Merge pull request #251 from kberg/auto-tests
authorDan Vanderkam <danvdk@gmail.com>
Mon, 3 Jun 2013 01:26:51 +0000 (18:26 -0700)
committerDan Vanderkam <danvdk@gmail.com>
Mon, 3 Jun 2013 01:26:51 +0000 (18:26 -0700)
Nicer auto tests

auto_tests/misc/fake-jstestdriver.js
auto_tests/misc/local.html
auto_tests/misc/local.js [new file with mode: 0644]

index 6f4f464..404d165 100644 (file)
  * @author konigsberg@google.com (Robert Konigsberg)
  */
 var jstestdriver = {
-  jQuery : jQuery
+  jQuery : jQuery,
+  listeners_ : [],
+  announce_ : function(name, args) {
+    for (var idx = 0; idx < jstestdriver.listeners_.length; idx++) {
+      var listener = jstestdriver.listeners_[idx];
+      if (listener[name]) {
+        listener[name].apply(null, args);
+      }
+    }
+  },
+  attachListener: function(listener) {
+    jstestdriver.listeners_.push(listener);
+  }
 };
 
 if (!console) {
@@ -55,6 +67,7 @@ function TestCase(name) {
 
   testCase.prototype.setUp = function() { };
   testCase.prototype.tearDown = function() { };
+  testCase.prototype.name = name;
   /**
    * name can be a string, which is looked up in this object, or it can be a
    * function, in which case it's run.
@@ -68,29 +81,34 @@ function TestCase(name) {
    * Chrome's console completion.
    */
   testCase.prototype.runTest = function(func) {
+    var result = false;
+    var ex = null;
+    var name = typeof(func) == "string" ? func : "(anonymous function)";
+    jstestdriver.announce_("start", [this, name]);
     try {
-      this.setUp();
-
-      var fn = null;
-      var parameterType = typeof(func);
-      if (typeof(func) == "function") {
-        fn = func;
-      } else if (typeof(func) == "string") {
-        fn = this[func];
-      } else {
-        fail("can't supply " + typeof(func) + " to runTest");
-      }
-
-      fn.apply(this, []);
-      this.tearDown();
-      return true;
+      result = this.runTest_(func);
     } catch (e) {
-      console.log(e);
-      if (e.stack) {
-        console.log(e.stack);
-      }
-      return false;
+      ex = e;
     }
+    jstestdriver.announce_("finish", [this, name, result, ex]);
+  }
+
+  testCase.prototype.runTest_ = function(func) {
+    this.setUp();
+
+    var fn = null;
+    var parameterType = typeof(func);
+    if (typeof(func) == "function") {
+      fn = func;
+    } else if (typeof(func) == "string") {
+      fn = this[func];
+    } else {
+      fail("can't supply " + typeof(func) + " to runTest");
+    }
+
+    fn.apply(this, []);
+    this.tearDown();
+    return true;
   };
 
   testCase.prototype.runAllTests = function() {
@@ -152,3 +170,15 @@ function addGlobalTestSymbols() {
 function getAllTestCases() {
   return testCaseList;
 }
+
+jstestdriver.attachListener({
+  finish : function(tc, name, result, e) {
+    if (e) {
+      console.log(e);
+      if (e.stack) {
+        console.log(e.stack);
+      }
+    }
+  }
+});
+
index e168de0..6bdb547 100644 (file)
@@ -17,6 +17,7 @@
   <script type="text/javascript" src="../tests/DygraphOps.js"></script>
   <script type="text/javascript" src="../tests/PixelSampler.js"></script>
   <script type="text/javascript" src="../tests/Util.js"></script>
+  <script type="text/javascript" src="local.js"></script>
 
   <!-- Scripts for automated tests -->
   <script type="text/javascript" src="../tests/annotations.js"></script>
     text-decoration: none;
   }
 </style>
-  <script type="text/javascript">
-
-  // save Dygraph.warn so we can catch warnings.
-  if (false) { // Set true if you want warnings to cause failures.
-    var originalDygraphWarn = Dygraph.warn;
-    Dygraph.warn = function(msg) {
-      if (msg == "Using default labels. Set labels explicitly via 'labels' in the options parameter") {
-        originalDygraphWarn(msg);
-        return;
-      }
-      throw "Warnings not permitted: " + msg;
-    }
-    Dygraph.prototype.warn = Dygraph.warn;
-  }
-
-  var tc = null; // Selected test case
-  var name = null; 
-
-  var resultDiv = null;
-
-  function processVariables() {
-    var splitVariables = function() { // http://www.idealog.us/2006/06/javascript_to_p.html
-      var query = window.location.search.substring(1); 
-      var args = {};
-      var vars = query.split("&"); 
-      for (var i = 0; i < vars.length; i++) { 
-        if (vars[i].length > 0) {
-          var pair = vars[i].split("="); 
-          args[pair[0]] = pair[1];
-        }
-      }
-      return args;
-    }
-
-    var args = splitVariables();
-    var test = args.test;
-    var command = args.command;
-
-    // args.testCaseName uses the string name of the test.
-    if (args.testCaseName) {
-      var testCases = getAllTestCases();
-      name = args.testCaseName;
-      for (var idx in testCases) {
-        var entry = testCases[idx];
-        if (entry.name == args.testCaseName) {
-          var prototype = entry.testCase;
-          tc = new entry.testCase();
-          break;
-        }
-      }
-    } else if (args.testCase) { // The class name of the test.
-      name = args.testCase;
-      eval("tc = new " + args.testCase + "()");
-    }
-
-    var results = null;
-    // If the test class is defined.
-    if (tc != null) {
-      if (args.command == "runAllTests") {
-        console.log("Running all tests for " + args.testCase);
-        results = tc.runAllTests();
-      } else if (args.command == "runTest") {
-        console.log("Running test " + args.testCase + "." + args.test);
-        results = tc.runTest(args.test);
-      }
-    } else {
-      if (args.command == "runAllTests") {
-        console.log("Running all tests for all test cases");
-        var testCases = getAllTestCases();
-        results = {};
-        for (var idx in testCases) {
-          var entry = testCases[idx];
-          var prototype = entry.testCase;
-          tc = new entry.testCase();
-          results[entry.name] = tc.runAllTests();
-        }
-      }
-    }
-    resultsDiv = createResultsDiv();
-    var summary = { failed: 0, passed: 0 };
-    postResults(results, summary);
-    resultsDiv.appendChild(document.createElement("hr"));
-    document.getElementById('summary').innerHTML = "(" + summary.failed + " failed, " + summary.passed + " passed)";
-  }
-
-  function createResultsDiv() {
-    var body = document.getElementsByTagName("body")[0];
-    div = document.createElement("div");
-    div.id='results';
-    div.innerHTML = "Test results: <span id='summary'></span> <a href='#' id='passed'>passed</a> <a href='#' id='failed'>failed</a> <a href='#' id='all'>all</a><br/>";
-    body.insertBefore(div, body.firstChild);
-
-    var setByClassName = function(name, displayStyle) {
-      var elements = div.getElementsByClassName(name);
-      for (var i = 0; i < elements.length; i++) {
-        elements[i].style.display = displayStyle;
-      }
-    }
-
-    var passedAnchor = document.getElementById('passed');
-    var failedAnchor = document.getElementById('failed');
-    var allAnchor = document.getElementById('all');
-    passedAnchor.onclick = function() {
-      setByClassName('fail', 'none');
-      setByClassName('pass', 'block');
-
-      passedAnchor.setAttribute("class", 'activeAnchor');
-      failedAnchor.setAttribute("class", '');
-    };
-    failedAnchor.onclick = function() {
-      setByClassName('fail', 'block');
-      setByClassName('pass', 'none');
-      passedAnchor.setAttribute("class", '');
-      failedAnchor.setAttribute("class", 'activeAnchor');
-    };
-    allAnchor.onclick = function() {
-      setByClassName('fail', 'block');
-      setByClassName('pass', 'block');
-      passedAnchor.setAttribute("class", '');
-      failedAnchor.setAttribute("class", '');
-    };
-    return div;
-  }
-
-  function postResults(results, summary, title) {
-    if (typeof(results) == "boolean") {
-      var elem = document.createElement("div");
-      elem.setAttribute("class", results ? 'pass' : 'fail');
-
-      var prefix = title ? (title + ": ") : "";
-      elem.innerHTML = prefix + '<span class=\'outcome\'>' + (results ? 'pass' : 'fail') + '</span>';
-      resultsDiv.appendChild(elem);
-      if (results) {
-        summary.passed++;
-      } else {
-        summary.failed++;
-      }
-    } else { // hash
-      var failed = 0;
-      var html = "";
-      for (var key in results) {
-        if (results.hasOwnProperty(key)) {
-          var elem = results[key];
-          if (typeof(elem) == "boolean" && title) {
-            postResults(results[key], summary, title + "." + key);
-          } else {
-            postResults(results[key], summary, key);
-          }
-        }
-      }
-    }
-  }
-
-  </script>
 </head>
 <body>
   <div id='graph'></div>
   Example: <code>local.html?testCase=ScrollingDivTestCase&test=testNestedDiv_Scrolled&command=runTest</code>
   <p/>
 </body>
-<script>
-processVariables();
-addGlobalTestSymbols();
-
-var selector = document.getElementById("selector");
-
-if (selector != null) { // running a test
-  var createAttached = function(name, parent) {
-    var elem = document.createElement(name);
-    parent.appendChild(elem);
-    return elem;
-  }
-
-  var description = createAttached("div", selector);
-  var list = createAttached("ul", selector);
-  var parent = list.parentElement;
-  var createLink = function(parent, text, url) {
-    var li = createAttached("li", parent);
-    var a = createAttached("a", li);
-    a.innerHTML = text;
-    a.href = url;
-  }
-  if (tc == null) {
-    description.innerHTML = "Test cases:";
-    var testCases = getAllTestCases();
-    createLink(list, "(run all tests)", document.URL + "?command=runAllTests");
-    for (var idx in testCases) {
-      var entryName = testCases[idx].name;
-      createLink(list, entryName, document.URL + "?testCaseName=" + entryName);
-    }
-  } else {
-    description.innerHTML = "Tests for " + name;
-    var names = tc.getTestNames();
-    createLink(list, "Run All Tests", document.URL + "&command=runAllTests");
-    for (var idx in names) {
-      var name = names[idx];
-      createLink(list, name, document.URL + "&test=" + name + "&command=runTest");
-    }
-  }
-}
+<script type="text/javascript">
+  var tester = new DygraphsLocalTester();
+  // tester.overrideWarn(); // uncomment if you want warnings to be errors.
+  tester.processVariables();
+  addGlobalTestSymbols();
+  tester.run();
 </script>
 </html>
diff --git a/auto_tests/misc/local.js b/auto_tests/misc/local.js
new file mode 100644 (file)
index 0000000..e8414ae
--- /dev/null
@@ -0,0 +1,218 @@
+var DygraphsLocalTester = function() {
+  this.tc = null; // Selected test case
+  this.name = null; 
+  this.resultsDiv = null;
+  this.results = [];
+  this.summary = { failed: 0, passed: 0 };
+
+  var self = this;
+  jstestdriver.attachListener({
+    start : function(tc) {
+      self.start_(tc);
+    },
+    finish : function(tc, name, result, e) {
+      self.finish_(tc, name, result, e);
+    }
+  });
+};
+
+/**
+ * Call this to replace Dygraphs.warn so it throws an error.
+ *
+ * In some cases we will still allow warnings to be warnings, however.
+ */
+DygraphsLocalTester.prototype.overrideWarn = function() {
+  // save Dygraph.warn so we can catch warnings.
+  var originalDygraphWarn = Dygraph.warn;
+  Dygraph.warn = function(msg) {
+    // This warning is still
+    if (msg == "Using default labels. Set labels explicitly via 'labels' in the options parameter") {
+      originalDygraphWarn(msg);
+      return;
+    }
+    throw "Warnings not permitted: " + msg;
+  }
+  Dygraph.prototype.warn = Dygraph.warn;
+};
+
+DygraphsLocalTester.prototype.processVariables = function() {
+  var splitVariables = function() { // http://www.idealog.us/2006/06/javascript_to_p.html
+    var query = window.location.search.substring(1); 
+    var args = {};
+    var vars = query.split("&"); 
+    for (var i = 0; i < vars.length; i++) { 
+      if (vars[i].length > 0) {
+        var pair = vars[i].split("="); 
+        args[pair[0]] = pair[1];
+      }
+    }
+    return args;
+  }
+
+  var args = splitVariables();
+  var test = args.test;
+  var command = args.command;
+
+  // args.testCaseName uses the string name of the test.
+  if (args.testCaseName) {
+    var testCases = getAllTestCases();
+    name = args.testCaseName;
+    for (var idx in testCases) {
+      var entry = testCases[idx];
+      if (entry.name == args.testCaseName) {
+        var prototype = entry.testCase;
+        this.tc = new entry.testCase();
+        break;
+      }
+    }
+  } else if (args.testCase) { // The class name of the test.
+    name = args.testCase;
+    eval("tc__= new " + args.testCase + "()");
+    this.tc = tc_;
+  }
+
+  // If the test class is defined.
+  if (this.tc != null) {
+    if (args.command == "runAllTests") {
+      console.log("Running all tests for " + args.testCase);
+      this.tc.runAllTests();
+    } else if (args.command == "runTest") {
+      console.log("Running test " + args.testCase + "." + args.test);
+      this.tc.runTest(args.test);
+    }
+  } else {
+    if (args.command == "runAllTests") {
+      console.log("Running all tests for all test cases");
+      var testCases = getAllTestCases();
+      for (var idx in testCases) {
+        var entry = testCases[idx];
+        var prototype = entry.testCase;
+        this.tc = new entry.testCase();
+        this.tc.runAllTests();
+      }
+    }
+  }
+  this.resultsDiv = this.createResultsDiv();
+  this.postResults();
+  this.resultsDiv.appendChild(document.createElement("hr"));
+  document.getElementById('summary').innerHTML = "(" + this.summary.failed + " failed, " + this.summary.passed + " passed)";
+}
+
+DygraphsLocalTester.prototype.createResultsDiv = function() {
+  div = document.createElement("div");
+  div.id='results';
+  div.innerHTML = "Test results: <span id='summary'></span> <a href='#' id='passed'>passed</a> <a href='#' id='failed'>failed</a> <a href='#' id='all'>all</a><br/>";
+
+  var body = document.getElementsByTagName("body")[0];
+  body.insertBefore(div, body.firstChild);
+
+  var setByClassName = function(name, displayStyle) {
+    var elements = div.getElementsByClassName(name);
+    for (var i = 0; i < elements.length; i++) {
+      elements[i].style.display = displayStyle;
+    }
+  }
+
+  var passedAnchor = document.getElementById('passed');
+  var failedAnchor = document.getElementById('failed');
+  var allAnchor = document.getElementById('all');
+  passedAnchor.onclick = function() {
+    setByClassName('fail', 'none');
+    setByClassName('pass', 'block');
+
+    passedAnchor.setAttribute("class", 'activeAnchor');
+    failedAnchor.setAttribute("class", '');
+  };
+  failedAnchor.onclick = function() {
+    setByClassName('fail', 'block');
+    setByClassName('pass', 'none');
+    passedAnchor.setAttribute("class", '');
+    failedAnchor.setAttribute("class", 'activeAnchor');
+  };
+  allAnchor.onclick = function() {
+    setByClassName('fail', 'block');
+    setByClassName('pass', 'block');
+    passedAnchor.setAttribute("class", '');
+    failedAnchor.setAttribute("class", '');
+  };
+  return div;
+}
+
+DygraphsLocalTester.prototype.postResults = function() {
+  var table = document.createElement("table");
+  this.resultsDiv.appendChild(table);
+  for (var idx = 0; idx < this.results.length; idx++) {
+    var result = this.results[idx];
+    var tr = document.createElement("tr");
+    tr.setAttribute("class", result.result ? 'pass' : 'fail');
+
+    var tdResult = document.createElement("td");
+    tdResult.setAttribute("class", "outcome");
+    tdResult.innerText = result.result ? 'pass' : 'fail';
+    tr.appendChild(tdResult);
+
+    var tdName = document.createElement("td");
+    tdName.innerText = result.name;
+    tr.appendChild(tdName);
+
+    var tdDuration = document.createElement("td");
+    tdDuration.innerText = result.duration;
+    tr.appendChild(tdDuration);
+
+    table.appendChild(tr);
+  }
+}
+
+DygraphsLocalTester.prototype.run = function() {
+  var selector = document.getElementById("selector");
+
+  if (selector != null) { // running a test
+    var createAttached = function(name, parent) {
+      var elem = document.createElement(name);
+      parent.appendChild(elem);
+      return elem;
+    }
+  
+    var description = createAttached("div", selector);
+    var list = createAttached("ul", selector);
+    var parent = list.parentElement;
+    var createLink = function(parent, text, url) {
+      var li = createAttached("li", parent);
+      var a = createAttached("a", li);
+      a.innerHTML = text;
+      a.href = url;
+    }
+    if (this.tc == null) {
+      description.innerHTML = "Test cases:";
+      var testCases = getAllTestCases();
+      createLink(list, "(run all tests)", document.URL + "?command=runAllTests");
+      for (var idx in testCases) {
+        var entryName = testCases[idx].name;
+        createLink(list, entryName, document.URL + "?testCaseName=" + entryName);
+      }
+    } else {
+      description.innerHTML = "Tests for " + name;
+      var names = this.tc.getTestNames();
+      createLink(list, "Run All Tests", document.URL + "&command=runAllTests");
+      for (var idx in names) {
+        var name = names[idx];
+        createLink(list, name, document.URL + "&test=" + name + "&command=runTest");
+      }
+    }
+  }
+}
+
+DygraphsLocalTester.prototype.start_ = function(tc) {
+  this.startms_ = new Date().getTime();
+}
+
+DygraphsLocalTester.prototype.finish_ = function(tc, name, result, e) {
+  var endms_ = new Date().getTime();
+  this.results.push({
+    name : tc.name + "." + name,
+    result : result,
+    duration : endms_ - this.startms_
+  });
+  this.summary.passed += result ? 1 : 0;
+  this.summary.failed += result ? 0 : 1;
+}