Mocking composables and stores in Vue - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is mocking in the context of Vue composables and stores?

Mocking means creating fake versions of composables or stores to test components without using real data or logic. It helps isolate parts during testing.

beginner

Why do we mock composables or stores in Vue tests?

We mock them to control their behavior, avoid side effects, and test components independently from actual data or network calls.

intermediate

How can you mock a composable in Vue 3 using the Composition API?

You can replace the composable import with a mock function that returns fixed values or reactive refs during tests.

intermediate

What is a common tool to mock Pinia stores in Vue tests?

Pinia stores can be mocked by creating a fake store instance or using testing utilities like 'createTestingPinia' to simulate store behavior.

beginner

How does mocking improve test reliability in Vue applications?

Mocking removes dependencies on real data or APIs, making tests faster, more predictable, and easier to debug.

What is the main purpose of mocking a composable in Vue tests?

A To add new features to the composable

B To improve component styling

C To increase app performance in production

D To isolate component tests from real composable logic

Mocking isolates tests by replacing real composable logic with controlled fake data.

Which Vue store library is commonly mocked using 'createTestingPinia'?

A Pinia

B Vuex

C Redux

D MobX

'createTestingPinia' is a utility for mocking Pinia stores in tests.

When mocking a composable, what should the mock return?

A Random values each time

B The original composable's code

C Fixed or controlled reactive values

D Nothing at all

Mocks return fixed or controlled reactive values to simulate expected behavior.

Which Vue API is most relevant when mocking composables?

A Composition API

B Options API

C Vue Router

D Vue CLI

The Composition API is used to create and mock composables.

Mocking stores helps tests by:

A Making tests slower

B Removing side effects and dependencies

C Changing production code

D Adding network calls

Mocking removes side effects and external dependencies, improving test reliability.

Explain how you would mock a Pinia store in a Vue 3 test.

Think about how to isolate store logic from the component during testing.

Describe why mocking composables is useful when testing Vue components.

Consider what problems mocking solves in testing.

Practice

1. What is the main reason to mock composables or stores in Vue component tests?

easy

A. To automatically generate UI snapshots

B. To improve the component's runtime performance

C. To isolate the component test from real logic and external dependencies

D. To enable two-way data binding in tests

Solution

1. Step 1: Understand the purpose of mocking

   Mocking replaces real implementations with fake ones to isolate tests from external logic.

2. Step 2: Apply this to composables and stores

   Mocking composables and stores prevents side effects and focuses tests on the component itself.

3. Final Answer:

   To isolate the component test from real logic and external dependencies -> Option C

4. Quick Check:

   Mocking isolates tests = A [OK]

Hint: Mock to isolate component logic from external code [OK]

Common Mistakes:

• Thinking mocking improves runtime performance
• Confusing mocking with UI snapshot generation
• Believing mocking enables data binding

2. Which syntax correctly mocks a composable module named useAuth using Vitest's vi.mock()?

easy

A. vi.mock('./useAuth', () => ({ useAuth: () => ({ isLoggedIn: true }) }))

B. vi.mock('useAuth', () => ({ isLoggedIn: true }))

C. vi.mock('useAuth', () => ({ useAuth: () => ({ isLoggedIn: true }) }))

D. vi.mock('./useAuth', () => ({ isLoggedIn: true }))

Solution

1. Step 1: Identify the module path

   Modules are mocked by their relative or absolute path, so './useAuth' is correct if the file is local.

2. Step 2: Provide a factory returning the mocked composable function

   The factory must return an object with the composable function that returns the mocked state.

3. Final Answer:

   vi.mock('./useAuth', () => ({ useAuth: () => ({ isLoggedIn: true }) })) -> Option A

4. Quick Check:

   Correct path and factory function = C [OK]

Hint: Mock with correct path and return a function for composables [OK]

Common Mistakes:

• Using module name without path when path is required
• Returning state object directly instead of a function
• Mocking without a factory function

3. Given this mocked store code snippet:

vi.mock('./store', () => ({ useStore: () => ({ count: 5, increment: vi.fn() }) }))

const store = useStore();
store.increment();
console.log(store.count);

What will be logged to the console?

medium

A. undefined

B. 5

C. Error: increment is not a function

D. 0

Solution

1. Step 1: Analyze the mocked store return values

   The mocked useStore returns an object with count: 5 and increment as a mock function.

2. Step 2: Check the console.log output

   The count property is 5 and is not changed by calling increment() because it's a mock function without implementation.

3. Final Answer:

   5 -> Option B

4. Quick Check:

   Mocked count value logged = 5 [OK]

Hint: Mocked state stays same unless mock function changes it [OK]

Common Mistakes:

• Assuming mock function changes state automatically
• Expecting undefined because increment is mocked
• Confusing mock function with real implementation

4. Identify the error in this test mocking a composable:

vi.mock('./useCounter', () => ({
  useCounter: {
    count: 0,
    increment: vi.fn()
  }
}))

medium

A. The mock should return a function, not an object directly

B. The vi.fn() should be replaced with a real function

C. The module path './useCounter' is incorrect

D. The mock should not include the increment function

Solution

1. Step 1: Understand composable mocking pattern

   Composable modules export functions, so mocks must return a function, not an object.

2. Step 2: Identify the incorrect mock structure

   The code returns an object directly instead of a function returning the object.

3. Final Answer:

   The mock should return a function, not an object directly -> Option A

4. Quick Check:

   Composable mocks return functions = D [OK]

Hint: Mock composables as functions returning objects [OK]

Common Mistakes:

• Returning object directly instead of function
• Replacing vi.fn() unnecessarily
• Incorrect module path assumptions

5. You want to test a Vue component that uses a Pinia store with a fetchData action. How do you mock the store to verify fetchData is called without running its real logic?

hard

A. Replace fetchData with an empty async function in the real store

B. Import the real store and spy on fetchData without mocking

C. Mock the component instead of the store

D. Use vi.mock() to replace the store module with a mock where fetchData is a vi.fn()

Solution

1. Step 1: Understand mocking for store actions

   To isolate tests, replace the store module with a mock that has fetchData as a mock function.

2. Step 2: Use vi.mock() to replace the store module

   This allows you to track calls to fetchData without executing its real code.

3. Final Answer:

   Use vi.mock() to replace the store module with a mock where fetchData is a vi.fn() -> Option D

4. Quick Check:

   Mock store action with vi.fn() = A [OK]

Hint: Mock store actions with vi.fn() to track calls without side effects [OK]

Common Mistakes:

• Not mocking the store and calling real logic
• Mocking the component instead of the store
• Replacing functions with empty but untracked implementations