Current File : //usr/local/prospamfilter/vendor/codeception/codeception/readme.md
# Codeception
[](https://packagist.org/packages/Codeception/Codeception)
[](https://packagist.org/packages/codeception/codeception)
[](https://packagist.org/packages/codeception/codeception)
[](https://gitter.im/Codeception/Codeception?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://travis-ci.org/Codeception/Codeception)
[](https://scrutinizer-ci.com/g/Codeception/Codeception/?branch=master)
**Modern PHP Testing for everyone**
Codeception is a modern full-stack testing framework for PHP.
Inspired by BDD, it provides you an absolutely new way of writing acceptance, functional and even unit tests.
Powered by PHPUnit.
| General | Windows | Webdriver | Facebook |
| ------- | -------- | -------- | -------- |
| [](http://travis-ci.org/Codeception/Codeception) | [](https://ci.appveyor.com/project/DavertMik/codeception/branch/2.1) | [](https://semaphoreci.com/codeception/codeception) | [ ](https://codeship.com/projects/160201) |
#### Contributions
At Codeception we are glad to receive contributions from the community. If you want to send additions or fixes to the code or the documentation please check the [Contributing guide](https://github.com/Codeception/Codeception/blob/2.0/CONTRIBUTING.md).
### At a Glance
Describe what you test and how you test it. Use PHP to write descriptions faster.
Run tests and see what actions were taken and what results were seen.
#### Sample acceptance test
``` php
<?php
$I = new FunctionalTester($scenario);
$I->wantTo('create wiki page');
$I->amOnPage('/');
$I->click('Pages');
$I->click('New');
$I->see('New Page');
$I->submitForm('form#new_page', array('title' => 'Tree of Life Movie Review','body' => "Next time don't let Hollywood create art-house!"));
$I->see('page created'); // notice generated
$I->see('Tree of Life Movie Review','h1'); // head of page of is our title
$I->seeInCurrentUrl('pages/tree-of-life-movie-review'); // slug is generated
$I->seeInDatabase('pages', array('title' => 'Tree of Life Movie Review')); // data is stored in database
?>
```
For unit testing you can stay on classic PHPUnit tests, as Codeception can run them too.
## Documentation
[Documentation on Github](https://github.com/Codeception/Codeception/tree/master/docs)
Documentation is currently included within the project. Look for it in the 'docs' directory.
## Installation
### Phar
Download [codecept.phar](http://codeception.com/codecept.phar)
Copy it into your project.
You can also make Codeception an executable and it put it into your `$PATH`, for instance:
```
wget http://codeception.com/codecept.phar
chmod +x codecept.phar
sudo mv codecept.phar /usr/local/bin/codecept
```
You can then run Codecept in the command line using: `codecept bootstrap`, `codecept run`, etc
Run CLI utility:
```
php codecept.phar
```
### Composer
```
php composer.phar require "codeception/codeception"
```
Read Also [Installation](http://codeception.com/install) | **[QuickStart](http://codeception.com/quickstart)**
## Getting Started
If you successfully installed Codeception, run this command:
```
codecept bootstrap
```
this will create a default directory structure and default test suites
See Documentation for more information.
### License
MIT
(c) Michael Bodnarchuk "Davert"
2011-2016
Mini Shell