Overview
In this tutorial, we will create a test in Javascript+Mocha in order to validate a simple application interaction using Sauce Labs for cloud mobile testing.
Please note
Within this tutorial, only one Test Execution will be used; it will contain one Test Run with all the results for the different used browsers. Thus, the overall test run status will be affected by the results made for all the browsers.
Instead of this approach, a different one could be creating a Test Execution per each browser; this would require some adaptions in order to produce a XML report per each used browser. This approach would give the ability to take advantage of Test Environments (more info in Working with Test Environments).
Requirements
- Install NodeJS
- Install all dependencies using "npm"
Description
This tutorial is based on some examples from this project.
You may start by cloning the project's repository.
git clone https://github.com/dwyl/learn-nightwatch
Nightwatch.js configuration is managed in a configuration file, similar to the following one.
The capabilities (devices/browsers) we want, along with the reporter/JUnit related configurations, are all defined in the previous configuraiton file.
Nightwatch.js provides a built-in JUnit reporter, which we'll use.
The test use the Page Objects pattern, implemented in several classes such as the following one.
Test: Verify the existence of a meny entry
var expect = require('chai').expect;
var HomePage = require('../pages/home.page'),
MenuPage = require('../pages/menu.page');
describe('Mocha Spec Sync example', function() {
it("verify Arcs entry in menu", function() {
HomePage.click("Graphics");
expect(MenuPage.arcsEntry.isVisible()).to.equal(true);
});
});
Running tests locally
Test(s) then can be run using NPM "test" task.
npm test
After successfully running the tests and generating the JUnit XML reports (e.g. androidemulator.android.5_1.apidemos-debug_apk?raw=true.xml, samsunggalaxys4emulator.android.4_4.apidemos-debug_apk?raw=true.xml), it can be imported to Xray (either by the REST API or through the Import Execution Results action within the Test Execution).
We'll use some shell-script sugar to do that for us and at the same time populate the Test Environment field on the Test Execution issues that will be created.
PROJECT=CALC JIRASERVER=https://yourjiraserver USERNAME=user PASSWORD=pass FIXVERSION=v3.0 for FILE in `ls *.xml`; do TESTENV=$(echo $FILE | cut -d "." -f 1-3) curl -H "Content-Type: multipart/form-data" -u $USERNAME:$PASSWORD -F "file=@$FILE" "$JIRASERVER/rest/raven/1.0/import/execution/junit?projectKey=$PROJECT&testEnvironments=$TESTENV&fixVersion=$FIXVERSION" done
In our case, two Test Executions will be created: one per each mobile device. Each one contains the same Test case.
Mocha tests are mapped to Generic Tests in Jira, and the Generic Test Definition field contains the namespace, the name of the class, and the method name that implements the Test case.
The execution screen details will provide information on the overall test run result.
Running in the cloud using SauceLabs
Before running the test(s), you need to export some environment variables with your Sauce Lab's username along with the respective access key, which you can obtain from within the User Settings section in your Sauce Lab's profile page.
export SAUCE_USERNAME=<your Sauce Labs username> export SAUCE_ACCESS_KEY=<your Sauce Labs access key>
Test(s) then can be run in parallel using NPM.
npm run sauce
Multiple JUnit XML files will be created, one per capability (device+browser), under the node_modules/nightwatch/reports/ folder.
Please note
By using the junit-merge utility we can merge multiple JUnit XML reports and upload the merged report to Xray, although we'll loose the visibility of results on a per Test Environment basis.
If we want to have visibility of the results per Test Environment, then we need to separately upload them and identify the Test Environment on each REST API request.
In Sauce Labs you can see some info about it.
