@xenon-device-management/xenon 1.1.0

package/lib/test/unit/IOSDeviceManager.spec.js

@@ -0,0 +1,261 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+const sinon_1 = __importDefault(require("sinon"));
+const chai_1 = require("chai");
+const IOSDeviceManager_1 = __importDefault(require("../../src/device-managers/IOSDeviceManager"));
+const IOSDiscoveryService_1 = require("../../src/device-managers/ios/IOSDiscoveryService");
+const Helper = __importStar(require("../../src/helpers"));
+const DeviceUtils = __importStar(require("../../src/device-utils"));
+const devices_1 = require("./fixtures/devices");
+const ip_1 = __importDefault(require("ip"));
+const IPluginArgs_1 = require("../../src/interfaces/IPluginArgs");
+let sandbox = sinon_1.default.createSandbox();
+beforeEach(() => {
+    if (IOSDiscoveryService_1.IOSDiscoveryService.prototype.getDevices.restore) {
+        IOSDiscoveryService_1.IOSDiscoveryService.prototype.getDevices.restore();
+    }
+    sinon_1.default.restore();
+    sandbox = sinon_1.default.createSandbox();
+});
+afterEach(function () {
+    sandbox.restore();
+});
+const pluginArgs = Object.assign({}, IPluginArgs_1.DefaultPluginArgs, {
+    remote: [`http://${ip_1.default.address()}:4723`],
+    skipChromeDownload: true,
+});
+describe('IOS Device Manager', () => {
+    it('IOS Device List to have added state', () => __awaiter(void 0, void 0, void 0, function* () {
+        const iosDevices = new IOSDeviceManager_1.default(pluginArgs, 4723);
+        sandbox.stub(IOSDiscoveryService_1.IOSDiscoveryService.prototype, 'getDevices').resolves([
+            {
+                udid: '00001111-00115D822222002E',
+                sdk: '14.1.1',
+                name: 'Sai’s iPhone',
+                busy: false,
+                realDevice: true,
+                deviceType: 'real',
+                platform: 'ios',
+                wdaLocalPort: 54093,
+                sessionStartTime: 0,
+                totalUtilizationTimeMilliSec: 0,
+                host: `http://${ip_1.default.address()}:4723`,
+                derivedDataPath: 'dummy',
+                mjpegServerPort: 54093,
+            },
+            {
+                name: 'iPad Air (3rd generation)',
+                udid: '0FBCBDCC-2FF1-4FCA-B034-60ABC86ED866',
+                state: 'Shutdown',
+                sdk: '13.5',
+                platform: 'ios',
+                deviceType: 'simulator',
+                host: `http://${ip_1.default.address()}:4723`,
+            },
+            {
+                name: 'iPad Air (3rd generation)',
+                udid: '0FBCBDCC-2FF1-4FCA-B034-60ABC86E9999',
+                state: 'Booted',
+                sdk: '14.5',
+                platform: 'ios',
+                deviceType: 'simulator',
+                host: `http://${ip_1.default.address()}:4723`,
+            },
+        ]);
+        sandbox.stub(Helper, 'isMac').returns(true);
+        const devices = yield iosDevices.getDevices({ iosDeviceType: 'both' }, []);
+        (0, chai_1.expect)(devices).to.have.lengthOf(3);
+        (0, chai_1.expect)(devices[0].udid).to.equal('00001111-00115D822222002E');
+        (0, chai_1.expect)(devices[1].udid).to.equal('0FBCBDCC-2FF1-4FCA-B034-60ABC86ED866');
+        (0, chai_1.expect)(devices[2].udid).to.equal('0FBCBDCC-2FF1-4FCA-B034-60ABC86E9999');
+    }));
+    it('Should consider only simulators that is given by user and all real devices', () => __awaiter(void 0, void 0, void 0, function* () {
+        const simulators = [
+            {
+                name: 'iPhone 14',
+                sdk: '16.1',
+            },
+            {
+                name: 'iPhone 14 Plus',
+                sdk: '16.1',
+            },
+        ];
+        let iosDeviceManager = new IOSDeviceManager_1.default(Object.assign({ platform: 'iOS', simulators }, IPluginArgs_1.DefaultPluginArgs), 4723);
+        const mockSims = devices_1.deviceMock.filter((device) => device.platform === 'ios' && device.deviceType === 'simulator');
+        sandbox.stub(IOSDiscoveryService_1.IOSDiscoveryService.prototype, 'getDevices').resolves([
+            {
+                udid: '00001111-00115D822222002E',
+                sdk: '14.1.1',
+                name: 'Sai’s iPhone',
+                busy: false,
+                realDevice: true,
+                deviceType: 'real',
+                platform: 'ios',
+                wdaLocalPort: 54093,
+                sessionStartTime: 0,
+                totalUtilizationTimeMilliSec: 0,
+                host: `http://${ip_1.default.address()}:4723`,
+                derivedDataPath: 'dummy',
+                mjpegServerPort: 54093,
+            },
+            ...mockSims
+        ]);
+        sandbox.stub(Helper, 'getFreePort').returns(54093);
+        sandbox.stub(DeviceUtils, 'getUtilizationTime').returns(0);
+        const devices = yield iosDeviceManager.getDevices({ iosDeviceType: 'real' }, []);
+        devices.forEach((device) => {
+            (0, chai_1.expect)(device.platform).to.equal('ios');
+        });
+    }));
+    it('Should consider only simulators that is given by user and not real devices', () => __awaiter(void 0, void 0, void 0, function* () {
+        const simulators = [
+            {
+                name: 'iPhone 14',
+                sdk: '16.1',
+            },
+            {
+                name: 'iPhone 14 Plus',
+                sdk: '16.1',
+            },
+        ];
+        let iosDeviceManager = new IOSDeviceManager_1.default(Object.assign({ platform: 'iOS', iosDeviceType: 'simulated', remote: ['http://127.0.0.1:4723'], simulators }, IPluginArgs_1.DefaultPluginArgs), 4723);
+        const mockSims = devices_1.deviceMock.filter((device) => device.platform === 'ios' && device.deviceType === 'simulator');
+        sandbox.stub(IOSDiscoveryService_1.IOSDiscoveryService.prototype, 'getDevices').resolves(mockSims);
+        sandbox.stub(Helper, 'getFreePort').returns(54093);
+        sandbox.stub(DeviceUtils, 'getUtilizationTime').returns(0);
+        const devices = yield iosDeviceManager.getDevices({ iosDeviceType: 'simulated' }, []);
+        devices.forEach((device) => {
+            (0, chai_1.expect)(device.realDevice).to.be.false;
+        });
+    }));
+    it('IOS Device List to have added state - Include simulators with real devices', () => __awaiter(void 0, void 0, void 0, function* () {
+        const iosDevices = new IOSDeviceManager_1.default(IPluginArgs_1.DefaultPluginArgs, 4723);
+        sandbox.stub(IOSDiscoveryService_1.IOSDiscoveryService.prototype, 'getDevices').resolves([
+            {
+                udid: '00001111-00115D822222002E',
+                sdk: '14.1.1',
+                name: 'Sai’s iPhone',
+                busy: false,
+                realDevice: true,
+                deviceType: 'real',
+                platform: 'ios',
+                wdaLocalPort: 54093,
+                host: `http://${ip_1.default.address()}:4723`,
+                derivedDataPath: 'dummy',
+                mjpegServerPort: 54093,
+                sessionStartTime: 0,
+                totalUtilizationTimeMilliSec: 0,
+            },
+            {
+                name: 'iPad Air (3rd generation)',
+                udid: '0FBCBDCC-2FF1-4FCA-B034-60ABC86ED866',
+                state: 'Shutdown',
+                sdk: '13.5',
+                platform: 'ios',
+                deviceType: 'simulator',
+                host: `http://${ip_1.default.address()}:4723`,
+            },
+        ]);
+        const devices = yield iosDevices.getDevices({ iosDeviceType: 'both' }, []);
+        (0, chai_1.expect)(devices).to.have.lengthOf(2);
+        (0, chai_1.expect)(devices[0].udid).to.equal('00001111-00115D822222002E');
+        (0, chai_1.expect)(devices[1].udid).to.equal('0FBCBDCC-2FF1-4FCA-B034-60ABC86ED866');
+    }));
+    it('IOS Device List to have added state - Only simulators', () => __awaiter(void 0, void 0, void 0, function* () {
+        const iosDevices = new IOSDeviceManager_1.default(IPluginArgs_1.DefaultPluginArgs, 4723);
+        sandbox.stub(IOSDiscoveryService_1.IOSDiscoveryService.prototype, 'getDevices').resolves([
+            {
+                name: 'iPad Air (3rd generation)',
+                udid: '0FBCBDCC-2FF1-4FCA-B034-60ABC86ED866',
+                state: 'Shutdown',
+                sdk: '13.5',
+                platform: 'ios',
+                deviceType: 'simulator',
+                host: `http://${ip_1.default.address()}:4723`,
+            },
+        ]);
+        sandbox.stub(Helper, 'getFreePort').returns(54093);
+        sandbox.stub(DeviceUtils, 'getUtilizationTime').returns(0);
+        const devices = yield iosDevices.getDevices({ iosDeviceType: 'simulated' }, []);
+        (0, chai_1.expect)(devices).to.deep.equal([
+            {
+                name: 'iPad Air (3rd generation)',
+                udid: '0FBCBDCC-2FF1-4FCA-B034-60ABC86ED866',
+                state: 'Shutdown',
+                sdk: '13.5',
+                platform: 'ios',
+                deviceType: 'simulator',
+                host: `http://${ip_1.default.address()}:4723`,
+            },
+        ]);
+    }));
+    it('IOS Device List to have added state - Only real devices', () => __awaiter(void 0, void 0, void 0, function* () {
+        const iosDevices = new IOSDeviceManager_1.default(IPluginArgs_1.DefaultPluginArgs, 4723);
+        sandbox.stub(IOSDiscoveryService_1.IOSDiscoveryService.prototype, 'getDevices').resolves([
+            {
+                udid: '00001111-00115D822222002E',
+                sdk: '14.1.1',
+                name: 'Sai’s iPhone',
+                busy: false,
+                realDevice: true,
+                deviceType: 'real',
+                platform: 'ios',
+                wdaLocalPort: 54093,
+                sessionStartTime: 0,
+                totalUtilizationTimeMilliSec: 0,
+                host: `http://${ip_1.default.address()}:4723`,
+                derivedDataPath: 'dummy',
+                mjpegServerPort: 54093,
+            }
+        ]);
+        const devices = yield iosDevices.getDevices({ iosDeviceType: 'real' }, []);
+        (0, chai_1.expect)(devices).to.have.lengthOf(1);
+        (0, chai_1.expect)(devices[0].udid).to.equal('00001111-00115D822222002E');
+    }));
+});

