fix browser_check

Author: Frederic Collonval

.travis.yml

@@ -5,13 +5,14 @@ cache:
   pip: true
   directories:
     - /home/travis/.yarn-cache/
-install: pip install pytest jupyterlab
+install: pip install pytest "jupyterlab>=1.0.3"
 script:
   - pytest tests/unit
   - yarn
   - yarn build
   - yarn test
   - pip install .
+  - jupyter serverextension enable --py jupyterlab_git
   - jupyter labextension install .
   - python -m jupyterlab.browser_check
   - yarn run lint

tests/test-browser/chrome-test.js

@@ -1,58 +1,58 @@
 const assert = require('assert');
 const puppeteer = require('puppeteer');
 const inspect = require('util').inspect;
+const URL = process.argv[2];
 
-function getUrl() {
-  return process.argv[2];
+function testGitExtension(html) {
+  // Test git icons are present
+  assert(html.includes('--jp-icon-git-clone'), 'Could not find git clone icon.');
+  assert(html.includes('--jp-icon-git-pull'), 'Could not find git pull icon.');
+  assert(html.includes('--jp-icon-git-push'), 'Could not find git push icon.');
 }
 
-function testJupyterLabPage(html) {
+async function main() {
+  /* eslint-disable no-console */
+  console.info('Starting Chrome Headless');
+
+  const browser = await puppeteer.launch({ args: ['--no-sandbox'] });
+  const page = await browser.newPage();
+
+  console.info('Navigating to page:', URL);
+  await page.goto(URL);
+  console.info('Waiting for page to load...');
+
+  // Wait for the local file to redirect on notebook >= 6.0
+  await page.waitForNavigation();
+
+  const html = await page.content();
   if (inspect(html).indexOf('jupyter-config-data') === -1) {
     console.error('Error loading JupyterLab page:');
     console.error(html);
   }
-}
 
-async function testApplication(page) {
   const el = await page.waitForSelector('#browserTest', { timeout: 100000 });
   console.log('Waiting for application to start...');
+  let testError = null;
 
-  await page.waitForSelector('.completed');
-
+  try {
+    await page.waitForSelector('.completed');
+  } catch (e) {
+    testError = e;
+  }
   const textContent = await el.getProperty('textContent');
   const errors = JSON.parse(await textContent.jsonValue());
 
   for (let error of errors) {
     console.error(`Parsed an error from text content: ${error.message}`, error);
-    throw error;
   }
-}
 
-function testGitExtension(html) {
-    // Test git icons are present
-    assert(html.includes('--jp-icon-git-clone'), 'Could not find git clone icon.');
-    assert(html.includes('--jp-icon-git-pull'), 'Could not find git pull icon.');
-    assert(html.includes('--jp-icon-git-push'), 'Could not find git push icon.');
-}
-
-async function main() {
-  console.info('Starting Chrome Headless');
-
-  const URL = getUrl();
-  const browser = await puppeteer.launch({ args: ['--no-sandbox'] });
-  const page = await browser.newPage();
-
-  console.info('Navigating to page:', URL);
-  await page.goto(URL);
-  console.info('Waiting for page to load...');
-
-  const html = await page.content();
-  testJupyterLabPage(html);
-
-  await testApplication(page);
   testGitExtension(html);
 
   await browser.close();
+
+  if (testError) {
+    throw testError;
+  }
   console.info('Chrome test complete');
 }
 
@@ -61,4 +61,4 @@ process.on('unhandledRejection', up => {
   throw up;
 });
 
-main();
+main();

tests/test-browser/run_browser_test.py

@@ -1,71 +1,14 @@
 # -*- coding: utf-8 -*-
-# This file is copied from https://github.com/jupyterlab/jupyterlab/blob/master/jupyterlab/browser_check.py
-from concurrent.futures import ThreadPoolExecutor
+# This file reproduces https://github.com/jupyterlab/jupyterlab/blob/master/jupyterlab/browser_check.py
+# but patch the global `here` to use the local chrome-test.js
 import os
-import shutil
-import sys
-import subprocess
-
-from jupyterlab.labapp import LabApp, get_app_dir
-from notebook.notebookapp import flags, aliases
-from tornado.ioloop import IOLoop
-from traitlets import Bool
+from unittest.mock import patch
 
+from jupyterlab.browser_check import BrowserApp
 
 here = os.path.abspath(os.path.dirname(__file__))
-test_flags = dict(flags)
-test_flags['core-mode'] = (
-    {'BrowserApp': {'core_mode': True}},
-    "Start the app in core mode."
-)
-test_flags['dev-mode'] = (
-    {'BrowserApp': {'dev_mode': True}},
-    "Start the app in dev mode."
-)
-
-
-test_aliases = dict(aliases)
-test_aliases['app-dir'] = 'BrowserApp.app_dir'
-
-
-class BrowserApp(LabApp):
-
-    open_browser = Bool(False)
-    base_url = '/lab/'
-    ip = '127.0.0.1'
-    flags = test_flags
-    aliases = test_aliases
-
-    def start(self):
-        web_app = self.web_app
-        web_app.settings.setdefault('page_config_data', dict())
-        web_app.settings['page_config_data']['browserTest'] = True
-        web_app.settings['page_config_data']['buildAvailable'] = False
-
-        pool = ThreadPoolExecutor()
-        future = pool.submit(run_browser, self.display_url)
-        IOLoop.current().add_future(future, self._browser_finished)
-        super(BrowserApp, self).start()
-
-    def _browser_finished(self, future):
-        try:
-            sys.exit(future.result())
-        except Exception as e:
-            self.log.error(str(e))
-            sys.exit(1)
-
-
-def run_browser(url):
-    """Run the browser test and return an exit code.
-    """
-    target = os.path.join(get_app_dir(), 'browser_test')
-    if not os.path.exists(os.path.join(target, 'node_modules')):
-        os.makedirs(target)
-        subprocess.call(["yarn"], cwd=target)
-        subprocess.call(["yarn", "add", "puppeteer"], cwd=target)
-    shutil.copy(os.path.join(here, 'chrome-test.js'), os.path.join(target, 'chrome-test.js'))
-    return subprocess.check_call(["node", "chrome-test.js", url], cwd=target)
 
 
 if __name__ == '__main__':
-    BrowserApp.launch_instance()
+    with patch('jupyterlab.browser_check.here', here):
+        BrowserApp.launch_instance()