Components can't use interactive mode without tty

- Adding a concept of no-tty which in this commit simply
  tracks DumbTerminal as jline creates that if there nothing
  better.
- For components without tty don't go to interaction loop.
- For new sample show that we can at least manually handle
  required option with a flow while command option is not
  required.
- Fixes #444

Author: jvalkeal

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

@@ -210,6 +210,10 @@ public CommandParserExceptionsException(String message, List<CommandParserExcept
 			this.parserExceptions = parserExceptions;
 		}
 
+		public static CommandParserExceptionsException of(String message, List<CommandParserException> parserExceptions) {
+			return new CommandParserExceptionsException(message, parserExceptions);
+		}
+
 		public List<CommandParserException> getParserExceptions() {
 			return parserExceptions;
 		}

spring-shell-core/src/main/java/org/springframework/shell/component/ConfirmationInput.java

@@ -24,6 +24,8 @@
 import org.jline.keymap.KeyMap;
 import org.jline.terminal.Terminal;
 import org.jline.utils.AttributedString;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import org.springframework.shell.component.ConfirmationInput.ConfirmationInputContext;
 import org.springframework.shell.component.context.ComponentContext;
@@ -39,6 +41,7 @@
  */
 public class ConfirmationInput extends AbstractTextComponent<Boolean, ConfirmationInputContext> {
 
+	private final static Logger log = LoggerFactory.getLogger(ConfirmationInput.class);
 	private final boolean defaultValue;
 	private ConfirmationInputContext currentContext;
 
@@ -78,6 +81,10 @@ public ConfirmationInputContext getThisContext(ComponentContext<?> context) {
 	@Override
 	protected boolean read(BindingReader bindingReader, KeyMap<String> keyMap, ConfirmationInputContext context) {
 		String operation = bindingReader.readBinding(keyMap);
+		log.debug("Binding read result {}", operation);
+		if (operation == null) {
+			return true;
+		}
 		String input;
 		switch (operation) {
 			case OPERATION_CHAR:

spring-shell-core/src/main/java/org/springframework/shell/component/MultiItemSelector.java

@@ -70,7 +70,10 @@ public MultiItemSelectorContext<T, I> getThisContext(ComponentContext<?> context
 	@Override
 	protected MultiItemSelectorContext<T, I> runInternal(MultiItemSelectorContext<T, I> context) {
 		super.runInternal(context);
-		loop(context);
+		// if there's no tty don't try to loop as it would then cause user interaction
+		if (hasTty()) {
+			loop(context);
+		}
 		return context;
 	}
 

spring-shell-core/src/main/java/org/springframework/shell/component/PathInput.java

@@ -27,6 +27,8 @@
 import org.jline.keymap.KeyMap;
 import org.jline.terminal.Terminal;
 import org.jline.utils.AttributedString;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import org.springframework.shell.component.PathInput.PathInputContext;
 import org.springframework.shell.component.context.ComponentContext;
@@ -42,6 +44,7 @@
  */
 public class PathInput extends AbstractTextComponent<Path, PathInputContext> {
 
+	private final static Logger log = LoggerFactory.getLogger(PathInput.class);
 	private PathInputContext currentContext;
 	private Function<String, Path> pathProvider = (path) -> Paths.get(path);
 
@@ -75,6 +78,10 @@ public PathInputContext getThisContext(ComponentContext<?> context) {
 	@Override
 	protected boolean read(BindingReader bindingReader, KeyMap<String> keyMap, PathInputContext context) {
 		String operation = bindingReader.readBinding(keyMap);
+		log.debug("Binding read result {}", operation);
+		if (operation == null) {
+			return true;
+		}
 		String input;
 		switch (operation) {
 			case OPERATION_CHAR:

spring-shell-core/src/main/java/org/springframework/shell/component/SingleItemSelector.java

@@ -70,7 +70,10 @@ public SingleItemSelectorContext<T, I> getThisContext(ComponentContext<?> contex
 	@Override
 	protected SingleItemSelectorContext<T, I> runInternal(SingleItemSelectorContext<T, I> context) {
 		super.runInternal(context);
-		loop(context);
+		// if there's no tty don't try to loop as it would then cause user interaction
+		if (hasTty()) {
+			loop(context);
+		}
 		return context;
 	}
 

spring-shell-core/src/main/java/org/springframework/shell/component/StringInput.java

@@ -24,6 +24,8 @@
 import org.jline.keymap.KeyMap;
 import org.jline.terminal.Terminal;
 import org.jline.utils.AttributedString;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import org.springframework.shell.component.StringInput.StringInputContext;
 import org.springframework.shell.component.context.ComponentContext;
@@ -38,6 +40,7 @@
  */
 public class StringInput extends AbstractTextComponent<String, StringInputContext> {
 
+	private final static Logger log = LoggerFactory.getLogger(StringInput.class);
 	private final String defaultValue;
 	private StringInputContext currentContext;
 	private Character maskCharacter;
@@ -83,6 +86,10 @@ public StringInputContext getThisContext(ComponentContext<?> context) {
 	@Override
 	protected boolean read(BindingReader bindingReader, KeyMap<String> keyMap, StringInputContext context) {
 		String operation = bindingReader.readBinding(keyMap);
+		log.debug("Binding read result {}", operation);
+		if (operation == null) {
+			return true;
+		}
 		String input;
 		switch (operation) {
 			case OPERATION_CHAR:

spring-shell-core/src/main/java/org/springframework/shell/component/context/ComponentContext.java

@@ -56,6 +56,14 @@ static <C extends ComponentContext<C>> ComponentContext<C> empty() {
 	 */
 	<T> T get(Object key, Class<T> type);
 
+	/**
+	 * Check if a context contains a key.
+	 *
+	 * @param key the key
+	 * @return true if context contains key
+	 */
+	boolean containsKey(Object key);
+
 	/**
 	 * Put an entry into a context.
 	 *

spring-shell-core/src/main/java/org/springframework/shell/component/support/AbstractComponent.java

@@ -33,6 +33,7 @@
 import org.jline.terminal.Attributes;
 import org.jline.terminal.Size;
 import org.jline.terminal.Terminal;
+import org.jline.terminal.impl.DumbTerminal;
 import org.jline.utils.AttributedString;
 import org.jline.utils.Display;
 import org.jline.utils.InfoCmp.Capability;
@@ -153,7 +154,8 @@ public final T run(ComponentContext<?> context) {
 		context = runPreRunHandlers(getThisContext(context));
 		T run = runInternal(getThisContext(context));
 		context = runPostRunHandlers(getThisContext(context));
-		if (printResults) {
+		// if there's no tty don't try to print results as it'd be pointless
+		if (printResults && hasTty()) {
 			printResults(context);
 		}
 		return run;
@@ -186,6 +188,22 @@ public void setTemplateLocation(String templateLocation) {
 		this.templateLocation = templateLocation;
 	}
 
+	/**
+	 * Checks if this component has an existing {@code tty}.
+	 *
+	 * @return true if component has tty
+	 */
+	protected boolean hasTty() {
+		boolean hasTty = true;
+		if (this.terminal instanceof DumbTerminal) {
+			if (this.terminal.getSize().getRows() == 0) {
+				hasTty = false;
+			}
+		}
+		log.debug("Terminal is {} with size {}, marking hasTty as {}", this.terminal, this.terminal.getSize(), hasTty);
+		return hasTty;
+	}
+
 	/**
 	 * Render a given template with attributes.
 	 *

spring-shell-core/src/main/java/org/springframework/shell/component/support/AbstractSelectorComponent.java

@@ -26,6 +26,8 @@
 import org.jline.keymap.KeyMap;
 import org.jline.terminal.Terminal;
 import org.jline.utils.InfoCmp.Capability;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import org.springframework.shell.component.context.BaseComponentContext;
 import org.springframework.shell.component.context.ComponentContext;
@@ -46,6 +48,7 @@
 public abstract class AbstractSelectorComponent<T, C extends SelectorComponentContext<T, I, C>, I extends Nameable & Matchable & Enableable & Itemable<T>>
 		extends AbstractComponent<C> {
 
+	private final static Logger log = LoggerFactory.getLogger(AbstractSelectorComponent.class);
 	protected final String name;
 	private final List<I> items;
 	private Comparator<I> comparator = (o1, o2) -> 0;
@@ -155,6 +158,10 @@ protected boolean read(BindingReader bindingReader, KeyMap<String> keyMap, C con
 		ItemStateViewProjection buildItemStateView = buildItemStateView(start.get(), thisContext);
 		List<ItemState<I>> itemStateView = buildItemStateView.items;
 		String operation = bindingReader.readBinding(keyMap);
+		log.debug("Binding read result {}", operation);
+		if (operation == null) {
+			return true;
+		}
 		String input;
 		switch (operation) {
 			case OPERATION_SELECT:

spring-shell-core/src/main/java/org/springframework/shell/component/support/AbstractTextComponent.java

@@ -66,7 +66,10 @@ protected void bindKeyMap(KeyMap<String> keyMap) {
 
 	@Override
 	protected C runInternal(C context) {
-		loop(context);
+		// if there's no tty don't try to loop as it would then cause user interaction
+		if (hasTty()) {
+			loop(context);
+		}
 		return context;
 	}
 

spring-shell-core/src/test/java/org/springframework/shell/component/AbstractShellTests.java

@@ -25,6 +25,7 @@
 import java.util.concurrent.LinkedBlockingQueue;
 
 import org.jline.keymap.KeyMap;
+import org.jline.terminal.Size;
 import org.jline.terminal.Terminal;
 import org.jline.terminal.impl.DumbTerminal;
 import org.jline.utils.AttributedString;
@@ -79,6 +80,7 @@ public ThemeSettings getSettings() {
 
         pipedInputStream.connect(pipedOutputStream);
 		terminal = new DumbTerminal("terminal", "ansi", pipedInputStream, consoleOut, StandardCharsets.UTF_8);
+        terminal.setSize(new Size(1, 1));
 
         executorService.execute(() -> {
             try {

spring-shell-core/src/test/java/org/springframework/shell/component/ConfirmationInputTests.java

@@ -15,13 +15,17 @@
  */
 package org.springframework.shell.component;
 
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
 import java.io.IOException;
+import java.nio.charset.StandardCharsets;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.atomic.AtomicReference;
 
+import org.jline.terminal.impl.DumbTerminal;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -55,6 +59,33 @@ public void cleanupTests() throws IOException {
 		service = null;
 	}
 
+	@Test
+	void testNoTty() throws Exception {
+		ByteArrayInputStream in = new ByteArrayInputStream(new byte[0]);
+		ByteArrayOutputStream out = new ByteArrayOutputStream();
+		DumbTerminal dumbTerminal = new DumbTerminal("terminal", "ansi", in, out, StandardCharsets.UTF_8);
+
+		ComponentContext<?> empty = ComponentContext.empty();
+		ConfirmationInput component1 = new ConfirmationInput(dumbTerminal, "component1");
+		component1.setResourceLoader(new DefaultResourceLoader());
+		component1.setTemplateExecutor(getTemplateExecutor());
+
+		service.execute(() -> {
+			ConfirmationInputContext run1Context = component1.run(empty);
+			result1.set(run1Context);
+			latch1.countDown();
+		});
+
+		TestBuffer testBuffer = new TestBuffer().cr();
+		write(testBuffer.getBytes());
+
+		latch1.await(2, TimeUnit.SECONDS);
+		ConfirmationInputContext run1Context = result1.get();
+
+		assertThat(run1Context).isNotNull();
+		assertThat(run1Context.getResultValue()).isNull();
+	}
+
 	@Test
 	public void testResultUserInputEnterDefaultYes() throws InterruptedException, IOException {
 		ComponentContext<?> empty = ComponentContext.empty();

spring-shell-core/src/test/java/org/springframework/shell/component/MultiItemSelectorTests.java

@@ -15,6 +15,9 @@
  */
 package org.springframework.shell.component;
 
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.nio.charset.StandardCharsets;
 import java.time.Duration;
 import java.util.Arrays;
 import java.util.List;
@@ -25,6 +28,8 @@
 import java.util.concurrent.atomic.AtomicReference;
 import java.util.stream.Stream;
 
+import org.jline.terminal.Terminal;
+import org.jline.terminal.impl.DumbTerminal;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -75,6 +80,19 @@ public void cleanupMulti() {
 		service = null;
 	}
 
+	@Test
+	void testNoTty() throws Exception {
+		ByteArrayInputStream in = new ByteArrayInputStream(new byte[0]);
+		ByteArrayOutputStream out = new ByteArrayOutputStream();
+		DumbTerminal dumbTerminal = new DumbTerminal("terminal", "ansi", in, out, StandardCharsets.UTF_8);
+
+		scheduleSelect(dumbTerminal);
+		awaitLatch();
+
+		List<SelectorItem<SimplePojo>> selected = result.get();
+		assertThat(selected).isNull();
+	}
+
 	@Test
 	public void testItemsShown() {
 		scheduleSelect();
@@ -192,12 +210,21 @@ private void scheduleSelect() {
 				SELECTOR_ITEM_4));
 	}
 
+	private void scheduleSelect(Terminal terminal) {
+		scheduleSelect(Arrays.asList(SELECTOR_ITEM_1, SELECTOR_ITEM_2, SELECTOR_ITEM_3, SELECTOR_ITEM_4), null,
+				terminal);
+	}
+
 	private void scheduleSelect(List<SelectorItem<SimplePojo>> items) {
 		scheduleSelect(items, null);
 	}
 
 	private void scheduleSelect(List<SelectorItem<SimplePojo>> items, Integer maxItems) {
-		MultiItemSelector<SimplePojo, SelectorItem<SimplePojo>> selector = new MultiItemSelector<>(getTerminal(),
+		scheduleSelect(items, maxItems, getTerminal());
+	}
+
+	private void scheduleSelect(List<SelectorItem<SimplePojo>> items, Integer maxItems, Terminal terminal) {
+		MultiItemSelector<SimplePojo, SelectorItem<SimplePojo>> selector = new MultiItemSelector<>(terminal,
 				items, "testSimple", null);
 		selector.setResourceLoader(new DefaultResourceLoader());
 		selector.setTemplateExecutor(getTemplateExecutor());