Mocktail

Mocktail Skill

This skill defines how to correctly use the mocktail package for mocking in Dart and Flutter tests.

1. Mock vs. Fake vs. Real Object

• Never add @override methods or implementations to a class extending Mock.
• Only use mocks if your test has verify assertions; otherwise prefer real or fake objects.

2. Creating Mocks

dartCopy code
class MockMyService extends Mock implements MyService {}
class FakeMyEvent extends Fake implements MyEvent {}

No code generation required — unlike Mockito, Mocktail uses noSuchMethod at runtime.

3. Registering Fallback Values

Register fallback values before using custom types with argument matchers. Do this in setUpAll or at the top of your test:

dartCopy code
setUpAll(() {
  registerFallbackValue(FakeMyEvent());
});

• Required for non-nullable custom types used with any(), captureAny(), or captureThat().
• Register fallback values for any custom type used with argument matchers.

4. Stubbing

dartCopy code
final mock = MockMyService();

// Return a value
when(() => mock.fetchData()).thenReturn('result');

// Throw an error
when(() => mock.fetchData()).thenThrow(Exception('error'));

// Dynamic/async response
when(() => mock.fetchData()).thenAnswer((_) async => 'result');

// Future<void>
when(() => mock.doWork()).thenAnswer((_) async {});

• Always stub async methods (returning Future or Future<void>) with thenAnswer.
• Stub every method you expect to be called, even if it's not the focus of your test.

5. Named Parameters

Always include all named parameters in both when and verify calls. Use any(named: 'paramName') for those you don't care about:

dartCopy code
when(() => mock.fetch(
  id: any(named: 'id'),
  headers: any(named: 'headers'),
)).thenReturn(response);

• If a method has default values for named parameters, Mocktail still expects them all to be matched.

6. Verification

dartCopy code
verify(() => mock.fetchData());             // called at least once
verifyNever(() => mock.fetchData());        // never called
verify(() => mock.fetchData()).called(2);   // called exactly twice

7. Argument Matchers

dartCopy code
// Any positional argument
when(() => mock.process(any())).thenReturn(true);

// Capture arguments for later assertions
final captured = verify(() => mock.process(captureAny())).captured;
print(captured.last);

• Use any() for positional parameters when you don't care about the exact value.
• Use captureThat() for conditional capturing.
• When matching string output, be aware of what .toString() returns for the type.

References

• Mocktail GitHub Repository