#7: Support for in-process transport for testing

Signed-off-by: andreilisa <andreilisa2001@gmail.com>

Author: andreilisa

samples/grpc-server/src/test/java/org/springframework/grpc/sample/InProcessApplicationContextInitializerTests.java

@@ -0,0 +1,101 @@
+/*
+ * Copyright 2024-2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.grpc.sample;
+
+import io.grpc.ManagedChannel;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.NoSuchBeanDefinitionException;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+import org.springframework.grpc.test.InProcessApplicationContextInitializer;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.AssertionsForClassTypes.assertThatThrownBy;
+
+/*
+ * @author Andrei Lisa
+ */
+
+@SpringBootTest
+class InProcessApplicationContextInitializerTests {
+
+	private AnnotationConfigApplicationContext context;
+
+	@BeforeEach
+	public void setUp() {
+		System.clearProperty("spring.grpc.inprocess");
+		context = new AnnotationConfigApplicationContext();
+	}
+
+	@AfterEach
+	public void cleanUp() {
+		InProcessApplicationContextInitializer.shutdown();
+		context.close();
+	}
+
+	@Nested
+	class WhenDefaultEnabled {
+
+		@Test
+		void shouldInitializeInProcessServer() {
+			new InProcessApplicationContextInitializer().initialize(context);
+			context.refresh();
+
+			ManagedChannel channel = context.getBean("grpcInProcessChannel", ManagedChannel.class);
+			assertThat(channel).isNotNull().isInstanceOf(ManagedChannel.class);
+		}
+
+	}
+
+	@Nested
+	class WhenDisabledByProperty {
+
+		@Test
+		void shouldNotInitializeInProcessServer() {
+			System.setProperty("spring.grpc.inprocess", "false");
+			new InProcessApplicationContextInitializer().initialize(context);
+			context.refresh();
+			assertThatThrownBy(() -> {
+				context.getBean("grpcInProcessChannel", ManagedChannel.class);
+			}).isInstanceOf(NoSuchBeanDefinitionException.class);
+		}
+
+	}
+
+	@Nested
+	class WhenShutdownIsCalled {
+
+		@Test
+		void shouldShutdownInProcessServer() {
+			new InProcessApplicationContextInitializer().initialize(context);
+			context.refresh();
+
+			ManagedChannel channel = context.getBean("grpcInProcessChannel", ManagedChannel.class);
+			assertThat(channel).isNotNull();
+
+			InProcessApplicationContextInitializer.shutdown();
+
+			assertThat(channel).isNotNull();
+			assertThat(channel.isShutdown()).isTrue();
+		}
+
+	}
+
+}

spring-grpc-test/pom.xml

@@ -35,5 +35,9 @@
 			<groupId>io.grpc</groupId>
 			<artifactId>grpc-testing</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>io.grpc</groupId>
+			<artifactId>grpc-inprocess</artifactId>
+		</dependency>
 	</dependencies>
 </project>

spring-grpc-test/src/main/java/org/springframework/grpc/test/InProcessApplicationContextInitializer.java

@@ -0,0 +1,77 @@
+/*
+ * Copyright 2024-2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.grpc.test;
+
+import io.grpc.ManagedChannel;
+import io.grpc.Server;
+import io.grpc.inprocess.InProcessChannelBuilder;
+import io.grpc.inprocess.InProcessServerBuilder;
+import org.springframework.context.ApplicationContextInitializer;
+import org.springframework.context.ConfigurableApplicationContext;
+
+/*
+ * @author Andrei Lisa
+ */
+public class InProcessApplicationContextInitializer
+		implements ApplicationContextInitializer<ConfigurableApplicationContext> {
+
+	private static final String PROPERTY_SOURCE_NAME = "spring.grpc.inprocess";
+
+	private static final String CHANNEL_NAME = "grpcInProcessChannel";
+
+	private static Server grpcServer;
+
+	private static ManagedChannel grpcChannel;
+
+	@Override
+	public void initialize(ConfigurableApplicationContext applicationContext) {
+		String inProcessEnabled = System.getProperty(PROPERTY_SOURCE_NAME, "true");
+
+		if ("true".equalsIgnoreCase(inProcessEnabled) && isJarOnClasspath()) {
+			try {
+				String serverName = InProcessServerBuilder.generateName();
+
+				grpcServer = InProcessServerBuilder.forName(serverName).directExecutor().build().start();
+
+				grpcChannel = InProcessChannelBuilder.forName(serverName).directExecutor().build();
+				applicationContext.getBeanFactory().registerSingleton(CHANNEL_NAME, grpcChannel);
+
+			}
+			catch (Exception e) {
+				throw new RuntimeException("Failed to initialize in-process gRPC server", e);
+			}
+		}
+	}
+
+	private boolean isJarOnClasspath() {
+		try {
+			Class.forName("io.grpc.inprocess.InProcessChannelBuilder");
+			return true;
+		}
+		catch (ClassNotFoundException e) {
+			return false;
+		}
+	}
+
+	public static void shutdown() {
+		if (grpcChannel != null)
+			grpcChannel.shutdownNow();
+		if (grpcServer != null)
+			grpcServer.shutdownNow();
+	}
+
+}

spring-grpc-test/src/main/resources/META-INF/spring.factories

@@ -1,3 +1,4 @@
 # Application Context Initializers
 org.springframework.context.ApplicationContextInitializer=\
-org.springframework.grpc.test.ServerPortInfoApplicationContextInitializer
+org.springframework.grpc.test.ServerPortInfoApplicationContextInitializer,\
+org.springframework.grpc.test.InProcessApplicationContextInitializer