Use galata for integration tests (#1030)

* Use future galata for ui-tests

* Fix CI

* WIP

* Wait for the server

* Refactor

* Use extension merge feature

* Lint config file

* Force repository status update

* Run server in debug mode

* Fix linter

* Fix CI

* Refactor ui tests

* Set server log to debug

* Set git config globally

* [skip ci] use default server log level

Author: fcollonval

.github/workflows/build.yml

@@ -2,24 +2,24 @@ name: Build
 
 on:
   push:
-    branches: master
+    branches: ['master']
   pull_request:
-    branches: '*'
+    branches: ['master']
 
 jobs:
   test-3x:
     name: Test Python ${{ matrix.python-version }}
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.6', '3.7', '3.8', '3.9']
+        python-version: ['3.7', '3.8', '3.9', '3.10']
     steps:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Install node
         uses: actions/setup-node@v1
         with:
-          node-version: '12.x'
+          node-version: '14.x'
       - name: Setup Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with:
@@ -59,7 +59,7 @@ jobs:
             ${{ runner.os }}-yarn-
 
       - name: Install dependencies
-        run: python -m pip install -U jupyter_packaging~=0.7.9 jupyterlab~=3.0 pip wheel
+        run: python -m pip install -U jupyter_packaging~=0.7.9 jupyterlab~=3.0 pip wheel build
       - name: Test the extension
         run: |
           jlpm
@@ -83,13 +83,14 @@ jobs:
           jupyter labextension list 2>&1 | grep -ie "@jupyterlab/git.*OK"
           python -m jupyterlab.browser_check
 
+          python -m build -w
+
       - uses: actions/upload-artifact@v2
         if: matrix.python-version == '3.9'
         with:
           name: extension
-          path: |
-            jupyterlab_git
-            jupyter-config
+          path: dist/jupyterlab_git*.whl
+          if-no-files-found: error
 
   ui-test:
     name: Integration tests
@@ -100,30 +101,77 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
+      - name: Install node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '14.x'
       - uses: actions/download-artifact@v2
         with:
           name: extension
+      - name: Setup Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+          architecture: 'x64'
 
-      - name: UI tests
+      - name: Get pip cache dir
+        id: pip-cache
         run: |
-          docker-compose -f ./docker/docker-compose.yml down || true
-          docker-compose -f ./docker/docker-compose.yml pull -q || true
-          docker-compose -f ./docker/docker-compose.yml build
-          docker-compose -f ./docker/docker-compose.yml run --rm e2e
+          echo "::set-output name=dir::$(pip cache dir)"
+
+      - name: pip cache
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-3.9-${{ hashFiles('**/setup.py') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-3.9-
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        # Install jupyter-archive to deal with test git repository upload
+        run: |
+          python -m pip install -U pip
+          python -m pip install jupyterlab~=3.0 jupyter-archive ./jupyterlab_git*.whl
+
+      - name: Set up git
+        run: |
+          git config --global user.name 'Test Bot'
+          git config --global user.email '[email protected]'
+
+      - name: Start server for UI tests
+        working-directory: ui-tests
+        run: |
+          jlpm
+          (jupyter lab --config jupyter_server_test_config.py > /tmp/jupyterlab_server.log 2>&1) &
+          jlpm run playwright install chromium
+
+      - name: Wait for JupyterLab
+        uses: ifaxity/wait-on-action@v1
+        with:
+          resource: http-get://localhost:8888/lab
+          timeout: 180000
+
+      - name: UI tests
         working-directory: ui-tests
+        run: |
+          jlpm run playwright test
 
       - name: Upload UI Test artifacts
         if: always()
         uses: actions/upload-artifact@v2
         with:
           name: ui-test-output
           path: |
+            ui-tests/playwright-report
             ui-tests/test-results
 
-      - name: Stop containers
+      - name: Stop JupyterLab
         if: always()
         run: |
-          # Print jupyterlab logs before removing the containers using the container name set in docker-compose file
-          docker logs jupyterlab
-          docker-compose -f ./docker/docker-compose.yml down
-        working-directory: ui-tests
+          kill -s SIGTERM $(pgrep jupyter-lab)
+
+      - name: Print JupyterLab logs
+        if: always()
+        run: |
+          cat /tmp/jupyterlab_server.log

.gitignore

@@ -137,5 +137,5 @@ dmypy.json
 src/version.ts
 
 # Integration tests
-ui-tests/node_modules/
-ui-tests/test-results/
+test-results/
+playwright-report/

ui-tests/README.md

@@ -1,29 +1,6 @@
 # Test
 
-The test will produce a video to help debugging and check what happened.
-
-To execute integration tests, you have two options:
-
-- use docker-compose (cons: needs to know and use docker) - this is a more reliable solution.
-- run tests locally (cons: will interact with your JupyterLab user settings)
-
-## Test on docker
-
-1. Compile the extension:
-
-```
-jlpm install
-```
-
-2. Execute the docker stack in the ui-tests folder:
-
-```
-docker-compose -f ./docker/docker-compose.yml build --no-cache
-docker-compose -f ./docker/docker-compose.yml run --rm e2e
-docker-compose -f ./docker/docker-compose.yml down
-```
-
-## Test locally
+The test will produce a video to help debugging in case of failures and check what happened.
 
 1. Compile the extension:
 
@@ -35,16 +12,16 @@ jlpm run build:prod
 2. Start JupyterLab _with the extension installed_ without any token or password
 
 ```
-jupyter lab --ServerApp.token= --ServerApp.password=
+jupyter lab --config ./ui-tests/jupyter_server_config.py
 ```
 
 3. Execute in another console the [Playwright](https://playwright.dev/docs/intro) tests:
 
 ```
 cd ui-tests
 jlpm install
-npx playwright install
-npx playwright test
+jlpm playwright install
+jlpm playwright test
 ```
 
 # Create tests
@@ -60,25 +37,17 @@ jlpm run build:prod
 
 2. Start JupyterLab _with the extension installed_ without any token or password:
 
-**Using docker**
-
-```
-docker-compose -f ./docker/docker-compose.yml run --rm -p 8888:8888 lab
-```
-
-**Using local installation**
-
 ```
-jupyter lab --ServerApp.token= --ServerApp.password=
+jupyter lab --config ./ui-tests/jupyter_server_config.py
 ```
 
 3. Launch the code generator tool:
 
 ```
 cd ui-tests
 jlpm install
-npx playwright install
-npx playwright codegen localhost:8888
+jlpm playwright install
+jlpm playwright codegen localhost:8888
 ```
 
 # Debug tests
@@ -94,23 +63,15 @@ jlpm run build:prod
 
 2. Start JupyterLab _with the extension installed_ without any token or password:
 
-**Using docker**
-
-```
-docker-compose -f ./docker/docker-compose.yml run --rm -p 8888:8888 lab
-```
-
-**Using local installation**
-
 ```
-jupyter lab --ServerApp.token= --ServerApp.password=
+jupyter lab --config ./ui-tests/jupyter_server_config.py
 ```
 
 3. Launch the debug tool:
 
 ```
 cd ui-tests
 jlpm install
-npx playwright install
-PWDEBUG=1 npx playwright test
+jlpm playwright install
+PWDEBUG=1 jlpm playwright test
 ```