@xenon-device-management/xenon 1.1.0

package/lib/src/types/CloudSchema.js

@@ -0,0 +1,131 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultSchema = exports.pCloudySchema = exports.sauceOrLambdaSchema = exports.browserStackSchema = void 0;
+exports.browserStackSchema = {
+    $schema: 'http://json-schema.org/draft-07/schema',
+    title: 'browserstackConfig',
+    type: 'object',
+    required: ['cloudName', 'url', 'devices'],
+    properties: {
+        cloudName: {
+            type: 'string',
+            description: 'specify cloudName as browserstack',
+        },
+        url: {
+            type: 'string',
+            description: 'Url of cloud',
+        },
+        devices: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    deviceName: {
+                        type: 'string',
+                    },
+                    os_version: {
+                        type: 'string',
+                    },
+                    platform: {
+                        type: 'string',
+                    },
+                },
+                required: ['deviceName', 'os_version', 'platform'],
+            },
+        },
+    },
+};
+exports.sauceOrLambdaSchema = {
+    $schema: 'http://json-schema.org/draft-07/schema',
+    title: 'sauceLabsOrLambdaConfig',
+    type: 'object',
+    required: ['cloudName', 'url', 'devices'],
+    properties: {
+        cloudName: {
+            type: 'string',
+            description: 'specify cloudName as sauce or lambdatest',
+        },
+        url: {
+            type: 'string',
+            description: 'Url of cloud',
+        },
+        devices: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    deviceName: {
+                        type: 'string',
+                    },
+                    platformVersion: {
+                        type: 'string',
+                    },
+                    platform: {
+                        type: 'string',
+                    },
+                },
+                required: ['deviceName', 'platformVersion', 'platform'],
+            },
+        },
+    },
+};
+exports.pCloudySchema = {
+    $schema: 'http://json-schema.org/draft-07/schema',
+    title: 'pCloudyConfig',
+    type: 'object',
+    required: ['cloudName', 'url', 'devices'],
+    properties: {
+        cloudName: {
+            type: 'string',
+            description: 'specify cloudName as pCloudy',
+        },
+        url: {
+            type: 'string',
+            description: 'Url of cloud',
+        },
+        devices: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    pCloudy_DeviceManufacturer: {
+                        type: 'string',
+                    },
+                    pCloudy_DeviceVersion: {
+                        type: 'string',
+                    },
+                    platform: {
+                        type: 'string',
+                    },
+                },
+                required: ['pCloudy_DeviceManufacturer', 'pCloudy_DeviceVersion', 'platform'],
+            },
+        },
+    },
+};
+exports.defaultSchema = {
+    $schema: 'http://json-schema.org/draft-07/schema',
+    title: 'defaultCloudConfig',
+    type: 'object',
+    required: ['cloudName', 'url', 'devices'],
+    properties: {
+        cloudName: {
+            type: 'string',
+        },
+        url: {
+            type: 'string',
+        },
+        devices: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    platform: {
+                        type: 'string',
+                    },
+                },
+                required: ['platform'],
+            },
+        },
+    },
+};

package/lib/src/types/DeviceType.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/src/types/DeviceUpdate.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/src/types/IOSDevice.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/src/types/Platform.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/src/types/SessionStatus.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionStatus = void 0;
+var SessionStatus;
+(function (SessionStatus) {
+    SessionStatus["RUNNING"] = "running";
+    SessionStatus["SUCCESS"] = "success";
+    SessionStatus["FAILED"] = "failed";
+    SessionStatus["UNMARKED"] = "unmarked";
+    SessionStatus["TIMEOUT"] = "timeout";
+})(SessionStatus || (exports.SessionStatus = SessionStatus = {}));

package/lib/src/validators/CapabilityValidator.js

