Move scanCommands() method to CommandScanner class

Author: ritvik

src/main/java/org/springframework/cli/runtime/command/CommandScanner.java

@@ -19,6 +19,7 @@
 import java.io.File;
 import java.io.IOException;
 import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
@@ -30,6 +31,7 @@
 import org.slf4j.LoggerFactory;
 
 import org.springframework.cli.SpringCliException;
+import org.springframework.cli.util.IoUtils;
 
 /**
  * Scans a directory, by default .spring/commands in the current working directory, and
@@ -42,7 +44,7 @@
  */
 public class CommandScanner {
 
-	private final Logger logger = LoggerFactory.getLogger(CommandScanner.class);
+	private static final Logger logger = LoggerFactory.getLogger(CommandScanner.class);
 
 	private Path pathToScan;
 
@@ -122,4 +124,12 @@ private Command getCommandObject(File directory) {
 		return command;
 	}
 
+	public static CommandScanResults scanCommands() {
+		Path cwd = IoUtils.getWorkingDirectory().toAbsolutePath();
+		Path pathToUse = Paths.get(cwd.toString(), ".spring", "commands");
+		logger.debug("Looking for user-defined commands in directory " + pathToUse);
+		CommandScanner scanner = new CommandScanner(pathToUse);
+		return scanner.scan();
+	}
+
 }

src/main/java/org/springframework/cli/runtime/command/DynamicMethodCommandResolver.java

@@ -16,8 +16,6 @@
 
 package org.springframework.cli.runtime.command;
 
-import java.nio.file.Path;
-import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
@@ -31,7 +29,6 @@
 
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.cli.runtime.engine.model.ModelPopulator;
-import org.springframework.cli.util.IoUtils;
 import org.springframework.cli.util.TerminalMessage;
 import org.springframework.shell.command.CommandRegistration;
 import org.springframework.shell.command.CommandRegistration.BuilderSupplier;
@@ -71,19 +68,19 @@ public DynamicMethodCommandResolver(Collection<ModelPopulator> modelPopulators,
 
 	@Override
 	public List<CommandRegistration> resolve() {
-		CommandScanResults commandScanResults = scanCommands();
+		CommandScanResults commandScanResults = CommandScanner.scanCommands();
 		log.debug("Found commands " + commandScanResults);
 		return registerSpringCliCommands(commandScanResults, modelPopulators, builder);
 	}
 
-	protected CommandScanResults scanCommands() {
-		Path cwd = IoUtils.getWorkingDirectory().toAbsolutePath();
-		Path pathToUse = Paths.get(cwd.toString(), ".spring", "commands");
-		log.debug("Looking for user-defined commands in directory " + pathToUse);
-		CommandScanner scanner = new CommandScanner(pathToUse);
-		CommandScanResults commandScanResults = scanner.scan();
-		return commandScanResults;
-	}
+	// protected CommandScanResults scanCommands() {
+	// Path cwd = IoUtils.getWorkingDirectory().toAbsolutePath();
+	// Path pathToUse = Paths.get(cwd.toString(), ".spring", "commands");
+	// log.debug("Looking for user-defined commands in directory " + pathToUse);
+	// CommandScanner scanner = new CommandScanner(pathToUse);
+	// CommandScanResults commandScanResults = scanner.scan();
+	// return commandScanResults;
+	// }
 
 	private List<CommandRegistration> registerSpringCliCommands(CommandScanResults results,
 			Collection<ModelPopulator> modelPopulators, CommandRegistration.BuilderSupplier builderSupplier) {

src/test/java/org/springframework/cli/runtime/command/DynamicMethodCommandResolverTests.java

@@ -23,15 +23,19 @@
 import java.util.Map;
 
 import org.junit.jupiter.api.Test;
-import org.mockito.Mockito;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.MockedStatic;
+import org.mockito.junit.jupiter.MockitoExtension;
 
 import org.springframework.cli.runtime.engine.model.ModelPopulator;
 import org.springframework.cli.runtime.engine.model.SystemModelPopulator;
 import org.springframework.cli.util.TerminalMessage;
 import org.springframework.shell.command.CommandRegistration;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mockStatic;
 
+@ExtendWith(MockitoExtension.class)
 class DynamicMethodCommandResolverTests {
 
 	@Test
@@ -71,30 +75,32 @@ void testResolving() {
 		modelPopulators.add(systemModelPopulator);
 		DynamicMethodCommandResolver resolver = new DynamicMethodCommandResolver(modelPopulators,
 				() -> CommandRegistration.builder(), TerminalMessage.noop(), null);
-		// Move to mock scan so that we control results
-		DynamicMethodCommandResolver spy = Mockito.spy(resolver);
-		Mockito.when(spy.scanCommands()).thenReturn(commandScanResults);
-		List<CommandRegistration> resolved = spy.resolve();
-
-		assertThat(resolved).hasSize(2);
-		assertThat(resolved).satisfiesExactly(registration -> {
-			assertThat(registration.getCommand()).isEqualTo("k8s-simple new");
-			assertThat(registration.getDescription()).isEqualTo("subcommand description");
-			assertThat(registration.getOptions()).hasSize(2);
-			assertThat(registration.getOptions().get(0)).satisfies(option -> {
-				assertThat(option.getLongNames()).contains("with-gusto");
-				assertThat(option.getType().getType()).isEqualTo(Boolean.class);
-				assertThat(option.getDescription()).isEqualTo("what a nice simple option");
-				assertThat(option.getDefaultValue()).isEqualTo("true");
-				assertThat(option.isRequired()).isTrue();
-			});
-			assertThat(registration.getOptions().get(1)).satisfies(option -> {
-				assertThat(option.getLongNames()).contains("with-greeting");
-				assertThat(option.getType().getType()).isEqualTo(String.class);
+
+		try (MockedStatic<CommandScanner> mockedCommandScanner = mockStatic(CommandScanner.class)) {
+			mockedCommandScanner.when(CommandScanner::scanCommands).thenReturn(commandScanResults);
+
+			List<CommandRegistration> resolved = resolver.resolve();
+
+			assertThat(resolved).hasSize(2);
+			assertThat(resolved).satisfiesExactly(registration -> {
+				assertThat(registration.getCommand()).isEqualTo("k8s-simple new");
+				assertThat(registration.getDescription()).isEqualTo("subcommand description");
+				assertThat(registration.getOptions()).hasSize(2);
+				assertThat(registration.getOptions().get(0)).satisfies(option -> {
+					assertThat(option.getLongNames()).contains("with-gusto");
+					assertThat(option.getType().getType()).isEqualTo(Boolean.class);
+					assertThat(option.getDescription()).isEqualTo("what a nice simple option");
+					assertThat(option.getDefaultValue()).isEqualTo("true");
+					assertThat(option.isRequired()).isTrue();
+				});
+				assertThat(registration.getOptions().get(1)).satisfies(option -> {
+					assertThat(option.getLongNames()).contains("with-greeting");
+					assertThat(option.getType().getType()).isEqualTo(String.class);
+				});
+			}, registration -> {
+				assertThat(registration.getCommand()).isEqualTo("k8s-simple new-services");
 			});
-		}, registration -> {
-			assertThat(registration.getCommand()).isEqualTo("k8s-simple new-services");
-		});
+		}
 	}
 
 }