Pass samples loading tests

This commit is contained in:
49lf
2024-11-29 17:34:16 -05:00
parent 0c48006793
commit 2844f4c4d6

View File

@ -1,83 +1,72 @@
import { test, expect } from '@playwright/test' import { test, expect } from './zoo-test'
import { getUtils, setup, setupElectron, tearDown } from './test-utils' import { getUtils } from './test-utils'
import { bracket } from 'lib/exampleKcl' import { bracket } from 'lib/exampleKcl'
import * as fsp from 'fs/promises' import * as fsp from 'fs/promises'
import { join } from 'path' import { join } from 'path'
import { FILE_EXT } from 'lib/constants' import { FILE_EXT } from 'lib/constants'
import { UnitLength_type } from '@kittycad/lib/dist/types/src/models' import { UnitLength_type } from '@kittycad/lib/dist/types/src/models'
test.beforeEach(async ({ context, page }, testInfo) => {
await setup(context, page, testInfo)
})
test.afterEach(async ({ page }, testInfo) => {
await tearDown(page, testInfo)
})
test.describe('Testing in-app sample loading', () => { test.describe('Testing in-app sample loading', () => {
/** /**
* Note this test implicitly depends on the KCL sample "car-wheel.kcl", * Note this test implicitly depends on the KCL sample "car-wheel.kcl",
* its title, and its units settings. https://github.com/KittyCAD/kcl-samples/blob/main/car-wheel/car-wheel.kcl * its title, and its units settings. https://github.com/KittyCAD/kcl-samples/blob/main/car-wheel/car-wheel.kcl
*/ */
test('Web: should overwrite current code, cannot create new file', async ({ test('Web: should overwrite current code, cannot create new file', async ({ editor, context, page, homePage }) => {
page,
}) => {
const u = await getUtils(page) const u = await getUtils(page)
await test.step(`Test setup`, async () => { await test.step(`Test setup`, async () => {
await page.addInitScript((code) => { await context.addInitScript((code) => {
window.localStorage.setItem('persistCode', code) window.localStorage.setItem('persistCode', code)
}, bracket) }, bracket)
await page.setViewportSize({ width: 1200, height: 500 }) await page.setBodyDimensions({ width: 1200, height: 500 })
await u.waitForAuthSkipAppStart() await homePage.goToModelingScene()
})
// Locators and constants
const newSample = {
file: 'car-wheel' + FILE_EXT,
title: 'Car Wheel',
}
const commandBarButton = page.getByRole('button', { name: 'Commands' })
const samplesCommandOption = page.getByRole('option', {
name: 'Open Sample',
})
const commandSampleOption = page.getByRole('option', {
name: newSample.title,
exact: true,
})
const commandMethodArgButton = page.getByRole('button', {
name: 'Method',
})
const commandMethodOption = (name: 'Overwrite' | 'Create new file') =>
page.getByRole('option', {
name,
})
const warningText = page.getByText('Overwrite current file and units?')
const confirmButton = page.getByRole('button', { name: 'Submit command' })
const codeLocator = page.locator('.cm-content')
const unitsToast = (unit: UnitLength_type) =>
page.getByText(`Set default unit to "${unit}" for this project`)
await test.step(`Precondition: check the initial code`, async () => {
await u.openKclCodePanel()
await expect(codeLocator).toContainText(bracket.split('\n')[0])
})
await test.step(`Load a KCL sample with the command palette`, async () => {
await commandBarButton.click()
await samplesCommandOption.click()
await commandSampleOption.click()
await commandMethodArgButton.click()
await expect(commandMethodOption('Create new file')).not.toBeVisible()
await commandMethodOption('Overwrite').click()
await expect(warningText).toBeVisible()
await confirmButton.click()
await expect(codeLocator).toContainText('// ' + newSample.title)
await expect(unitsToast('in')).toBeVisible()
})
}) })
// Locators and constants
const newSample = {
file: 'car-wheel' + FILE_EXT,
title: 'Car Wheel',
}
const commandBarButton = page.getByRole('button', { name: 'Commands' })
const samplesCommandOption = page.getByRole('option', {
name: 'Open Sample',
})
const commandSampleOption = page.getByRole('option', {
name: newSample.title,
exact: true,
})
const commandMethodArgButton = page.getByRole('button', {
name: 'Method',
})
const commandMethodOption = (name: 'Overwrite' | 'Create new file') =>
page.getByRole('option', {
name,
})
const warningText = page.getByText('Overwrite current file and units?')
const confirmButton = page.getByRole('button', { name: 'Submit command' })
const unitsToast = (unit: UnitLength_type) =>
page.getByText(`Set default unit to "${unit}" for this project`)
await test.step(`Precondition: check the initial code`, async () => {
await u.openKclCodePanel()
await editor.scrollToText(bracket.split('\n')[0])
await editor.expectEditor.toContain(bracket.split('\n')[0])
})
await test.step(`Load a KCL sample with the command palette`, async () => {
await commandBarButton.click()
await samplesCommandOption.click()
await commandSampleOption.click()
await commandMethodArgButton.click()
await expect(commandMethodOption('Create new file')).not.toBeVisible()
await commandMethodOption('Overwrite').click()
await expect(warningText).toBeVisible()
await confirmButton.click()
await editor.expectEditor.toContain('// ' + newSample.title)
await expect(unitsToast('in')).toBeVisible()
}) })
/** /**
* Note this test implicitly depends on the KCL samples: * Note this test implicitly depends on the KCL samples:
* "car-wheel.kcl": https://github.com/KittyCAD/kcl-samples/blob/main/car-wheel/car-wheel.kcl * "car-wheel.kcl": https://github.com/KittyCAD/kcl-samples/blob/main/car-wheel/car-wheel.kcl
@ -86,16 +75,13 @@ test.describe('Testing in-app sample loading', () => {
test( test(
'Desktop: should create new file by default, optionally overwrite', 'Desktop: should create new file by default, optionally overwrite',
{ tag: '@electron' }, { tag: '@electron' },
async ({ browserName: _ }, testInfo) => { async ({ editor, context, page, browserName: _ }, testInfo) => {
const { electronApp, page, dir } = await setupElectron({ const { dir } = await context.folderSetupFn(async (dir) => {
testInfo, const bracketDir = join(dir, 'bracket')
folderSetupFn: async (dir) => { await fsp.mkdir(bracketDir, { recursive: true })
const bracketDir = join(dir, 'bracket') await fsp.writeFile(join(bracketDir, 'main.kcl'), bracket, {
await fsp.mkdir(bracketDir, { recursive: true }) encoding: 'utf-8',
await fsp.writeFile(join(bracketDir, 'main.kcl'), bracket, { })
encoding: 'utf-8',
})
},
}) })
const u = await getUtils(page) const u = await getUtils(page)
@ -134,19 +120,19 @@ test.describe('Testing in-app sample loading', () => {
page.getByRole('listitem').filter({ page.getByRole('listitem').filter({
has: page.getByRole('button', { name }), has: page.getByRole('button', { name }),
}) })
const codeLocator = page.locator('.cm-content')
const unitsToast = (unit: UnitLength_type) => const unitsToast = (unit: UnitLength_type) =>
page.getByText(`Set default unit to "${unit}" for this project`) page.getByText(`Set default unit to "${unit}" for this project`)
await test.step(`Test setup`, async () => { await test.step(`Test setup`, async () => {
await page.setViewportSize({ width: 1200, height: 500 }) await page.setBodyDimensions({ width: 1200, height: 500 })
await projectCard.click() await projectCard.click()
await u.waitForPageLoad() await u.waitForPageLoad()
}) })
await test.step(`Precondition: check the initial code`, async () => { await test.step(`Precondition: check the initial code`, async () => {
await u.openKclCodePanel() await u.openKclCodePanel()
await expect(codeLocator).toContainText(bracket.split('\n')[0]) await editor.scrollToText(bracket.split('\n')[0])
await editor.expectEditor.toContain(bracket.split('\n')[0])
await u.openFilePanel() await u.openFilePanel()
await expect(projectMenuButton).toContainText('main.kcl') await expect(projectMenuButton).toContainText('main.kcl')
@ -163,7 +149,7 @@ test.describe('Testing in-app sample loading', () => {
}) })
await test.step(`Ensure we made and opened a new file`, async () => { await test.step(`Ensure we made and opened a new file`, async () => {
await expect(codeLocator).toContainText('// ' + sampleOne.title) await editor.expectEditor.toContain('// ' + sampleOne.title)
await expect(newlyCreatedFile(sampleOne.file)).toBeVisible() await expect(newlyCreatedFile(sampleOne.file)).toBeVisible()
await expect(projectMenuButton).toContainText(sampleOne.file) await expect(projectMenuButton).toContainText(sampleOne.file)
await expect(unitsToast('in')).toBeVisible() await expect(unitsToast('in')).toBeVisible()
@ -182,7 +168,7 @@ test.describe('Testing in-app sample loading', () => {
}) })
await test.step(`Ensure we overwrote the current file without navigating`, async () => { await test.step(`Ensure we overwrote the current file without navigating`, async () => {
await expect(codeLocator).toContainText('// ' + sampleTwo.title) await editor.expectEditor.toContain('// ' + sampleTwo.title)
await test.step(`Check actual file contents`, async () => { await test.step(`Check actual file contents`, async () => {
await expect await expect
.poll(async () => { .poll(async () => {
@ -198,8 +184,6 @@ test.describe('Testing in-app sample loading', () => {
await expect(projectMenuButton).toContainText(sampleOne.file) await expect(projectMenuButton).toContainText(sampleOne.file)
await expect(unitsToast('mm')).toBeVisible() await expect(unitsToast('mm')).toBeVisible()
}) })
await electronApp.close()
} }
) )
}) })