Skip to content

Commit f76b9d2

Browse files
mhan83mhan83
authored
Merge 3f9ba5d into 6c77af4 
2 parents 6c77af4 + 3f9ba5d commit f76b9d2

8 files changed

+4
-130
lines changed

‎docs/basics/test-config-annotation/test-annotation.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export const Highlight = ({children, color}) => ( <span style={{
1919
padding: '0.2rem',
2020
}}>{children}</span> );
2121

22-
Test annotation refers to adding information to your tests, such as a name, build number, tag, and pass/fail status. These annotations are useful for managing your tests and builds (for example, when searching and sorting tests in your [Archives](/test-results/viewing-test-results/#archived-test-results)).
22+
Test annotation refers to adding information to your tests, such as a name, build number, tag, and pass/fail status. These annotations are useful for managing your tests and builds (for example, when filtering tests in your [Test Results](/test-results/viewing-test-results/#filtering-and-searching-automated-test-results)).
2323

2424
You can add annotations after test execution with our [REST API](/basics/test-config-annotation/test-annotation/#sauce-labs-rest-api) or during test execution with the [Selenium JavaScript Executor](/basics/test-config-annotation/test-annotation/#selenium-javascript-executor). You can also use [sample test frameworks](https://github.com/saucelabs-training) to automatically add annotations to your tests.
2525

@@ -165,7 +165,7 @@ public class TextInputTest extends TestBase {
165165

166166
<p><span className="sauceGreen">Virtual Devices Only</span></p>
167167

168-
You can manage your tests more effectively from your Dashboard and Archives with annotations. The Sauce Labs REST API includes an [update_job](/dev/api/jobs/#update-a-job) method that you can use to set a name, tags, pass/fail status, and custom data for your test after it runs. To automate test annotation with this method, you'll want to create a simple set of functions to perform the put request for you.
168+
You can manage your tests more effectively from your Dashboard with annotations. The Sauce Labs REST API includes an [update_job](/dev/api/jobs/#update-a-job) method that you can use to set a name, tags, pass/fail status, and custom data for your test after it runs. To automate test annotation with this method, you'll want to create a simple set of functions to perform the put request for you.
169169

170170
<details>
171171
<summary>Sauce Labs REST API Examples</summary>
@@ -187,8 +187,8 @@ You can set the following [test configuration options](/basics/test-config-annot
187187
| Option | Description | Key | Value Type | Example |
188188
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------- |
189189
| Test Names | Used to record test names for jobs and make it easier to find individual tests | `name` | string | `"name" : "my example name"` |
190-
| Build Numbers | Used to associate jobs with a build number or app version, displayed on the Dashboard and Archives views | `build` | string | `"build": "build-1234"` |
191-
| Tagging | User-defined tags for grouping and filtering jobs in the Dashboard and Archives | `tags` | list | `"tags": ["tag1","tag2","tag3"]` |
190+
| Build Numbers | Used to associate jobs with a build number or app version, displayed on the Dashboard views | `build` | string | `"build": "build-1234"` |
191+
| Tagging | User-defined tags for grouping and filtering jobs in the Dashboard | `tags` | list | `"tags": ["tag1","tag2","tag3"]`
192192
| Pass/Fail Status | Selenium and Appium handle sending commands to control a browser or app, but don't report to the server whether a test passed or failed. To record pass/fail status on Sauce, set the passed flag on the job.<br/>Since you can't know in advance whether a test passed or failed, this flag can't be set in the initial configuration. | `passed` | boolean | `"passed": "true"` |
193193
| Custom Data | User-defined custom data that will accept any valid JSON object, limited to 64KB in size. | `customData` | object | `"customData": {"release": "1.0", "commit": "0k392a9dkjr", "staging": true, "execution_number": 5, "server": "test.customer.com"}` |
194194

0 commit comments

Comments
 (0)