@mablhq/mabl-cli 1.61.8 → 2.0.3

package/mablscript/mobile/steps/actions/MobileFindAction.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MobileFindAction = void 0;
+const MablAction_1 = require("../../../MablAction");
+class MobileFindAction extends MablAction_1.MablAction {
+    constructor(findDescriptor) {
+        super('MobileFindAction', [[]]);
+        this.findDescriptor = findDescriptor;
+    }
+    toDescriptor() {
+        return this.findDescriptor;
+    }
+    toYaml() {
+        return this.findDescriptor;
+    }
+    getInputVariables() {
+        return MablAction_1.MablAction.findUniqueVariableReferencesInValue(this.findDescriptor);
+    }
+    static fromDescriptor(mobileFindDescriptor) {
+        return new MobileFindAction(mobileFindDescriptor);
+    }
+}
+exports.MobileFindAction = MobileFindAction;

package/mablscript/mobile/steps/stepUtil.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isStepWithFind = exports.humanizeCustomFind = exports.getDescriptionForMobileStep = exports.getSimpleIOSElementName = exports.getSimpleAndroidElementName = void 0;
+const domUtil_1 = require("../../../domUtil");
+const mablscriptFind_1 = require("../../../mablscriptFind");
+function getSimpleAndroidElementName(className) {
+    if (!className) {
+        return 'unknown';
+    }
+    const parts = className.split('.');
+    return parts[parts.length - 1];
+}
+exports.getSimpleAndroidElementName = getSimpleAndroidElementName;
+function getSimpleIOSElementName(elementName) {
+    if (!elementName) {
+        return 'unknown';
+    }
+    const parts = elementName.split('XCUIElementType');
+    if (parts.length > 1) {
+        return parts[1];
+    }
+    return 'unknown';
+}
+exports.getSimpleIOSElementName = getSimpleIOSElementName;
+function getDescriptionForMobileStep(predicateAction, descriptor) {
+    var _a;
+    const findTarget = (_a = descriptor.find) === null || _a === void 0 ? void 0 : _a.findTarget;
+    if ((0, domUtil_1.isMobileFindSpecification)(findTarget)) {
+        if ((0, domUtil_1.isWebViewFindElementDescriptor)(descriptor.find)) {
+            return getDescriptionForWebViewStep(predicateAction, descriptor.find);
+        }
+        const selector = findTarget.selector;
+        if (selector.android && Object.keys(selector.android).length) {
+            if (selector.android.text) {
+                return `${predicateAction} element with text "${selector.android.text}"`;
+            }
+            return `${predicateAction} "${getSimpleAndroidElementName(selector.android.class)}" element`;
+        }
+        else if (selector.iOS) {
+            if (selector.iOS.name) {
+                return `${predicateAction} "${selector.iOS.name}" element`;
+            }
+            if (selector.iOS.label) {
+                return `${predicateAction} element with text "${selector.iOS.label}"`;
+            }
+            return `${predicateAction} the "${getSimpleIOSElementName(selector.iOS.type)}" element`;
+        }
+    }
+    return `${predicateAction} unknown element`;
+}
+exports.getDescriptionForMobileStep = getDescriptionForMobileStep;
+function getDescriptionForWebViewStep(predicateAction, webViewElementDescriptor) {
+    if ((0, domUtil_1.isFindElementDescriptor)(webViewElementDescriptor.webView.descriptor)) {
+        const elementDescription = (0, mablscriptFind_1.humanizeFindOneDescriptor)(webViewElementDescriptor.webView.descriptor.findTarget);
+        return `${predicateAction} ${elementDescription}`;
+    }
+    return `Unknown webview descriptor type.`;
+}
+function humanizeCustomFind(descriptor) {
+    if (isStepWithFind(descriptor)) {
+        if ((0, domUtil_1.isMobileFindCustomDescriptor)(descriptor.find)) {
+            return `xpath: ${descriptor.find.findTarget.xpath}`;
+        }
+    }
+    return `custom find`;
+}
+exports.humanizeCustomFind = humanizeCustomFind;
+function isStepWithFind(value) {
+    return !!(value === null || value === void 0 ? void 0 : value.find);
+}
+exports.isStepWithFind = isStepWithFind;

