Writing a test suite

You may have noticed after having read through the previous recipe that it can quickly become tedious to have to manually run phpunit and specify test classes and PHP filenames. This is especially true when dealing with applications that employ dozens or even hundreds of classes and files. The PHPUnit project has a built-in capability to handle running multiple tests with a single command. Such a set of tests is referred to as a test suite.

How to do it...

At its simplest, all you need to do is to move all the tests into a single folder:
```
mkdir tests
cp *Test.php tests
```
You'll need to adjust commands that include or require external files to account for the new location. The example shown (SimpleTest) was developed in the preceding recipe:
```
<?php
use PHPUnit\Framework\TestCase;
require_once __DIR__ . '/../chap_13_unit_test_simple.php';

class SimpleTest extends TestCase
{
  // etc.
```
You can then simply run phpunit with the directory path as an argument. PHPUnit will then automatically run all tests in that folder. In this example, we assume there is a tests subdirectory:
```
phpunit tests
```
You can use the --bootstrap option to specify a file that is executed prior to running the tests. A typical use for this option is to initiate autoloading:
```
phpunit --boostrap tests_with_autoload/bootstrap.php tests
```

Here is the sample bootstrap.php file that implements autoloading:

<?php
require __DIR__ . '/../../Application/Autoload/Loader.php';
Application\Autoload\Loader::init([__DIR__]);

Another possibility is to define one or more sets of tests using an XML configuration file. Here is an example that runs only the Simple* tests:

<phpunit>
  <testsuites>
    <testsuite name="simple">
      <file>SimpleTest.php</file>
      <file>SimpleDbTest.php</file>
      <file>SimpleClassTest.php</file>
    </testsuite>
  </testsuites>
</phpunit>

Here is another example that runs a test based on a directory and also specifies a bootstrap file:

<phpunit bootstrap="bootstrap.php">
  <testsuites>
    <testsuite name="visitor">
      <directory>Simple</directory>
    </testsuite>
  </testsuites>
</phpunit>

How it works...

Make sure all the tests discussed in the previous recipe, Writing a simple test, have been defined. You can then create a tests folder and move or copy all the *Test.php files into this folder. You'll then need to adjust the path in the require_once statements, as shown in step 2.

In order to demonstrate how PHPUnit can run all tests in a folder, from the directory containing the source code you defined for this chapter, run the following command:

phpunit tests

You should see the following output:

To demonstrate the use of a autoloading via a bootstrap file, create a new tests_with_autoload directory. In this folder, define a bootstrap.php file with the code shown in step 5. Create two directories in tests_with_autoload: Demo and Simple.

From the directory containing the source code for this chapter, copy the file (discussed in step 12 of the previous recipe) into tests_with_autoload/Demo/Demo.php. After the opening <?php tag, add this line:

namespace Demo;

Next, copy the SimpleTest.php file to tests_with_autoload/Simple/ClassTest.php. (Notice the filename change!). You will need to change the first few lines to the following:

<?php
namespace Simple;
use Demo\Demo;
use PHPUnit\Framework\TestCase;

class ClassTest extends TestCase
{
  protected $demo;
  public function setup()
  {
    $this->demo = new Demo();
  }
// etc.

After that, create a tests_with_autoload/phpunit.xml file that pulls everything together:

<phpunit bootstrap="bootstrap.php">
  <testsuites>
    <testsuite name="visitor">
      <directory>Simple</directory>
    </testsuite>
  </testsuites>
</phpunit>

Finally, change to the directory that contains the code for this chapter. You can now run a unit test that incorporates a bootstrap file, along with autoloading and namespaces, as follows:

phpunit -c tests_with_autoload/phpunit.xml

The output should appear as follows:

Table of Contents for
PHP 7: Real World Application Development

Writing a test suite

How to do it...

How it works...

See also...

Table of Contents for PHP 7: Real World Application Development

Writing a test suite

How to do it...

How it works...

See also...

Table of Contents for
PHP 7: Real World Application Development