grpc-test

Includes a JUnit 5 Extension that can automatically release gRPC resources at the end of the test. Like GrpcCleanupRule, but built for JUnit 5 and actively maintained.

Usage

Declare a Resources in one of the three following ways, and register Server and/or ManagedChannel instances with it.

Get a Resources from:

1. A test method parameter injection, or
2. An instance field, or
3. A static field.

The difference is in the lifecycle of the Resources object. For #1, a new instance is created for every test method. #2 is the same as #1 unless the test class declares @TestInstance(TestInstance.Lifecycle.PER_CLASS), in which case one instance is shared among all the tests. #3 is obviously one instance shared among all the tests.

@ExtendWith(GrpcCleanupExtension.class)
class ExampleTestCase {
    @Test
    void testSuccessful(Resources resources) {
        resources.register(server); // use default timeout
        resources.register(channel, Duration.ofSeconds(1)); // override default timeout
        resources.timeout(Duration.ofSeconds(3)); // change default timeout to 3 seconds
        resources.register(channel2) // channel2 timeout is 3 seconds; server and channel timeouts didn't change
    }
}

ℹ️ Note that for #2 and #3, if the variable is already been assigned a value by the user, the extension will not reinitialize it.

ℹ️ If you're writing @Nested tests, see issues/8.

The test class in client project uses the GrpcCleanupExtension from Java code.