JUnit-XML based Mocha report

Using the terminal, you can create JUnit-XML based reports from Mocha and upload them to Test Management.

Executing a Test Case with Mocha

You can initiate an example Mocha project with this sample code to execute a Test Case.

const { assert } = require("chai");
var DemoTest = require("../src/demoTest.js");
var myObj = new DemoTest();
var chai = require("chai");
var expect = chai.expect;
describe ("Test Suite 1", function () {
    it("Test the add functionality 1", function(){
        expect(myObj.add(1,2)).to.be.equal(3);       
    })
    it("Test the equality functionality 1", function(){
        expect(myObj.add(1,2)).to.be.equal(3);       
    })
})
describe ("Test Suite 2", function () {
    it("Test the add functionality 2", function(){
        expect(myObj.add(1,2)).to.be.equal(3);       
    })
    it("Test the equality functionality 2 ", function(){
        expect(myObj.add(1,2)).to.be.equal(3);       
    })
})

Create test report with Mocha

Install the mocha-junit-reporter package.

npm install -g mocha-junit-reporter

Enable the ‘mocha-junit-reporter’ in the configuration file.

"module.exports = {
  reporter: 'mocha-junit-reporter',
  reporterOptions: [
    ""mochaFile=results/test-results.xml"",
    ""testCaseSwitchClassnameAndName=1"",
    ""outputs=1""
  ]
}"

Sample JUnit-XML report generated from Mocha in the results folder.

<?xml version="1.0" encoding="UTF-8"?>
<testsuites name="Mocha Tests" time="0.005" tests="4" failures="0">
  <testsuite name="Root Suite" timestamp="2023-06-26T14:06:15" tests="0" time="0.000" failures="0">
  </testsuite>
  <testsuite name="Test Suite 1" timestamp="2023-06-26T14:06:15" tests="2" file="/Users/bhavyakarimikonda/Documents/Automation_Frameworks/Mocha/specs/demoTest.spec.js" time="0.003" failures="0">
    <testcase name="Test the add functionality 1" time="0.001" classname="Test Suite 1 Test the add functionality 1">
    </testcase>
    <testcase name="Test the equality functionality 1" time="0.000" classname="Test Suite 1 Test the equality functionality 1">
    </testcase>
  </testsuite>
  <testsuite name="Test Suite 2" timestamp="2023-06-26T14:06:15" tests="2" file="/Users/bhavyakarimikonda/Documents/Automation_Frameworks/Mocha/specs/demoTest.spec.js" time="0.001" failures="0">
    <testcase name="Test the add functionality 2" time="0.000" classname="Test Suite 2 Test the add functionality 2">
    </testcase>
    <testcase name="Test the equality functionality 2 " time="0.000" classname="Test Suite 2 Test the equality functionality 2 ">
    </testcase>
  </testsuite>
</testsuites>

Steps to upload the JUnit-XML test report

Open the project directory in the Terminal and load the variables.

export TEST_MANAGEMENT_API_TOKEN="*************28a42"
export TEST_MANAGEMENT_PROJECT_NAME="<Project Name>"
export JUNIT_XML_FILE_PATH="<Report Path>"
export TEST_RUN_NAME="<Test Run Name"

Upload the JUnit-XML test report using curl command.

curl -k -X POST https://test-management.browserstack.com/api/v1/import/results/xml/junit \
-u $TEST_MANAGEMENT_API_TOKEN \
-F project_name="$TEST_MANAGEMENT_PROJECT_NAME" \
-F "file_path=@$JUNIT_XML_FILE_PATH" \
-F test_run_name="$TEST_RUN_NAME"

You can also upload JUnit-XML test report with Mocha using CI/CD.

Access the test run report from the console generated URL

After your report is successfully uploaded, you see a message similar to the following in your terminal. This message also generates a URL with "url" parameter that you can use to access your automated test run.

{"message":"File uploaded successfully.","url":"https://test-management.browserstack.com/projects/<project id>/test-runs/<test run id>","success":true}

View test run report in Test Management

1. Log in to the BrowserStack Test Management dashboard.
2. Select the relevant project that has the test report uploaded.
3. Click Test Runs.
4. Open the Test Run generated from automation test exectution.
5. You will find all the test cases with their respective results here.