@@ -0,0 +1,93 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CapabilityValidator = exports.CapabilitySchema = void 0;
+const zod_1 = require("zod");
+const typedi_1 = require("typedi");
+const XenonCapabilityManager_1 = require("../XenonCapabilityManager");
+/**
+ * Zod Schema for Appium Capabilities
+ * Focuses on critical fields required for session allocation and infrastructure management.
+ */
+exports.CapabilitySchema = zod_1.z
+    .object({
+    platformName: zod_1.z
+        .string()
+        .toLowerCase()
+        .refine((val) => ['android', 'ios', 'tvos'].includes(val), {
+        message: 'platformName must be one of: android, ios, tvos',
+    }),
+    // Appium specific caps (with and without prefix)
+    'appium:automationName': zod_1.z.string().optional(),
+    automationName: zod_1.z.string().optional(),
+    'appium:udid': zod_1.z.string().optional(),
+    udid: zod_1.z.string().optional(),
+    'appium:platformVersion': zod_1.z.string().optional(),
+    platformVersion: zod_1.z.string().optional(),
+    'appium:deviceName': zod_1.z.string().optional(),
+    deviceName: zod_1.z.string().optional(),
+    'appium:app': zod_1.z.string().optional(),
+    app: zod_1.z.string().optional(),
+    // Standard Appium Timeouts & Reset strategies
+    'appium:newCommandTimeout': zod_1.z.number().int().min(0).max(1800).optional(),
+    newCommandTimeout: zod_1.z.number().int().min(0).max(1800).optional(),
+    'appium:noReset': zod_1.z.boolean().optional(),
+    noReset: zod_1.z.boolean().optional(),
+    'appium:fullReset': zod_1.z.boolean().optional(),
+    fullReset: zod_1.z.boolean().optional(),
+    // Xenon Specific Options (Enterprise Features)
+    [XenonCapabilityManager_1.XENON_CAPABILITIES.BUILD_NAME]: zod_1.z.string().optional(),
+    [XenonCapabilityManager_1.XENON_CAPABILITIES.SESSION_NAME]: zod_1.z.string().optional(),
+    // Xenon Network Conditioning (Roadmap Item 2)
+    'xenon:networkProfile': zod_1.z.enum(['4G', '3G', 'Edge', 'Offline', 'Normal']).optional(),
+    // Predictive Failure Thresholds (Roadmap Item 1)
+    'xenon:minBatteryLevel': zod_1.z.number().int().min(1).max(100).optional().default(10),
+    'xenon:maxThermalStatus': zod_1.z.enum(['Normal', 'Hot', 'Critical']).optional().default('Hot'),
+    // Advanced Resource Isolation (Roadmap Item 3)
+    'xenon:isolationProfile': zod_1.z
+        .enum(['Economy', 'Performance', 'Guaranteed'])
+        .optional()
+        .default('Performance'),
+    // Core capabilities using the enum defined in XenonCapabilityManager
+    [XenonCapabilityManager_1.XENON_CAPABILITIES.VIDEO_RECORDING]: zod_1.z.union([zod_1.z.boolean(), zod_1.z.string()]).optional(),
+    [XenonCapabilityManager_1.XENON_CAPABILITIES.RECORD_VIDEO]: zod_1.z.union([zod_1.z.boolean(), zod_1.z.string()]).optional(),
+    [XenonCapabilityManager_1.XENON_CAPABILITIES.SCREENSHOT_ON_FAILURE]: zod_1.z.union([zod_1.z.boolean(), zod_1.z.string()]).optional(),
+    [XenonCapabilityManager_1.XENON_CAPABILITIES.SCREENSHOT_ON_FAIL]: zod_1.z.union([zod_1.z.boolean(), zod_1.z.string()]).optional(),
+    [XenonCapabilityManager_1.XENON_CAPABILITIES.SCREENSHOT_ON_EVERY_COMMAND]: zod_1.z.union([zod_1.z.boolean(), zod_1.z.string()]).optional(),
+    [XenonCapabilityManager_1.XENON_CAPABILITIES.SCREENSHOT_EVERY_COMMAND]: zod_1.z.union([zod_1.z.boolean(), zod_1.z.string()]).optional(),
+    [XenonCapabilityManager_1.XENON_CAPABILITIES.SAVE_DEVICE_LOGS]: zod_1.z.union([zod_1.z.boolean(), zod_1.z.string()]).optional(),
+    [XenonCapabilityManager_1.XENON_CAPABILITIES.SAVE_LOGS]: zod_1.z.union([zod_1.z.boolean(), zod_1.z.string()]).optional(),
+    // Legacy/Additional snake_case/camelCase aliases not covered by the main enum
+    buildName: zod_1.z.string().optional(),
+    sessionName: zod_1.z.string().optional(),
+})
+    .passthrough();
+/**
+ * Principal Capability Validator
+ * Performs strict validation and "Fails Fast" before resource allocation.
+ */
+let CapabilityValidator = class CapabilityValidator {
+    /**
+     * Validates the merged capabilities from alwaysMatch and firstMatch.
+     * @param caps The merged capability object
+     * @returns Validated object or throws error
+     */
+    validate(caps) {
+        const result = exports.CapabilitySchema.safeParse(caps);
+        if (!result.success) {
+            const error = result.error.issues[0];
+            const field = error.path.join('.');
+            throw new Error(`[Xenon] Invalid Capability: '${field}' - ${error.message}`);
+        }
+        return result.data;
+    }
+};
+exports.CapabilityValidator = CapabilityValidator;
+exports.CapabilityValidator = CapabilityValidator = __decorate([
+    (0, typedi_1.Service)()
+], CapabilityValidator);

