Support to run Test In Sauce (#598)

* Support for Sauce labs

* pick host name from config file

* bump version

Author: saikrishna321

README.md

@@ -72,10 +72,17 @@ Refer on BroswerStack config [here](https://github.com/AppiumTestDistribution/ap
 ### pCloudy
 
 ```
-PCLOUDY_APIKEY="apiKey" PCLOUDY_USERNAME="useremail" appium server -ka 800 --use-plugins=device-farm --config ./serverConfig/pcloudy-config.json -pa /wd/hub
+BS_USERNAME="username" BS_PASSWORD="password" appium server -ka 800 --use-plugins=device-farm --config ./serverConfig/bs-config.json -pa /wd/hub
 ```
 Refer on pCloudy config [here](https://github.com/AppiumTestDistribution/appium-device-farm/blob/main/serverConfig/pcloudy-config.json)
 
+### SauceLabs
+
+```
+SAUCE_PASSWORD="apiKey" SAUCE_USERNAME="useremail" appium server -ka 800 --use-plugins=device-farm --config ./serverConfig/sauce-config.json -pa /wd/hub
+```
+Refer on pCloudy config [here](https://github.com/AppiumTestDistribution/appium-device-farm/blob/main/serverConfig/sauce-config.json)
+
 
 ### Argument options
 

azure-pipelines.yml

@@ -138,3 +138,20 @@ jobs:
         nohup ./node_modules/.bin/appium server -ka 800 --use-plugins=device-farm -pa /wd/hub --config=./serverConfig/bs-config.json &
         npm run test-parallel-bs
       displayName: 'E2E Test'
+
+ - job: Sauce
+   pool:
+     vmImage: 'macOS-latest'
+
+   steps:
+     - task: NodeTool@0.200.0
+       inputs:
+         versionSpec: '16.x'
+
+     - script: |
+         npm ci
+         export APPIUM_HOME=/tmp/device-farm
+         ./node_modules/.bin/appium plugin install --source=local .
+         nohup ./node_modules/.bin/appium server -ka 800 --use-plugins=device-farm -pa /wd/hub --config=./serverConfig/sauce-config.json &
+         npm run test-parallel-sauce
+       displayName: 'E2E Test'

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-device-farm",
-  "version": "3.11.0",
+  "version": "3.12.0",
   "description": "An appium 2.0 plugin that manages and create driver session on available devices",
   "main": "./lib/index.js",
   "scripts": {
@@ -9,6 +9,7 @@
     "test-parallel-android": "wait-on http://localhost:31337/device-farm/ && mocha --require ts-node/register -p ./test/e2e/android/*.spec.js --timeout 260000",
     "test-parallel-bs": "mocha --require ts-node/register -p ./test/e2e/android/cloud/conf.spec.js --timeout 260000",
     "test-parallel-pcloudy": "mocha --require ts-node/register -p ./test/e2e/android/cloud/pcloudy.spec.js --timeout 260000",
+    "test-parallel-sauce": "mocha --require ts-node/register -p ./test/e2e/android/cloud/sauce.spec.js --timeout 260000",
     "test-parallel-ios": "wait-on http://localhost:4723/device-farm/ && mocha --require ts-node/register -p ./test/e2e/ios/*.spec.js --timeout 260000",
     "test-e2e": "wait-on http://localhost:31337/device-farm/ && mocha --require ts-node/register ./test/e2e/plugin.spec.js --timeout 999999",
     "test-e2e-browserstack": "wait-on http://localhost:31337/device-farm/ && mocha --require ts-node/register ./test/e2e/browserstack.spec.js --timeout 999999",

package.json

@@ -0,0 +1,23 @@
+{
+  "server": {
+    "port": 31337,
+    "plugin": {
+      "device-farm": {
+        "platform": "android",
+        "remote": [
+          {
+            "cloudName": "sauce",
+            "url": "https://ondemand.eu-central-1.saucelabs.com/wd/hub",
+            "devices": [
+              {
+                "platformVersion": "12.0",
+                "deviceName": "Android GoogleAPI Emulator",
+                "platform": "android"
+              }
+            ]
+          }
+        ]
+      }
+    }
+  }
+}

serverConfig/sauce-config.json

@@ -14,7 +14,7 @@ export default class CapabilityManager {
     entries.map(([key, val]) => {
       this.capabilities.alwaysMatch[`appium:${key}`] = val;
     });
-    if(this.freeDevice.cloud.toLowerCase() === Cloud.PCLOUDY) {
+    if (this.freeDevice.cloud.toLowerCase() === Cloud.PCLOUDY) {
       this.capabilities.alwaysMatch['pCloudy_ApiKey'] = process.env.PCLOUDY_APIKEY;
       this.capabilities.alwaysMatch['pCloudy_Username'] = process.env.PCLOUDY_USERNAME;
     }

src/device-managers/cloud/CapabilityManager.ts

@@ -24,6 +24,13 @@ export default class Devices {
           udid: d.deviceName,
         };
       }
+      if (this.host.cloudName.toLowerCase() === Cloud.SAUCELABS) {
+        cloudDeviceProperties = {
+          name: d.deviceName,
+          sdk: d.platformVersion,
+          udid: d.deviceName,
+        };
+      }
       if (this.host.cloudName.toLowerCase() === Cloud.PCLOUDY) {
         cloudDeviceProperties = {
           name: d?.pCloudy_DeviceFullName || d?.pCloudy_DeviceManufacturer,

src/device-managers/cloud/Devices.ts

@@ -2,7 +2,6 @@ import { IDevice } from '../../interfaces/IDevice';
 import RemoteAndroidDeviceManager from '../RemoteAndroidDeviceManager';
 import RemoteIOSDeviceManager from '../RemoteIOSDeviceManager';
 import { isObject } from 'lodash';
-import Cloud from '../../enums/Cloud';
 import { CloudArgs } from '../../types/CloudArgs';
 import DevicePlatform from '../../enums/Platform';
 import Devices from '../cloud/Devices';

src/device-managers/factory/DeviceFactory.ts

@@ -1,6 +1,7 @@
 enum Cloud {
   BROWSERSTACK = 'browserstack',
   PCLOUDY = 'pcloudy',
+  SAUCELABS = 'sauce',
 }
 
 export default Cloud;

src/enums/Cloud.ts

@@ -36,9 +36,13 @@ export async function getFreePort() {
 }
 
 export function hubUrl(device: IDevice) {
-  const host = normalizeUrl(device.host, {removeTrailingSlash: false});
+  const host = normalizeUrl(device.host, { removeTrailingSlash: false });
   if (device.hasOwnProperty('cloud') && device.cloud === 'browserstack') {
     return `https://${process.env.BS_USERNAME}:${process.env.BS_PASSWORD}@hub.browserstack.com/wd/hub/session`;
+  } else if (device.hasOwnProperty('cloud') && device.cloud === 'sauce') {
+    return `https://${process.env.SAUCE_USERNAME}:${process.env.SAUCE_PASSWORD}@${
+      new URL(device.host).host
+    }/wd/hub/session`;
   } else if (device.hasOwnProperty('cloud') && device.cloud.toLowerCase() === Cloud.PCLOUDY) {
     return `${host}/session`;
   }