package/lib/test/unit/RemoteIOs.spec.js

@@ -0,0 +1,78 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+const sinon_1 = __importDefault(require("sinon"));
+const axios_1 = __importDefault(require("axios"));
+const chai_1 = require("chai");
+const IOSDeviceManager_1 = __importDefault(require("../../src/device-managers/IOSDeviceManager"));
+const IOSDiscoveryService_1 = require("../../src/device-managers/ios/IOSDiscoveryService");
+let sandbox = sinon_1.default.createSandbox();
+beforeEach(function () {
+    if (IOSDiscoveryService_1.IOSDiscoveryService.prototype.getDevices.restore) {
+        IOSDiscoveryService_1.IOSDiscoveryService.prototype.getDevices.restore();
+    }
+    sinon_1.default.restore();
+    sandbox = sinon_1.default.createSandbox();
+});
+afterEach(function () {
+    sinon_1.default.restore();
+    sandbox.restore();
+});
+const stubResponse = {
+    data: [
+        {
+            name: 'iPad (8th generation)',
+            udid: '3F74FBC0-D50E-4317-8C33-428C1CE55C27',
+            state: 'Shutdown',
+            sdk: '14.2',
+            platform: 'ios',
+            busy: false,
+            realDevice: false,
+            deviceType: 'simulator',
+        },
+    ],
+    status: 200,
+    statusText: 'OK',
+    headers: {},
+    config: {},
+};
+describe('Remote IOS', () => __awaiter(void 0, void 0, void 0, function* () {
+    it('Fetch remote devices', function () {
+        return __awaiter(this, void 0, void 0, function* () {
+            let stub = sinon_1.default.stub(axios_1.default, 'post').resolves(stubResponse);
+            const iosDevices = new IOSDeviceManager_1.default({});
+            sandbox.stub(IOSDiscoveryService_1.IOSDiscoveryService.prototype, 'getDevices').resolves([
+                {
+                    wdaLocalPort: 54093,
+                    udid: '00001111-00115D822222002E',
+                    sdk: '14.1.1',
+                    name: 'Sai’s iPhone',
+                    busy: false,
+                    realDevice: true,
+                    deviceType: 'real',
+                    platform: 'ios',
+                    host: 'http://127.0.0.1:4723',
+                    derivedDataPath: 'dummy',
+                    mjpegServerPort: 54093,
+                    sessionStartTime: 0,
+                    totalUtilizationTimeMilliSec: 0,
+                }
+            ]);
+            const devices = yield iosDevices.getDevices({ iosDeviceType: 'both' }, []);
+            (0, chai_1.expect)(devices).to.have.lengthOf(1);
+            (0, chai_1.expect)(devices[0].udid).to.equal('00001111-00115D822222002E');
+        });
+    });
+}));

