| id | title | sidebar_label |
|---|---|---|
test-status |
Setting Test Statuses |
Setting Test Statuses |
import useBaseUrl from '@docusaurus/useBaseUrl'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
- How to use the JavaScript Executor to update the status of your test at the end of the session.
- How to use the Sauce Labs REST API to update the status of your test after it has already completed.
You can use the Selenium JavaScript Executor to annotate your test in the @after hook. This is the ideal means of writing your tests to interpret the results as a pass/fail and update the status accordingly.
:::caution JavaScript Executor The JavaScript Executer commands can only be run while the test is in session. Once the test is complete, the JavaScript Executor commands are no longer applicable and you must use the REST API to update the test. :::
Watch this video for a demonstration of using the Selenium JavaScript Executor to annotate your test result with a Passed/Failed status.
<iframe width="560" height="315" src="https://www.youtube.com/embed/iaKRGjO-L8Y" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>The annotation for calling the JavaScript Executor in your test differs slightly for each framework and language, which are provided in the following code snippet examples. Refer to our Sauce Labs Demonstration Code Repositories on GitHub for further information, and more context, on annotating your tests to record the pass/fail status.
<Tabs defaultValue="java" values={[ {label: 'Java', value: 'java'}, {label: 'C#', value: 'c#'}, {label: 'Python', value: 'python'}, {label: 'NodeJS', value: 'node'}, {label: 'Ruby', value: 'ruby'}, ]}>
- JUnit 5
https://github.com/saucelabs-training/demo-java/blob/docs-1.0/selenium-examples/src/test/java/com/saucedemo/selenium/demo/SeleniumTest.java#L56-L68- TestNG
https://github.com/saucelabs-training/demo-java/blob/docs-1.0/selenium-testng-examples/src/test/java/com/saucedemo/selenium/testng/demo/SeleniumTest.java#L43-L47- MSTest
https://github.com/saucelabs-training/demo-csharp/blob/docs-1.0/SauceExamples/SeleniumMsTest/Onboarding/InstantSauceTest.cs#L83-L85- NUnit
https://github.com/saucelabs-training/demo-csharp/blob/docs-1.0/DotnetCore/Sauce.Demo/Core.Selenium.Examples/AllTestsBase.cs#L61-L64- PyTest
https://github.com/saucelabs-training/demo-python/blob/docs-1.0/examples/w3c-examples/test_pytest_chrome.py#L33-L38- Robot Framework
https://github.com/saucelabs-training/demo-python/blob/docs-1.0/examples/robotframework/desktop_web/Tests/resource.robot#L58-L61- WebdriverIO
The Sauce Service for WebdriverIO does the reporting for you automatically.
- Nightwatch
https://github.com/saucelabs-training/demo-js/blob/docs-1.0/nightwatch/appium-web/examples/update-sauce-real-devices/tests/custom-commands/customSauceLabsEnd.js#L30-L35- RSpec
https://github.com/saucelabs-training/demo-ruby/blob/docs-1.0/intro/spec/spec_helper.rb#L20-L24If you did not use the JavaScript Executor to update the status of your test as an assertion in the test code, you can still use the Sauce Labs REST API to update the test status.
- A Sauce Labs account (Log in or sign up for a free trial license)
- Your Sauce Labs Username and Access Key
- The JOB_ID for the test you wish to update
Call the update_jobs REST API and pass the parameter "passed" with a value of "true" or "false".
curl PUT -X -u USERNAME:ACCESS_KEY \'https://saucelabs.com/rest/v1/USERNAME/jobs/JOB_ID' \
--header 'Content-Type: application/json' \
--data-raw '{
"data": {
"passed": "true"
}
}'You can obtain the JOB_ID either by:
- Collecting and storing the web driver SessionId for the test, which Sauce Labs uses as the JOB_ID
- testFinding the Id value in the test's Metadata tab on Sauce Labs, as shown in the following figure
<img src={useBaseUrl('img/test-results/test-results-meta-id-updated.png')} alt="Test results metadata - JOB_ID"/>