Merge pull request #452 from GuillaumeGomez/property

Add `property` command

goml-script.md

@@ -134,6 +134,7 @@ Here's the command list:
  * [`pause-on-error`](#pause-on-error)
  * [`permissions`](#permissions)
  * [`press-key`](#press-key)
+ * [`property`](#property)
  * [`reload`](#reload)
  * [`screenshot`](#screenshot)
  * [`screenshot-comparison`](#screenshot-comparison)
@@ -1279,6 +1280,24 @@ press-key: 27 // Same but with an integer
 press-key: ('Escape', 1000) // The keyup event will be send after 1000 ms.
 ```
 
+#### property
+
+**property** command allows to update an element's property. Example:
+
+```
+property: ("details", "open", "false")
+// Same but with a XPath:
+property: ("//details", "attribute-name", "attribute-value")
+```
+
+To set multiple properties at a time, you can use a JSON object:
+
+```
+property: ("details", {"open": "false", "another": "x"})
+// Same but with a XPath:
+property: ("//details", {"open": "false", "another": "x"})
+```
+
 #### reload
 
 **reload** command reloads the current page. Example:

src/commands.js

@@ -64,6 +64,7 @@ const ORDERS = {
     'pause-on-error': commands.parsePauseOnError,
     'permissions': commands.parsePermissions,
     'press-key': commands.parsePressKey,
+    'property': commands.parseProperty,
     'reload': commands.parseReload,
     'screenshot': commands.parseScreenshot,
     'screenshot-comparison': commands.parseScreenshotComparison,

src/commands/all.js

@@ -73,6 +73,7 @@ module.exports = {
     'parsePauseOnError': context_setters.parsePauseOnError,
     'parsePermissions': emulation.parsePermissions,
     'parsePressKey': input.parsePressKey,
+    'parseProperty': dom_modifiers.parseProperty,
     'parseReload': navigation.parseReload,
     'parseScreenshot': general.parseScreenshot,
     'parseScreenshotComparison': context_setters.parseScreenshotComparison,

src/commands/dom_modifiers.js

@@ -100,6 +100,17 @@ function parseAttribute(parser) {
         (key, value) => `e.setAttribute("${key}","${value}");`);
 }
 
+// Possible inputs:
+//
+// * ("CSS selector", "property name", "property value")
+// * ("XPath", "attribute name", "property value")
+// * ("CSS selector", JSON dict)
+// * ("XPath", JSON dict)
+function parseProperty(parser) {
+    return innerParseCssAttribute(parser, 'property', 'parsePropertyElem',
+        (key, value) => `e["${key}"] = "${value}";`);
+}
+
 // Possible inputs:
 //
 // * ("CSS selector", "CSS property name", "CSS property value")
@@ -153,5 +164,6 @@ function parseText(parser) {
 module.exports = {
     'parseAttribute': parseAttribute,
     'parseCss': parseCss,
+    'parseProperty': parseProperty,
     'parseText': parseText,
 };

tests/test-js/api-output/parseProperty/basic-1.toml

@@ -0,0 +1,7 @@
+instructions = [
+  """let parsePropertyElem = await page.$(\"a\");
+if (parsePropertyElem === null) { throw '\"a\" not found'; }
+await page.evaluate(e => {
+e[\"b\"] = \"c\";
+}, parsePropertyElem);""",
+]

tests/test-js/api-output/parseProperty/basic-2.toml

@@ -0,0 +1,7 @@
+instructions = [
+  """let parsePropertyElem = await page.$(\"a\");
+if (parsePropertyElem === null) { throw '\"a\" not found'; }
+await page.evaluate(e => {
+e[\"\\\"b\"] = \"c\";
+}, parsePropertyElem);""",
+]

tests/test-js/api-output/parseProperty/basic-3.toml

@@ -0,0 +1,7 @@
+instructions = [
+  """let parsePropertyElemJson = await page.$(\"a\");
+if (parsePropertyElemJson === null) { throw '\"a\" not found'; }
+await page.evaluate(e => {
+e[\"b\"] = \"c\";
+}, parsePropertyElemJson);""",
+]

tests/test-js/api-output/parseProperty/basic-4.toml

@@ -0,0 +1,10 @@
+instructions = [
+  """let parsePropertyElemJson = await page.$(\"a\");
+if (parsePropertyElemJson === null) { throw '\"a\" not found'; }
+await page.evaluate(e => {
+e[\"b\"] = \"c\";
+}, parsePropertyElemJson);
+await page.evaluate(e => {
+e[\"d\"] = \"e\";
+}, parsePropertyElemJson);""",
+]

tests/test-js/api-output/parseProperty/err-1.toml

@@ -0,0 +1 @@
+error = """expected `\"` at the end of the string"""

tests/test-js/api-output/parseProperty/err-10.toml

@@ -0,0 +1,6 @@
+instructions = [
+]
+wait = false
+warnings = [
+  """Ignoring recursive entry with key `\"a\"`""",
+]

tests/test-js/api-output/parseProperty/err-2.toml

@@ -0,0 +1 @@
+error = """expected `)` or `,` after `\"b\"`"""

tests/test-js/api-output/parseProperty/err-3.toml

@@ -0,0 +1 @@
+error = """expected `(\"CSS selector\" or \"XPath\", \"property name\", \"property value\")` or `(\"CSS selector\" or \"XPath\", [JSON object])`"""

tests/test-js/api-output/parseProperty/err-4.toml

@@ -0,0 +1 @@
+error = """expected `(\"CSS selector\" or \"XPath\", \"property name\", \"property value\")` or `(\"CSS selector\" or \"XPath\", [JSON object])`"""

tests/test-js/api-output/parseProperty/err-5.toml

@@ -0,0 +1 @@
+error = """expected json as second argument (since there are only two arguments), found a string"""

tests/test-js/api-output/parseProperty/err-6.toml

@@ -0,0 +1 @@
+error = """expected `(\"CSS selector\" or \"XPath\", \"property name\", \"property value\")` or `(\"CSS selector\" or \"XPath\", [JSON object])`"""

tests/test-js/api-output/parseProperty/err-7.toml

@@ -0,0 +1 @@
+error = """expected `,` or `)`, found `\"` after `\"b\"`"""

tests/test-js/api-output/parseProperty/err-8.toml

@@ -0,0 +1 @@
+error = """expected json as second argument (since there are only two arguments), found a string"""

tests/test-js/api-output/parseProperty/err-9.toml

@@ -0,0 +1 @@
+error = """expected `(\"CSS selector\" or \"XPath\", \"property name\", \"property value\")` or `(\"CSS selector\" or \"XPath\", [JSON object])`"""

tests/test-js/api-output/parseProperty/multiline-1.toml

@@ -0,0 +1 @@
+error = """expected json as second argument (since there are only two arguments), found a string"""

tests/test-js/api-output/parseProperty/multiline-2.toml

@@ -0,0 +1,8 @@
+instructions = [
+  """let parsePropertyElemJson = await page.$x(\"//a\");
+if (parsePropertyElemJson.length === 0) { throw 'XPath \"//a\" not found'; }
+parsePropertyElemJson = parsePropertyElemJson[0];
+await page.evaluate(e => {
+e[\"b\"] = \"c\";
+}, parsePropertyElemJson);""",
+]

tests/test-js/api-output/parseProperty/multiline-3.toml

@@ -0,0 +1,8 @@
+instructions = [
+  """let parsePropertyElemJson = await page.$x(\"//a\");
+if (parsePropertyElemJson.length === 0) { throw 'XPath \"//a\" not found'; }
+parsePropertyElemJson = parsePropertyElemJson[0];
+await page.evaluate(e => {
+e[\"b\"] = \"c\\n\";
+}, parsePropertyElemJson);""",
+]

tests/test-js/api-output/parseProperty/xpath-1.toml

@@ -0,0 +1 @@
+error = """XPath must start with `//`"""

tests/test-js/api-output/parseProperty/xpath-2.toml

@@ -0,0 +1,8 @@
+instructions = [
+  """let parsePropertyElem = await page.$x(\"//a\");
+if (parsePropertyElem.length === 0) { throw 'XPath \"//a\" not found'; }
+parsePropertyElem = parsePropertyElem[0];
+await page.evaluate(e => {
+e[\"b\"] = \"c\";
+}, parsePropertyElem);""",
+]

tests/test-js/api-output/parseProperty/xpath-3.toml

@@ -0,0 +1,8 @@
+instructions = [
+  """let parsePropertyElemJson = await page.$x(\"//a\");
+if (parsePropertyElemJson.length === 0) { throw 'XPath \"//a\" not found'; }
+parsePropertyElemJson = parsePropertyElemJson[0];
+await page.evaluate(e => {
+e[\"b\"] = \"c\";
+}, parsePropertyElemJson);""",
+]

tests/test-js/api.js

@@ -440,7 +440,7 @@ function checkAssertText(x, func) {
     func('("//a"\n, \n"b",\n ALL)', 'multiline-2');
 }
 
-function checkAttribute(x, func) {
+function checkAttributeProperty(x, func) {
     func('"', 'err-1');
     func('("a", "b"', 'err-2');
     func('("a")', 'err-3');
@@ -1970,7 +1970,7 @@ const TO_CHECK = [
     },
     {
         'name': 'attribute',
-        'func': checkAttribute,
+        'func': checkAttributeProperty,
         'toCall': (x, e, name, o) => wrapper(parserFuncs.parseAttribute, x, e, name, o),
     },
     {
@@ -2178,6 +2178,11 @@ const TO_CHECK = [
         'func': checkPressKey,
         'toCall': (x, e, name, o) => wrapper(parserFuncs.parsePressKey, x, e, name, o),
     },
+    {
+        'name': 'property',
+        'func': checkAttributeProperty,
+        'toCall': (x, e, name, o) => wrapper(parserFuncs.parseProperty, x, e, name, o),
+    },
     {
         'name': 'reload',
         'func': checkReload,

tests/ui-tests/property.goml

@@ -9,3 +9,7 @@ assert-window-property: {"size": "a"}
 assert-document-property-false: {"size": "a"}
 document-property: {"size": "a"}
 assert-document-property: {"size": "a"}
+
+assert-property-false: ("header", {"yolo": "a"})
+property: ("header", {"yolo": "a"})
+assert-property: ("header", {"yolo": "a"})