On this page

Still need help?

The Atlassian Community is here for you.

Ask the community

This page describes how to configure a PHPUnit task. 

Before you begin:

  • To use this task, you will need to install PHPUnit and reference the path to your PHP command-line interpreter, (e.g. /usr/bin/phpunit on Ubuntu).

To configure a PHPUnit task:

  1. Navigate to the Tasks configuration tab for the job (this will be the default job if creating a new plan).
  2. Select the name of an existing task, or select Add task > PHPUnit (or another option, such as PHPUnit 3.3.X) to create a new task.
  3. Update the task settings:
    Task description
    Enter a description of the task, for display in Bamboo.

    Disable this task
    Check, or clear, to selectively run this task.

    Add condition to task
    Make task run only when a certain condition is met. 
    You can find conditions on Atlassian Marketplace or implement your own.  

    Select the PHPUnit executable that you wish to configure for this task (e.g. "PHPUnit 3.3.x" or "PHPUnit"). The executable that you select will become one of the task's capability requirements (and hence, one of the job's requirements). For details, please see Configuring a job's requirements.

    Type the name of the directory/files that will be analyzed recursively by PHPUnit. The default value is "." (i.e. the working subdirectory, if specified). You must specify at least one argument.

    Environment variables (Optional)
    Additional system environment variables that you want to pass to your build. Note that existing environment variables are automatically available to the executable. You can also include Bamboo global or build-specific variables (see Using global, plan or build-specific variables).
    Multiple variables should be separated with spaces. Parameters with spaces must be quoted (e.g ANT_OPTS="-Xms200m -Xmx700m").

    Working subdirectory (Optional) 
    An alternative subdirectory, relative to the job's root directory, where Bamboo will run the executable. The root directory contains everything checked out from the job's configured source repository. If you leave this field blank, Bamboo will look for build files in the root directory. This option is useful if your task has a build script in a subdirectory and the executable needs to be run from within that subdirectory.

    Log test execution to XML file
    Select if you want PHPUnit to record test results in JUnit format.  (info) This format is also used by TestNG.  
    Test Result File — the relative location, and name, of the file to record PHPUnit test results.

    Generate code coverage report in HTML format
    Select if you want PHPUnit to generate code coverage data in HTML format (e.g. for PHPUnit HTML Code Coverage reports). 
    HTML Code Coverage Directory — the relative location of the directory to store the code coverage report. 

  4. Select Save.

PHPUnit task type configuration

Last modified on Jul 18, 2021

Was this helpful?

Provide feedback about this article
Powered by Confluence and Scroll Viewport.