package/lib/test/e2e/android/conf.spec.js

@@ -0,0 +1,43 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const webdriverio_1 = require("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 = {
+    platformName: 'Android',
+    'appium:uiautomator2ServerInstallTimeout': '50000',
+    'appium:automationName': 'UIAutomator2',
+    'appium:app': 'https://github.com/AppiumTestDistribution/appium-demo/blob/main/VodQA.apk?raw=true',
+};
+let driver;
+describe('Plugin Test', () => {
+    beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {
+        driver = yield (0, webdriverio_1.remote)(Object.assign(Object.assign({}, WDIO_PARAMS), { capabilities }));
+    }));
+    it('Vertical swipe test', () => __awaiter(void 0, void 0, void 0, function* () {
+        console.log(yield driver.capabilities.deviceUDID);
+        yield driver.$('~login').click();
+    }));
+    afterEach(() => __awaiter(void 0, void 0, void 0, function* () {
+        if (driver) {
+            yield driver.deleteSession();
+            driver = null;
+        }
+    }));
+});

package/lib/test/e2e/android/conf2.spec.js

@@ -0,0 +1,44 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const webdriverio_1 = require("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 = {
+    platformName: 'Android',
+    'appium:uiautomator2ServerInstallTimeout': '50000',
+    'appium:automationName': 'UIAutomator2',
+    'appium:app': 'https://github.com/AppiumTestDistribution/appium-demo/blob/main/VodQA.apk?raw=true',
+};
+describe('Plugin1 Test', () => {
+    let driver;
+    beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {
+        driver = yield (0, webdriverio_1.remote)(Object.assign(Object.assign({}, WDIO_PARAMS), { capabilities }));
+    }));
+    it('Slider test', () => __awaiter(void 0, void 0, void 0, function* () {
+        console.log(yield driver.capabilities.deviceUDID);
+        yield driver.$('~login').click();
+        yield driver.$('~slider1').click();
+    }));
+    afterEach(() => __awaiter(void 0, void 0, void 0, function* () {
+        if (driver) {
+            yield driver.deleteSession();
+            driver = null;
+        }
+    }));
+});

package/lib/test/e2e/android/conf3.spec.js

@@ -0,0 +1,44 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const webdriverio_1 = require("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 = {
+    platformName: 'Android',
+    'appium:uiautomator2ServerInstallTimeout': '50000',
+    'appium:automationName': 'UIAutomator2',
+    'appium:app': 'https://github.com/AppiumTestDistribution/appium-demo/blob/main/VodQA.apk?raw=true',
+};
+describe('Plugin1 Test', () => {
+    let driver;
+    beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {
+        driver = yield (0, webdriverio_1.remote)(Object.assign(Object.assign({}, WDIO_PARAMS), { capabilities }));
+    }));
+    it('Slider test', () => __awaiter(void 0, void 0, void 0, function* () {
+        console.log(yield driver.capabilities.deviceUDID);
+        yield driver.$('~login').click();
+        yield driver.$('~slider1').click();
+    }));
+    afterEach(() => __awaiter(void 0, void 0, void 0, function* () {
+        if (driver) {
+            yield driver.deleteSession();
+            driver = null;
+        }
+    }));
+});

package/lib/test/e2e/e2ehelper.js

