Initial playwright setup

.github/workflows/kubernetes_test.yaml

@@ -31,6 +31,9 @@ on:
         required: true
         type: string
 
+env:
+  NEBARI_BASE_URL: "github-actions.nebari.dev"
+
 jobs:
   test-kubernetes:
     if: github.event.pull_request.head.repo.full_name == github.repository || github.event_name != 'pull_request'
@@ -70,6 +73,7 @@ jobs:
         run: |
           conda install -c anaconda pip
           pip install .[dev]
+          playwright install --with-deps
       - name: Download and Install Kubectl
         run: |
           mkdir -p bin
@@ -92,12 +96,12 @@ jobs:
           ip route
       - name: Add DNS entry to hosts
         run: |
-          sudo echo "172.18.1.100  github-actions.nebari.dev" | sudo tee -a /etc/hosts
+          sudo echo "172.18.1.100  $NEBARI_BASE_URL" | sudo tee -a /etc/hosts
       - name: Initialize Nebari Cloud
         run: |
           mkdir -p local-deployment
           cd local-deployment
-          nebari init local --project=thisisatest --domain github-actions.nebari.dev --auth-provider=password
+          nebari init local --project=thisisatest --domain $NEBARI_BASE_URL --auth-provider=password
 
           # Need smaller profiles on Local Kind
           sed -i -E 's/(cpu_guarantee):\s+[0-9\.]+/\1: 0.25/g' "nebari-config.yaml"
@@ -112,12 +116,12 @@ jobs:
         if: always()
         run: |
           kubectl get all,cm,secret,ing -A
-      - name: Check github-actions.nebari.dev resolves
+      - name: Check $NEBARI_BASE_URL resolves
         run: |
-          nslookup github-actions.nebari.dev
+          nslookup $NEBARI_BASE_URL
       - name: Curl jupyterhub login page
         run: |
-          curl -k https://github-actions.nebari.dev/hub/home -i
+          curl -k https://$NEBARI_BASE_URL/hub/home -i
 
       ### CYPRESS TESTS
       - name: Setup Node
@@ -146,10 +150,20 @@ jobs:
           nebari keycloak adduser --user "${CYPRESS_EXAMPLE_USER_NAME}" "${CYPRESS_EXAMPLE_USER_PASSWORD}" --config "${NEBARI_CONFIG_PATH}"
           nebari keycloak listusers --config "${NEBARI_CONFIG_PATH}"
 
+      - name: Playwright Tests
+        env:
+          USERNAME: ${{ secrets.EXAMPLE_USER_NAME }}
+          PASSWORD: ${{ secrets.EXAMPLE_USER_PASSWORD }}
+          NEBARI_FULL_URL: "https://${{ env.NEBARI_BASE_URL }}/"
+        working-directory: tests_e2e/playwright
+        run: |
+          envsubst < .env.tpl > .env
+          pytest --browser chromium
+
       - name: Cypress run
         uses: cypress-io/github-action@v4
         env:
-          CYPRESS_BASE_URL: https://github-actions.nebari.dev/
+          CYPRESS_BASE_URL: "https://${{ env.NEBARI_BASE_URL }}/"
         with:
           working-directory: tests_e2e
 
@@ -161,6 +175,7 @@ jobs:
           path: |
             ./tests_e2e/cypress/screenshots/
             ./tests_e2e/cypress/videos/
+            ${{ env.NEBARI_CONFIG_PATH }}
 
       - name: Deployment Pytests
         run: |
@@ -174,13 +189,15 @@ jobs:
         run: |
           export JUPYTERHUB_USERNAME=${CYPRESS_EXAMPLE_USER_NAME}
           export JUPYTERHUB_PASSWORD=${CYPRESS_EXAMPLE_USER_PASSWORD}
-          jhubctl --verbose run --hub=https://github-actions.nebari.dev \
+          jhubctl --verbose run --hub=https://$NEBARI_BASE_URL \
                                 --auth-type=keycloak \
                                 --validate --no-verify-ssl \
                                 --kernel python3 \
                                 --stop-server \
                                 --notebook tests_deployment/assets/notebook/simple.ipynb \
 
