.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - v[0-9]+.[0-9]+.[0-9]+*
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [windows-latest, macOS-latest]
+        node-version: [12.x]
+
+    steps:
+      - name: Fix git checkout line endings
+        run: git config --global core.autocrlf input
+      - uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Get npm cache directory
+        id: npm-cache
+        run: |
+          echo "::set-output name=dir::$(npm config get cache)"
+      - uses: actions/cache@v1
+        with:
+          path: ${{ steps.npm-cache.outputs.dir }}
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - name: Install
+        run: npm ci
+      - name: Test
+        run: npm test

.travis.yml

@@ -1,21 +1,14 @@
-os:
-  - linux
-  - osx
-
+os: linux
 language: node_js
-
-node_js:
-  - '8'
+node_js: '12'
+cache: npm
 
 branches:
   only:
     - master
 
-script: ./script/travis-build.sh
-
-cache:
-  directories:
-    - node_modules
+services:
+  - xvfb
 
 notifications:
   email:

README.md

@@ -1,14 +1,7 @@
 # <img src="https://cloud.githubusercontent.com/assets/378023/15063284/cf544f2c-1383-11e6-9336-e13bd64b1694.png" width="60px" align="center" alt="Spectron icon"> Spectron
 
-[![Linux Build Status](https://travis-ci.org/electron/spectron.svg?branch=master)](https://travis-ci.org/electron/spectron)
-[![Windows Build Status](https://ci.appveyor.com/api/projects/status/iv8xd919q6b44pap/branch/master?svg=true)](https://ci.appveyor.com/project/kevinsawicki/spectron/branch/master)
-<br>
-[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)
-[![dependencies](https://img.shields.io/david/electron/spectron.svg)](https://david-dm.org/electron/spectron)
-<br>
-[![license:mit](https://img.shields.io/badge/license-mit-blue.svg)](https://opensource.org/licenses/MIT)
-[![npm:](https://img.shields.io/npm/v/spectron.svg)](https://www.npmjs.com/package/spectron)
-[![downloads](https://img.shields.io/npm/dm/spectron.svg)](https://www.npmjs.com/package/spectron)
+[![Windows Build Status](https://ci.appveyor.com/api/projects/status/iv8xd919q6b44pap/branch/master?svg=true)](https://ci.appveyor.com/project/kevinsawicki/spectron/branch/master) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)
+[![dependencies](https://img.shields.io/david/electron/spectron.svg)](https://david-dm.org/electron/spectron) [![license:mit](https://img.shields.io/badge/license-mit-blue.svg)](https://opensource.org/licenses/MIT) [![npm:](https://img.shields.io/npm/v/spectron.svg)](https://www.npmjs.com/package/spectron) [![downloads](https://img.shields.io/npm/dm/spectron.svg)](https://www.npmjs.com/package/spectron)
 
 Easily test your [Electron](http://electron.atom.io) apps using
 [ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver) and
@@ -33,6 +26,10 @@ For given versions of Electron you must depend on a very specific version range
 | `^3.0.0` | `^5.0.0` |
 | `^4.0.0` | `^6.0.0` |
 | `^5.0.0` | `^7.0.0` |
+| `^6.0.0` | `^8.0.0` |
+| `^7.0.0` | `^9.0.0` |
+| `^8.0.0` | `^10.0.0`|
+| `^9.0.0` | `^11.0.0`|
 
 Learn more from [this presentation](https://speakerdeck.com/kevinsawicki/testing-your-electron-apps-with-chromedriver).
 
@@ -61,7 +58,7 @@ touch test/spec.js
 cd test
 ```
 
-Then simply include the following your first `spec.js`.
+Then simply include the following in your first `spec.js`.
 
 ```js
 const Application = require('spectron').Application
@@ -305,6 +302,18 @@ app.webContents.savePage('/Users/kevin/page.html', 'HTMLComplete')
   })
 ```
 
+##### executeJavaScript
+The async `executeJavaScript` API is supported but instead of taking a callback it
+returns a `Promise` that will resolve with the result of the last statement of the
+script.
+
+```js
+app.webContents.executeJavaScript('1 + 2')
+  .then(function (result) {
+    console.log(result) // prints 3
+  })
+```
+
 #### mainProcess
 
 The `mainProcess` property is an alias for `require('electron').remote.process`.
@@ -452,6 +461,18 @@ Focus a window using its index from the `windowHandles()` array.
 app.client.windowByIndex(1)
 ```
 
+#### client.switchWindow(urlOrTitleToMatch)
+
+Focus a window using its URL or title.
+
+```js
+// switch via url match
+app.client.switchWindow('google.com')
+
+// switch via title match
+app.client.switchWindow('Next-gen WebDriver test framework')
+```
+
 ### Accessibility Testing
 
 Spectron bundles the [Accessibility Developer Tools](https://github.com/GoogleChrome/accessibility-developer-tools)

lib/api.js

@@ -313,19 +313,16 @@ Api.prototype.addCapturePageSupport = function () {
   var self = this
 
   app.client.addCommand('browserWindow.capturePage', function (rect) {
-    return this.executeAsync(function (rect, requireName, done) {
+    return this.executeAsync(async function (rect, requireName, done) {
       var args = []
       if (rect != null) args.push(rect)
-      args.push(function (image) {
-        if (image != null) {
-          done(image.toPNG().toString('base64'))
-        } else {
-          done(image)
-        }
-      })
-
       var browserWindow = window[requireName]('electron').remote.getCurrentWindow()
-      browserWindow.capturePage.apply(browserWindow, args)
+      const image = await browserWindow.capturePage.apply(browserWindow, args)
+      if (image != null) {
+        done(image.toPNG().toString('base64'))
+      } else {
+        done(image)
+      }
     }, rect, self.requireName).then(getResponseValue).then(function (image) {
       return Buffer.from(image, 'base64')
     })
@@ -342,7 +339,8 @@ Api.prototype.addWebContentsApis = function (api) {
   app.webContents = {}
 
   const asyncApis = {
-    'webContents.savePage': true
+    'webContents.savePage': true,
+    'webContents.executeJavaScript': true
   }
 
   Object.keys(api).filter(function (name) {
@@ -361,16 +359,18 @@ Api.prototype.addWebContentsApis = function (api) {
   })
 
   this.addSavePageSupport()
+  this.addExecuteJavaScriptSupport()
 }
 
 Api.prototype.addSavePageSupport = function () {
   var app = this.app
   var self = this
 
   app.client.addCommand('webContents.savePage', function (fullPath, saveType) {
-    return this.executeAsync(function (fullPath, saveType, requireName, done) {
+    return this.executeAsync(async function (fullPath, saveType, requireName, done) {
       var webContents = window[requireName]('electron').remote.getCurrentWebContents()
-      webContents.savePage(fullPath, saveType, done)
+      await webContents.savePage(fullPath, saveType)
+      done()
     }, fullPath, saveType, self.requireName).then(getResponseValue).then(function (rawError) {
       if (rawError) {
         var error = new Error(rawError.message)
@@ -385,6 +385,23 @@ Api.prototype.addSavePageSupport = function () {
   }
 }
 
+Api.prototype.addExecuteJavaScriptSupport = function () {
+  const app = this.app
+  const self = this
+
+  app.client.addCommand('webContents.executeJavaScript', function (code, useGesture) {
+    return this.executeAsync(async function (code, useGesture, requireName, done) {
+      const webContents = window[requireName]('electron').remote.getCurrentWebContents()
+      const result = await webContents.executeJavaScript(code, useGesture)
+      done(result)
+    }, code, useGesture, self.requireName).then(getResponseValue)
+  })
+
+  app.webContents.executeJavaScript = function () {
+    return app.client['webContents.executeJavaScript'].apply(app.client, arguments)
+  }
+}
+
 Api.prototype.addProcessApis = function (api) {
   var app = this.app
   app.rendererProcess = {}

lib/application.js

@@ -225,6 +225,40 @@ Application.prototype.addCommands = function () {
     })
   })
 
+  /**
+   * Utility from webdriverio v5
+   * https://github.com/webdriverio/webdriverio/blob/v5.9.4/packages/webdriverio/src/commands/browser/switchWindow.js
+   */
+  this.client.addCommand('switchWindow', async function (urlOrTitleToMatch) {
+    if (typeof urlOrTitleToMatch !== 'string' && !(urlOrTitleToMatch instanceof RegExp)) {
+      throw new TypeError('Invalid parameter urlOrTitleToMatch: expected a string or a RegExp')
+    }
+
+    const tabs = await this.windowHandles().then(getResponseValue)
+
+    for (const tab of tabs) {
+      await this.window(tab)
+
+      /**
+       * check if url matches
+       */
+      const url = await this.getUrl()
+      if (url.match(urlOrTitleToMatch)) {
+        return tab
+      }
+
+      /**
+       * check title
+       */
+      const title = await this.getTitle()
+      if (title.match(urlOrTitleToMatch)) {
+        return tab
+      }
+    }
+
+    throw new Error(`No window found with title or url matching "${urlOrTitleToMatch}"`)
+  })
+
   this.client.addCommand('waitUntilWindowLoaded', function (timeout) {
     return this.waitUntil(function () {
       return this.webContents.isLoading().then(function (loading) {

lib/chrome-driver.js

@@ -120,7 +120,7 @@ ChromeDriver.prototype.isRunning = function (callback) {
   request(requestOptions, function (error, response, body) {
     if (error) return callback(cb)
     if (response.statusCode !== 200) return callback(cb)
-    callback(body && body.status === 0)
+    callback(body && body.value.ready)
   })
 }
 

lib/launcher.js

@@ -18,7 +18,7 @@ process.argv.slice(2).forEach(function (arg) {
   if (name === '--spectron-path') {
     executablePath = value
   } else if (name.indexOf('--spectron-arg') === 0) {
-    appArgs.push(value)
+    appArgs[Number(name.substring(14))] = value
   } else if (name.indexOf('--spectron-env') === 0) {
     process.env[name.substring(15)] = value
   } else if (name.indexOf('--spectron-') !== 0) {

lib/rpath-fix.js

@@ -0,0 +1,13 @@
+if (process.platform !== 'darwin') process.exit(0)
+
+const cp = require('child_process')
+const path = require('path')
+
+const pathToChromedriver = require.resolve('electron-chromedriver/chromedriver')
+const pathToChromedriverBin = path.resolve(pathToChromedriver, '..', 'bin', 'chromedriver')
+
+const result = cp.spawnSync('install_name_tool', ['-add_rpath', '@executable_path/.', pathToChromedriverBin], {})
+if (result.status !== 0) {
+  if (result.stderr.includes('file already has LC_RPATH')) process.exit(0)
+  process.exit(result.status)
+}