314 lines
11 KiB
TypeScript
314 lines
11 KiB
TypeScript
import { join } from 'path'
|
|
import { PROJECT_SETTINGS_FILE_NAME } from '@src/lib/constants'
|
|
import * as fsp from 'fs/promises'
|
|
|
|
import type { NamedView } from '@rust/kcl-lib/bindings/NamedView'
|
|
|
|
import {
|
|
createProject,
|
|
perProjectSettingsToToml,
|
|
runningOnWindows,
|
|
tomlToPerProjectSettings,
|
|
} from '@e2e/playwright/test-utils'
|
|
import { expect, test } from '@e2e/playwright/zoo-test'
|
|
|
|
// Helper function to determine if the file path on disk exists
|
|
// Specifically this is used to check if project.toml exists on disk
|
|
const fileExists = async (path: string) => {
|
|
return !!(await fsp
|
|
.stat(path)
|
|
.then((_) => true)
|
|
.catch((_) => false))
|
|
}
|
|
|
|
// Here are a few uuids.
|
|
// When created named views rust will auto generate uuids and they will
|
|
// never match the snapshots. Overwrite them in memory to these
|
|
// values to have them match the snapshots.
|
|
const uuid1: string = '0656fb1a-9640-473e-b334-591dc70c0138'
|
|
const uuid2: string = 'c810cf04-c6cc-4a4a-8b11-17bf445dcab7'
|
|
const uuid3: string = 'cfecbfee-48a6-4561-b96d-ffbe5678bb7d'
|
|
|
|
// Look up the named view by name and then rewrite it with the same uuid each time
|
|
const nameToUuid: Map<string, string> = new Map()
|
|
nameToUuid.set('uuid1', uuid1)
|
|
nameToUuid.set('uuid2', uuid2)
|
|
nameToUuid.set('uuid3', uuid3)
|
|
|
|
/**
|
|
* Given the project.toml string, overwrite the named views to be the constant uuid
|
|
* values to match the snapshots. The uuids are randomly generated
|
|
*/
|
|
function tomlStringOverWriteNamedViewUuids(toml: string): string {
|
|
const settings = tomlToPerProjectSettings(toml)
|
|
const namedViews = settings.settings?.app?.named_views
|
|
if (namedViews) {
|
|
const entries = Object.entries(namedViews)
|
|
const remappedNamedViews: { [key: string]: NamedView } = {}
|
|
entries.forEach(([_, value]) => {
|
|
if (value) {
|
|
// {name:'uuid1'} -> uuid1 lookup
|
|
const staticUuid = nameToUuid.get(value.name)
|
|
if (staticUuid) {
|
|
remappedNamedViews[staticUuid] = value
|
|
}
|
|
}
|
|
})
|
|
if (settings && settings.settings && settings.settings.app) {
|
|
settings.settings.app.named_views = remappedNamedViews
|
|
}
|
|
}
|
|
return perProjectSettingsToToml(settings)
|
|
}
|
|
|
|
test.describe('Named view tests', () => {
|
|
test.fail(runningOnWindows(), 'Windows line endings break snapshot matching')
|
|
test('Verify project.toml is not created', async ({ page }, testInfo) => {
|
|
// Create project and load it
|
|
const projectName = 'named-views'
|
|
await createProject({ name: projectName, page })
|
|
|
|
// Generate file paths for project.toml
|
|
const projectDirName = testInfo.outputPath('electron-test-projects-dir')
|
|
const tempProjectSettingsFilePath = join(
|
|
projectDirName,
|
|
projectName,
|
|
PROJECT_SETTINGS_FILE_NAME
|
|
)
|
|
|
|
// project.toml should not exist on initial project creation
|
|
let exists = await fileExists(tempProjectSettingsFilePath)
|
|
expect(exists).toBe(false)
|
|
})
|
|
test('Verify named view gets created', async ({
|
|
cmdBar,
|
|
scene,
|
|
page,
|
|
}, testInfo) => {
|
|
const projectName = 'named-views'
|
|
const myNamedView = 'uuid1'
|
|
|
|
// Create and load project
|
|
await createProject({ name: projectName, page })
|
|
await scene.settled(cmdBar)
|
|
|
|
// Create named view
|
|
const projectDirName = testInfo.outputPath('electron-test-projects-dir')
|
|
await cmdBar.openCmdBar()
|
|
await cmdBar.chooseCommand('create named view')
|
|
await cmdBar.argumentInput.fill(myNamedView)
|
|
await cmdBar.progressCmdBar(false)
|
|
|
|
// Generate paths for the project.toml
|
|
const tempProjectSettingsFilePath = join(
|
|
projectDirName,
|
|
projectName,
|
|
PROJECT_SETTINGS_FILE_NAME
|
|
)
|
|
|
|
const toastMessage = page.getByText('Named view uuid1 created.')
|
|
await expect(toastMessage).toBeInViewport()
|
|
|
|
// Expect project.toml to be generated on disk since a named view was created
|
|
await expect(async () => {
|
|
let exists = await fileExists(tempProjectSettingsFilePath)
|
|
expect(exists).toBe(true)
|
|
}).toPass()
|
|
|
|
await expect(async () => {
|
|
// Read project.toml into memory
|
|
let tomlString = await fsp.readFile(tempProjectSettingsFilePath, 'utf-8')
|
|
|
|
// Rewrite the uuids in the named views to match snapshot otherwise they will be randomly generated from rust and break
|
|
tomlString = tomlStringOverWriteNamedViewUuids(tomlString)
|
|
|
|
// Write the entire tomlString to a snapshot.
|
|
// There are many key/value pairs to check this is a safer match.
|
|
expect(tomlString).toMatchSnapshot('verify-named-view-gets-created.toml')
|
|
}).toPass()
|
|
})
|
|
test('Verify named view gets deleted', async ({
|
|
cmdBar,
|
|
scene,
|
|
page,
|
|
}, testInfo) => {
|
|
const projectName = 'named-views'
|
|
const myNamedView1 = 'uuid1'
|
|
|
|
// Create project and go into the project
|
|
await createProject({ name: projectName, page })
|
|
await scene.settled(cmdBar)
|
|
|
|
// Create a new named view
|
|
await cmdBar.openCmdBar()
|
|
await cmdBar.chooseCommand('create named view')
|
|
await cmdBar.argumentInput.fill(myNamedView1)
|
|
await cmdBar.progressCmdBar(false)
|
|
|
|
let toastMessage = page.getByText('Named view uuid1 created.')
|
|
await expect(toastMessage).toBeInViewport()
|
|
|
|
// Generate file paths for project.toml
|
|
const projectDirName = testInfo.outputPath('electron-test-projects-dir')
|
|
const tempProjectSettingsFilePath = join(
|
|
projectDirName,
|
|
projectName,
|
|
PROJECT_SETTINGS_FILE_NAME
|
|
)
|
|
|
|
// Except the project.toml to be written to disk since a named view was created
|
|
await expect(async () => {
|
|
let exists = await fileExists(tempProjectSettingsFilePath)
|
|
expect(exists).toBe(true)
|
|
}).toPass()
|
|
|
|
await expect(async () => {
|
|
// Read project.toml into memory
|
|
let tomlString = await fsp.readFile(tempProjectSettingsFilePath, 'utf-8')
|
|
// Rewrite the uuids in the named views to match snapshot otherwise they will be randomly generated from rust and break
|
|
tomlString = tomlStringOverWriteNamedViewUuids(tomlString)
|
|
|
|
// Write the entire tomlString to a snapshot.
|
|
// There are many key/value pairs to check this is a safer match.
|
|
expect(tomlString).toMatchSnapshot('verify-named-view-gets-created.toml')
|
|
}).toPass()
|
|
|
|
// Delete a named view
|
|
await cmdBar.openCmdBar()
|
|
await cmdBar.chooseCommand('delete named view')
|
|
cmdBar.selectOption({ name: myNamedView1 })
|
|
await cmdBar.progressCmdBar(false)
|
|
|
|
toastMessage = page.getByText('Named view uuid1 removed.')
|
|
await expect(toastMessage).toBeInViewport()
|
|
|
|
await expect(async () => {
|
|
// Read project.toml into memory again since we deleted a named view
|
|
let tomlString = await fsp.readFile(tempProjectSettingsFilePath, 'utf-8')
|
|
// Rewrite the uuids in the named views to match snapshot otherwise they will be randomly generated from rust and break
|
|
tomlString = tomlStringOverWriteNamedViewUuids(tomlString)
|
|
|
|
// Write the entire tomlString to a snapshot.
|
|
// There are many key/value pairs to check this is a safer match.
|
|
expect(tomlString).toMatchSnapshot('verify-named-view-gets-deleted.toml')
|
|
}).toPass()
|
|
})
|
|
test('Verify named view gets loaded', async ({
|
|
cmdBar,
|
|
scene,
|
|
page,
|
|
}, testInfo) => {
|
|
const projectName = 'named-views'
|
|
const myNamedView = 'uuid1'
|
|
|
|
// Create project and go into the project
|
|
await createProject({ name: projectName, page })
|
|
await scene.settled(cmdBar)
|
|
|
|
// Create a new named view
|
|
await cmdBar.openCmdBar()
|
|
await cmdBar.chooseCommand('create named view')
|
|
await cmdBar.argumentInput.fill(myNamedView)
|
|
await cmdBar.progressCmdBar(false)
|
|
|
|
let toastMessage = page.getByText('Named view uuid1 created.')
|
|
await expect(toastMessage).toBeInViewport()
|
|
|
|
// Generate file paths for project.toml
|
|
const projectDirName = testInfo.outputPath('electron-test-projects-dir')
|
|
const tempProjectSettingsFilePath = join(
|
|
projectDirName,
|
|
projectName,
|
|
PROJECT_SETTINGS_FILE_NAME
|
|
)
|
|
|
|
// Except the project.toml to be written to disk since a named view was created
|
|
await expect(async () => {
|
|
let exists = await fileExists(tempProjectSettingsFilePath)
|
|
expect(exists).toBe(true)
|
|
}).toPass()
|
|
|
|
await expect(async () => {
|
|
// Read project.toml into memory
|
|
let tomlString = await fsp.readFile(tempProjectSettingsFilePath, 'utf-8')
|
|
// Rewrite the uuids in the named views to match snapshot otherwise they will be randomly generated from rust and break
|
|
tomlString = tomlStringOverWriteNamedViewUuids(tomlString)
|
|
|
|
// Write the entire tomlString to a snapshot.
|
|
// There are many key/value pairs to check this is a safer match.
|
|
expect(tomlString).toMatchSnapshot('verify-named-view-gets-created.toml')
|
|
}).toPass()
|
|
|
|
// Create a load a named view
|
|
await cmdBar.openCmdBar()
|
|
await cmdBar.chooseCommand('load named view')
|
|
await cmdBar.argumentInput.fill(myNamedView)
|
|
await cmdBar.progressCmdBar(false)
|
|
|
|
// Check the toast appeared
|
|
await expect(
|
|
page.getByText(`Named view ${myNamedView} loaded.`)
|
|
).toBeVisible()
|
|
})
|
|
test('Verify two named views get created', async ({
|
|
cmdBar,
|
|
scene,
|
|
page,
|
|
}, testInfo) => {
|
|
const projectName = 'named-views'
|
|
const myNamedView1 = 'uuid1'
|
|
const myNamedView2 = 'uuid2'
|
|
|
|
// Create and load project
|
|
await createProject({ name: projectName, page })
|
|
await scene.settled(cmdBar)
|
|
|
|
// Create named view
|
|
const projectDirName = testInfo.outputPath('electron-test-projects-dir')
|
|
await cmdBar.openCmdBar()
|
|
await cmdBar.chooseCommand('create named view')
|
|
await cmdBar.argumentInput.fill(myNamedView1)
|
|
await cmdBar.progressCmdBar(false)
|
|
|
|
let toastMessage = page.getByText('Named view uuid1 created.')
|
|
await expect(toastMessage).toBeInViewport()
|
|
|
|
await scene.moveCameraTo({ x: 608, y: 0, z: 0 }, { x: 0, y: 0, z: 0 })
|
|
await page.waitForTimeout(2500)
|
|
|
|
await cmdBar.openCmdBar()
|
|
await cmdBar.chooseCommand('create named view')
|
|
await cmdBar.argumentInput.fill(myNamedView2)
|
|
await cmdBar.progressCmdBar(false)
|
|
|
|
toastMessage = page.getByText('Named view uuid2 created.')
|
|
await expect(toastMessage).toBeInViewport()
|
|
|
|
// Generate paths for the project.toml
|
|
const tempProjectSettingsFilePath = join(
|
|
projectDirName,
|
|
projectName,
|
|
PROJECT_SETTINGS_FILE_NAME
|
|
)
|
|
|
|
// Expect project.toml to be generated on disk since a named view was created
|
|
await expect(async () => {
|
|
let exists = await fileExists(tempProjectSettingsFilePath)
|
|
expect(exists).toBe(true)
|
|
}).toPass()
|
|
|
|
await expect(async () => {
|
|
// Read project.toml into memory
|
|
let tomlString = await fsp.readFile(tempProjectSettingsFilePath, 'utf-8')
|
|
// Rewrite the uuids in the named views to match snapshot otherwise they will be randomly generated from rust and break
|
|
tomlString = tomlStringOverWriteNamedViewUuids(tomlString)
|
|
|
|
// Write the entire tomlString to a snapshot.
|
|
// There are many key/value pairs to check this is a safer match.
|
|
expect(tomlString).toMatchSnapshot(
|
|
'verify-two-named-view-gets-created.toml'
|
|
)
|
|
}).toPass()
|
|
})
|
|
})
|