Update ShellRunner#run to return void

Before this commit, `ShellRunner#run` was returning a boolean (and not
void as it was before). The javadoc mentions that the "return value
indicates if run operation happened and no further runners should be
used", but it is not the ShellRunner's responsibility to decide the flow
of execution (ie if another runner should run or not). Custom implementations
have no context to decide to return true or false.

Author: fmbenhassine

spring-shell-core/src/main/java/org/springframework/shell/core/ShellRunner.java

@@ -24,14 +24,10 @@
 public interface ShellRunner {
 
 	/**
-	 * Execute {@code ShellRunner} with given args. Return value indicates if run
-	 * operation happened and no further runners should be used.
+	 * Execute {@code ShellRunner} with given args.
 	 * @param args the raw arguments
-	 * @return true if run execution happened
 	 * @throws Exception possible error during run
 	 */
-	default boolean run(String[] args) throws Exception {
-		return false;
-	}
+	void run(String[] args) throws Exception;
 
 }

spring-shell-core/src/main/java/org/springframework/shell/core/jline/InteractiveShellRunner.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2022 the original author or authors.
+ * Copyright 2017-2025 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.
@@ -69,11 +69,10 @@ public InteractiveShellRunner(LineReader lineReader, PromptProvider promptProvid
 	}
 
 	@Override
