Test the template in CI

Author: vidartf

.travis.yml

@@ -0,0 +1,30 @@
+language: python
+python:
+  - 3.6
+sudo: false
+cache:
+  pip: true
+  directories:
+    - $HOME/.npm
+before_install:
+  - pip install -U pip setuptools
+  - nvm install 6
+  - pip install cookiecutter
+install:
+  - |
+    pushd $(mktemp -d)
+    cookiecutter $TRAVIS_BUILD_DIR --config-file $TRAVIS_BUILD_DIR/tests/testconfig.yaml --no-input
+    pushd jupyter-widget-testwidgets
+    pip install --upgrade -v ".[test]"
+script:
+  - |
+    py.test
+    npm test
+    popd
+    popd
+before_cache:
+  # Do not cache our own package
+  - |
+    rm -rf packages/{{ cookiecutter.jlab_extension_name }}/node_modules/{{ cookiecutter.npm_package_name }}
+after_success:
+    - codecov

README.md

@@ -48,7 +48,7 @@ you should run the tests:
 # First install the python package. This will also build the JS packages.
 pip install -e .
 
-# Run the python tests. This should only give you TODO errors:
+# Run the python tests. This should not give you a few sucessful example tests
 py.test
 
 # Run the JS tests. This should again, only give TODO errors (Expected 'Value' to equal 'Expected value'):

tests/testconfig.yaml

@@ -0,0 +1,11 @@
+default_context:
+    author_name: "Test Widget"
+    author_email: "[email protected]"
+    github_project_name: "jupyter-widget-testwidgets"
+    github_organization_name: "jupyter"
+    python_package_name: "ipywidgettestwidgets"
+    npm_package_name: "jupyter-widget-testwidgets"
+    npm_package_version: "1.1.0"
+    jlab_extension_name: "jupyterlab-widget-testwidgets"
+    jlab_extension_id: "jupyter.extensions.testwidgets"
+    project_short_description: "A Test Jupyter Widget Library"

{{cookiecutter.github_project_name}}/examples/introduction.ipynb

@@ -26,15 +26,6 @@
    "source": [
     "assert w.value == 'Hello World'"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "raise ValueError('TODO: Add example usage of your widget.')"
-   ]
   }
  ],
  "metadata": {

{{cookiecutter.github_project_name}}/packages/{{ cookiecutter.jlab_extension_name }}/package.json

@@ -8,7 +8,7 @@
     "@jupyterlab/application": "~0.9.0",
     "@phosphor/coreutils": "~1.3.0",
     "@jupyter-widgets/jupyterlab-manager": "~0.25.11",
-    "{{ cookiecutter.npm_package_name }}": "{{ cookiecutter.npm_package_name }}"
+    "{{ cookiecutter.npm_package_name }}": "^{{ cookiecutter.npm_package_version }}"
   },
   "devDependencies": {
     "rimraf": "^2.6.1",

{{cookiecutter.github_project_name}}/packages/{{ cookiecutter.npm_package_name }}/package.json

@@ -22,6 +22,9 @@
     "jupyter",
     "widgets"
   ],
+  "dependencies": {
+    "@jupyter-widgets/base": "~0.6.11"
+  },
   "devDependencies": {
     "@types/expect.js": "^0.3.29",
     "@types/mocha": "^2.2.41",
@@ -41,9 +44,6 @@
     "typescript": "^2.4.2",
     "webpack": "^3.4.1"
   },
