Mocha / JavaScript
Testmo works with any test automation tool, including the popular Mocha JavaScript unit testing framework. This quickstart guide provides an overview of how to report JavaScript & Mocha test automation results to Testmo.
Run Mocha & generate XML file
Mocha can generate JUnit-style XML files, which has become a standard format to exchange test results between tools. You just need to install the popular mocha-junit-reporter
package. Then simply enable this reporter in your Mocha config and configure the filename and recommended settings:
This will run your Mocha tests and automatically write all test results to an XML file in the results
directory. You can learn more about available configuration options in the package 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:
We can now send the Mocha 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):
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 Mocha with Testmo CLI
In the above example, we first launched Mocha 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 Mocha (testmo
then starts and waits for Mocha 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 Mocha exit code
➡️ Bonus: Custom fields
Testmo also supports additional custom fields for test runs, threads and tests. You can learn more here:
Mocha does not yet directly support fields/properties per test, but Testmo can also parse and read fields/properties from the test output. And Mocha lets you specify the output it should write 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.
More resources & references
Now that you are familiar with submitting your Mocha test results to Testmo, you might also find the following additional examples, topics and references useful for more advanced workflows.
Last updated