Improve documentation around testing setup

[cdprete]

Hello.

This is somehow a continuation of #278.

The documentation should, in my opinion, offer at least an example of configuration which doesn't require @SpringBootTest.

In my application, I've some LDAP configuration which gets usually loaded and @SpringBootTest starts a full context, therefore including such chunk of LDAP stuff, even if they're not needed.
@DataLdapTest would resolve the issue with the missing LDAP resources, but it doesn't work because then there are 2 bootstrap contexts defined (the one coming from @SpringBootTest and the one coming from @DataLdapTest).

@dsyer The only I found to make this work was to use @SpringJUnit and to set explicitly the spring.grpc.test.inprocess.enabled property to true with a @TestPropertySource since, for some unknown reasons to me, @AutoConfigureInProcessTransport was then getting ignored. I don't know if it's maybe a bug then.

• Spring Boot version: 3.5.7
• Spring gRPC version: 0.11.0

[dsyer]

Can you clarify a bit more what the test is for (client or server, or both, etc.) and why @SpringBootTest doesn't work for you. I don't quite follow your point about the LDAP. You wouldn't want to put @DataLdapTest and @SpringBootTest on the same class (ever), and if you use @DataLdapTest then you won't get any gRPC features autoconfigured (I would expect).

[cdprete]

Hello.

The idea is to test the server.
As said, if I annotate the test with @SpringBootTest, the full context gets initialized, including my LdapConfiguration class that configures some LDAP stuff (repos, context, pooling, ...).
But, for the scope of the test, that part is not needed and, actually, it fails because the embedded LDAP server starts only with @DataLdapTest.

[dsyer]

So what was it that worked for you in the end? I'm still not really getting the picture. It seems like you want a gRPC server with inprocess transport, and no LDAP. How could we make that easier, or easier to find examples?

[cdprete]

So what was it that worked for you in the end? I'm still not really getting the picture. It seems like you want a gRPC server with inprocess transport, and no LDAP

Correct.
This is what worked for me:

@TestPropertySource(properties = {
        "spring.grpc.test.inprocess.enabled=true",
        "spring.grpc.server.inprocess.name=junit",
        "spring.grpc.client.channels.junit.address=in-process:junit"
})
@SpringJUnitConfig(classes = {
        GrpcClientConfig.class,
        AdjustmentsApiGRPC.class
})
@EnableAutoConfiguration
class AdjustmentsApiGRPCTest {
...
}

[dsyer]

I guess I need a simple sample. This works for me in the grpc-server sample:

@TestPropertySource(properties = {
		"spring.grpc.test.inprocess.enabled=true",
		"spring.grpc.client.inprocess.exclusive=true",
		"spring.grpc.server.inprocess.exclusive=true",
		"spring.grpc.client.default-channel.address=localhost:9090"
})
@SpringJUnitConfig(TestConfig.class)
public class GrpcServerSideTests {

	@Autowired
	private SimpleBlockingStub stub;

	@Test
	void contextLoads() {
		HelloRequest request = HelloRequest.newBuilder().setName("Test").build();
		HelloReply reply = this.stub.sayHello(request);
		assertThat(reply.getMessage()).contains(("Test"));
	}

	@TestConfiguration
	@Import(GrpcServerService.class)
	@EnableAutoConfiguration
	static class TestConfig {
	}

}

You need the "enabled" and "exclusive" properties to mimic @AutoConfigInProcessTransport, and you need the default channel address so that the stubs are created automatically.

I'm not quite sure what the point is, so I'm not really sure where to start documenting.

[cdprete]

I guess I need a simple sample. This works for me in the grpc-server sample:

@TestPropertySource(properties = {
"spring.grpc.test.inprocess.enabled=true",
"spring.grpc.client.inprocess.exclusive=true",
"spring.grpc.server.inprocess.exclusive=true",
"spring.grpc.client.default-channel.address=localhost:9090"
})
@SpringJUnitConfig(TestConfig.class)
public class GrpcServerSideTests {

@Autowired
private SimpleBlockingStub stub;

@test
void contextLoads() {
HelloRequest request = HelloRequest.newBuilder().setName("Test").build();
HelloReply reply = this.stub.sayHello(request);
assertThat(reply.getMessage()).contains(("Test"));
}

@TestConfiguration
@import(GrpcServerService.class)
@EnableAutoConfiguration
static class TestConfig {
}

}
You need the "enabled" and "exclusive" properties to mimic @AutoConfigInProcessTransport, and you need the default channel address so that the stubs are created automatically.

I'm not quite sure what the point is, so I'm not really sure where to start documenting.

This would already be fine as example in the docs if it's followed by some explanations.
The point is that the docs just say to use @SpringBootTest but it may be too wide.

[dsyer]

I'm not sure I would recommend doing it that way though. It depends on what you need to do. For instance, it might be better to use @SpringBootTest with some excludes.

[cdprete]

I'm not sure I would recommend doing it that way though. It depends on what you need to do. For instance, it might be better to use @SpringBootTest with some excludes.

The problem is that you can exclude only auto configurations and, usually, to my knowledge, you don't write your configurations as auto configurations in applications but rather in libraries.

[onobc]

This sounds like a case for a Spring Boot test slice (e.g. @SpringGrpcTest).

[cdprete]

@SpringGrpcTest

It may be an option. Is there support for this? I didn't find anything under https://docs.spring.io/spring-grpc/reference/server.html#_testing.

[onobc]

Hi @cdprete - no we would have to implement a "test slice" and we would likely not do that until version 1.1 which is when we will move the Spring Boot auto-configuration and starters out of this project and into Spring Boot 4.1.x.

[cdprete]

Hi @cdprete - no we would have to implement a "test slice" and we would likely not do that until version 1.1 which is when we will move the Spring Boot auto-configuration and starters out of this project and into Spring Boot 4.1.x.

Hi @onobc.

Fair enough. I would suggest to just extend the documentation for now then.

[onobc]

Thanks @cdprete ,

Would you be able to submit a PR w/ the changes that you think would be helpful?

[dsyer]

Good idea. N.B. in snapshots you can use @AutoConfigureInProcessTransport without @SpringBootTest. So that's probably the message to get over in the docs - just use that annotation and anything else you need (e.g. @EnableAutoconfiguration) to switch on the server and client configurations. Here's my example from earlier:

@TestPropertySource(properties = { "spring.grpc.client.default-channel.address=localhost:9090" })
@SpringJUnitConfig(TestConfig.class)
@AutoConfigureInProcessTransport
public class GrpcServerSideTests {

	@Autowired
	private SimpleBlockingStub stub;

	@Test
	void contextLoads() {
		HelloRequest request = HelloRequest.newBuilder().setName("Test").build();
		HelloReply reply = this.stub.sayHello(request);
		assertThat(reply.getMessage()).contains(("Test"));
	}

	@TestConfiguration
	@Import({ GrpcServerService.class })
	@EnableAutoConfiguration
	static class TestConfig {

	}

}

[cdprete]

GrpcServerService.class

@dsyer Maybe, for clarity, I would provide the content of GrpcServerService.class as well.