https://github.com/pactumjs/pactum-cucumber-boilerplate

Boilerplate project to run REST API tests with Cucumber & Pactum
https://github.com/pactumjs/pactum-cucumber-boilerplate

api api-testing bdd boilerplate cucumber pactum pactumjs rest-api testing

Last synced: 2 days ago
JSON representation

Boilerplate project to run REST API tests with Cucumber & Pactum

• Host: GitHub
• URL: https://github.com/pactumjs/pactum-cucumber-boilerplate
• Owner: pactumjs
• License: mit
• Created: 2020-09-20T06:34:59.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-09-05T02:11:24.000Z (about 1 year ago)
• Last Synced: 2024-05-02T04:22:37.402Z (7 months ago)
• Topics: api, api-testing, bdd, boilerplate, cucumber, pactum, pactumjs, rest-api, testing
• Language: JavaScript
• Homepage:
• Size: 142 KB
• Stars: 31
• Watchers: 3
• Forks: 17
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pactum-cucumber-boilerplate

Boilerplate project to run REST API tests with [Cucumber](https://cucumber.io) and [PactumJS](https://pactumjs.github.io)

## Setup

There are 2 options to setup this project:

- Manually clone this project then install all dependencies

- Simply using [pusakatest](https://www.npmjs.com/package/pusakatest) CLI tool

  - If you don't have a package.json in your file directory, it will be copied from one of the templates available at [pusakatest](https://github.com/depapp/pusakatest/blob/644409e90fe29f9cdab3b0da3ab9bf497150da79/templates/english/package.json#L20) when you run below command

  - If you already have a package.json file, add all the dependencies mentioned in [pusakatest](https://github.com/depapp/pusakatest/blob/644409e90fe29f9cdab3b0da3ab9bf497150da79/templates/english/package.json#L20) to your package.json (below command will not override or replace your package.json file)

  

```bash

npx pusakatest

```

## Sample Test Case

```gherkin

Feature: Regres

  In order to keep Regres api stable

  As a tester

  I want to make sure that everything works as expected

  

  Scenario: Get A User With Id

    Given I make a GET request to /api/users/{id}

      And I set path param id to $S{UserId}

     When I receive a response

     Then I expect response should have a status 200

      And I expect response should have a json like

      """

      {

        "data": {

          "id": 7

        }

      }

      """

```

## Running Tests

```sh

npm run test

```

## Gherkin Expressions

Sample Step Definitions

```gherkin

  Given

    I make a (.*) request to (.*)

    I set path param (.*) to (.*)

    I set query param (.*) to (.*)

    I set header (.*) to (.*)

    I set cookie (.*) to (.*)

    I set basic authentication credentials (.*) and (.*)

    I set body to

    I set multipart form data (.*) to (.*)

    I upload file at (.*)

    I set form-data to

    I set inspection

  

  When

    I receive a response

  

  Then

    I expect response should have a status {int}

    I expect response header (.*) should be (.*)

    I expect response header (.*) should have (.*)

    I expect response cookie (.*) should be (.*)

    I expect response should have a json

    I expect response should have a json at (.*)

    I expect response should have a json like

    I expect response should have a json like at (.*)

    I expect response should have a json schema

    I expect response should have a json schema at (.*)

    I expect response should have a body

    I expect response to match a json snapshot (.*)

    I expect response body should contain (.*)

    I expect response should have {string}

    I expect response time should be less than {int} ms

    I store response at (.*) as (.*)

```