Docs Integrations REST API Back to Testmo

PHPUnit

Testmo works with any test automation tool, including the popular PHPUnit unit testing framework for PHP. This quickstart guide provides an overview of how to report PHPUnit test automation results to Testmo.

PHPUnit comes with full support for generating JUnit-style XML files, which has become a standard format to exchange test results between tools.

$ phpunit --log-junit results/test-results.xml

This will run your tests with PHPUnit and automatically write all test results to an XML file in the results directory. You can also configure a different directory or set various options in your PHPUnit config file. You can learn more about all the available options and PHPUnit's JUnit support in the PHPUnit documentation.

To submit your test results to Testmo, you simply use our cross-platform testmo CLI tool. The CLI tool is distributed as an NPM package and is easy to install on any system. Simply install our official @testmo/testmo-cli NPM package:

$ npm install -g @testmo/testmo-cli
$ testmo -h

Usage: testmo [options] [command]
[...]

We can now send the PHPUnit test results to Testmo. To do this, make sure to generate an API key in Testmo from your profile page. The API key is used to authenticate with Testmo to send the results. We can then use the testmo CLI tool so submit our results (note that we first set the TESTMO_TOKEN variable, which the tool expects):

$ export TESTMO_TOKEN=********
$ testmo automation:run:submit \
  --instance https://<your-name>.testmo.net \
  --project-id 1 \
  --name "PHPUnit test run" \
  --source "unittests" \
  --results results/*.xml
See command output
Collecting log files ..
Found 1 result file with a total of 855 tests
Created new automation run (ID: 254)
Created new thread (ID: 608)
Sending tests to Testmo ..
Uploading: [|||||||||||||||||||||||||] 100% | ETA: 0s | 855/855 tests
Successfully sent tests and completed run
Marked the run as completed

That's it! 🎉 This will automatically analyze the XML result file, create a new test run in Testmo, submit all tests & results and mark the run as completed. There's no need to manually create any tests, map tests or IDs or build any custom API code. Everything is handled automatically for you.

➡️ Bonus: Launch PHPUnit with Testmo CLI

In the above example, we first launched PHPUnit to generate the XML file and then used our CLI tool to submit the results in a second step. As an improvement to the above example, we can ask our CLI tool to launch PHPUnit (testmo then starts and waits for PHPUnit to finish). This has the following additional benefits:

a) Capture full console output and send it to Testmo b) Accurately measure test times c) Record the PHPUnit exit code

Launch PHPUnit with CLI tool

We can ask our CLI tool to launch PHPUnit, so we can capture the console output and more:

$ export TESTMO_TOKEN=********
$ testmo automation:run:submit \
  --instance https://<your-name>.testmo.net \
  --project-id 1 \
  --name "PHPUnit test run" \
  --source "unittests" \
  --results results/*.xml \
  -- phpunit --log-junit results/test-results.xml
    ^ space!

Also learn more and see other examples in the full Testmo CLI guide.

➡️ Bonus: Custom fields

Testmo also supports additional custom fields for test runs, threads and tests. You can learn more here:

PHPUnit does not directly support fields/properties per test, but Testmo can also parse and read fields/properties from the test output. And PHPUnit adds any output you write to the console during your test to the results XML file. So we can use Testmo's output property syntax to record any additional custom fields for our tests and submit these as fields to Testmo. Testmo supports many automation field types including strings, links, rich HTML, steps and attachment links.

Add custom fields with PHPUnit

To log additional fields for a test, simply use Testmo's output property syntax and write any fields to standard out during the test.

<?php

use PHPUnit\Framework\TestCase;

final class UserProfileTest extends TestCase
{
  public function testUpdateUserEmail()
  {
    echo "[[PROPERTY|author=Adrian]]\n";
    echo "[[PROPERTY|language=english]]\n";
    echo "[[PROPERTY|url:github=https://github.com/project/code.php]]\n";
    
    // Testmo also supports automation steps, including statuses & 
    // sub fields. This example uses multi-line properties.
    echo "[[PROPERTY|step[passed]]]\nThe first step\n[[/PROPERTY]]\n";
    echo "[[PROPERTY|step[passed]]]\nThe second step\n[[/PROPERTY]]\n";
    echo "[[PROPERTY|step[failed]]]\nThe third step\n[[/PROPERTY]]\n";

    // You can also include attachment links for test artifacts
    echo "[[PROPERTY|attachment=https://ci-server/browser.log]]\n";
    echo "[[PROPERTY|attachment=https://ci-server/screenshot.png]]\n";

    // [..]
  }
}

You can learn more about fields and types supported by Testmo.

Now that you are familiar with submitting your PHPUnit test results to Testmo, you might also find the following additional examples, topics and references useful for more advanced workflows.

PreviousNUnitNextPlaywright

Last updated