freecodecamp--freecodecamp/e2e/daily-coding-challenge.spec.ts

import { test, expect } from '@playwright/test';
import {
  getTodayUsCentral,
  formatDisplayDate
} from '../client/src/components/daily-coding-challenge/helpers';

const dateRouteRe = /.*\/daily-coding-challenge\/date\/.*/;

const todayUsCentral = getTodayUsCentral();

const todayMidnight = `${todayUsCentral}T00:00:00.000Z`;

const mockApiChallenge = {
  id: 'test-challenge-id',
  challengeNumber: 1,
  title: 'Test title',
  date: todayMidnight,
  description: 'Test description',
  javascript: {
    tests: [
      {
        text: 'Test text',
        testString: 'assert.strictEqual(true, true);'
      }
    ],
    challengeFiles: [
      {
        fileKey: 'scriptjs',
        contents: '// JavaScript seed code'
      }
    ]
  },
  python: {
    tests: [
      {
        text: 'Test text',
        testString: '({test: () => { runPython(`assert True == True`)}})'
      }
    ],
    challengeFiles: [
      {
        fileKey: 'mainpy',
        contents: '# Python seed code'
      }
    ]
  }
};

// Temporarily disabled
// const runChallengeTest = async (page: Page, isMobile: boolean) => {
//   if (isMobile) {
//     await page.getByRole('tab', { name: 'Console' }).click();
//     await page.getByText('Run').click();
//   } else {
//     await page.getByText('Run the Tests (Ctrl + Enter)').click();
//   }
// };

test.describe('Daily Coding Challenges', () => {
  test('should redirect to archive for invalid date', async ({ page }) => {
    await page.goto('/learn/daily-coding-challenge/invalid-date');
    await expect(page).toHaveURL('/learn/daily-coding-challenge/archive');
  });

  test('should load and display a daily coding challenge with a valid date, and should be able to switch between JavaScript and Python', async ({
    page
  }) => {
    await page.route(dateRouteRe, async route => {
      await route.fulfill({
        status: 200,
        headers: { 'Content-Type': 'application/json' },
        json: mockApiChallenge
      });
    });

    await page.goto(`/learn/daily-coding-challenge/${todayUsCentral}`);

    const leftBreadcrumb = page.getByRole('link', {
      name: /daily coding challenge/i
    });
    await expect(leftBreadcrumb).toBeVisible();
    await expect(leftBreadcrumb).toHaveAttribute(
      'href',
      '/learn/daily-coding-challenge/archive'
    );

    const rightBreadcrumb = page.getByRole('link', {
      name: `${formatDisplayDate(todayUsCentral)}`
    });
    await expect(rightBreadcrumb).toBeVisible();
    await expect(rightBreadcrumb).toHaveAttribute(
      'href',
      '/learn/daily-coding-challenge/archive'
    );

    await expect(page.getByText('Test title')).toBeVisible();

    await expect(page.getByText('Test description')).toBeVisible();

    // Language buttons
    await expect(
      page.getByRole('button', { name: /javascript/i })
    ).toBeVisible();
    await expect(page.getByRole('button', { name: /python/i })).toBeVisible();

    // Should show JS UI by default

    await expect(
      page.getByRole('button', { name: /script.js/i })
    ).toBeVisible();
    await expect(
      page.getByRole('button', { name: /main.py/i })
    ).not.toBeVisible();
    await expect(page.getByRole('button', { name: /console/i })).toBeVisible();
    await expect(page.getByTestId('preview-pane-button')).not.toBeVisible();
    await expect(page.locator("div[role='code'].monaco-editor")).toContainText(
      '// JavaScript seed code'
    );

    // Show Python UI after changing language
    await page.getByRole('button', { name: /python/i }).click();

    await expect(page.getByRole('button', { name: /main.py/i })).toBeVisible();
    await expect(
      page.getByRole('button', { name: /script.js/i })
    ).not.toBeVisible();
    await expect(page.getByRole('button', { name: /console/i })).toBeVisible();
    await expect(page.getByTestId('preview-pane-button')).toBeVisible();
    await expect(page.locator("div[role='code'].monaco-editor")).toContainText(
      '# Python seed code'
    );

    await page.goto(`/learn/daily-coding-challenge/${todayUsCentral}`);

    await expect(page.getByRole('button', { name: /main.py/i })).toBeVisible();
  });
});

test.describe('Daily Coding Challenge Archive', () => {
  test('/learn/daily-coding-challenge should redirect to archive', async ({
    page
  }) => {
    await page.goto('/learn/daily-coding-challenge');
    await expect(page).toHaveURL('/learn/daily-coding-challenge/archive');
  });

  test('/learn/daily-coding-challenge/ should redirect to archive', async ({
    page
  }) => {
    await page.goto('/learn/daily-coding-challenge/');
    await expect(page).toHaveURL('/learn/daily-coding-challenge/archive');
  });

  test('/learn/daily-coding-challenge/path-1/path2 should redirect to archive', async ({
    page
  }) => {
    await page.goto('/learn/daily-coding-challenge/path-1/path2');
    await expect(page).toHaveURL('/learn/daily-coding-challenge/archive');
  });
});

// Temporarily disabled
// test.describe('Daily code challenge solution can be downloaded', () => {
//   test('Downloaded solution files are named by challenge number', async ({
//     page,
//     isMobile
//   }) => {
//     await page.route(/.*\/daily-coding-challenge\/date\/.*/, async route => {
//       await route.fulfill({
//         status: 200,
//         headers: { 'Content-Type': 'application/json' },
//         json: mockApiChallenge
//       });
//     });

//     await page.goto(`/learn/daily-coding-challenge/${todayUsCentral}`);
//     await runChallengeTest(page, isMobile);
//     await expect(page.getByRole('dialog')).toBeVisible({ timeout: 15000 });
//     await expect(
//       page.getByRole('link', { name: 'Download my solution' })
//     ).toBeVisible({ timeout: 15000 });
//     const [download] = await Promise.all([
//       page.waitForEvent('download'),
//       page.getByRole('link', { name: 'Download my solution' }).click()
//     ]);
//     const suggestedFileName = download.suggestedFilename();
//     await download.saveAs(suggestedFileName);
//     expect(fs.existsSync(suggestedFileName)).toBeTruthy();
//     expect(suggestedFileName).toBe('challenge-1.txt');
//   });
// });