package/mablscript/mobile/tests/StepTestsUtil.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadRawStepIntoMablStep = exports.parseAndValidateYamlConversion = void 0;
+const js_yaml_1 = require("js-yaml");
+const importer_1 = require("../../importer");
+function parseAndValidateYamlConversion(steps, expectedStepName, expectedDescriptor) {
+    const yamlfiedSteps = (0, js_yaml_1.dump)(steps);
+    const loadedSteps = (0, importer_1.loadYamlSteps)(yamlfiedSteps, true);
+    expect(loadedSteps[0].name).toEqual(expectedStepName);
+    expect(loadedSteps[0].descriptor).toEqual(expectedDescriptor);
+    const yamlfied = (0, importer_1.yamlifyTheLoadedSteps)(loadedSteps);
+    expect(yamlfied).toEqual(yamlfiedSteps);
+}
+exports.parseAndValidateYamlConversion = parseAndValidateYamlConversion;
+function loadRawStepIntoMablStep(step) {
+    const yamlfiedSteps = (0, js_yaml_1.dump)([step]);
+    const loadedSteps = (0, importer_1.loadYamlSteps)(yamlfiedSteps, true);
+    return loadedSteps[0];
+}
+exports.loadRawStepIntoMablStep = loadRawStepIntoMablStep;

package/mablscript/mobile/tests/TestMobileFindDescriptors.js

