initial playwright setup and test (#1039)

* initial playwright setup and test * try verbose logging * double check resolution * double check token * remove logs * try running on ubuntu and macos * move e2e tests * vitest ignores playwright tests * add a series of tests * tweak yarn setup * typo * update fmt * action typo * rust toolchain? * remove .only from playwright test * A snapshot a day keeps the bugs away! 📷🐛 * A snapshot a day keeps the bugs away! 📷🐛 * add pan and zoom back * try puting os in commit message * A snapshot a day keeps the bugs away! 📷🐛 .os * A snapshot a day keeps the bugs away! 📷🐛 .os * fix commit message * A snapshot a day keeps the bugs away! 📷🐛 (OS: macos-latest) * add command logs to UI for axis tests * typo * fmt * remove .only * add auto complete test * remove .only * update queries to be more playwright recommended * move test utils * remove waits from first test * remove old snapshots * re-arrange files and tests * A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu-latest) * trigger CI * refactor plane test * A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu-latest) * remove .only * try longer wait * try snap shoting * fmt * better CI names * fix * fix linux * A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu-latest) * try make executes on load a bit more robust * fix * A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu-latest) * stabilise snapshots * A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu-latest) * A snapshot a day keeps the bugs away! 📷🐛 (OS: macos-latest) * make tests run linearly * update naming * tidy * .only * update readme * trigger CI * add set tool * util clean up * update readme * readme tweaks * self-review clean up * A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu) * tweak * update readme * Ensure Vite preview server is running before running any Playwright tests (#1114) * Ensure that Vite is serving before tests run * Don't break secrets if developer has extra blank line in env file * @mxschmitt's suggestions * fix * add wait-on types * tsconfig fix * update readme * code template for sktech on each plane test --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Frank Noirot <frank@kittycad.io>
2023-11-24 08:59:24 +11:00
parent c37dfc61ef
commit b88425efc8
28 changed files with 1322 additions and 26 deletions
--- a/e2e/playwright/test-utils.ts
+++ b/e2e/playwright/test-utils.ts
@ -0,0 +1,114 @@
+import { expect, Page } from '@playwright/test'
+import { EngineCommand } from '../../src/lang/std/engineConnection'
+
+async function waitForPageLoad(page: Page) {
+  // wait for 'Loading KittyCAD Modeling App...' spinner
+  await page.getByTestId('initial-load').waitFor()
+  // wait for 'Loading stream...' spinner
+  await page.getByTestId('loading-stream').waitFor()
+  // wait for all spinners to be gone
+  await page.getByTestId('loading').waitFor({ state: 'detached' })
+
+  await page.getByTestId('start-sketch').waitFor()
+}
+
+async function removeCurrentCode(page: Page) {
+  const hotkey = process.platform === 'darwin' ? 'Meta' : 'Control'
+  await page.click('.cm-content')
+  await page.keyboard.down(hotkey)
+  await page.keyboard.press('a')
+  await page.keyboard.up(hotkey)
+  await page.keyboard.press('Backspace')
+  await expect(page.locator('.cm-content')).toHaveText('')
+}
+
+async function sendCustomCmd(page: Page, cmd: EngineCommand) {
+  await page.fill('[data-testid="custom-cmd-input"]', JSON.stringify(cmd))
+  await page.click('[data-testid="custom-cmd-send-button"]')
+}
+
+async function clearCommandLogs(page: Page) {
+  await page.click('[data-testid="clear-commands"]')
+}
+
+async function expectCmdLog(page: Page, locatorStr: string) {
+  await expect(page.locator(locatorStr)).toBeVisible()
+}
+
+async function waitForDefaultPlanesToBeVisible(page: Page) {
+  await page.waitForFunction(
+    () =>
+      document.querySelectorAll('[data-receive-command-type="object_visible"]')
+        .length >= 3
+  )
+}
+
+async function openDebugPanel(page: Page) {
+  const isOpen =
+    (await page
+      .locator('[data-testid="debug-panel"]')
+      ?.getAttribute('open')) === ''
+
+  if (!isOpen) {
+    await page.getByText('Debug').click()
+    await page.getByTestId('debug-panel').and(page.locator('[open]')).waitFor()
+  }
+}
+
+async function closeDebugPanel(page: Page) {
+  const isOpen =
+    (await page.getByTestId('debug-panel')?.getAttribute('open')) === ''
+  if (isOpen) {
+    await page.getByText('Debug').click()
+    await page
+      .getByTestId('debug-panel')
+      .and(page.locator(':not([open])'))
+      .waitFor()
+  }
+}
+
+async function waitForCmdReceive(page: Page, commandType: string) {
+  return page
+    .locator(`[data-receive-command-type="${commandType}"]`)
+    .first()
+    .waitFor()
+}
+
+export function getUtils(page: Page) {
+  return {
+    waitForAuthSkipAppStart: () => waitForPageLoad(page),
+    removeCurrentCode: () => removeCurrentCode(page),
+    sendCustomCmd: (cmd: EngineCommand) => sendCustomCmd(page, cmd),
+    clearCommandLogs: () => clearCommandLogs(page),
+    expectCmdLog: (locatorStr: string) => expectCmdLog(page, locatorStr),
+    waitForDefaultPlanesVisibilityChange: () =>
+      waitForDefaultPlanesToBeVisible(page),
+    openDebugPanel: () => openDebugPanel(page),
+    closeDebugPanel: () => closeDebugPanel(page),
+    openAndClearDebugPanel: async () => {
+      await openDebugPanel(page)
+      return clearCommandLogs(page)
+    },
+    clearAndCloseDebugPanel: async () => {
+      await clearCommandLogs(page)
+      return closeDebugPanel(page)
+    },
+    waitForCmdReceive: (commandType: string) =>
+      waitForCmdReceive(page, commandType),
+    doAndWaitForCmd: async (
+      fn: () => Promise<void>,
+      commandType: string,
+      endWithDebugPanelOpen = true
+    ) => {
+      await openDebugPanel(page)
+      await clearCommandLogs(page)
+      await closeDebugPanel(page)
+      await fn()
+      await openDebugPanel(page)
+      await waitForCmdReceive(page, commandType)
+      if (!endWithDebugPanelOpen) {
+        await closeDebugPanel(page)
+      }
+    },
+  }
+}