Pytest – Testmo

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

Run Pytest & generate XML file

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

$ pytest --junitxml=results/test-results.xml

This will run your tests with Pytest 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 Pytest config file. You can learn more about all the available options and Pytest's JUnit support in the Pytest documentation.

Submit test results to Testmo

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 Pytest 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):

Full example

Single line

Windows

$ export TESTMO_TOKEN=********
$ testmo automation:run:submit \
  --instance https://<your-name>.testmo.net \
  --project-id 1 \
  --name "Pytest test run" \
  --source "unittests" \
  --results results/*.xml

If you run this example on a single command line, make sure to remove the backspace:

$ export TESTMO_TOKEN=********
$ testmo automation:run:submit --instance https://<your-name>.testmo.net --project-id 1 --name "Pytest test run" --source "unittests" --results results/*.xml

On Windows, the command line uses a slightly different syntax to set a variable:

> set TESTMO_TOKEN=********
> testmo automation:run:submit --instance https://<your-name>.testmo.net --project-id 1 --name "Pytest 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 Pytest with Testmo CLI

In the above example, we first launched Pytest 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 Pytest (testmo then starts and waits for Pytest 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 Pytest exit code

Launch Pytest with CLI tool

We can ask our CLI tool to launch Pytest, 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 "Pytest test run" \
  --source "unittests" \
  --results results/*.xml \
  -- pytest --junitxml=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:

Use Pytest's record_property fixture to add additional properties to the XML file for individual tests. Testmo will automatically read these properties from the XML file 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 Pytest

To log additional fields for a test, you can use the record_property fixture:

 def test_function(record_property):
    record_property("author", "Adrian")
    record_property("language", "english")
    record_property("url:github", "https://github.com/project/code.py")
  
    # Testmo also supports automation steps, including statuses & sub fields
    record_property("step[passed]", "The first step")
    record_property("step[passed]", "The second step")
    record_property("step[failed]", "The third step")

    # You can also include attachment links for test artifacts
    record_property("attachment", "https://ci-server/browser.log")
    record_property("attachment", "https://ci-server/screenshot.png")

    assert True

You can learn more about Pytest's API in their documentation. And you can learn more about fields and types supported by Testmo.

More resources & references

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