@@ -0,0 +1,215 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AndroidTestLabWebViewClickCounterMobileFindDescriptor = exports.iOSTestLabWebViewClickCounterMobileFindDescriptor = exports.AndroidWebViewTextFieldMobileFindDescriptor = exports.iOSWebViewTextFieldMobileFindDescriptor = void 0;
+const domUtil_1 = require("../../../domUtil");
+exports.iOSWebViewTextFieldMobileFindDescriptor = {
+    findType: domUtil_1.FindType.FIND_ONE,
+    findTarget: {
+        selector: {
+            iOS: {
+                accessible: false,
+                rect: {
+                    width: 390,
+                    x: 0,
+                    y: 175,
+                    height: 635,
+                },
+                xpath: '//XCUIElementTypeApplication/XCUIElementTypeWindow/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeWebView',
+                visible: true,
+                index: 1,
+                alternateXPaths: [],
+                type: 'XCUIElementTypeWebView',
+                enabled: true,
+            },
+            uuid: '',
+        },
+    },
+    webView: {
+        descriptor: {
+            findTarget: {
+                selector: {
+                    bounding_width: '155',
+                    visible: 'true',
+                    tag_name: 'input',
+                    namespace_uri: 'http://www.w3.org/1999/xhtml',
+                    label: 'Regex pattern restriction (simple ip address-like):',
+                    title: 'HTML5 Input Type test',
+                    uuid: '',
+                    url: 'https://storage.googleapis.com/public-dev-test-lab/input/inputtypes.html',
+                    xpath: '//html[1]/body[1]/form[1]/table[1]/tbody[1]/tr[17]/td[2]/input[1]',
+                    inputElementType: 'text',
+                    name: 'input-regex',
+                    id: 'input-regex',
+                    bounding_height: '21',
+                    bounding_x: '333',
+                    bounding_y: '288',
+                },
+            },
+            findType: domUtil_1.FindType.FIND_ONE,
+        },
+        title: 'HTML5 Input Type test',
+        url: 'https://storage.googleapis.com/public-dev-test-lab/input/inputtypes.html',
+    },
+};
+exports.AndroidWebViewTextFieldMobileFindDescriptor = {
+    findType: domUtil_1.FindType.FIND_ONE,
+    findTarget: {
+        selector: {
+            android: {
+                displayed: true,
+                checkable: false,
+                clickable: false,
+                index: 0,
+                focusable: false,
+                alternateXPaths: [],
+                enabled: true,
+                longClickable: false,
+                rect: {
+                    width: 1440,
+                    x: 0,
+                    y: 280,
+                    height: 2196,
+                },
+                password: false,
+                xpath: '//hierarchy/android.widget.FrameLayout/android.widget.LinearLayout/android.widget.FrameLayout/androidx.compose.ui.platform.ComposeView/android.view.View/android.view.View/android.view.View/android.view.ViewGroup/android.webkit.WebView',
+                bounds: '[0,280][1440,2476]',
+                focused: false,
+                checked: false,
+                text: '',
+                class: 'android.webkit.WebView',
+                scrollable: false,
+                selected: false,
+            },
+            uuid: '',
+        },
+    },
+    webView: {
+        descriptor: {
+            findTarget: {
+                selector: {
+                    bounding_width: '191',
+                    visible: 'true',
+                    tag_name: 'input',
+                    namespace_uri: 'http://www.w3.org/1999/xhtml',
+                    label: 'Regex pattern restriction (simple ip address-like):',
+                    title: 'HTML5 Input Type test',
+                    uuid: '',
+                    url: 'https://storage.googleapis.com/public-dev-test-lab/input/inputtypes.html',
+                    xpath: '//html[1]/body[1]/form[1]/table[1]/tbody[1]/tr[17]/td[2]/input[1]',
+                    inputElementType: 'text',
+                    name: 'input-regex',
+                    id: 'input-regex',
+                    bounding_height: '21',
+                    bounding_x: '92',
+                    bounding_y: '476',
+                },
+            },
+            findType: domUtil_1.FindType.FIND_ONE,
+        },
+        title: 'HTML5 Input Type test',
+        url: 'https://storage.googleapis.com/public-dev-test-lab/input/inputtypes.html',
+    },
+};
+exports.iOSTestLabWebViewClickCounterMobileFindDescriptor = {
+    findType: domUtil_1.FindType.FIND_ONE,
+    findTarget: {
+        selector: {
+            iOS: {
+                accessible: false,
+                rect: {
+                    width: 390,
+                    x: 0,
+                    y: 143,
+                    height: 334,
+                },
+                visible: true,
+                xpath: '//XCUIElementTypeApplication/XCUIElementTypeWindow/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeWebView',
+                alternateXPaths: [],
+                type: 'XCUIElementTypeWebView',
+                enabled: true,
+            },
+            uuid: '',
+        },
+    },
+    webView: {
+        descriptor: {
+            findTarget: {
+                selector: {
+                    bounding_width: '69',
+                    visible: 'true',
+                    tag_name: 'button',
+                    namespace_uri: 'http://www.w3.org/1999/xhtml',
+                    title: 'test lab - click counter',
+                    uuid: '',
+                    url: 'https://storage.googleapis.com/public-dev-test-lab/click/click-counter.html',
+                    xpath: '//html[1]/body[1]/div[1]/button[1]',
+                    id: 'click-me-button',
+                    text: 'Click me',
+                    bounding_height: '29',
+                    bounding_x: '40',
+                    bounding_y: '125',
+                },
+            },
+            findType: domUtil_1.FindType.FIND_ONE,
+        },
+        title: 'test lab - click counter',
+        url: 'https://storage.googleapis.com/public-dev-test-lab/click/click-counter.html',
+    },
+};
+exports.AndroidTestLabWebViewClickCounterMobileFindDescriptor = {
+    findType: domUtil_1.FindType.FIND_ONE,
+    findTarget: {
+        selector: {
+            android: {
+                displayed: true,
+                checkable: false,
+                clickable: false,
+                index: 0,
+                focusable: false,
+                alternateXPaths: [],
+                enabled: true,
+                longClickable: false,
+                rect: {
+                    width: 1000,
+                    x: 0,
+                    y: 280,
+                    height: 700,
+                },
+                password: false,
+                xpath: '//hierarchy/android.widget.FrameLayout/android.widget.LinearLayout/android.widget.FrameLayout/androidx.compose.ui.platform.ComposeView/android.view.View/android.view.View/android.view.View/android.view.ViewGroup/android.webkit.WebView',
+                bounds: '[0,280][1000,980]',
+                focused: false,
+                checked: false,
+                text: '',
+                class: 'android.webkit.WebView',
+                scrollable: false,
+                selected: false,
+            },
+            uuid: '',
+        },
+    },
+    webView: {
+        descriptor: {
+            findTarget: {
+                selector: {
+                    bounding_width: '67',
+                    visible: 'true',
+                    tag_name: 'button',
+                    namespace_uri: 'http://www.w3.org/1999/xhtml',
+                    title: 'test lab - click counter',
+                    uuid: '',
+                    url: 'https://storage.googleapis.com/public-dev-test-lab/click/click-counter.html',
+                    xpath: '//html[1]/body[1]/div[1]/button[1]',
+                    id: 'click-me-button',
+                    text: 'Click me',
+                    bounding_height: '21',
+                    bounding_x: '40',
+                    bounding_y: '115',
+                },
+            },
+            findType: domUtil_1.FindType.FIND_ONE,
+        },
+        title: 'test lab - click counter',
+        url: 'https://storage.googleapis.com/public-dev-test-lab/click/click-counter.html',
+    },
+};

