@seleniumhq/code-export-csharp-nunit 4.0.12 → 4.1.0-beta.1

package/__test__/src/command.spec.js

@@ -16,12 +16,10 @@
 // under the License.
 
 import Command from '../../src/command'
-import {
-  Commands,
-  ControlFlowCommandNames,
-} from '../../../selenium-ide/src/neo/models/Command'
+import { Commands } from '@seleniumhq/side-model'
+import { ControlFlowCommandNames } from '@seleniumhq/side-runtime/dist/playback-tree/commands'
 import { opts } from '../../src/index'
-import { codeExport as exporter } from '@seleniumhq/side-code-export'
+import { codeExport as exporter } from 'side-code-export'
 
 const commandPrefixPadding = opts.commandPrefixPadding
 
@@ -34,22 +32,17 @@ async function prettify(command, { fullPayload } = {}) {
 }
 
 describe('command code emitter', () => {
-  it.skip('should emit all known commands', () => {
-    let result = []
-    Commands.array.forEach(command => {
-      if (!Command.canEmit(command)) {
-        result.push(command)
-      }
-    })
-    expect(() => {
-      if (result.length) {
-        if (result.length === 1) {
-          throw new Error(`${result[0]} has no emitter, write one!`)
-        } else {
-          throw new Error(`No emitters for ${result.join(', ')}. Write them!`)
-        }
-      }
-    }).not.toThrow()
+  it('should have an emitter for every command', () => {
+    const missing = Object.keys(Commands).filter(
+      (command) => !Command.emitters[command]
+    )
+    expect(missing).toEqual([])
+  })
+  it('should not escape backticks in values', async () => {
+    const command = { command: 'type', target: 'id=a', value: "it's `ok`" }
+    expect(await Command.emit(command, opts)).toBe(
+      'driver.FindElement(By.Id("a")).SendKeys("it\\\'s `ok`");'
+    )
   })
   it('should emit `add selection` command', () => {
     const command = {
@@ -375,14 +368,6 @@ describe('command code emitter', () => {
     }
     return expect(prettify(command)).resolves.toMatchSnapshot()
   })
-  it.skip('should emit `mouse move` event', () => {
-    const command = {
-      command: 'mouseMove',
-      target: 'id=button',
-      value: '',
-    }
-    return expect(prettify(command)).resolves.toMatchSnapshot()
-  })
   it('should emit `mouse move at` event', () => {
     const command = {
       command: 'mouseMoveAt',
@@ -463,6 +448,14 @@ describe('command code emitter', () => {
     }
     return expect(prettify(command)).resolves.toMatchSnapshot()
   })
+  it('should emit `run` command for a test with a capitalized name', () => {
+    const command = { command: 'run', target: 'Some Test Case', value: '' }
+    return expect(prettify(command)).resolves.toMatchSnapshot()
+  })
+  it('should emit a comment for `run` with a test name from a variable', async () => {
+    const command = { command: 'run', target: '${testName}', value: '' }
+    expect(await Command.emit(command, opts)).toMatchSnapshot()
+  })
   it('should emit `run script` command', () => {
     const command = {
       command: 'runScript',
@@ -565,22 +558,6 @@ describe('command code emitter', () => {
     }
     return expect(prettify(command)).resolves.toMatchSnapshot()
   })
-  it('should skip playback supported commands, that are not supported in webdriver', () => {
-    return Promise.all([
-      expect(
-        prettify({ command: 'answerOnNextPrompt', target: 'blah' })
-      ).resolves.toMatchSnapshot(),
-      expect(
-        prettify({ command: 'chooseCancelOnNextConfirmation' })
-      ).resolves.toMatchSnapshot(),
-      expect(
-        prettify({ command: 'chooseCancelOnNextPrompt' })
-      ).resolves.toMatchSnapshot(),
-      expect(
-        prettify({ command: 'chooseOkOnNextConfirmation' })
-      ).resolves.toMatchSnapshot(),
-    ])
-  })
   it('should emit `store` command', () => {
     const command = {
       command: 'store',
@@ -613,6 +590,18 @@ describe('command code emitter', () => {
     }
     return expect(prettify(command)).resolves.toMatchSnapshot()
   })
+  it('should escape the variable name of `store json`', () => {
+    const command = {
+      command: 'storeJson',
+      target: '{"a":0}',
+      value: 'x"); System.exit(1); //',
+    }
+    return expect(prettify(command)).resolves.toMatchSnapshot()
+  })
+  it('should store a json array as a list', () => {
+    const command = { command: 'storeJson', target: '[1, 2]', value: 'list' }
+    return expect(prettify(command)).resolves.toMatchSnapshot()
+  })
   it('should emit `store title` command', () => {
     const command = {
       command: 'storeTitle',
@@ -637,26 +626,28 @@ describe('command code emitter', () => {
     }
     return expect(prettify(command)).resolves.toMatchSnapshot()
   })
-  it('should emit `store xpath count` command', () => {
+  it('should emit `store element count` command', () => {
     const command = {
-      command: 'storeXpathCount',
+      command: 'storeElementCount',
       target: 'xpath=button',
       value: 'myVar',
     }
     return expect(prettify(command)).resolves.toMatchSnapshot()
   })
-  it('should emit `submit` command', () => {
+  it('should emit `times` command', () => {
     const command = {
-      command: 'submit',
-      target: 'id=form',
+      command: ControlFlowCommandNames.times,
+      target: '5',
       value: '',
     }
-    return expect(prettify(command)).resolves.toMatchSnapshot()
+    return expect(
+      prettify(command, { fullPayload: true })
+    ).resolves.toMatchSnapshot()
   })
-  it('should emit `times` command', () => {
+  it('should emit `times` command with a variable count', () => {
     const command = {
       command: ControlFlowCommandNames.times,
-      target: '5',
+      target: '${count}',
       value: '',
     }
     return expect(
@@ -847,25 +838,41 @@ describe('command code emitter', () => {
     }
     return expect(prettify(command)).resolves.toMatchSnapshot()
   })
-  it('should emit `answer on visible prompt` command', () => {
+  it('should emit `answer prompt` command', () => {
     const command = {
-      command: 'webdriverAnswerOnVisiblePrompt',
+      command: 'answerPrompt',
       target: 'an answer',
       value: '',
     }
     return expect(prettify(command)).resolves.toMatchSnapshot()
   })
-  it('should emit `choose cancel on visible prompt` command', () => {
+  it('should emit `dismiss prompt` command', () => {
+    const command = {
+      command: 'dismissPrompt',
+      target: '',
+      value: '',
+    }
+    return expect(prettify(command)).resolves.toMatchSnapshot()
+  })
+  it('should emit `accept confirmation` command', () => {
+    const command = {
+      command: 'acceptConfirmation',
+      target: '',
+      value: '',
+    }
+    return expect(prettify(command)).resolves.toMatchSnapshot()
+  })
+  it('should emit `accept alert` command', () => {
     const command = {
-      command: 'webdriverChooseCancelOnVisiblePrompt',
+      command: 'acceptAlert',
       target: '',
       value: '',
     }
     return expect(prettify(command)).resolves.toMatchSnapshot()
   })
-  it('should emit `choose ok on visible confirmation` command', () => {
+  it('should emit `dismiss confirmation` command', () => {
     const command = {
-      command: 'webdriverChooseOkOnVisibleConfirmation',
+      command: 'dismissConfirmation',
       target: '',
       value: '',
     }

package/__test__/src/index.spec.js

@@ -17,14 +17,8 @@
 
 import fs from 'fs'
 import path from 'path'
-import codeExport, {
-  emitTest,
-  emitSuite,
-  _emitMethod,
-  _findTestByName,
-} from '../../src'
+import languageExport from '../../src'
 import Command from '../../src/command'
-import { project as projectProcessor } from '@seleniumhq/side-code-export'
 
 function readFile(filename) {
   return JSON.parse(
@@ -43,110 +37,92 @@ function readFile(filename) {
   )
 }
 
+const options = (project) => ({
+  project,
+  tests: project.tests,
+  enableOriginTracing: false,
+  enableDescriptionAsComment: false,
+  beforeEachOptions: {},
+})
+
 describe('Code Export C# NUnit', () => {
   it('should export a test', async () => {
     const project = readFile('single-test.side')
-    const results = await emitTest({
-      baseUrl: project.url,
+    const results = await languageExport.emit.test({
+      ...options(project),
       test: project.tests[0],
-      tests: project.tests,
     })
-    expect(results.body).toBeDefined()
     expect(results.body).toMatchSnapshot()
   })
   it('should export a test with grid execution', async () => {
     const project = readFile('single-test.side')
-    const results = await emitTest({
-      baseUrl: project.url,
+    const results = await languageExport.emit.test({
+      ...options(project),
       test: project.tests[0],
-      tests: project.tests,
       beforeEachOptions: {
         browserName: 'Firefox',
         gridUrl: 'http://localhost:4444/wd/hub',
       },
     })
-    expect(results.body).toBeDefined()
     expect(results.body).toMatchSnapshot()
   })
   it('should export a suite', async () => {
-    const project = normalizeProject(readFile('single-suite.side'))
-    const results = await emitSuite({
-      baseUrl: project.url,
+    const project = readFile('single-suite.side')
+    const results = await languageExport.emit.suite({
+      ...options(project),
       suite: project.suites[0],
-      tests: project.tests,
     })
-    expect(results.body).toBeDefined()
     expect(results.body).toMatchSnapshot()
   })
   it('should export a test with a reused test method', async () => {
-    const project = normalizeProject(readFile('test-case-reuse.side'))
-    const results = await emitTest({
-      baseUrl: project.url,
+    const project = readFile('test-case-reuse.side')
+    const results = await languageExport.emit.test({
+      ...options(project),
       test: project.tests[1],
-      tests: project.tests,
-    })
-    expect(results.body).toBeDefined()
-    expect(results.body).toMatchSnapshot()
-  })
-  it('should export a test with commands that open a new window', async () => {
-    const project = normalizeProject(readFile('select-window.side'))
-    const results = await emitTest({
-      baseUrl: project.url,
-      test: project.tests[0],
-      tests: project.tests,
     })
-    expect(results.body).toBeDefined()
     expect(results.body).toMatchSnapshot()
   })
   it('should export a suite with a reused test method', async () => {
-    const project = normalizeProject(readFile('test-case-reuse.side'))
-    const results = await emitSuite({
-      baseUrl: project.url,
+    const project = readFile('test-case-reuse.side')
+    const results = await languageExport.emit.suite({
+      ...options(project),
       suite: project.suites[0],
-      tests: project.tests,
     })
-    expect(results.body).toBeDefined()
     expect(results.body).toMatchSnapshot()
   })
   it('should export a suite that uses control flow commands', async () => {
-    const project = normalizeProject(readFile('control-flow-suite.side'))
-    const results = await emitSuite({
-      baseUrl: project.url,
+    const project = readFile('control-flow-suite.side')
+    const results = await languageExport.emit.suite({
+      ...options(project),
       suite: project.suites[0],
-      tests: project.tests,
     })
-    expect(results.body).toBeDefined()
+    expect(results.body).toMatchSnapshot()
+  })
+  it('should export a test with commands that open a new window', async () => {
+    const project = readFile('select-window.side')
+    const results = await languageExport.emit.test({
+      ...options(project),
+      test: project.tests[0],
+    })
     expect(results.body).toMatchSnapshot()
   })
   it('should export a suite with commands that open a new window inside of a reused test method', async () => {
-    const project = normalizeProject(readFile('nested-select-window.side'))
-    const results = await emitSuite({
-      baseUrl: project.url,
+    const project = readFile('nested-select-window.side')
+    const results = await languageExport.emit.suite({
+      ...options(project),
       suite: project.suites[0],
-      tests: project.tests,
     })
-    expect(results.body).toBeDefined()
     expect(results.body).toMatchSnapshot()
   })
   it('should export a suite with just one new window util method when there are multiple commands that open a new window', async () => {
-    const project = normalizeProject(readFile('nested-select-window-v2.side'))
-    const results = await emitSuite({
-      baseUrl: project.url,
+    const project = readFile('nested-select-window-v2.side')
+    const results = await languageExport.emit.suite({
+      ...options(project),
       suite: project.suites[0],
-      tests: project.tests,
     })
-    expect(results.body).toBeDefined()
     expect(results.body).toMatchSnapshot()
   })
   it('should export the command emitter', () => {
-    expect(Command.emit).toStrictEqual(codeExport.emit.command)
+    expect(languageExport.emit.command).toBe(Command.emit)
   })
 })
-
-function normalizeProject(project) {
-  let _project = { ...project }
-  _project.suites.forEach(suite => {
-    projectProcessor.normalizeTestsInSuite({ suite, tests: _project.tests })
-  })
-  return _project
-}

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAiBA,OAAO,EAGL,mBAAmB,EAEpB,MAAM,kBAAkB,CAAA;AAMzB,eAAO,MAAM,WAAW,aAAa,CAAA;AAErC,eAAO,MAAM,IAAI,EAAE,mBA2BlB,CAAA;;AAGD,wBAAqD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAiBA,OAAO,EAGL,mBAAmB,EAEpB,MAAM,kBAAkB,CAAA;AAMzB,eAAO,MAAM,WAAW,aAAa,CAAA;AAErC,eAAO,MAAM,IAAI,EAAE,mBA8BlB,CAAA;;AAGD,wBAAoD"}

package/dist/index.js

@@ -35,11 +35,14 @@ exports.opts = {
     commandPrefixPadding: '  ',
     terminatingKeyword: '}',
     commentPrefix: '//',
+    // A backslash before a backtick isn't a valid escape
+    escapedQuotes: `"'`,
     generateFilename: (name) => {
         return `${side_code_export_1.codeExport.parsers.capitalize(side_code_export_1.codeExport.parsers.sanitizeName(name))}Test${exports.opts.fileExtension}`;
     },
     generateMethodDeclaration: (name) => {
-        return `public void ${side_code_export_1.codeExport.parsers.sanitizeName(name)}() {`;
+        // run_ prefix: generated test names can't contain it, so they can't clash
+        return `public void run_${side_code_export_1.codeExport.parsers.sanitizeName(name)}() {`;
     },
     generateTestDeclaration: (name) => {
         return `[Test]\npublic void ${side_code_export_1.codeExport.parsers.uncapitalize(side_code_export_1.codeExport.parsers.sanitizeName(name))}() {`;

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.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,uDAKyB;AACzB,wDAA+B;AAC/B,uFAAiE;AACjE,kDAA0B;AAE1B,0BAA0B;AACb,QAAA,WAAW,GAAG,UAAU,CAAA;AAExB,QAAA,IAAI,GAAwB;IACvC,WAAW,EAAX,mBAAW;IACX,IAAI,EAAE,cAAc;IACpB,OAAO,EAAP,iBAAO;IACP,KAAK,EAAE,IAAA,gCAAa,EAAC,cAAK,CAAC;IAC3B,aAAa,EAAE,KAAK;IACpB,oBAAoB,EAAE,IAAI;IAC1B,kBAAkB,EAAE,GAAG;IACvB,aAAa,EAAE,IAAI;IACnB,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE;QACzB,OAAO,GAAG,6BAAQ,CAAC,OAAO,CAAC,UAAU,CACnC,6BAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CACpC,OAAO,YAAI,CAAC,aAAa,EAAE,CAAA;IAC9B,CAAC;IACD,yBAAyB,EAAE,CAAC,IAAI,EAAE,EAAE;QAClC,OAAO,eAAe,6BAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAA;IACjE,CAAC;IACD,uBAAuB,EAAE,CAAC,IAAI,EAAE,EAAE;QAChC,OAAO,uBAAuB,6BAAQ,CAAC,OAAO,CAAC,YAAY,CACzD,6BAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CACpC,MAAM,CAAA;IACT,CAAC;IACD,wBAAwB,EAAE,CAAC,IAAI,EAAE,EAAE;QACjC,OAAO,+BAA+B,6BAAQ,CAAC,OAAO,CAAC,UAAU,CAC/D,6BAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CACpC,QAAQ,CAAA;IACX,CAAC;CACF,CAAA;AAED,sFAAsF;AACtF,kBAAe,IAAA,mCAAgB,EAAC,YAAI,EAAE,qCAAQ,CAAC,IAAI,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.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,uDAKyB;AACzB,wDAA+B;AAC/B,uFAAiE;AACjE,kDAA0B;AAE1B,0BAA0B;AACb,QAAA,WAAW,GAAG,UAAU,CAAA;AAExB,QAAA,IAAI,GAAwB;IACvC,WAAW,EAAX,mBAAW;IACX,IAAI,EAAE,cAAc;IACpB,OAAO,EAAP,iBAAO;IACP,KAAK,EAAE,IAAA,gCAAa,EAAC,cAAK,CAAC;IAC3B,aAAa,EAAE,KAAK;IACpB,oBAAoB,EAAE,IAAI;IAC1B,kBAAkB,EAAE,GAAG;IACvB,aAAa,EAAE,IAAI;IACnB,qDAAqD;IACrD,aAAa,EAAE,IAAI;IACnB,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE;QACzB,OAAO,GAAG,6BAAQ,CAAC,OAAO,CAAC,UAAU,CACnC,6BAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CACpC,OAAO,YAAI,CAAC,aAAa,EAAE,CAAA;IAC9B,CAAC;IACD,yBAAyB,EAAE,CAAC,IAAI,EAAE,EAAE;QAClC,0EAA0E;QAC1E,OAAO,mBAAmB,6BAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAA;IACrE,CAAC;IACD,uBAAuB,EAAE,CAAC,IAAI,EAAE,EAAE;QAChC,OAAO,uBAAuB,6BAAQ,CAAC,OAAO,CAAC,YAAY,CACzD,6BAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CACpC,MAAM,CAAA;IACT,CAAC;IACD,wBAAwB,EAAE,CAAC,IAAI,EAAE,EAAE;QACjC,OAAO,+BAA+B,6BAAQ,CAAC,OAAO,CAAC,UAAU,CAC/D,6BAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CACpC,QAAQ,CAAA;IACX,CAAC;CACF,CAAA;AAED,sFAAsF;AACtF,kBAAe,IAAA,mCAAgB,EAAC,YAAI,EAAE,qCAAQ,CAAC,IAAI,CAAC,CAAA"}

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-csharp-nunit",
-  "version": "4.0.12",
+  "version": "4.1.0-beta.1",
   "private": false,
   "description": "Export Selenium IDE project contents to C# NUnit",
   "repository": "https://github.com/SeleniumHQ/selenium-ide",
@@ -12,9 +12,13 @@
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "devDependencies": {
+    "@seleniumhq/side-runtime": "4.1.0-beta.1",
+    "@seleniumhq/side-model": "4.1.0-beta.1"
+  },
   "dependencies": {
-    "@seleniumhq/code-export-csharp-commons": "4.0.12",
-    "side-code-export": "^4.0.11"
+    "@seleniumhq/code-export-csharp-commons": "4.1.0-beta.1",
+    "side-code-export": "4.1.0-beta.1"
   },
   "gitHead": "f58e327e7616e23a3e926e4b80cf9952164e5744",
   "scripts": {

package/src/index.ts

@@ -37,13 +37,16 @@ export const opts: LanguageEmitterOpts = {
   commandPrefixPadding: '  ',
   terminatingKeyword: '}',
   commentPrefix: '//',
+  // A backslash before a backtick isn't a valid escape
+  escapedQuotes: `"'`,
   generateFilename: (name) => {
     return `${exporter.parsers.capitalize(
       exporter.parsers.sanitizeName(name)
     )}Test${opts.fileExtension}`
   },
   generateMethodDeclaration: (name) => {
-    return `public void ${exporter.parsers.sanitizeName(name)}() {`
+    // run_ prefix: generated test names can't contain it, so they can't clash
+    return `public void run_${exporter.parsers.sanitizeName(name)}() {`
   },
   generateTestDeclaration: (name) => {
     return `[Test]\npublic void ${exporter.parsers.uncapitalize(
@@ -58,4 +61,4 @@ export const opts: LanguageEmitterOpts = {
 }
 
 // Emit an individual test, wrapped in a suite (using the test name as the suite name)
-export default languageFromOpts(opts, location.emit);
+export default languageFromOpts(opts, location.emit)