using webdriver to test the ide pt 1

Author: toddtarsi

package.json

@@ -4,7 +4,6 @@
   "license": "Apache-2.0",
   "private": true,
   "scripts": {
-    "start": "cd packages/selenium-ide && pnpm run start",
     "start:test-site": "http-server -p 8080 ./tests/static",
     "build": "run-s build:ts build:ide",
     "build:electron": "pnpm run --stream --filter @seleniumhq/selenium-ide build:electron",
@@ -18,7 +17,7 @@
     "test:e2e": "jest --testMatch \"**/packages/**/__tests__/**/*.e2e.js\"",
     "lint": "pnpm run lint:scripts",
     "lint:scripts": "eslint --ignore-pattern node_modules --ignore-pattern third-party --ignore-pattern dist --ignore-pattern build --ignore-pattern json --ext .ts,.tsx --ext .js packages/",
-    "test:ide": "npm-run-bg -s 'http-server -p 8080 ./tests/static::Available on::8080' 'node ./scripts/ide-runner.js -t 15000 ./tests/examples/*.side'",
+    "test:ide": "npm-run-bg -s 'http-server -p 8080 ./tests/static::Available on::8080' 'node ./packages/selenium-ide/scripts/ide-runner.js -t 15000 ./tests/examples/*.side'",
     "test:side-runner": "npm-run-bg -s 'http-server -p 8080 ./tests/static::Available on::8080' 'node ./packages/side-runner/dist/bin.js -t 15000 ./tests/examples/*.side'",
     "test:side-runner:ci": "npm-run-bg -s 'http-server -p 8080 ./tests/static::Available on::8080' 'node ./packages/side-runner/dist/bin.js -c \"goog:chromeOptions.args=[headless,no-sandbox] browserName=chrome\" -t 15000 ./tests/examples/*.side'",
     "typecheck": "tsc --noEmit --composite false",

packages/selenium-ide/package.json

@@ -106,7 +106,7 @@
     "@seleniumhq/code-export-ruby-rspec": "^4.0.0-alpha.1",
     "side-code-export": "^4.0.0-alpha.11",
     "@seleniumhq/get-driver": "^4.0.0-alpha.1",
-    "@seleniumhq/side-api": "^4.0.0-alpha.27",
+    "@seleniumhq/side-api": "^4.0.0-alpha.29",
     "@seleniumhq/side-model": "^4.0.0-alpha.4",
     "@seleniumhq/side-runtime": "^4.0.0-alpha.27",
     "dnd-core": "^16.0.1",
@@ -143,6 +143,7 @@
     "npm-run-all": "^4.1.5",
     "run-script-os": "^1.1.6",
     "scroll-into-view-if-needed": "^3.0.10",
+    "selenium-webdriver": "^4.11.1",
     "source-map-loader": "^4.0.1",
     "source-map-support": "^0.5.21",
     "style-loader": "^3.3.3",

packages/selenium-ide/scripts/ide-runner.js

@@ -0,0 +1,111 @@
+const args = process.argv
+
+const { spawn } = require('child_process')
+const webdriver = require('selenium-webdriver')
+const fs = require('fs')
+const path = require('path')
+const os = require('os')
+
+const WebdriverDebugLog = console.log // debuglog('webdriver')
+
+const appName = 'Electron'
+
+const driverPath = path.join(
+  __dirname,
+  '..',
+  'node_modules',
+  'electron-chromedriver',
+  'bin',
+  'chromedriver' + (os.platform() === 'win32' ? '.exe' : '')
+)
+
+const electronBinaryPath = path.join(
+  require.resolve('electron'),
+  '..',
+  'dist',
+  appName + '.app',
+  'Contents',
+  'MacOS',
+  appName
+)
+
+const pathToSeleniumIDE = path.join(__dirname, '..', 'build', 'main-bundle.js')
+
+const port = 9518
+main()
+
+async function main() {
+  console.log('Starting webdriver backend')
+  await startWebdriverBackend({ driver: 'chrome' })
+  const sideFiles = args.filter((arg) => arg.endsWith('.side'))
+  for (const sideFile of sideFiles) {
+    console.log('Starting driver for sidefile', sideFile)
+    const driver = await new webdriver.Builder()
+      .usingServer(`http://localhost:${port}`)
+      .withCapabilities({
+        'goog:chromeOptions': {
+          // Here is the path to your Electron binary.
+          binary: electronBinaryPath,
+          args: [
+            'app=' + pathToSeleniumIDE,
+            `side-file=./../../${sideFile.replace('./', '')}`,
+          ],
+        },
+      })
+      .forBrowser('chrome') // note: use .forBrowser('electron') for selenium-webdriver <= 3.6.0
+      .build()
+    await driver.sleep(10000)
+    await driver.quit()
+    return
+  }
+}
+
+function startWebdriverBackend() {
+  const successMessage = 'was started successfully.'
+  return new Promise((resolve) => {
+    let initialized = false
+    const args = ['--verbose', `--port=${port}`]
+    if (fs.existsSync(driverPath)) {
+      const driver = spawn(driverPath.replace(/\s/g, ' '), args, {
+        env: {},
+        shell: false,
+      })
+      process.on('exit', () => {
+        driver.kill()
+      })
+      driver.stdout.on('data', (out) => {
+        const outStr = `${out}`
+        WebdriverDebugLog(outStr)
+        const fullyStarted = outStr.includes(successMessage)
+        if (fullyStarted) {
+          initialized = true
+          WebdriverDebugLog('Driver has initialized!')
+          resolve({ success: true, driver: driver })
+        }
+      })
+      driver.stderr.on('data', (err) => {
+        const errStr = `${err}`
+        WebdriverDebugLog(errStr)
+        if (!initialized) {
+          resolve({ success: false, error: errStr })
+        }
+      })
+      driver.on('close', (code) => {
+        if (code) {
+          WebdriverDebugLog(`driver has exited with code ${code}`)
+          if (!initialized) {
+            resolve({
+              success: false,
+              error: 'Process has exited before starting with code ' + code,
+            })
+          }
+        }
+      })
+    } else {
+      resolve({
+        success: false,
+        error: `Missing executable at path ${driverPath}`,
+      })
+    }
+  })
+}

packages/selenium-ide/src/main/index.ts

@@ -5,11 +5,12 @@ import { configureLogging, connectSessionLogging } from './log'
 import store from './store'
 import createSession from './session'
 import installReactDevtools from './install-react-devtools'
+import { isAutomated } from './util'
 
 // Configure logging
 configureLogging();
 
-// Enable debugging - required for electron-chromedriv\
+// Enable debugging - required for electron-chromedriver
 app.commandLine.appendSwitch('remote-debugging-port', '8315')
 
 // Capture and show unhandled exceptions
@@ -34,7 +35,9 @@ app.on('open-file', async (_e, path) => {
 
 // Start and stop hooks
 app.on('ready', async () => {
-  !app.isPackaged && installReactDevtools()
+  if (!app.isPackaged && !isAutomated) {
+    installReactDevtools()
+  }
   await session.system.startup()
 
   process.on('SIGINT', async () => {

packages/selenium-ide/src/main/session/controllers/Projects/index.ts

@@ -8,6 +8,7 @@ import { Session } from 'main/types'
 import { randomUUID } from 'crypto'
 import RecentProjects from './Recent'
 import BaseController from '../Base'
+import { isAutomated } from 'main/util'
 
 export default class ProjectsController {
   constructor(session: Session) {
@@ -116,27 +117,29 @@ export default class ProjectsController {
     return starterProject
   }
 
-  async load(filepath: string): Promise<CoreSessionData | null > {
-    const fileExists = await fs.stat(filepath)
-    .then(() => true)
-    .catch(() => false);
-    if(fileExists){
-    const loadedProject = await this.load_v3(filepath)
-    if (loadedProject) {
-      if (this.loaded) {
-        const confirm = await this.onProjectUnloaded()
-        if (!confirm) {
-          return null
+  async load(filepath: string): Promise<CoreSessionData | null> {
+    const fileExists = await fs
+      .stat(filepath)
+      .then(() => true)
+      .catch(() => false)
+    console.log('fileExists', filepath, process.cwd(), __dirname);
+    if (fileExists) {
+      const loadedProject = await this.load_v3(filepath)
+      if (loadedProject) {
+        if (this.loaded) {
+          const confirm = await this.onProjectUnloaded()
+          if (!confirm) {
+            return null
+          }
         }
+        await this.onProjectLoaded(loadedProject, filepath)
+        return await this.session.state.get()
       }
-      await this.onProjectLoaded(loadedProject, filepath)
-      return await this.session.state.get()
-    }
-    return null
-  }else{
-    this.doShowWarning()
-     this.recentProjects.remove(filepath)
-     return null
+      return null
+    } else {
+      this.doShowWarning()
+      this.recentProjects.remove(filepath)
+      return null
     }
   }
 
@@ -146,19 +149,15 @@ export default class ProjectsController {
 
   async select(useArgs = false): Promise<void> {
     // When we're opened with a side file in the path
-    let argsFilepath = process.argv[1]
-    if (!this.session.app.isPackaged) {
-      const mainArgIndex = process.argv.findIndex((arg) =>
-        arg.endsWith('main-bundle.js')
-      )
-      if (mainArgIndex === -1) {
-        argsFilepath = ''
-      } else argsFilepath = process.argv[mainArgIndex + 1]
-    }
+    let argsFilepath = process.argv.find((arg) => arg.startsWith('--side-file=')) || ''
     if (this.filepath) {
       await this.load(this.filepath)
     } else if (useArgs && argsFilepath) {
-      await this.load(argsFilepath)
+      try {
+        await this.load(argsFilepath.replace('--side-file=', ''))
+      } catch (e) {
+        console.warn(`Unable to load file from args: ${argsFilepath}`)
+      }
     } else {
       await this.session.windows.open('splash')
     }
@@ -224,11 +223,11 @@ export default class ProjectsController {
   }
 
   async doShowWarning(): Promise<boolean> {
-    if (await this.projectHasChanged()) {
-       await this.session.dialogs.showMessageBox(
-        'The Project your trying to load is not found , Please create new Project',
-        [ 'Ok']
-      )      
+    if (!isAutomated && (await this.projectHasChanged())) {
+      await this.session.dialogs.showMessageBox(
+        "The project you're trying to load is not found , Please create a new project",
+        ['Ok']
+      )
     }
     return true
   }

packages/selenium-ide/src/main/session/controllers/System/index.ts

@@ -1,5 +1,6 @@
 import { dialog } from 'electron'
 import BaseController from '../Base'
+import { isAutomated } from 'main/util'
 
 let firstTime = true
 export default class SystemController extends BaseController {
@@ -11,16 +12,22 @@ export default class SystemController extends BaseController {
   }
   async startup() {
     if (this.isDown) {
-      const startupError = await this.session.driver.startProcess()
-      if (startupError) {
-        await this.crash(`Unable to startup due to chromedriver error: ${startupError}`);
+      await this.session.windows.open('logger')
+      // If automated, assume we already have a chromedriver process running
+      if (!isAutomated) {
+        const startupError = await this.session.driver.startProcess()
+        if (startupError) {
+          await this.crash(
+            `Unable to startup due to chromedriver error: ${startupError}`
+          )
+        }
       }
       await this.session.projects.select(firstTime)
-      await this.session.windows.open('logger')
       this.isDown = false
       firstTime = false
     }
   }
+
   async shutdown() {
     if (!this.isDown) {
       if (!this.shuttingDown) {
@@ -34,6 +41,7 @@ export default class SystemController extends BaseController {
       }
     }
   }
+
   async crash(error: string) {
     await dialog.showMessageBox({
       message: error,
@@ -42,6 +50,7 @@ export default class SystemController extends BaseController {
     await this.shutdown()
     await this.quit()
   }
+
   async quit() {
     await this.shutdown()
     if (this.isDown) {

packages/selenium-ide/src/main/session/controllers/Windows/index.ts

@@ -13,11 +13,13 @@ import { Session } from 'main/types'
 import storage from 'main/store'
 import { join } from 'path'
 import BaseController from '../Base'
+import { isAutomated } from 'main/util'
 
 const playbackWindowName = 'playback-window'
 const playbackCSS = readFileSync(join(__dirname, 'highlight.css'), 'utf-8')
 const playbackWindowOptions = {
   webPreferences: {
+    devTools: !isAutomated,
     nodeIntegration: false,
     nodeIntegrationInSubFrames: true,
     preload: join(__dirname, `playback-window-preload-bundle.js`),
@@ -53,6 +55,7 @@ const windowLoaderFactoryMap: WindowLoaderFactoryMap = Object.fromEntries(
           const win = new BrowserWindow({
             ...windowConfig,
             webPreferences: {
+              devTools: !isAutomated,
               ...(windowConfig?.webPreferences ?? {}),
               preload: hasPreload ? preloadPath : undefined,
             },

packages/selenium-ide/src/main/util.ts

@@ -10,6 +10,8 @@ export const COLOR_MAGENTA = '\x1b[35m'
 export const COLOR_CYAN = '\x1b[36m'
 export const COLOR_WHITE = '\x1b[37m'
 
+export const isAutomated = process.argv.includes('--enable-automation')
+
 export const vdebuglog = (namespace: string, color: string) => {
   const isBin = app.isPackaged
   const prefix = isBin ? `${namespace}: ` : color

packages/side-api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seleniumhq/side-api",
-  "version": "4.0.0-alpha.28",
+  "version": "4.0.0-alpha.29",
   "private": false,
   "description": "Selenium IDE API command shapes and such",
   "author": "Todd Tarsi <[email protected]>",

packages/side-api/src/types.ts

@@ -4,6 +4,8 @@ import { Browser } from '@seleniumhq/get-driver'
 import { StateShape } from './models/state'
 import { PluginRuntimeShape } from '@seleniumhq/side-runtime'
 
+export * from '@seleniumhq/side-model/dist/types'
+
 export interface BrowserInfo extends Pick<Chrome.BrowserInfo, 'version'> {
   browser: Browser
 }