-	public boolean run(String[] args) throws Exception {
+	public void run(String[] args) throws Exception {
 		shellContext.setInteractionMode(InteractionMode.INTERACTIVE);
 		InputProvider inputProvider = new JLineInputProvider(lineReader, promptProvider);
 		shell.run(inputProvider);
-		return true;
 	}
 
 	public static class JLineInputProvider implements InputProvider {

spring-shell-core/src/main/java/org/springframework/shell/core/jline/NonInteractiveShellRunner.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021-2024 the original author or authors.
+ * Copyright 2021-2025 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.
@@ -133,18 +133,17 @@ public void setLineParser(Parser lineParser) {
 	}
 
 	@Override
-	public boolean run(String[] args) throws Exception {
+	public void run(String[] args) throws Exception {
 		List<String> commands = commandsFromArgs.apply(args);
 		if (commands.isEmpty()) {
-			return false;
+			return;
 		}
 		List<ParsedLine> parsedLines = commands.stream()
 			.map(rawCommandLine -> lineParser.parse(rawCommandLine, rawCommandLine.length() + 1))
 			.collect(Collectors.toList());
 		MultiParsedLineInputProvider inputProvider = new MultiParsedLineInputProvider(parsedLines);
 		shellContext.setInteractionMode(InteractionMode.NONINTERACTIVE);
 		shell.run(inputProvider);
-		return true;
 	}
 
 	/**

spring-shell-core/src/main/java/org/springframework/shell/core/jline/ScriptShellRunner.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2018-2024 the original author or authors.
+ * Copyright 2018-2025 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.
@@ -64,13 +64,13 @@ public ScriptShellRunner(Parser parser, Shell shell) {
 	}
 
 	@Override
-	public boolean run(String[] args) throws Exception {
+	public void run(String[] args) throws Exception {
 		String[] sourceArgs = args;
 		if (ObjectUtils.isEmpty(sourceArgs)) {
-			return false;
+			return;
 		}
 		if (!(sourceArgs[0].startsWith("@") && sourceArgs[0].length() > 1)) {
-			return false;
+			return;
 		}
 
 		List<File> scriptsToRun = Arrays.asList(args)
@@ -85,8 +85,6 @@ public boolean run(String[] args) throws Exception {
 				shell.run(inputProvider);
 			}
 		}
-
-		return true;
 	}
 
 }

spring-shell-core/src/test/java/org/springframework/shell/core/jline/NonInteractiveShellRunnerTests.java

@@ -41,24 +41,26 @@ class NonInteractiveShellRunnerTests {
 
 	@Test
 	void testEmptyArgsDontRun() throws Exception {
-		NonInteractiveShellRunner runner = new NonInteractiveShellRunner(null, null);
-		assertThat(runner.run(new String[0])).isFalse();
+		NonInteractiveShellRunner runner = new NonInteractiveShellRunner(shell, null);
+		runner.run(new String[0]);
+		Mockito.verifyNoInteractions(shell);
 	}
 
 	@Test
 	void testNonEmptyArgsRun() throws Exception {
 		NonInteractiveShellRunner runner = new NonInteractiveShellRunner(shell, new DefaultShellContext());
 		ArgumentCaptor<InputProvider> valueCapture = ArgumentCaptor.forClass(InputProvider.class);
 		Mockito.doNothing().when(shell).run(valueCapture.capture());
-		assertThat(runner.run(ofArgs("hi"))).isTrue();
+		runner.run(ofArgs("hi"));
+		Mockito.verify(shell).run(Mockito.any(InputProvider.class));
 	}
 
 	@Test
 	void shouldQuoteWithWhitespace() throws Exception {
 		NonInteractiveShellRunner runner = new NonInteractiveShellRunner(shell, new DefaultShellContext());
 		ArgumentCaptor<InputProvider> valueCapture = ArgumentCaptor.forClass(InputProvider.class);
 		Mockito.doNothing().when(shell).run(valueCapture.capture());
-		assertThat(runner.run(ofArgs("foo bar"))).isTrue();
+		runner.run(ofArgs("foo bar"));
 		InputProvider value = valueCapture.getValue();
 		assertThat(value.readInput().rawText()).isEqualTo("\"foo bar\"");
 	}
@@ -68,7 +70,7 @@ void shouldNotQuoteIfQuoted() throws Exception {
 		NonInteractiveShellRunner runner = new NonInteractiveShellRunner(shell, new DefaultShellContext());
 		ArgumentCaptor<InputProvider> valueCapture = ArgumentCaptor.forClass(InputProvider.class);
 		Mockito.doNothing().when(shell).run(valueCapture.capture());
-		assertThat(runner.run(ofArgs("'foo bar'"))).isTrue();
+		runner.run(ofArgs("'foo bar'"));
 		InputProvider value = valueCapture.getValue();
 		assertThat(value.readInput().rawText()).isEqualTo("'foo bar'");
 	}
@@ -78,7 +80,7 @@ void shouldNotQuoteWithoutWhitespace() throws Exception {
 		NonInteractiveShellRunner runner = new NonInteractiveShellRunner(shell, new DefaultShellContext());
 		ArgumentCaptor<InputProvider> valueCapture = ArgumentCaptor.forClass(InputProvider.class);
 		Mockito.doNothing().when(shell).run(valueCapture.capture());
-		assertThat(runner.run(ofArgs("foobar"))).isTrue();
+		runner.run(ofArgs("foobar"));
 		InputProvider value = valueCapture.getValue();
 		assertThat(value.readInput().rawText()).isEqualTo("foobar");
 	}

spring-shell-core/src/test/java/org/springframework/shell/core/jline/ScriptShellRunnerTests.java

@@ -22,36 +22,37 @@
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.junit.jupiter.api.io.TempDir;
 import org.mockito.Mock;
+import org.mockito.Mockito;
 import org.mockito.junit.jupiter.MockitoExtension;
 
 import org.springframework.boot.ApplicationArguments;
 import org.springframework.boot.DefaultApplicationArguments;
 import org.springframework.shell.core.Shell;
-import org.springframework.shell.core.jline.ScriptShellRunner;
-
-import static org.assertj.core.api.Assertions.*;
 
 @ExtendWith(MockitoExtension.class)
 class ScriptShellRunnerTests {
 
 	@Mock
 	Shell shell;
 
-	private final ScriptShellRunner runner = new ScriptShellRunner(null, null);
+	private final ScriptShellRunner runner = new ScriptShellRunner(null, shell);
 
 	@Test
 	void shouldNotRunWhenNoArgs() throws Exception {
-		assertThat(runner.run(ofArgs())).isFalse();
+		runner.run(ofArgs());
+		Mockito.verifyNoInteractions(shell);
 	}
 
 	@Test
 	void shouldNotRunWhenInOptionValue() throws Exception {
-		assertThat(runner.run(ofArgs("--foo", "@"))).isFalse();
+		runner.run(ofArgs("--foo", "@"));
+		Mockito.verifyNoInteractions(shell);
 	}
 
 	@Test
 	void shouldNotRunWhenJustFirstArgWithoutFile() throws Exception {
-		assertThat(runner.run(ofArgs("@"))).isFalse();
+		runner.run(ofArgs("@"));
+		Mockito.verifyNoInteractions(shell);
 	}
 
 	@Test
@@ -60,7 +61,7 @@ void shouldRunWhenFirstArgHavingFile(@TempDir Path workingDir) throws Exception
 		Path file = Files.createFile(path);
 		String pathStr = file.toAbsolutePath().toString();
 		ScriptShellRunner shellRunner = new ScriptShellRunner(null, shell);
-		assertThat(shellRunner.run(new String[] { "@" + pathStr })).isTrue();
+		shellRunner.run(new String[] { "@" + pathStr });
 	}
 
 	private static ApplicationArguments ofApplicationArguments(String... args) {