From 846038aad4815feec55d2e86b8ccfad7dc1019b6 Mon Sep 17 00:00:00 2001
From: Robert Konigsberg <konigsberg@gmail.com>
Date: Sat, 8 Dec 2012 18:24:52 -0500
Subject: [PATCH] Centralize utility methods in automated tests.

---
 auto_tests/misc/local.html                 |  19 +++---
 auto_tests/tests/Util.js                   |  27 +++++++-
 auto_tests/tests/axis_labels-deprecated.js |  65 ++++++-------------
 auto_tests/tests/axis_labels.js            | 100 ++++++++++++-----------------
 4 files changed, 95 insertions(+), 116 deletions(-)

diff --git a/auto_tests/misc/local.html b/auto_tests/misc/local.html
index d5b697e..fc74332 100644
--- a/auto_tests/misc/local.html
+++ b/auto_tests/misc/local.html
@@ -72,15 +72,16 @@
   <script type="text/javascript">
 
   // save Dygraph.warn so we can catch warnings.
-  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;
+  // Disabled for now.
+  // 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; 
diff --git a/auto_tests/tests/Util.js b/auto_tests/tests/Util.js
index 7ab0b9a..7fca030 100644
--- a/auto_tests/tests/Util.js
+++ b/auto_tests/tests/Util.js
@@ -6,8 +6,9 @@
 var Util = {};
 
 /**
- * Get the y-labels for a given axis. You can specify a parent if more than one
- * graph is on the document.
+ * Get the y-labels for a given axis.
+ *
+ * You can specify a parent if more than one graph is in the document.
  */
 Util.getYLabels = function(axis_num, parent) {
   axis_num = axis_num || "";
@@ -21,6 +22,21 @@ Util.getYLabels = function(axis_num, parent) {
 }
 
 /**
+ * Get the x-labels for a given axis.
+ *
+ * You can specify a parent if more than one graph is in the document.
+ */
+Util.getXLabels = function(parent) {
+  parent = parent || document;
+  var x_labels = parent.getElementsByClassName("dygraph-axis-label-x");
+  var ary = [];
+  for (var i = 0; i < x_labels.length; i++) {
+    ary.push(x_labels[i].innerHTML);
+  }
+  return ary;
+}
+
+/**
  * Returns all text in tags w/ a given css class, sorted.
  * You can specify a parent if more than one graph is on the document.
  */
@@ -34,3 +50,10 @@ Util.getClassTexts = function(css_class, parent) {
   texts.sort();
   return texts;
 }
+
+Util.getLegend = function(parent) {
+  parent = parent || document;
+  var legend = parent.getElementsByClassName("dygraph-legend")[0];
+  return legend.textContent;
+}
+
diff --git a/auto_tests/tests/axis_labels-deprecated.js b/auto_tests/tests/axis_labels-deprecated.js
index 34f37a5..10784db 100644
--- a/auto_tests/tests/axis_labels-deprecated.js
+++ b/auto_tests/tests/axis_labels-deprecated.js
@@ -13,31 +13,6 @@ DeprecatedAxisLabelsTestCase.prototype.setUp = function() {
 DeprecatedAxisLabelsTestCase.prototype.tearDown = function() {
 };
 
-// TODO(konigsberg): Scope these functions.
-
-function getYLabels() {
-  var y_labels = document.getElementsByClassName("dygraph-axis-label-y");
-  var ary = [];
-  for (var i = 0; i < y_labels.length; i++) {
-    ary.push(y_labels[i].innerHTML);
-  }
-  return ary;
-}
-
-function getXLabels() {
-  var x_labels = document.getElementsByClassName("dygraph-axis-label-x");
-  var ary = [];
-  for (var i = 0; i < x_labels.length; i++) {
-    ary.push(x_labels[i].innerHTML);
-  }
-  return ary;
-}
-
-function getLegend() {
-  var legend = document.getElementsByClassName("dygraph-legend")[0];
-  return legend.textContent;
-}
-
 DeprecatedAxisLabelsTestCase.prototype.testDeprecatedDeprecatedXAxisTimeLabelFormatter = function() {
   var opts = {
     width: 480,
@@ -60,11 +35,11 @@ DeprecatedAxisLabelsTestCase.prototype.testDeprecatedDeprecatedXAxisTimeLabelFor
     }
   });
 
-  assertEquals(["00:05:00","00:05:12","00:05:24","00:05:36","00:05:48"], getXLabels());
+  assertEquals(["00:05:00","00:05:12","00:05:24","00:05:36","00:05:48"], Util.getXLabels());
 
   // The legend does not use the xAxisLabelFormatter:
   g.setSelection(1);
-  assertEquals('5.1: Y1:1', getLegend());
+  assertEquals('5.1: Y1:1', Util.getLegend());
 };
 
 DeprecatedAxisLabelsTestCase.prototype.testDeprecatedAxisLabelFormatter = function () {
@@ -94,11 +69,11 @@ DeprecatedAxisLabelsTestCase.prototype.testDeprecatedAxisLabelFormatter = functi
   var graph = document.getElementById("graph");
   var g = new Dygraph(graph, data, opts);
 
-  assertEquals(['x0','x2','x4','x6','x8'], getXLabels());
-  assertEquals(['y0','y2','y4','y6','y8','y10','y12','y14','y16','y18'], getYLabels());
+  assertEquals(['x0','x2','x4','x6','x8'], Util.getXLabels());
+  assertEquals(['y0','y2','y4','y6','y8','y10','y12','y14','y16','y18'], Util.getYLabels());
 
   g.setSelection(2);
-  assertEquals("2: y:4", getLegend());
+  assertEquals("2: y:4", Util.getLegend());
 };
 
 DeprecatedAxisLabelsTestCase.prototype.testDeprecatedDateAxisLabelFormatter = function () {
@@ -128,11 +103,11 @@ DeprecatedAxisLabelsTestCase.prototype.testDeprecatedDateAxisLabelFormatter = fu
   var graph = document.getElementById("graph");
   var g = new Dygraph(graph, data, opts);
 
-  assertEquals(["x2011/01/01", "x2011/01/02", "x2011/01/03", "x2011/01/04", "x2011/01/05", "x2011/01/06", "x2011/01/07", "x2011/01/08", "x2011/01/09"], getXLabels());
-  assertEquals(['y2','y4','y6','y8','y10','y12','y14','y16','y18'], getYLabels());
+  assertEquals(["x2011/01/01", "x2011/01/02", "x2011/01/03", "x2011/01/04", "x2011/01/05", "x2011/01/06", "x2011/01/07", "x2011/01/08", "x2011/01/09"], Util.getXLabels());
+  assertEquals(['y2','y4','y6','y8','y10','y12','y14','y16','y18'], Util.getYLabels());
 
   g.setSelection(0);
-  assertEquals("2011/01/01: y:2", getLegend());
+  assertEquals("2011/01/01: y:2", Util.getLegend());
 };
 
 // This test verifies that when a valueFormatter is set (but not an
