How to run a shell in an integration test in spring shell 4.x?

[georgmittendorfer]

I would like to run a basic integration test that starts the interactive or non-interactive shell to verify that the spring application is able to properly start up.

In spring shell 3.x I did:

@Test
void nonInteractiveShellStarts() {
  ShellTestClient.InteractiveShellSession session = client.interactive().run();
  await().atMost(Duration.ofSeconds(2)).untilAsserted(() -> ShellAssertions.assertThat(session.screen()).containsText("shell"));
  session.write(session.writeSequence().text("help").carriageReturn().build());
  await().atMost(Duration.ofSeconds(2)).untilAsserted(() -> ShellAssertions.assertThat(session.screen()).containsText("...")); // check that all commands are registered
}

In spring shell 4.x I tried:

@Test
void interactiveShellStarts(@Autowired ShellTestClient client) throws Exception {
	client.sendCommand("help"); // throws command not found
}

How could I do a basic smoke test to see if the spring shell starts properly and all my commands are registered and shown with the 'help' command?

[czpilar]

I've tried example from documentation https://docs.spring.io/spring-shell/reference/testing.html and it worked without any problem.

Here is working snipped with the help command:

@ShellTest
@ContextConfiguration(classes = ExampleShellApplication.class)
class ShellTestIntegrationTests {

	@Test
	void testCommandExecution(@Autowired ShellTestClient client) throws Exception {
		// when
		ShellScreen shellScreen = client.sendCommand("help");

		// then
		ShellAssertions.assertThat(shellScreen).containsText("AVAILABLE COMMANDS");
	}
}

[fmbenhassine]

@georgmittendorfer You did not share your entire test setup, so I am not sure what could be wrong. If you want to test your command in isolation, then you can unit test it as a regular class implementing the Command interface. However, if you want to test the command as part of a shell application (to verify its registration, etc), then it is expected that you define your command in a shell application class as mentioned in the docs here: https://docs.spring.io/spring-shell/reference/testing.html. Thank you for the follow up on this, @czpilar !

Now if you don't want to use Spring Shell test utilities and need to end-to-end test your shell application, you can use Spring Boot test utilities (or any other test library) to capture the output of your application and assert on it. Here is an example:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.shell.core.command.annotation.Command;

@SpringBootApplication
public class MyShellApplication {

	public static void main(String[] args) {
		SpringApplication.run(MyShellApplication.class, args);
	}

	@Command
	public void hi() {
		System.out.println("Hello world!");
	}

}

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.system.CapturedOutput;
import org.springframework.boot.test.system.OutputCaptureExtension;

import static org.assertj.core.api.Assertions.assertThat;

@SpringBootTest(
		webEnvironment = SpringBootTest.WebEnvironment.NONE,
		useMainMethod = SpringBootTest.UseMainMethod.ALWAYS,
		classes = { MyShellApplication.class },
		properties = { "spring.shell.interactive.enabled=false" },
		args = "hi")
@ExtendWith(OutputCaptureExtension.class)
public class ShellApplicationEndToEndTests {

	@Test
	void testCommandOutput(CapturedOutput output) {
		assertThat(output).contains("Hello world!");
	}

}

I will update the docs with such an example and plan it for the next patch release.

[georgmittendorfer]

Maybe I had some error in my setup. Sorry for the invalid issue. I will try to get my code working.