testing

Testing Guidelines (Supplement)

For basic testing approach (Jest for unit, Playwright for E2E), see AGENTS.md. This rule adds detailed patterns.

---

1. Unit Tests (Jest)

File Location

• Place test files in __tests__ folder adjacent to the module being tested
• Naming: ComponentName.test.tsx or utilName.test.ts

Structure

import { render, screen } from '@testing-library/react';
import { userEvent } from '@testing-library/user-event';

describe('ComponentName', () => {
  it('renders correctly with valid props', () => {
    render(<Component {...defaultProps} />);
    expect(screen.getByText('Expected text')).toBeInTheDocument();
  });

  it('handles user interactions', async () => {
    const user = userEvent.setup();
    render(<Component {...defaultProps} />);
    await user.click(screen.getByRole('button'));
    await user.type(screen.getByLabelText('Name'), 'test-value');
    expect(screen.getByDisplayValue('test-value')).toBeInTheDocument();
  });

  it('handles loading state', () => {
    render(<Component loaded={false} />);
    expect(screen.getByRole('progressbar')).toBeInTheDocument();
  });

  it('handles error state', () => {
    render(<Component loadError={new Error('Failed')} />);
    expect(screen.getByText(/failed/i)).toBeInTheDocument();
  });

  it('handles empty state', () => {
    render(<Component data={[]} />);
    expect(screen.getByText(/no items/i)).toBeInTheDocument();
  });
});

Mocking

// Mock i18n
jest.mock('src/utils/i18n', () => ({
  useForkliftTranslation: () => ({ t: (key: string) => key }),
}));

// Mock Console SDK
jest.mock('@openshift-console/dynamic-plugin-sdk', () => ({
  useK8sWatchResource: jest.fn(),
}));

What to Test

• Renders without error
• Displays correct data
• Handles loading, error, empty states
• User interactions trigger correct callbacks
• Edge cases (null data, empty arrays, boundary values)

Run Commands

npm test                         # Run all unit tests
npm run test:coverage            # With coverage report
npm test path/to/file.test.ts    # Run specific test file