@@ -166,13 +141,13 @@ DeprecatedAxisLabelsTestCase.prototype.testDeprecatedValueFormatter = function (
   var g = new Dygraph(graph, data, opts);
 
   // the valueFormatter options do not affect the ticks.
-  assertEquals(['0','2','4','6','8'], getXLabels());
+  assertEquals(['0','2','4','6','8'], Util.getXLabels());
   assertEquals(['0','2','4','6','8','10','12','14','16','18'],
-               getYLabels());
+               Util.getYLabels());
 
   // they do affect the legend, however.
   g.setSelection(2);
-  assertEquals("x2: y:y4", getLegend());
+  assertEquals("x2: y:y4", Util.getLegend());
 };
 
 DeprecatedAxisLabelsTestCase.prototype.testDeprecatedDateValueFormatter = function () {
@@ -204,12 +179,12 @@ DeprecatedAxisLabelsTestCase.prototype.testDeprecatedDateValueFormatter = functi
   var g = new Dygraph(graph, data, opts);
 
   // valueFormatters do not affect ticks.
-  assertEquals(['01Jan','02Jan','03Jan','04Jan','05Jan','06Jan','07Jan','08Jan','09Jan'], getXLabels());
-  assertEquals(['2','4','6','8','10','12','14','16','18'], getYLabels());
+  assertEquals(['01Jan','02Jan','03Jan','04Jan','05Jan','06Jan','07Jan','08Jan','09Jan'], Util.getXLabels());
+  assertEquals(['2','4','6','8','10','12','14','16','18'], Util.getYLabels());
 
   // the valueFormatter options also affect the legend.
   g.setSelection(2);
-  assertEquals('x2011/01/03: y:y6', getLegend());
+  assertEquals('x2011/01/03: y:y6', Util.getLegend());
 };
 
 // This test verifies that when both a valueFormatter and an axisLabelFormatter
