README

What is QaApi

QaApi is an API for a QA department. This API can get or change an internal state of a system during manual or automated testing.

Example of Test Case

You created a new feature for your webshop. It sends a reminder to the customer email in 1 day if he gave up his cart.

How does tester have to test this case? Right, he has to create a cart and wait 1 day.

But if we have no that time, tester will go to developer and ask him to change a creation time of the cart in database back on 23 hours 55 minutes. Then the feature will be tested in 5 minutes, and we can release it.

At this time we solved our problem, but:

tester will interrupt a developer every time when he needs to change something in database
tester can't write automated tests for such cases (unless he has a knowledge of the project source code and has an access to it)

QaApi solves the both problems

Developer just needs to write one API method which can change a creation time of a cart. Then tester can use it for manual and automated testing:

PHP client for API will be automatically generated to use it for automated tests
if your company use QAdept service, tester can use it manually from Operations tab

What benefits do you have using this approach?

Testing of difficult test cases is much easier.
It helps testers with manual and automated testing.
It increases productivity by splitting up testers' and developers' work.
Testers don't need to know anything about the project source code.
It allows company to don't share the project source code with testers.

How to install

Install QaApi package:

composer require qadept/codeception-qaapi

Add QaApi module to a suite file. Its content should look like:

class_name: FunctionalTester
modules:
    enabled:
        - \WebShop\Helper\Functional
        - WebDriver:
            url: 'http://myproject.local'
            browser: phantomjs
            window_size: 1280x960
        - Asserts
        - \WebShop\Helper\QaApi:
            url: 'http://myproject.local/qaapi'
            api_key: my_secret_key

Here "url" is a base URL for API, "api_key" is a key for authorization.

Create a qaapi.json file in the directory with tests (the same directory where you have codeception.yml file). This file is using Swagger Specification and will be used for automatical generation of PHP API Client.

Generate PHP API Client and helper classes:

./vendor/bin/codecept qaapi:generate -c projects/WebShop

./vendor/bin/codecept build -c projects/WebShop

qadept / codeception-qaapi

Maintainers

Details