In jones-test, add a feature to disable tests.

In jones-ndb, disable some tests in the composition suite that are known to fail
because of features that have not been implemented.

Author: jdduncan

jones-ndb/test/disabled-tests.js

@@ -0,0 +1,26 @@
+/*
+ Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights
+ reserved.
+
+ This program is free software; you can redistribute it and/or
+ modify it under the terms of the GNU General Public License
+ as published by the Free Software Foundation; version 2 of
+ the License.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ 02110-1301  USA
+*/
+
+module.exports = function(driver) {
+  driver.disableTest("composition",  "QueryExtraProjectionTest.js", /.*/);
+  driver.disableTest("composition", "QueryScanProjectionTest.js", /.*/);
+};
+
+

jones-ndb/test/driver.js

@@ -1,5 +1,10 @@
 /*
- Copyright (c) 2013, 2016, Oracle and/or its affiliates. All rights reserved.
+ Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved.
+ 
+ This program is free software; you can redistribute it and/or
+ modify it under the terms of the GNU General Public License
+ as published by the Free Software Foundation; version 2 of
+ the License.
  
  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License, version 2.0,
@@ -40,9 +45,14 @@ driver.name = "ndb";
 global.test_conn_properties = properties;
 global.adapter              = "ndb";
 
-/* Find and run all tests */
+/* Find all tests */
 driver.addSuitesFromDirectory(jones.fs.suites_dir);
 driver.addSuitesFromDirectory(jonesMysql.config.suites_dir);
 driver.addSuitesFromDirectory(jonesNdb.config.suites_dir);
+
+/* Disable some tests */
+driver.disableTestsFromFile(jonesNdb.config.suites_dir, "disabled-tests.js");
+
+/* Run tests */
 driver.runAllTests();
 

jones-test/API-Documentation/Driver.md

@@ -93,6 +93,22 @@ function addSuiteFromFile(suitename, filename);
 function addSuitesFromDirectory(directory);
 ```
 
+### Disabling tests
+```JavaScript
+/* In file testFileName in suite suiteName,
+   disable all tests matching testNamePattern (which must be a RegExp)
+*/
+function disableTest(suiteName, testFileName, testNamePattern);
+
+
+/* Specify disabled tests in a file.
+   The file is a JavaScript source file read using require().
+   It should export a single function which calls driver.disableTest()
+   for each test to be disabled.
+*/
+function disableTestsFromFile(directoryName, fileName);
+```
+
 
 ### Creating Lint Tests
 ```JavaScript

jones-test/lib/Driver.js

@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2012, 2015 Oracle and/or its affiliates. All rights
+ Copyright (c) 2012, 2018 Oracle and/or its affiliates. All rights
  reserved.
  
  This program is free software; you can redistribute it and/or
@@ -160,6 +160,20 @@ Driver.prototype.listSuites = function() {
   });
 };
 
