Add automated tests for chrome app

Author: felixhammerl

package.json

@@ -23,7 +23,8 @@
     "test": "npm run lint && npm run unit && npm run integration",
     "unit": "npx mocha './src/*-unit.js' --reporter spec --require babel-register --require babel-polyfill testutils.js",
     "integration": "npm run integration-ws",
-    "integration-ws": "npm run build && npx webpack --config webpack.config.test.js -p && npx wdio wdio.conf.js"
+    "integration-ws": "npm run build && npx webpack --config webpack.config.test.js -p && npx wdio wdio.conf.js",
+    "integration-chrome": "cp node_modules/chai/chai.js node_modules/mocha/mocha.js node_modules/mocha/mocha.css test/chrome/ && npm run build && npx webpack --config webpack.config.chrome.js && npx babel-node test/chrome/run.js"
   },
   "bugs": {
     "url": "https://github.com/emailjs/emailjs-tcp-socket/issues"
@@ -42,18 +43,20 @@
     "babel-preset-env": "^1.6.1",
     "babel-register": "^6.26.0",
     "chai": "^4.1.2",
+    "chrome-launcher": "^0.10.0",
     "emailjs-tcp-proxy": "^1.0.2",
     "hoodiecrow-imap": "^2.1.0",
     "mocha": "^4.0.1",
     "nodemon": "^1.12.5",
     "pre-commit": "^1.2.2",
+    "shelljs": "^0.7.8",
     "sinon": "^4.1.3",
     "standard": "^10.0.3",
-    "starttls": "https://github.com/felixhammerl/starttls/tarball/master",
     "wdio-chromedriver-service": "^0.1.1",
     "wdio-mocha-framework": "^0.5.11",
     "webdriverio": "^4.9.11",
-    "webpack": "^3.10.0"
+    "webpack": "^3.10.0",
+    "ws": "^3.3.2"
   },
   "standard": {
     "globals": [

test/chrome/background.js

@@ -0,0 +1,5 @@
+'use strict'
+
+chrome.app.runtime.onLaunched.addListener(function () {
+  chrome.app.window.create('index.html', { width: 1024, height: 650 })
+})

test/chrome/chrome-integration.js

@@ -0,0 +1,73 @@
+/* eslint-ignore no-unused-expressions */
+
+import TCPSocket from '../../'
+import { PORT_NET, PORT_STARTTLS, PORT_TLS } from './constants'
+const { expect } = window.chai
+
+const a2s = arr => String.fromCharCode.apply(null, new Uint8Array(arr))
+const s2a = str => new Uint8Array(str.split('').map(char => char.charCodeAt(0))).buffer
+
+describe('TCP chrome shim integration tests', function () {
+  const payload = 'the.payload.woopwoop!'
+  let received
+
+  beforeEach(done => {
+    received = ''
+    setTimeout(done, 500)
+  })
+
+  describe('tcp', function () {
+    it('should open, read, write, and close', function (done) {
+      const socket = TCPSocket.open('localhost', PORT_NET)
+      socket.onopen = () => { socket.send(s2a(payload)) }
+      socket.onclose = () => {
+        expect(received).to.equal(payload)
+        done()
+      }
+      socket.ondata = ({ data }) => {
+        received += a2s(data)
+        if (received === payload) {
+          socket.close()
+        }
+      }
+    })
+  })
+
+  describe('tls', function () {
+    it('should open, read, write, and close', function (done) {
+      const useSecureTransport = true
+      var socket = TCPSocket.open('localhost', PORT_TLS, { useSecureTransport })
+      socket.onopen = () => { socket.send(s2a(payload)) }
+      socket.onclose = () => {
+        expect(received).to.equal(payload)
+        done()
+      }
+      socket.ondata = ({ data }) => {
+        received += a2s(data)
+        if (received === payload) {
+          socket.close()
+        }
+      }
+    })
+  })
+
+  describe.skip('starttls', function () {
+    it('should open, read, write, and close', function (done) {
+      var socket = TCPSocket.open('localhost', PORT_STARTTLS)
+      socket.onopen = () => {
+        socket.upgradeToSecure()
+        socket.send(s2a(payload))
+      }
+      socket.onclose = () => {
+        expect(received).to.equal(payload)
+        done()
+      }
+      socket.ondata = ({ data }) => {
+        received += a2s(data)
+        if (received === payload) {
+          socket.close()
+        }
+      }
+    })
+  })
+})

test/chrome/constants.js

@@ -0,0 +1,3 @@
+export const PORT_NET = 8000
+export const PORT_TLS = 8001
+export const PORT_STARTTLS = 8002

test/chrome/index.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html style="overflow-y: auto">
+
+<head>
+  <meta http-equiv="Content-type" content="text/html; charset=utf-8">
+  <link href="mocha.css" rel="stylesheet" />
+</head>
+
+<body>
+  <div id="mocha"></div>
+
+  <script src="mocha.js"></script>
+  <script src="chai.js"></script>
+  <script src="mocha-prepare.js"></script>
+  <script src="chrome-integration.comp.js"></script>
+  <script src="mocha-run.js"></script>
+</body>
+
+</html>

test/chrome/manifest.json

@@ -0,0 +1,26 @@
+{
+  "name": "tcp-socket with chrome.sockets",
+  "description": "Example of a TCPSocket shim for Chrome Packaged Apps",
+  "version": "0.0.1",
+  "manifest_version": 2,
+  "offline_enabled": false,
+  "permissions": [
+    {
+      "socket": [
+        "tcp-connect"
+      ]
+    }
+  ],
+  // "sockets": {
+  //     "tcp": {
+  //         "connect": ""
+  //     }
+  // },
+  "app": {
+    "background": {
+      "scripts": [
+        "background.js"
+      ]
+    }
+  }
+}

test/chrome/mocha-prepare.js

@@ -0,0 +1,4 @@
+(function () {
+  'use strict'
+  window.mocha.setup('bdd')
+})()

test/chrome/mocha-run.js

@@ -0,0 +1,10 @@
+(function () {
+  'use strict'
+  window.mocha.run(function (failureCount) {
+    if (!failureCount) {
+      console.log('All tests passed!')
+    } else {
+      console.log('Failure count: ' + failureCount)
+    }
+  })
+})()

test/chrome/remote-debugger.js

@@ -0,0 +1,68 @@
+// taken from https://github.com/tejohnso/chrome-app-test-runner
+
+import WebSocket from 'ws'
+import { get } from 'http'
+
+let ws
+let messageHandler
+let intervalHandler
+let evalPromiseResolverObject = { resolve: 0 }
+
+function createConnectionResponse (resolver, intervalHandler) {
+  return function (resp) {
+    var chunks = ''
+
+    resp.on('data', function (data) {
+      chunks += data
+    })
+    resp.on('end', function () {
+      var inspectables
+
+      inspectables = JSON.parse(chunks).filter(function (tabData) {
+        return tabData.type === 'app'
+      })[0]
+
+      if (inspectables && inspectables.webSocketDebuggerUrl) {
+        clearInterval(intervalHandler.handle)
+        ws = new WebSocket(inspectables.webSocketDebuggerUrl)
+        ws.onopen = function () {
+          ws.send(JSON.stringify({ 'id': 1, 'method': 'Console.enable' }))
+        }
+        ws.onmessage = function (event) {
+          var data = JSON.parse(event.data)
+
+          if (data.id === 9) {
+            return evalPromiseResolverObject.resolver(data.result.result.value)
+          }
+          messageHandler(data)
+        }
+        resolver()
+      }
+    })
+  }
+}
+
+function createErrorResponse (rejecter) {
+  return function (resp) {
+    console.log(resp)
+    clearInterval(intervalHandler.handle)
+    rejecter()
+  }
+}
+
+export function attachDebugger () {
+  return new Promise(function (resolve, reject) {
+    intervalHandler = { handle: 0 }
+    let connectionResponse = createConnectionResponse(resolve, intervalHandler)
+    let errorResponse = createErrorResponse(reject)
+
+    intervalHandler.handle = setInterval(function () {
+      get('http://localhost:9222/json/list', connectionResponse)
+        .on('error', errorResponse)
+    }, 500)
+  })
+}
+
+export function setDebugHandler (handler) {
+  messageHandler = handler
+}

test/chrome/run.js

@@ -0,0 +1,56 @@
+import fs from 'fs'
+import net from 'net'
+import tls from 'tls'
+import startTls from './starttls'
+import { pathOr } from 'ramda'
+import { join } from 'path'
+import { attachDebugger, setDebugHandler } from './remote-debugger.js'
+import { PORT_NET, PORT_STARTTLS, PORT_TLS } from './constants'
+import { launch } from 'chrome-launcher'
+
+function createServers () {
+  const key = fs.readFileSync(join(__dirname, '..', '..', 'crt', 'server.key'), 'utf8')
+  const cert = fs.readFileSync(join(__dirname, '..', '..', 'crt', 'server.crt'), 'utf8')
+  const s1 = net.createServer(socket => { socket.pipe(socket) })
+  const s2 = tls.createServer({ key, cert }, socket => { socket.pipe(socket) })
+  const s3 = startTls.createServer(socket => {
+    socket.upgrade({ key, cert, requestCert: false, rejectUnauthorized: false }, () => {
+      socket.pipe(socket)
+    })
+  })
+
+  const servers = [[s1, PORT_NET], [s2, PORT_TLS], [s3, PORT_STARTTLS]]
+  const startServers = () => Promise.all(servers.map(([server, port]) => new Promise((resolve, reject) => { server.listen(port, resolve) })))
+  const stopServers = () => Promise.all(servers.map(([s, _]) => new Promise((resolve, reject) => { s.close(resolve) })))
+  return { startServers, stopServers }
+}
+
+const { startServers, stopServers } = createServers()
+let chrome
+
+startServers()
+  .then(() => launch({ port: 9222, chromeFlags: [`--load-and-launch-app=${__dirname}`], enableExtensions: true }))
+  .then(child => { chrome = child })
+  .then(() => attachDebugger())
+  .then(() => new Promise((resolve, reject) => {
+    setDebugHandler(data => {
+      var message = pathOr('', ['params', 'message', 'text'])(data)
+      if (message === 'All tests passed!') {
+        resolve(message)
+      } else if (/Failure count: [\d]+/.test(message)) {
+        reject(message)
+      }
+    })
+  }))
+  .then(msg => {
+    console.log(msg)
+    chrome.kill()
+    stopServers()
+    process.exit(0)
+  })
+  .catch(e => {
+    console.error(e)
+    chrome.kill()
+    stopServers()
+    process.exit(1)
+  })