Refactor boltstub, always run related tests

Previously driver allowed boltkit to be an optional dependency and
relied on neokit (submodule) to start/stop neo4j database. That's
why all tests that use stub server from boltkit were executed as a
separate step. These days boltkit is always required and
neokit is gone.

This commit refactors stub server handling and turns all boltkit tests
into normal tests that run as part of `npm test` and `runTests` script.
These tests are however skipped in browser testing because it is not
possible to spawn child processes when in phantomjs environment.

Author: lutovich

gulpfile.babel.js

@@ -170,14 +170,6 @@ gulp.task('test-nodejs', ['install-driver-into-sandbox'], function () {
     })).on('end', logActiveNodeHandles);
 });
 
-gulp.task('test-boltkit', ['nodejs'], function () {
-  return gulp.src('test/**/*.boltkit.it.js')
-    .pipe(jasmine({
-      includeStackTrace: true,
-      verbose: true
-    })).on('end', logActiveNodeHandles);
-});
-
 gulp.task('test-browser', function (cb) {
   runSequence('all', 'run-browser-test', cb)
 });

package.json

@@ -1,7 +1,7 @@
 {
   "name": "neo4j-driver",
-  "version": "1.4.1-dev",
-  "description": "Connect to Neo4j 3.1.0 and up from JavaScript",
+  "version": "1.5.0-dev",
+  "description": "Connect to Neo4j 3.0.0 and up from JavaScript",
   "author": "Neo Technology Inc.",
   "license": "Apache-2.0",
   "repository": {
@@ -10,7 +10,6 @@
   },
   "scripts": {
     "test": "gulp test",
-    "boltkit": "gulp test-boltkit",
     "build": "gulp all",
     "start-neo4j": "gulp start-neo4j",
     "stop-neo4j": "gulp stop-neo4j",

test/internal/bolt-stub.js

@@ -0,0 +1,132 @@
+/**
+ * Copyright (c) 2002-2017 "Neo Technology,","
+ * Network Engine for Objects in Lund AB [http://neotechnology.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import sharedNeo4j from './shared-neo4j';
+import neo4j from '../../src/v1/index';
+
+class UnsupportedBoltStub {
+
+  start(script, port) {
+    throw new Error('BoltStub: unable to start, unavailable on this platform');
+  }
+
+  startWithTemplate(scriptTemplate, parameters, port) {
+    throw new Error('BoltStub: unable to start with template, unavailable on this platform');
+  }
+
+  run(callback) {
+    throw new Error('BoltStub: unable to run, unavailable on this platform');
+  }
+}
+
+const verbose = false; // for debugging purposes
+
+class SupportedBoltStub extends UnsupportedBoltStub {
+
+  constructor() {
+    super();
+    this._childProcess = require('child_process');
+    this._mustache = require('mustache');
+    this._fs = require('fs');
+    this._tmp = require('tmp');
+  }
+
+  static create() {
+    try {
+      return new SupportedBoltStub();
+    } catch (e) {
+      return null;
+    }
+  }
+
+  start(script, port) {
+    const boltStub = this._childProcess.spawn('boltstub', ['-v', port, script]);
+
+    if (verbose) {
+      boltStub.stdout.on('data', (data) => {
+        console.log(`${data}`);
+      });
+      boltStub.stderr.on('data', (data) => {
+        console.log(`${data}`);
+      });
+      boltStub.on('end', data => {
+        console.log(data);
+      });
+    }
+
+    let exitCode = -1;
+    boltStub.on('close', code => {
+      exitCode = code;
+    });
+
+    boltStub.on('error', error => {
+      console.log('Failed to start child process:' + error);
+    });
+
+    return new StubServer(() => exitCode);
+  }
+
+  startWithTemplate(scriptTemplate, parameters, port) {
+    const template = this._fs.readFileSync(scriptTemplate, 'utf-8');
+    const scriptContents = this._mustache.render(template, parameters);
+    const script = this._tmp.fileSync().name;
+    this._fs.writeFileSync(script, scriptContents, 'utf-8');
+    return this.start(script, port);
+  }
+
+  run(callback) {
+    // wait to make sure boltstub is started before running user code
+    setTimeout(callback, 1000);
+  }
+}
+
+class StubServer {
+
+  constructor(exitCodeSupplier) {
+    this._exitCodeSupplier = exitCodeSupplier;
+    this.exit.bind(this);
+  }
+
+  exit(callback) {
+    // give process some time to exit
+    setTimeout(() => {
+      callback(this._exitCodeSupplier());
+    }, 1000);
+  }
+}
+
+function newDriver(url) {
+  // boltstub currently does not support encryption, create driver with encryption turned off
+  const config = {
+    encrypted: 'ENCRYPTION_OFF'
+  };
+  return neo4j.driver(url, sharedNeo4j.authToken, config);
+}
+
+const supportedStub = SupportedBoltStub.create();
+const supported = supportedStub != null;
+const stub = supported ? supportedStub : new UnsupportedBoltStub();
+
+export default {
+  supported: supported,
+  start: stub.start.bind(stub),
+  startWithTemplate: stub.startWithTemplate.bind(stub),
+  run: stub.run.bind(stub),
+  newDriver: newDriver
+};

test/resources/boltkit/acquire_endpoints.script renamed to test/resources/boltstub/acquire_endpoints.script

@@ -1,6 +1,6 @@
 !: AUTO RESET
 !: AUTO PULL_ALL
 
-C: INIT "neo4j-javascript/0.0.0-dev" {"credentials": "neo4j", "scheme": "basic", "principal": "neo4j"}
+C: INIT "neo4j-javascript/0.0.0-dev" {"credentials": "password", "scheme": "basic", "principal": "neo4j"}
 S: FAILURE {"code": "Neo.ClientError.Security.Unauthorized", "message": "Some server auth error message"}
 S: <EXIT>

test/resources/boltkit/acquire_endpoints_and_exit.script renamed to test/resources/boltstub/acquire_endpoints_and_exit.script

@@ -1,7 +1,7 @@
 !: AUTO RESET
 !: AUTO PULL_ALL
 
-C: INIT "neo4j-javascript/0.0.0-dev" {"credentials": "neo4j", "scheme": "basic", "principal": "neo4j"}
+C: INIT "neo4j-javascript/0.0.0-dev" {"credentials": "password", "scheme": "basic", "principal": "neo4j"}
 S: SUCCESS {"server": "Neo4j/8.8.8"}
 C: RUN "MATCH (n) RETURN n.name" {}
    PULL_ALL

test/resources/boltkit/acquire_endpoints_with_one_of_each.script renamed to test/resources/boltstub/acquire_endpoints_with_one_of_each.script

@@ -1,6 +1,5 @@
 !: AUTO INIT
 !: AUTO RESET
-!: AUTO RUN "RETURN 1 // JavaDriver poll to test connection" {}
 !: AUTO PULL_ALL
 
 C: RUN "RETURN {x}" {"x": 1}

test/resources/boltkit/address_unavailable_template.script.mst renamed to test/resources/boltstub/address_unavailable_template.script.mst

@@ -1,7 +1,7 @@
 !: AUTO RESET
 !: AUTO PULL_ALL
 
-C: INIT "neo4j-javascript/0.0.0-dev" {"credentials": "neo4j", "scheme": "basic", "principal": "neo4j"}
+C: INIT "neo4j-javascript/0.0.0-dev" {"credentials": "password", "scheme": "basic", "principal": "neo4j"}
 S: SUCCESS {"server": "Neo4j/9.9.9"}
 C: RUN "CREATE (n {name:'Bob'})" {}
    PULL_ALL