Merge pull request #35 from github-samples/add-playwright

Add playwright

Author: GeekTrainer

.github/workflows/run-tests.yml

@@ -0,0 +1,73 @@
+name: "Run tests"
+
+# Run tests on pull requests to main and on pushes to main
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  backend-tests:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.13"
+          cache: "pip"
+
+      - name: Install Python dependencies
+        run: bash ./scripts/setup-env.sh
+        
+
+      - name: Run Flask unit tests
+        run: bash ./scripts/run-server-tests.sh
+
+  frontend-tests:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          cache: "npm"
+          cache-dependency-path: "./client/package.json"
+
+      - name: Install JavaScript dependencies
+        working-directory: ./client
+        run: npm ci
+
+      - name: Install Playwright browsers
+        working-directory: ./client
+        run: npx playwright install --with-deps
+
+      - name: Run environment setup
+        run: bash ./scripts/setup-env.sh
+
+      - name: Run Playwright e2e tests
+        working-directory: ./client
+        run: npm run test:e2e
+        env:
+          CI: true
+
+      - name: Upload Playwright report
+        uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: playwright-report
+          path: client/playwright-report/
+          retention-days: 30

client/.gitignore

@@ -0,0 +1,7 @@
+
+# Playwright
+node_modules/
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

client/e2e-tests/games.spec.ts

@@ -0,0 +1,134 @@
+import { test, expect } from '@playwright/test';
+
+test.describe('Game Listing and Navigation', () => {
+  test('should display games with titles on index page', async ({ page }) => {
+    await page.goto('/');
+    
+    // Wait for the games to load
+    await page.waitForSelector('[data-testid="games-grid"]', { timeout: 10000 });
+    
+    // Check that games are displayed
+    const gameCards = page.locator('[data-testid="game-card"]');
+    
+    // Wait for at least one game card to be visible
+    await expect(gameCards.first()).toBeVisible();
+    
+    // Check that we have at least one game
+    const gameCount = await gameCards.count();
+    expect(gameCount).toBeGreaterThan(0);
+    
+    // Check that each game card has a title
+    const firstGameCard = gameCards.first();
+    await expect(firstGameCard.locator('[data-testid="game-title"]')).toBeVisible();
+    
+    // Verify that game titles are not empty
+    const gameTitle = await firstGameCard.locator('[data-testid="game-title"]').textContent();
+    expect(gameTitle?.trim()).toBeTruthy();
+  });
+
+  test('should navigate to correct game details page when clicking on a game', async ({ page }) => {
+    await page.goto('/');
+    
+    // Wait for games to load
+    await page.waitForSelector('[data-testid="games-grid"]', { timeout: 10000 });
+    
+    // Get the first game card and its data attributes
+    const firstGameCard = page.locator('[data-testid="game-card"]').first();
+    const gameId = await firstGameCard.getAttribute('data-game-id');
+    const gameTitle = await firstGameCard.getAttribute('data-game-title');
+    
+    // Click on the first game
+    await firstGameCard.click();
+    
+    // Verify we're on the correct game details page
+    await expect(page).toHaveURL(`/game/${gameId}`);
+    
+    // Verify the game details page loads
+    await page.waitForSelector('[data-testid="game-details"]', { timeout: 10000 });
+    
+    // Verify the title matches what we clicked on
+    const detailsTitle = page.locator('[data-testid="game-details-title"]');
+    await expect(detailsTitle).toHaveText(gameTitle || '');
+  });
+
+  test('should display game details with all required information', async ({ page }) => {
+    // Navigate to a specific game (we'll use game ID 1 as an example)
+    await page.goto('/game/1');
+    
+    // Wait for game details to load
+    await page.waitForSelector('[data-testid="game-details"]', { timeout: 10000 });
+    
+    // Check that the game title is present and not empty
+    const gameTitle = page.locator('[data-testid="game-details-title"]');
+    await expect(gameTitle).toBeVisible();
+    const titleText = await gameTitle.textContent();
+    expect(titleText?.trim()).toBeTruthy();
+    
+    // Check that the game description is present and not empty
+    const gameDescription = page.locator('[data-testid="game-details-description"]');
+    await expect(gameDescription).toBeVisible();
+    const descriptionText = await gameDescription.textContent();
+    expect(descriptionText?.trim()).toBeTruthy();
+    
+    // Check that either publisher or category (or both) are present
+    const publisherExists = await page.locator('[data-testid="game-details-publisher"]').isVisible();
+    const categoryExists = await page.locator('[data-testid="game-details-category"]').isVisible();
+    expect(publisherExists && categoryExists).toBeTruthy();
+    
+    // If publisher exists, check it has content
+    if (publisherExists) {
+      const publisherText = await page.locator('[data-testid="game-details-publisher"]').textContent();
+      expect(publisherText?.trim()).toBeTruthy();
+    }
+    
+    // If category exists, check it has content
+    if (categoryExists) {
+      const categoryText = await page.locator('[data-testid="game-details-category"]').textContent();
+      expect(categoryText?.trim()).toBeTruthy();
+    }
+  });
+
+  test('should display a button to back the game', async ({ page }) => {
+    await page.goto('/game/1');
+    
+    // Wait for game details to load
+    await page.waitForSelector('[data-testid="game-details"]', { timeout: 10000 });
+    
+    // Check that the back game button is present
+    const backButton = page.locator('[data-testid="back-game-button"]');
+    await expect(backButton).toBeVisible();
+    await expect(backButton).toContainText('Support This Game');
+    
+    // Verify the button is clickable
+    await expect(backButton).toBeEnabled();
+  });
+
+  test('should be able to navigate back to home from game details', async ({ page }) => {
+    await page.goto('/game/1');
+    
+    // Wait for the page to load
+    await page.waitForSelector('[data-testid="game-details"]', { timeout: 10000 });
+    
+    // Find and click the back to all games link
+    const backLink = page.locator('a:has-text("Back to all games")');
+    await expect(backLink).toBeVisible();
+    await backLink.click();
+    
+    // Verify we're back on the home page
+    await expect(page).toHaveURL('/');
+    await page.waitForSelector('[data-testid="games-grid"]', { timeout: 10000 });
+  });
+
+  test('should handle navigation to non-existent game gracefully', async ({ page }) => {
+    // Navigate to a game that doesn't exist
+    await page.goto('/game/99999');
+    
+    // The page should load without crashing
+    // Check if there's an error message or if it handles gracefully
+    await page.waitForTimeout(3000);
+    
+    // The page should either show an error or handle it gracefully
+    // We expect the page to not crash and still have a valid title
+    await expect(page).toHaveTitle(/Game Details - Tailspin Toys/);
+  });
+});

