Fix detection of the implicit help option

spring-shell-core/src/main/java/org/springframework/shell/core/command/AbstractCommand.java

@@ -23,6 +23,7 @@
 import org.springframework.shell.core.command.completion.CompletionProvider;
 import org.springframework.shell.core.command.completion.DefaultCompletionProvider;
 import org.springframework.shell.core.command.exit.ExitStatusExceptionMapper;
+import org.springframework.util.StringUtils;
 
 import java.io.PrintWriter;
 import java.util.ArrayList;
@@ -35,6 +36,7 @@
  * @author Janne Valkealahti
  * @author Piotr Olaszewski
  * @author Mahmoud Ben Hassine
+ * @author David Pilar
  */
 public abstract class AbstractCommand implements Command {
 
@@ -167,7 +169,7 @@ public ExitStatus execute(CommandContext commandContext) throws Exception {
 			return ExitStatus.AVAILABILITY_ERROR;
 		}
 		List<CommandOption> options = commandContext.parsedInput().options();
-		if (options.size() == 1 && isHelp(options.get(0))) {
+		if (options.stream().anyMatch(this::isHelp)) {
 			println(getHelp(), commandContext);
 			return ExitStatus.OK;
 		}
@@ -209,7 +211,13 @@ protected void println(String message, CommandContext commandContext) {
 	}
 
 	protected boolean isHelp(CommandOption option) {
-		return option.longName().equalsIgnoreCase("help") || option.shortName() == 'h';
+		return !isDeclaredOption(option) && ("help".equals(option.longName()) || option.shortName() == 'h');
+	}
+
+	private boolean isDeclaredOption(CommandOption option) {
+		String optionName = StringUtils.hasLength(option.longName()) ? "--" + option.longName()
+				: "-" + option.shortName();
+		return getOptions().stream().anyMatch(o -> o.isOptionEqual(optionName));
 	}
 
 	public abstract ExitStatus doExecute(CommandContext commandContext) throws Exception;

spring-shell-core/src/test/java/org/springframework/shell/core/command/AbstractCommandHelpTests.java

@@ -0,0 +1,217 @@
+/*
+ * Copyright 2025-present 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.shell.core.command;
+
+import java.io.PrintWriter;
+import java.io.StringWriter;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.shell.core.InputReader;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.mockito.Mockito.mock;
+
+/**
+ * Tests for how {@link AbstractCommand} recognises a request for the implicit help
+ * option.
+ *
+ * @author David Pilar
+ */
+class AbstractCommandHelpTests {
+
+	private static final String HELP_TEXT = "The help of 'mycommand'";
+
+	@Test
+	void testHelpIsPrintedForImplicitLongOption() throws Exception {
+		// given
+		TestCommand command = new TestCommand();
+
+		// when
+		String output = execute(command, option(' ', "help", "true"));
+
+		// then
+		assertFalse(command.executed);
+		assertTrue(output.contains(HELP_TEXT));
+	}
+
+	@Test
+	void testHelpIsPrintedForImplicitShortOption() throws Exception {
+		// given
+		TestCommand command = new TestCommand();
+
+		// when
+		String output = execute(command, option('h', "", "true"));
+
+		// then
+		assertFalse(command.executed);
+		assertTrue(output.contains(HELP_TEXT));
+	}
+
+	@Test
+	void testHelpIsPrintedWhenGivenAlongsideOtherOptions() throws Exception {
+		// given
+		TestCommand command = new TestCommand();
+		command.getOptions().add(declaredOption(' ', "name", String.class));
+
+		// when
+		String output = execute(command, option(' ', "help", "true"), option(' ', "name", "x"));
+
+		// then
+		assertFalse(command.executed);
+		assertTrue(output.contains(HELP_TEXT));
+	}
+
+	@Test
+	void testDeclaredShortOptionIsNotTreatedAsHelp() throws Exception {
+		// given
+		TestCommand command = new TestCommand();
+		command.getOptions().add(declaredOption('h', "host", String.class));
+
+		// when
+		String output = execute(command, option('h', "", "myhost"));
+
+		// then
+		assertTrue(command.executed);
+		assertEquals("", output);
+	}
+
+	@Test
+	void testDeclaredShortOptionIsNotTreatedAsHelpAlongsideOtherOptions() throws Exception {
+		// given
+		TestCommand command = new TestCommand();
+		command.getOptions().add(declaredOption('h', "host", String.class));
+		command.getOptions().add(declaredOption(' ', "port", String.class));
+
+		// when
+		String output = execute(command, option('h', "", "myhost"), option(' ', "port", "22"));
+
+		// then
+		assertTrue(command.executed);
+		assertEquals("", output);
+	}
+
+	@Test
+	void testDeclaredLongOptionIsNotTreatedAsHelp() throws Exception {
+		// given
+		TestCommand command = new TestCommand();
+		command.getOptions().add(declaredOption(' ', "help", String.class));
+
+		// when
+		String output = execute(command, option(' ', "help", "topic"));
+
+		// then
+		assertTrue(command.executed);
+		assertEquals("", output);
+	}
+
+	@Test
+	void testImplicitLongOptionStillWorksWhenShortOptionIsDeclared() throws Exception {
+		// given
+		TestCommand command = new TestCommand();
+		command.getOptions().add(declaredOption('h', "host", String.class));
+
+		// when
+		String output = execute(command, option(' ', "help", "true"));
+
+		// then
+		assertFalse(command.executed);
+		assertTrue(output.contains(HELP_TEXT));
+	}
+
+	@Test
+	void testImplicitShortOptionStillWorksWhenLongOptionIsDeclared() throws Exception {
+		// given
+		TestCommand command = new TestCommand();
+		command.getOptions().add(declaredOption(' ', "help", String.class));
+
+		// when
+		String output = execute(command, option('h', "", "true"));
+
+		// then
+		assertFalse(command.executed);
+		assertTrue(output.contains(HELP_TEXT));
+	}
+
+	@Test
+	void testDifferentlyCasedLongOptionIsNotTreatedAsHelp() throws Exception {
+		// given
+		TestCommand command = new TestCommand();
+
+		// when
+		String output = execute(command, option(' ', "HELP", "true"));
+
+		// then
+		assertTrue(command.executed);
+		assertEquals("", output);
+	}
+
+	@Test
+	void testDeclaredHelpOptionIsNotHijackedByDifferentlyCasedInput() throws Exception {
+		// given
+		TestCommand command = new TestCommand();
+		command.getOptions().add(declaredOption(' ', "help", String.class));
+
+		// when
+		String output = execute(command, option(' ', "HELP", "topic"));
+
+		// then
+		assertTrue(command.executed);
+		assertEquals("", output);
+	}
+
+	private static String execute(Command command, CommandOption... options) throws Exception {
+		ParsedInput.Builder parsedInputBuilder = ParsedInput.builder().commandName(command.getName());
+		for (CommandOption option : options) {
+			parsedInputBuilder.addOption(option);
+		}
+		StringWriter outputWriter = new StringWriter();
+		CommandRegistry commandRegistry = new CommandRegistry();
+		commandRegistry.registerCommand(command);
+		CommandContext commandContext = new CommandContext(parsedInputBuilder.build(), commandRegistry,
+				new PrintWriter(outputWriter), mock(InputReader.class));
+		ExitStatus exitStatus = command.execute(commandContext);
+		assertEquals(ExitStatus.OK, exitStatus);
+		return outputWriter.toString().trim();
+	}
+
+	private static CommandOption option(char shortName, String longName, String value) {
+		return CommandOption.with().shortName(shortName).longName(longName).value(value).build();
+	}
+
+	private static CommandOption declaredOption(char shortName, String longName, Class<?> type) {
+		return CommandOption.with().shortName(shortName).longName(longName).type(type).build();
+	}
+
+	private static class TestCommand extends AbstractCommand {
+
+		private boolean executed;
+
+		TestCommand() {
+			super("mycommand", "My test command", "My test group", HELP_TEXT);
+		}
+
+		@Override
+		public ExitStatus doExecute(CommandContext commandContext) {
+			this.executed = true;
+			return ExitStatus.OK;
+		}
+
+	}
+
+}