README.md

RestQa Action

A GitHub action to run your RestQa project's test automation suite

RestQa

What is RestQa ?

Restqa is an open automation framework based on Gherkin. A few step and your Test automation framework is setup. No dependency the framework is ready to be plug to all your project components

Pre Requisite

• Project with RestQA installed (.restqa.yml file at the root level)

Usage

This action runs the RestQa container.

If all your feature files are in a folder called tests, run it like this:

name: E2E Test

on: [push]

jobs:
  RestQa:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - uses: restqa/[email protected]
      with:
        path: 'test/'

If you want to pass environment variables to the RestQA command, run this:

# This example is triggering the action manually

name: E2E Test

on:
  workflow_dispatch:
     inputs:
       environment:
         description: 'Environment target'
         required: true
         default: 'prod'

jobs:
  RestQa:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - uses: restqa/[email protected]
      env:
        SLACK_WEBHOOK_URL: ${{secrets.SLACK_WEBHOOK_URL}}
        RESTQA_ENV: ${{github.event.inputs.environment}}
      with:
        path: 'test/'

And Voila !

References

• RestQa
• RestQa Organization

Keywords

• test automation
• Gherkin
• Cucumber
• End to End
• E2E
• Quality assurance
• QA
• Continuous integration