https://github.com/tecnickcom/tc-lib-testrest
Library to test end-to-end RESTful services using Behat
https://github.com/tecnickcom/tc-lib-testrest
Last synced: 8 months ago
JSON representation
Library to test end-to-end RESTful services using Behat
- Host: GitHub
- URL: https://github.com/tecnickcom/tc-lib-testrest
- Owner: tecnickcom
- License: mit
- Created: 2015-11-26T11:42:24.000Z (almost 10 years ago)
- Default Branch: develop
- Last Pushed: 2020-01-02T16:04:13.000Z (almost 6 years ago)
- Last Synced: 2025-01-07T09:46:07.947Z (9 months ago)
- Language: PHP
- Size: 79.1 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# tc-lib-testrest
*PHP library to test end-to-end RESTful API services using Gherkin language (Behat)*
[](https://packagist.org/packages/tecnickcom/tc-lib-testrest)
[](https://travis-ci.org/tecnickcom/tc-lib-testrest?branch=master)
[](https://coveralls.io/github/tecnickcom/tc-lib-testrest?branch=master)
[](https://packagist.org/packages/tecnickcom/tc-lib-testrest)
[](https://packagist.org/packages/tecnickcom/tc-lib-testrest)
[](https://github.com/tecnickcom/tc-lib-testrest/tree/develop)
[](https://travis-ci.org/tecnickcom/tc-lib-testrest?branch=develop)
[](https://coveralls.io/github/tecnickcom/tc-lib-testrest?branch=develop)
[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations¤cy_code=GBP&business=paypal@tecnick.com&item_name=donation%20for%20tc-lib-testrest%20project)
*Please consider supporting this project by making a donation via [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations¤cy_code=GBP&business=paypal@tecnick.com&item_name=donation%20for%20tc-lib-testrest%20project)*
* **category** Library
* **package** \Com\Tecnick\TestRest
* **author** Nicola Asuni
* **copyright** 2015 MediaSift Ltd. , 2016-2017 Tecnick.com LTD
* **license** The MIT License (MIT) - see [LICENSE](LICENSE)
* **link** https://github.com/tecnickcom/tc-lib-testrest
## Description
PHP library to test end-to-end RESTful API services using Gherkin language ([Behat](http://behat.org))
## Installation
This project requires PHP 5.4.0+ to use the PHP built-in web server.
* Create a composer.json in your projects root-directory and include this project:
```json
{
"require-dev": {
"tecnickcom/tc-lib-testrest": "^2.10"
}
}
```
Or add to an existing project with:
```bash
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](https://getcomposer.org/)):
```bash
$ 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:
```bash
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:
```sql
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.
To execute all the tests you can now run `make qa_all`.
Please issue the command `make help` to see all available options and execute individual tests.
### 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`.
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.
## Developer(s) Contact
* Nicola Asuni