Skip to content

Commit

Permalink
Merge branch 'main' into screener-ultimate-eol
Browse files Browse the repository at this point in the history
  • Loading branch information
konraddysput authored Nov 28, 2024
2 parents 875c110 + ff828bd commit 029d7db
Show file tree
Hide file tree
Showing 106 changed files with 2,380 additions and 658 deletions.
6 changes: 3 additions & 3 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@

# Dev/API:
/docs/dev/api/error-reporting/ @rick-bt @peter-shao
/docs/dev/api/rdc/ @kristofmuhi
/docs/dev/api/storage/ @kristofmuhi
/docs/dev/api/rdc/ @saucelabs/rdcdev
/docs/dev/api/storage/ @saucelabs/rdcdev

# Dev:
/docs/dev/cli/ @saucelabs/devx
Expand All @@ -29,7 +29,7 @@
/docs/orchestrate.md @saucelabs/sauce-orchestrate-team

# Mobile apps:
/docs/mobile-apps/ @kristofmuhi
/docs/mobile-apps/ @saucelabs/rdcdev

# Web apps:
/docs/web-apps/ @saucelabs/devx
Expand Down
56 changes: 53 additions & 3 deletions docs/api-testing/sauce-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ If you are already using a tunnel, note that the version has been updated, and t
  defaultValue="US Data Center"
  values={[
    {label: 'US Data Center', value: 'US Data Center'},
    {label: 'US Data Center (SC5)', value: 'US Data Center (SC5)'},
    {label: 'EU Data Center', value: 'EU Data Center'},
    {label: 'EU Data Center (SC5)', value: 'EU Data Center (SC5)'},
  ]}>

<TabItem value="US Data Center">
Expand All @@ -46,6 +48,18 @@ user: '$SAUCE_USERNAME'
api-key: '$SAUCE_ACCESS_KEY'
vm-version: 'v2alpha'
tunnel-identifier: '$SAUCE_USERNAME_TUNNEL'
```
</TabItem>
<TabItem value="US Data Center (SC5)">
```yaml
---
access-key: '$SAUCE_ACCESS_KEY'
metadata: vm-version=v2alpha2
region: us-west
tunnel-name: '$SAUCE_USERNAME_TUNNEL'
user: '$SAUCE_USERNAME'
```
</TabItem>
Expand All @@ -58,15 +72,27 @@ user: '$SAUCE_USERNAME'
api-key: '$SAUCE_ACCESS_KEY'
vm-version: 'v2alpha'
tunnel-identifier: '$SAUCE_USERNAME_TUNNEL'
```
</TabItem>
<TabItem value="EU Data Center (SC5)">
```yaml
---
access-key: '$SAUCE_ACCESS_KEY'
metadata: vm-version=v2alpha2
region: eu-central
tunnel-name: '$SAUCE_USERNAME_TUNNEL'
user: '$SAUCE_USERNAME'
```
</TabItem>
</Tabs>
2. In the **api-config.yaml** file:
- Leave the `rest-url` and `vm-version` values as-is
- Set the `user` and `api-key` values as your own Sauce username and access key, respectively
- Set the `tunnel-identifier` value to whatever you'd like to name your tunnel
- Leave the `rest-url`/`region` and `vm-version` values as-is
- Set the `user` and `api-key`/`access-key` values as your own Sauce username and access key, respectively
- Set the `tunnel-identifier`/`tunnel-name` value to whatever you'd like to name your tunnel
3. Save the **api-config.yaml** file to the Sauce Connect Proxy root folder on your local machine. <br/>
<img src={useBaseUrl('img/api-testing/sauceconnect-folders.png')} alt="API Testing Sauce Connect folder structure" width="350" />
4. Open your terminal and navigate to the Sauce Connect Proxy folder. If your folder is in your home directory, you'd run:
Expand All @@ -77,6 +103,7 @@ tunnel-identifier: '$SAUCE_USERNAME_TUNNEL'
    {label: 'Linux', value: 'Linux'},
    {label: 'Windows', value: 'Windows'},
{label: 'Mac', value: 'Mac'},
{label: 'Linux/Mac/Windows (SC5)', value: 'Linux/Mac/Windows (SC5)'},
  ]}>

