Merge pull request #3279 from jtpio/update-galata

Update to the new Galata

Author: jasongrout

.github/workflows/tests.yml

@@ -151,27 +151,30 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v2
       with:
-        python-version: 3.7
+        python-version: 3.9
     - uses: actions/cache@v1
       with:
         path: ~/.cache/pip
         key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}-${{hashFiles('**/requirements.txt')}}
         restore-keys: |
           ${{ runner.os }}-pip-
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install jupyterlab==3.0.3
+        python -m pip install -U jupyterlab~=3.2 jupyter-packaging~=0.10
 
-    - name: Use Node.js 12.x
-      uses: actions/setup-node@v1
+    - name: Set up Node
+      uses: actions/setup-node@v2
       with:
-        node-version: 12.x
+        node-version: 14.x
+
     - name: Get yarn cache
       id: yarn-cache
       run: echo "::set-output name=dir::$(yarn cache dir)"
+
     - uses: actions/cache@v1
       with:
         path: ${{ steps.yarn-cache.outputs.dir }}
@@ -183,6 +186,7 @@ jobs:
       run: |
         yarn install --frozen-lockfile
         yarn run build
+
     - name: Build the extension
       run: |
         cd python/ipywidgets
@@ -195,42 +199,54 @@ jobs:
         pip install -e .
         jupyter labextension develop . --overwrite
         jupyter labextension list
-    - name: Install Galata
+
+    - name: Install Test Dependencies
       run: |
         cd ui-tests
         yarn install --frozen-lockfile
+        yarn playwright install chromium
+
     - name: Launch JupyterLab
       run: |
         cd ui-tests
-        yarn run start-jlab:detached
+        yarn run start:detached
+
     - name: Wait for JupyterLab
       uses: ifaxity/wait-on-action@v1
       with:
         resource: http-get://localhost:8888/api
         timeout: 20000
+
     - name: Run UI Tests
       run: |
         cd ui-tests
         yarn run test
-    - name: Upload UI Test artifacts
+
+    - name: Upload Playwright Test assets
       if: always()
       uses: actions/upload-artifact@v2
       with:
-        name: ipywidgets-ui-test-output
+        name: ipywidgets-test-assets
         path: |
-          ui-tests/test-output
-    - name: Run UI Tests
-      if: ${{ failure() }}
-      run: |
-        cd ui-tests
-        jlpm run test:create-references
-    - name: Upload UI Test new reference artifacts
-      if: ${{ failure() }}
+          ui-tests/test-results
+
+    - name: Upload Playwright Test report
+      if: always()
       uses: actions/upload-artifact@v2
       with:
-        name: ipywidgets-ui-test-new-reference
+        name: ipywidgets-test-report
         path: |
-          ui-tests/test-output/test/screenshots/*.png
+          ui-tests/playwright-report
 
-      env:
-        CI: true
+    - name: Update snapshots
+      if: failure()
+      run: |
+        cd ui-tests
+        yarn run test:update
+
+    - name: Upload updated snapshots
+      if: failure()
+      uses: actions/upload-artifact@v2
+      with:
+        name: ipywidgets-updated-snapshots
+        path: ui-tests/tests

.gitignore

@@ -37,4 +37,5 @@ temp/*
 
 tsconfig.tsbuildinfo
 
-ui-tests/test-output/*
+ui-tests/test-results
+ui-tests/playwright-report

docs/source/dev_testing.md

@@ -1,7 +1,10 @@
+from tempfile import mkdtemp
+
 c.ServerApp.port = 8888
+c.ServerApp.open_browser = False
+c.ServerApp.root_dir = mkdtemp(prefix='galata-test-')
 c.ServerApp.token = ""
 c.ServerApp.password = ""
 c.ServerApp.disable_check_xsrf = True
-c.ServerApp.open_browser = False
-c.LabApp.open_browser = False
+
 c.LabApp.expose_app_in_browser = True

ui-tests/galata-config.json

@@ -1,17 +1,19 @@
 {
-  "name": "ipywidgets-ui-tests",
-  "version": "1.0.0",
-  "description": "ipywidgets UI Tests",
+  "name": "@jupyter-widgets/ui-tests",
   "private": true,
+  "version": "0.1.0",
+  "description": "ipywidgets UI Tests",
   "scripts": {
-    "start-jlab": "jupyter lab --config ./jupyter_server_config.py",
-    "start-jlab:detached": "yarn run start-jlab&",
-    "test:create-references": "galata --skip-visual-regression --skip-html-regression",
-    "test": "galata"
+    "start": "jupyter lab --config ./jupyter_server_config.py",
+    "start:detached": "yarn run start&",
+    "test": "playwright test",
+    "test:debug": "PWDEBUG=1 playwright test",
+    "test:report": "http-server ./playwright-report -a localhost -o",
+    "test:update": "playwright test --update-snapshots"
   },
   "author": "Project Jupyter",
   "license": "BSD-3-Clause",
   "dependencies": {
-    "@jupyterlab/galata": "3.0.11-2"
+    "@jupyterlab/galata": "~4.0.2"
   }
 }

ui-tests/jupyter_server_config.py

@@ -0,0 +1,7 @@
+const baseConfig = require('@jupyterlab/galata/lib/playwright-config');
+
+module.exports = {
+  ...baseConfig,
+  timeout: 240000,
+  retries: 1,
+};