Files
ComfyUI_frontend/src/platform/assets/components/modelInfo/ModelInfoPanel.test.ts
Alexander Brown f90d6cf607 test: migrate 132 test files from @vue/test-utils to @testing-library/vue (#10965)
## 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>
2026-04-08 19:21:42 -07:00

199 lines
5.8 KiB
TypeScript

import { createTestingPinia } from '@pinia/testing'
import { describe, expect, it, vi } from 'vitest'
import { createI18n } from 'vue-i18n'
import { render, screen } from '@testing-library/vue'
import type { AssetDisplayItem } from '@/platform/assets/composables/useAssetBrowser'
import ModelInfoPanel from './ModelInfoPanel.vue'
vi.mock('@/composables/useCopyToClipboard', () => ({
useCopyToClipboard: () => ({
copyToClipboard: vi.fn()
})
}))
const i18n = createI18n({
legacy: false,
locale: 'en',
messages: { en: {} },
missingWarn: false,
fallbackWarn: false
})
describe('ModelInfoPanel', () => {
const createMockAsset = (
overrides: Partial<AssetDisplayItem> = {}
): AssetDisplayItem => ({
id: 'test-id',
name: 'test-model.safetensors',
asset_hash: 'hash123',
size: 1024,
mime_type: 'application/octet-stream',
tags: ['models', 'checkpoints'],
created_at: '2024-01-01T00:00:00Z',
updated_at: '2024-01-01T00:00:00Z',
last_access_time: '2024-01-01T00:00:00Z',
secondaryText: 'A test model description',
badges: [],
stats: {},
...overrides
})
function renderPanel(asset: AssetDisplayItem) {
return render(ModelInfoPanel, {
props: { asset },
global: {
plugins: [createTestingPinia({ stubActions: false }), i18n]
}
})
}
describe('Basic Info Section', () => {
it('renders basic info section', () => {
renderPanel(createMockAsset())
expect(
screen.getByText('assetBrowser.modelInfo.basicInfo')
).toBeInTheDocument()
})
it('displays asset filename', () => {
const asset = createMockAsset({ name: 'my-model.safetensors' })
renderPanel(asset)
expect(
screen.getAllByText('my-model.safetensors').length
).toBeGreaterThanOrEqual(1)
})
it('prefers user_metadata.filename over asset.name for filename field', () => {
const asset = createMockAsset({
name: 'registry-display-name',
user_metadata: { filename: 'checkpoints/real-file.safetensors' }
})
renderPanel(asset)
expect(
screen.getByText('checkpoints/real-file.safetensors')
).toBeInTheDocument()
})
it('displays name from user_metadata when present', () => {
const asset = createMockAsset({
user_metadata: { name: 'My Custom Model' }
})
renderPanel(asset)
expect(screen.getByText('My Custom Model')).toBeInTheDocument()
})
it('falls back to asset name when user_metadata.name not present', () => {
const asset = createMockAsset({ name: 'fallback-model.safetensors' })
renderPanel(asset)
expect(
screen.getAllByText('fallback-model.safetensors').length
).toBeGreaterThanOrEqual(1)
})
it('renders source link when source_arn is present', () => {
const asset = createMockAsset({
user_metadata: { source_arn: 'civitai:model:123:version:456' }
})
renderPanel(asset)
const link = screen.getByRole('link')
expect(link).toHaveAttribute(
'href',
'https://civitai.com/models/123?modelVersionId=456'
)
expect(link).toHaveAttribute('target', '_blank')
})
it('displays Civitai icon for Civitai source', () => {
const asset = createMockAsset({
user_metadata: { source_arn: 'civitai:model:123:version:456' }
})
renderPanel(asset)
expect(screen.getByRole('img')).toHaveAttribute(
'src',
'/assets/images/civitai.svg'
)
})
it('does not render source field when source_arn is absent', () => {
renderPanel(createMockAsset())
expect(screen.queryAllByRole('link')).toHaveLength(0)
})
})
describe('Model Tagging Section', () => {
it('renders model tagging section', () => {
renderPanel(createMockAsset())
expect(
screen.getByText('assetBrowser.modelInfo.modelTagging')
).toBeInTheDocument()
})
it('renders model type field', () => {
renderPanel(createMockAsset())
expect(
screen.getByText('assetBrowser.modelInfo.modelType')
).toBeInTheDocument()
})
it('renders base models field', () => {
const asset = createMockAsset({
user_metadata: { base_model: ['SDXL'] }
})
renderPanel(asset)
expect(
screen.getByText('assetBrowser.modelInfo.compatibleBaseModels')
).toBeInTheDocument()
})
it('renders additional tags field', () => {
renderPanel(createMockAsset())
expect(
screen.getByText('assetBrowser.modelInfo.additionalTags')
).toBeInTheDocument()
})
})
describe('Model Description Section', () => {
it('renders trigger phrases when present', () => {
const asset = createMockAsset({
user_metadata: { trained_words: ['trigger1', 'trigger2'] }
})
renderPanel(asset)
expect(screen.getByText('trigger1')).toBeInTheDocument()
expect(screen.getByText('trigger2')).toBeInTheDocument()
})
it('renders description section', () => {
renderPanel(createMockAsset())
expect(
screen.getByText('assetBrowser.modelInfo.modelDescription')
).toBeInTheDocument()
})
it('does not render trigger phrases field when empty', () => {
renderPanel(createMockAsset())
expect(
screen.queryByText('assetBrowser.modelInfo.triggerPhrases')
).not.toBeInTheDocument()
})
})
describe('Accordion Structure', () => {
it('renders all three section labels', () => {
renderPanel(createMockAsset())
expect(
screen.getByText('assetBrowser.modelInfo.basicInfo')
).toBeInTheDocument()
expect(
screen.getByText('assetBrowser.modelInfo.modelTagging')
).toBeInTheDocument()
expect(
screen.getByText('assetBrowser.modelInfo.modelDescription')
).toBeInTheDocument()
})
})
})