tecnickcom/tc-lib-testrest

Library to test end-to-end RESTful services using Behat

tc-lib-testrest

PHP library to test end-to-end RESTful API services using Gherkin language (Behat), _(*1)

, _(*2)

, _(*3)

Please consider supporting this project by making a donation via PayPal, _(*4)

• category Library
• package \Com\Tecnick\TestRest
• author Nicola Asuni info@tecnick.com
• copyright 2015 MediaSift Ltd. http://datasift.com, 2016-2017 Tecnick.com LTD http://www.tecnick.com
• license The MIT License (MIT) - see LICENSE
• link https://github.com/tecnickcom/tc-lib-testrest

Description

PHP library to test end-to-end RESTful API services using Gherkin language (Behat), _(*5)

Installation

This project requires PHP 5.4.0+ to use the PHP built-in web server., _(*6)

• Create a composer.json in your projects root-directory and include this project:

{
    "require-dev": {
        "tecnickcom/tc-lib-testrest": "^2.10"
    }
}

Or add to an existing project with:, _(*7)

composer require tecnickcom/tc-lib-testrest ^2.10

• Create a behat.yml file in the root directory of your project like the one in test/behat.yml and check the internal comments and options.
• Create a test/features folder in your project like the one in test/features and write your own ".feature" files like the provided example.
• Create (or update) a makefile like the one in this project which contains the "btest" target. This target starts the PHP built-in server and execute the Behat tests.

Development - getting started

First, you need to install all dependencies (you'll need composer):, _(*8)

$ cd /tmp && curl -sS https://getcomposer.org/installer | php
$ sudo mv composer.phar /usr/local/bin/composer

The following command will download all the composer dependencies required for development and testing:, _(*9)

make build_dev

Running Tests

The internal unit tests includes a database testing, so you need to install MySQL and SQLite with PDO drivers. You also need to create the following MySQL database with the right privileges:, _(*10)

CREATE DATABASE IF NOT EXISTS testrest_test;
GRANT ALL ON testrest_test.* TO 'testrest'@'%' IDENTIFIED BY 'testrest';
FLUSH PRIVILEGES;

You also need to install APC and memcached to test all features., _(*11)

To execute all the tests you can now run make qa_all., _(*12)

Please issue the command make help to see all available options and execute individual tests., _(*13)

Coding standards

This project follows the PSR2 coding standard. To see any errors in your code, you can use the make phpcs command. We also use a tool to detect any code smells. To run it, use make phpmd., _(*14)

Before submitting a Pull Request, please execute the make qa_all to be sure that no errors where introduced. Additionally, please check the target/coverage/index.html report to be sure that every line of code is covered by a unit test. If you add any new gherkin language feature please also add an example in test/features., _(*15)

Developer(s) Contact

• Nicola Asuni info@tecnick.com