Merge pull request #36 from neo4j/1.0-tck

1.0 tck - ResultSummary API and Equality

Author: pontusmelke

gulpfile.js

@@ -204,8 +204,8 @@ gulp.task('download-tck', function() {
 gulp.task('run-tck', ['download-tck', 'nodejs'], function() {
     return gulp.src(featureHome + "/*").pipe(cucumber({
         'steps': 'test/v1/tck/steps/*.js',
-        'format': 'summary',
-        'tags' : ['~@in_dev', '~@db']
+        'format': 'pretty',
+        'tags' : ['~@in_dev', '~@db', '~@equality']
     }));
 });
 

src/v1/internal/ch-node.js

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
- 
+
 import net from 'net';
 import tls from 'tls';
 import fs from 'fs';
@@ -210,7 +210,7 @@ class NodeChannel {
       this.onerror(err);
     }
   }
-  
+
   /**
    * Write the passed in buffer to connection
    * @param {NodeBuffer} buffer - Buffer to write

test/v1/tck/steps/environment.js

@@ -19,6 +19,10 @@ module.exports = function () {
     callback();
   });
 
+  this.Before("@equality_test", function( scenario ) {
+    this.savedValues = {}
+  });
+
   this.After(function (scenario, callback) {
     if (!scenario.isSuccessful()) {
       failedScenarios.push(scenario)

test/v1/tck/steps/matchacceptencesteps.js

@@ -3,15 +3,15 @@ var util = require("./util")
 
 module.exports = function () {
 
-  this.Given(/^init:(.*)$/, function (statement) {
+  this.Given(/^init: (.*)$/, function (statement) {
     return this.session.run(statement);
   });
 
-  this.When(/^running:(.*)$/, function (statement) {
+  this.When(/^running: (.*)$/, function (statement) {
       this.rc = this.session.run(statement);
   });
 
-  this.When(/^running parametrized:(.*)$/, function (statement, table) {
+  this.When(/^running parametrized: (.*)$/, function (statement, table) {
     var param = util.literalTableToTestObject(table.hashes())[0];
     this.rc = this.session.run(statement, param);
   });

test/v1/tck/steps/resultapisteps.js

@@ -0,0 +1,219 @@
+var neo4j = require("../../../../lib/v1");
+var resultSummary = require("../../../../lib/v1/result-summary");
+var util = require("./util")
+
+module.exports = function () {
+
+  this.When(/^the `Statement Result` is consumed a `Result Summary` is returned$/, function (callback) {
+    self = this;
+    this.rc.then(function(res) {
+      self.summary = res.summary;
+      callback();
+    }).catch(function(err) {callback(new Error("Rejected Promise: " + err))});
+  });
+
+  this.Then(/^the `Statement Result` is closed$/, function () {
+    //No result cursor in JavaScript Driver
+  });
+
+  this.When(/^I request a `Statement` from the `Result Summary`$/, function () {
+    this.statement = this.summary.statement
+  });
+
+  this.Then(/^requesting the `Statement` as text should give: (.*)$/, function (statementText) {
+    if (this.statement.text != statementText) {
+      throw Error("'" + this.statement.text + "' does not match expected text: '" + statementText + "'")
+    }
+  });
+
+  this.Then(/^requesting the `Statement` parameter should give: (.*)$/, function (statementParam) {
+    var param = util.literalValueToTestValue(statementParam);
+    if (typeof this.statement.parameters === 'undefined') {
+      this.statement.parameters = {}
+    }
+    if (!util.compareValues(this.statement.parameters, param)) {
+        throw Error("Params does not match! Got: " + this.statement.parameters + " Expected: " + param);
+    }
+  });
+
+  this.Then(/^requesting `Counters` from `Result Summary` should give$/, function (table) {
+    var updateStatistics = this.summary.updateStatistics
+    for ( var i = 0 ; i < table.hashes().length; i++) {
+      var statistic = table.hashes()[i].counter;
+      var expected = util.literalValueToTestValueNormalIntegers(table.hashes()[i].result);
+      var given = getStatistic(statistic, updateStatistics)
+      if (!util.compareValues(given, expected)) {
+        throw Error("Statistics for: " + statistic + " does not match. Expected: '" + expected + "' Given: '" + given + "'");
+      }
+    }
+  });
+
+  this.Then(/^requesting the `Statement Type` should give (.*)$/, function (type) {
+    var type = getStatementTypeFromString(type);
+    if (this.summary.statementType != type)
+    {
+      throw Error("statementType does not match. Expected: '" + type + "' Given: '" + this.summary.statementType + "'");
+    }
+  });
+
+  this.Then(/^the `Result Summary` has a `Plan`$/, function () {
+    if(! this.summary.hasPlan()) {
+      throw Error("Expected summary to have a `plan`. It did not...");
+    }
+  });
+
+  this.Then(/^the `Result Summary` does not have a `Plan`$/, function () {
+    if(this.summary.hasPlan()) {
+      throw Error("Expected summary to NOT have a `plan`. It did not...");
+    }
+  });
+
+  this.Then(/^the `Result Summary` has a `Profile`$/, function () {
+    if(! this.summary.hasProfile()) {
+      throw Error("Expected summary to have a `profile plan`. It did not...");
+    }
+  });
+
+  this.Then(/^the `Result Summary` does not have a `Profile`$/, function () {
+    if( this.summary.hasProfile()) {
+      throw Error("Expected summary to NOT have a `profile plan`. It did...");
+    }
+  });
+
+  this.Then(/^requesting the `Plan` it contains$/, function (table) {
+    checkPlanExact(table, this.summary.plan)
+  });
+
+  this.Then(/^the `Plan` also contains method calls for:$/, function (table) {
+    checkPlan(table, this.summary.plan)
+  });
+
+  this.Then(/^requesting the `Profile` it contains:$/, function (table) {
+    checkPlanExact(table, this.summary.profile)
+});
+
+this.Then(/^the `Profile` also contains method calls for:$/, function (table) {
+  checkPlan(table, this.summary.profile)
+});
+
+this.Then(/^the `Result Summary` `Notifications` is empty$/, function () {
+  if (! this.summary.notifications.length == 0) {
+    throw Error("Expected no notifications. Got: " + this.summary.notifications.length)
+  }
+});
+
+this.Then(/^the `Result Summary` `Notifications` has one notification with$/, function (table) {
+
+  var expected = {};
+  if (this.summary.notifications.length > 1) {
+    throw Error("Expected only one notification. Got: " + this.summary.notifications.length)
+  }
+  var givenNotification = this.summary.notifications[0];
+  var given = {}
+  for ( var i = 0 ; i < table.hashes().length; i++) {
+    var key = table.hashes()[i]['key']
+    expected[key] = util.literalValueToTestValueNormalIntegers(table.hashes()[i]['value']);
+    given[key] = givenNotification[key]
+  }
+  if (Object.keys(givenNotification).length !== Object.keys(given).length) {
+    throw Error("Keys do not match with expected. Got: " + Object.keys(givenNotification) + " Expected: " + Object.keys(given))
+  }
+  if (!util.compareValues(expected, given)) {
+    throw Error("Summary notifications does not match. Expected: '" + util.printable(expected) + "' Given: '" + util.printable(givenNotification) + "'");
+  }
+});
+
+  function checkPlanExact(table, plan)
+  {
+    for ( var i = 0 ; i < table.hashes().length; i++) {
+      var dataKey = getPlanParam(table.hashes()[i]["plan method"])
+      var given = plan[dataKey];
+      if (given === undefined || given === null || given === NaN) {
+        throw Error("Plans `" + dataKey + "` has no content! Got: " + given);
+      }
+    }
+  }
+
+  function checkPlan(table, plan)
+  {
+    for ( var i = 0 ; i < table.hashes().length; i++) {
+      var dataKey = getPlanParam(table.hashes()[i]["plan method"])
+      var given = plan[dataKey];
+      if (given === undefined || given === null || given === NaN) {
+        throw Error("Plans `" + dataKey + "` has no content! Got: " + given);
+      }
+    }
+  }
+
+  function getPlanParam(key) {
+    if (key == 'operator type') {
+      return 'operatorType'
+    }
+    if (key == 'db hits') {
+      return 'dbHits'
+    }
+    if (key == 'records') {
+      return 'rows'
+    }
+    else {
+      return key
+    }
+  }
+
+  function getStatementTypeFromString(type) {
+    if (type == 'read write') {
+      return resultSummary.statementType.READ_WRITE;
+    }
+    if (type == 'read only') {
+      return resultSummary.statementType.READ_ONLY;
+    }
+    if (type == 'write only') {
+      return resultSummary.statementType.WRITE_ONLY;
+    }
+    if (type == 'schema write') {
+      return resultSummary.statementType.SCHEMA_WRITE;
+    }
+    throw Error("No statement type mapping of: " + type)
+  }
+
+  function getStatistic(statementString, updateStatistics) {
+    if (statementString == 'nodes created') {
+      return updateStatistics.nodesCreated();
+    }
+    if (statementString == 'nodes deleted') {
+      return updateStatistics.nodesDeleted();
+    }
+    if (statementString == 'relationships created') {
+      return updateStatistics.relationshipsCreated();
+    }
+    if (statementString == 'relationships deleted') {
+      return updateStatistics.relationshipsDeleted();
+    }
+    if (statementString == 'properties set') {
+      return updateStatistics.propertiesSet();
+    }
+    if (statementString == 'labels added') {
+      return updateStatistics.labelsAdded();
+    }
+    if (statementString == 'labels removed') {
+      return updateStatistics.labelsRemoved();
+    }
+    if (statementString == 'indexes added') {
+      return updateStatistics.indexesAdded();
+    }
+    if (statementString == 'indexes removed') {
+      return updateStatistics.indexesRemoved();
+    }
+    if (statementString == 'constraints added') {
+      return updateStatistics.constraintsAdded();
+    }
+    if (statementString == 'constraints removed') {
+      return updateStatistics.constraintsRemoved();
+    }
+    if (statementString == 'contains updates') {
+      return updateStatistics.containsUpdates();
+    }
+    throw Error("No statistics mapping of: " + statementString)
+  }
+
+}

test/v1/tck/steps/util.js

@@ -11,6 +11,7 @@ PATH = 'path';
 
 module.exports = {
   literalTableToTestObject: literalTableToTestObject,
+  literalValueToTestValueNormalIntegers : literalValueToTestValueNormalIntegers,
   literalValueToTestValue: literalValueToTestValue,
   compareValues: compareValues,
   sizeOfObject: sizeOfObject,
@@ -35,12 +36,20 @@ function literalLineToObjects(resultRow) {
   return resultObject;
 }
 
+function literalValueToTestValueNormalIntegers(values) {
+  return literalValueToTestObject(values, false)
+}
+
 function literalValueToTestValue(values) {
+  return literalValueToTestObject(values, true)
+}
+
+function literalValueToTestObject(values, bigInt) {
   if (isLiteralArray(values)) {
     values = getLiteralArray(values);
   }
   if (isLiteralMap(values)) {
-    return getProperties(values);
+    return parseMap(values, bigInt);
   }
   if (values instanceof Array) {
     var res = [];
@@ -49,12 +58,12 @@ function literalValueToTestValue(values) {
     }
   }
   else {
-     var res = convertValue(values);
+     var res = convertValue(values, bigInt);
   }
   return res;
 }
 
-function convertValue(value) {
+function convertValue(value, bigInt) {
   if (value === NULL) {
     return null;
   }
@@ -74,7 +83,13 @@ function convertValue(value) {
     return createPath(value);
   }
   if (value.match( "^(-?[0-9]+)$")) {
-    return neo4j.int(value)
+    if (bigInt)
+    {
+      return neo4j.int(value)
+    }
+    else {
+      return parseInt(value)
+    }
   }
   return parseFloat(value);
 }
@@ -159,19 +174,29 @@ function parseNodesAndRelationshipsFromPath(val) {
   return nodesAndRels;
 }
 
+function parseMap(val, bigInt) {
+  if (bigInt)
+  {
+    return properties = JSON.parse(val, function(k, v) {
+      if (Number.isInteger(v)) {
+        return neo4j.int(v);
+      }
+      return v;
+    });
+  }
+  else {
+    return properties = JSON.parse(val);
+  }
+}
+
 function getProperties(val) {
   var startIndex = val.indexOf("{");
   var endIndex = val.indexOf("}");
   if (!(startIndex >= 0 && endIndex >= 0)) {
     return {};
   }
   val = val.substring(startIndex, endIndex + 1);
-  return properties = JSON.parse(val, function(k, v) {
-    if (Number.isInteger(v)) {
-      return neo4j.int(v);
-    }
-    return v;
-  });
+  return parseMap(val, true)
 }
 
 function printable(array) {