client/e2e-tests/home.spec.ts

@@ -0,0 +1,26 @@
+import { test, expect } from '@playwright/test';
+
+test.describe('Home Page', () => {
+  test('should display the correct title', async ({ page }) => {
+    await page.goto('/');
+    
+    // Check that the page title is correct
+    await expect(page).toHaveTitle('Tailspin Toys - Crowdfunding your new favorite game!');
+  });
+
+  test('should display the main heading', async ({ page }) => {
+    await page.goto('/');
+    
+    // Check that the main heading is present
+    const mainHeading = page.locator('h1').first();
+    await expect(mainHeading).toHaveText('Tailspin Toys');
+  });
+
+  test('should display the welcome message', async ({ page }) => {
+    await page.goto('/');
+    
+    // Check that the welcome message is present
+    const welcomeMessage = page.locator('p').first();
+    await expect(welcomeMessage).toHaveText('Find your next game! And maybe even back one! Explore our collection!');
+  });
+});

client/package-lock.json

@@ -6,7 +6,8 @@
     "dev": "astro dev",
     "build": "astro build",
     "preview": "astro preview",
-    "astro": "astro"
+    "astro": "astro",
+    "test:e2e": "npx playwright test"
   },
   "dependencies": {
     "@astrojs/node": "^9.2.2",
@@ -17,6 +18,7 @@
     "typescript": "^5.8.3"
   },
   "devDependencies": {
+    "@playwright/test": "^1.52.0",
     "@types/node": "^22.15.21",
     "autoprefixer": "^10.4.21",
     "postcss": "^8.5.3",

client/package.json

@@ -0,0 +1,50 @@
+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: './e2e-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: 'list',
+  /* 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:4321',
+
+    /* 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'] },
+    },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  webServer: {
+    command: '../scripts/start-app.sh',
+    url: 'http://localhost:4321',
+    reuseExistingServer: !process.env.CI,
+    timeout: 120 * 1000, // 2 minutes to allow for setup
+  },
+});