Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/sadabnepal/supertest-ts-mocha-api-test

Boilerplate API test framework using Mocha, SuperTest, TypeScript and ReportPortal
https://github.com/sadabnepal/supertest-ts-mocha-api-test

chai docker eslint githubaction-workflow husky mocha report-portal rest-api supertest supertest-mocha-chai typescript

Last synced: about 1 month ago
JSON representation

Boilerplate API test framework using Mocha, SuperTest, TypeScript and ReportPortal

Host: GitHub
URL: https://github.com/sadabnepal/supertest-ts-mocha-api-test
Owner: sadabnepal
Created: 2022-04-29T23:53:01.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-05-13T09:52:45.000Z (8 months ago)
Last Synced: 2024-05-13T10:59:34.335Z (8 months ago)
Topics: chai, docker, eslint, githubaction-workflow, husky, mocha, report-portal, rest-api, supertest, supertest-mocha-chai, typescript
Language: HTML
Homepage:
Size: 834 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # API Test Automation framework

Boilerplate API test framework using Mocha, SuperTest and TypeScript.

#### Pre-requisite:

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

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

#### Getting Started:

Clone Repository

```bash

git https://github.com/sadabnepal/supertest-ts-mocha-api-test.git

cd supertest-ts-mocha-api-test

```

Install the dependencies

```bash

npm install

```

Setup user token

```bash

- Open the URL 'https://gorest.co.in/'

- Login or Sign

- Click on Login user drop down --> Access Token

- Create .env file and add actual token, refer .env.example file

```

Run tests

```bash

npm test

npm run test:rp [ to capture test results in report portal ]

```

Report Path:

```bash

path: /report/index.html

```

Docker Run:

> Setup [docker](https://docs.docker.com/get-docker/) in your local machine to run test in dockerize environment

```bash

docker build -t node-api-image . [ you can given any name of your choice ]

docker run node-api-image:latest [ to run test inside docker ]

```

Run in Github Actions

> Currently test is setup to execute in github action on push event. You need to [create github secrete](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository) for `GO_RES_USER_TOKEN` with value generated in `Setup user token` step.

 Github Permission to update report:  Go to Repository -> Settings -> Actions -> General 


Scroll to bottom of the page and look for 'Workflow permissions' section 


Check 'Read and write permission' and click on save

### Report Portal Integration

- Setup: run below two command to spin up report portal instance locally with docker (read more https://reportportal.io/installation)

    - curl -LO https://raw.githubusercontent.com/reportportal/reportportal/master/docker-compose.yml

    - docker-compose -p reportportal up -d --force-recreate

- Login: Open http://localhost:8080/ and login with time user `superadmin` and password `erebus`

- Generate API key:

    - Click on bottom left of logged in user --> click on `Profile`

    - Click on `API KEYS` --> `Generate API Key` --> copy the generated key

    - Create `.env` file in root project folder. Refer `.env.example` file

    - Paste your API key into `.env` file as `REPORT_PORTAL_KEY=`

- Enter `REPORT_PORTAL_PROJECT=` into `.env`. Value can be found on `PROJECT ASSIGNMENT` tab of user profile

- Other details are updated in `reportPortal.js` file

![docker_run](./images/reportPortal.png)

#### Features:

    - Supertest library

    - Mocha framework to organize tests

    - Mochawesome report integration with logs

    - Custom types for better code intellisense

    - Service as enum for better input control

    - Schema validation

    - Multi environment support 

    - Docker and Github integration

    - Enhanced import statements

    - Request and response report logger

    - Lint for better code quality

    - Husky for auto lint check before code commit

    - Manage secretes using dotenv library

    - Runtime dynamic test data generation using faker js library

    - AI powered Report Portal integration

#### Tech stacks:

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

[![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/)

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

[![GithubActions](https://img.shields.io/badge/github%20actions-%232671E5?logo=githubactions&logoColor=white)](https://github.com/features/actions)

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

[![ESlint](https://img.shields.io/badge/ESLint-4B3263?logo=eslint&logoColor=white)]([https://www.docker.com/](https://typescript-eslint.io/))

[![Husky](https://img.shields.io/badge/Husky-dbc1ac?logo=gitlab&logoColor=black)]([https://www.docker.com/](https://typicode.github.io/husky/))

#### Folder Structure:

```bash

├───.github

├───.husky

├───.vscode

├───src

|     ├───data

|     ├───env

|     ├───helper

|     ├───schema

|     ├───services

|     ├───static

|     ├───test

|     └───types

├───.env.example

├───.eslintrc.js

├───.gitignore

├───.mocharc.js

├───Dockerfile

├───package-lock.json

├───package.json

├───README.md

└───tsconfig.json

```

#### Sample Report

![SampleReport](https://user-images.githubusercontent.com/65847528/167574833-05db8fe3-e2b0-4d97-9cac-16f6f1c6c0c2.png)