@seleniumhq/code-export-python-pytest 4.0.12 → 4.1.0-beta.1

package/dist/location.js

@@ -16,7 +16,7 @@
 // specific language governing permissions and limitations
 // under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.emit = void 0;
+exports.emit = emit;
 const side_code_export_1 = require("side-code-export");
 const emitters = {
     id: emitId,
@@ -30,7 +30,6 @@ const emitters = {
 function emit(location) {
     return side_code_export_1.codeExport.emit.location(location, emitters);
 }
-exports.emit = emit;
 exports.default = {
     emit,
 };

package/dist/location.js.map

@@ -1 +1 @@
-{"version":3,"file":"location.js","sourceRoot":"","sources":["../src/location.ts"],"names":[],"mappings":";AAAA,+DAA+D;AAC/D,+DAA+D;AAC/D,wDAAwD;AACxD,6DAA6D;AAC7D,oDAAoD;AACpD,6DAA6D;AAC7D,6DAA6D;AAC7D,EAAE;AACF,+CAA+C;AAC/C,EAAE;AACF,6DAA6D;AAC7D,8DAA8D;AAC9D,yDAAyD;AACzD,4DAA4D;AAC5D,0DAA0D;AAC1D,qBAAqB;;;AAErB,uDAAyD;AAEzD,MAAM,QAAQ,GAAG;IACf,EAAE,EAAE,MAAM;IACV,IAAI,EAAE,QAAQ;IACd,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,QAAQ;IAClB,eAAe,EAAE,mBAAmB;IACpC,GAAG,EAAE,OAAO;IACZ,KAAK,EAAE,SAAS;CACjB,CAAA;AAED,SAAgB,IAAI,CAAC,QAAgB;IACnC,OAAO,6BAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;AACnD,CAAC;AAFD,oBAEC;AAED,kBAAe;IACb,IAAI;CACL,CAAA;AAED,SAAS,MAAM,CAAC,QAAgB;IAC9B,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,QAAQ,GAAG,CAAC,CAAA;AAChD,CAAC;AAED,SAAS,QAAQ,CAAC,QAAgB;IAChC,OAAO,OAAO,CAAC,OAAO,CAAC,aAAa,QAAQ,GAAG,CAAC,CAAA;AAClD,CAAC;AAED,SAAS,QAAQ,CAAC,QAAgB;IAChC,OAAO,OAAO,CAAC,OAAO,CAAC,kBAAkB,QAAQ,GAAG,CAAC,CAAA;AACvD,CAAC;AAED,SAAS,mBAAmB,CAAC,QAAgB;IAC3C,OAAO,OAAO,CAAC,OAAO,CAAC,0BAA0B,QAAQ,GAAG,CAAC,CAAA;AAC/D,CAAC;AAED,SAAS,OAAO,CAAC,QAAgB;IAC/B,OAAO,OAAO,CAAC,OAAO,CAAC,qBAAqB,QAAQ,GAAG,CAAC,CAAA;AAC1D,CAAC;AAED,SAAS,SAAS,CAAC,QAAgB;IACjC,OAAO,OAAO,CAAC,OAAO,CAAC,cAAc,QAAQ,GAAG,CAAC,CAAA;AACnD,CAAC"}
+{"version":3,"file":"location.js","sourceRoot":"","sources":["../src/location.ts"],"names":[],"mappings":";AAAA,+DAA+D;AAC/D,+DAA+D;AAC/D,wDAAwD;AACxD,6DAA6D;AAC7D,oDAAoD;AACpD,6DAA6D;AAC7D,6DAA6D;AAC7D,EAAE;AACF,+CAA+C;AAC/C,EAAE;AACF,6DAA6D;AAC7D,8DAA8D;AAC9D,yDAAyD;AACzD,4DAA4D;AAC5D,0DAA0D;AAC1D,qBAAqB;;AAcrB,oBAEC;AAdD,uDAAyD;AAEzD,MAAM,QAAQ,GAAG;IACf,EAAE,EAAE,MAAM;IACV,IAAI,EAAE,QAAQ;IACd,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,QAAQ;IAClB,eAAe,EAAE,mBAAmB;IACpC,GAAG,EAAE,OAAO;IACZ,KAAK,EAAE,SAAS;CACjB,CAAA;AAED,SAAgB,IAAI,CAAC,QAAgB;IACnC,OAAO,6BAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;AACnD,CAAC;AAED,kBAAe;IACb,IAAI;CACL,CAAA;AAED,SAAS,MAAM,CAAC,QAAgB;IAC9B,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,QAAQ,GAAG,CAAC,CAAA;AAChD,CAAC;AAED,SAAS,QAAQ,CAAC,QAAgB;IAChC,OAAO,OAAO,CAAC,OAAO,CAAC,aAAa,QAAQ,GAAG,CAAC,CAAA;AAClD,CAAC;AAED,SAAS,QAAQ,CAAC,QAAgB;IAChC,OAAO,OAAO,CAAC,OAAO,CAAC,kBAAkB,QAAQ,GAAG,CAAC,CAAA;AACvD,CAAC;AAED,SAAS,mBAAmB,CAAC,QAAgB;IAC3C,OAAO,OAAO,CAAC,OAAO,CAAC,0BAA0B,QAAQ,GAAG,CAAC,CAAA;AAC/D,CAAC;AAED,SAAS,OAAO,CAAC,QAAgB;IAC/B,OAAO,OAAO,CAAC,OAAO,CAAC,qBAAqB,QAAQ,GAAG,CAAC,CAAA;AAC1D,CAAC;AAED,SAAS,SAAS,CAAC,QAAgB;IACjC,OAAO,OAAO,CAAC,OAAO,CAAC,cAAc,QAAQ,GAAG,CAAC,CAAA;AACnD,CAAC"}

package/dist/selection.js

@@ -16,7 +16,7 @@
 // specific language governing permissions and limitations
 // under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.emit = void 0;
+exports.emit = emit;
 const side_code_export_1 = require("side-code-export");
 const emitters = {
     id: emitId,
@@ -27,7 +27,6 @@ const emitters = {
 function emit(location) {
     return side_code_export_1.codeExport.emit.selection(location, emitters);
 }
-exports.emit = emit;
 exports.default = {
     emit,
 };
@@ -38,9 +37,6 @@ function emitValue(value) {
     return Promise.resolve(`By.CSS_SELECTOR, "*[value='${value}']"`);
 }
 function emitLabel(label) {
-    if (label.startsWith('self.vars[')) {
-        return Promise.resolve(`By.XPATH, "//option[. = '{}']".format(${label})`);
-    }
     return Promise.resolve(`By.XPATH, "//option[. = '${label}']"`);
 }
 function emitIndex(index) {

package/dist/selection.js.map

@@ -1 +1 @@
-{"version":3,"file":"selection.js","sourceRoot":"","sources":["../src/selection.ts"],"names":[],"mappings":";AAAA,+DAA+D;AAC/D,+DAA+D;AAC/D,wDAAwD;AACxD,6DAA6D;AAC7D,oDAAoD;AACpD,6DAA6D;AAC7D,6DAA6D;AAC7D,EAAE;AACF,+CAA+C;AAC/C,EAAE;AACF,6DAA6D;AAC7D,8DAA8D;AAC9D,yDAAyD;AACzD,4DAA4D;AAC5D,0DAA0D;AAC1D,qBAAqB;;;AAErB,uDAAyD;AAEzD,MAAM,QAAQ,GAAG;IACf,EAAE,EAAE,MAAM;IACV,KAAK,EAAE,SAAS;IAChB,KAAK,EAAE,SAAS;IAChB,KAAK,EAAE,SAAS;CACjB,CAAA;AAED,SAAgB,IAAI,CAAC,QAAgB;IACnC,OAAO,6BAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;AACpD,CAAC;AAFD,oBAEC;AAED,kBAAe;IACb,IAAI;CACL,CAAA;AAED,SAAS,MAAM,CAAC,EAAU;IACxB,OAAO,OAAO,CAAC,OAAO,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAA;AAC5D,CAAC;AAED,SAAS,SAAS,CAAC,KAAa;IAC9B,OAAO,OAAO,CAAC,OAAO,CAAC,8BAA8B,KAAK,KAAK,CAAC,CAAA;AAClE,CAAC;AAED,SAAS,SAAS,CAAC,KAAa;IAC9B,IAAI,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;QAClC,OAAO,OAAO,CAAC,OAAO,CAAC,yCAAyC,KAAK,GAAG,CAAC,CAAA;KAC1E;IACD,OAAO,OAAO,CAAC,OAAO,CAAC,4BAA4B,KAAK,KAAK,CAAC,CAAA;AAChE,CAAC;AAED,SAAS,SAAS,CAAC,KAAa;IAC9B,OAAO,OAAO,CAAC,OAAO,CAAC,iCAAiC,KAAK,IAAI,CAAC,CAAA;AACpE,CAAC"}
+{"version":3,"file":"selection.js","sourceRoot":"","sources":["../src/selection.ts"],"names":[],"mappings":";AAAA,+DAA+D;AAC/D,+DAA+D;AAC/D,wDAAwD;AACxD,6DAA6D;AAC7D,oDAAoD;AACpD,6DAA6D;AAC7D,6DAA6D;AAC7D,EAAE;AACF,+CAA+C;AAC/C,EAAE;AACF,6DAA6D;AAC7D,8DAA8D;AAC9D,yDAAyD;AACzD,4DAA4D;AAC5D,0DAA0D;AAC1D,qBAAqB;;AAWrB,oBAEC;AAXD,uDAAyD;AAEzD,MAAM,QAAQ,GAAG;IACf,EAAE,EAAE,MAAM;IACV,KAAK,EAAE,SAAS;IAChB,KAAK,EAAE,SAAS;IAChB,KAAK,EAAE,SAAS;CACjB,CAAA;AAED,SAAgB,IAAI,CAAC,QAAgB;IACnC,OAAO,6BAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;AACpD,CAAC;AAED,kBAAe;IACb,IAAI;CACL,CAAA;AAED,SAAS,MAAM,CAAC,EAAU;IACxB,OAAO,OAAO,CAAC,OAAO,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAA;AAC5D,CAAC;AAED,SAAS,SAAS,CAAC,KAAa;IAC9B,OAAO,OAAO,CAAC,OAAO,CAAC,8BAA8B,KAAK,KAAK,CAAC,CAAA;AAClE,CAAC;AAED,SAAS,SAAS,CAAC,KAAa;IAC9B,OAAO,OAAO,CAAC,OAAO,CAAC,4BAA4B,KAAK,KAAK,CAAC,CAAA;AAChE,CAAC;AAED,SAAS,SAAS,CAAC,KAAa;IAC9B,OAAO,OAAO,CAAC,OAAO,CAAC,iCAAiC,KAAK,IAAI,CAAC,CAAA;AACpE,CAAC"}

package/jest.config.js

@@ -0,0 +1,14 @@
+module.exports = {
+  // The snapshots were written with the format from before Jest 29
+  snapshotFormat: { escapeString: true, printBasicPrototype: true },
+  testEnvironmentOptions: {
+    url: 'http://localhost/index.html',
+  },
+  testMatch: ['**/packages/**/__test?(s)__/**/*.spec.[jt]s?(x)'],
+  testPathIgnorePatterns: ['/node_modules/', '/dist/'],
+  transform: {
+    // Find the repo's babel.config.js from the package folder
+    '^.+\\.jsx?$': ['babel-jest', { rootMode: 'upward' }],
+    '^.+\\.ts?$': 'ts-jest',
+  },
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seleniumhq/code-export-python-pytest",
-  "version": "4.0.12",
+  "version": "4.1.0-beta.1",
   "private": false,
   "description": "Export Selenium IDE project contents to Python pytest",
   "repository": "https://github.com/SeleniumHQ/selenium-ide",
@@ -12,10 +12,11 @@
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "dependencies": {
-    "side-code-export": "^4.0.11"
+    "side-code-export": "4.1.0-beta.1"
   },
   "devDependencies": {
-    "@seleniumhq/side-model": "4.0.12"
+    "@seleniumhq/side-runtime": "4.1.0-beta.1",
+    "@seleniumhq/side-model": "4.1.0-beta.1"
   },
   "gitHead": "f58e327e7616e23a3e926e4b80cf9952164e5744",
   "scripts": {

package/src/command.ts

@@ -22,6 +22,7 @@ import {
   PrebuildEmitter,
   ProcessedCommandEmitter,
   ScriptShape,
+  hasVariable,
 } from 'side-code-export'
 // eslint-disable-next-line node/no-unpublished-import
 import { CommandShape } from '@seleniumhq/side-model'
@@ -30,7 +31,6 @@ import selection from './selection'
 
 export const emitters: Record<string, ProcessedCommandEmitter> = {
   addSelection: emitSelect,
-  answerOnNextPrompt: skip,
   assert: emitAssert,
   assertAlert: emitAssertAlert,
   assertChecked: emitVerifyChecked,
@@ -49,9 +49,6 @@ export const emitters: Record<string, ProcessedCommandEmitter> = {
   assertText: emitVerifyText,
   assertTitle: emitVerifyTitle,
   check: emitCheck,
-  chooseCancelOnNextConfirmation: skip,
-  chooseCancelOnNextPrompt: skip,
-  chooseOkOnNextConfirmation: skip,
   click: emitClick,
   clickAt: emitClick,
   close: emitClose,
@@ -71,7 +68,6 @@ export const emitters: Record<string, ProcessedCommandEmitter> = {
   if: emitControlFlowIf,
   mouseDown: emitMouseDown,
   mouseDownAt: emitMouseDown,
-  mouseMove: emitMouseMove,
   mouseMoveAt: emitMouseMove,
   mouseOver: emitMouseMove,
   mouseOut: emitMouseOut,
@@ -96,8 +92,7 @@ export const emitters: Record<string, ProcessedCommandEmitter> = {
   storeTitle: emitStoreTitle,
   storeValue: emitStoreValue,
   storeWindowHandle: emitStoreWindowHandle,
-  storeXpathCount: emitStoreXpathCount,
-  submit: emitSubmit,
+  storeElementCount: emitStoreXpathCount,
   times: emitControlFlowTimes,
   type: emitType,
   uncheck: emitUncheck,
@@ -121,12 +116,12 @@ export const emitters: Record<string, ProcessedCommandEmitter> = {
   waitForElementNotEditable: emitWaitForElementNotEditable,
   waitForElementNotPresent: emitWaitForElementNotPresent,
   waitForElementNotVisible: emitWaitForElementNotVisible,
-  webdriverAnswerOnVisiblePrompt: emitAnswerOnNextPrompt,
+  answerPrompt: emitAnswerOnNextPrompt,
   waitForText: emitWaitForText,
-  webdriverChooseCancelOnVisibleConfirmation:
-    emitChooseCancelOnNextConfirmation,
-  webdriverChooseCancelOnVisiblePrompt: emitChooseCancelOnNextConfirmation,
-  webdriverChooseOkOnVisibleConfirmation: emitChooseOkOnNextConfirmation,
+  dismissConfirmation: emitChooseCancelOnNextConfirmation,
+  dismissPrompt: emitChooseCancelOnNextConfirmation,
+  acceptConfirmation: emitChooseOkOnNextConfirmation,
+  acceptAlert: emitChooseOkOnNextConfirmation,
   while: emitControlFlowWhile,
 }
 
@@ -140,10 +135,17 @@ function emit(command: CommandShape, context: EmitterContext) {
   return exporter.emit.command(command, emitters[command.command], {
     context,
     variableLookup,
+    variableInString,
     emitNewWindowHandling,
   })
 }
 
+// How a variable is joined with a string literal, e.g. "Hi " + name
+const variableInString = {
+  quotes: ['"', "'"],
+  toString: (lookup: string) => `str(${lookup})`,
+}
+
 function variableLookup(varName: string) {
   return `self.vars["${varName}"]`
 }
@@ -261,9 +263,17 @@ function generateScriptArguments(script: ScriptShape) {
     .join(',')}`
 }
 
-function emitControlFlowDo() {
+// The name of the counter of a loop, unique in a test
+const loopCounter = (context?: EmitterContext) => `loop${context?.loopId ?? 1}`
+
+function emitControlFlowDo(
+  _target: string,
+  _value: string,
+  context: EmitterContext
+) {
   return Promise.resolve({
     commands: [
+      { level: 0, statement: `${loopCounter(context)} = 0` },
       { level: 0, statement: 'condition = True' },
       { level: 0, statement: 'while condition:' },
     ],
@@ -331,9 +341,21 @@ function emitControlFlowForEach(
   })
 }
 
-function emitControlFlowRepeatIf(script: ScriptShape) {
+function emitControlFlowRepeatIf(
+  script: ScriptShape,
+  value: string,
+  context: EmitterContext
+) {
+  const loop = loopCounter(context)
   return Promise.resolve({
     commands: [
+      { level: 0, statement: `${loop} += 1` },
+      {
+        level: 0,
+        statement: `if ${loop} > ${exporter.parsers.loopLimit(
+          value
+        )}: raise Exception("${exporter.parsers.loopLimitMessage}")`,
+      },
       {
         level: 0,
         statement: `condition = ${generateExpressionScript(script)}`,
@@ -343,17 +365,47 @@ function emitControlFlowRepeatIf(script: ScriptShape) {
   })
 }
 
-function emitControlFlowTimes(target: string) {
-  const commands = [{ level: 0, statement: `for i in range(0, ${target}):` }]
-  return Promise.resolve({ commands, endingLevelAdjustment: 1 })
+function emitControlFlowTimes(
+  target: string,
+  value: string,
+  context: EmitterContext
+) {
+  const loop = loopCounter(context)
+  const count = exporter.parsers.loopCount(
+    target,
+    (count) => `int(float(${count}) // 1)`
+  )
+  return Promise.resolve({
+    commands: [
+      { level: 0, statement: `for ${loop} in range(0, ${count}):` },
+      {
+        level: 1,
+        statement: `if ${loop} >= ${exporter.parsers.loopLimit(
+          value
+        )}: raise Exception("${exporter.parsers.loopLimitMessage}")`,
+      },
+    ],
+  })
 }
 
-function emitControlFlowWhile(script: ScriptShape) {
+function emitControlFlowWhile(
+  script: ScriptShape,
+  value: string,
+  context: EmitterContext
+) {
+  const loop = loopCounter(context)
   return Promise.resolve({
     commands: [
+      { level: 0, statement: `${loop} = 0` },
       { level: 0, statement: `while ${generateExpressionScript(script)}:` },
+      { level: 1, statement: `${loop} += 1` },
+      {
+        level: 1,
+        statement: `if ${loop} > ${exporter.parsers.loopLimit(
+          value
+        )}: raise Exception("${exporter.parsers.loopLimitMessage}")`,
+      },
     ],
-    endingLevelAdjustment: 1,
   })
 }
 
@@ -394,21 +446,8 @@ async function emitDragAndDrop(dragged: string, dropped: string) {
   return Promise.resolve({ commands })
 }
 
-function translateToPythonString(str: string) {
-  const regExp = /self.vars\["\w+"]/
-  const vars = str.match(regExp)
-
-  if (vars && vars.length > 0) {
-    const fmtStr = str.replace(regExp, '{}')
-    return `"${fmtStr}".format(${vars.join(', ')})`
-  }
-
-  return `"${str}"`
-}
-
 async function emitEcho(message: string) {
-  const _message = translateToPythonString(message)
-  return Promise.resolve(`print(${_message})`)
+  return Promise.resolve(`print("${message}")`)
 }
 
 async function emitEditContent(locator: string, content: string) {
@@ -515,8 +554,22 @@ async function emitPause(time: number) {
   return Promise.resolve({ commands })
 }
 
-async function emitRun(testName: string) {
-  return Promise.resolve(`self.${exporter.parsers.sanitizeName(testName)}()`)
+async function emitRun(
+  testName: string,
+  _value: string,
+  context: EmitterContext
+) {
+  // The test to run is only known during playback
+  if (hasVariable(testName)) {
+    return Promise.resolve(
+      `${context.commentPrefix} Cannot export run with a test name from a variable: ${testName}`
+    )
+  }
+  return Promise.resolve(
+    `self.${exporter.parsers.uncapitalize(
+      exporter.parsers.sanitizeName(testName)
+    )}()`
+  )
 }
 
 async function emitRunScript(script: ScriptShape) {
@@ -616,9 +669,7 @@ function generateSendKeysInput(value: string | string[]) {
   if (typeof value === 'object') {
     return value
       .map((s) => {
-        if (s.startsWith('self.vars[')) {
-          return s
-        } else if (s.startsWith('Key[')) {
+        if (s.startsWith('Key[')) {
           const key = s.match(/\['(.*)'\]/)?.[1]
           return `Keys.${key}`
         } else {
@@ -704,12 +755,6 @@ async function emitStoreXpathCount(locator: string, varName: string) {
   return Promise.resolve(variableSetter(varName, result))
 }
 
-async function emitSubmit(_locator: string) {
-  return Promise.resolve(
-    `raise Exception("'submit' is not a supported command in Selenium WebDriver. Please re-record the step in the IDE.")`
-  )
-}
-
 async function emitType(target: string, value: string) {
   return Promise.resolve(
     `self.driver.find_element(${await location.emit(
@@ -812,7 +857,7 @@ async function emitVerifyNotSelectedValue(
     },
     {
       level: 0,
-      statement: `assert value != "${exporter.emit.text(expectedValue)}"`,
+      statement: `assert value != "${expectedValue}"`,
     },
   ]
   return Promise.resolve({ commands })
@@ -826,7 +871,7 @@ async function emitVerifyNotText(locator: string, text: string) {
         locator
       )}).text`,
     },
-    { level: 0, statement: `assert text != "${exporter.emit.text(text)}"` },
+    { level: 0, statement: `assert text != "${text}"` },
   ]
   return Promise.resolve({ commands })
 }
@@ -860,7 +905,7 @@ async function emitVerifyText(locator: string, text: string) {
       level: 0,
       statement: `assert self.driver.find_element(${await location.emit(
         locator
-      )}).text == "${exporter.emit.text(text)}"`,
+      )}).text == "${text}"`,
     },
   ]
   return Promise.resolve({ commands })

package/src/hook.ts

@@ -14,7 +14,7 @@
 // KIND, either express or implied.  See the License for the specific language governing permissions and limitations
 // under the License.
 
-import { HookFunctionInputs } from "side-code-export"
+import { HookFunctionInputs } from 'side-code-export'
 
 const emitters = {
   afterAll,

package/src/index.ts

@@ -37,6 +37,9 @@ export const opts: LanguageEmitterOpts = {
   commandPrefixPadding: '  ',
   terminatingKeyword: '',
   commentPrefix: '#',
+  // A backslash before a backtick isn't a valid escape
+  escapedQuotes: `"'`,
+  emptyBlockStatement: 'pass',
   // Create generators for dynamic string creation of primary entities (e.g., filename, methods, test, and suite)
   generateTestDeclaration: function generateTestDeclaration(name) {
     return `def test_${exporter.parsers.uncapitalize(

package/src/selection.ts

@@ -41,9 +41,6 @@ function emitValue(value: string) {
 }
 
 function emitLabel(label: string) {
-  if (label.startsWith('self.vars[')) {
-    return Promise.resolve(`By.XPATH, "//option[. = '{}']".format(${label})`)
-  }
   return Promise.resolve(`By.XPATH, "//option[. = '${label}']"`)
 }