Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/restqa/restqa

🦏 | Best in class Microservice automation testing. Test Driven Happiness
https://github.com/restqa/restqa

gherkin restqa test-automation testing-tools unit-testing

Last synced: 1 day ago
JSON representation

🦏 | Best in class Microservice automation testing. Test Driven Happiness

Host: GitHub
URL: https://github.com/restqa/restqa
Owner: restqa
License: mit
Created: 2020-04-25T09:24:51.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-09-13T09:55:50.000Z (3 months ago)
Last Synced: 2024-10-06T16:09:16.565Z (2 months ago)
Topics: gherkin, restqa, test-automation, testing-tools, unit-testing
Language: JavaScript
Homepage: https://restqa.io
Size: 49.9 MB
Stars: 85
Watchers: 8
Forks: 12
Open Issues: 18
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-testing - RestQA - A REST API testing Framework based on ghekin to manage microservice local testing using the best in class Developer experience. (Software / Make your life easier)
awesome-rest - RestQA - A REST API testing Framework based on BDD / Gherkin to manage microservice local testing. (Testing / Querying)
awesome-bdd - RestQA - All-in-one API test automation framework with a great developer experience. Based on Cucumber. (Tools / JavaScript)

README

        


RestQA

Test Driven Happiness

Making Backend engineer happy by applying world class developer experience through Microservice Testing



  

  

  

  

  





    

    📖 Documentation



> Project Paused.. ~Still under development... The release 1.0.0 is coming soon, Feel free to contribute!~

## 😃 Why Test Driven Happiness?

Within our DEV team while working with microservice, we realized a few thing:

- [X] **WE HATE** Writting Local Test

- [X] **WE HATE** Reviewing long unreadable Local Test full of mocks

- [X] **WE HATE** Maintaining the Integration Test

- [X] **WE HATE** Maintaining the Performance Test

- [X] **WE HATE** Maintaining the API specification

- [X] **WE HATE** Maintaining the postman collection

- [X] **WE HATE** Maintaining the HTTP Mocks

- [X] **WE HATE** Rewrite the test while changing the microservice technology

This is why we decided to challenge ourself on how to transform this frustration into a positive initative.

RestQA was build with a simple goal: Driving the happiness of the DEV team through testing.

Run one command and get everything that you need to enjoy maintaining your microservice.

#### Synthax

Gherkin Based but **KEEP CALM It aint's BDD!**

![Step definition](https://restqa.io/assets/img/content/2-why-step1.gif)

The RestQA Community maintains the step definitions! **YOU** focus on writting scenarios **WE** taking care of everything else 🤗

#### Screenshot

👉 [Access to our online demo](https://dashboard.restqa.io)

![Screenshot](https://restqa.io/assets/img/content/2-why-step2.png)

#### Benefits

* No Gherkin step to maintain (50+ steps out of the box)

* Gherkin step maintain by the community

* Test Ready in a minute

* Outside in testing: Code refactoring friendly

* Code Review friendly

* Test driven development friendly

* Mock ready in a minute

* Community driven

## ⭐️ Features

- 🌈 Local API test as Single source of truth

- 💬 Write local API test using ordinary language

- 🚦 Reuse your local API test to run the integration test

- 🎯 Get code coverage from your local tests

- 🏎  Generate Performace Test scenario compatible with your favorite Performance testing tool

- 📚  Generate an up to date API specification from the test results

- 👩‍🚀 Generate an up to date postman collection

- 🕐 Instant result

- 👑 Programming language Agnostic

- 👩‍💻 Community Driven

## 🕵️ Under the scene

Only one command to run and everything else is taking care of:

``` mermaid

%%{init: {'theme': 'forest' } }%%

stateDiagram-v2

    direction LR

    state "npm test" as cmd

    state "RestQA" as restqa

    state "run tests" as runner

    state "Test report" as formatter

    state "Microservice" as mc

    state "External dependencies (container)" as extenal

    state "3rd party mock" as mock

    state "console output" as console

    [*] --> cmd

    cmd --> restqa

    state restqa {

      direction LR

      

      runner --> mc

      mc --> runner

      mc --> extenal

      extenal --> mc

     

      state mc {

        direction LR

        [*] --> running

        running --> [*]

      }

      state extenal {

        direction LR

        [*] --> mock

        mock --> [*]

      }

      mc --> result

      result --> formatter

      result --> console

    }

    restqa --> [*]

```

## 🎬 Demo

https://user-images.githubusercontent.com/4768226/205502972-1fddb8f2-130e-4071-a9f5-de4bc2406497.mp4

## 📦 Install

Once you get nodeJs on your local machine run the command

```

npm install -D @restqa/restqa@next

```

```

yarn add @restqa/restqa@next -D

```

## 🎯 Usage

In you `package.json` add the script:

```

  "scripts": {

    "test": "restqa run",

    "happy": "restqa run --report"

  }

```

Run the command:

```

npm test

```

It will automatically initialize RestQA into your project and generate the initial test for you ^^

Then you can Write your Unit Test Using ordinary language:

```gherkin

Feature: GET /api/infos

Scenario: Get the list of informations

Given a request

When GET "/api/info"

Then status = 200

  And the body:

  """

{

  "message": "Hello World!"

}

  """

```

Then simply run the command to get full report:

```

npm run happy

```

## 🌈 Example

Take a look at the [examples folder](./examples) to see a basic setup.

## 🚧 Roadmap

##### 🚀 Local Test

- [X] Test coverage

- [X] [Mock external http depedencies](./packages/plugin-http-mock)

- [X] [Mock MongoDB database](./packages/plugin-mongodb)

- [ ] Mock Postgres database

- [ ] Mock MySQL database

- [ ] Mock S3 database

- [ ] Mock Redis store

##### 🏎 Performance Test

- [X] Artillery.io

- [ ] K6 (Need contribution [#291](https://github.com/restqa/restqa/issues/291))

- [ ] Jmeter (Need contribution [#290](https://github.com/restqa/restqa/issues/290))

- [ ] Vegeta (Need contribution [#289](https://github.com/restqa/restqa/issues/289))

#### 📚 API Specification

- [X] OAS (swagger)

- [ ] Raml

#### 👩‍🚀 API Collection

- [X] Postman

## Big Love ❤️

RestQA Team would like to give a hug 🤗 to thanks the excellent work of the following dependent open source project:

* [Cucumber-js](https://github.com/cucumber/cucumber-js/)

* [VueJs](https://vuejs.org/)

* [Element-ui](https://element-plus.org)

* [C8](https://github.com/bcoe/c8)

* [Swagger Ui](https://github.com/swagger-api/swagger-ui)

* [Scarf](https://github.com/scarf-sh)

## Contribution

See [Contributing Guide](./CONTRIBUTING.md).

## Author

- [@olivierodo](https://www.github.com/olivierodo) - 🇫🇷

- [@tonygo](https://github.com/tony-go) - 🇫🇷

## License

[MIT License](./LICENSE)