@@ -0,0 +1,113 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.node_config = exports.hub_config = exports.PLUGIN_PATH = exports.NODE_APPIUM_PORT = exports.HUB_APPIUM_PORT = void 0;
+exports.ensureTempDir = ensureTempDir;
+exports.ensureAppiumHome = ensureAppiumHome;
+exports.ensureHubConfig = ensureHubConfig;
+exports.ensureNodeConfig = ensureNodeConfig;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const os_1 = __importDefault(require("os"));
+const ip_1 = __importDefault(require("ip"));
+const IPluginArgs_1 = require("../../src/interfaces/IPluginArgs");
+const ifaces = os_1.default.networkInterfaces();
+/**
+ {
+  lo0: [
+    {
+      address: '127.0.0.1',
+      netmask: '255.0.0.0',
+      family: 'IPv4',
+      mac: '00:00:00:00:00:00',
+      internal: true,
+      cidr: '127.0.0.1/8'
+    }
+  ]
+}
+ */
+const localIp = ip_1.default.address();
+const ifaceNames = Object.keys(ifaces);
+// find first ip address coming from device other than localIp
+const availableIpAddresses = ifaceNames
+    .map((device) => {
+    var _a;
+    return (_a = (ifaces[device] || []).find((iface) => iface.family === 'IPv4')) === null || _a === void 0 ? void 0 : _a.address;
+})
+    .filter((ip) => ip !== undefined);
+// find first ip address coming from device other than localIp
+let alternateIp = availableIpAddresses.find((ip) => ip !== localIp);
+if (alternateIp === undefined)
+    alternateIp = localIp;
+console.log(`Using localIp: ${localIp}`);
+console.log(`Using alternateIp: ${alternateIp}`);
+exports.HUB_APPIUM_PORT = 4723;
+exports.NODE_APPIUM_PORT = 4724;
+exports.PLUGIN_PATH = path_1.default.resolve(__dirname + '/../..');
+exports.hub_config = Object.assign({}, IPluginArgs_1.DefaultPluginArgs, {
+    hub: undefined,
+    bindHostOrIp: localIp,
+});
+exports.node_config = Object.assign({}, IPluginArgs_1.DefaultPluginArgs, {
+    hub: `http://${exports.hub_config.bindHostOrIp}:${exports.HUB_APPIUM_PORT}`,
+    bindHostOrIp: alternateIp,
+});
+function ensureTempDir() {
+    const tempDir = path_1.default.resolve(__dirname + '/../../temp-appium');
+    if (!fs_1.default.existsSync(tempDir)) {
+        fs_1.default.mkdirSync(tempDir);
+    }
+    return tempDir;
+}
+function ensureAppiumHome(suffix = '', deleteExisting = true) {
+    const newHome = path_1.default.resolve(path_1.default.join(__dirname, '/../../temp-appium', suffix));
+    if (!fs_1.default.existsSync(newHome)) {
+        fs_1.default.mkdirSync(newHome);
+    }
+    // check if there's already extensions.yaml under node_modules/.cache/appium
+    const extensionsYaml = path_1.default.join(newHome, 'node_modules', '.cache', 'appium', 'extensions.yaml');
+    // log a warning as appium won't be able to install the plugin
+    if (fs_1.default.existsSync(extensionsYaml)) {
+        console.log(`WARNING: ${extensionsYaml} already exists. Appium won't be able to install the plugin`);
+        if (deleteExisting) {
+            console.log(`Deleting ${extensionsYaml}`);
+            fs_1.default.unlinkSync(extensionsYaml);
+        }
+    }
+    return newHome;
+}
+function ensureHubConfig(platform = 'android', iosDeviceType = 'both', androidDeviceType = 'both', moreConfig = {}) {
+    return ensureConfig('hub-config.json', {
+        server: {
+            port: exports.HUB_APPIUM_PORT,
+            plugin: {
+                xenon: Object.assign(exports.node_config, {
+                    platform,
+                    androidDeviceType,
+                    iosDeviceType,
+                }, moreConfig),
+            },
+        },
+    });
+}
+function ensureNodeConfig(platform = 'android', iosDeviceType = 'both', androidDeviceType = 'both', moreConfig = {}) {
+    return ensureConfig('node-config.json', {
+        server: {
+            port: exports.NODE_APPIUM_PORT,
+            plugin: {
+                xenon: Object.assign(exports.node_config, {
+                    platform,
+                    androidDeviceType,
+                    iosDeviceType,
+                }),
+            },
+        },
+    });
+}
+function ensureConfig(filename, config) {
+    const config_file = ensureTempDir() + '/' + filename;
+    fs_1.default.writeFileSync(config_file, JSON.stringify(config));
+    return config_file;
+}