Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sadabnepal/web-mobile-api-test-framework

Boilerplate project for Web, Mobile and API using WebdriverIO, Appium, SuperTest and TypeScript
https://github.com/sadabnepal/web-mobile-api-test-framework

appium cucumber cucumber-html-report docker mocha mochawesome supertest-mocha-chai typescript wdio-async wdio-cucumber-steps webdriverio webdriverio-appium webdriverio-boilerplate-framework webdriverio-framework webdriverio-typescript

Last synced: about 1 month ago
JSON representation

Boilerplate project for Web, Mobile and API using WebdriverIO, Appium, SuperTest and TypeScript

Host: GitHub
URL: https://github.com/sadabnepal/web-mobile-api-test-framework
Owner: sadabnepal
License: mit
Created: 2021-05-17T14:14:29.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-05-01T11:05:43.000Z (8 months ago)
Last Synced: 2024-06-13T20:10:06.904Z (6 months ago)
Topics: appium, cucumber, cucumber-html-report, docker, mocha, mochawesome, supertest-mocha-chai, typescript, wdio-async, wdio-cucumber-steps, webdriverio, webdriverio-appium, webdriverio-boilerplate-framework, webdriverio-framework, webdriverio-typescript
Language: TypeScript
Homepage:
Size: 6.23 MB
Stars: 30
Watchers: 4
Forks: 16
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        
 Web, API and Mobile Test Automation Framework 




    

        

    





