Vitest setup for unit testing in Vue - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is Vitest used for in Vue projects?

Vitest is a testing framework used to write and run unit tests for Vue components and JavaScript code, helping ensure code works as expected.

beginner

Which command installs Vitest and Vue Test Utils for unit testing?

You run npm install -D vitest @vue/test-utils to add Vitest and Vue Test Utils as development dependencies.

intermediate

What file do you create to configure Vitest in a Vue project?

You create a vitest.config.ts file to set up Vitest options like test environment and Vue plugin integration.

beginner

How do you run Vitest tests from the command line?

Use npx vitest or add a script like "test": "vitest" in package.json and run npm run test.

intermediate

Why is it important to use @vue/test-utils with Vitest?

@vue/test-utils provides helpers to mount and interact with Vue components in tests, making unit testing easier and more accurate.

Which command installs Vitest in a Vue project?

A npm install -D vitest

B npm install vitest

C npm install -g vitest

D npm install vue-vitest

Vitest should be installed as a development dependency using npm install -D vitest.

What file is commonly used to configure Vitest settings?

A test.config.json

B vue.config.js

C vitest.setup.js

D vitest.config.ts

Vitest uses vitest.config.ts or vitest.config.js for configuration.

Which package helps mount Vue components in Vitest tests?

A vitest-utils

B @vue/test-utils

C vue-test-runner

D vue-mount

@vue/test-utils provides utilities to mount and test Vue components.

How do you run Vitest tests using npm scripts?

A npm start

B npm run vitest

C npm run test

D npm test-all

You add a script like "test": "vitest" and run npm run test.

What test environment is recommended for Vue component testing with Vitest?

A jsdom

B node

C browser

D deno

The jsdom environment simulates a browser for Vue component tests.

Describe the steps to set up Vitest for unit testing in a Vue project.

Think about installation, configuration, and running tests.

Explain why @vue/test-utils is important when using Vitest for Vue components.

Consider how you test Vue components practically.

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