test(e2e): add end to end test setup with webdriver-io

.github/workflows/ci.yaml → .github/workflows/code-linting.yaml

@@ -6,19 +6,17 @@ on:
     branches: [ main ]
 
 jobs:
-  audit:
+  lint-code:
     strategy:
       matrix:
         os: [macos-latest, ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
     - name: Checkout
       uses: actions/checkout@v4
-    - uses: pnpm/action-setup@v3
-      with:
-        version: 8
+    - uses: pnpm/action-setup@v4
     - name: Install Node.js
-      uses: actions/setup-node@v4
+      uses: actions/setup-node@v4.1.0
       with:
         node-version: 20.x
         cache: 'pnpm'
@@ -28,11 +26,3 @@ jobs:
       run: pnpm run lint
     - name: Test Typings
       run: pnpm run test:typings
-    - name: Test Unit
-      run: pnpm run test:unit
-    - name: Test E2E (Linux)
-      if: runner.os == 'Linux'
-      run: xvfb-run -a pnpm run test:e2e
-    - name: Test E2E (non-Linux)
-      if: runner.os != 'Linux'
-      run: pnpm run test:e2e

.github/workflows/commit-linting.yaml

@@ -1,4 +1,4 @@
-name: Commit linting
+name: CI
 on:
   pull_request:
     branches: [ main ]

.github/workflows/e2e-testing.yaml

@@ -0,0 +1,92 @@
+name: CI
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test-e2e:
+    strategy:
+      matrix:
+        os: [macos-latest, ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Install Radicle
+      env:
+        RAD_HOME: ${{ github.workspace }}/.radicle
+      run: |
+        echo "Installing radicle-node..."
+        curl -sSf https://radicle.xyz/install | sh
+
+        echo "Installing radicle-httpd..."
+
+        case "$(uname)/$(uname -m)" in
+        Darwin/arm64)
+          export TARGET="aarch64-apple-darwin" ;;
+        Darwin/x86_64)
+          export TARGET="x86_64-apple-darwin" ;;
+        Linux/arm64|Linux/aarch64)
+          export TARGET="aarch64-unknown-linux-musl" ;;
+        Linux/x86_64)
+          export TARGET="x86_64-unknown-linux-musl" ;;
+        *)
+          fatal "Your operating system is currently unsupported. Sorry!" ;;
+        esac
+        echo $TARGET
+        curl -s https://files.radicle.xyz/releases/radicle-httpd/0.17.0/radicle-httpd-0.17.0-$TARGET.tar.xz | tar -xJ --strip-components=2
+        mv radicle-httpd $RAD_HOME/bin/radicle-httpd
+
+        # add to path
+        echo "${RAD_HOME}/bin" >> $GITHUB_PATH
+        echo "RAD_HOME=${{ github.workspace }}/.radicle" >> $GITHUB_ENV
+        echo "RAD_PASSPHRASE=''" >> $GITHUB_ENV
+
+    - name: Create New Radicle Identity
+      run: |
+        rad auth --alias test_user
+
+    - name: Configure Radicle for Testing
+      run: |
+        # Source: https://app.radicle.xyz/nodes/seed.radicle.xyz/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/HACKING.md
+        jq '.node.network = "test" | .preferredSeeds = [] | .node.connect = [] | .node.peers.type = "static"' ${RAD_HOME}/config.json > ${RAD_HOME}/config.json.tmp
+        mv ${RAD_HOME}/config.json.tmp ${RAD_HOME}/config.json
+
+    - name: Start Radicle Node and http API
+      run: |
+        rad node start &
+        echo "allowing node to start up..."
+        sleep 5
+        radicle-httpd --listen 0.0.0.0:8888 &
+        rad node status
+        rad self
+
+    - uses: pnpm/action-setup@v4
+    - name: Install Node.js
+      uses: actions/[email protected]
+      with:
+        cache-dependency-path: ./pnpm-lock.yaml
+        node-version: 20.x
+        cache: 'pnpm'
+
+    - name: Install Dependencies
+      run: npx npm-run-all -l verify-deps:*
+
+    - name: Build
+      run: pnpm run build
+
+    - name: Test E2E (Linux)
+      if: runner.os == 'Linux'
+      env:
+        RAD_PATH: ${{ github.workspace }}/.radicle/bin/rad
+      run: xvfb-run -a pnpm test:e2e
+
+    - name: Test E2E (non-Linux)
+      if: runner.os != 'Linux'
+      env:
+        RAD_PATH: ${{ github.workspace }}/.radicle/bin/rad
+      run: pnpm test:e2e

