spectron/lib/chrome-driver.js

Easily test your Electron apps using ChromeDriver and WebdriverIO.

var ChildProcess = require('child_process')
var path = require('path')
var request = require('request')
var split = require('split')

function ChromeDriver (host, port, nodePath, startTimeout, workingDirectory, chromeDriverLogPath) {
  this.host = host
  this.port = port
  this.nodePath = nodePath
  this.startTimeout = startTimeout
  this.workingDirectory = workingDirectory
  this.chromeDriverLogPath = chromeDriverLogPath

  this.path = require.resolve('electron-chromedriver/chromedriver')
  this.urlBase = '/wd/hub'
  this.statusUrl = 'http://' + this.host + ':' + this.port + this.urlBase + '/status'
  this.logLines = []
}

ChromeDriver.prototype.start = function () {
  if (this.process) throw new Error('ChromeDriver already started')

  var args = [
    this.path,
    '--port=' + this.port,
    '--url-base=' + this.urlBase
  ]

  if (this.chromeDriverLogPath) {
    args.push('--verbose')
    args.push('--log-path=' + this.chromeDriverLogPath)
  }
  var options = {
    cwd: this.workingDirectory,
    env: this.getEnvironment()
  }
  this.process = ChildProcess.spawn(this.nodePath, args, options)

  var self = this
  this.exitHandler = function () { self.stop() }
  global.process.on('exit', this.exitHandler)

  this.setupLogs()
  return this.waitUntilRunning()
}

ChromeDriver.prototype.waitUntilRunning = function () {
  var self = this
  return new Promise(function (resolve, reject) {
    var startTime = Date.now()
    var checkIfRunning = function () {
      self.isRunning(function (running) {
        if (!self.process) {
          return reject(Error('ChromeDriver has been stopped'))
        }

        if (running) {
          return resolve()
        }

        var elapsedTime = Date.now() - startTime
        if (elapsedTime > self.startTimeout) {
          return reject(Error('ChromeDriver did not start within ' + self.startTimeout + 'ms'))
        }

        global.setTimeout(checkIfRunning, 100)
      })
    }
    checkIfRunning()
  })
}

ChromeDriver.prototype.setupLogs = function () {
  var linesToIgnore = 2 // First two lines are ChromeDriver specific
  var lineCount = 0

  this.logLines = []

  var self = this
  this.process.stdout.pipe(split()).on('data', function (line) {
    if (lineCount < linesToIgnore) {
      lineCount++
      return
    }
    self.logLines.push(line)
  })
}

ChromeDriver.prototype.getEnvironment = function () {
  var env = {}
  Object.keys(process.env).forEach(function (key) {
    env[key] = process.env[key]
  })

  if (process.platform === 'win32') {
    env.SPECTRON_NODE_PATH = process.execPath
    env.SPECTRON_LAUNCHER_PATH = path.join(__dirname, 'launcher.js')
  }

  return env
}

ChromeDriver.prototype.stop = function () {
  if (this.exitHandler) global.process.removeListener('exit', this.exitHandler)
  this.exitHandler = null

  if (this.process) this.process.kill()
  this.process = null

  this.clearLogs()
}

ChromeDriver.prototype.isRunning = function (callback) {
  var requestOptions = {
    uri: this.statusUrl,
    json: true,
    followAllRedirects: true
  }
  request(requestOptions, function (error, response, body) {
    if (error) return callback(false)
    if (response.statusCode !== 200) return callback(false)
    callback(body && body.status === 0)
  })
}

ChromeDriver.prototype.getLogs = function () {
  return this.logLines.slice()
}

ChromeDriver.prototype.clearLogs = function () {
  this.logLines = []
}

module.exports = ChromeDriver