Add Jest, Playwright and pytest tests

.github/workflows/check-tests.yml

@@ -0,0 +1,72 @@
+name: Tests validation
+
+on:
+ push:
+ branches: ["*.0"]
+ pull_request:
+ branches: ["*"]
+ schedule:
+ - cron: "0 0 * * *"
+
+jobs:
+ tests:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+
+ - name: Base Setup
+ uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+
+ - name: Install dependencies
+ run: python -m pip install -U cookiecutter check-manifest jupyterlab~=3.1
+
+ - name: Create the extension
+ run: |
+ set -eux
+ # Trick to use custom parameters
+ python -m cookiecutter --no-input .
+
+ - name: Test the extension
+ working-directory: myextension
+ run: |
+ set -eux
+ jlpm
+ jlpm test
+
+ - name: Install the extension
+ working-directory: myextension
+ run: |
+ set -eux
+ python -m pip install .
+
+ - name: Install dependencies
+ working-directory: myextension/ui-tests
+ env:
+ PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
+ run: jlpm install
+
+ - name: Set up browser cache
+ uses: actions/cache@v2
+ with:
+ path: |
+ ${{ github.workspace }}/pw-browsers
+ key: ${{ runner.os }}-${{ hashFiles('myextension/ui-tests/yarn.lock') }}
+
+ - name: Install browser
+ run: jlpm playwright install chromium
+ working-directory: myextension/ui-tests
+
+ - name: Execute integration tests
+ working-directory: myextension/ui-tests
+ run: |
+ jlpm playwright test
+
+ - name: Upload Playwright Test report
+ if: always()
+ uses: actions/upload-artifact@v2
+ with:
+ name: myextension-playwright-tests
+ path: |
+ myextension/ui-tests/test-results
+ myextension/ui-tests/playwright-report

.github/workflows/main.yml

@@ -41,18 +41,18 @@ jobs:
  # Trick to use custom parameters
  python -c "from cookiecutter.main import cookiecutter; import json, os; f=open('cookiecutter.json'); d=json.load(f); f.close(); d['labextension_name']=os.getenv('NAME'); cookiecutter('.', extra_context=d, no_input=True)"
  pushd ${PYNAME}
- pip install jupyterlab
+ python -m pip install jupyterlab
  jlpm
  jlpm stylelint-config-prettier-check
  jlpm lint:check
- pip install -e .
+ python -m pip install -e .
  jupyter labextension develop . --overwrite
  jupyter labextension list
  jupyter labextension list 2>&1 | grep -ie "${NAME}.*OK"
  python -m jupyterlab.browser_check
 
  jupyter labextension uninstall ${NAME}
- pip uninstall -y ${NAME} jupyterlab
+ python -m pip uninstall -y ${NAME} jupyterlab
 
  git init && git add .
  check-manifest -v
@@ -154,11 +154,14 @@ jobs:
  # Trick to use custom parameters
  python -c "from cookiecutter.main import cookiecutter; import json; f=open('cookiecutter.json'); d=json.load(f); f.close(); d['kind']='server'; cookiecutter('.', extra_context=d, no_input=True)"
  cd myextension
- pip install -e .
- pip install jupyterlab
+ python -m pip install -e .[test]
+ python -m pip install jupyterlab
  jupyter labextension develop . --overwrite
  jupyter server extension enable myextension
 
+ # Check unit tests are passing
+ python -m pytest -vv -r ap --cov myextension
+
  - name: Check pip develop method
  run: |
  set -eux
@@ -177,7 +180,7 @@ jobs:
  jupyter labextension build ./myextension
 
  jupyter labextension uninstall myextension
- pip uninstall -y myextension jupyterlab
+ python -m pip uninstall -y myextension jupyterlab
 
  python -c "import shutil; shutil.rmtree('myextension')"
 
@@ -186,11 +189,11 @@ jobs:
  # Trick to use custom parameters
  python -c "from cookiecutter.main import cookiecutter; import json; f=open('cookiecutter.json'); d=json.load(f); f.close(); d['kind']='server'; cookiecutter('.', extra_context=d, no_input=True)"
  cd myextension
- pip install jupyterlab
+ python -m pip install jupyterlab
  jupyter lab clean --all
  python -m build --sdist
  cd dist
