add unique udid for cloud devices

package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-device-farm",
-  "version": "8.4.7-rc.3",
+  "version": "8.4.7-rc.4",
   "description": "An appium 2.0 plugin that manages and create driver session on available devices",
   "main": "./lib/src/index.js",
   "scripts": {
@@ -149,6 +149,7 @@
     "babel-eslint": "10.1.0",
     "chai": "4.3.10",
     "chai-as-promised": "^7.1.1",
+    "chai-exclude": "^2.1.0",
     "dotenv": "^16.3.1",
     "eslint": "8.52.0",
     "eslint-config-prettier": "9.0.0",

serverConfig/bs-config.json

@@ -11,8 +11,13 @@
             "url": "http://hub-cloud.browserstack.com/wd/hub",
             "devices": [
               {
-                "deviceName": "Google Pixel 3",
-                "os_version": "9.0",
+                "deviceName": "Samsung Galaxy S21",
+                "os_version": "12.0",
+                "platform": "android"
+              },
+              {
+                "deviceName": "Samsung Galaxy S21",
+                "os_version": "12.0",
                 "platform": "android"
               },
               {

src/device-managers/cloud/Devices.ts

@@ -10,6 +10,7 @@ import {
 import logger from '../../logger';
 import { Schema, Validator } from 'jsonschema';
 import { CloudConfig, CloudDevice } from '../../interfaces/IPluginArgs';
+import { v4 as uuidv4 } from 'uuid';
 
 export default class Devices {
   private devices: CloudDevice[];
@@ -33,28 +34,26 @@ export default class Devices {
         cloudDeviceProperties = {
           name: d.deviceName,
           sdk: d['os_version'],
-          udid: d.deviceName,
         };
       }
       if (this.isSauceLabs() || this.isLambdaTest() || this.isHeadSpin()) {
         this.validateSchema(sauceOrLambdaSchema);
         cloudDeviceProperties = {
           name: d.deviceName,
           sdk: d.platformVersion,
-          udid: d.deviceName,
         };
       }
       if (this.isPCloudy()) {
         this.validateSchema(pCloudySchema);
         cloudDeviceProperties = {
           name: d?.pCloudy_DeviceFullName || d?.pCloudy_DeviceManufacturer,
           sdk: d?.pCloudy_DeviceVersion || d?.platformVersion,
-          udid: d?.pCloudy_DeviceFullName || d?.pCloudy_DeviceManufacturer,
         };
       }
       return Object.assign({}, ...devicesByPlatform, {
         host: this.cloud.url,
         busy: false,
+        udid: uuidv4(),
         userBlocked: false,
         deviceType: 'real',
         capability: d,

test/e2e/android/cloud/bs.spec.ts

@@ -61,6 +61,11 @@ describe('BrowserStack: Plugin Test', () => {
 
   it('Vertical swipe test', async () => {
     console.log(`Device UDID: ${await driver.capabilities.deviceUDID}`);
+    const currentBusyDevices = await busyDevices();
+    console.log(`currentBusyDevices: ${JSON.stringify(currentBusyDevices)}`);
+
+    // the same number of devices should be busy
+    expect(currentBusyDevices.length).to.equal(1);
     await driver.performActions([
       {
         type: 'pointer',
@@ -90,7 +95,10 @@ describe('BrowserStack: Plugin Test', () => {
     }
   });
 });
-
+async function busyDevices() {
+  const res = await axios.get(`http://${APPIUM_HOST}:${HUB_APPIUM_PORT}/device-farm/api/device`);
+  return res.data.filter((device: any) => device.busy === true);
+}
 describe('Browser Stack: Quirks', () => {
   // dump hub config into a file
   const hub_config_file = path.join(__dirname, '../../../../serverConfig/bs-config.json');
@@ -116,10 +124,6 @@ describe('Browser Stack: Quirks', () => {
     appiumHome: APPIUM_HOME!,
   });
 
-  async function busyDevices() {
-    const res = await axios.get(`http://${APPIUM_HOST}:${HUB_APPIUM_PORT}/device-farm/api/device`);
-    return res.data.filter((device: any) => device.busy === true);
-  }
   it('handles empty session id when app is invalid', async () => {
     capabilities['appium:app'] = 'bs://invalid-app-id';
     const initialBusyDevices = await busyDevices();

test/e2e/browserstack.spec.ts

@@ -12,6 +12,10 @@ import {
 import ip from 'ip';
 import path from 'path';
 import { IDevice } from '../../src/interfaces/IDevice';
+import * as chai from 'chai';
+import chaiExclude from 'chai-exclude';
+
+chai.use(chaiExclude);
 
 describe('Browserstack Devices', () => {
   // dump hub config into a file
@@ -45,21 +49,23 @@ describe('Browserstack Devices', () => {
     androidDevices = androidDevices.filter((device: IDevice) => device.cloud === 'browserstack');
     delete androidDevices[0].meta;
     delete androidDevices[0]['$loki'];
-    expect(androidDevices[0]).to.deep.equal({
-      deviceName: 'Google Pixel 3',
-      os_version: '9.0',
-      platform: 'android',
-      host: 'http://hub-cloud.browserstack.com/wd/hub',
-      busy: false,
-      userBlocked: false,
-      deviceType: 'real',
-      capability: { deviceName: 'Google Pixel 3', os_version: '9.0', platform: 'android' },
-      cloud: 'browserstack',
-      name: 'Google Pixel 3',
-      sdk: '9.0',
-      udid: 'Google Pixel 3',
-      offline: false,
-    });
+    expect(androidDevices[0])
+      .excluding('udid')
+      .to.deep.equal({
+        deviceName: 'Samsung Galaxy S21',
+        os_version: '12.0',
+        platform: 'android',
+        host: 'http://hub-cloud.browserstack.com/wd/hub',
+        busy: false,
+        userBlocked: false,
+        deviceType: 'real',
+        capability: { deviceName: 'Samsung Galaxy S21', os_version: '12.0', platform: 'android' },
+        cloud: 'browserstack',
+        name: 'Samsung Galaxy S21',
+        sdk: '12.0',
+        udid: 'Google Pixel 3',
+        offline: false,
+      });
   });
 
   it('Should be able to run the plugin with Browerstack config', async () => {
@@ -72,24 +78,26 @@ describe('Browserstack Devices', () => {
     iosDevices = iosDevices.filter((device: IDevice) => device.cloud === 'browserstack');
     delete iosDevices[0].meta;
     delete iosDevices[0]['$loki'];
-    expect(iosDevices[0]).to.deep.equal({
-      deviceName: 'iPhone XS',
-      os_version: '15',
-      platform: 'ios',
-      host: 'http://hub-cloud.browserstack.com/wd/hub',
-      busy: false,
-      userBlocked: false,
-      deviceType: 'real',
-      capability: {
+    expect(iosDevices[0])
+      .excluding('udid')
+      .to.deep.equal({
         deviceName: 'iPhone XS',
         os_version: '15',
         platform: 'ios',
-      },
-      cloud: 'browserstack',
-      name: 'iPhone XS',
-      sdk: '15',
-      udid: 'iPhone XS',
-      offline: false,
-    });
+        host: 'http://hub-cloud.browserstack.com/wd/hub',
+        busy: false,
+        userBlocked: false,
+        deviceType: 'real',
+        capability: {
+          deviceName: 'iPhone XS',
+          os_version: '15',
+          platform: 'ios',
+        },
+        cloud: 'browserstack',
+        name: 'iPhone XS',
+        sdk: '15',
+        udid: 'iPhone XS',
+        offline: false,
+      });
   });
 });