Fix pcloudy (#594)

* support for pCloudy

* send pCloudy key and username from env

* updated readMe and bump version

* bump version and update readMe

Author: saikrishna321

README.md

@@ -58,6 +58,25 @@ You can also pass all the arguments in a config file. Refer [here](https://githu
 appium server -ka 800 --use-plugins=device-farm --config ./server-config.json -pa /wd/hub
 ```
 
+## Cloud Execution
+
+Plugin currently supports pCloudy and BrowserStack
+
+### BrowserStack
+
+```
+BS_USERNAME="username" BS_PASSWORD="password" appium server -ka 800 --use-plugins=device-farm --config ./serverConfig/bs-config.json -pa /wd/hub
+```
+Refer on BroswerStack config [here](https://github.com/AppiumTestDistribution/appium-device-farm/blob/main/serverConfig/bs-config.json)
+
+### pCloudy
+
+```
+PCLOUDY_APIKEY="apiKey" PCLOUDY_USERNAME="useremail" appium server -ka 800 --use-plugins=device-farm --config ./serverConfig/pcloudy-config.json -pa /wd/hub
+```
+Refer on pCloudy config [here](https://github.com/AppiumTestDistribution/appium-device-farm/blob/main/serverConfig/pcloudy-config.json)
+
+
 ### Argument options
 
 These arguments are set when you launch the Appium server, with this plugin installed.

package-lock.json

@@ -1,13 +1,14 @@
 {
   "name": "appium-device-farm",
-  "version": "3.9.0",
+  "version": "3.10.0",
   "description": "An appium 2.0 plugin that manages and create driver session on available devices",
   "main": "./lib/index.js",
   "scripts": {
     "test": "mocha -r ts-node/register ./test/unit/*.spec.js --plugin-device-farm-platform=both --exit --timeout=10000",
     "test-jest": "NODE_OPTIONS=--experimental-vm-modules npx jest ./test/unit/AndroidDeviceManager.spec.js",
     "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/*.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-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

@@ -1,3 +1,4 @@
+import Cloud from '../../enums/Cloud';
 import { IDevice } from '../../interfaces/IDevice';
 
 export default class CapabilityManager {
@@ -13,6 +14,10 @@ export default class CapabilityManager {
     entries.map(([key, val]) => {
       this.capabilities.alwaysMatch[`appium:${key}`] = val;
     });
+    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;
+    }
     return this.capabilities;
   }
 }

src/device-managers/cloud/CapabilityManager.ts

@@ -6,6 +6,7 @@ import getPort from 'get-port';
 import { IDevice } from './interfaces/IDevice';
 import _ from 'lodash';
 import log from './logger';
+import Cloud from './enums/Cloud';
 
 const APPIUM_VENDOR_PREFIX = 'appium:';
 export async function asyncForEach(
@@ -36,7 +37,7 @@ export async function getFreePort() {
 export function hubUrl(device: IDevice) {
   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 === 'pCloudy') {
+  } else if (device.hasOwnProperty('cloud') && device.cloud.toLowerCase() === Cloud.PCLOUDY) {
     return 'https://device.pcloudy.com/appiumcloud/wd/hub/session';
   }
   return `${device.host}/wd/hub/session`;

src/helpers.ts

@@ -164,29 +164,33 @@ class DevicePlugin extends BasePlugin {
     if (!device.host.includes('127.0.0.1')) {
       const remoteUrl = hubUrl(device);
       let sessionDetails: any;
-      try {
-        logger.info('Creating cloud session');
-        sessionDetails = //change to give the entire URL
-          (
-            await axios.post(remoteUrl, {
-              capabilities: caps,
-            })
-          ).data;
-        if (sessionDetails.value.error) throw new Error(`Failed ❌ ${sessionDetails.value.error}`);
-
-        session = {
-          protocol: 'W3C',
-          value: [sessionDetails.value.sessionId, sessionDetails.value.capabilities, 'W3C'],
-        };
-      } catch (err: any) {
-        await updateDevice(device, { busy: false });
-        logger.info(
-          `📱 Device UDID ${device.udid} unblocked. Reason: Remote Session failed to create`
-        );
-        throw new Error(
-          `${err}, Please check the remote appium server log to know the reason for failure`
-        );
-      }
+      logger.info('Creating cloud session');
+      var config = {
+        method: 'post',
+        url: remoteUrl,
+        headers: {
+          'Content-Type': 'application/json',
+        },
+        data: { capabilities: caps },
+      };
+      await axios(config)
+        .then(function (response) {
+          sessionDetails = response.data;
+        })
+        .catch(async function (error) {
+          console.log('Inside Error', error);
+          await updateDevice(device, { busy: false });
+          logger.info(
+            `📱 Device UDID ${device.udid} unblocked. Reason: Remote Session failed to create`
+          );
+          throw new Error(
+            `${error.response.data.value.message}, Please check the remote appium server log to know the reason for failure`
+          );
+        });
+      session = {
+        protocol: 'W3C',
+        value: [sessionDetails.value.sessionId, sessionDetails.value.capabilities, 'W3C'],
+      };
     } else {
       session = await next();
     }

src/plugin.ts

@@ -0,0 +1,39 @@
+import { remote } from 'webdriverio';
+
+const APPIUM_HOST = '127.0.0.1';
+const APPIUM_PORT = 31337;
+const WDIO_PARAMS = {
+  connectionRetryCount: 0,
+  hostname: APPIUM_HOST,
+  port: APPIUM_PORT,
+  path: '/wd/hub/',
+  logLevel: 'info',
+};
+const capabilities = {
+  automationName: 'UiAutomator2',
+  newCommandTimeout: 600,
+  launchTimeout: 90000,
+  platformName: 'Android',
+  autoGrantPermissions: true,
+  pCloudy_DurationInMinutes: 10,
+  pCloudy_WildNet: 'false',
+  pCloudy_EnableVideo: 'true',
+  pCloudy_EnablePerformanceData: 'true',
+  pCloudy_EnableDeviceLogs: 'true',
+  pCloudy_ApplicationName: 'pCloudy_Appium_Demo.apk',
+  appPackage: 'com.pcloudy.appiumdemo',
+  appActivity: 'com.ba.mobile.LaunchActivity'
+};
+let driver;
+describe('Plugin Test', () => {
+  beforeEach(async () => {
+    driver = await remote({ ...WDIO_PARAMS, capabilities });
+  });
+
+  it('Vertical swipe test', async () => {
+    console.log(await driver.capabilities.deviceUDID);
+    await driver.$('~login').click();
+  });
+
+  afterEach(async () => await driver.deleteSession());
+});