+Driver.prototype.disableTest = function(suiteName, fileName, testNamePattern) {
+  this.suites.forEach(function(s) {
+    if(s.name == suiteName) {
+      s.disableTest(fileName, testNamePattern);
+    }
+  });
+};
+
+Driver.prototype.disableTestsFromFile = function(dir, f) {
+  var file = path.join(dir, f);
+  var disablerFunction = require(file);
+  disablerFunction(this);
+};
+
 Driver.prototype.testCompleted = function(testCase) {
   var suite = testCase.suite;
   if (suite.testCompleted(testCase)) {

jones-test/lib/Suite.js

@@ -1,5 +1,5 @@
-/*
- Copyright (c) 2012, 2015 Oracle and/or its affiliates. All rights
+ /*
+ Copyright (c) 2012, 2018 Oracle and/or its affiliates. All rights
  reserved.
  
  This program is free software; you can redistribute it and/or
@@ -37,6 +37,7 @@ function Suite(driver, name, suiteDir) {
   this.path = "";
 
   this.tests = [];
+  this.disabledTests = {};
   this.smokeTest = {};
   this.smokeTestHasFailed = null;
   this.serialTests = [];
@@ -63,16 +64,23 @@ Suite.prototype.addTest = function(filename, test) {
   test.filename = path.resolve(this.path, filename);
   test.suite = this;
   test.reset();
-  this.tests.push(test);  // should check if test has been disabled
+  this.tests.push(test);
+  if(this.disabledTests[filename] &&
+     this.disabledTests[filename].test(test.name))
+        test.enabled = false;
+ };
+
+Suite.prototype.disableTest = function(fileName, testNamePattern) {
+  this.disabledTests[fileName] = testNamePattern;
 };
 
-/* addTestsFromFile(f, onlyTests)
-   f is a fully resolved pathname
-   onlyTests is a string containing a comma separated list of 
+/* addTestsFromFile(fileName, onlyTests)
+   onlyTests is a string containing a comma separated list of
    test numbers.  If set, only those elements of the test array are added.
 */
-Suite.prototype.addTestsFromFile = function(f, onlyTests) {
-  var t, i, j, k, testList, testHash;
+Suite.prototype.addTestsFromFile = function(fileName, onlyTests) {
+  var f, t, i, j, k, testList, testHash;
+  f = path.join(this.path, fileName);
   if(onlyTests) {
     onlyTests = String(onlyTests);
     testList = onlyTests.split(",");
@@ -82,17 +90,17 @@ Suite.prototype.addTestsFromFile = function(f, onlyTests) {
       testHash[k] = 1;
     }
   }
-  if(re_matching_test_case.test(f)) {
+  if(re_matching_test_case.test(fileName)) {
     t = require(f);
     if(typeof(t.tests) === 'object' && t.tests instanceof Array) {
       for(j = 0 ; j < t.tests.length ; j++) {
         if(onlyTests === null || testHash[j] === 1) {
-          this.addTest(f, t.tests[j]);
+          this.addTest(fileName, t.tests[j]);
         }
       }
     }      
     else if(typeof(t.isTest) === 'function' && t.isTest()) {
-      this.addTest(f, t);
+      this.addTest(fileName, t);
     }
     else { 
       console.log("Warning: " + f + " does not export a Test.");
@@ -110,17 +118,17 @@ Suite.prototype.createTests = function() {
       var testFile = this.path;
       this.path = path.dirname(testFile);
       try {
-        this.addTestsFromFile(path.join(this.path, "SmokeTest.js"), null);
+        this.addTestsFromFile("SmokeTest.js", null);
       } catch(ignore) {}
       this.addTestsFromFile(testFile, this.driver.testInFile);
       try {
-        this.addTestsFromFile(path.join(this.path, "ClearSmokeTest.js"), null);
+        this.addTestsFromFile("ClearSmokeTest.js", null);
       } catch(ignore) {}
     }
     else if(stat.isDirectory()) {
       var files = fs.readdirSync(this.path);
       for(i = 0; i < files.length ; i++) {
-        this.addTestsFromFile(path.join(this.path, files[i]), null);
+        this.addTestsFromFile(files[i], null);
       }
     }
   }

jones-test/lib/Test.js

@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2012, 2015 Oracle and/or its affiliates. All rights
+ Copyright (c) 2012, 2018 Oracle and/or its affiliates. All rights
  reserved.
  
  This program is free software; you can redistribute it and/or
@@ -37,11 +37,18 @@ function Test() {
   this.failed   = null;     // will be set to true by fail(), or false by pass()
   this.skipped  = false;
   this.result   = null;     // will be set by Test.test()
+  this.enabled  = true;
 }
 
 Test.prototype.test = function(result) {
   var runReturnCode;
   this.result = result;
+
+  if(! this.enabled) {
+    this.result.skipNotStarted(this, "disabled");
+    return;
+  }
+
   result.startTest(this);
 
   udebug.log("Starting test", this.name);