- pip install myextension-0.1.0.tar.gz
+ python -m pip install myextension-0.1.0.tar.gz
 
  - name: Check install tarball method
  run: |
@@ -205,7 +208,7 @@ jobs:
  python -m jupyterlab.browser_check
 
  cp myextension/dist/*.tar.gz myextension.tar.gz
- pip uninstall -y myextension jupyterlab
+ python -m pip uninstall -y myextension jupyterlab
  rm -rf myextension
  shell: bash
 
@@ -248,8 +251,8 @@ jobs:
  sudo rm -rf $(which node)
  sudo rm -rf $(which node)
 
- pip install myextension.tar.gz
- pip install jupyterlab
+ python -m pip install myextension.tar.gz
+ python -m pip install jupyterlab
  jupyter labextension list 2>&1 | grep -ie "myextension.*OK"
  jupyter server extension list
  jupyter server extension list 2>&1 | grep -ie "myextension.*OK"
@@ -279,17 +282,17 @@ jobs:
  # Trick to use custom parameters
  python -c "from cookiecutter.main import cookiecutter; import json; f=open('cookiecutter.json'); d=json.load(f); f.close(); d['kind']='theme'; cookiecutter('.', extra_context=d, no_input=True)"
  pushd mytheme
- pip install jupyterlab
+ python -m pip install jupyterlab
  jlpm
  jlpm lint:check
- pip install -e .
+ python -m pip install -e .
  jupyter labextension develop . --overwrite
  jupyter labextension list
  jupyter labextension list 2>&1 | grep -ie "mytheme.*OK"
  python -m jupyterlab.browser_check
 
  jupyter labextension uninstall mytheme
- pip uninstall -y mytheme jupyterlab
+ python -m pip uninstall -y mytheme jupyterlab
 
  git init && git add .
  check-manifest -v

hooks/post_gen_project.py

@@ -35,7 +35,9 @@ def remove_path(path: str) -> None:
  for f in (
  "{{ cookiecutter.python_name }}/handlers.py",
  "src/handler.ts",
- "jupyter-config"
+ "jupyter-config",
+ "conftest.py",
+ "{{ cookiecutter.python_name }}/tests"
  ):
  remove_path(PROJECT_DIRECTORY / f)
 

{{cookiecutter.python_name}}/.eslintignore

@@ -3,3 +3,6 @@ dist
 coverage
 **/*.d.ts
 tests
+
+**/__tests__
+ui-tests

{{cookiecutter.python_name}}/.github/workflows/build.yml

@@ -9,6 +9,7 @@ on:
 jobs:
  build:
  runs-on: ubuntu-latest
+
  steps:
  - name: Checkout
  uses: actions/checkout@v2
@@ -19,30 +20,45 @@ jobs:
  - name: Install dependencies
  run: python -m pip install -U jupyterlab~=3.1 check-manifest
 
- - name: Build the extension
+ - name: Lint the extension
  run: |
  set -eux
  jlpm
- jlpm lint:check
- python -m pip install .
+ jlpm run lint:check
+
+ - name: Test the extension
+ run: |
+ set -eux
+ jlpm run test
+
+ - name: Build the extension
+ run: |
+ set -eux
+ python -m pip install .[test]
 {% if cookiecutter.kind.lower() == 'server' %}
+ pytest -vv -r ap --cov {{ cookiecutter.python_name }}
+ jupyter server extension list
  jupyter server extension list 2>&1 | grep -ie "{{ cookiecutter.python_name }}.*OK"
 {% endif %}
+ jupyter labextension list
  jupyter labextension list 2>&1 | grep -ie "{{ cookiecutter.labextension_name }}.*OK"
  python -m jupyterlab.browser_check
 
+ - name: Package the extension
+ run: |
+ set -eux
  check-manifest -v
 
  pip install build
