sc5 support resolves #240 (#265)

* sc: use sc api to retrieve SC download url

* update endpoint to retrive SC download

* always extend metadata with runner when starting sauce connect

* fix downloading custom sauce connect version

---------

Co-authored-by: Alana McKenzie <[email protected]>
Co-authored-by: Michał Budziak <[email protected]>

Author: 3 people

README.md

@@ -104,12 +104,12 @@ or start Sauce Connect Proxy in EU datacenter:
 # start Sauce Connect tunnel for eu-central-1 region
 $ sl sc --region eu --tunnel-name "my-tunnel"
 # run a specific Sauce Connect version
-$ sl sc --scVersion 4.9.1
+$ sl sc --scVersion 5.2.2
 # see all available Sauce Connect parameters via:
 $ sl sc --help
 ```
 
-You can see all available Sauce Connect parameters on the [Sauce Labs Docs](https://docs.saucelabs.com/dev/cli/sauce-connect-proxy/).
+You can see all available Sauce Connect parameters on the [Sauce Labs Docs](https://docs.saucelabs.com/dev/cli/sauce-connect-5/run/).
 
 ### As NPM Package
 
@@ -179,7 +179,7 @@ import SauceLabs from 'saucelabs';
      */
     logger: (stdout) => console.log(stdout),
     /**
-     * see all available parameters here: https://docs.saucelabs.com/dev/cli/sauce-connect-proxy/
+     * see all available parameters here: https://docs.saucelabs.com/dev/cli/sauce-connect-5/run/
      * all parameters have to be applied camel cased instead of with hyphens, e.g.
      * to apply the `--tunnel-name` parameter, set:
      */
@@ -219,6 +219,7 @@ const myAccount = new SauceLabs({
   user: 'YOUR-USER',
   key: 'YOUR-ACCESS-KEY',
   region: 'eu', // run in EU datacenter
+  tunnelName: 'my-tunnel',
 });
 
 // get full webdriver url from the client depending on `region` option:

apis/sauce.json

@@ -458,81 +458,33 @@
       },
       "type": "object"
     },
-    "SauceConnectDownloadInfo": {
+    "SauceConnectDownload": {
       "type": "object",
       "properties": {
-        "download_url": {
-          "type": "string"
-        },
-        "sha1": {
-          "type": "string",
-          "nullable": true
-        },
-        "sha256": {
-          "type": "string",
-          "nullable": true
-        },
-        "version": {
-          "type": "string",
-          "nullable": true
-        }
-      }
-    },
-    "SauceConnectByPlatform": {
-      "type": "object",
-      "properties": {
-        "linux": {
-          "$ref": "#/definitions/SauceConnectDownloadInfo",
-          "nullable": true
-        },
-        "linux-arm64": {
-          "$ref": "#/definitions/SauceConnectDownloadInfo",
-          "nullable": true
-        },
-        "win32": {
-          "$ref": "#/definitions/SauceConnectDownloadInfo",
-          "nullable": true
-        },
-        "osx": {
-          "$ref": "#/definitions/SauceConnectDownloadInfo"
-        }
-      }
-    },
-    "SauceConnectVersions": {
-      "type": "object",
-      "properties": {
-        "latest_version": {
-          "type": "string"
-        },
-        "client_version": {
-          "type": "string"
-        },
-        "status": {
-          "type": "string",
-          "enum": ["LATEST", "UPGRADE", "PRERELEASE", "UNKNOWN", "EOL"]
-        },
-        "info_url": {
-          "type": "string"
-        },
-        "download_url": {
-          "type": "string"
-        },
-        "sha1": {
-          "type": "string",
-          "nullable": true
-        },
-        "sha256": {
-          "type": "string",
-          "nullable": true
-        }
-      },
-      "downloads": {
-        "$ref": "#/definitions/SauceConnectByPlatform"
-      },
-      "all_downloads": {
-        "type": "array",
-        "items": {
-          "$ref": "#/definitions/SauceConnectByPlatform"
+        "download": {
+          "type": "object",
+          "properties": {
+            "url": {
+              "type": "string"
+            },
+            "version": {
+              "type": "string"
+            },
+            "checksums": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "value": {
+                    "type": "string"
+                  },
+                  "algorithm": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
         }
       }
     },
@@ -820,17 +772,24 @@
       "required": true,
       "type": "string"
     },
-    "clientHost": {
-      "description": "SC client host OS and CPU arch",
+    "clientArch": {
+      "description": "SC client host CPU arch",
       "in": "query",
-      "name": "client_host",
+      "name": "arch",
+      "required": false,
+      "type": "string"
+    },
+    "clientOS": {
+      "description": "SC client host OS",
+      "in": "query",
+      "name": "os",
       "required": false,
       "type": "string"
     },
     "clientVersion": {
       "description": "SC client version",
       "in": "query",
-      "name": "client_version",
+      "name": "version",
       "required": false,
       "type": "string"
     },
@@ -1768,25 +1727,26 @@
         "tags": ["Tunnel"]
       }
     },
-    "/v1/public/tunnels/info/versions": {
+    "/v1/public/tunnels/sauce-connect/download": {
       "get": {
-        "operationId": "sc_versions",
+        "description": "Get Sauce Connect download information for the latest version",
+        "operationId": "sc_download",
         "parameters": [
           {
-            "$ref": "#/parameters/clientVersion"
+            "$ref": "#/parameters/clientArch"
           },
           {
-            "$ref": "#/parameters/clientHost"
+            "$ref": "#/parameters/clientOS"
           },
           {
-            "$ref": "#/parameters/all"
+            "$ref": "#/parameters/clientVersion"
           }
         ],
         "responses": {
           "200": {
-            "description": "Tunnels",
+            "description": "download",
             "schema": {
-              "$ref": "#/definitions/SauceConnectVersions"
+              "$ref": "#/definitions/SauceConnectDownload"
             }
           },
           "default": {
@@ -1796,7 +1756,6 @@
             }
           }
         },
-        "summary": "Get tunnels for the user or all the users in the team",
         "tags": ["Tunnel"]
       }
     },

docs/interface.md

@@ -185,12 +185,12 @@ The following commands are available via package or cli tool:
     </tr>
     <tr>
       <td>
-        <b>GET</b> <code>/v1/public/tunnels/info/versions</code><br>
-        Get tunnels for the user or all the users in the team
+        <b>GET</b> <code>/v1/public/tunnels/sauce-connect/download</code><br>
+        Get Sauce Connect download information for the latest version
         <h3>Example:</h3>
-        <code>api.scVersions({ ...options })</code>
+        <code>api.scDownload({ ...options })</code>
         <br><h4>Options</h4>
-        <ul>          <li><b>client_version</b>: SC client version</li>          <li><b>client_host</b>: SC client host OS and CPU arch</li>          <li><b>all</b>: Should the response contain the same team user data</li>        </ul>      </td>
+        <ul>          <li><b>arch</b>: SC client host CPU architecture</li>          <li><b>os</b>: SC client host OS</li>        <li><b>version</b>: Optional. Return the newest version matching this minimal version</li>        </ul>      </td>
     </tr>
     <tr>
       <td>

e2e/sc.test.js

@@ -23,27 +23,42 @@ test('should be able to get Sauce Connect versions', async () => {
     return;
   }
   const api = new SauceLabs();
-  const scVersion = await api.scVersions({
-    clientVersion: '5.1.0',
-    clientHost: 'darwin-arm64',
+  const response = await api.scDownload({
+    version: '5.2.2',
+    arch: 'arm64',
+    os: 'macos',
   });
-  expect(scVersion.status).toEqual('UPGRADE');
-  expect(scVersion.latest_version).toMatch(/5\./);
-  console.log(scVersion.download_url);
+
+  expect(response.download.version).toEqual('5.2.2');
+  expect(response.download.url).toMatch(/5\.2\.2/);
+  console.log(response.download.url);
 });
 
 test('should not be able to run Sauce Connect due to invalid credentials', async () => {
   if (SKIP_TEST) {
     return;
   }
-  const api = new SauceLabs({key: 'foobar'});
+  const api = new SauceLabs({key: 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa'});
   const err = await api
     .startSauceConnect({
       logger: console.log.bind(console),
       tunnelName: `node-saucelabs E2E test - ${ID}`,
     })
     .catch((err) => err);
-  expect(err.message).toContain('Unauthorized');
+  expect(err.message).toContain('Not authorized');
+});
+
+test('should not be able to run Sauce Connect due to missing tunnel-name', async () => {
+  if (SKIP_TEST) {
+    return;
+  }
+  const api = new SauceLabs();
+  const err = await api
+    .startSauceConnect({
+      logger: console.log.bind(console),
+    })
+    .catch((err) => err);
+  expect(err.message).toContain('Missing tunnel-name');
 });
 
 test('should be able to run Sauce Connect', async () => {

src/commands/sc.js

@@ -2,7 +2,15 @@ import SauceLabs from './..';
 import {DEFAULT_OPTIONS, SAUCE_CONNECT_CLI_PARAMS} from '../constants';
 
 export const command = 'sc [flags]';
-export const describe = 'Sauce Connect interface';
+export const describe = `Sauce Connect Proxy interface.
+ - Only the 'sc run' command is currently supported
+ - See https://docs.saucelabs.com/dev/cli/sauce-connect-5/run/ for detailed CLI documentation.
+ - Sauce Connect Proxy 4.x.x cannot be used with the library version 9.0.0 and newer
+ - Some Sauce Connect CLI option aliases differ from the 'sc' binary
+ - Some CLI options differ from the 'sc' binary:
+   - '--proxy' corresponds to https://docs.saucelabs.com/dev/cli/sauce-connect-5/run/#proxy-sauce
+   - '--sc-upstream-proxy' corresponds to https://docs.saucelabs.com/dev/cli/sauce-connect-5/run/#proxy
+`;
 export const builder = (yargs) => {
   for (const option of SAUCE_CONNECT_CLI_PARAMS) {
     yargs.option(option.name, option);