adding var handling and env escape hatch

toddtarsi · toddtarsi · commit c809d49f4604 · 2023-08-12T14:28:49.000-05:00
diff --git a/packages/side-api/package.json b/packages/side-api/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@seleniumhq/side-api",
-  "version": "4.0.0-alpha.27",
+  "version": "4.0.0-alpha.28",
   "private": false,
   "description": "Selenium IDE API command shapes and such",
   "author": "Todd Tarsi <tarsitodd@gmail.com>",
@@ -20,7 +20,7 @@
     "@seleniumhq/browser-info": "^4.0.0-alpha.1",
     "@seleniumhq/get-driver": "^4.0.0-alpha.2",
     "@seleniumhq/side-model": "^4.0.0-alpha.4",
-    "@seleniumhq/side-runtime": "^4.0.0-alpha.27",
+    "@seleniumhq/side-runtime": "^4.0.0-alpha.28",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
diff --git a/packages/side-example-suite/package.json b/packages/side-example-suite/package.json
@@ -21,8 +21,7 @@
     "@seleniumhq/code-export-python-pytest": "4.0.0-alpha.2"
   },
   "devDependencies": {
-    "@seleniumhq/side-api": "^4.0.0-alpha.26",
-    "@seleniumhq/side-runtime": "^4.0.0-alpha.26"
+    "@seleniumhq/side-api": "^4.0.0-alpha.28"
   },
   "repository": {
     "type": "git",
diff --git a/packages/side-example-suite/tsconfig.json b/packages/side-example-suite/tsconfig.json
@@ -17,9 +17,6 @@
       {
         "path": "../side-api"
       },
-      {
-        "path": "../side-runtime"
-      }
     ]
   }
   
