Skip to content

php_unit.md

Latest commit

 

History

History
52 lines (38 loc) · 1.79 KB

php_unit.md

File metadata and controls

52 lines (38 loc) · 1.79 KB
Raw

Plugin PHPUnit

Runs PHPUnit tests against your build.

Configuration

Options

Has two modes:

phpunit.xml Configuration File

It's activated if you have phpunit.xml file in your build path, tests/ subfolder, or you specify it as a parameter:

  • config [string, optional] - Path to a PHP Unit XML configuration file.
  • run_from [string, optional] - When running PHPUnit with an XML config, the command is run from this directory
  • coverage [bool, optional] - Value for the --coverage-html command line flag.

Running Tests By Specifying Directory

  • directory - [DEPRECATED] Option directory is deprecated and will be deleted in version 2.0. Use the option directories instead.
  • directories - Optional - The directories (array) to run PHPUnit on.

Both modes accept:

  • args - Optional - Command line args (in string format) to pass to PHP Unit

Examples

Specify config file and test directory:

test:
    php_unit:
        config:
            - "path/to/phpunit.xml"
        directories:
            - "app/tests/"
        coverage: true

Troubleshooting

If standard logging of PHP Censor is not enough, to get standard output from any command, including PHPUnit, edit CommandExecutor::executeCommand() to see what exactly is wrong

  • Run composer update in phpunit plugin directory of PHP Censor to get all of its dependencies
  • If phpunit is inside of the project's composer.json, it might interfere with PHP Censor's phpunit installation
  • Make sure you have XDebug installed.The Xdebug extension is not loaded. No code coverage will be generated. Otherwise test report parsing in TapParser will fail, wanting coverage report as well Invalid TAP string, number of tests does not match specified test count.