mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-05-24 22:58:08 +00:00
## Summary Migrate 132 test files from `@vue/test-utils` (VTU) to `@testing-library/vue` (VTL) with `@testing-library/user-event`, adopting user-centric behavioral testing patterns across the codebase. ## Changes - **What**: Systematic migration of component/unit tests from VTU's `mount`/`wrapper` API to VTL's `render`/`screen`/`userEvent` API across 132 files in `src/` - **Breaking**: None — test-only changes, no production code affected ### Migration breakdown | Batch | Files | Description | |-------|-------|-------------| | 1 | 19 | Simple render/assert tests | | 2A | 16 | Interactive tests with user events | | 2B-1 | 14 | Interactive tests (continued) | | 2B-2 | 32 | Interactive tests (continued) | | 3A–3E | 51 | Complex tests (stores, composables, heavy mocking) | | Lint fix | 7 | `await` on `fireEvent` calls for `no-floating-promises` | | Review fixes | 15 | Address CodeRabbit feedback (3 rounds) | ### Review feedback addressed - Removed class-based assertions (`text-ellipsis`, `pr-3`, `.pi-save`, `.skeleton`, `.bg-black\/15`, Tailwind utilities) in favor of behavioral/accessible queries - Added null guards before `querySelector` casts - Added `expect(roots).toHaveLength(N)` guards before indexed NodeList access - Wrapped fake timer tests in `try/finally` for guaranteed cleanup - Split double-render tests into focused single-render tests - Replaced CSS class selectors with `screen.getByText`/`screen.getByRole` queries - Updated stubs to use semantic `role`/`aria-label` instead of CSS classes - Consolidated redundant edge-case tests - Removed manual `document.body.appendChild` in favor of VTL container management - Used distinct mock return values to verify command wiring ### VTU holdouts (2 files) These files intentionally retain `@vue/test-utils` because their components use `<script setup>` without `defineExpose`, making internal computed properties and methods inaccessible via VTL: 1. **`NodeWidgets.test.ts`** — partial VTU for `vm.processedWidgets` 2. **`WidgetSelectDropdown.test.ts`** — full VTU for heavy `wrapper.vm.*` access ## Follow-up Deferred items (`ComponentProps` typing, camelCase listener props) tracked in #10966. ## Review Focus - Test correctness: all migrated tests preserve original behavioral coverage - VTL idioms: proper use of `screen` queries, `userEvent`, and accessibility-based selectors - The 2 VTU holdout files are intentional, not oversights ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-10965-test-migrate-132-test-files-from-vue-test-utils-to-testing-library-vue-33c6d73d36508199a6a7e513cf5d8296) by [Unito](https://www.unito.io) --------- Co-authored-by: Amp <amp@ampcode.com> Co-authored-by: Christian Byrne <cbyrne@comfy.org>
160 lines
4.3 KiB
TypeScript
160 lines
4.3 KiB
TypeScript
import { render, screen } from '@testing-library/vue'
|
|
import userEvent from '@testing-library/user-event'
|
|
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
|
import { createI18n } from 'vue-i18n'
|
|
|
|
import CanvasModeSelector from '@/components/graph/CanvasModeSelector.vue'
|
|
|
|
const mockExecute = vi.fn()
|
|
const mockGetCommand = vi.fn().mockReturnValue({
|
|
keybinding: {
|
|
combo: {
|
|
getKeySequences: () => ['V']
|
|
}
|
|
}
|
|
})
|
|
const mockFormatKeySequence = vi.fn().mockReturnValue('V')
|
|
|
|
vi.mock('@/stores/commandStore', () => ({
|
|
useCommandStore: () => ({
|
|
execute: mockExecute,
|
|
getCommand: mockGetCommand,
|
|
formatKeySequence: mockFormatKeySequence
|
|
})
|
|
}))
|
|
|
|
vi.mock('@/renderer/core/canvas/canvasStore', () => ({
|
|
useCanvasStore: () => ({
|
|
canvas: { read_only: false }
|
|
})
|
|
}))
|
|
|
|
const i18n = createI18n({
|
|
legacy: false,
|
|
locale: 'en',
|
|
messages: {
|
|
en: {
|
|
graphCanvasMenu: {
|
|
select: 'Select',
|
|
hand: 'Hand',
|
|
canvasMode: 'Canvas Mode'
|
|
}
|
|
}
|
|
}
|
|
})
|
|
|
|
const mockPopoverHide = vi.fn()
|
|
|
|
function renderComponent() {
|
|
const user = userEvent.setup()
|
|
render(CanvasModeSelector, {
|
|
global: {
|
|
plugins: [i18n],
|
|
stubs: {
|
|
Popover: {
|
|
template: '<div><slot /></div>',
|
|
methods: {
|
|
toggle: vi.fn(),
|
|
hide: mockPopoverHide
|
|
}
|
|
}
|
|
}
|
|
}
|
|
})
|
|
return { user }
|
|
}
|
|
|
|
describe('CanvasModeSelector', () => {
|
|
beforeEach(() => {
|
|
vi.clearAllMocks()
|
|
})
|
|
|
|
it('should render menu with menuitemradio roles and aria-checked', () => {
|
|
renderComponent()
|
|
|
|
expect(screen.getByRole('menu')).toBeInTheDocument()
|
|
|
|
const menuItems = screen.getAllByRole('menuitemradio')
|
|
expect(menuItems).toHaveLength(2)
|
|
|
|
expect(menuItems[0]).toHaveAttribute('aria-checked', 'true')
|
|
expect(menuItems[1]).toHaveAttribute('aria-checked', 'false')
|
|
})
|
|
|
|
it('should render menu items as buttons with aria-labels', () => {
|
|
renderComponent()
|
|
|
|
const menuItems = screen.getAllByRole('menuitemradio')
|
|
menuItems.forEach((item) => {
|
|
expect(item.tagName).toBe('BUTTON')
|
|
expect(item).toHaveAttribute('type', 'button')
|
|
})
|
|
expect(menuItems[0]).toHaveAttribute('aria-label', 'Select')
|
|
expect(menuItems[1]).toHaveAttribute('aria-label', 'Hand')
|
|
})
|
|
|
|
it('should use roving tabindex based on active mode', () => {
|
|
renderComponent()
|
|
|
|
const menuItems = screen.getAllByRole('menuitemradio')
|
|
expect(menuItems[0]).toHaveAttribute('tabindex', '0')
|
|
expect(menuItems[1]).toHaveAttribute('tabindex', '-1')
|
|
})
|
|
|
|
it('should mark icons as aria-hidden', () => {
|
|
renderComponent()
|
|
|
|
const menuItems = screen.getAllByRole('menuitemradio')
|
|
menuItems.forEach((item) => {
|
|
// eslint-disable-next-line testing-library/no-node-access
|
|
const icons = item.querySelectorAll('i')
|
|
icons.forEach((icon) => {
|
|
expect(icon).toHaveAttribute('aria-hidden', 'true')
|
|
})
|
|
})
|
|
})
|
|
|
|
it('should expose trigger button with aria-haspopup and aria-expanded', () => {
|
|
renderComponent()
|
|
|
|
const trigger = screen.getByRole('button', { name: 'Canvas Mode' })
|
|
expect(trigger).toHaveAttribute('aria-haspopup', 'menu')
|
|
expect(trigger).toHaveAttribute('aria-expanded', 'false')
|
|
})
|
|
|
|
it('should call focus on next item when ArrowDown is pressed', async () => {
|
|
const { user } = renderComponent()
|
|
|
|
const menuItems = screen.getAllByRole('menuitemradio')
|
|
const focusSpy = vi.spyOn(menuItems[1], 'focus')
|
|
|
|
menuItems[0].focus()
|
|
await user.keyboard('{ArrowDown}')
|
|
expect(focusSpy).toHaveBeenCalled()
|
|
})
|
|
|
|
it('should call focus on previous item when ArrowUp is pressed', async () => {
|
|
const { user } = renderComponent()
|
|
|
|
const menuItems = screen.getAllByRole('menuitemradio')
|
|
const focusSpy = vi.spyOn(menuItems[0], 'focus')
|
|
|
|
menuItems[1].focus()
|
|
await user.keyboard('{ArrowUp}')
|
|
expect(focusSpy).toHaveBeenCalled()
|
|
})
|
|
|
|
it('should close popover on Escape and restore focus to trigger', async () => {
|
|
const { user } = renderComponent()
|
|
|
|
const menuItems = screen.getAllByRole('menuitemradio')
|
|
const trigger = screen.getByRole('button', { name: 'Canvas Mode' })
|
|
const focusSpy = vi.spyOn(trigger, 'focus')
|
|
|
|
menuItems[0].focus()
|
|
await user.keyboard('{Escape}')
|
|
expect(mockPopoverHide).toHaveBeenCalled()
|
|
expect(focusSpy).toHaveBeenCalled()
|
|
})
|
|
})
|