@mablhq/mabl-cli 2.8.18 → 2.11.6

package/mablscript/importer.js

@@ -64,6 +64,9 @@ const CreateVariableStepDescriptor_1 = require("./types/CreateVariableStepDescri
 const JavaScriptDescriptor_1 = require("./types/JavaScriptDescriptor");
 const MablStepV2_1 = require("./MablStepV2");
 const PushFileStep_1 = require("./mobile/steps/PushFileStep");
+const InstallAppStep_1 = require("./mobile/steps/InstallAppStep");
+const UninstallAppStep_1 = require("./mobile/steps/UninstallAppStep");
+const PrepareSessionStep_1 = require("./mobile/steps/PrepareSessionStep");
 const ActionTypes = [
     AwaitDownloadAction_1.AwaitDownloadAction,
     AwaitPDFDownloadAction_1.AwaitPDFDownloadAction,
@@ -117,13 +120,16 @@ const StepTypes = [
 const MobileStepTypes = [
     AssertStep_1.AssertStep,
     CreateVariableMobileStep_1.CreateVariableMobileStep,
+    InstallAppStep_1.InstallAppStep,
     NavigateBackStep_1.NavigateBackStep,
     NavigateHomeStep_1.NavigateHomeStep,
     TapStep_1.TapStep,
     EnterTextStep_2.EnterTextStep,
     SetOrientationStep_1.SetOrientationStep,
     ScrollStep_1.ScrollStep,
+    PrepareSessionStep_1.PrepareSessionStep,
     PushFileStep_1.PushFileStep,
+    UninstallAppStep_1.UninstallAppStep,
 ];
 const SyntheticActionCodes = [
     'autologin',

package/mablscript/mobile/steps/InstallAppStep.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InstallAppStep = void 0;
+const MablStepV2_1 = require("../../MablStepV2");
+class InstallAppStep extends MablStepV2_1.MablStepV2 {
+    constructor(descriptor) {
+        super(InstallAppStep.stepName, descriptor, 'installApp');
+    }
+    stepDescription() {
+        if (this.descriptor.packageName) {
+            return `Install app - ${this.descriptor.packageName}`;
+        }
+        return `Install primary app under test`;
+    }
+    static fromYaml(_stepName, stepDescriptor) {
+        return new InstallAppStep(stepDescriptor);
+    }
+}
+exports.InstallAppStep = InstallAppStep;
+InstallAppStep.stepName = 'InstallApp';
+InstallAppStep.yamlMablScriptNames = [InstallAppStep.stepName];
+InstallAppStep.stepVersion = 2;

package/mablscript/mobile/steps/PrepareSessionStep.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PrepareSessionStep = void 0;
+const MablStepV2_1 = require("../../MablStepV2");
+class PrepareSessionStep extends MablStepV2_1.MablStepV2 {
+    constructor(descriptor) {
+        super(PrepareSessionStep.stepName, descriptor, 'prepareSession');
+    }
+    stepDescription() {
+        return `Launch and initialize app session`;
+    }
+    static fromYaml(_stepName, stepDescriptor) {
+        return new PrepareSessionStep(stepDescriptor);
+    }
+}
+exports.PrepareSessionStep = PrepareSessionStep;
+PrepareSessionStep.stepName = 'PrepareSession';
+PrepareSessionStep.yamlMablScriptNames = [PrepareSessionStep.stepName];
+PrepareSessionStep.stepVersion = 2;

package/mablscript/mobile/steps/ScrollStep.js

@@ -1,16 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.humanizeScrollInformation = exports.formatPercentageVal = exports.ScrollStep = void 0;
+exports.getScrollDirectionAndPercentageFromCoordinates = exports.formatPercentageVal = exports.humanizeScrollInformation = exports.ScrollStep = void 0;
 const MablStepV2_1 = require("../../MablStepV2");
+const ScrollStepDescriptor_1 = require("../../types/mobile/ScrollStepDescriptor");
+const stepUtil_1 = require("./stepUtil");
 const STEP_NAME = 'Scroll';
 class ScrollStep extends MablStepV2_1.MablStepV2 {
     constructor(descriptor) {
         super(ScrollStep.stepName, descriptor, 'scroll');
     }
     stepDescription() {
-        return humanizeScrollInformation(this.descriptor.coordinates);
+        return humanizeScrollInformation(this.descriptor);
     }
     static fromYaml(_stepName, stepDescriptor) {
+        if (!stepDescriptor.scrollDirection) {
+            const { scrollDirection } = getScrollDirectionAndPercentageFromCoordinates(stepDescriptor.coordinates);
+            stepDescriptor.scrollDirection = scrollDirection;
+        }
+        if (!stepDescriptor.scrollType) {
+            stepDescriptor.scrollType = ScrollStepDescriptor_1.ScrollType.ScrollDeviceScreen;
+        }
         return new ScrollStep(stepDescriptor);
     }
 }
@@ -18,20 +27,55 @@ exports.ScrollStep = ScrollStep;
 ScrollStep.stepName = STEP_NAME;
 ScrollStep.yamlMablScriptNames = [ScrollStep.stepName];
 ScrollStep.stepVersion = 2;
+function humanizeScrollInformation(stepDescriptor) {
+    switch (stepDescriptor.scrollType) {
+        case ScrollStepDescriptor_1.ScrollType.ScrollDeviceScreen: {
+            const { coordinates } = stepDescriptor;
+            return humanizeCoordinateScroll(coordinates, 'of the screen');
+        }
+        case ScrollStepDescriptor_1.ScrollType.ScrollToElement: {
+            const { find, maxScrollAttempts, scrollDirection, targetElementDescriptor, } = stepDescriptor;
+            const containerElementDescription = (0, stepUtil_1.getElementDescriptionFromMobileFindDescriptor)(find);
+            const targetElementDescription = (0, stepUtil_1.getElementDescriptionFromMobileFindDescriptor)(targetElementDescriptor);
+            return `Scroll ${scrollDirection} a maximum of ${maxScrollAttempts} times within the ${containerElementDescription} until the ${targetElementDescription} is visible`;
+        }
+        case ScrollStepDescriptor_1.ScrollType.ScrollWithinElement: {
+            const { coordinates, find } = stepDescriptor;
+            const containerElementDescription = (0, stepUtil_1.getElementDescriptionFromMobileFindDescriptor)(find);
+            return humanizeCoordinateScroll(coordinates, `within the ${containerElementDescription}`);
+        }
+        default:
+            return 'Unknown scroll step type';
+    }
+}
+exports.humanizeScrollInformation = humanizeScrollInformation;
+function humanizeCoordinateScroll(coordinates, scrollTargetActionString) {
+    const { scrollDirection, scrollPercent } = getScrollDirectionAndPercentageFromCoordinates(coordinates);
+    return `Scroll ${scrollDirection} ${scrollPercent} ${scrollTargetActionString}`;
+}
 function formatPercentageVal(percent) {
     return `${Math.round(percent * 10000) / 100}%`;
 }
 exports.formatPercentageVal = formatPercentageVal;
-function humanizeScrollInformation(coordinates) {
+function getScrollDirectionAndPercentageFromCoordinates(coordinates) {
+    if (!coordinates) {
+        return { scrollDirection: ScrollStepDescriptor_1.ScrollDirection.Down, scrollPercent: '80%' };
+    }
     const yScrollDistance = Math.abs(coordinates.to.yPercent - coordinates.from.yPercent);
     const xScrollDistance = Math.abs(coordinates.to.xPercent - coordinates.from.xPercent);
     if (yScrollDistance > xScrollDistance) {
         const scrollDistanceFormatted = formatPercentageVal(yScrollDistance);
-        const scrollUp = coordinates.from.yPercent < coordinates.to.yPercent;
-        return `Scroll ${scrollUp ? 'up' : 'down'} ${scrollDistanceFormatted} of the screen`;
+        const isScrollUp = coordinates.from.yPercent < coordinates.to.yPercent;
+        const scrollDirection = isScrollUp
+            ? ScrollStepDescriptor_1.ScrollDirection.Up
+            : ScrollStepDescriptor_1.ScrollDirection.Down;
+        return { scrollDirection, scrollPercent: scrollDistanceFormatted };
     }
     const scrollDistanceFormatted = formatPercentageVal(xScrollDistance);
-    const swipeRight = coordinates.from.xPercent < coordinates.to.xPercent;
-    return `Swipe ${swipeRight ? 'right' : 'left'} ${scrollDistanceFormatted} of the screen`;
+    const isScrollLeft = coordinates.from.xPercent < coordinates.to.xPercent;
+    const scrollDirection = isScrollLeft
+        ? ScrollStepDescriptor_1.ScrollDirection.Left
+        : ScrollStepDescriptor_1.ScrollDirection.Right;
+    return { scrollDirection, scrollPercent: scrollDistanceFormatted };
 }
-exports.humanizeScrollInformation = humanizeScrollInformation;
+exports.getScrollDirectionAndPercentageFromCoordinates = getScrollDirectionAndPercentageFromCoordinates;

package/mablscript/mobile/steps/UninstallAppStep.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UninstallAppStep = void 0;
+const MablStepV2_1 = require("../../MablStepV2");
+class UninstallAppStep extends MablStepV2_1.MablStepV2 {
+    constructor(descriptor) {
+        super(UninstallAppStep.stepName, descriptor, 'uninstallApp');
+    }
+    stepDescription() {
+        if (this.descriptor.appId) {
+            return `Uninstall app - ${this.descriptor.appId}`;
+        }
+        return `Uninstall primary app under test`;
+    }
+    static fromYaml(_stepName, stepDescriptor) {
+        return new UninstallAppStep(stepDescriptor);
+    }
+}
+exports.UninstallAppStep = UninstallAppStep;
+UninstallAppStep.stepName = 'UninstallApp';
+UninstallAppStep.yamlMablScriptNames = [UninstallAppStep.stepName];
+UninstallAppStep.stepVersion = 2;

package/mablscript/mobile/tests/TestMobileFindDescriptors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AndroidTestLabWebViewClickCounterMobileFindDescriptor = exports.iOSTestLabWebViewClickCounterMobileFindDescriptor = exports.AndroidWebViewTextFieldMobileFindDescriptor = exports.iOSWebViewTextFieldMobileFindDescriptor = void 0;
+exports.iOSTwoHorizontalScrollGrid2MobileFindDescriptor = exports.iOSVerticalGridCar75MobileFindDescriptor = exports.iOSVerticalGridContainerMobileFindDescriptor = exports.AndroidTestLabWebViewClickCounterMobileFindDescriptor = exports.iOSTestLabWebViewClickCounterMobileFindDescriptor = exports.AndroidWebViewTextFieldMobileFindDescriptor = exports.iOSWebViewTextFieldMobileFindDescriptor = void 0;
 const domUtil_1 = require("../../../domUtil");
 exports.iOSWebViewTextFieldMobileFindDescriptor = {
     findType: domUtil_1.FindType.FIND_ONE,
@@ -213,3 +213,74 @@ exports.AndroidTestLabWebViewClickCounterMobileFindDescriptor = {
         url: 'https://storage.googleapis.com/public-dev-test-lab/click/click-counter.html',
     },
 };
+exports.iOSVerticalGridContainerMobileFindDescriptor = {
+    findTarget: {
+        selector: {
+            iOS: {
+                type: 'XCUIElementTypeOther',
+                enabled: true,
+                accessible: false,
+                rect: {
+                    x: 0,
+                    y: 143,
+                    width: 390,
+                    height: 5142,
+                },
+                index: 0,
+                xpath: '//XCUIElementTypeApplication/XCUIElementTypeWindow/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeScrollView/XCUIElementTypeOther',
+                alternateXPaths: [],
+            },
+            uuid: '',
+        },
+    },
+    findType: domUtil_1.FindType.FIND_ONE,
+};
+exports.iOSVerticalGridCar75MobileFindDescriptor = {
+    findTarget: {
+        selector: {
+            iOS: {
+                rect: {
+                    width: 51,
+                    x: 219,
+                    y: 657,
+                    height: 21,
+                },
+                xpath: '//XCUIElementTypeApplication/XCUIElementTypeWindow/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeScrollView/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeButton[55]/XCUIElementTypeStaticText',
+                name: 'Car 75',
+                index: 1,
+                alternateXPaths: [
+                    '//XCUIElementTypeStaticText[@name="Car 75"]',
+                    '//XCUIElementTypeButton[@name="Car 75"]/XCUIElementTypeStaticText',
+                ],
+                label: 'Car 75',
+                type: 'XCUIElementTypeStaticText',
+                enabled: true,
+            },
+            uuid: '',
+        },
+    },
+    findType: domUtil_1.FindType.FIND_ONE,
+};
+exports.iOSTwoHorizontalScrollGrid2MobileFindDescriptor = {
+    findTarget: {
+        selector: {
+            uuid: 'd0efcf61-de79-49d2-91e3-dd318185576b',
+            iOS: {
+                type: 'XCUIElementTypeOther',
+                name: 'grid-2',
+                enabled: true,
+                accessible: false,
+                rect: {
+                    x: 0,
+                    y: 517,
+                    width: 1125,
+                    height: 301,
+                },
+                index: 0,
+                xpath: '//XCUIElementTypeApplication/XCUIElementTypeWindow/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeScrollView[2]/XCUIElementTypeOther/XCUIElementTypeOther',
+                alternateXPaths: ['//XCUIElementTypeOther[@name="grid-2"]'],
+            },
+        },
+    },
+    findType: domUtil_1.FindType.FIND_ONE,
+};

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

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const InstallAppStep_1 = require("../../steps/InstallAppStep");
+const StepTestsUtil_1 = require("../StepTestsUtil");
+describe('Install App steps parse correctly', () => {
+    it('Parses an InstallApp step', () => {
+        const stepDescriptor = {
+            id: 'hereYouGo',
+            actionCode: 'installApp',
+        };
+        const steps = [
+            {
+                InstallApp: stepDescriptor,
+            },
+        ];
+        (0, StepTestsUtil_1.parseAndValidateYamlConversion)(steps, InstallAppStep_1.InstallAppStep.stepName, stepDescriptor);
+        const tapStep = new InstallAppStep_1.InstallAppStep(stepDescriptor);
+        expect(tapStep.stepId()).toEqual(stepDescriptor.id);
+    });
+});