Skip to main content

JUnit-XML based report upload using Nightwatch JS

You can create and upload test reports to BrowserStack Test Management using Nightwatch JS. This enables you to sync test case reports on BrowserStack Test Management from your terminal.

Executing a test case with Nightwatch JS

You can initiate an example Nightwatch JS project with this sample code to execute a test case.

module.exports = {
    before : function(browser) {
      //Declaring Global Timeout
      browser.globals.waitForConditionTimeout = 5000;
    },
    'Wikipedia Search 1' : function (browser) {
    browser
      .url('https://www.wikipedia.org/')
      .assert.title('Wikipedia')
      .setValue('#searchInput', 'Google')
      .click('button[type="submit"]')
      .assert.containsText('h1#firstHeading', 'Google')
      .assert.title('Google - Wikipedia')
  },
  'Duck Duck Go Search 1' : function (browser) {
    browser
      .url('https://duckduckgo.com/')
      .assert.title('DuckDuckGo')
      .setValue('#searchbox_input', 'Google')
      .click('button[type="submit"]')
      .assert.title('Google at DuckDuckGo')
  },
  after : function(browser) {
    browser.end();
  }
}

Create JUnit-XML test report with Nightwatch JS

Nightwatch outputs JUnit-XML reports by default and reports can be accessed in the output_folder.

In the configuration file, define the output folder.

"module.exports = {
  output_folder: 'tests_output'
}"

Sample JUnit-XML report generated with NightwatchJS.

<?xml version="1.0" encoding="UTF-8" ?>
<testsuites errors="0" failures="1" tests="2">
    <testsuite name="first_demo" errors="0" failures="1" hostname="" id="" package="first_demo" skipped="0" tests="2" time="16.95" timestamp="">
        <testcase name="Wikipedia Search 1" classname="first_demo" time="2.406" assertions="3"></testcase>
        <testcase name="Duck Duck Go Search 1" classname="first_demo" time="6.033" assertions="1">
            <failure message="Testing if the page title equals &#39;DuckDuckGo&#39; in 5000ms - expected &#34;is &#39;DuckDuckGo&#39;&#34; but got: &#34;DuckDuckGo — Privacy, simplified.&#34; (5158ms)"> at Duck Duck Go Search 1 (/Users/bhavyakarimikonda/Documents/Automation_Frameworks/Nightwatch/tests/first_demo.js:22:15)</failure>
        </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"
export USER_EMAIL="<Email Address>"
Note: You can get your TEST_MANAGEMENT_API_TOKEN from the Active API Key section in the Settings of BrowserStack Test Management.

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" \
-F user_email=$USER_EMAIL
Note: Report upload will take a few seconds to about a minute depending on the size of your test-suite. Do not interrupt the cURL command until you get the response back.

You can also upload JUnit-XML test report with NightwatchJS 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.

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback

Is this page helping you?

Yes
No

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback!

Talk to an Expert
Download Copy