Add base shell test system

- NOTE: very much wip and unstable
- This commit is a first step to provide boot style
  @ShellTest annotation
- New modules spring-shell-test and spring-shell-test-autoconfigure
- Focus is to autoconfigure context without shell runners so that
  we can create "sessions" and hook to configures jline terminal
  with custom in/out streams.
- Skeleton fork from jediterm to provide basic terminal emulation
  to part of a control amd escape characters working.
- ShellTestClient is a concept user can use to interact with a shell
  in a same way user would use a "real" shell.
- Fixes #489

spring-shell-test-autoconfigure/src/test/java/org/springframework/shell/test/autoconfigure/ShellTestIntegrationTests.java

@@ -0,0 +1,134 @@
+/*
+ * Copyright 2022 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.test.autoconfigure;
+
+import java.util.List;
+import java.util.concurrent.TimeUnit;
+
+import org.assertj.core.api.Condition;
+import org.junit.jupiter.api.Test;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.shell.test.ShellAssertions;
+import org.springframework.shell.test.ShellTestClient;
+import org.springframework.shell.test.ShellTestClient.InteractiveShellSession;
+import org.springframework.shell.test.ShellTestClient.NonInteractiveShellSession;
+import org.springframework.shell.test.autoconfigure.app.ExampleShellApplication;
+import org.springframework.test.annotation.DirtiesContext;
+import org.springframework.test.annotation.DirtiesContext.ClassMode;
+import org.springframework.test.context.ContextConfiguration;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.awaitility.Awaitility.await;
+
+@ContextConfiguration(classes = ExampleShellApplication.class)
+@ShellTest
+@DirtiesContext(classMode = ClassMode.AFTER_EACH_TEST_METHOD)
+public class ShellTestIntegrationTests {
+
+	@Autowired
+	ShellTestClient client;
+
+	@Test
+	void testInteractive1() throws Exception {
+		InteractiveShellSession session = client.interactive().run();
+
+		await().atMost(2, TimeUnit.SECONDS).untilAsserted(() -> {
+			ShellAssertions.assertThat(session.screen()).containsText("shell");
+		});
+
+		session.write(session.writeSequence().text("help").carriageReturn().build());
+		await().atMost(2, TimeUnit.SECONDS).untilAsserted(() -> {
+			ShellAssertions.assertThat(session.screen()).containsText("AVAILABLE COMMANDS");
+		});
+
+		session.write(session.writeSequence().carriageReturn().build());
+		await().atMost(4, TimeUnit.SECONDS).untilAsserted(() -> {
+			List<String> lines = session.screen().lines();
+			Condition<String> prompt = new Condition<>(line -> line.contains("shell:"), "Shell has expected prompt");
+			assertThat(lines).areExactly(3, prompt);
+		});
+
+		session.write(session.writeSequence().ctrl('l').build());
+		await().atMost(4, TimeUnit.SECONDS).untilAsserted(() -> {
+			List<String> lines = session.screen().lines();
+			Condition<String> prompt = new Condition<>(line -> line.contains("shell:"), "Shell has expected prompt");
+			assertThat(lines).areExactly(1, prompt);
+		});
+
+		session.write(session.writeSequence().ctrl('c').build());
+		await().atMost(2, TimeUnit.SECONDS).untilAsserted(() -> {
+			assertThat(session.isComplete()).isTrue();
+		});
+	}
+
+	@Test
+	void testInteractive2() throws Exception {
+		InteractiveShellSession session = client.interactive().run();
+
+		await().atMost(2, TimeUnit.SECONDS).untilAsserted(() -> {
+			ShellAssertions.assertThat(session.screen()).containsText("shell:");
+		});
+
+		session.write(session.writeSequence().ctrl('c').build());
+		await().atMost(30, TimeUnit.SECONDS).untilAsserted(() -> {
+			assertThat(session.isComplete()).isTrue();
+		});
+	}
+
+	@Test
+	void testNonInteractive() throws Exception {
+		Condition<String> helpCondition = new Condition<>(line -> line.contains("AVAILABLE COMMANDS"),
+				"Help has expected output");
+
+		Condition<String> helpHelpCondition = new Condition<>(line -> line.contains("help - Display help about available commands"),
+				"Help help has expected output");
+
+		NonInteractiveShellSession session = client.nonInterative("help").run();
+
+		await().atMost(30, TimeUnit.SECONDS).untilAsserted(() -> {
+			List<String> lines = session.screen().lines();
+			assertThat(lines).areExactly(1, helpCondition);
+			assertThat(lines).areNot(helpHelpCondition);
+		});
+
+		session.write(session.writeSequence().clearScreen().build());
+		NonInteractiveShellSession session2 = client.nonInterative("help", "help").run();
+		await().atMost(30, TimeUnit.SECONDS).untilAsserted(() -> {
+			List<String> lines = session2.screen().lines();
+			assertThat(lines).areNot(helpCondition);
+			assertThat(lines).areExactly(1, helpHelpCondition);
+		});
+
+		session.write(session.writeSequence().ctrl('c').build());
+		await().atMost(2, TimeUnit.SECONDS).untilAsserted(() -> {
+			assertThat(session.isComplete()).isTrue();
+		});
+	}
+
+	@Test
+	void testNonInteractive2() throws Exception {
+		Condition<String> helloCondition = new Condition<>(line -> line.contains("hello"),
+				"Hello has expected output");
+
+		NonInteractiveShellSession session = client.nonInterative("hello").run();
+
+		await().atMost(30, TimeUnit.SECONDS).untilAsserted(() -> {
+			List<String> lines = session.screen().lines();
+			assertThat(lines).areExactly(1, helloCondition);
+		});
+	}
+}

spring-shell-test-autoconfigure/src/test/java/org/springframework/shell/test/autoconfigure/ShellTestPropertiesIntegrationTests.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2022 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.test.autoconfigure;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.core.env.Environment;
+import org.springframework.shell.test.autoconfigure.app.ExampleShellApplication;
+import org.springframework.test.context.ContextConfiguration;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for the {@link ShellTest#properties properties} attribute of
+ * {@link ShellTest @ShellTest}.
+ *
+ * @author Janne Valkealahti
+ */
+@ShellTest(properties = "spring.profiles.active=test")
+@ContextConfiguration(classes = ExampleShellApplication.class)
+public class ShellTestPropertiesIntegrationTests {
+
+	@Autowired
+	private Environment environment;
+
+	@Test
+	void environmentWithNewProfile() {
+		assertThat(this.environment.getActiveProfiles()).containsExactly("test");
+	}
+}

spring-shell-test-autoconfigure/src/test/java/org/springframework/shell/test/autoconfigure/app/ExampleShellApplication.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2022 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.test.autoconfigure.app;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.shell.test.autoconfigure.ShellTest;
+
+/**
+ * Example {@link SpringBootApplication @SpringBootApplication} for use with
+ * {@link ShellTest @ShellTest} tests.
+ *
+ * @author Janne Valkealahti
+ */
+@SpringBootApplication
+public class ExampleShellApplication {
+}

spring-shell-test-autoconfigure/src/test/java/org/springframework/shell/test/autoconfigure/app/HelloCommand.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2022 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.test.autoconfigure.app;
+
+import org.springframework.shell.standard.ShellComponent;
+import org.springframework.shell.standard.ShellMethod;
+
+@ShellComponent
+public class HelloCommand {
+
+	@ShellMethod
+	public String hello() {
+		return "hello";
+	}
+}

spring-shell-test-autoconfigure/src/test/resources/application.yml

@@ -0,0 +1,9 @@
+#logging:
+#  file:
+#    name: xxx.log
+#  level:
+#    root: debug
+#    org:
+#      jline: debug
+#      springframework:
+#        shell: trace