package/lib/test/unit/ResilioTreeHealingProvider.test.js

@@ -0,0 +1,96 @@
+"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 chai_1 = require("chai");
+const types_1 = require("../../src/services/healing/types");
+const ResilioTreeHealingProvider_1 = require("../../src/services/healing/ResilioTreeHealingProvider");
+const { JSDOMParser, Path } = require('resiliotree');
+describe('ResilioTreeHealingProvider', () => {
+    let provider;
+    let mockEtalonService;
+    const sourceXml = `
+        <hierarchy>
+            <android.widget.FrameLayout index="0">
+                <android.widget.LinearLayout index="0">
+                    <android.widget.Button index="0" text="Submit" resource-id="com.example:id/submit_btn" />
+                    <android.widget.TextView index="1" text="Hello" />
+                </android.widget.LinearLayout>
+            </android.widget.FrameLayout>
+        </hierarchy>
+    `;
+    const brokenXml = `
+        <hierarchy>
+            <android.widget.FrameLayout index="0">
+                <android.widget.LinearLayout index="0">
+                    <android.widget.Button index="0" text="Send" resource-id="com.example:id/send_btn" />
+                    <android.widget.TextView index="1" text="Hello World" />
+                </android.widget.LinearLayout>
+            </android.widget.FrameLayout>
+        </hierarchy>
+    `;
+    beforeEach(() => {
+        mockEtalonService = {
+            getSignature: () => __awaiter(void 0, void 0, void 0, function* () { return null; }),
+        };
+        provider = new ResilioTreeHealingProvider_1.ResilioTreeHealingProvider(mockEtalonService);
+    });
+    it('should heal an element when a ResilioTree path exists', () => __awaiter(void 0, void 0, void 0, function* () {
+        const parser = new JSDOMParser();
+        const root = parser.parse(sourceXml);
+        // Find the button in source
+        const bodyNode = root.children[0];
+        const hierarchyNode = bodyNode.children[0];
+        const frameLayout = hierarchyNode.children[0];
+        const linearLayout = frameLayout.children[0];
+        const buttonNode = linearLayout.children[0];
+        const path = new Path([root, bodyNode, hierarchyNode, frameLayout, linearLayout, buttonNode]);
+        mockEtalonService.getSignature = () => __awaiter(void 0, void 0, void 0, function* () {
+            return ({
+                selector: "//android.widget.Button[@text='Submit']",
+                strategy: 'xpath',
+                attributes: { text: 'Submit', 'resource-id': 'com.example:id/submit_btn' },
+                nodeName: 'android.widget.Button',
+                path: path.toJSON(),
+                lastSeen: Date.now(),
+            });
+        });
+        const mockDriver = {
+            findElement: (strategy, selector) => __awaiter(void 0, void 0, void 0, function* () {
+                (0, chai_1.expect)(strategy).to.equal('xpath');
+                (0, chai_1.expect)(selector.toLowerCase()).to.contain('android.widget.button');
+                return { ELEMENT: 'healed-element-123' };
+            }),
+        };
+        const context = {
+            sessionId: 'test-session',
+            driver: mockDriver,
+            strategy: 'xpath',
+            selector: "//android.widget.Button[@text='Submit']",
+            pageSource: brokenXml,
+        };
+        const result = yield provider.heal(context);
+        (0, chai_1.expect)(result).to.not.be.null;
+        (0, chai_1.expect)(result === null || result === void 0 ? void 0 : result.id).to.equal('healed-element-123');
+        (0, chai_1.expect)(result === null || result === void 0 ? void 0 : result.tier).to.equal(types_1.HealingTier.TIER_1_RECOVERY);
+        (0, chai_1.expect)(result === null || result === void 0 ? void 0 : result.message).to.contain('ResilioTree');
+    }));
+    it('should return null if no signature/path is found', () => __awaiter(void 0, void 0, void 0, function* () {
+        const context = {
+            sessionId: 'test-session',
+            driver: {},
+            strategy: 'xpath',
+            selector: '//unknown',
+            pageSource: brokenXml,
+        };
+        const result = yield provider.heal(context);
+        (0, chai_1.expect)(result).to.be.null;
+    }));
+});

