GraphQL APIs with Spring Boot · Lesson

Unit Testing GraphQL Resolvers

Write effective unit tests for your GraphQL resolvers and data fetching logic in Spring Boot.

Unit Testing GraphQL Resolvers is a free GraphQL APIs with Spring Boot lesson on CoddyKit — lesson 1 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the GraphQL APIs with Spring Boot learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.

Why Unit Test Resolvers?

Unit testing is crucial for ensuring the reliability of your GraphQL API. When we unit test resolvers, we focus on testing individual components in isolation.

Isolation: We test a resolver without needing a running server or database.
Correctness: Verify the resolver's logic, argument handling, and data transformation.
Speed: Unit tests run very fast, providing quick feedback during development.

This lesson will guide you through writing effective unit tests for your Spring Boot GraphQL resolvers.

Spring Boot Resolver Overview

Before testing, let's briefly recall how resolvers are structured in Spring Boot. They are typically Spring @Controller components with methods annotated for GraphQL operations like @QueryMapping or @MutationMapping.

These methods often depend on other Spring @Service components to fetch or manipulate data, which is where mocking comes in handy for testing.

Setting Up Test Environment

For unit testing in Spring Boot, you'll primarily use JUnit 5 and Mockito. These are typically included by default with spring-boot-starter-test.

JUnit 5: The testing framework to write and run your tests.
Mockito: A mocking framework to create mock objects for dependencies, allowing you to isolate the resolver under test.

Ensure your pom.xml or build.gradle includes the spring-boot-starter-test dependency.

Isolating Resolvers with Mocks

Resolvers often interact with services, repositories, or other components. To unit test a resolver, we need to isolate it from these dependencies.

Mockito helps us create 'mock' objects that mimic the behavior of real dependencies. This allows us to control what the dependencies return and verify how they are called, without actually invoking their real logic.

@Mock: Creates a mock instance of a class or interface.
@InjectMocks: Injects the created mocks into the object being tested.
@ExtendWith(MockitoExtension.class): Integrates Mockito with JUnit 5.

Testing a Simple Resolver

Let's start with a basic resolver that doesn't have any external dependencies. We can instantiate it directly and call its method.

This example shows a simple resolver and its corresponding unit test using JUnit 5 assertions.

package com.example.app;

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;

// Imagine MyResolver.java exists with a greeting() method
// @Controller
// public class MyResolver {
//   @QueryMapping
//   public String greeting() {
//     return "Hello GraphQL!";
//   }
// }

class MyResolverTest {
  @Test
  void greetingReturnsCorrectMessage() {
    // 1. Arrange: Create an instance of the resolver
    MyResolver resolver = new MyResolver();

    // 2. Act: Call the method under test
    String result = resolver.greeting();

    // 3. Assert: Verify the output
    assertEquals("Hello GraphQL!", result);
  }
}

Testing with Mocked Services

Most resolvers depend on services to perform business logic. Here's how to test a resolver that uses a GreetingService.

We use @Mock for the service and @InjectMocks for the resolver. Then, when().thenReturn() tells the mock what to return when its method is called.

package com.example.app;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.when;

// Imagine GreetingResolver.java and GreetingService.java exist
// (see previous scenes for context)

@ExtendWith(MockitoExtension.class)
class GreetingResolverTest {
  @Mock
  private GreetingService greetingService;

  @InjectMocks
  private GreetingResolver greetingResolver;

  @Test
  void personalizedGreetingReturnsExpected() {
    // Arrange: Define mock behavior
    when(greetingService.generateGreeting("Alice"))
      .thenReturn("Hello, Alice!");

    // Act: Call resolver method
    String result = greetingResolver.personalizedGreeting("Alice");

    // Assert: Verify resolver's output
    assertEquals("Hello, Alice!", result);
  }
}

Verifying Input Arguments

It's important to ensure that your resolver correctly passes arguments to its underlying services. Mockito's verify() method helps with this.

Mockito.verify(mockObject).method(expectedArgs) confirms that the specified method was called with the exact arguments during the test execution.

package com.example.app;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

@ExtendWith(MockitoExtension.class)
class GreetingResolverVerifyTest {
  @Mock
  private GreetingService greetingService;

