Add Jest, Playwright and pytest tests

.github/workflows/check-tests.yml

@@ -0,0 +1,71 @@
+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
+          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

@@ -30,7 +30,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-          python -m pip install cookiecutter check-manifest build
+          python -m pip install cookiecutter check-manifest
 
       - name: Create pure frontend extension
         env:
@@ -39,27 +39,69 @@ jobs:
         run: |
           set -eux
           # 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)"
+          python -c "from cookiecutter.main import cookiecutter; import json, os; f=open('cookiecutter.json'); d=json.load(f); f.close(); d['kind']=d['kind'][0]; 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
 
           popd
           rm -rf ${NAME}
 
+  no-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # This will be used by the base setup action
+        python-version: ["3.10"]
+
+    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 cookiecutter check-manifest
+
+      - name: Create pure frontend extension
+        run: |
+          set -eux
+          # 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']=d['kind'][0]; d['test']='n'; cookiecutter('.', extra_context=d, no_input=True)"
+          pushd myextension
+          pip install jupyterlab
+          jlpm
+          jlpm lint:check
+          pip install -e .
+          jupyter labextension develop . --overwrite
+          jupyter labextension list
+          jupyter labextension list 2>&1 | grep -ie "myextension.*OK"
+          python -m jupyterlab.browser_check
+
+          jupyter labextension uninstall myextension
+          pip uninstall -y myextension jupyterlab
+
+          git init && git add .
+          check-manifest -v
+
+          popd
+          rm -rf myextension
+
   settings:
     runs-on: ubuntu-latest
     strategy:
@@ -76,13 +118,13 @@ jobs:
 
       - name: Install dependencies
         run: |
-          python -m pip install cookiecutter check-manifest build
+          python -m pip install cookiecutter check-manifest
 
       - name: Create pure frontend extension
         run: |
           set -eux
           # 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['has_settings']='y'; cookiecutter('.', extra_context=d, no_input=True)"
+          python -c "from cookiecutter.main import cookiecutter; import json; f=open('cookiecutter.json'); d=json.load(f); f.close(); d['kind']=d['kind'][0]; d['has_settings']='y'; cookiecutter('.', extra_context=d, no_input=True)"
           pushd myextension
           pip install jupyterlab
           jlpm
@@ -154,11 +196,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 +222,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 +231,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 +250,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 +293,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 +324,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

cookiecutter.json

@@ -7,5 +7,6 @@
   "project_short_description": "A JupyterLab extension.",
   "has_settings": "n",
   "has_binder": "n",
+  "test": "y",
   "repository": "https://github.com/github_username/{{ cookiecutter.labextension_name }}"
 }

hooks/post_gen_project.py

@@ -4,11 +4,14 @@
 PROJECT_DIRECTORY = Path.cwd()
 
 
-def remove_path(path: str) -> None:
+def remove_path(path: Path) -> None:
     """Remove the provided path.
 
     If the target path is a directory, remove it recursively.
     """
+    if not path.exists():
+        return
+
     if path.is_file():
         path.unlink()
     elif path.is_dir():
@@ -35,10 +38,21 @@ 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)
 
     if not "{{ cookiecutter.has_binder }}".lower().startswith("y"):
         remove_path(PROJECT_DIRECTORY / "binder")
         remove_path(PROJECT_DIRECTORY / ".github/workflows/binder-on-pr.yml")
+
+    if not "{{ cookiecutter.test }}".lower().startswith("y"):
+        remove_path(PROJECT_DIRECTORY / ".github" / "workflows" / "update-integration-tests.yml")
+        remove_path(PROJECT_DIRECTORY / "src" / "__tests__")
+        remove_path(PROJECT_DIRECTORY / "ui-tests")
+        remove_path(PROJECT_DIRECTORY / "{{ cookiecutter.python_name }}" / "tests")
+        remove_path(PROJECT_DIRECTORY / "babel.config.js")
+        remove_path(PROJECT_DIRECTORY / "conftest.py")
+        remove_path(PROJECT_DIRECTORY / "jest.config.js")

{{cookiecutter.python_name}}/.eslintignore

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