-  "dependencies": {
-    "@jupyter-widgets/base": "~0.6.11"
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/{{ cookiecutter.github_organization_name }}/{{ cookiecutter.python_package_name }}"

{{cookiecutter.github_project_name}}/packages/{{ cookiecutter.npm_package_name }}/tests/src/index.spec.ts

@@ -7,18 +7,30 @@ import {
   // Add any needed widget imports here (or from controls)
 } from '@jupyter-widgets/base';
 
+import {
+  createTestModel
+} from './utils.spec';
+
 import {
   ExampleModel, ExampleView
 } from '../../src/'
 
 
-describe('Test category', () => {
+describe('Example', () => {
 
-  describe('Sub category', () => {
+  describe('ExampleModel', () => {
+
+    it('should be createable', () => {
+      let model = createTestModel(ExampleModel);
+      expect(model).to.be.an(ExampleModel);
+      expect(model.get('value')).to.be('Hello World');
+    });
 
-    it('should be testable', () => {
-      // TODO: Replace me!
-      expect('Value').to.be('Expected value');
+    it('should be createable with a value', () => {
+      let state = { value: 'Foo Bar!' }
+      let model = createTestModel(ExampleModel, state);
+      expect(model).to.be.an(ExampleModel);
+      expect(model.get('value')).to.be('Foo Bar!');
     });
 
   });

{{cookiecutter.github_project_name}}/packages/{{ cookiecutter.npm_package_name }}/tests/src/utils.spec.ts

@@ -0,0 +1,104 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+
+import * as widgets from '@jupyter-widgets/base';
+import * as services from '@jupyterlab/services';
+import * as Backbone from 'backbone';
+
+let numComms = 0;
+
+export
+class MockComm {
+    constructor() {
+        this.comm_id = `mock-comm-id-${numComms}`;
+        numComms += 1;
+    }
+    on_close(fn: Function | null) {
+        this._on_close = fn;
+    }
+    on_msg(fn: Function | null) {
+        this._on_msg = fn;
+    }
+    _process_msg(msg: services.KernelMessage.ICommMsg) {
+        if (this._on_msg) {
+            return this._on_msg(msg);
+        } else {
+            return Promise.resolve();
+        }
+    }
+    close() {
+        if (this._on_close) {
+            this._on_close();
+        }
+    }
+    send() {}
+    comm_id: string;
+    _on_msg: Function | null = null;
+    _on_close: Function | null = null;
+}
+
+export
+class DummyManager extends widgets.ManagerBase<HTMLElement> {
+    constructor() {
+        super();
+        this.el = window.document.createElement('div');
+    }
+
+    display_view(msg: services.KernelMessage.IMessage, view: Backbone.View<Backbone.Model>, options: any) {
+        // TODO: make this a spy
+        // TODO: return an html element
+        return Promise.resolve(view).then(view => {
+            this.el.appendChild(view.el);
+            view.on('remove', () => console.log('view removed', view));
+            return view.el;
+        });
+    }
+
+    protected loadClass(className: string, moduleName: string, moduleVersion: string): Promise<any> {
+        if (moduleName === '@jupyter-widgets/base') {
+            if ((widgets as any)[className]) {
+                return Promise.resolve((widgets as any)[className]);
+            } else {
+                return Promise.reject(`Cannot find class ${className}`)
+            }
+        } else if (moduleName === 'jupyter-datawidgets') {
+            if (this.testClasses[className]) {
+                return Promise.resolve(this.testClasses[className]);
+            } else {
+                return Promise.reject(`Cannot find class ${className}`)
+            }
+        } else {
+            return Promise.reject(`Cannot find module ${moduleName}`);
+        }
+    }
+
+    _get_comm_info() {
+        return Promise.resolve({});
+    }
+
+    _create_comm() {
+        return Promise.resolve(new MockComm());
+    }
+
+    el: HTMLElement;
+
+    testClasses: { [key: string]: any } = {};
+}
+
+
+export
+interface Constructor<T> {
+    new (attributes?: any, options?: any): T;
+}
+
+export
+function createTestModel<T extends widgets.WidgetModel>(constructor: Constructor<T>, attributes?: any): T {
+  let id = widgets.uuid();
+  let widget_manager = new DummyManager();
+  let modelOptions = {
+      widget_manager: widget_manager,
+      model_id: id,
+  }
+
+  return new constructor(attributes, modelOptions);
+}

{{cookiecutter.github_project_name}}/{{cookiecutter.python_package_name}}/tests/test_example.py

@@ -12,8 +12,3 @@
 def test_example_creation_blank():
     w = ExampleWidget()
     assert w.value == 'Hello World'
-
-
-def test_todo():
-    # TODO: Replace me with proper tests
-    assert 'Value' == 'Expected value'