<TabItem value="Linux">
Expand All @@ -99,6 +126,13 @@ cd C:\sc-4.9.2-win32
cd sc-4.9.1-osx
```

</TabItem>
<TabItem value="Linux/Mac/Windows (SC5)">

If the Sauce Connect client was installed via package manager, it will be in
your PATH. If installed manually from an archive file, it will be in the
directory where the archive file was extracted.

</TabItem>
</Tabs>

Expand All @@ -109,6 +143,8 @@ cd sc-4.9.1-osx
  values={[
    {label: 'Mac/Linux', value: 'Mac/Linux'},
    {label: 'Windows', value: 'Windows'},
    {label: 'Mac/Linux (SC5)', value: 'Mac/Linux (SC5)'},
    {label: 'Windows (SC5)', value: 'Windows (SC5)'},
  ]}>

<TabItem value="Mac/Linux">
Expand All @@ -122,6 +158,20 @@ bin/sc -c api-config.yaml

```bash
bin\sc.exe -c api-config.yaml
```

</TabItem>
<TabItem value="Mac/Linux (SC5)">

```bash
sc run -c api-config.yaml
```

</TabItem>
<TabItem value="Windows (SC5)">

```bash
sc.exe run -c api-config.yaml
```

</TabItem>
Expand Down
Binary file added docs/assets/private-device-skip-folder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 3 additions & 5 deletions docs/basics/acct-team-mgmt/private-device-mgmt.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,11 +121,9 @@ This feature ensures that selected data remains intact during the device cleanin
- Filepaths or folders associated with specific applications can be retained.
- This is especially useful for retaining data that is crucial for continuous testing or for maintaining certain app states.

By default, the following folders are not cleaned on your private Android devices, ensuring that their contents are retained between sessions (iOS/Android):
- Documents
- Pictures
- Downloads
- DCIM
You can specify multiple folders (comma-separated) ensuring that their contents are retained between sessions (iOS/Android):

![private-device-skip-folder.png](..%2F..%2Fassets%2Fprivate-device-skip-folder.png)

:::note
You can only retain specific folders created inside tmp. You cannot retain the whole tmp folder.
Expand Down
4 changes: 2 additions & 2 deletions docs/basics/data-center-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,9 @@ Sauce Connect Proxy makes its initial connection to saucelabs.com, which resolve
| ---------------------------------- |
| 66.85.48.0/21 |
| 162.222.72.0/21 |
| 34.145.254.128/27 |
| 34.85.201.150/32 |

### EU Central Reguion
### EU Central Region

| Endpoints |
| ---------------------------------- |
Expand Down
4 changes: 3 additions & 1 deletion docs/basics/sso/setting-up-sso-special-cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@ If your Identity Provider has this limitation and you have two organizations at
- [sp2 metadata](https://accounts.saucelabs.com/am/sso/metadata/https%3A%2F%2Faccounts.saucelabs.com%2Fsp2)
- [sp3 metadata](https://accounts.saucelabs.com/am/sso/metadata/https%3A%2F%2Faccounts.saucelabs.com%2Fsp3)
- [sp4 metadata](https://accounts.saucelabs.com/am/sso/metadata/https%3A%2F%2Faccounts.saucelabs.com%2Fsp4)
- The metadata contains different entity ID and different ACS URLs (`spX` instead of `sp`), where `X` is a number from 1 to 4.
- [sp5 metadata](https://accounts.saucelabs.com/am/sso/metadata/https%3A%2F%2Faccounts.saucelabs.com%2Fsp5)
- [sp6 metadata](https://accounts.saucelabs.com/am/sso/metadata/https%3A%2F%2Faccounts.saucelabs.com%2Fsp6)
- The metadata contains different entity ID and different ACS URLs (`spX` instead of `sp`), where `X` is a number from 1 to 6.
- In this tutorial we will use the metadata for the auxiliary SP with entity ID `sp1`. But if you for example want to use the auxiliary **SP3, remember to put `sp3` in all places in the configuration in your IdP instead of `sp1`**.
- Here is an example of the attributes for the auxiliary Sauce Labs SP with entity ID `sp1` that differ from the standard setup with `sp`:

Expand Down
2 changes: 2 additions & 0 deletions docs/basics/sso/setting-up-sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,8 @@ Encryption of the SAML Assertion **is not mandatory**.

You can enable encryption if you want an additional layer of security. You will need to use the certificate (with alias _encryption_) from [the Sauce Labs metadata](https://accounts.saucelabs.com/am/sso/metadata/https%3A%2F%2Faccounts.saucelabs.com%2Fsp).

The Sauce Labs metadata may contain multiple encryption certificates. If you are unsure which certificate to upload, copy the content of the `<ds:X509Certificate>` tag and paste it into a [certificate decoder](https://www.sslshopper.com/certificate-decoder.html). Then, select the certificate that has a longer validity period.

In the encryption process, the Identity Provider encrypts the SAML Assertion using the public key from [the Sauce Labs metadata](https://accounts.saucelabs.com/am/sso/metadata/https%3A%2F%2Faccounts.saucelabs.com%2Fsp), and Sauce Labs Service Provider decrypts it using the private key. When Sauce Labs updates its encryption certificate, customers are required to [update their configurations with the new certificate (public key)](#sauce-labs-encryption-certificate-rotation).

:::tip
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/api/error-reporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Submits crash object to Backtrace instance.
<li><code>sourceCode</code> - A string value that identifies the ID of the source code file the stack frame is contained in.</li>
<li><code>library</code> - A string value that identifies the shared object, the library or the module name.</li>
<li><code>debug_identifier</code> - A string value that identifies the debug identifier for the library associated with this frame.</li>
<li><code>faulted</code> - A boolean value that indicates if this frame is known to to the faulting frame.</li>
<li><code>faulted</code> - A boolean value that indicates if this frame is known to be the faulting frame.</li>
<li><code>registers</code> - In this object the keys are the register names. Use any names that make sense for the architecture. These must correspond to the values in the <code>arch</code> definition. JSON does not support 64 bit integers, so you must set the correct type and then encode the 64 bit integers as a string.</li>
</ul>
</ul>
Expand Down
Loading

0 comments on commit 029d7db

Please sign in to comment.