Merge pull request #137 from dwightjack/tests

Tests

Author: dwightjack

.github/workflows/main.yml

@@ -17,7 +17,6 @@ concurrency:
 jobs:
   build:
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
       - uses: pnpm/action-setup@v4
@@ -28,3 +27,24 @@ jobs:
       - run: pnpm i
       - run: pnpm run lint
       - run: pnpm run build
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: pnpm/action-setup@v4
+      - uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4
+        with:
+          node-version-file: '.node-version'
+          cache: 'pnpm'
+      - run: pnpm i
+      - name: Install Playwright Browsers
+        run: pnpm exec playwright install chromium --with-deps
+      - name: Run Playwright tests
+        run: pnpm run test
+      - uses: actions/upload-artifact@v4
+        if: ${{ !cancelled() }}
+        with:
+          name: playwright-report
+          path: playwright-report/
+          retention-days: 10

.gitignore

@@ -3,4 +3,10 @@ node_modules
 dist
 dist-ssr
 *.local
-!.vscode
+!.vscode
+
+# Playwright
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

package.json

@@ -5,10 +5,12 @@
   "description": "A configurable pomodoro-like timer",
   "type": "module",
   "scripts": {
-    "dev": "vite",
+    "dev": "vite --port 8888",
     "build": "vue-tsc --noEmit && vite build",
     "lint": "eslint 'src/**/*.*'",
-    "serve": "vite preview"
+    "serve": "vite preview",
+    "dev:test": "vite dev --port 8888 --mode=test",
+    "test": "playwright test"
   },
   "packageManager": "[email protected]",
   "engines": {
@@ -24,6 +26,7 @@
   },
   "devDependencies": {
     "@eslint/js": "9.20.0",
+    "@playwright/test": "^1.51.0",
     "@tailwindcss/vite": "4.0.9",
     "@types/node": "22.13.7",
     "@vitejs/plugin-vue": "5.2.1",

playwright.config.ts

@@ -0,0 +1,53 @@
+import { defineConfig, devices } from '@playwright/test';
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// import dotenv from 'dotenv';
+// import path from 'path';
+// dotenv.config({ path: path.resolve(__dirname, '.env') });
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: './tests',
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: 'html',
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    baseURL: 'http://localhost:8888',
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: 'on-first-retry',
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+    },
+
+    {
+      name: 'Mobile Chrome',
+      use: { ...devices['Pixel 5'] },
+    },
+  ],
+
+  webServer: {
+    command: 'pnpm run dev:test',
+    url: 'http://localhost:8888',
+    reuseExistingServer: !process.env.CI,
+  },
+});

pnpm-lock.yaml

@@ -25,7 +25,7 @@ const label = computed(() => {
   if (mins === 0) {
     return `${toSpacedString(type)}: less than 1 minute left`;
   }
-  return `${toSpacedString(type)}: ${mins + 1} minutes left`;
+  return `${toSpacedString(type)}: ${mins + (secs === 0 ? 0 : 1)} minutes left`;
 });
 
 const classes = computed(() => getIntervalTypeColor(type as IntervalType));

src/components/BaseTimer.vue

@@ -1,13 +1,18 @@
 <script setup lang="ts">
 import IntervalSquare from '@/components/IntervalSquare.vue';
 import { useCycle } from '@/stores/cycle';
+import { useId } from 'vue';
 
 const cycle = useCycle();
+const id = useId();
 </script>
 <template>
   <div>
-    <h2 class="sr-only">Intervals</h2>
-    <ul class="flex flex-wrap items-center justify-center gap-1">
+    <h2 :id="id + '-cycle'" aria-hidden="true" class="sr-only">Intervals</h2>
+    <ul
+      class="flex flex-wrap items-center justify-center gap-1"
+      :aria-labelledby="id + '-cycle'"
+    >
       <IntervalSquare
         v-for="(interval, i) in cycle.intervals"
         :key="interval.id"

src/components/TheCycle.vue

