Skip to content

Commit 9d172d3

Browse files
authored
Get started docs (#321)
* working accessibility example * add intro section * update menu structure * menu items moved and duplicates deleted * better promo for overview * remove comment
1 parent 5d2ca1b commit 9d172d3

19 files changed

+163
-359
lines changed

java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/examples/AccessibilityExample.java

+2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ public void storeVariables() {
2323
@Test
2424
public void accessibilityExample() {
2525
driver.get("https://www.saucedemo.com/");
26+
//store the accessibility results into an object
2627
Results accessibilityResults = session.getAccessibilityResults();
28+
//if you want, you can assert on the accessibilityResults
2729
}
2830
}

website/docs/BROWSER_OPTIONS.md

-88
This file was deleted.

website/docs/SAUCE_OPTIONS.md

-89
This file was deleted.

website/docs/TEST_RUNNERS.md

-30
This file was deleted.
+29-63
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,17 @@
11
---
2-
id: accessibility
32
title: Accessibility Testing
43
---
54

6-
As of version 1.2, Sauce Bindings supports the new Sauce Labs
5+
As of version 1.2, Sauce Bindings supports the new Sauce Labs
76
[Deque axe™ Integration](https://docs.saucelabs.com/basics/integrations/deque/index.html)
87

9-
* The Session classes now have a method to obtain accessibility results, which does two basic things:
10-
* Populates the new Accessibility tab in the Sauce Labs UI for a given job
11-
with the accessibility violations found during the test run.
12-
* Returns the specific violations found in the code. The format of these results varies by language, and it is left to the user
13-
to determine how best to make use of them in their code if so desired.
14-
* The Java code is implemented using Deque's [Axe Core Maven HTML Jar](https://github.com/dequelabs/axe-core-maven-html)
15-
* This implementation provides access to all the advanced features.
16-
* As a wrapper, Sauce bindings provides 3 method signatures for getting accessibility results, as outlined below.
17-
* The Ruby and Python code is implemented with the new [sa11y](https://github.com/saucelabs/sa11y) project
18-
* Sa11y is a minimalist implementation of Deque's axe™ functionality.
19-
* The accessibility results method allows you to specify a different js library, the ability to turn off frame support,
20-
and the ability to turn on cross-origin frame support. Examples are provided below.
21-
228
import Tabs from '@theme/Tabs';
239
import TabItem from '@theme/TabItem';
2410

2511
<Tabs
2612
defaultValue="java"
2713
values={[
28-
{ label: 'Java', value: 'java', },
29-
{ label: 'Python', value: 'python', },
30-
{ label: 'Ruby', value: 'ruby', },
31-
{ label: 'C#', value: 'csharp', },
14+
{ label: 'Java', value: 'java', }
3215
]
3316
}>
3417

@@ -37,61 +20,44 @@ values={[
3720
<Tabs
3821
defaultValue="junit5"
3922
values={[
40-
{ label: 'JUnit 5', value: 'junit5', },
41-
{ label: 'JUnit 4', value: 'junit4', },
42-
{ label: 'TestNG', value: 'testng', },
43-
{ label: 'Direct', value: 'direct', },
23+
{ label: 'JUnit 5', value: 'junit5', }
4424
]
4525
}>
4626

4727
<TabItem value="junit5">
4828

4929
```java reference
50-
https://github.com/saucelabs/sauce_bindings/tree/website-1.2.0/java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/examples/AccessibilityTest.java
51-
```
52-
53-
</TabItem>
54-
<TabItem value="junit4">
55-
56-
```java reference
57-
https://github.com/saucelabs/sauce_bindings/tree/website-1.2.0/java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/AccessibilityTest.java
58-
```
59-
60-
</TabItem>
61-
<TabItem value="testng">
62-
63-
```java reference
64-
https://github.com/saucelabs/sauce_bindings/tree/website-1.2.0/java/testng/src/test/java/com/saucelabs/saucebindings/testng/examples/AccessibilityTest.java
65-
```
66-
67-
</TabItem>
68-
<TabItem value="direct">
30+
import com.deque.html.axecore.results.Results;
31+
import com.saucelabs.saucebindings.SauceSession;
32+
import com.saucelabs.saucebindings.junit5.SauceBindingsExtension;
33+
import org.junit.jupiter.api.BeforeEach;
34+
import org.junit.jupiter.api.Test;
35+
import org.junit.jupiter.api.extension.RegisterExtension;
36+
import org.openqa.selenium.WebDriver;
37+
38+
public class AccessibilityExample {
39+
WebDriver driver;
40+
SauceSession session;
41+
42+
@RegisterExtension static SauceBindingsExtension sauceExtension = new SauceBindingsExtension();
43+
44+
@BeforeEach
45+
public void storeVariables() {
46+
session = sauceExtension.getSession();
47+
driver = sauceExtension.getDriver();
48+
}
49+
50+
@Test
51+
public void accessibilityExample() {
52+
driver.get("https://www.saucedemo.com/");
53+
Results accessibilityResults = session.getAccessibilityResults();
54+
}
55+
}
6956

70-
```java reference
71-
https://github.com/saucelabs/sauce_bindings/tree/website-1.2.0/java/main/src/test/java/com/saucelabs/saucebindings/examples/AccessibilityTest.java
7257
```
7358

7459
</TabItem>
7560
</Tabs>
7661

77-
</TabItem>
78-
<TabItem value="python">
79-
80-
```python reference
81-
https://github.com/saucelabs/sauce_bindings/tree/website-1.2.0/python/tests/examples/test_accessibility.py
82-
```
83-
84-
</TabItem>
85-
<TabItem value="ruby">
86-
87-
```ruby reference
88-
https://github.com/saucelabs/sauce_bindings/tree/website-1.2.0/ruby/spec/examples/accessibility_spec.rb
89-
```
90-
91-
</TabItem>
92-
<TabItem value="csharp">
93-
94-
**C# bindings are coming soon...**
95-
9662
</TabItem>
9763
</Tabs>

website/docs/core-concepts/Roadmap.md

-22
This file was deleted.

0 commit comments

Comments
 (0)