Mocking Dependencies with Mockito

In our journey through isolating dependencies with test doubles, we've explored dummies, stubs, and spies. This lesson focuses on mocks, which are powerful test doubles capable of simulating external dependencies in software tests. You may have noticed in the previous unit how spying on the real implementation can be messy. Mocks can imitate the behavior of complex systems, allowing us to test code in isolation without relying on real and sometimes unpredictable systems like databases or web services.

Now, let's review the TDD workflow:

• Red: Write a failing test.
• Green: Write the minimum code to pass the test.
• Refactor: Improve the code structure without changing its behavior.

We'll demonstrate these principles using mocks, helping you to effectively isolate and test your application logic.

Mocks are indispensable in TDD because they allow you to test your code independently of the parts of the system you don't control. For instance, when writing tests for a PricingService, you don't want tests to fail because an external currency conversion API goes down or changes unexpectedly. Mocks provide a controlled environment where you can simulate various conditions and responses as well as validate the calls.

Mocks, unlike spies, fully simulate the dependencies rather than simply observing their behavior. A mock creates a controlled substitute for a dependency, so the actual code or functionality isn’t executed. For instance, if a function interacts with an external API, a mock can simulate different responses from that API without making a network request.

Let's dive into mocking with Mockito in Scala. We'll start with the basics: how to mock a class and its methods.

Consider the IExchangeRateService, which fetches exchange rates from an API. In testing the PricingService, we need to mock this service to ensure our tests don't rely on actual API responses.

Here's a simple way to mock with Mockito:

class PricingServiceSpec extends AnyFunSpec with BeforeAndAfter with MockitoSugar:

  // Mock of the exchange rate service
  private var mockIExchangeRateService: IExchangeRateService = uninitialized
  private var pricingService: PricingService = uninitialized

  before:
    mockIExchangeRateService = mock[IExchangeRateService]
    pricingService = PricingService(mockIExchangeRateService)

  describe("convertPrice"):
    it("should use the mocked exchange rate to calculate final price"):
      // Arrange
      when(mockIExchangeRateService.getRate("USD", "EUR")).thenReturn(1.5)

      // Act
      val result = pricingService.convertPrice(100, "USD", "EUR")

      // Assert
      verify(mockIExchangeRateService, times(1)).getRate("USD", "EUR")
      assert(result == 150.00)
end PricingServiceSpec

In this setup:

• We use mock[...] to create a Mockito mock of the IExchangeRateService. This mock object allows control over returned values and behavior without implementing the actual logic.
• when(mockIExchangeRateService.getRate("USD", "EUR")).thenReturn(1.5) is used to simulate a method that returns a predefined value when called.
• verify(mockIExchangeRateService, times(1)).getRate("USD", "EUR") checks that this method was indeed called exactly once during the test.