mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-02-05 15:40:10 +00:00
## Summary Migrates all unit tests from `tests-ui/` to colocate with their source files in `src/`, improving discoverability and maintainability. ## Changes - **What**: Relocated all unit tests to be adjacent to the code they test, following the `<source>.test.ts` naming convention - **Config**: Updated `vitest.config.ts` to remove `tests-ui` include pattern and `@tests-ui` alias - **Docs**: Moved testing documentation to `docs/testing/` with updated paths and patterns ## Review Focus - Migration patterns documented in `temp/plans/migrate-tests-ui-to-src.md` - Tests use `@/` path aliases instead of relative imports - Shared fixtures placed in `__fixtures__/` directories ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-7811-chore-migrate-tests-from-tests-ui-to-colocate-with-source-files-2da6d73d36508147a4cce85365dee614) by [Unito](https://www.unito.io) --------- Co-authored-by: Amp <amp@ampcode.com> Co-authored-by: GitHub Action <action@github.com>
177 lines
5.2 KiB
TypeScript
177 lines
5.2 KiB
TypeScript
import { createPinia, setActivePinia } from 'pinia'
|
|
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import { app } from '@/scripts/app'
|
|
import { useKeybindingService } from '@/services/keybindingService'
|
|
import { useCommandStore } from '@/stores/commandStore'
|
|
import { useDialogStore } from '@/stores/dialogStore'
|
|
|
|
// Mock the app and canvas using factory functions
|
|
vi.mock('@/scripts/app', () => {
|
|
return {
|
|
app: {
|
|
canvas: {
|
|
processKey: vi.fn()
|
|
}
|
|
}
|
|
}
|
|
})
|
|
|
|
// Mock stores
|
|
vi.mock('@/platform/settings/settingStore', () => ({
|
|
useSettingStore: vi.fn(() => ({
|
|
get: vi.fn(() => [])
|
|
}))
|
|
}))
|
|
|
|
vi.mock('@/stores/dialogStore', () => ({
|
|
useDialogStore: vi.fn(() => ({
|
|
dialogStack: []
|
|
}))
|
|
}))
|
|
|
|
// Test utility for creating keyboard events with mocked methods
|
|
function createTestKeyboardEvent(
|
|
key: string,
|
|
options: {
|
|
target?: Element
|
|
ctrlKey?: boolean
|
|
altKey?: boolean
|
|
metaKey?: boolean
|
|
} = {}
|
|
): KeyboardEvent {
|
|
const {
|
|
target = document.body,
|
|
ctrlKey = false,
|
|
altKey = false,
|
|
metaKey = false
|
|
} = options
|
|
|
|
const event = new KeyboardEvent('keydown', {
|
|
key,
|
|
ctrlKey,
|
|
altKey,
|
|
metaKey,
|
|
bubbles: true,
|
|
cancelable: true
|
|
})
|
|
|
|
// Mock event methods
|
|
event.preventDefault = vi.fn()
|
|
event.composedPath = vi.fn(() => [target])
|
|
|
|
return event
|
|
}
|
|
|
|
describe('keybindingService - Event Forwarding', () => {
|
|
let keybindingService: ReturnType<typeof useKeybindingService>
|
|
|
|
beforeEach(() => {
|
|
vi.clearAllMocks()
|
|
setActivePinia(createPinia())
|
|
|
|
// Mock command store execute
|
|
const commandStore = useCommandStore()
|
|
commandStore.execute = vi.fn()
|
|
|
|
// Reset dialog store mock to empty
|
|
vi.mocked(useDialogStore).mockReturnValue({
|
|
dialogStack: []
|
|
} as any)
|
|
|
|
keybindingService = useKeybindingService()
|
|
keybindingService.registerCoreKeybindings()
|
|
})
|
|
|
|
it('should forward Delete key to canvas when no keybinding exists', async () => {
|
|
const event = createTestKeyboardEvent('Delete')
|
|
|
|
await keybindingService.keybindHandler(event)
|
|
|
|
// Should forward to canvas processKey
|
|
expect(vi.mocked(app.canvas.processKey)).toHaveBeenCalledWith(event)
|
|
// Should not execute any command
|
|
expect(vi.mocked(useCommandStore().execute)).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('should forward Backspace key to canvas when no keybinding exists', async () => {
|
|
const event = createTestKeyboardEvent('Backspace')
|
|
|
|
await keybindingService.keybindHandler(event)
|
|
|
|
expect(vi.mocked(app.canvas.processKey)).toHaveBeenCalledWith(event)
|
|
expect(vi.mocked(useCommandStore().execute)).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('should not forward Delete key when typing in input field', async () => {
|
|
const inputElement = document.createElement('input')
|
|
const event = createTestKeyboardEvent('Delete', { target: inputElement })
|
|
|
|
await keybindingService.keybindHandler(event)
|
|
|
|
// Should not forward to canvas when in input field
|
|
expect(vi.mocked(app.canvas.processKey)).not.toHaveBeenCalled()
|
|
expect(vi.mocked(useCommandStore().execute)).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('should not forward Delete key when typing in textarea', async () => {
|
|
const textareaElement = document.createElement('textarea')
|
|
const event = createTestKeyboardEvent('Delete', { target: textareaElement })
|
|
|
|
await keybindingService.keybindHandler(event)
|
|
|
|
expect(vi.mocked(app.canvas.processKey)).not.toHaveBeenCalled()
|
|
expect(vi.mocked(useCommandStore().execute)).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('should not forward Delete key when canvas processKey is not available', async () => {
|
|
// Temporarily replace processKey with undefined
|
|
const originalProcessKey = vi.mocked(app.canvas).processKey
|
|
vi.mocked(app.canvas).processKey = undefined as any
|
|
|
|
const event = createTestKeyboardEvent('Delete')
|
|
|
|
await keybindingService.keybindHandler(event)
|
|
|
|
expect(vi.mocked(useCommandStore().execute)).not.toHaveBeenCalled()
|
|
|
|
// Restore processKey for other tests
|
|
vi.mocked(app.canvas).processKey = originalProcessKey
|
|
})
|
|
|
|
it('should not forward Delete key when canvas is not available', async () => {
|
|
// Temporarily set canvas to null
|
|
const originalCanvas = vi.mocked(app).canvas
|
|
vi.mocked(app).canvas = null as any
|
|
|
|
const event = createTestKeyboardEvent('Delete')
|
|
|
|
await keybindingService.keybindHandler(event)
|
|
|
|
expect(vi.mocked(useCommandStore().execute)).not.toHaveBeenCalled()
|
|
|
|
// Restore canvas for other tests
|
|
vi.mocked(app).canvas = originalCanvas
|
|
})
|
|
|
|
it('should not forward non-canvas keys', async () => {
|
|
const event = createTestKeyboardEvent('Enter')
|
|
|
|
await keybindingService.keybindHandler(event)
|
|
|
|
// Should not forward Enter key
|
|
expect(vi.mocked(app.canvas.processKey)).not.toHaveBeenCalled()
|
|
expect(vi.mocked(useCommandStore().execute)).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('should not forward when modifier keys are pressed', async () => {
|
|
const event = createTestKeyboardEvent('Delete', { ctrlKey: true })
|
|
|
|
await keybindingService.keybindHandler(event)
|
|
|
|
// Should not forward when modifiers are pressed
|
|
expect(vi.mocked(app.canvas.processKey)).not.toHaveBeenCalled()
|
|
expect(vi.mocked(useCommandStore().execute)).not.toHaveBeenCalled()
|
|
})
|
|
})
|