Commit f418a07b authored by Andy Wilkinson's avatar Andy Wilkinson

Add basic integration tests for the CLI

Add integration tests for the CLI that invoke it as a user would, i.e.
via the shell script in the package's bin directory.
parent 015d92b8
......@@ -46,6 +46,7 @@
</activation>
<modules>
<module>spring-boot-integration-tests</module>
<module>spring-boot-cli-integration-tests</module>
</modules>
</profile>
<profile>
......
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-parent</artifactId>
<version>0.5.0.BUILD-SNAPSHOT</version>
<relativePath>../spring-boot-parent</relativePath>
</parent>
<artifactId>spring-boot-cli-integration-tests</artifactId>
<properties>
<main.basedir>${basedir}/..</main.basedir>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<executions>
<execution>
<id>unpack</id>
<phase>generate-resources</phase>
<goals>
<goal>unpack</goal>
</goals>
<configuration>
<artifactItems>
<artifactItem>
<groupId>${project.groupId}</groupId>
<artifactId>spring-boot-cli</artifactId>
<version>${project.version}</version>
<classifier>bin</classifier>
<type>zip</type>
<overWrite>true</overWrite>
</artifactItem>
</artifactItems>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
\ No newline at end of file
package org.springframework.boot.cli.it;
import java.io.IOException;
import org.junit.Test;
import org.springframework.boot.cli.it.infrastructure.Cli;
import org.springframework.boot.cli.it.infrastructure.CliInvocation;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
/**
* @author Andy Wilkinson
*/
public class UsabilityTests {
private final Cli cli = new Cli();
@Test
public void hintProducesListOfValidCommands() throws IOException,
InterruptedException {
CliInvocation cli = this.cli.invoke("hint");
assertEquals(0, cli.await());
assertEquals(0, cli.getErrorOutput().length());
assertEquals(6, cli.getStandardOutputLines().size());
}
@Test
public void invokingWithNoArgumentsDisplaysHelp() throws IOException,
InterruptedException {
CliInvocation cli = this.cli.invoke();
assertEquals(1, cli.await()); // TODO Should this be 0? Probably not.
assertEquals(0, cli.getErrorOutput().length());
assertTrue(cli.getStandardOutput().startsWith("usage:"));
}
@Test
public void unrecognizedCommandsAreHandledGracefully() throws IOException,
InterruptedException {
CliInvocation cli = this.cli.invoke("not-a-real-command");
assertEquals(1, cli.await());
assertTrue(
cli.getErrorOutput(),
cli.getErrorOutput().contains(
"'not-a-real-command' is not a valid command"));
assertEquals(0, cli.getStandardOutput().length());
}
@Test
public void version() throws IOException, InterruptedException {
CliInvocation cli = this.cli.invoke("version");
assertEquals(0, cli.await());
assertEquals(0, cli.getErrorOutput().length());
assertTrue(cli.getStandardOutput(),
cli.getStandardOutput().startsWith("Spring CLI v"));
}
@Test
public void help() throws IOException, InterruptedException {
CliInvocation cli = this.cli.invoke("help");
assertEquals(1, cli.await()); // TODO Should this be 0? Perhaps.
assertEquals(0, cli.getErrorOutput().length());
assertTrue(cli.getStandardOutput().startsWith("usage:"));
}
}
package org.springframework.boot.cli.it.infrastructure;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
/**
* @author Andy Wilkinson
*/
public final class Cli {
public CliInvocation invoke(String... args) throws IOException {
return new CliInvocation(launchCli(args));
}
private Process launchCli(String... args) throws IOException {
List<String> arguments = Arrays.asList(args);
List<String> command = new ArrayList<String>();
command.add(findLaunchScript().getAbsolutePath());
command.addAll(arguments);
return new ProcessBuilder(command).start();
}
private File findLaunchScript() {
File dependencyDirectory = new File("target/dependency");
if (dependencyDirectory.isDirectory()) {
File[] files = dependencyDirectory.listFiles();
if (files.length == 1) {
File binDirectory = new File(files[0], "bin");
if (isWindows()) {
return new File(binDirectory, "spring.bat");
}
else {
return new File(binDirectory, "spring");
}
}
}
throw new IllegalStateException("Could not find CLI launch script");
}
private boolean isWindows() {
return File.separatorChar == '\\';
}
}
package org.springframework.boot.cli.it.infrastructure;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.StringReader;
import java.util.ArrayList;
import java.util.List;
/**
* @author Andy Wilkinson
*/
public final class CliInvocation {
private final StringBuffer errorOutput = new StringBuffer();
private final StringBuffer standardOutput = new StringBuffer();
private final Process process;
CliInvocation(Process process) {
this.process = process;
new Thread(new StreamReadingRunnable(this.process.getErrorStream(),
this.errorOutput)).start();
new Thread(new StreamReadingRunnable(this.process.getInputStream(),
this.standardOutput)).start();
}
public String getErrorOutput() {
return this.errorOutput.toString();
}
public String getStandardOutput() {
return this.standardOutput.toString();
}
public List<String> getStandardOutputLines() {
BufferedReader reader = new BufferedReader(new StringReader(
this.standardOutput.toString()));
String line;
List<String> lines = new ArrayList<String>();
try {
while ((line = reader.readLine()) != null) {
lines.add(line);
}
}
catch (IOException e) {
throw new RuntimeException("Failed to read standard output");
}
return lines;
}
public int await() throws InterruptedException {
return this.process.waitFor();
}
private final class StreamReadingRunnable implements Runnable {
private final InputStream stream;
private final StringBuffer output;
private final byte[] buffer = new byte[4096];
private StreamReadingRunnable(InputStream stream, StringBuffer buffer) {
this.stream = stream;
this.output = buffer;
}
public void run() {
int read;
try {
while ((read = this.stream.read(this.buffer)) > 0) {
this.output.append(new String(this.buffer, 0, read));
}
}
catch (IOException e) {
// Allow thread to die
}
}
}
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment