Service mocking

API Design

Meaning

Service mocking replaces real external services (databases, third-party APIs, message brokers) with programmable test doubles that simulate their behavior at the network or protocol boundary. It addresses the pain point of tests being slow, flaky, or impossible to run when code depends on services that are unavailable, slow, or have side effects in test environments. The trigger is writing tests for code that interacts with services you do not control or cannot reach reliably from CI.

Primary Function

Test isolation

Communicative Purpose

Enables deterministic, fast, and offline testing of code that depends on external services by substituting them with controllable stand-ins.

Pattern

define mock behavior → inject into system under test → exercise code → verify interactions

Função primária

Test isolation

Propósito comunicativo

Enables deterministic, fast, and offline testing of code that depends on external services by substituting them with controllable stand-ins.

Situações de gatilho

Microservices testing: isolating a service from its downstream dependencies during unit and integration tests

Contextos

Microservices, REST and gRPC API clients, SDK development, test-driven development, CI/CD pipelines, frontend development against not-yet-built backends

Padrão

define mock behavior → inject into system under test → exercise code → verify interactions

Colocados típicos

test doubles
stubs
fakes
spies
dependency injection
HTTP mocking
WireMock
Mockito
msw
Pact
contract testing

Substituições comuns

In-memory fakes (more code
less boundary fidelity)
recorded HTTP fixtures (less flexible
harder to maintain)
sandbox environments (slower
shared state risk)

Erros comuns

Mocking types instead of behavior: tests break on harmless refactors because they assert on internal structure

Similar / contraste

Stub: returns canned data without verification of how it was called

Interferências

Coming from Python unittest.mock: may confuse patch decorators with service-level mocking — service mocking operates at the network/protocol boundary, not the object boundary

Família do chunk

test doubles
stubs
fakes
spies
dependency injection
contract testing

Nuance

When NOT to use: end-to-end tests that must verify real service contracts, or when the system under test is itself the service being mocked

Efeito pragmático

Enables fast, hermetic, deterministic test suites that do not depend on external service availability, dramatically improving CI pipeline speed and developer feedback loops.

Dica de memória

Service mocking is like hiring a stunt double for an unavailable actor — the stand-in looks and behaves the same for the scene so filming can continue without the real star.

Upgrade path

Contract testing (e.g., Pact) to verify mocks stay in sync with real service behavior

Frequência: HighFormulaicidade: FlexiblePrioridade de aquisição: Active recallPrioridade de output: BothTag de espaçamento: Medium-term

Examples

import requests from unittest.mock import patch, MagicMock def fetch_user_profile(user_id): response = requests.get(f"https://api.example.com/users/{user_id}") response.raise_for_status() return response.json() def test_fetch_user_profile_returns_parsed_json(): with patch("requests.get") as mock_get: mock_response = MagicMock() mock_response.json.return_value = {"id": 42, "name": "Alice"} mock_response.raise_for_status.return_value = None mock_get.return_value = mock_response profile = fetch_user_profile(42) assert profile["name"] == "Alice" mock_get.assert_called_once_with("https://api.example.com/users/42")

import { http, HttpResponse } from 'msw'; import { setupServer } from 'msw/node'; import { fetchOrderStatus } from './order-service'; const server = setupServer( http.get('/api/orders/:id', ({ params }) => { return HttpResponse.json({ id: params.id, status: 'shipped' }); }) ); beforeAll(() => server.listen()); afterEach(() => server.resetHandlers()); afterAll(() => server.close()); test('fetchOrderStatus returns shipped status', async () => { const status = await fetchOrderStatus('123'); expect(status).toBe('shipped'); });

import static com.github.tomakehurst.wiremock.client.WireMock.*; import com.github.tomakehurst.wiremock.WireMockServer; import org.junit.jupiter.api.*; import static org.junit.jupiter.api.Assertions.assertEquals; public class PaymentServiceTest { private WireMockServer mockServer; private PaymentService service; @BeforeEach void setUp() { mockServer = new WireMockServer(8089); mockServer.start(); configureFor("localhost", 8089); stubFor(post(urlEqualTo("/payments")) .willReturn(aResponse() .withStatus(200) .withBody("{\"transactionId\":\"tx-001\"}"))); service = new PaymentService("http://localhost:8089"); } @Test void processesPaymentSuccessfully() { String txId = service.processPayment(100.0, "USD"); assertEquals("tx-001", txId); verify(postRequestedFor(urlEqualTo("/payments"))); } }