+
+
       ### CLEANUP AFTER TESTS
       - name: Cleanup nebari deployment
         run: |

.github/workflows/test.yaml

@@ -6,7 +6,7 @@ on:
       - ".github/workflows/test.yaml"
       - "tests/**"
       - "tests_deployment/**"
-      - "tests_e2e/**"
+      - "tests_e2e/cypress/**"
       - "scripts/**"
       - "nebari/**"
       - "setup.cfg"
@@ -20,7 +20,7 @@ on:
       - ".github/workflows/test.yaml"
       - "tests/**"
       - "tests_deployment/**"
-      - "tests_e2e/**"
+      - "tests_e2e/cypress/**"
       - "scripts/**"
       - "nebari/**"
       - "setup.cfg"
@@ -52,4 +52,4 @@ jobs:
       - name: Test Nebari
         run: |
           pytest --version
-          pytest --ignore=tests_deployment
+          pytest --ignore=tests_deployment --ignore=tests_e2e/playwright

.gitignore

@@ -1,6 +1,7 @@
 # docs
 .nox
 _build
+.env
 
 # setuptools scm
 nebari/_version.py
@@ -45,5 +46,7 @@ nebari-config.yaml
 
 .vscode/
 .pytest_cache
+.ipynb_checkpoints
+.DS_Store
 
 /.ruff_cache

pyproject.toml

@@ -72,6 +72,7 @@ dev = [
     "black==22.3.0",
     "dask-gateway",
     "diagrams",
+    "python-dotenv",
     "escapism",
     "flake8==3.8.4",
     "importlib-metadata<5.0",
@@ -80,6 +81,7 @@ dev = [
     "pre-commit",
     "pytest",
     "pytest-timeout",
+    "pytest-playwright",
 ]
 
 [project.urls]

tests_e2e/playwright/.env.tpl

@@ -0,0 +1,3 @@
+USERNAME=""
+PASSWORD=""
+NEBARI_FULL_URL=""

tests_e2e/playwright/README.md

@@ -0,0 +1,67 @@
+# Nebari integration testing with Playwright
+
+
+## How does it work?
+
+Playwright manages interactions with any website. We are using it to interact
+with a deployed Nebari instance and test the various integrations that are
+included.
+
+For our test suite, we utilize Playwright's synchronous API. The first task
+is to launch the web browser you'd like to test in. Options in our test suite
+are `chromium`, `webkit`, and `firefox`. Playwright uses browser contexts to
+achieve test isolation. The context can either be created by default or
+manually (for the purposes of generating multiple contexts per test in the case
+of admin vs user testing). Next the page on the browser is created. For all
+tests this starts as a blank page, then during the test, we navigate to a given
+url.
+
+## Setup
+
+Install Nebari with the development requirements (which include Playwright)
+
+`pip install -e ".[dev]"`
+
+The install playwright
+
+`playwright install`
+
+
+## Writing Playwright tests
+
+In general most of the testing happens through `assertions` and `locators`.
+The Playwright API has several mechanism for getting a locator for an item on
+the page.
+
+```python
+button = self.page.get_by_role("button", name="Sign in with Keycloak")
+```
+
+Once you have a handle locator, you can interact with it in different ways,
+depending on the type of object. For example, clicking
+a button:
+
+```python
+button.click()
+```
+
+Occasionally you'll need to wait for things to load on the screen. We can
+achieve this through several mechanisms. We can either wait for the page to
+finish loading:
+
+```python
+self.page.wait_for_load_state("networkidle")
+```
+
+or we can wait for something specific to happen with the locator itself:
+
+```python
+button.wait_for(timeout=3000, state="attached")
+```
+
+
+
+## Notes
+Playwright dev tips:
+* when its running, don't touch anything - this should go without saying,
+but its easy to forget