improve jupyter test design:

- make lib/server.js handle arbitrary html index and js test file
  (to test multiple ipynb fixutres)
- use ipykernel to determine which python version nosetest is launched w/
- use domready to make sure that tests are ran after DOM is ready

Author: etpinard

plotly/tests/test_core/test_jupyter/lib/server.js

@@ -2,27 +2,48 @@ var http = require('http');
 var url = require('url');
 var fs = require('fs');
 var path = require('path');
+
 var ecstatic = require('ecstatic');
 var browserify = require('browserify');
 var cheerio = require('cheerio');
-var chrome = require('chrome-launch');
 var tapParser = require('tap-parser');
+var chrome = require('chrome-launch');
 
 var PORT = 8080;
 var PATH_ROOT = path.join(__dirname, '..');
-var PATH_FIXTURES = path.join(PATH_ROOT, 'fixtures');
-var PATH_INDEX = path.join(PATH_FIXTURES, 'test.html');
-var PATH_INDEX_STUB = path.join(PATH_FIXTURES, 'test.tmp.html');
-var PATH_TEST_FILE = path.join(PATH_ROOT, 'test.js');
+var PATH_INDEX_STUB = path.join(PATH_ROOT, 'index.tmp.html');
 var PATH_TEST_BUNDLE = path.join(PATH_ROOT, 'test.tmp.js');
-var URL = 'http://localhost:' + PORT + '/fixtures/test.tmp.html';
+
+var URL = 'http://localhost:' + PORT + '/index.tmp.html';
 var EXIT_CODE = 0;
 
-// main
-stubIndex()
-    .then(bundleTests)
-    .then(startServer)
-    .then(launch)
+if(process.argv.length !== 4) {
+    throw new Error('must provide path to html and js files');
+}
+
+var PATH_INDEX = process.argv[2];
+var PATH_TEST_FILE = process.argv[3];
+
+main();
+
+function main() {
+    scanInput();
+
+    stubIndex()
+        .then(bundleTests)
+        .then(startServer)
+        .then(launch);
+}
+
+function scanInput() {
+    var reqFiles = [PATH_INDEX, PATH_TEST_FILE];
+
+    reqFiles.forEach(function(filePath) {
+        if(!doesFileExist(filePath)) {
+            throw new Error(filePath + ' does not exist');
+        }
+    });
+}
 
 function stubIndex() {
     return new Promise(function(resolve, reject) {
@@ -91,3 +112,14 @@ function removeBuildFiles() {
     fs.unlinkSync(PATH_INDEX_STUB);
     fs.unlinkSync(PATH_TEST_BUNDLE);
 }
+
+function doesFileExist(filePath) {
+    try {
+        if(fs.statSync(filePath).isFile()) return true;
+    }
+    catch(e) {
+        return false;
+    }
+
+    return false;
+}

plotly/tests/test_core/test_jupyter/lib/tape-wrapper.js

@@ -1,5 +1,8 @@
+'use strict';
+
 var test = require('tape');
 var xhr = require('xhr');
+var domready = require('domready');
 
 var cnt = 0;
 var noop = function() {};
@@ -19,4 +22,12 @@ test.onFinish(function() {
     post('done');
 });
 
+test('should not crash browser', function(t) {
+    t.plan(1);
+
+    domready(function() {
+        t.pass('domready');
+    });
+});
+
 module.exports = test;

plotly/tests/test_core/test_jupyter/package.json

@@ -11,6 +11,7 @@
     "browserify": "^13.1.0",
     "cheerio": "^0.20.0",
     "chrome-launch": "^1.1.4",
+    "domready": "^1.0.8",
     "ecstatic": "^2.1.0",
     "tap-parser": "^2.0.0",
     "tape": "^4.6.0",

plotly/tests/test_core/test_jupyter/test_jupyter.py

@@ -2,40 +2,49 @@
 test__jupyter
 
 """
-from __future__ import absolute_import
-
 import nbformat
 from nbconvert import HTMLExporter
 from nbconvert.preprocessors import ExecutePreprocessor
+from ipykernel import kernelspec
 
 from unittest import TestCase
 from os import path
 import subprocess
 
-import plotly
-
 PATH_ROOT = path.dirname(__file__)
 PATH_FIXTURES = path.join(PATH_ROOT, 'fixtures')
-PATH_TEST_NB = path.join(PATH_FIXTURES, 'test.ipynb')
-PATH_TEST_HTML = path.join(PATH_FIXTURES, 'test.html')
+PATH_JS_TESTS = path.join(PATH_ROOT, 'js_tests')
+
 
+class Common(TestCase):
+    __test__ = False
+    name = None
 
-class PlotlyJupyterTestCase(TestCase):
     def setUp(self):
-        with open(PATH_TEST_NB, 'r') as f:
+        self.path_test_nb = path.join(PATH_FIXTURES, self.name + '.ipynb')
+        self.path_test_html = path.join(PATH_FIXTURES, self.name + '.html')
+        self.path_test_js = path.join(PATH_JS_TESTS, self.name + '.js')
+
+        self.kernel_name = kernelspec.KERNEL_NAME
+
+        with open(self.path_test_nb, 'r') as f:
             self.nb = nbformat.read(f, as_version=4)
 
-        self.ep = ExecutePreprocessor(timeout=600)
+        self.ep = ExecutePreprocessor(timeout=600,
+                                      kernel_name=self.kernel_name)
+
         self.html_exporter = HTMLExporter()
 
         self.ep.preprocess(self.nb, {'metadata': {'path': '.'}})
         (self.body, _) = self.html_exporter.from_notebook_node(self.nb)
 
-        with open(PATH_TEST_HTML, 'w') as f:
+        with open(self.path_test_html, 'w') as f:
             f.write(self.body)
 
-    def test_one(self):
-        proc = subprocess.Popen(['npm', 'test'],
+    def test_js(self):
+        cmd = ['npm', 'test', '--', self.path_test_html, self.path_test_js]
+
+        proc = subprocess.Popen(cmd,
                                 cwd=PATH_ROOT,
                                 stdout=subprocess.PIPE,
                                 stderr=subprocess.PIPE)
@@ -44,3 +53,13 @@ def test_one(self):
 
         if stderr:
             self.fail('One or more javascript test failed')
+
+
+class PlotlyJupyterConnectedFalseTestCase(Common):
+    __test__ = True
+    name = 'connected_false'
+
+
+class PlotlyJupyterConnectedTrueTestCase(Common):
+    __test__ = True
+    name = 'connected_true'