https://github.com/restqa/restqa-action

:octocat: | A GitHub action to run your RestQa project's test automation suite
https://github.com/restqa/restqa-action

automation-framework automation-test github-actions restqa testing

Last synced: 6 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/restqa/restqa-action
• Owner: restqa
• Created: 2020-05-01T01:33:29.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-10-24T00:34:31.000Z (about 4 years ago)
• Last Synced: 2024-03-15T02:46:07.706Z (8 months ago)
• Topics: automation-framework, automation-test, github-actions, restqa, testing
• Language: Dockerfile
• Homepage: https://restqa.io
• Size: 5.86 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](https://hub.docker.com/repository/docker/restqa/restqa) container.

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

```yaml

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:

```yaml

# 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](http://www.restqa.io)

* [RestQa Organization](https://github.com/restqa)

### Keywords

* test automation

* Gherkin

* Cucumber

* End to End

* E2E

* Quality assurance

* QA

* Continuous integration