package/lib/test/unit/commands.spec.js

@@ -0,0 +1,27 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const commands_1 = __importDefault(require("../../src/commands"));
+const plugin_1 = require("../../src/plugin");
+const chai_1 = require("chai");
+describe('Plugin commands', () => {
+    it('Should handle empty or populated commands list', () => {
+        (0, chai_1.expect)(Object.keys(commands_1.default).length).to.be.at.least(0);
+    });
+    it('Should register commands to plugin', () => __awaiter(void 0, void 0, void 0, function* () {
+        for (var [name, command] of Object.entries(commands_1.default)) {
+            (0, chai_1.expect)(plugin_1.XenonPlugin.prototype[name]).to.equal(command);
+        }
+    }));
+});

package/lib/test/unit/config.spec.js

@@ -0,0 +1,27 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const device_utils_1 = require("../../src/device-utils");
+const chai_1 = require("chai");
+describe('Config Test', () => {
+    it('Should be able to load data from absolute path from config', () => __awaiter(void 0, void 0, void 0, function* () {
+        const deviceConfigPath = path_1.default.resolve(__dirname, './fixtures/device.config.js');
+        (0, chai_1.expect)((0, device_utils_1.isDeviceConfigPathAbsolute)(deviceConfigPath)).to.be.true;
+    }));
+    it('Should throw error when path is not absolute', () => __awaiter(void 0, void 0, void 0, function* () {
+        const deviceConfigPath = './fixtures/device.config.js';
+        (0, chai_1.expect)(() => (0, device_utils_1.isDeviceConfigPathAbsolute)(deviceConfigPath)).to.throw('Device Config Path ./fixtures/device.config.js should be absolute');
+    }));
+});