Component testing with Testing Library in Svelte

Introduction

Component testing helps you check if your Svelte parts work right. Testing Library makes this easy by focusing on what users see and do.

You want to check if a button click changes text on the screen.

You need to verify that a form shows error messages when empty.

You want to make sure a list displays the right items after loading data.

You want to test if a component shows or hides content based on user actions.

Syntax

Svelte

import { render, fireEvent } from '@testing-library/svelte';
import ComponentName from './ComponentName.svelte';

test('description', async () => {
  const { getByText } = render(ComponentName);
  const button = getByText('Click me');
  await fireEvent.click(button);
  expect(getByText('Changed text')).toBeInTheDocument();
});

render() creates a test version of your component.

fireEvent simulates user actions like clicks or typing.

Examples

This test checks if the text 'Hello, world!' appears when the component loads.

Svelte

import { render } from '@testing-library/svelte';
import Hello from './Hello.svelte';

test('shows greeting', () => {
  const { getByText } = render(Hello);
  getByText('Hello, world!');
});

This test clicks a button and checks if the count number updates.

Svelte

import { render, fireEvent } from '@testing-library/svelte';
import Counter from './Counter.svelte';

test('increments count on click', async () => {
  const { getByText } = render(Counter);
  const button = getByText('Count: 0');
  await fireEvent.click(button);
  getByText('Count: 1');
});

Sample Program

This example shows a simple counter button. The test renders the button, checks the initial count, clicks it, and then checks the updated count. It uses an accessible label for the button to help find it in the test.

Svelte

/* Counter.svelte */
<script>
  let count = 0;
  function increment() {
    count += 1;
  }
</script>
<button on:click={increment} aria-label="Increment count">Count: {count}</button>

/* Counter.test.js */
import { render, fireEvent } from '@testing-library/svelte';
import Counter from './Counter.svelte';

test('button increments count when clicked', async () => {
  const { getByRole } = render(Counter);
  const button = getByRole('button', { name: 'Increment count' });
  expect(button).toHaveTextContent('Count: 0');
  await fireEvent.click(button);
  expect(button).toHaveTextContent('Count: 1');
});

Important Notes

Use accessible roles and labels to find elements in tests for better clarity and reliability.

Testing Library encourages testing what users see, not internal details.

Always await user events like clicks to handle async updates correctly.

Summary

Component testing checks if your Svelte parts behave as users expect.

Testing Library helps simulate user actions and find elements by what they show.

Write tests that focus on visible output and user interaction, not internal code.

Practice

1. What is the main goal of component testing in Svelte using Testing Library?

easy

A. To check if the component behaves correctly from a user's perspective

B. To test the internal variables and functions of the component

C. To measure the performance speed of the component

D. To verify the component's file size and bundle output

Solution

1. Step 1: Understand component testing purpose

   Component testing focuses on how the component behaves and appears to users, not internal code details.

2. Step 2: Match Testing Library's approach

   Testing Library encourages testing visible output and user interactions, aligning with user perspective testing.

3. Final Answer:

   To check if the component behaves correctly from a user's perspective -> Option A

4. Quick Check:

   User-focused testing = To check if the component behaves correctly from a user's perspective [OK]

Hint: Focus on user-visible behavior, not internal code [OK]

Common Mistakes:

• Testing internal variables instead of user output
• Confusing performance testing with component testing
• Checking file size instead of behavior

2. Which of the following is the correct way to import the render function from Testing Library for Svelte?

easy

A. import { render } from 'svelte';

B. import render from 'svelte-testing-library';

C. import { render } from '@testing-library/svelte';

D. import { renderComponent } from '@testing-library/svelte';

Solution

1. Step 1: Identify the official Testing Library package for Svelte

   The official package is '@testing-library/svelte' which exports the render function.

2. Step 2: Check correct import syntax

   The render function is a named export, so it must be imported with curly braces.

3. Final Answer:

   import { render } from '@testing-library/svelte'; -> Option C

4. Quick Check:

   Named import from '@testing-library/svelte' = import { render } from '@testing-library/svelte'; [OK]