@@ -239,11 +214,11 @@ DeprecatedAxisLabelsTestCase.prototype.testDeprecatedAxisLabelFormatterPrecedenc
   var graph = document.getElementById("graph");
   var g = new Dygraph(graph, data, opts);
 
-  assertEquals(['x0','x2','x4','x6','x8'], getXLabels());
-  assertEquals(['y0','y2','y4','y6','y8','y10','y12','y14','y16','y18'], getYLabels());
+  assertEquals(['x0','x2','x4','x6','x8'], Util.getXLabels());
+  assertEquals(['y0','y2','y4','y6','y8','y10','y12','y14','y16','y18'], Util.getYLabels());
 
   g.setSelection(9);
-  assertEquals("xvf9: y:yvf18", getLegend());
+  assertEquals("xvf9: y:yvf18", Util.getLegend());
 };
 
 // This is the same as the previous test, except that options are added
@@ -281,9 +256,9 @@ DeprecatedAxisLabelsTestCase.prototype.testDeprecatedAxisLabelFormatterIncrement
     }
   });
 
-  assertEquals(["x0","x2","x4","x6","x8"], getXLabels());
-  assertEquals(['y0','y2','y4','y6','y8','y10','y12','y14','y16','y18'], getYLabels());
+  assertEquals(["x0","x2","x4","x6","x8"], Util.getXLabels());
+  assertEquals(['y0','y2','y4','y6','y8','y10','y12','y14','y16','y18'], Util.getYLabels());
 
   g.setSelection(9);
-  assertEquals("xvf9: y:yvf18", getLegend());
+  assertEquals("xvf9: y:yvf18", Util.getLegend());
 };