- python -m build --sdist
- cp dist/*.tar.gz myextension.tar.gz
+ python -m build
  pip uninstall -y "{{ cookiecutter.python_name }}" jupyterlab
- rm -rf myextension
 
- - uses: actions/upload-artifact@v2
+ - name: Upload extension packages
+ uses: actions/upload-artifact@v2
  with:
- name: myextension-sdist
- path: myextension.tar.gz
+ name: extension-artifacts
+ path: dist/{{ cookiecutter.python_name }}*
+ if-no-files-found: error
 
  test_isolated:
  needs: build
@@ -54,18 +70,80 @@ jobs:
  - name: Install Python
  uses: actions/setup-python@v2
  with:
- python-version: '3.8'
+ python-version: '3.9'
  architecture: 'x64'
  - uses: actions/download-artifact@v2
  with:
- name: myextension-sdist
+ name: extension-artifacts
  - name: Install and Test
  run: |
  set -eux
  # Remove NodeJS, twice to take care of system and locally installed node versions.
  sudo rm -rf $(which node)
  sudo rm -rf $(which node)
- pip install myextension.tar.gz
- pip install jupyterlab
+
+ pip install "jupyterlab~=3.1" {{ cookiecutter.python_name }}*.whl
+
+{% if cookiecutter.kind.lower() == 'server' %}
+ jupyter server extension list
+ jupyter server extension list 2>&1 | grep -ie "{{ cookiecutter.python_name }}.*OK"
+{% endif %}
+ jupyter labextension list
  jupyter labextension list 2>&1 | grep -ie "{{ cookiecutter.labextension_name }}.*OK"
  python -m jupyterlab.browser_check --no-chrome-test
+
+ integration-tests:
+ name: Integration tests
+ needs: build
+ runs-on: ubuntu-latest
+
+ env:
+ PLAYWRIGHT_BROWSERS_PATH: ${{ "{{ github.workspace }}" }}/pw-browsers
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+
+ - name: Base Setup
+ uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+
+ - name: Download extension package
+ uses: actions/download-artifact@v2
+ with:
+ name: extension-artifacts
+
+ - name: Install the extension
+ run: |
+ set -eux
+ python -m pip install "jupyterlab~=3.1" {{ cookiecutter.python_name }}*.whl
+
+ - name: Install dependencies
+ working-directory: ui-tests
+ env:
+ PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
+ run: jlpm install
+{% raw %}
+ - name: Set up browser cache
+ uses: actions/cache@v2
+ with:
+ path: |
+ ${{ github.workspace }}/pw-browsers
+ key: ${{ runner.os }}-${{ hashFiles('ui-tests/yarn.lock') }}
+{% endraw %}
+ - name: Install browser
+ run: jlpm playwright install chromium
+ working-directory: ui-tests
+
+ - name: Execute integration tests
+ working-directory: ui-tests
+ run: |
+ jlpm playwright test
+
+ - name: Upload Playwright Test report
+ if: always()
+ uses: actions/upload-artifact@v2
+ with:
+ name: {{ cookiecutter.python_name }}-playwright-tests
+ path: |
+ ui-tests/test-results
+ ui-tests/playwright-report

{{cookiecutter.python_name}}/.github/workflows/update-integration-tests.yml

@@ -0,0 +1,44 @@
+name: Update Playwright Snapshots
+
+on:
+ issue_comment:
+ types: [created, edited]
+
+permissions:
+ contents: write
+ pull-requests: write
+
+jobs:
+ {# Escape double curly brace #}
+ {% raw %}
+ update-snapshots:
+ if: ${{ github.event.issue.pull_request && contains(github.event.comment.body, 'please update playwright snapshots') }}
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+ with:
+ token: ${{ secrets.GITHUB_TOKEN }}
+
+ - name: Configure git to use https
+ run: git config --global hub.protocol https
+
+ - name: Checkout the branch from the PR that triggered the job
+ run: hub pr checkout ${{ github.event.issue.number }}
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+ - name: Install dependencies
+ run: |
+ set -eux
+ jlpm
+ python -m pip install .
+
+ - uses: jupyterlab/maintainer-tools/.github/actions/update-snapshots@v1
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ # Playwright knows how to start JupyterLab server
+ start_server_script: 'null'
+ test_folder: ui-tests
+ {% endraw %}

{{cookiecutter.python_name}}/.gitignore

@@ -8,6 +8,10 @@ node_modules/
 *.tsbuildinfo
 {{cookiecutter.python_name}}/labextension
 
+# Integration tests
+ui-tests/test-results/
+ui-tests/playwright-report/
+
 # Created by https://www.gitignore.io/api/python
 # Edit at https://www.gitignore.io/?templates=python