Merge pull request #629 from GuillaumeGomez/within-iframe

Add `within-iframe` command

Author: GuillaumeGomez

Dockerfile

@@ -32,7 +32,6 @@ COPY ./package*.json ./
 
 RUN npm install
 
-# never use the "--no-sandbox" outside of a container!
-ENTRYPOINT ["node", "./browser-ui-test-src/index.js", "--no-sandbox"]
+ENTRYPOINT ["node", "./browser-ui-test-src/index.js"]
 # to be able to pass arguments to index.js
 CMD []

goml-script.md

@@ -246,6 +246,7 @@ Here's the command list:
  * [`wait-for-size-false`](#wait-for-size-false)
  * [`wait-for-window-property`](#wait-for-window-property)
  * [`wait-for-window-property-false`](#wait-for-window-property-false)
+ * [`within-iframe`](#within-iframe)
  * [`write`](#write)
  * [`write-into`](#write-into)
 
@@ -2400,6 +2401,17 @@ wait-for-window-property-false: ({"key": "value", "key2": "value2"}, [ENDS_WITH,
 
 If you want to wait for all properties to have the expected value, take a look at [`wait-for-window-property`](#wait-for-window-property).
 
+#### within-iframe
+
+**within-iframe** commands moves the context inside the provided `<iframe>` selector. Inside it, all selectors are relative to the `iframe`, same if you use `go-to`. Examples:
+
+```
+within-iframe: ("#iframe", block {
+    // We try to click on an element inside the `#iframe` element.
+    click: "#element"
+})
+```
+
 #### write
 
 **write** command sends keyboard inputs on the currently focused element. Examples:

package.json

@@ -15,7 +15,7 @@
         "browser-ui-test": "src/index.js"
     },
     "scripts": {
-        "test": "node src/index.js --test-folder tests/full-check/ --failure-folder failures --variable DOC_PATH tests/html_files --no-sandbox",
+        "test": "node src/index.js --test-folder tests/full-check/ --failure-folder failures --variable DOC_PATH tests/html_files",
         "all-test": "node tools/all.js",
         "api-test": "node tools/api.js",
         "ui-test": "node tools/ui.js",

src/commands.js

@@ -2,7 +2,6 @@ const { AstLoader } = require('./ast.js');
 const process = require('process');
 const commands = require('./commands/all.js');
 const consts = require('./consts.js');
-const path = require('path');
 const { stripCommonPathsPrefix } = require('./utils.js');
 
 const ORDERS = {
@@ -117,6 +116,7 @@ const ORDERS = {
     'wait-for-text-false': commands.parseWaitForTextFalse,
     'wait-for-window-property': commands.parseWaitForWindowProperty,
     'wait-for-window-property-false': commands.parseWaitForWindowPropertyFalse,
+    'within-iframe': commands.parseWithinIFrame,
     'write': commands.parseWrite,
     'write-into': commands.parseWriteInto,
 };
@@ -164,6 +164,7 @@ const FATAL_ERROR_COMMANDS = [
     'wait-for-property-false',
     'wait-for-text',
     'wait-for-text-false',
+    'within-iframe',
     'write',
     'write-into',
 ];
@@ -262,64 +263,6 @@ class ParserWithContext {
         }
     }
 
-    setup_user_function_call(ast) {
-        const ret = commands.parseCallFunction(this);
-        if (ret.error !== undefined) {
-            ret.line = this.get_current_command_line();
-            if (ast.length !== 0) {
-                ret.error += ` (from command \`${ast[0].getErrorText()}\`)`;
-            }
-            return ret;
-        }
-        const args = Object.create(null);
-        const func = this.definedFunctions[ret['function']];
-        for (const arg_name of func['arguments']) {
-            const index = ret['args'].findIndex(arg => arg.key.value === arg_name);
-            if (index === -1) {
-                return {
-                    'error': `Missing argument "${arg_name}"`,
-                    'line': this.get_current_command_line(),
-                    'fatal_error': true,
-                };
-            }
-            args[arg_name] = ret['args'][index].value;
-        }
-        const context = this.get_current_context();
-        this.pushNewContext({
-            'ast': context.ast,
-            'commands': func.commands,
-            'currentCommand': 0,
-            'functionArgs': Object.assign({}, context.functionArgs, args),
-            'filePath': func.filePath,
-        });
-        // We disable the `increasePos` in the context to prevent it to be done twice.
-        return this.get_next_command(false);
-    }
-
-    setup_include() {
-        const ret = commands.parseInclude(this);
-        if (ret.error !== undefined) {
-            ret.line = this.get_current_command_line();
-            if (ast.length !== 0) {
-                ret.error += ` (from command \`${ast[0].getErrorText()}\`)`;
-            }
-            return ret;
-        }
-        const dirPath = path.dirname(this.get_current_context().ast.absolutePath);
-        const ast = new AstLoader(ret.path, dirPath);
-        if (ast.hasErrors()) {
-            return {'errors': ast.errors};
-        }
-        this.pushNewContext({
-            'ast': ast,
-            'commands': ast.commands,
-            'currentCommand': 0,
-            'functionArgs': Object.create(null),
-        });
-        // We disable the `increasePos` in the context to prevent it to be done twice.
-        return this.get_next_command(false);
-    }
-
     getCurrentFile() {
         const context = this.get_current_context();
         if (context === null) {
@@ -330,19 +273,12 @@ class ParserWithContext {
         return context.ast.absolutePath;
     }
 
-    run_order(order, ast) {
+    run_order(pages, order, ast) {
         // This is needed because for now, all commands get access to the ast
         // through `ParserWithContext`.
         this.elems = ast;
 
-        if (order === 'call-function') {
-            // We need to special-case `call-function` since it needs to access variables of this
-            // class.
-            return this.setup_user_function_call(ast);
-        } else if (order === 'include') {
-            // We need to special-case `include` since it needs to parse a new file when called.
-            return this.setup_include();
-        } else if (!Object.prototype.hasOwnProperty.call(ORDERS, order)) {
+        if (!Object.prototype.hasOwnProperty.call(ORDERS, order)) {
             return {'error': `Unknown command "${order}"`, 'line': this.get_current_command_line()};
         }
         if (this.firstGotoParsed === false) {
@@ -367,10 +303,15 @@ class ParserWithContext {
         if (res.error !== undefined) {
             res.line = this.get_current_command_line();
             if (this.elems.length !== 0) {
-                res.error += ` (from command \`${this.elems[0].getErrorText()}\`)`;
+                res.error += ` (from command \`${order}: ${this.elems[0].getErrorText()}\`)`;
             }
             return res;
         }
+        if (res.skipInstructions) {
+            // We disable the `increasePos` in the context to prevent it to be done twice.
+            return this.get_next_command(pages, false);
+        }
+
         return {
             'fatal_error': FATAL_ERROR_COMMANDS.indexOf(order) !== -1,
             'wait': res['wait'],
@@ -380,13 +321,18 @@ class ParserWithContext {
             'instructions': res['instructions'],
             'infos': res['infos'],
             'warnings': res['warnings'],
+            'callback': res['callback'],
+            'noPosIncrease': res['noPosIncrease'],
         };
     }
 
-    get_next_command(increasePos = true) {
+    get_next_command(pages, increasePos = true) {
         let context = this.get_current_context();
         while (context !== null && context.currentCommand >= context.commands.length) {
-            this.contexts.pop();
+            const prevContext = this.contexts.pop();
+            if (prevContext.dropCallback !== undefined) {
+                prevContext.dropCallback(pages);
+            }
             context = this.get_current_context();
             if (context !== null) {
                 context.currentCommand += 1;
@@ -404,8 +350,8 @@ class ParserWithContext {
                 'errors': inferred.errors,
             };
         }
-        const ret = this.run_order(command.commandName, inferred.ast);
-        if (increasePos) {
+        const ret = this.run_order(pages, command.commandName, inferred.ast);
+        if (increasePos && !ret['noPosIncrease']) {
             this.increase_context_pos();
         }
         return ret;

src/commands/all.js

@@ -125,6 +125,7 @@ module.exports = {
     'parseWaitForTextFalse': wait.parseWaitForTextFalse,
     'parseWaitForWindowProperty': wait.parseWaitForWindowProperty,
     'parseWaitForWindowPropertyFalse': wait.parseWaitForWindowPropertyFalse,
+    'parseWithinIFrame': context_setters.parseWithinIFrame,
     'parseWrite': input.parseWrite,
     'parseWriteInto': input.parseWriteInto,
 };

src/commands/context_setters.js

@@ -3,6 +3,7 @@
 const consts = require('../consts.js');
 const { validator } = require('../validator.js');
 const { hasError } = require('../utils.js');
+const { getAndSetElements } = require('./utils.js');
 
 // Possible inputs:
 //
@@ -162,7 +163,7 @@ function parseSetTimeout(parser) {
     }
     return {
         'instructions': [
-            `page.setDefaultTimeout(${ret.value.value})`,
+            `pages[0].setDefaultTimeout(${ret.value.value})`,
         ],
         'wait': false,
         'warnings': warnings.length > 0 ? warnings : undefined,
@@ -213,6 +214,67 @@ if (oldValue !== true) {
     };
 }
 
+// Possible inputs:
+//
+// * (selector, block)
+function parseWithinIFrame(parser) {
+    const ret = validator(parser,
+        {
+            kind: 'tuple',
+            elements: [
+                {
+                    kind: 'selector',
+                },
+                {
+                    kind: 'block',
+                },
+            ],
+        },
+    );
+    if (hasError(ret)) {
+        return ret;
+    }
+    const tuple = ret.value.entries;
+    const selector = tuple[0].value;
+    const isPseudo = !selector.isXPath && selector.pseudo !== null;
+
+    if (isPseudo) {
+        return {
+            'error': 'Pseudo elements cannot be <iframe>',
+        };
+    }
+
+    const code = `\
+${getAndSetElements(selector, 'iframe', false)}
+await iframe.evaluate(el => {
+    if (el.tagName !== "IFRAME") {
+        throw "selector \`${selector.value}\` is not an \`<iframe>\` but a \`<" + \
+el.tagName.toLowerCase() + ">\`";
+    }
+});
+pages.push(iframe);`;
+
+    return {
+        'instructions': [code],
+        'callback': () => {
+            const context = parser.get_current_context();
+            parser.pushNewContext({
+                'ast': context.ast,
+                'commands': tuple[1].value.value,
+                'currentCommand': 0,
+                'functionArgs': Object.create(null),
+                'dropCallback': pages => {
+                    if (pages.length < 2) {
+                        throw new Error('`pages` is empty whereas it should never happen!');
+                    }
+                    pages.pop();
+                },
+            });
+        },
+        'noPosIncrease': true,
+    };
+}
+
 module.exports = {
     'parseDebug': parseDebug,
     'parseExpectFailure': parseExpectFailure,
@@ -223,4 +285,5 @@ module.exports = {
     'parseScreenshotOnFailure': parseScreenshotOnFailure,
     'parseShowText': parseShowText,
     'parseSetTimeout': parseSetTimeout,
+    'parseWithinIFrame': parseWithinIFrame,
 };

src/commands/emulation.js

@@ -34,13 +34,13 @@ function parseSetWindowSize(parser) {
     return {
         'instructions': [
             `\
-const viewport = page.viewport();
+const viewport = pages[0].viewport();
 const newViewport = {
     ...viewport,
     width: ${width},
     height: ${height},
 };
-await page.setViewport(newViewport);`,
+await pages[0].setViewport(newViewport);`,
         ],
     };
 }
@@ -64,12 +64,12 @@ function parseSetDevicePixelRatio(parser) {
     return {
         'instructions': [
             `\
-const viewport = page.viewport();
+const viewport = pages[0].viewport();
 const newViewport = {
     ...viewport,
     deviceScaleFactor: ${ret.value.getRaw()},
 };
-await page.setViewport(newViewport);`,
+await pages[0].setViewport(newViewport);`,
         ],
     };
 }
@@ -97,7 +97,7 @@ if (arg.puppeteer.KnownDevices["${device}"] === undefined) {
 https://github.com/GoogleChrome/puppeteer/blob/master/lib/DeviceDescriptors.js or \
 you can use \`--show-devices\` option';
 } else {
-    await page.emulate(arg.puppeteer.KnownDevices["${device}"]);
+    await pages[0].emulate(arg.puppeteer.KnownDevices["${device}"]);
 }`,
         ],
     };
@@ -128,7 +128,7 @@ function parseGeolocation(parser) {
     const tuple = ret.value.entries;
     return {
         'instructions': [
-            `await page.setGeolocation(${tuple[0].value.getRaw()}, ${tuple[1].value.getRaw()});`,
+            `await pages[0].setGeolocation(${tuple[0].value.getRaw()},${tuple[1].value.getRaw()});`,
         ],
     };
 }
@@ -178,7 +178,7 @@ function parseJavascript(parser) {
 
     return {
         'instructions': [
-            `await page.setJavaScriptEnabled(${ret.value.getRaw()});`,
+            `await pages[0].setJavaScriptEnabled(${ret.value.getRaw()});`,
         ],
     };
 }
@@ -200,7 +200,7 @@ function parseSetFontSize(parser) {
 
     return {
         'instructions': [`\
-const client = await page.target().createCDPSession();
+const client = await pages[0].target().createCDPSession();
 await client.send("Page.enable");
 await client.send("Page.setFontSizes", {
     fontSizes: {