55e1ec7dad
* Rename desktop e2e scripts and tags for consistency * Show local command in main test step * Restore 'e2e' prefix to clarify GitHub UI * Add web script to contributor guide
281 lines
10 KiB
TypeScript
281 lines
10 KiB
TypeScript
import { join } from 'path'
|
|
import { bracket } from '@e2e/playwright/fixtures/bracket'
|
|
import { FILE_EXT } from '@src/lib/constants'
|
|
import * as fsp from 'fs/promises'
|
|
|
|
import type { CmdBarSerialised } from '@e2e/playwright/fixtures/cmdBarFixture'
|
|
import type { ElectronZoo } from '@e2e/playwright/fixtures/fixtureSetup'
|
|
import {
|
|
executorInputPath,
|
|
getUtils,
|
|
runningOnWindows,
|
|
testsInputPath,
|
|
} from '@e2e/playwright/test-utils'
|
|
import { expect, test } from '@e2e/playwright/zoo-test'
|
|
|
|
test.describe('Testing loading external models', () => {
|
|
/**
|
|
* Note this test implicitly depends on the KCL sample "parametric-bearing-pillow-block",
|
|
* its title, and its units settings. https://github.com/KittyCAD/kcl-samples/blob/main/parametric-bearing-pillow-block/main.kcl
|
|
*/
|
|
// We have no more web tests
|
|
test.fail(
|
|
'Web: should overwrite current code, cannot create new file',
|
|
async ({ editor, context, page, homePage }) => {
|
|
const u = await getUtils(page)
|
|
await test.step(`Test setup`, async () => {
|
|
await context.addInitScript((code) => {
|
|
window.localStorage.setItem('persistCode', code)
|
|
}, bracket)
|
|
await page.setBodyDimensions({ width: 1200, height: 500 })
|
|
await homePage.goToModelingScene()
|
|
})
|
|
|
|
// Locators and constants
|
|
const newSample = {
|
|
file: 'pillow-block-bearing' + FILE_EXT,
|
|
title: 'Pillow Block Bearing',
|
|
}
|
|
const commandBarButton = page.getByRole('button', { name: 'Commands' })
|
|
const samplesCommandOption = page.getByRole('option', {
|
|
name: 'Load external model',
|
|
})
|
|
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 with sample?')
|
|
const confirmButton = page.getByRole('button', {
|
|
name: 'Submit command',
|
|
})
|
|
|
|
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)
|
|
})
|
|
}
|
|
)
|
|
|
|
/**
|
|
* Note this test implicitly depends on the KCL samples:
|
|
* "parametric-bearing-pillow-block": https://github.com/KittyCAD/kcl-samples/blob/main/parametric-bearing-pillow-block/main.kcl
|
|
* "gear-rack": https://github.com/KittyCAD/kcl-samples/blob/main/gear-rack/main.kcl
|
|
*/
|
|
test(
|
|
'Desktop: should create new file by default, creates a second file with automatic unique name',
|
|
{ tag: '@desktop' },
|
|
async ({ editor, context, page, scene, cmdBar, toolbar }) => {
|
|
if (runningOnWindows()) {
|
|
}
|
|
|
|
await context.folderSetupFn(async (dir) => {
|
|
const bracketDir = join(dir, 'bracket')
|
|
await fsp.mkdir(bracketDir, { recursive: true })
|
|
await fsp.writeFile(join(bracketDir, 'main.kcl'), bracket, {
|
|
encoding: 'utf-8',
|
|
})
|
|
})
|
|
const u = await getUtils(page)
|
|
|
|
// Locators and constants
|
|
const sampleOne = {
|
|
file: 'ball-bearing' + FILE_EXT,
|
|
title: 'Ball Bearing',
|
|
file1: 'ball-bearing-1' + FILE_EXT,
|
|
folderName: 'ball-bearing',
|
|
folderName1: 'ball-bearing-1',
|
|
}
|
|
const projectCard = page.getByRole('link', { name: 'bracket' })
|
|
const overwriteWarning = page.getByText(
|
|
'Overwrite current file with sample?'
|
|
)
|
|
const projectMenuButton = page.getByTestId('project-sidebar-toggle')
|
|
const newlyCreatedFile = (name: string) =>
|
|
page.getByRole('listitem').filter({
|
|
has: page.getByRole('button', { name }),
|
|
})
|
|
const defaultLoadCmdBarState: CmdBarSerialised = {
|
|
commandName: 'Add file to project',
|
|
currentArgKey: 'sample',
|
|
currentArgValue: '',
|
|
headerArguments: {
|
|
Method: 'Existing project',
|
|
Sample: '',
|
|
Source: 'kcl-samples',
|
|
ProjectName: 'bracket',
|
|
},
|
|
highlightedHeaderArg: 'sample',
|
|
stage: 'arguments',
|
|
}
|
|
|
|
await test.step(`Test setup`, async () => {
|
|
await page.setBodyDimensions({ width: 1200, height: 500 })
|
|
await projectCard.click()
|
|
await scene.settled(cmdBar)
|
|
})
|
|
|
|
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 u.openFilePanel()
|
|
|
|
await expect(projectMenuButton).toContainText('main.kcl')
|
|
await expect(newlyCreatedFile(sampleOne.file)).not.toBeVisible()
|
|
})
|
|
|
|
await test.step(`Load a KCL sample with the command palette`, async () => {
|
|
await toolbar.loadButton.click()
|
|
await cmdBar.selectOption({ name: 'KCL Samples' }).click()
|
|
await cmdBar.expectState(defaultLoadCmdBarState)
|
|
await cmdBar.selectOption({ name: sampleOne.title }).click()
|
|
await expect(overwriteWarning).not.toBeVisible()
|
|
await page.waitForTimeout(1000)
|
|
})
|
|
|
|
await test.step(`Ensure we made and opened a new file`, async () => {
|
|
await editor.expectEditor.toContain('// ' + sampleOne.title)
|
|
await expect(
|
|
page.getByTestId('file-tree-item').getByText(sampleOne.folderName)
|
|
).toBeVisible()
|
|
await expect(projectMenuButton).toContainText('main.kcl')
|
|
})
|
|
|
|
await test.step(`Load a KCL sample with the command palette`, async () => {
|
|
await toolbar.loadButton.click()
|
|
await cmdBar.selectOption({ name: 'KCL Samples' }).click()
|
|
await cmdBar.expectState(defaultLoadCmdBarState)
|
|
await cmdBar.selectOption({ name: sampleOne.title }).click()
|
|
await expect(overwriteWarning).not.toBeVisible()
|
|
await page.waitForTimeout(1000)
|
|
})
|
|
|
|
await test.step(`Ensure we made and opened a new file with a unique name`, async () => {
|
|
await editor.expectEditor.toContain('// ' + sampleOne.title)
|
|
await expect(
|
|
page.getByTestId('file-tree-item').getByText(sampleOne.folderName1)
|
|
).toBeVisible()
|
|
await expect(projectMenuButton).toContainText('main.kcl')
|
|
})
|
|
}
|
|
)
|
|
|
|
const externalModelCases = [
|
|
{
|
|
modelName: 'cylinder.kcl',
|
|
deconflictedModelName: 'cylinder-1.kcl',
|
|
modelPath: executorInputPath('cylinder.kcl'),
|
|
},
|
|
{
|
|
modelName: 'cube.step',
|
|
deconflictedModelName: 'cube-1.step',
|
|
modelPath: testsInputPath('cube.step'),
|
|
},
|
|
]
|
|
externalModelCases.map(({ modelName, deconflictedModelName, modelPath }) => {
|
|
test(
|
|
`Load external models from local drive - ${modelName}`,
|
|
{ tag: ['@desktop'] },
|
|
async ({ page, homePage, scene, toolbar, cmdBar, tronApp }) => {
|
|
if (!tronApp) {
|
|
fail()
|
|
}
|
|
|
|
await page.setBodyDimensions({ width: 1000, height: 500 })
|
|
await homePage.goToModelingScene()
|
|
await scene.settled(cmdBar)
|
|
const modelFileContent = await fsp.readFile(modelPath, 'utf-8')
|
|
const { editorTextMatches } = await getUtils(page, test)
|
|
|
|
async function loadExternalFileThroughCommandBar(tronApp: ElectronZoo) {
|
|
await toolbar.loadButton.click()
|
|
await cmdBar.selectOption({ name: 'Local Drive' }).click()
|
|
await cmdBar.expectState({
|
|
commandName: 'Add file to project',
|
|
currentArgKey: 'pathOpen file',
|
|
currentArgValue: '',
|
|
headerArguments: {
|
|
Method: 'Existing project',
|
|
Path: '',
|
|
Source: 'local',
|
|
ProjectName: 'testDefault',
|
|
},
|
|
highlightedHeaderArg: 'path',
|
|
stage: 'arguments',
|
|
})
|
|
|
|
// Mock the file picker selection
|
|
const handleFile = tronApp.electron.evaluate(
|
|
async ({ dialog }, filePaths) => {
|
|
dialog.showOpenDialog = () =>
|
|
Promise.resolve({ canceled: false, filePaths })
|
|
},
|
|
[modelPath]
|
|
)
|
|
await page.getByTestId('cmd-bar-arg-file-button').click()
|
|
await handleFile
|
|
|
|
await cmdBar.expectState({
|
|
commandName: 'Add file to project',
|
|
currentArgKey: 'pathOpen file',
|
|
currentArgValue: '',
|
|
headerArguments: {
|
|
Method: 'Existing project',
|
|
Path: '',
|
|
Source: 'local',
|
|
ProjectName: 'testDefault',
|
|
},
|
|
highlightedHeaderArg: 'path',
|
|
stage: 'arguments',
|
|
})
|
|
await cmdBar.progressCmdBar()
|
|
}
|
|
|
|
await test.step('Load the external model from local drive', async () => {
|
|
await loadExternalFileThroughCommandBar(tronApp)
|
|
// TODO: I think the files pane should auto open?
|
|
await toolbar.openPane('files')
|
|
await toolbar.expectFileTreeState([modelName, 'main.kcl'])
|
|
if (modelName.endsWith('.kcl')) {
|
|
await editorTextMatches(modelFileContent)
|
|
}
|
|
})
|
|
|
|
await test.step('Load the same external model, except deconflicted name', async () => {
|
|
await loadExternalFileThroughCommandBar(tronApp)
|
|
await toolbar.openPane('files')
|
|
await toolbar.expectFileTreeState([
|
|
deconflictedModelName,
|
|
modelName,
|
|
'main.kcl',
|
|
])
|
|
if (modelName.endsWith('.kcl')) {
|
|
await editorTextMatches(modelFileContent)
|
|
}
|
|
})
|
|
}
|
|
)
|
|
})
|
|
})
|