Merge pull request #3172 from mbektasbbg/galata

Visual regression testing using Galata

Author: jtpio

.github/workflows/tests.yml

@@ -143,3 +143,79 @@ jobs:
       run: |
         python ./packages/schema/generate-spec.py -f markdown > spec.md
         diff -u ./packages/schema/jupyterwidgetmodels.latest.md ./spec.md
+  ui-test:
+    name: Visual Regression
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.7
+    - 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
+
+    - name: Use Node.js 12.x
+      uses: actions/setup-node@v1
+      with:
+        node-version: 12.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 }}
+        key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-yarn-
+
+    - name: Build and Install ipywidgets
+      run: |
+        yarn install --frozen-lockfile
+        yarn run build
+    - name: Build the extension
+      run: |
+        pip install .
+        jlpm install
+        jlpm run build
+        cd jupyterlab_widgets
+        pwd
+        pip install -e .
+        jupyter labextension develop . --overwrite
+        jupyter labextension list
+    - name: Install Galata
+      run: |
+        cd ui-tests
+        yarn install --frozen-lockfile
+    - name: Launch JupyterLab
+      run: |
+        cd ui-tests
+        yarn run start-jlab: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
+      if: always()
+      uses: actions/upload-artifact@v2
+      with:
+        name: ui-test-output
+        path: |
+          ui-tests/test-output
+
+      env:
+        CI: true

.gitignore

@@ -36,3 +36,5 @@ index.built.js.map
 temp/*
 
 tsconfig.tsbuildinfo
+
+ui-tests/test-output/*

docs/source/dev_testing.md

@@ -0,0 +1,3 @@
+{
+  "testId": "test"
+}

ui-tests/galata-config.json

@@ -0,0 +1,7 @@
+c.ServerApp.port = 8888
+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/jupyter_server_config.py

@@ -0,0 +1,16 @@
+{
+  "name": "ipywidgets-ui-tests",
+  "version": "1.0.0",
+  "description": "ipywidgets UI Tests",
+  "private": true,
+  "scripts": {
+    "start-jlab": "jupyter lab --config ./jupyter_server_config.py",
+    "start-jlab:detached": "yarn run start-jlab&",
+    "test": "galata"
+  },
+  "author": "Project Jupyter",
+  "license": "BSD-3-Clause",
+  "dependencies": {
+    "@jupyterlab/galata": "3.0.3-3"
+  }
+}