Vitest setup for unit testing in Vue - Mini Project: Build & Apply

Vitest setup for unit testing

📖 Scenario: You are building a small Vue 3 component and want to make sure it works correctly by writing unit tests. To do this, you will set up Vitest, a testing tool designed for Vue projects.

🎯 Goal: Set up Vitest in a Vue 3 project and write a simple unit test for a component function.

📋 What You'll Learn

Create a basic Vue 3 component with a function to test

Add a Vitest configuration file

Write a unit test using Vitest syntax

Run the test setup with the correct import and test structure

💡 Why This Matters

🌍 Real World

Unit testing helps catch bugs early by checking small parts of your app work as expected. Vitest is a fast, modern tool for testing Vue components.

💼 Career

Many frontend developer roles require writing unit tests. Knowing how to set up and use Vitest shows you can maintain code quality and reliability.

1

Create a Vue 3 component with a function

Create a Vue 3 component file named Counter.vue with a count variable initialized to 0 and a function called increment that adds 1 to count.

Vue

// Your code here

Hint

Use ref from Vue to create a reactive count variable. Define increment as a function that increases count.value by 1.

2

Add Vitest configuration file

Create a file named vitest.config.ts and add a basic Vitest configuration that imports defineConfig from vitest/config and exports a default config with test property having globals: true.

Vue

// Your code here

Hint

Use defineConfig from vitest/config to create and export the configuration object. Set globals to true inside the test property.

3

Write a unit test for the increment function

Create a test file named Counter.test.ts. Import increment and count from Counter.vue. Write a test using test and expect to check that calling increment() increases count.value by 1.

Vue

// Your code here

Hint

Use test and expect from Vitest. Call incrementTest() and check if countTest.value equals 1.

4

Complete the Vitest setup and test structure

Ensure the test file imports test and expect from vitest and that the test function is correctly defined with a descriptive name and assertion. Confirm the configuration file exports the Vitest config properly.

Vue

// Your code here to finalize test structure

Hint

Check that the test imports and config export are correct and the test has a clear name and assertion.

Practice

1. What is the main purpose of Vitest when working with Vue projects?

easy

A. To run unit tests quickly and efficiently

B. To build and bundle Vue components

C. To style Vue components with CSS

D. To deploy Vue applications to servers

Solution

1. Step 1: Understand Vitest's role

   Vitest is a testing framework designed to run tests fast and provide feedback.

2. Step 2: Compare with other options

   Building, styling, and deploying are not testing tasks, so they don't match Vitest's purpose.

3. Final Answer:

   To run unit tests quickly and efficiently -> Option A

4. Quick Check:

   Vitest = fast unit testing [OK]

Hint: Vitest is for testing, not building or styling [OK]

Common Mistakes:

• Confusing Vitest with build tools
• Thinking Vitest handles styling
• Assuming Vitest deploys apps

2. Which of the following is the correct way to import Vue Test Utils in a Vitest test file?

easy

A. import mount from 'vue-test-utils';

B. import { mount } from '@vue/test-utils';

C. const mount = require('@vue/test-utils');

D. import { mount } from 'vitest/vue';

Solution

1. Step 1: Check correct import syntax

   Vue Test Utils exports mount as a named export, so use curly braces and the correct package name '@vue/test-utils'.

2. Step 2: Eliminate incorrect options

   import mount from 'vue-test-utils'; uses wrong package name and default import, C uses CommonJS require which is not standard ES modules, D uses wrong package name.

3. Final Answer:

   import { mount } from '@vue/test-utils'; -> Option B

4. Quick Check:

   Correct import = import { mount } from '@vue/test-utils'; [OK]

Hint: Use named imports with curly braces from '@vue/test-utils' [OK]

Common Mistakes:

• Using default import instead of named import
• Using require instead of import
• Wrong package name in import

3. Given this Vitest test code for a Vue component:

import { mount } from '@vue/test-utils';
import { describe, it, expect } from 'vitest';
import HelloWorld from './HelloWorld.vue';

describe('HelloWorld', () => {
  it('renders greeting', () => {
    const wrapper = mount(HelloWorld);
    expect(wrapper.text()).toContain('Hello');
  });
});

What will happen when this test runs?

medium

A. The test passes only if the component has a button

B. The test fails because mount is not imported correctly

C. The test passes if the component's text includes 'Hello'

D. The test throws a runtime error due to missing props

Solution

1. Step 1: Analyze the test logic

   The test mounts the HelloWorld component and checks if its text includes 'Hello'.

2. Step 2: Check for errors or conditions

   Mount is imported correctly, no props are required, and the test expects 'Hello' in text.

3. Final Answer:

   The test passes if the component's text includes 'Hello' -> Option C

4. Quick Check:

   Text includes 'Hello' = test passes [OK]

Hint: Check what the expect statement verifies in the test [OK]

Common Mistakes:

• Assuming mount import is wrong
• Thinking props are mandatory here
• Confusing test condition with button presence

4. You wrote this Vitest test but it fails with "ReferenceError: describe is not defined":

import { mount } from '@vue/test-utils';
import HelloWorld from './HelloWorld.vue';

describe('HelloWorld', () => {
  it('renders greeting', () => {
    const wrapper = mount(HelloWorld);
    expect(wrapper.text()).toContain('Hello');
  });
});

What is the most likely fix?

medium

A. Remove the mount import

B. Change describe to test and it to check

C. Wrap the test code inside a Vue component

D. Add import { describe, it, expect } from 'vitest'; at the top

Solution

1. Step 1: Identify missing imports

   The error says 'describe' is not defined, meaning it is not imported from Vitest.

2. Step 2: Add necessary imports

   Importing describe, it, and expect from 'vitest' fixes the error.

3. Final Answer:

   Add import { describe, it, expect } from 'vitest'; at the top -> Option D

4. Quick Check:

   Missing test functions import = add import [OK]

Hint: Always import test functions from 'vitest' [OK]

Common Mistakes:

• Assuming describe is globally available
• Changing test function names incorrectly
• Removing needed imports

5. You want to test a Vue component that uses a global plugin. Which Vitest setup step is necessary to ensure the plugin works during testing?

hard

A. Configure the test to mount the component with the plugin registered globally

B. Mock the plugin by replacing it with an empty object

C. Import the plugin inside the test file but do not register it

D. Run the test without mounting the component

Solution

1. Step 1: Understand plugin usage in tests

   Global plugins must be registered in the test mount options to behave like in the app.

2. Step 2: Choose correct setup

   Mounting with the plugin registered globally ensures the component can use it during the test.

3. Final Answer:

   Configure the test to mount the component with the plugin registered globally -> Option A

4. Quick Check:

   Global plugin = register in mount options [OK]

Hint: Register global plugins in mount options for tests [OK]

Common Mistakes:

• Mocking plugin without registering it
• Importing plugin but not registering
• Testing without mounting component