cedriclange/ci-phpunit

An easier way to use PHPUnit with CodeIgniter 3.x

v0.17.5 2020-04-02 22:19 UTC

Requires

• php: >=5.4.0
• nikic/php-parser: ^2.1|^3.0|^4.2

MIT

• Kenji Suzuki

• phpunit
• test
• unit testing
• codeigniter
• monkey patch

README

phpunit

this repo has been build to solve issues #34 and #311

An easier way to use PHPUnit with CodeIgniter 3.x.

• You don't have to modify CodeIgniter core files at all.
• You can write controller tests easily.
• Nothing is untestable, maybe.
• Well documented.

Requirements

• PHP 5.4.0 or later (5.6 or later is recommended)
• CodeIgniter 3.x
• PHPUnit 4.3 to 7.5 (4.8 or later is recommended)
  • If you want to use PHPUnit 8 or later, please use ci-phpunit-test 2.x.
  • If you use PHPUnit 6.0, please use ci-phpunit-test v0.14.0 or later.
  • You can download old version of phpunit.phar from https://phar.phpunit.de/.

Optional

• NetBeans
  • Go to Project Properties > Testing > PHPUnit, check Use Custom Test Suite checkbox, and select application/tests/_ci_phpunit_test/TestSuiteProvider.php.

Change Log

See Change Log.

Folder Structure

codeigniter/
├── application/
│   └── tests/
│        ├── _ci_phpunit_test/ ... don't touch! files ci-phpunit-test uses
│        ├── Bootstrap.php     ... bootstrap file for PHPUnit
│        ├── DbTestCase.php    ... DbTestCase class
│        ├── TestCase.php      ... TestCase class
│        ├── controllers/      ... put your controller tests
│        ├── libraries/        ... put your library tests
│        ├── mocks/
│        │   └── libraries/    ... mock libraries
│        ├── models/           ... put your model tests
│        └── phpunit.xml       ... config file for PHPUnit
└── vendor/

Installation

Installation via Composer

If you like Composer:

$ cd /path/to/codeigniter/
$ composer require cedriclange/ci-phpunit --dev

And run install.php:

$ php vendor/cedric/ci-phpunit/install.php --from-composer

• The above command always overwrites existing files.
• You must run it at CodeIgniter project root folder.
• Please remove the line <exclude>./_ci_phpunit_test/</exclude> in tests/phpunit.xml.
• You can specify your application and public folder with option arguments, if you use custom folder paths.

$ php vendor/cedriclange/ci-phpunit/install.php -a <application_dir> -p <public_dir>

• But some paths may be not correct, in that case, please fix them in tests/Bootstrap.php.

Upgrading via Composer

If you like Composer:

$ cd /path/to/codeigniter/
$ composer update cedriclange/ci-phpunit

If you're upgrading from a previous version of ci-phpunit-test that created an application/test/_ci_phpunit_test directory and now want to directly use ci-phpunit-test from Composer, you have a couple of additional steps:

1. Delete the old test library directory: rm -rf /path/to/codeigniter/application/tests/_ci_phpunit_test
2. Edit the application/tests/Bootstrap.php file. At the bottom of the "set the main path constants"