@@ -0,0 +1,151 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import {
+  type Page,
+  type Locator,
+  test as base,
+  expect as baseExpect,
+} from '@playwright/test';
+import { Interval } from '../../src/types';
+import { uid } from 'uid';
+import { IntervalType } from '../../src/types';
+
+export const mockInterval = (type: IntervalType, duration: number) => ({
+  type,
+  duration: duration * 60 * 1000,
+  id: uid(),
+});
+
+class Queries {
+  protected readonly list: Locator;
+  protected readonly controls: Locator;
+
+  readonly timer: Locator;
+
+  constructor(public readonly page: Page) {
+    this.list = this.page.getByRole('list', { name: 'Intervals' });
+    this.timer = this.page.getByRole('timer');
+    this.controls = this.page.getByRole('group', { name: 'Timer controls' });
+  }
+
+  getControl(name: string | RegExp, { context }: { context?: Locator } = {}) {
+    return (context ?? this.controls).getByRole('button', { name });
+  }
+
+  getButton(name: string | RegExp, { context }: { context?: Locator } = {}) {
+    return (context ?? this.page).getByRole('button', { name });
+  }
+
+  getIntervalList() {
+    return this.list.getByRole('listitem');
+  }
+
+  getIntervalByType(type: 'W' | 'LB' | 'SB') {
+    return this.getIntervalList().filter({ hasText: type });
+  }
+
+  getIntervalByDuration(duration: number) {
+    return this.getIntervalList().filter({
+      hasText: `${String(duration).padStart(2, '0')}:00`,
+    });
+  }
+}
+
+export class AppPage {
+  constructor(public readonly page: Page) {}
+
+  async setStorage(intervals: Interval[]) {
+    // set two intervals
+    await this.page.addInitScript((intervals) => {
+      window.localStorage.setItem('intervals', JSON.stringify(intervals));
+    }, intervals);
+  }
+
+  async withinSettings(fn: (dialog: Locator) => Promise<void> | void) {
+    await fn(this.page.getByRole('dialog', { name: 'Settings' }));
+  }
+}
+
+export const test = base.extend<{ appPage: AppPage; queries: Queries }>({
+  appPage: async ({ page }, use) => {
+    const todoPage = new AppPage(page);
+
+    await use(todoPage);
+  },
+  queries: async ({ page }, use) => {
+    await use(new Queries(page));
+  },
+});
+
+export const expect = baseExpect.extend({
+  async toHaveOptions(
+    locator: Locator,
+    expectedOptions: string[],
+    options?: { timeout?: number },
+  ) {
+    const assertionName = 'toHaveOptions';
+    let pass = true;
+
+    let matcherResult: any;
+    try {
+      const optionsLocator = locator.getByRole('option');
+      await baseExpect(optionsLocator).toHaveText(expectedOptions, options);
+    } catch (e) {
+      matcherResult = (e as any).matcherResult;
+      pass = false;
+    }
+
+    const message = () =>
+      this.utils.matcherHint(assertionName, undefined, undefined, {
+        isNot: this.isNot,
+      }) +
+      '\n\n' +
+      `Locator: ${locator}\n` +
+      `Expected options: ${this.utils.printExpected(expectedOptions)}\n` +
+      `Received options: ${this.utils.printReceived(matcherResult?.actual)}`;
+
+    return {
+      message,
+      pass,
+      name: assertionName,
+      expected: expectedOptions,
+      actual: matcherResult?.actual,
+    };
+  },
+  async toHaveSelected(
+    locator: Locator,
+    expected: string | RegExp,
+    options?: { timeout?: number },
+  ) {
+    const assertionName = 'toHaveOptions';
+    let pass = true;
+
+    let matcherResult: any;
+    try {
+      const matchOptionValue =
+        (await locator
+          .getByRole('option', { name: expected })
+          .getAttribute('value')) ?? expected;
+      await baseExpect(locator).toHaveValue(matchOptionValue, options);
+    } catch (e) {
+      matcherResult = (e as any).matcherResult;
+      pass = false;
+    }
+
+    const message = () =>
+      this.utils.matcherHint(assertionName, undefined, undefined, {
+        isNot: this.isNot,
+      }) +
+      '\n\n' +
+      `Locator: ${locator}\n` +
+      `Expected selected option: ${this.utils.printExpected(expected)}\n` +
+      `Received selected option: ${this.utils.printReceived(matcherResult?.actual)}`;
+
+    return {
+      message,
+      pass,
+      name: assertionName,
+      expected,
+      actual: matcherResult?.actual,
+    };
+  },
+});