tests: add first test

Author: Aslam97

.github/workflows/playwright.yml

@@ -0,0 +1,27 @@
+name: Playwright Tests
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: lts/*
+    - name: Install dependencies
+      run: npm install -g pnpm && pnpm install
+    - name: Install Playwright Browsers
+      run: pnpm exec playwright install --with-deps
+    - name: Run Playwright tests
+      run: pnpm exec playwright test
+    - uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: playwright-report
+        path: playwright-report/
+        retention-days: 30

.gitignore

@@ -22,3 +22,7 @@ dist-ssr
 *.njsproj
 *.sln
 *.sw?
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

package.json

@@ -24,6 +24,7 @@
     "zod": "^3.23.8"
   },
   "devDependencies": {
+    "@playwright/test": "^1.45.1",
     "@types/node": "^20.14.10",
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18.3.0",

playwright.config.ts

@@ -0,0 +1,78 @@
+import { defineConfig, devices } from '@playwright/test';
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// import dotenv from 'dotenv';
+// 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://127.0.0.1:3000',
+
+    /* 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: 'firefox',
+      use: { ...devices['Desktop Firefox'] },
+    },
+
+    {
+      name: 'webkit',
+      use: { ...devices['Desktop Safari'] },
+    },
+
+    /* Test against mobile viewports. */
+    // {
+    //   name: 'Mobile Chrome',
+    //   use: { ...devices['Pixel 5'] },
+    // },
+    // {
+    //   name: 'Mobile Safari',
+    //   use: { ...devices['iPhone 12'] },
+    // },
+
+    /* Test against branded browsers. */
+    // {
+    //   name: 'Microsoft Edge',
+    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
+    // },
+    // {
+    //   name: 'Google Chrome',
+    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
+    // },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  // webServer: {
+  //   command: 'npm run start',
+  //   url: 'http://127.0.0.1:3000',
+  //   reuseExistingServer: !process.env.CI,
+  // },
+});

pnpm-lock.yaml

@@ -83,6 +83,7 @@ function App() {
                     <FancySwitch
                       {...field}
                       options={orderTypes}
+                      data-testid="orderType"
                       className="flex rounded-full bg-muted p-2"
                       highlighterClassName="bg-primary rounded-full"
                       radioClassName={cn(

src/App.tsx

@@ -174,6 +174,7 @@ const FancySwitch = React.forwardRef<HTMLDivElement, FancySwitchProps>(
             ...highlighterStyle
           }}
           aria-hidden="true"
+          data-highlighter
         />
 
         {memoizedOptions.map((option, index) => (

src/components/fancy-switch/fancy-switch.tsx

@@ -0,0 +1,66 @@
+import { test, expect } from '@playwright/test'
+
+test.describe('FancySwitch Component', () => {
+  test.beforeEach(async ({ page }) => {
+    await page.goto('http://localhost:5173')
+  })
+
+  test('renders options', async ({ page }) => {
+    const radiogroups = await page.getByTestId('orderType')
+    const options = await radiogroups.getByRole('radio').all()
+
+    await expect(options).toHaveLength(3)
+    await expect(options[0]).toHaveText('Delivery')
+    await expect(options[1]).toHaveText('Pickup')
+    await expect(options[2]).toHaveText('Shipping')
+  })
+
+  test('selects option on click', async ({ page }) => {
+    const radiogroups = await page.getByTestId('orderType')
+    const secondOption = await radiogroups.getByRole('radio').nth(1)
+    await secondOption.click()
+    await expect(secondOption).toHaveAttribute('aria-checked', 'true')
+  })
+
+  test('changes selection with arrow keys', async ({ page }) => {
+    const firstOption = await page.locator('[role="radio"]').nth(0)
+    await firstOption.focus()
+    await page.keyboard.press('ArrowRight')
+
+    const secondOption = await page.locator('[role="radio"]').nth(1)
+    await expect(secondOption).toHaveAttribute('aria-checked', 'true')
+  })
+
+  test('highlighter moves to selected option', async ({ page }) => {
+    const radiogroups = await page.getByTestId('orderType')
+    const secondOption = await radiogroups.getByRole('radio').nth(1)
+    await secondOption.click()
+
+    const highlighter = await radiogroups.locator('[data-highlighter]')
+    const optionBox = await secondOption.boundingBox()
+
+    // get second option margin
+    const margin = await secondOption.evaluate((el) => {
+      const { marginTop, marginBottom, marginLeft, marginRight } =
+        getComputedStyle(el)
+      return {
+        marginTop,
+        marginBottom,
+        marginLeft,
+        marginRight
+      }
+    })
+
+    // wait for the highlighter to move
+    await page.waitForTimeout(500)
+
+    const newHighlighterBox = await highlighter.boundingBox()
+    if (newHighlighterBox && optionBox) {
+      expect(newHighlighterBox.width).toBeCloseTo(
+        optionBox.width +
+          parseInt(margin.marginLeft) +
+          parseInt(margin.marginRight)
+      )
+    }
+  })
+})