.github/workflows/pr-linting.yaml

@@ -1,4 +1,4 @@
-name: PR linting
+name: CI
 on:
   pull_request:
     types: ['opened', 'edited', 'reopened', 'synchronize']

.gitignore

@@ -14,3 +14,6 @@ debug.log*
 
 # git / radicle
 .gitsigners
+
+# wdio
+.wdio-vscode-service

.vscode/settings.json

@@ -8,6 +8,8 @@
     "build",
     "lint",
     "git",
+    "ci",
+    "e2e",
     "env",
     "deps",
     "ts",
@@ -25,7 +27,6 @@
     "publish",
     "marketplace",
     "icons",
-    "ci",
     "auth",
     "ux",
     "httpd",

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Radicle VS Code Extension Change Log
 
+# _(WIP, yet unreleased version)_
+
+### 🤖 CI
+
+- **e2e:** set up new infrastructure and a related CI workflow capable of automated completely end-to-end testing. It uses a real Radicle node, which powers the latest extension build, which is running in an actual VS Code. Tests can assert behavior and state even as deep as extension webviews.
+
+### ☑️ Tests
+
+- **onboarding:** cover various paths of the flow with e2e tests
+
+-----
+
 ## **v0.6.0** (November 9th, 2024)
 
 ### ✨ Highlights

package.json

@@ -21,6 +21,7 @@
     "vscode": "^1.91.0",
     "npm": "^7"
   },
+  "packageManager": "[email protected]",
   "keywords": [
     "radicle",
     "git"
@@ -44,12 +45,12 @@
     "lint": "run-p lint:*",
     "lint:extension": "eslint . --ext .vue,.ts,.tsx,.js,.jsx --max-warnings 0 --cache --cache-location node_modules/.cache/eslint",
     "lint:webviews": "cd ./src/webviews && npm run lintfix",
-    "test": "npm run test:typings && npm run test:unit && npm run test:e2e",
+    "test": "npm run test:typings && npm run test:unit",
     "test:typings": "run-p test:typings:*",
     "test:typings:extension": "tsc --noEmit",
     "test:typings:webviews": "cd ./src/webviews && npm run type-check",
     "test:unit": "echo \"Unit testing not yet implemented.\"",
-    "test:e2e": "echo \"End-to-end testing not yet implemented.\""
+    "test:e2e": "wdio run ./test/e2e/wdio.conf.ts"
   },
   "main": "./dist/extension.js",
   "activationEvents": [
@@ -580,19 +581,36 @@
     "@total-typescript/ts-reset": "^0.5.1",
     "@types/javascript-time-ago": "^2.0.8",
     "@types/lodash": "^4.17.6",
+    "@types/mocha": "^10.0.9",
     "@types/node": "^20.11.21",
     "@types/vscode": "^1.91.0",
+    "@wdio/cli": "^9.2.11",
+    "@wdio/globals": "^9.2.11",
+    "@wdio/local-runner": "^9.2.11",
+    "@wdio/mocha-framework": "^9.2.8",
+    "@wdio/spec-reporter": "^9.2.8",
+    "@wdio/types": "^9.2.2",
     "esbuild": "^0.23.0",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^8.10.0",
     "eslint-plugin-jasmine": "^4.2.2",
     "eslint-plugin-prettier-vue": "^4.2.0",
     "eslint-plugin-tailwindcss": "^3.14.3",
     "eslint-plugin-vue-scoped-css": "^2.7.2",
+    "expect-webdriverio": "^5.0.4",
     "npm-run-all": "^4.1.5",
     "simple-git-hooks": "^2.9.0",
     "ts-xor": "^1.3.0",
-    "typescript": "^5.3.3"
+    "tsx": "^4.19.2",
+    "typescript": "^5.3.3",
+    "wdio-vscode-service": "^6.1.2",
+    "webdriverio": "^9.2.11",
+    "zx": "^8.1.9"
+  },
+  "overrides": {
+    "wdio-vscode-service": {
+      "webdriverio": "^9.2.11"
+    }
   },
   "simple-git-hooks": {
     "pre-commit": "npm run lint"