Testmo works with any test automation tool, including the popular JUnit unit testing framework for Java and Kotlin, as well as any other JVM-based language and testing framework. This quickstart guide provides an overview of how to report Java/Kotlin/JVM test automation results to Testmo.
JUnit (or more precisely, the Java Ant build tool) popularized the JUnit XML report file format, which has become a standard format to exchange test results between tools. Testmo fully supports this format so you can directly submit test results without any custom programming. You simply need to configure your build tool and environment to generate such XML files when running your tests:
Once configured, your build tool will run your tests and automatically write all test results to one or more XML files. Most Java build tools and environments will also automatically generate JUnit-style XML files by default without any further configuration.
To submit your test results to Testmo, you simply use our cross-platform
testmoCLI tool. The CLI tool is distributed as an NPM package and is easy to install on any system. Simply install our official
$ npm install -g @testmo/testmo-cli
$ testmo -h
Usage: testmo [options] [command]
We can now send the JUnit 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
testmoCLI tool so submit our results (note that we first set the
TESTMO_TOKENvariable, which the tool expects). Also make sure to adjust the path to your XML file(s) with the
$ export TESTMO_TOKEN=********
$ testmo automation:run:submit \
--instance https://<your-name>.testmo.net \
--project-id 1 \
--name 'JUnit test run' \
--source 'unittests' \
If you run this example on a single command line, make sure to remove the backspaces:
$ export TESTMO_TOKEN=********
$ testmo automation:run:submit --instance https://<your-name>.testmo.net --project-id 1 --name 'JUnit 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 'JUnit test run' --source 'unittests' --results results/*.xml
That's it! 🎉 This will automatically analyze the XML result file(s), 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.
Usually your build system launches your test runner to generate the XML file and then you use our CLI tool to submit the results in a second step. As an improvement to this workflow, we can ask our CLI tool to launch the tests (
testmothen starts and waits for tests 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 test runner exit code
Now that you are familiar with submitting your JUnit/Java/Kotlin test results to Testmo, you might also find the following additional examples, topics and references useful for more advanced workflows.