  @InjectMocks
  private GreetingResolver greetingResolver;

  @Test
  void serviceCalledWithCorrectArgument() {
    // Arrange
    when(greetingService.generateGreeting("Bob"))
      .thenReturn("Hi Bob!");

    // Act
    greetingResolver.personalizedGreeting("Bob");

    // Assert: Verify service method was called with "Bob"
    verify(greetingService).generateGreeting("Bob");
  }
}

Testing for Expected Return Values

After a resolver processes data, it should return the correct output. JUnit's assertions are used to confirm these return values.

assertEquals(expected, actual): Checks if two values are equal.
assertNotNull(object): Checks if an object is not null.
assertTrue(condition): Checks if a condition is true.

Always assert the final state or return value of the resolver method.

package com.example.app;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.when;

@ExtendWith(MockitoExtension.class)
class GreetingResolverAssertTest {
  @Mock
  private GreetingService greetingService;

  @InjectMocks
  private GreetingResolver greetingResolver;

  @Test
  void personalizedGreetingReturnsExpectedValue() {
    String name = "Charlie";
    String expectedGreeting = "Hello, Charlie!";

    // Arrange
    when(greetingService.generateGreeting(name))
      .thenReturn(expectedGreeting);

    // Act
    String actualGreeting = 
      greetingResolver.personalizedGreeting(name);

    // Assert
    assertEquals(expectedGreeting, actualGreeting);
  }
}

Testing Error Scenarios

Robust resolvers should handle errors gracefully. Unit tests can verify that your resolvers throw expected exceptions or handle them appropriately.

Use JUnit's assertThrows to confirm that a specific exception type is thrown when certain conditions are met, such as a service failing.

package com.example.app;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.Mockito.when;

@ExtendWith(MockitoExtension.class)
class ErrorHandlingResolverTest {
  @Mock
  private GreetingService greetingService;

  @InjectMocks
  private GreetingResolver greetingResolver;

  @Test
  void personalizedGreetingThrowsExceptionOnError() {
    String name = "ErrorUser";

    // Arrange: Mock service to throw an exception
    when(greetingService.generateGreeting(name))
      .thenThrow(new RuntimeException("Service failed"));

    // Act & Assert: Verify that the resolver throws
    assertThrows(RuntimeException.class, () -> {
      greetingResolver.personalizedGreeting(name);
    });
  }
}

Quick Check: Unit Test Concepts

When unit testing a Spring Boot GraphQL resolver that depends on a UserService, what is the primary purpose of using Mockito's @Mock annotation on the UserService instance within your test class?

Recap & What's Next

Congratulations! You've learned the fundamentals of unit testing your GraphQL resolvers in Spring Boot.

We understood the importance of isolation for unit tests.
We used Mockito to mock service dependencies.
We wrote tests to verify resolver logic, argument passing, and return values.
We also covered testing error scenarios.

By applying these techniques, you can ensure your GraphQL resolvers are robust and behave as expected. Next, you might explore integration testing to verify your entire GraphQL API end-to-end.

Frequently asked questions

Is the “Unit Testing GraphQL Resolvers” lesson free?

Yes — the full text of “Unit Testing GraphQL Resolvers” is free to read here on the web, and the GraphQL APIs with Spring Boot course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the GraphQL APIs with Spring Boot course, upgrade to CoddyKit PRO.

What will I learn in “Unit Testing GraphQL Resolvers”?

Write effective unit tests for your GraphQL resolvers and data fetching logic in Spring Boot. You practise GraphQL APIs with Spring Boot with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.

Do I need any experience to start GraphQL APIs with Spring Boot?

No prior experience is required. GraphQL APIs with Spring Boot on CoddyKit is structured for beginners through advanced learners; this is — lesson 1 of 4, so you can start here or from the beginning and move at your own pace.

How long does the “Unit Testing GraphQL Resolvers” lesson take?

Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.

Can I write and run code in this GraphQL APIs with Spring Boot lesson?

Yes. Every GraphQL APIs with Spring Boot lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.

All lessons in this course

← Back to GraphQL APIs with Spring Boot