diff --git a/auto_tests/tests/axis_labels.js b/auto_tests/tests/axis_labels.js
index f9f7196..9b36565 100644
--- a/auto_tests/tests/axis_labels.js
+++ b/auto_tests/tests/axis_labels.js
@@ -12,24 +12,9 @@ AxisLabelsTestCase.prototype.setUp = function() {
 AxisLabelsTestCase.prototype.tearDown = function() {
 };
 
-function getYLabels() {
-  var y_labels = document.getElementsByClassName("dygraph-axis-label-y");
-  var ary = [];
-  for (var i = 0; i < y_labels.length; i++) {
-    ary.push(y_labels[i].innerHTML);
-  }
-  return ary;
-}
-
-function getXLabels() {
-  var x_labels = document.getElementsByClassName("dygraph-axis-label-x");
-  var ary = [];
-  for (var i = 0; i < x_labels.length; i++) {
-    ary.push(x_labels[i].innerHTML);
-  }
-  return ary;
-}
-
+/**
+ * Takes in an array of strings and returns an array of floats.
+ */
 function makeNumbers(ary) {
   var ret = [];
   for (var i = 0; i < ary.length; i++) {
@@ -38,11 +23,6 @@ function makeNumbers(ary) {
   return ret;
 }
 
-function getLegend() {
-  var legend = document.getElementsByClassName("dygraph-legend")[0];
-  return legend.textContent;
-}
-
 AxisLabelsTestCase.prototype.kCloseFloat = 1.0e-10;
 
 AxisLabelsTestCase.prototype.testMinusOneToOne = function() {
@@ -61,25 +41,25 @@ AxisLabelsTestCase.prototype.testMinusOneToOne = function() {
   var g = new Dygraph(graph, data, opts);
 
   // TODO(danvk): would ['-1.0','-0.5','0.0','0.5','1.0'] be better?
-  assertEquals(['-1','-0.5','0','0.5','1'], getYLabels());
+  assertEquals(['-1','-0.5','0','0.5','1'], Util.getYLabels());
 
   // Go up to 2
   data += "4,2\n";
   g.updateOptions({file: data});
-  assertEquals(['-1','-0.5','0','0.5','1','1.5','2'], getYLabels());
+  assertEquals(['-1','-0.5','0','0.5','1','1.5','2'], Util.getYLabels());
 
   // Now 10
   data += "5,10\n";
   g.updateOptions({file: data});
-  assertEquals(['-2','0','2','4','6','8','10'], getYLabels());
+  assertEquals(['-2','0','2','4','6','8','10'], Util.getYLabels());
 
   // Now 100
   data += "6,100\n";
   g.updateOptions({file: data});
-  assertEquals(['0','20','40','60','80','100'], getYLabels());
+  assertEquals(['0','20','40','60','80','100'], Util.getYLabels());
 
   g.setSelection(0);
-  assertEquals('0: Y:-1', getLegend());
+  assertEquals('0: Y:-1', Util.getLegend());
 };
 
 AxisLabelsTestCase.prototype.testSmallRangeNearZero = function() {
@@ -99,20 +79,20 @@ AxisLabelsTestCase.prototype.testSmallRangeNearZero = function() {
   var graph = document.getElementById("graph");
   var g = new Dygraph(graph, data, opts);
   assertEqualsDelta(makeNumbers(["-0.1","-0.08","-0.06","-0.04","-0.02","0","0.02","0.04","0.06","0.08"]),
-                    makeNumbers(getYLabels()), this.kCloseFloat);
+                    makeNumbers(Util.getYLabels()), this.kCloseFloat);
 
   opts.valueRange = [-0.05, 0.05];
   g.updateOptions(opts);
   // TODO(danvk): why '1.00e-2' and not '0.01'?
   assertEquals(makeNumbers(["-0.05","-0.04","-0.03","-0.02","-0.01","0","1.00e-2","0.02","0.03","0.04"]),
-               makeNumbers(getYLabels()));
+               makeNumbers(Util.getYLabels()));
 
   opts.valueRange = [-0.01, 0.01];
   g.updateOptions(opts);
-  assertEquals(makeNumbers(["-0.01","-8.00e-3","-6.00e-3","-4.00e-3","-2.00e-3","0","2.00e-3","4.00e-3","6.00e-3","8.00e-3"]), makeNumbers(getYLabels()));
+  assertEquals(makeNumbers(["-0.01","-8.00e-3","-6.00e-3","-4.00e-3","-2.00e-3","0","2.00e-3","4.00e-3","6.00e-3","8.00e-3"]), makeNumbers(Util.getYLabels()));
 
   g.setSelection(1);
-  assertEquals('1: Y:0', getLegend());
+  assertEquals('1: Y:0', Util.getLegend());
 };
 
 AxisLabelsTestCase.prototype.testSmallRangeAwayFromZero = function() {
@@ -130,20 +110,20 @@ AxisLabelsTestCase.prototype.testSmallRangeAwayFromZero = function() {
 
   opts.valueRange = [9.9, 10.1];
   var g = new Dygraph(graph, data, opts);
-  assertEquals(["9.9","9.92","9.94","9.96","9.98","10","10.02","10.04","10.06","10.08"], getYLabels());
+  assertEquals(["9.9","9.92","9.94","9.96","9.98","10","10.02","10.04","10.06","10.08"], Util.getYLabels());
 
   opts.valueRange = [9.99, 10.01];
   g.updateOptions(opts);
   // TODO(danvk): this is bad
-  assertEquals(["9.99","9.99","9.99","10","10","10","10","10","10.01","10.01"], getYLabels());
+  assertEquals(["9.99","9.99","9.99","10","10","10","10","10","10.01","10.01"], Util.getYLabels());
 
   opts.valueRange = [9.999, 10.001];
   g.updateOptions(opts);
   // TODO(danvk): this is even worse!
-  assertEquals(["10","10","10","10","10","10","10","10","10","10"], getYLabels());
+  assertEquals(["10","10","10","10","10","10","10","10","10","10"], Util.getYLabels());
 
   g.setSelection(1);
-  assertEquals('1: Y:0', getLegend());
+  assertEquals('1: Y:0', Util.getLegend());
 };
 
 AxisLabelsTestCase.prototype.testXAxisTimeLabelFormatter = function() {
@@ -172,11 +152,11 @@ AxisLabelsTestCase.prototype.testXAxisTimeLabelFormatter = function() {
     }
   });
 
-  assertEquals(["00:05:00","00:05:12","00:05:24","00:05:36","00:05:48"], getXLabels());
+  assertEquals(["00:05:00","00:05:12","00:05:24","00:05:36","00:05:48"], Util.getXLabels());
 
   // The legend does not use the axisLabelFormatter:
   g.setSelection(1);
-  assertEquals('5.1: Y1:1', getLegend());
+  assertEquals('5.1: Y1:1', Util.getLegend());
 };
 
 AxisLabelsTestCase.prototype.testAxisLabelFormatter = function () {
@@ -212,11 +192,11 @@ AxisLabelsTestCase.prototype.testAxisLabelFormatter = function () {
   var graph = document.getElementById("graph");
   var g = new Dygraph(graph, data, opts);
 
-  assertEquals(['x0','x2','x4','x6','x8'], getXLabels());
-  assertEquals(['y0','y2','y4','y6','y8','y10','y12','y14','y16','y18'], getYLabels());
+  assertEquals(['x0','x2','x4','x6','x8'], Util.getXLabels());
+  assertEquals(['y0','y2','y4','y6','y8','y10','y12','y14','y16','y18'], Util.getYLabels());
 
   g.setSelection(2);
-  assertEquals("2: y:4", getLegend());
+  assertEquals("2: y:4", Util.getLegend());
 };
 
 AxisLabelsTestCase.prototype.testDateAxisLabelFormatter = function () {
@@ -252,11 +232,11 @@ AxisLabelsTestCase.prototype.testDateAxisLabelFormatter = function () {
   var graph = document.getElementById("graph");
   var g = new Dygraph(graph, data, opts);
 
-  assertEquals(["x2011/01/01", "x2011/01/02", "x2011/01/03", "x2011/01/04", "x2011/01/05", "x2011/01/06", "x2011/01/07", "x2011/01/08", "x2011/01/09"], getXLabels());
-  assertEquals(['y2','y4','y6','y8','y10','y12','y14','y16','y18'], getYLabels());
+  assertEquals(["x2011/01/01", "x2011/01/02", "x2011/01/03", "x2011/01/04", "x2011/01/05", "x2011/01/06", "x2011/01/07", "x2011/01/08", "x2011/01/09"], Util.getXLabels());
+  assertEquals(['y2','y4','y6','y8','y10','y12','y14','y16','y18'], Util.getYLabels());
 
   g.setSelection(0);
-  assertEquals("2011/01/01: y:2", getLegend());
+  assertEquals("2011/01/01: y:2", Util.getLegend());
 };
 
 // This test verifies that when a valueFormatter is set (but not an
@@ -296,13 +276,13 @@ AxisLabelsTestCase.prototype.testValueFormatter = function () {
   var g = new Dygraph(graph, data, opts);
 
   // the valueFormatter options do not affect the ticks.
-  assertEquals(['0','2','4','6','8'], getXLabels());
+  assertEquals(['0','2','4','6','8'], Util.getXLabels());
   assertEquals(['0','2','4','6','8','10','12','14','16','18'],
-               getYLabels());
+               Util.getYLabels());
 
   // they do affect the legend, however.
   g.setSelection(2);
-  assertEquals("x2: y:y4", getLegend());
+  assertEquals("x2: y:y4", Util.getLegend());
 };
 
 AxisLabelsTestCase.prototype.testDateValueFormatter = function () {
@@ -340,12 +320,12 @@ AxisLabelsTestCase.prototype.testDateValueFormatter = function () {
   var g = new Dygraph(graph, data, opts);
 
   // valueFormatters do not affect ticks.
-  assertEquals(['01Jan','02Jan','03Jan','04Jan','05Jan','06Jan','07Jan','08Jan','09Jan'], getXLabels());
-  assertEquals(['2','4','6','8','10','12','14','16','18'], getYLabels());
+  assertEquals(['01Jan','02Jan','03Jan','04Jan','05Jan','06Jan','07Jan','08Jan','09Jan'], Util.getXLabels());
+  assertEquals(['2','4','6','8','10','12','14','16','18'], Util.getYLabels());
 
   // the valueFormatter options also affect the legend.
   g.setSelection(2);
-  assertEquals('x2011/01/03: y:y6', getLegend());
+  assertEquals('x2011/01/03: y:y6', Util.getLegend());
 };
 
 // This test verifies that when both a valueFormatter and an axisLabelFormatter
@@ -381,11 +361,11 @@ AxisLabelsTestCase.prototype.testAxisLabelFormatterPrecedence = function () {
   var graph = document.getElementById("graph");
   var g = new Dygraph(graph, data, opts);
 
-  assertEquals(['x0','x2','x4','x6','x8'], getXLabels());
-  assertEquals(['y0','y2','y4','y6','y8','y10','y12','y14','y16','y18'], getYLabels());
+  assertEquals(['x0','x2','x4','x6','x8'], Util.getXLabels());
+  assertEquals(['y0','y2','y4','y6','y8','y10','y12','y14','y16','y18'], Util.getYLabels());
 
   g.setSelection(9);
-  assertEquals("xvf9: y:yvf18", getLegend());
+  assertEquals("xvf9: y:yvf18", Util.getLegend());
 };
 
 // This is the same as the previous test, except that options are added
@@ -439,11 +419,11 @@ AxisLabelsTestCase.prototype.testAxisLabelFormatterIncremental = function () {
     }
   });
 
-  assertEquals(["x0","x2","x4","x6","x8"], getXLabels());
-  assertEquals(['y0','y2','y4','y6','y8','y10','y12','y14','y16','y18'], getYLabels());
+  assertEquals(["x0","x2","x4","x6","x8"], Util.getXLabels());
+  assertEquals(['y0','y2','y4','y6','y8','y10','y12','y14','y16','y18'], Util.getYLabels());
 
   g.setSelection(9);
-  assertEquals("xvf9: y:yvf18", getLegend());
+  assertEquals("xvf9: y:yvf18", Util.getLegend());
 };
 
 AxisLabelsTestCase.prototype.testGlobalFormatters = function() {
@@ -465,11 +445,11 @@ AxisLabelsTestCase.prototype.testGlobalFormatters = function() {
   var graph = document.getElementById("graph");
   var g = new Dygraph(graph, data, opts);
 
-  assertEquals(['alf0','alf2','alf4','alf6','alf8'], getXLabels());
-  assertEquals(['alf0','alf2','alf4','alf6','alf8','alf10','alf12','alf14','alf16','alf18'], getYLabels());
+  assertEquals(['alf0','alf2','alf4','alf6','alf8'], Util.getXLabels());
+  assertEquals(['alf0','alf2','alf4','alf6','alf8','alf10','alf12','alf14','alf16','alf18'], Util.getYLabels());
 
   g.setSelection(9);
-  assertEquals("vf9: y:vf18", getLegend());
+  assertEquals("vf9: y:vf18", Util.getLegend());
 };
 
 AxisLabelsTestCase.prototype.testSeriesOrder = function() {
@@ -488,7 +468,7 @@ AxisLabelsTestCase.prototype.testSeriesOrder = function() {
   var g = new Dygraph(graph, data, opts);
 
   g.setSelection(2);
-  assertEquals('2: 00:103 01:203 10:303 11:403', getLegend());
+  assertEquals('2: 00:103 01:203 10:303 11:403', Util.getLegend());
 
   // Sanity checks for indexFromSetName
   assertEquals(0, g.indexFromSetName("x"));
-- 
2.7.4