Skip to content

Latest commit

 

History

History
118 lines (89 loc) · 6.14 KB

quickstart.md

File metadata and controls

118 lines (89 loc) · 6.14 KB
Raw
id title sidebar_label
quickstart
Sauce Connect Proxy 5 Quickstart Guide
Quickstart

import useBaseUrl from '@docusaurus/useBaseUrl'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Sauce Connect Proxy is required to run a test on an app or website located behind a firewall. Get up and running with a basic Sauce Connect Proxy tunnel in minutes using the steps below.

:::caution The Sauce Connect Proxy version 5 major release introduces CLI changes. Please refer to Sauce Connect Proxy 5 CLI Reference for details. An sc legacy command is introduced to help users transition from version 4.x.x to 5.0.x. :::

What You'll Need

  • A Sauce Labs account (Log in or sign up for a free trial license).
  • If you haven't already, make sure you can access the website or mobile app that you'll be testing from the Sauce Connect Proxy host.
  • Check to see if you have any proxies that are required to access the public Internet.

Installing Sauce Connect Proxy

See the installation instructions

Starting Sauce Connect Proxy

  1. Make sure that the directory containing the sc binary (sc.exe for Windows) is in the $PATH. Otherwise, you will have to specify the path to the binary in the command line, /path/to/sc
  2. Log in to Sauce Labs.
  3. Go to the Tunnel Proxies page.
    <img src={useBaseUrl('img/sauce-connect/tunnelsPage.png')} alt="Sauce Connect Proxy Tunnels page" width="400"/>
  4. Under step 2, Authenticate & connect, copy the code snippet.
    <img src={useBaseUrl('img/sauce-connect/configureAuth.png')} alt="Sauce Connect Proxy Tunnels page snippet" width="300"/>
    What is this? This snippet contains your authentication credentials (username and access key), selects a Sauce Labs Data Center, and applies a name to your tunnel. Optionally, you can rename your tunnel by replacing the value after the --tunnel-name flag.
  5. Paste the snippet into your terminal and run it. This will launch the tunnel.
  6. Follow the steps in the setup instructions to start Sauce Connect Proxy 5 using the username and the access key obtained in the previous step.

Verify Connection

To confirm your tunnel is up, look for the confirmation message in your terminal:

Sauce Connect is up, you may start your tests

Alternatively, you can check your list of active tunnels on the Tunnel Proxies page:
<img src={useBaseUrl('img/sauce-connect/tunnelsuccess-ui.png')} alt="Sauce Connect Tunnel Success" width="500"/>

Run Test

With your tunnel up and running, try doing a Live local test.

<Tabs   defaultValue="Cross-Browser"   values={[     {label: 'Cross-Browser', value: 'Cross-Browser'},     {label: 'Mobile Browser', value: 'Mobile Browser'},     {label: 'Mobile App', value: 'Mobile App'},   ]}>

  1. From your terminal or IDE, launch a local instance of your website as you normally would.
  2. From Sauce Labs, click Live > Cross Browser > Desktop.
  3. In the URL field, enter your website's local URL (e.g., http://localhost:3000).
  4. From the Sauce Connect Proxy dropdown, select your tunnel name.
  5. Select your desired browser configuration.
  6. Click Start Test to launch your live test in Sauce Labs.
  1. From your terminal or IDE, launch a local instance of your site as you normally would.
  2. From Sauce Labs, click Live > Cross Browser > Mobile Virtual or Mobile Real.
  3. Enter the local URL for your local website under test (e.g., http://localhost:3000)
  4. From the Sauce Connect Proxy dropdown, select your tunnel name.
  5. Select your desired Mobile Virtual or Mobile Real device configuration.
  6. Click Start Test to launch your live test in Sauce Labs.
  1. From Sauce Labs, click Live > Mobile App.
  2. Click Upload App to upload your iOS or Android mobile app file to Sauce Labs.
  3. Find your app in the apps list, hover your mouse over it, and click Choose Device.
  4. To test your app on a real device, click Mobile Real. To test it on an emulator or simulator, click Mobile Virtual.
  5. Select your desired device configuration, including your tunnel name in the Sauce Connect Proxy dropdown.
  6. Click Start Test to launch your live test in Sauce Labs.

Stop Tunnel

When you've finished testing, you can stop your tunnel from the terminal where Sauce Connect is running by entering Ctrl+C. If there are jobs that use Sauce Connect Proxy connection, it will wait for them to finish.

2024/01/23 15:19:33.152509 [control] [INFO] Sauce Connect is up, you may start your tests
^C
2024/01/23 15:29:12.617959 [control] [INFO] waiting for 1 active job(s) to finish, timeout: 3h0m0s
2024/01/23 15:29:27.622295 [control] [INFO] waiting for 1 active job(s) to finish, timeout: 2h59m45s
2024/01/23 15:29:42.600553 [control] [INFO] waiting for 1 active job(s) to finish, timeout: 2h59m30s
2024/01/23 15:30:00.924115 [control] [INFO] tunnel was shutdown gracefully

Alternatively, you can go to the Tunnel Proxies page and click one of the Stop Tunnels buttons.
<img src={useBaseUrl('img/sauce-connect/tunnelstop-ui.png')} alt="Sauce Connect Tunnel Stop" width="800"/>

More Information