Add Jest Tests (jupyter-server#56)

* add jest test infra

* get a basic test running

* make build quieter and increase timeout

* allow root

* try this

* try local dir

* another attempt at config

* try json file

* fix manifest

* wip test suite

* try with this

Author: Steve Silvester

.eslintignore

@@ -4,4 +4,4 @@ coverage
 **/*.d.ts
 tests
 style/index.js
-.eslintrc.js
+*.js

.gitignore

@@ -143,4 +143,6 @@ cython_debug/
 node_modules/
 data_studio_jupyter_extensions/labextension/
 tsconfig.tsbuildinfo
+tsconfig.test.tsbuildinfo
 Untitled*.ipynb
+junit.xml

MANIFEST.in

@@ -6,6 +6,8 @@ include *.txt
 include *.yml
 include condarc
 recursive-include jupyter-config *.json
+include *.js
+recursive-include test *.ts
 
 include package.json
 include install.json

Makefile

@@ -3,8 +3,8 @@
 .PHONY: install build watch run-remote run-local test
 
 install:
-	pip install pre-commit --index-url https://pypi.apple.com/simple
-	pip install -e ".[test]" --index-url https://pypi.apple.com/simple
+	pip install -q pre-commit --index-url https://pypi.apple.com/simple
+	pip install -q -e ".[test]" --index-url https://pypi.apple.com/simple
 	jupyter server extension enable data_studio_jupyter_extensions
 	jupyter labextension develop . --overwrite
 	pre-commit install

babel.config.js

@@ -0,0 +1 @@
+module.exports = require('@jupyterlab/testutils/lib/babel.config');

build.sh

@@ -38,7 +38,14 @@ which python
 python -V
 which pip
 pip config --user set global.progress_bar off
-pip install check-manifest pre-commit
+pip install -q check-manifest pre-commit
+
+# Set up Jupyter Config
+CONFIG_DIR=/workspace/miniconda/envs/data_studio_jupyter_extensions/etc/jupyter
+mkdir -p ${CONFIG_DIR}
+cat <<EOF >> ${CONFIG_DIR}/jupyter_server_config.json
+{ "ServerApp": { "allow_root": true } }
+EOF
 
 echo "+++++++++++++++++++++++++PYTHON++++++++++++++++++++++++++++++"
 make install
@@ -47,7 +54,7 @@ make test
 echo "++++++++++++++++++++NPM+++++++++++++++++++++++++++++++++++"
 yarn
 yarn build
-yarn test
+yarn test:cov
 
 echo "+++++++++++++++++++++++++INTEGRITY++++++++++++++++++++++++++++++"
 check-manifest -v

jest.config.js

@@ -0,0 +1,17 @@
+const func = require('@jupyterlab/testutils/lib/jest-config');
+var config = func(__dirname);
+config.transform = {
+  '\\.svg$': 'jest-raw-loader',
+  '^.+\\.md?$': 'markdown-loader-jest',
+  '\\.[j]sx?$': 'babel-jest'
+};
+config.transformIgnorePatterns = [];
+config.coverageThreshold = {
+  global: {
+    functions: 70,
+    lines: 70,
+    statements: -10
+  }
+};
+
+module.exports = config;

package.json

@@ -34,14 +34,18 @@
     "build:labextension": "jupyter labextension build .",
     "build:labextension:dev": "jupyter labextension build --development True .",
     "build:lib": "tsc",
+    "build:test": "tsc --build tsconfig.test.json",
     "clean": "jlpm run clean:lib",
     "clean:lib": "rimraf lib tsconfig.tsbuildinfo",
     "clean:labextension": "rimraf studio/labextension",
     "clean:all": "jlpm run clean:lib && jlpm run clean:labextension",
     "eslint": "eslint . --ext .ts,.tsx --fix",
     "eslint:check": "eslint . --ext .ts,.tsx",
     "install:extension": "jlpm run build",
-    "test": "echo 'No Test'",
+    "test": "jest",
+    "test:cov": "jest --collect-coverage",
+    "test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand",
+    "test:debug:watch": "node --inspect-brk node_modules/.bin/jest --runInBand --watch",
     "watch": "run-p watch:src watch:labextension",
     "watch:src": "tsc -w",
     "watch:labextension": "jupyter labextension watch ."
@@ -55,16 +59,21 @@
     "@jupyterlab/settingregistry": "^3.0.0"
   },
   "devDependencies": {
+    "@babel/preset-env": "^7.15.0",
     "@jupyterlab/builder": "^3.0.0",
+    "@jupyterlab/testutils": "^3.1.3",
+    "@types/jest": "^26.0.10",
     "@typescript-eslint/eslint-plugin": "^4.8.1",
     "@typescript-eslint/parser": "^4.8.1",
     "eslint": "^7.14.0",
     "eslint-config-prettier": "^6.15.0",
     "eslint-plugin-prettier": "^3.1.4",
+    "jest": "^26.4.2",
     "mkdirp": "^1.0.3",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.1.1",
     "rimraf": "^3.0.2",
+    "ts-jest": "^26.3.0",
     "typescript": "~4.1.3"
   },
   "sideEffects": [

src/index.ts

@@ -4,7 +4,6 @@ import {
 } from '@jupyterlab/application';
 
 import { PageConfig, URLExt } from '@jupyterlab/coreutils';
-import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import { ILoggerRegistry } from '@jupyterlab/logconsole';
 import { INotebookTracker, NotebookPanel } from '@jupyterlab/notebook';
 
@@ -15,29 +14,13 @@ const plugin: JupyterFrontEndPlugin<void> = {
   id: 'data_studio:plugin',
   autoStart: true,
   requires: [ILoggerRegistry, INotebookTracker],
-  optional: [ISettingRegistry],
   activate: (
     app: JupyterFrontEnd,
     loggerRegistry: ILoggerRegistry,
-    notebookTracker: INotebookTracker,
-    settingRegistry: ISettingRegistry | null
+    notebookTracker: INotebookTracker
   ) => {
     console.log('JupyterLab extension studio is activated!');
 
-    if (settingRegistry) {
-      settingRegistry
-        .load(plugin.id)
-        .then(settings => {
-          console.log(
-            'data studio studio settings loaded:',
-            settings.composite
-          );
-        })
-        .catch(reason => {
-          console.error('Failed to load settings for data studio.', reason);
-        });
-    }
-
     let path = '';
     const url = URLExt.join(PageConfig.getWsUrl(), 'subscribe');
     const ws = new WebSocket(url);

test/status.spec.ts

@@ -0,0 +1,46 @@
+import { flakyIt as it } from '@jupyterlab/testutils';
+
+import { JupyterLab } from '@jupyterlab/application';
+
+import { INotebookModel, NotebookTracker } from '@jupyterlab/notebook';
+
+import { Context } from '@jupyterlab/docregistry';
+import {
+  initNotebookContext,
+  JupyterServer,
+  NBTestUtils
+} from '@jupyterlab/testutils';
+
+import { LoggerRegistry } from '@jupyterlab/logconsole';
+
+import plugin from '../src/index';
+
+const server = new JupyterServer();
+
+beforeAll(async () => {
+  jest.setTimeout(20000);
+  await server.start();
+});
+
+afterAll(async () => {
+  await server.shutdown();
+});
+
+const app = new JupyterLab();
+const defaultRendermime = NBTestUtils.defaultRenderMime();
+const loggerRegistry = new LoggerRegistry({ defaultRendermime, maxLength: 10 });
+const notebookTracker = new NotebookTracker({ namespace: 'test' });
+
+describe('status', () => {
+  let context: Context<INotebookModel>;
+
+  beforeEach(async () => {
+    context = await initNotebookContext();
+  });
+
+  it('should create the plugin', () => {
+    const notebookPanel = NBTestUtils.createNotebookPanel(context);
+    plugin.activate(app, loggerRegistry, notebookTracker);
+    notebookTracker.add(notebookPanel);
+  });
+});

tsconfig.test.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
+    "composite": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "incremental": true,
+    "jsx": "react",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noEmitOnError": true,
+    "noImplicitAny": true,
+    "noUnusedLocals": true,
+    "preserveWatchOutput": true,
+    "resolveJsonModule": true,
+    "rootDir": ".",
+    "outDir": "lib",
+    "strict": true,
+    "strictNullChecks": true,
+    "target": "es2017",
+    "types": []
+  },
+  "include": ["src/*", "test/*"]
+}