diff --git a/packages/side-runner/package.json b/packages/side-runner/package.json
@@ -1,6 +1,6 @@
 {
   "name": "selenium-side-runner",
-  "version": "4.0.0-alpha.56",
+  "version": "4.0.0-alpha.57",
   "private": false,
   "description": "Run Selenium IDE projects in cli",
   "repository": "https://github.com/SeleniumHQ/selenium-ide",
@@ -24,7 +24,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@seleniumhq/side-model": "^4.0.0-alpha.4",
-    "@seleniumhq/side-runtime": "^4.0.0-alpha.27",
+    "@seleniumhq/side-runtime": "^4.0.0-alpha.28",
     "commander": "^11.0.0",
     "glob": "^10.3.1",
     "jest": "^29.6.0",
diff --git a/packages/side-runtime/package.json b/packages/side-runtime/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@seleniumhq/side-runtime",
-  "version": "4.0.0-alpha.27",
+  "version": "4.0.0-alpha.28",
   "private": false,
   "description": "Selenium IDE playback and execution",
   "author": "Tomer <tomer@corevo.io>",
diff --git a/packages/side-runtime/src/playback-tree/command-node.ts b/packages/side-runtime/src/playback-tree/command-node.ts
@@ -18,7 +18,7 @@
 import { Fn } from '@seleniumhq/side-commons'
 import { CommandShape } from '@seleniumhq/side-model'
 import { WebDriverExecutor } from '..'
-import { interpolateScript } from '../preprocessors'
+import { interpolateScript, interpolateString } from '../preprocessors'
 import { CommandNodeOptions } from '../types'
 import Variables from '../variables'
 import { WebDriverExecutorCondEvalResult } from '../webdriver'
@@ -224,17 +224,20 @@ export class CommandNode {
   }
 
   _evaluate(commandExecutor: WebDriverExecutor) {
-    let expression = interpolateScript(
-      this.command.target as string,
-      commandExecutor.variables
-    )
     if (ControlFlowCommandChecks.isTimes(this.command)) {
-      const number = Math.floor(+expression)
+      const number = Math.floor(
+        +interpolateString(`${this.command.target}`, commandExecutor.variables)
+      )
       if (isNaN(number)) {
         return Promise.reject(new Error('Invalid number provided as a target.'))
       }
       return this._evaluationResult({ value: this.timesVisited < number })
-    } else if (ControlFlowCommandChecks.isForEach(this.command)) {
+    }
+    let expression = interpolateScript(
+      this.command.target as string,
+      commandExecutor.variables
+    )
+    if (ControlFlowCommandChecks.isForEach(this.command)) {
       const result = this.evaluateForEach(commandExecutor.variables)
       if (!result) {
         this.emitControlFlowChange({
diff --git a/packages/side-runtime/src/variables.ts b/packages/side-runtime/src/variables.ts
@@ -22,6 +22,9 @@ export default class Variables {
   storedVars: Map<string, any>
 
   get(key: string) {
+    if (key.startsWith('env:')) {
+      return process.env[key.slice(4)]
+    }
     return this.storedVars.get(key)
   }
 
diff --git a/packages/side-runtime/src/webdriver.ts b/packages/side-runtime/src/webdriver.ts
@@ -1624,6 +1624,13 @@ WebDriverExecutor.prototype.doAssertPrompt = composePreprocessors(
   WebDriverExecutor.prototype.doAssertPrompt
 )
 
+WebDriverExecutor.prototype.doAssertSelectedLabel = composePreprocessors(
+  interpolateString,
+  interpolateString,
+  { targetFallback: preprocessArray(interpolateString) },
+  WebDriverExecutor.prototype.doAssertSelectedLabel
+)
+
 WebDriverExecutor.prototype.doAssertText = composePreprocessors(
   interpolateString,
   interpolateString,
diff --git a/tests/examples/variable-in-conditional.side b/tests/examples/variable-in-conditional.side
@@ -14,6 +14,7 @@
       "parallel": false,
       "persistSession": false,
       "tests": [
+        "a1f2325b-f579-445f-97a2-a24d45816e04",
         "2e05c87f-fd47-43e1-bd89-7197f52e3cda"
       ],
       "timeout": 30000
@@ -24,12 +25,6 @@
       "id": "2e05c87f-fd47-43e1-bd89-7197f52e3cda",
       "name": "If variable",
       "commands": [
-        {
-          "id": "73e3061e-5904-4ee7-9923-a0bb014349dd",
-          "command": "open",
-          "target": "/",
-          "value": ""
-        },
         {
           "command": "store",
           "target": "1",
@@ -38,16 +33,15 @@
         },
         {
           "command": "if",
-          "target": "${asdf} == 1",
+          "target": "${asdf} !== \"1\"",
           "value": "",
           "id": "67c95cc0-68ce-4019-a2eb-8f32fd6c722c"
         },
         {
-          "command": "click",
-          "target": "css=#gbqfbb",
-          "value": "",
-          "id": "6541336a-a114-42da-9443-53e1ad0027a4",
-          "isBreakpoint": false
+          "command": "assert",
+          "target": "asdf",
+          "value": "If clause succeeded without merit",
+          "id": "4cbdebb0-f650-4919-a489-1946359d976c"
         },
         {
           "command": "end",
@@ -56,6 +50,30 @@
           "id": "52a7461f-a944-471b-bfbc-66cecfa001a8"
         }
       ]
+    },
+    {
+      "id": "a1f2325b-f579-445f-97a2-a24d45816e04",
+      "name": "Times variable",
+      "commands": [
+        {
+          "command": "store",
+          "target": "1",
+          "value": "ONE",
+          "id": "8d34b903-0b7b-4d1e-b363-ca19bed870ce"
+        },
+        {
+          "id": "ca848518-2f34-4c92-b57c-4ce37c11e1cf",
+          "command": "times",
+          "target": "${ONE}",
+          "value": "3"
+        },
+        {
+          "command": "end",
+          "target": "",
+          "value": "",
+          "id": "bc6bffd6-0fec-4272-8aaa-7633ffb7266a"
+        }
+      ]
     }
   ],
   "snapshot": {

Original file line number	Diff line number	Diff line change
`@@ -17,9 +17,6 @@`
`17`	`17`	`{`
`18`	`18`	`"path": "../side-api"`
`19`	`19`	`},`
`20`		`- {`
`21`		`- "path": "../side-runtime"`
`22`		`- }`
`23`	`20`	`]`
`24`	`21`	`}`
`25`	`22`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@seleniumhq/side-runtime",`
`3`		`- "version": "4.0.0-alpha.27",`
	`3`	`+ "version": "4.0.0-alpha.28",`
`4`	`4`	`"private": false,`
`5`	`5`	`"description": "Selenium IDE playback and execution",`
`6`	`6`	`"author": "Tomer <[email protected]>",`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,9 @@ export default class Variables {`
`22`	`22`	`storedVars: Map<string, any>`
`23`	`23`
`24`	`24`	`get(key: string) {`
	`25`	`+ if (key.startsWith('env:')) {`
	`26`	`+ return process.env[key.slice(4)]`
	`27`	`+ }`
`25`	`28`	`return this.storedVars.get(key)`
`26`	`29`	`}`
`27`	`30`