Hint: Use named import from '@testing-library/svelte' for render [OK]

Common Mistakes:

• Using default import instead of named import
• Importing from wrong package name
• Using incorrect function name like renderComponent

3. Given this test code snippet, what will be the output of the assertion?

import { render } from '@testing-library/svelte';
import Button from './Button.svelte';

test('button shows correct label', () => {
  const { getByText } = render(Button, { props: { label: 'Click me' } });
  const button = getByText('Click me');
  expect(button).toBeInTheDocument();
});

medium

A. The test fails because the label prop is not passed correctly

B. The test passes because the button with label 'Click me' is rendered

C. The test throws a syntax error due to wrong render usage

D. The test fails because getByText cannot find the button

Solution

1. Step 1: Analyze render usage with props

   The Button component is rendered with prop label set to 'Click me', which should display that text.

2. Step 2: Check getByText and assertion

   getByText('Click me') finds the button element with that text, so expect(button).toBeInTheDocument() passes.

3. Final Answer:

   The test passes because the button with label 'Click me' is rendered -> Option B

4. Quick Check:

   Rendered label found by getByText = The test passes because the button with label 'Click me' is rendered [OK]

Hint: Check if rendered text matches getByText query [OK]

Common Mistakes:

• Assuming getByText fails when text is passed as prop
• Confusing render syntax with props
• Thinking toBeInTheDocument fails without explicit import

4. Identify the error in this test code for a Svelte component using Testing Library:

import { render } from '@testing-library/svelte';
import Counter from './Counter.svelte';

test('increments count on button click', () => {
  const { getByText } = render(Counter);
  const button = getByText('Increment');
  button.click();
  expect(getByText('Count: 1')).toBeInTheDocument();
});

medium

A. Missing import of the Counter component

B. Not passing initial count prop to Counter component

C. Incorrect query getByText for the button label

D. Using button.click() instead of fireEvent.click(button)

Solution

1. Step 1: Check how user events are simulated

   Testing Library requires using fireEvent or userEvent to simulate clicks, not direct button.click() calls.

2. Step 2: Verify other parts of the test

   Counter is imported, getByText queries are correct, and initial props are optional here.

3. Final Answer:

   Using button.click() instead of fireEvent.click(button) -> Option D

4. Quick Check:

   Use fireEvent for clicks, not button.click() [OK]

Hint: Use fireEvent or userEvent for clicks, not element.click() [OK]

Common Mistakes:

• Calling element.click() directly instead of fireEvent
• Forgetting to import the component
• Using wrong text in getByText query

5. You want to test a Svelte component that conditionally shows a message only after a button click. Which Testing Library approach correctly waits for the message to appear before asserting?

import { render, fireEvent, waitFor } from '@testing-library/svelte';
import MessageToggle from './MessageToggle.svelte';

test('shows message after click', async () => {
  const { getByText, queryByText } = render(MessageToggle);
  expect(queryByText('Hello!')).toBeNull();
  const button = getByText('Show Message');
  await fireEvent.click(button);
  await waitFor(() => getByText('Hello!'));
  expect(getByText('Hello!')).toBeInTheDocument();
});

hard

A. This test correctly waits for the message to appear after the click

B. The test fails because waitFor is not needed here

C. The test should use setTimeout instead of waitFor

D. The test is incorrect because queryByText should be replaced with getByText

Solution

1. Step 1: Understand conditional rendering after event

   The message appears only after clicking the button, so the test must wait for it asynchronously.

2. Step 2: Check usage of waitFor and fireEvent

   fireEvent.click simulates the click, and waitFor waits until getByText('Hello!') finds the message, ensuring correct timing.

3. Final Answer:

   This test correctly waits for the message to appear after the click -> Option A

4. Quick Check:

   Use waitFor to await async UI changes = This test correctly waits for the message to appear after the click [OK]

Hint: Use waitFor to handle UI changes after events [OK]

Common Mistakes:

• Not waiting for async UI updates before asserting
• Using setTimeout instead of waitFor
• Confusing queryByText and getByText usage