PHPUnit Extended With Test Explorer for VSCode

Setup

• Install phpunit or have phpunit installed through composer.
• Right click on the extension and select Extension Settings to change the configuration.
• You could also change the configuration using the settings.json file.
• Here is an example of values you can add to settings.json.

{
    "phpunit.args": [], // Shared arguments between commandLine and testExplorer
    "phpunit.configurationPath": "path/to/phpunit.xml",
    "phpunit.execPath": "path/to/phpunit", // If this value is set to '' it will try to use the composer phpunit installation.
    "phpunit.envVars": {
        // Here you can define the environment variables to be set before executing phpunit
        "XDEBUG_CONFIG": "idekey=VSCODE"
    },
    "phpunit.commandLine.args": [
        "--testdox"
    ],
    "phpunit.commandLine.excludedGroups": [
        // Groups to be excluded when running the TestSuiteWithExclusions command
    ],
    "phpunit.commandLine.scriptsAfterTests": {
        "ok": [
            {
            "command": "some-command-with-args",
            "args": ["-status=ok"]
            },
            "another-command-without-args"
        ],
        "error": []
    },
    "phpunit.commandLine.showOutput": "always",
    "phpunit.testExplorer.fileRegex": ".*(test|tests)\\w*\\.php",
    "phpunit.testExplorer.functionRegex": "(\\/\\*.*?(@test).*?\\*\\/\\s*?)|((public\\s+){0,1}function\\s+(test\\w*))",
    "phpunit.testExplorer.multilineFunctionRegex": true,
    "phpunit.testExplorer.folderPattern": "**/{test,tests,Test,Tests}/**/*.php",
    "phpunit.testExplorer.discoverAllTests": true
}

Settings

Combined Settings

• args sets the arguments that are used by both the command line and the test explorer.
• configurationPath determines the path to the phpunit.xml configuration file.
• execPath determines the phpunit path.
• envVars allows this extension to hook into the debugger (github.com/felixfbecker/vscode-php-debug) as show in the setup section.
• workingDirectory allows you to set the working directory of the process that runs the phpunit command.

Command Line Settings

• args allows setting hte arguments for the command line.
• excludedGroups excludes the given groups when running the TestSuiteWithExclusions command.
• scriptsAfterTest runs the given scripts based upon the pass/fail status of the test.
• showOutput determines when to show the output console after the tests run. I would recommend leaving this as the default always.
• showOutputInTerminal re-runs the test and show the output within a terminal instead of an output channel. This only occurs when the conditions in phpunit.commandLine.showOutput are met.

Test Explorer Settings

• args allows setting arguments for the tests. Some arguments, such as --testdox, will not allow the test explorer tests to pass.
• discoverAllTests allows all tests with paths that match the folderPattern glob AND the fileRegex to be added to the test explorer.
• fileRegex is used to determine the files to add to the test explorer.
• The file in the active editor is added based solely upon the fileRegex.
• folderPattern is only used when discoverAllTests is set to true.
• functionRegex sets the regex to find functions within a test file.
• highlightFailureLocation determines if the line responsible for the failing test should have a background highlight. Change the theme color using workbench.colorCustomizations and change the color with ID phpunit.failedTestBackground.
• multilineFunctionRegex allows the functionRegex to look at multiple lines. The functionRegex adds the s flag.
• parallelTests allows multiple tests to run concurrently. I would not recommend setting this above 8.
• showOutput is similar to the command line setting of the same name. Shows the output console when specified.
• showOutputInTerminal re-runs the test and show the output within a terminal instead of an output channel. This only occurs when the conditions in phpunit.testExplorer.showOutput are met.
• timeout sets the time a test can run. A test that does not complete before the timeout will be cancelled.
• verboseTestExplorerOutput allows output to show for each test, but can take longer to run.

How to use

Test Explorer

Run using the Testing tab.

Command Line

Run with (Cmd+Shift+P on OSX or Ctrl+Shift+P on Windows and Linux) and execute:

• PHPUnit Test Nearest: This command will search the nearest function from the cursor position until the file's beginning.

• PHPUnit Test Current File: This command will test the current active file.

• PHPUnit Test All Suite: This command will run all the test suite.

• PHPUnit Test All Suite With Exclusions: This command will run the test suite without the excluded groups set in the configuration.

• PHPUnit Test: This command will show a window to pick the test to run.

• PHPUnit Run Last Test: This command will run the last test ran.

• PHPUnit Cancel Current Test: This command will cancel the current running test.

Credits / Links

• santigarcor
• calebporzio
• VSCode's Extensions Samples
• VSCode's Testing Documentation

License

The MIT License (MIT). Please see the license file for more information.