#7: fix comments

Signed-off-by: andreilisa <[email protected]>

Author: andreilisa

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

@@ -24,19 +24,16 @@
 import org.springframework.beans.factory.NoSuchBeanDefinitionException;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+import org.springframework.context.support.GenericApplicationContext;
 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;
+	private GenericApplicationContext context;
 
 	@BeforeEach
 	public void setUp() {
@@ -46,7 +43,6 @@ public void setUp() {
 
 	@AfterEach
 	public void cleanUp() {
-		InProcessApplicationContextInitializer.shutdown();
 		context.close();
 	}
 
@@ -55,6 +51,7 @@ class WhenDefaultEnabled {
 
 		@Test
 		void shouldInitializeInProcessServer() {
+			System.setProperty("spring.grpc.inprocess", "true");
 			new InProcessApplicationContextInitializer().initialize(context);
 			context.refresh();
 
@@ -72,9 +69,9 @@ void shouldNotInitializeInProcessServer() {
 			System.setProperty("spring.grpc.inprocess", "false");
 			new InProcessApplicationContextInitializer().initialize(context);
 			context.refresh();
-			assertThatThrownBy(() -> {
-				context.getBean("grpcInProcessChannel", ManagedChannel.class);
-			}).isInstanceOf(NoSuchBeanDefinitionException.class);
+
+			assertThatThrownBy(() -> context.getBean("grpcInProcessChannel", ManagedChannel.class))
+				.isInstanceOf(NoSuchBeanDefinitionException.class);
 		}
 
 	}
@@ -84,18 +81,19 @@ class WhenShutdownIsCalled {
 
 		@Test
 		void shouldShutdownInProcessServer() {
+			System.setProperty("spring.grpc.inprocess", "true");
 			new InProcessApplicationContextInitializer().initialize(context);
+			context.registerShutdownHook();
 			context.refresh();
 
 			ManagedChannel channel = context.getBean("grpcInProcessChannel", ManagedChannel.class);
 			assertThat(channel).isNotNull();
 
-			InProcessApplicationContextInitializer.shutdown();
+			context.close();
 
-			assertThat(channel).isNotNull();
 			assertThat(channel.isShutdown()).isTrue();
 		}
 
 	}
 
-}
+}

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

@@ -16,14 +16,21 @@
 
 package org.springframework.grpc.test;
 
+import org.springframework.context.ApplicationContextInitializer;
+import org.springframework.context.ConfigurableApplicationContext;
+
 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;
 
-/*
+/**
+ * An {@link ApplicationContextInitializer} that configures and registers an in-process
+ * gRPC {@link Server} and {@link ManagedChannel} within a Spring
+ * {@link ConfigurableApplicationContext}. This initializer is intended for testing
+ * environments, allowing gRPC communication within the same process without network
+ * overhead.
+ *
  * @author Andrei Lisa
  */
 public class InProcessApplicationContextInitializer
@@ -33,23 +40,21 @@ public class InProcessApplicationContextInitializer
 
 	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");
+		String inProcessEnabled = applicationContext.getEnvironment().getProperty(PROPERTY_SOURCE_NAME);
 
 		if ("true".equalsIgnoreCase(inProcessEnabled) && isJarOnClasspath()) {
 			try {
 				String serverName = InProcessServerBuilder.generateName();
 
-				grpcServer = InProcessServerBuilder.forName(serverName).directExecutor().build().start();
+				Server grpcServer = InProcessServerBuilder.forName(serverName).directExecutor().build().start();
 
-				grpcChannel = InProcessChannelBuilder.forName(serverName).directExecutor().build();
+				ManagedChannel grpcChannel = InProcessChannelBuilder.forName(serverName).directExecutor().build();
 				applicationContext.getBeanFactory().registerSingleton(CHANNEL_NAME, grpcChannel);
 
+				applicationContext.addApplicationListener(new InProcessServerShutdownListener(grpcServer, grpcChannel));
+
 			}
 			catch (Exception e) {
 				throw new RuntimeException("Failed to initialize in-process gRPC server", e);
@@ -67,11 +72,4 @@ private boolean isJarOnClasspath() {
 		}
 	}
 
-	public static void shutdown() {
-		if (grpcChannel != null)
-			grpcChannel.shutdownNow();
-		if (grpcServer != null)
-			grpcServer.shutdownNow();
-	}
-
 }

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

@@ -0,0 +1,55 @@
+/*
+ * 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 org.springframework.context.ApplicationListener;
+import org.springframework.context.event.ContextClosedEvent;
+
+import io.grpc.ManagedChannel;
+import io.grpc.Server;
+
+/**
+ * Listener that automatically shuts down the in-process gRPC {@link Server} and
+ * {@link ManagedChannel} when the Spring
+ * {@link org.springframework.context.ApplicationContext} is closed. This helps to ensure
+ * proper resource cleanup after the application context is no longer active, avoiding the
+ * need for manual shutdown calls in tests or other classes.
+ *
+ * @author Andrei Lisa
+ */
+final class InProcessServerShutdownListener implements ApplicationListener<ContextClosedEvent> {
+
+	private final Server grpcServer;
+
+	private final ManagedChannel grpcChannel;
+
+	InProcessServerShutdownListener(Server grpcServer, ManagedChannel grpcChannel) {
+		this.grpcServer = grpcServer;
+		this.grpcChannel = grpcChannel;
+	}
+
+	@Override
+	public void onApplicationEvent(ContextClosedEvent event) {
+		if (grpcChannel != null) {
+			grpcChannel.shutdownNow();
+		}
+		if (grpcServer != null) {
+			grpcServer.shutdownNow();
+		}
+	}
+
+}

spring-grpc-test/src/main/resources/additional-spring-configuration-metadata.json

@@ -0,0 +1,9 @@
+{
+  "groups": [],
+  "properties": [
+    {
+      "name": "spring.grpc.inprocess",
+      "defaultValue": "true"
+    }
+  ]
+}