[![Web CI](https://github.com/sadabnepal/WebdriverIOTypeScriptE2E/actions/workflows/web.yml/badge.svg)](https://github.com/sadabnepal/WebdriverIOTypeScriptE2E/actions/workflows/web.yml)

[![API CI](https://github.com/sadabnepal/WebdriverIOTypeScriptE2E/actions/workflows/api.yml/badge.svg)](https://github.com/sadabnepal/WebdriverIOTypeScriptE2E/actions/workflows/api.yml)



#### Pre-requisite

[![NodeJs](https://img.shields.io/badge/-NodeJS-grey?logo=node.js)](https://nodejs.org/en/download/)

[![Docker](https://img.shields.io/badge/-Docker-0db7ed?logo=docker&logoColor=white)](https://docs.docker.com/engine/install/)

[![VSCode](https://img.shields.io/badge/-Visual%20Studio%20Code-%233178C6?logo=visual-studio-code)](https://code.visualstudio.com/download)

[![Appium-Inspector](https://img.shields.io/badge/-Appium%20Inspector-662d91?logo=appium&logoColor=black)](https://github.com/appium/appium-inspector/releases)

[![AndroidStudio](https://img.shields.io/badge/-Android%20Studio-3DDC84?logo=android-studio&logoColor=white)](https://developer.android.com/studio)

[![JDK](https://img.shields.io/badge/-JDK-white?logo=openjdk&logoColor=black&)](https://www.azul.com/downloads/#zulu)

#### Clone Repository

```bash

git clone https://github.com/sadabnepal/web-mobile-api-test-framework.git

cd web-mobile-api-test-framework

```

-----

### Interactive CLI to run test:

> Make sure mobile setup has been completed if selecting mobile as CLI option. See [Mobile Test](./mobile/README.md) for setup instructions. Before running actual test, presence of node_modules folder will be validated and if not not found installation will take place before proceeding any further.

```bash

npm start

```

It start wizard with test module options, based on user selection either of the below module will start locally or inside docker container. Code to control wizard and user selection is available in 'start.js' which is built using [enquirer](https://www.npmjs.com/package/enquirer) node package.


Test Module Options :  | UI | API | Mobile | 


![cli_demo](./images/setup.gif)

-----

### Web Test

Install dependencies:

> Navigate to "web" folder and then run below command

```bash

npm install

```

Setup .env file:


create `.env` file inside web folder and update content with reference to `.env.example`

Run test in local:

> By default test will run in HEADLESS mode.

> Update MODE=LOCAL in .env file to see test running in browser.

```bash

npm test             [ Mocha tests ]

npm run test:e2e     [ Cucumber BDD tests ]

```

Run test in Docker:

```bash

npm run test:docker       [ Mocha tests]

npm run test:e2e:docker   [ Cucumber BDD tests ]

```

> Pre and Post script will handle start and stop of docker containers automatically.

> If containers does not stop automatically run "docker-compose down" command.

Generate Report:

```bash

npm run report:mocha

npm run report:cucumber

```

Report Paths:

```bash

mocha: web/mochawesome-report/mochawesome-report.html

cucumber: web/reports/cucumber/cucumber-report.html

```

Send Report:

> Update .env file details with reference of .env.example file

```bash

npm run mailCucumberReport

npm run mailMochaResult

```

-----

### API Test

Install dependencies:

> Navigate to "api" folder and then run below command

```bash

npm install

```

Run test:

```bash

npm test

```

Report Paths:

```bash

api/reports/mochawesome.html

```

-----

### Mobile Test

Appium setup: [Click here to open Appium SetUp README](/mobile/README.md)

Install dependencies:

> Navigate to "mobile" folder and then run below command

```bash

npm install

```

Run in local:

> Make sure android virtual device is up and running before starting mobile test.

```bash

npm run test  [ Mobile tests ]

```

Generate Report:

```bash

npm run report

```

Report Paths:

```bash

mobile: mobile/reports/mobile.html

```

-----

#### Features:

    - Web, Mobile and API Testing

    - Mocha and Cucumber BDD framework

    - Page Object Design pattern

    - Docker with VNC integration

    - Parallel execution

    - Cross browser testing

    - Retry failed test

    - Screenshot in report for failed tests

    - Github actions

    - Send test report to list of Gmail

    - Use of types for method params optimization

    - Improved import statement using tsconfig path

#### Tech stacks:

[![WebdriverIO](https://img.shields.io/badge/-WebdriverI/O-EA5906?logo=WebdriverIO&logoColor=white)](https://webdriver.io/)

[![TypeScript](https://img.shields.io/badge/-TypeScript-%233178C6?logo=Typescript&logoColor=black)](https://www.typescriptlang.org/)

[![Mocha](https://img.shields.io/badge/-Mocha-%238D6748?logo=Mocha&logoColor=white)](https://mochajs.org/)

[![CucumberIO](https://img.shields.io/badge/-Cucumber.io-brightgreen?logo=cucumber&logoColor=white)](https://cucumber.io/)

[![ChaiJS](https://img.shields.io/badge/-ChaiJS-FEDABD?logo=Chai&logoColor=black)](https://www.chaijs.com/)

[![SuperTest](https://img.shields.io/badge/-SuperTest-07BA82?logoColor=white)](https://github.com/visionmedia/supertest)

[![Enquirer](https://img.shields.io/badge/-Enquirer-f0db4f?logoColor=white)](https://github.com/enquirer/enquirer)

[![Docker](https://img.shields.io/badge/-Docker-0db7ed?logo=docker&logoColor=white)](https://www.docker.com/)

[![Appium](https://img.shields.io/badge/-Appium-662d91?logo=appium&logoColor=black)](https://github.com/appium/appium)

[![dotenv](https://img.shields.io/badge/-dotenv-grey?logo=.env&logoColor=#ECD53F)](https://github.com/appium/appium)

[![Node-Mailer](https://img.shields.io/badge/-Node%20Mailer-grey?logo=gmail&logoColor=blue)](https://github.com/nodemailer/nodemailer)

#### Folder Structure:

![e2e_framework_folders](https://user-images.githubusercontent.com/65847528/168474570-5eca8112-25b7-45ca-b411-355d0ce39079.png)

#### Sample Email Report:

![email_report](https://user-images.githubusercontent.com/65847528/168474717-26236fd6-4f30-4cc0-bcb9-cf9ae0deadce.png)