test: add tests for ui (#241)

Author: AriPerkkio

.github/workflows/ci.yaml

@@ -35,6 +35,21 @@ jobs:
       - name: Test
         run: pnpm test
 
+  test-e2e:
+    name: Test E2E
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: ./.github/actions/setup-and-build
+
+      - name: Install Playwright Dependencies
+        run: pnpm --filter=tutorialkit-e2e exec playwright install chromium --with-deps
+
+      - name: Test
+        run: pnpm test:e2e
+
   docs:
     name: Docs
     runs-on: ubuntu-latest

.gitignore

@@ -23,3 +23,5 @@ tsconfig.tsbuildinfo
 tsconfig.build.tsbuildinfo
 .tmp
 .tmp-*
+/e2e/**/test-results
+/e2e/**/.astro

.npmrc

@@ -0,0 +1 @@
+shell-emulator=true

e2e/README.md

@@ -0,0 +1,42 @@
+# UI Tests
+
+> Tests for verifying TutorialKit works as expected in the browser. Tests are run against locally linked `@tutorialkit` packages.
+
+## Running
+
+- `pnpm exec playwright install chromium --with-deps` - When running the tests first time
+- `pnpm test`
+
+## Development
+
+- `pnpm start` - Starts example/fixture project's development server
+- `pnpm test:ui` - Start Playwright in UI mode
+
+## Structure
+
+Test cases are located in `test` directory.
+Each test file has its own `chapter`, that contains `lesson`s for test cases:
+
+For example Navigation tests:
+
+```
+├── src/content/tutorial
+│   └── tests
+│       └──── navigation
+│           ├── page-one
+│           ├── page-three
+│           └── page-two
+└── test
+    └── navigation.test.ts
+```
+
+Or File Tree tests:
+
+```
+├── src/content/tutorial
+│   └── tests
+│       └── file-tree
+│           └── lesson-and-solution
+└── test
+    └── file-tree.test.ts
+```

e2e/astro.config.ts

@@ -0,0 +1,23 @@
+import { createRequire } from 'node:module';
+import { resolve } from 'node:path';
+import tutorialkit from '@tutorialkit/astro';
+import { defineConfig } from 'astro/config';
+
+const require = createRequire(import.meta.url);
+const astroDist = resolve(require.resolve('astro/package.json'), '..');
+const swapFunctionEntry = resolve(astroDist, 'dist/transitions/swap-functions.js');
+
+export default defineConfig({
+  devToolbar: { enabled: false },
+  server: { port: 4329 },
+  integrations: [tutorialkit()],
+
+  vite: {
+    resolve: {
+      alias: {
+        // work-around for https://github.com/stackblitz/tutorialkit/pull/238
+        'node_modules/astro/dist/transitions/swap-functions': swapFunctionEntry,
+      },
+    },
+  },
+});

e2e/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "tutorialkit-e2e",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "astro dev",
+    "preview": "astro build && astro preview",
+    "test": "playwright test",
+    "test:ui": "pnpm run test --ui"
+  },
+  "devDependencies": {
+    "@astrojs/react": "^3.6.0",
+    "@iconify-json/ph": "^1.1.13",
+    "@iconify-json/svg-spinners": "^1.1.2",
+    "@playwright/test": "^1.46.0",
+    "@tutorialkit/astro": "workspace:*",
+    "@tutorialkit/components-react": "workspace:*",
+    "@tutorialkit/runtime": "workspace:*",
+    "@tutorialkit/theme": "workspace:*",
+    "@tutorialkit/types": "workspace:*",
+    "@types/node": "^22.2.0",
+    "@unocss/reset": "^0.59.4",
+    "@unocss/transformer-directives": "^0.62.0",
+    "astro": "^4.12.0",
+    "fast-glob": "^3.3.2",
+    "playwright": "^1.46.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "unocss": "^0.59.4"
+  }
+}

e2e/playwright.config.ts

@@ -0,0 +1,17 @@
+import { defineConfig } from '@playwright/test';
+
+export default defineConfig({
+  expect: {
+    timeout: process.env.CI ? 30_000 : 10_000,
+  },
+  use: {
+    baseURL: 'http://localhost:4329',
+  },
+  webServer: {
+    command: 'pnpm preview',
+    url: 'http://localhost:4329',
+    reuseExistingServer: !process.env.CI,
+    stdout: 'ignore',
+    stderr: 'pipe',
+  },
+});

e2e/public/logo.svg

@@ -0,0 +1,9 @@
+import { contentSchema } from '@tutorialkit/types';
+import { defineCollection } from 'astro:content';
+
+const tutorial = defineCollection({
+  type: 'content',
+  schema: contentSchema,
+});
+
+export const collections = { tutorial };

e2e/src/content/config.ts

@@ -0,0 +1,5 @@
+---
+type: tutorial
+mainCommand: ''
+prepareCommands: []
+---