package/mablscript/mobile/tests/steps/CreateVariableMobileStep.mobiletest.js

@@ -0,0 +1,287 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const domUtil_1 = require("../../../../domUtil");
+const CreateVariableStepDescriptor_1 = require("../../../types/CreateVariableStepDescriptor");
+const CreateVariableMobileStep_1 = require("../../steps/CreateVariableMobileStep");
+const StepTestsUtil_1 = require("../StepTestsUtil");
+describe('CreateVariable mobile steps parse correctly', () => {
+    it('Parses a CreateVariable mobile step with variable pattern', () => {
+        const stepDescriptor = {
+            generator: {
+                pattern: `my value: {{digit:3}}`,
+                type: CreateVariableStepDescriptor_1.VariableGenerator.PATTERN,
+            },
+            name: 'myValue',
+        };
+        const steps = [
+            {
+                CreateVariable: stepDescriptor,
+            },
+        ];
+        (0, StepTestsUtil_1.parseAndValidateYamlConversion)(steps, CreateVariableMobileStep_1.CreateVariableMobileStep.stepName, stepDescriptor);
+    });
+    it('Parses a CreateVariable mobile step for generating email address', () => {
+        const stepDescriptor = {
+            generator: {
+                type: CreateVariableStepDescriptor_1.VariableGenerator.EMAIL,
+            },
+            name: 'email',
+        };
+        const steps = [
+            {
+                CreateVariable: stepDescriptor,
+            },
+        ];
+        (0, StepTestsUtil_1.parseAndValidateYamlConversion)(steps, CreateVariableMobileStep_1.CreateVariableMobileStep.stepName, stepDescriptor);
+    });
+    it('Parses a CreateVariable mobile step for element attribute (Android)', () => {
+        const stepDescriptor = {
+            find: {
+                findType: domUtil_1.FindType.FIND_ONE,
+                findTarget: {
+                    selector: {
+                        android: {
+                            text: 'Profile',
+                        },
+                        uuid: '',
+                    },
+                },
+            },
+            generator: {
+                attribute: 'text',
+                type: CreateVariableStepDescriptor_1.VariableGenerator.ATTRIBUTE,
+            },
+            name: 'profile',
+        };
+        const steps = [
+            {
+                CreateVariable: stepDescriptor,
+            },
+        ];
+        (0, StepTestsUtil_1.parseAndValidateYamlConversion)(steps, CreateVariableMobileStep_1.CreateVariableMobileStep.stepName, stepDescriptor);
+    });
+    it('Parses a CreateVariable mobile step for element attribute (iOS)', () => {
+        const stepDescriptor = {
+            find: {
+                findType: domUtil_1.FindType.FIND_ONE,
+                findTarget: {
+                    selector: {
+                        iOS: {
+                            name: `PROFILE`,
+                        },
+                        uuid: '',
+                    },
+                },
+            },
+            generator: {
+                attribute: 'name',
+                type: CreateVariableStepDescriptor_1.VariableGenerator.ATTRIBUTE,
+            },
+            name: 'profile',
+        };
+        const steps = [
+            {
+                CreateVariable: stepDescriptor,
+            },
+        ];
+        (0, StepTestsUtil_1.parseAndValidateYamlConversion)(steps, CreateVariableMobileStep_1.CreateVariableMobileStep.stepName, stepDescriptor);
+    });
+    it('Parses a CreateVariable mobile step for element count (Android)', () => {
+        const stepDescriptor = {
+            find: {
+                findType: domUtil_1.FindType.FIND_ALL,
+                findTarget: {
+                    xpath: "//android.widget.TextView[@text='Car']",
+                },
+                foundElementSelectors: {
+                    android: {
+                        xpath: "//android.widget.TextView[@text='Car']",
+                    },
+                    uuid: '',
+                },
+                primarySelectors: {
+                    xpath: "//android.widget.TextView[@text='Car']",
+                },
+            },
+            generator: {
+                type: CreateVariableStepDescriptor_1.VariableGenerator.ELEMENT_COUNT,
+            },
+            name: 'count',
+        };
+        const steps = [
+            {
+                CreateVariable: stepDescriptor,
+            },
+        ];
+        (0, StepTestsUtil_1.parseAndValidateYamlConversion)(steps, CreateVariableMobileStep_1.CreateVariableMobileStep.stepName, stepDescriptor);
+    });
+    it('Parses a CreateVariable mobile step for element count (iOS)', () => {
+        const stepDescriptor = {
+            find: {
+                findType: domUtil_1.FindType.FIND_ALL,
+                findTarget: {
+                    xpath: "//XCUIElementTypeStaticText[@name='Car']",
+                },
+                foundElementSelectors: {
+                    android: {
+                        xpath: "//android.widget.TextView[@text='Car']",
+                    },
+                    uuid: '',
+                },
+                primarySelectors: {
+                    xpath: "//android.widget.TextView[@text='Car']",
+                },
+            },
+            generator: {
+                type: CreateVariableStepDescriptor_1.VariableGenerator.ELEMENT_COUNT,
+            },
+            name: 'count',
+        };
+        const steps = [
+            {
+                CreateVariable: stepDescriptor,
+            },
+        ];
+        (0, StepTestsUtil_1.parseAndValidateYamlConversion)(steps, CreateVariableMobileStep_1.CreateVariableMobileStep.stepName, stepDescriptor);
+    });
+    it('Parses a CreateVariable mobile step for JavaScript snippet (Android)', () => {
+        const stepDescriptor = {
+            generator: {
+                javaScript: { encodedJS: 'myScript' },
+                type: CreateVariableStepDescriptor_1.VariableGenerator.JAVASCRIPT,
+            },
+            name: 'result',
+        };
+        const steps = [
+            {
+                CreateVariable: stepDescriptor,
+            },
+        ];
+        (0, StepTestsUtil_1.parseAndValidateYamlConversion)(steps, CreateVariableMobileStep_1.CreateVariableMobileStep.stepName, stepDescriptor);
+    });
+    it('Parses a CreateVariable mobile step for element count (iOS)', () => {
+        const stepDescriptor = {
+            generator: {
+                javaScript: { encodedJS: 'myScript' },
+                type: CreateVariableStepDescriptor_1.VariableGenerator.JAVASCRIPT,
+            },
+            name: 'result',
+        };
+        const steps = [
+            {
+                CreateVariable: stepDescriptor,
+            },
+        ];
+        (0, StepTestsUtil_1.parseAndValidateYamlConversion)(steps, CreateVariableMobileStep_1.CreateVariableMobileStep.stepName, stepDescriptor);
+    });
+    it('Humanizes a Create variable from pattern step', () => {
+        const stepDescriptor = {
+            CreateVariable: {
+                generator: {
+                    pattern: `my value: {{digit:3}}`,
+                    type: CreateVariableStepDescriptor_1.VariableGenerator.PATTERN,
+                },
+                name: 'myValue',
+            },
+        };
+        const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepDescriptor);
+        expect(step.stepDescription()).toEqual(`Assign variable \"myValue\" value from string generated with format \"my value: {{digit:3}}\"`);
+    });
+    it('Humanizes a Create variable from email step', () => {
+        const stepDescriptor = {
+            CreateVariable: {
+                generator: {
+                    type: CreateVariableStepDescriptor_1.VariableGenerator.EMAIL,
+                },
+                name: 'email',
+            },
+        };
+        const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepDescriptor);
+        expect(step.stepDescription()).toEqual(`Generate a new mabl mailbox email address`);
+    });
+    it('Humanizes a Create variable from element attribute step (android)', () => {
+        const stepDescriptor = {
+            CreateVariable: {
+                find: {
+                    findType: domUtil_1.FindType.FIND_ONE,
+                    findTarget: {
+                        selector: {
+                            android: {
+                                text: 'Profile',
+                            },
+                        },
+                    },
+                },
+                generator: {
+                    attribute: 'text',
+                    type: CreateVariableStepDescriptor_1.VariableGenerator.ATTRIBUTE,
+                },
+                name: 'profile',
+            },
+        };
+        const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepDescriptor);
+        expect(step.stepDescription()).toEqual(`Assign variable \"profile\" value from element attribute \"text\"`);
+    });
+    it('Humanizes a Create variable from element attribute step (iOS)', () => {
+        const stepDescriptor = {
+            CreateVariable: {
+                find: {
+                    findType: domUtil_1.FindType.FIND_ONE,
+                    findTarget: {
+                        selector: {
+                            iOS: {
+                                name: `PROFILE`,
+                            },
+                        },
+                    },
+                },
+                generator: {
+                    attribute: 'name',
+                    type: CreateVariableStepDescriptor_1.VariableGenerator.ATTRIBUTE,
+                },
+                name: 'profile',
+            },
+        };
+        const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepDescriptor);
+        expect(step.stepDescription()).toEqual(`Assign variable \"profile\" value from element attribute \"name\"`);
+    });
+    it('Humanizes a Create variable from element count', () => {
+        const stepDescriptor = {
+            CreateVariable: {
+                find: {
+                    findType: domUtil_1.FindType.FIND_ALL,
+                    findTarget: {
+                        xpath: "//android.widget.TextView[@text='Car']",
+                    },
+                    foundElementSelectors: {
+                        android: {
+                            xpath: "//android.widget.TextView[@text='Car']",
+                        },
+                    },
+                    primarySelectors: {
+                        xpath: "//android.widget.TextView[@text='Car']",
+                    },
+                },
+                generator: {
+                    type: CreateVariableStepDescriptor_1.VariableGenerator.ELEMENT_COUNT,
+                },
+                name: 'count',
+            },
+        };
+        const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepDescriptor);
+        expect(step.stepDescription()).toEqual(`Assign variable \"count\" value from element count using xpath: //android.widget.TextView[@text='Car']`);
+    });
+    it('Humanizes a Create variable from script snippet', () => {
+        const stepDescriptor = {
+            CreateVariable: {
+                generator: {
+                    javaScript: { encodedJS: 'myScript' },
+                    type: CreateVariableStepDescriptor_1.VariableGenerator.JAVASCRIPT,
+                },
+                name: 'result',
+            },
+        };
+        const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepDescriptor);
+        expect(step.stepDescription()).toEqual(`Assign variable \"result\" using script`);
+    });
+});