Updating Sauce Labs tunnel instructions

config.yml.erb

@@ -215,6 +215,7 @@ azure_content_moderation_key:
 # multiple browsers
 saucelabs_username:
 saucelabs_authkey:
+saucelabs_tunnel_name:
 
 # Credentials for applitools.com, used for running automated visual tests
 applitools_eyes_api_key:      !Secret

dashboard/test/ui/README.md

@@ -47,6 +47,17 @@ You can find the values for these settings in your saucelabs account settings (`
 
 If you want to run tests on Sauce Labs against localhost you need to set up your tunnel:
 
+#### Latest version of Sauce Labs tunnel
+1. Login to Sauce Labs and download the [tunnel](https://app.saucelabs.com/tunnels).
+2. Uncomment and fill out the values for the "saucelabs_" properties in `locals.yml`
+   - `saucelabs_tunnel_name` can be an arbitrary name, but it needs to match what you pass as an argument to `sc run...`
+3. (Re)start your dashboard-server `./bin/dashboard-server`.
+4. Start the sauce labs tunnel
+    - `sc run -u <saucelabs_username> -k <saucelabs_authkey> -r us-west --tunnel-name <saucelabs_tunnel_name>`
+5. Run your UI test
+    - `./runner.rb -l -f features/platform/policy_compliance.feature -c Chrome --html`
+        - The log output can be found in `log/*.html`
+#### Older versions of Sauce Labs tunnel
 1. Login to Sauce Labs and download the [tunnel](https://app.saucelabs.com/tunnels).
    - If you work on a Linux EC2 instance:
      - Download the Linux version (will end in .tar.gz)

dashboard/test/ui/features/support/connect.rb

@@ -32,7 +32,8 @@ def saucelabs_browser(test_run_name)
     idleTimeout: 60,
     seleniumVersion: Selenium::WebDriver::VERSION
   }
-  sauce_options[:tunnelIdentifier] = CDO.circle_run_identifier if CDO.circle_run_identifier
+  tunnel_name = CDO.circle_run_identifier || CDO.saucelabs_tunnel_name
+  sauce_options[:tunnelIdentifier] = tunnel_name if tunnel_name
   sauce_options[:priority] = ENV['PRIORITY'].to_i if ENV['PRIORITY']
   capabilities["sauce:options"] ||= {}
   capabilities["sauce:options"].merge!(sauce_options)

locals.yml.default

@@ -71,6 +71,7 @@ use_my_apps: true
 # multiple browsers
 #saucelabs_username: ''
 #saucelabs_authkey: ''
+#saucelabs_tunnel_name: ''
 
 
 # Credentails for applitools.com, used for running automated visual tests