Clean up TestCommand paraphenalia

This commit is contained in:
Dave Syer
2013-10-08 15:39:37 -04:00
parent 1ce13cc2c2
commit b5f0f97110
13 changed files with 283 additions and 301 deletions

View File

@@ -0,0 +1,68 @@
/*
* Copyright 2012-2013 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
*
* http://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.
*/
import org.junit.runner.JUnitCore
import org.junit.runner.Result
import org.springframework.boot.cli.command.tester.Failure
import org.springframework.boot.cli.command.tester.TestResults
import java.lang.annotation.Annotation
import java.lang.reflect.Method
/**
* Groovy script to run JUnit tests inside the {@link TestCommand}.
* Needs to be compiled along with the actual code to work properly.
*
* @author Greg Turnquist
*/
class JUnitTester extends AbstractTester {
@Override
protected Set<Class<?>> findTestableClasses(List<Class<?>> compiled) {
// Look for @Test methods
Set<Class<?>> testable = new LinkedHashSet<Class<?>>()
for (Class<?> clazz : compiled) {
for (Method method : clazz.getMethods()) {
for (Annotation annotation : method.getAnnotations()) {
if (annotation.toString().contains("Test")) {
testable.add(clazz)
}
}
}
}
return testable
}
@Override
protected TestResults test(Class<?>[] testable) {
Result results = JUnitCore.runClasses(testable)
TestResults testResults = new TestResults()
testResults.setFailureCount(results.getFailureCount())
testResults.setRunCount(results.getRunCount())
List<org.springframework.boot.cli.command.tester.Failure> failures =
new ArrayList<Failure>()
for (org.junit.runner.notification.Failure failure : results.getFailures()) {
failures.add(new Failure(failure.getDescription().toString(), failure.getTrace()))
}
testResults.setFailures(failures.toArray(new Failure[0]))
return testResults
}
}

View File

@@ -0,0 +1,62 @@
/*
* Copyright 2012-2013 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
*
* http://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.
*/
import org.junit.runner.Result
import org.springframework.boot.cli.command.tester.Failure
import org.springframework.boot.cli.command.tester.TestResults
import spock.lang.Specification
import spock.util.EmbeddedSpecRunner
/**
* Groovy script to run Spock tests inside the {@link TestCommand}.
* Needs to be compiled along with the actual code to work properly.
*
* @author Greg Turnquist
*/
class SpockTester extends AbstractTester {
@Override
protected Set<Class<?>> findTestableClasses(List<Class<?>> compiled) {
// Look for classes that implement spock.lang.Specification
Set<Class<?>> testable = new LinkedHashSet<Class<?>>()
for (Class<?> clazz : compiled) {
if (Specification.class.isAssignableFrom(clazz)) {
testable.add(clazz)
}
}
return testable
}
@Override
protected TestResults test(Class<?>[] testable) {
Result results = new EmbeddedSpecRunner().runClasses(Arrays.asList(testable))
TestResults testResults = new TestResults()
testResults.setFailureCount(results.getFailureCount())
testResults.setRunCount(results.getRunCount())
List<org.springframework.boot.cli.command.tester.Failure> failures =
new ArrayList<Failure>()
for (org.junit.runner.notification.Failure failure : results.getFailures()) {
failures.add(new Failure(failure.getDescription().toString(), failure.getTrace()))
}
testResults.setFailures(failures.toArray(new Failure[0]))
return testResults
}
}

View File

@@ -0,0 +1,41 @@
/*
* Copyright 2012-2013 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
*
* http://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.
*/
import org.springframework.boot.cli.command.tester.TestResults
/**
* Groovy script define abstract basis for automated testers for {@link TestCommand}.
* Needs to be compiled along with the actual code to work properly.
*
* @author Greg Turnquist
*/
public abstract class AbstractTester {
public TestResults findAndTest(List<Class<?>> compiled) throws FileNotFoundException {
Set<Class<?>> testable = findTestableClasses(compiled)
if (testable.size() == 0) {
return TestResults.none
}
return test(testable.toArray(new Class<?>[0]))
}
abstract protected Set<Class<?>> findTestableClasses(List<Class<?>> compiled)
abstract protected TestResults test(Class<?>[] testable)
}

View File

@@ -17,7 +17,20 @@
package org.springframework.boot.cli.command;
import groovy.lang.GroovyObject;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.PrintWriter;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.logging.Level;
import joptsimple.OptionSet;
import org.apache.ivy.util.FileUtil;
import org.springframework.boot.cli.Log;
import org.springframework.boot.cli.command.tester.Failure;
@@ -25,240 +38,233 @@ import org.springframework.boot.cli.command.tester.TestResults;
import org.springframework.boot.cli.compiler.GroovyCompiler;
import org.springframework.boot.cli.compiler.GroovyCompilerConfiguration;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintWriter;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Scanner;
import java.util.Set;
import java.util.logging.Level;
/**
* Invokes testing for autocompiled scripts
*
*
* @author Greg Turnquist
*/
public class TestCommand extends OptionParsingCommand {
private TestOptionHandler testOptionHandler;
private TestOptionHandler testOptionHandler;
public TestCommand() {
super("test", "Test a groovy script", new TestOptionHandler());
this.testOptionHandler = (TestOptionHandler)this.getHandler();
}
public TestCommand() {
super("test", "Test a groovy script", new TestOptionHandler());
this.testOptionHandler = (TestOptionHandler) this.getHandler();
}
@Override
public String getUsageHelp() {
return "[options] <files>";
}
@Override
public String getUsageHelp() {
return "[options] <files>";
}
public TestResults getResults() {
return testOptionHandler.results;
}
public TestResults getResults() {
return this.testOptionHandler.results;
}
private static class TestGroovyCompilerConfiguration implements GroovyCompilerConfiguration {
@Override
public boolean isGuessImports() {
return true;
}
private static class TestGroovyCompilerConfiguration implements
GroovyCompilerConfiguration {
@Override
public boolean isGuessImports() {
return true;
}
@Override
public boolean isGuessDependencies() {
return true;
}
@Override
public boolean isGuessDependencies() {
return true;
}
@Override
public String getClasspath() {
return "";
}
@Override
public String getClasspath() {
return "";
}
public Level getLogLevel() {
return Level.INFO;
}
}
public Level getLogLevel() {
return Level.INFO;
}
}
private static class TestOptionHandler extends OptionHandler {
private static class TestOptionHandler extends OptionHandler {
private final GroovyCompiler compiler;
private final GroovyCompiler compiler;
private TestResults results;
private TestResults results;
public TestOptionHandler() {
TestGroovyCompilerConfiguration configuration = new TestGroovyCompilerConfiguration();
this.compiler = new GroovyCompiler(configuration);
if (configuration.getLogLevel().intValue() <= Level.FINE.intValue()) {
System.setProperty("groovy.grape.report.downloads", "true");
}
}
public TestOptionHandler() {
TestGroovyCompilerConfiguration configuration = new TestGroovyCompilerConfiguration();
this.compiler = new GroovyCompiler(configuration);
if (configuration.getLogLevel().intValue() <= Level.FINE.intValue()) {
System.setProperty("groovy.grape.report.downloads", "true");
}
}
@Override
protected void run(OptionSet options) throws Exception {
List<?> nonOptionArguments = options.nonOptionArguments();
@Override
protected void run(OptionSet options) throws Exception {
List<?> nonOptionArguments = options.nonOptionArguments();
Set<File> testerFiles = new HashSet<File>();
File[] files = getFileArguments(nonOptionArguments, testerFiles);
Set<File> testerFiles = new HashSet<File>();
File[] files = getFileArguments(nonOptionArguments, testerFiles);
/*
* Need to compile the code twice: The first time automatically
* pulls in autoconfigured libraries including test tools. Then
* the compiled code can be scanned to see what libraries were
* activated. Then it can be recompiled, with appropriate tester
* groovy scripts included in the same classloading context. Then
* the testers can be fetched and invoked through reflection against
* the composite AST.
*/
// Compile - Pass 1
Object[] sources = this.compiler.sources(files);
/*
* Need to compile the code twice: The first time automatically pulls in
* autoconfigured libraries including test tools. Then the compiled code can
* be scanned to see what libraries were activated. Then it can be recompiled,
* with appropriate tester groovy scripts included in the same classloading
* context. Then the testers can be fetched and invoked through reflection
* against the composite AST.
*/
// Compile - Pass 1
Object[] sources = this.compiler.sources(files);
boolean testing = false;
try {
check("org.junit.Test", sources);
testerFiles.add(locateSourceFromUrl("junit", "testers/junit.groovy"));
testing = true;
} catch (ClassNotFoundException e) {
}
boolean testing = false;
try {
check("org.junit.Test", sources);
testerFiles.add(locateSourceFromUrl("junit", "testers/junit.groovy"));
testing = true;
}
catch (ClassNotFoundException e) {
}
try {
check("spock.lang.Specification", sources);
testerFiles.add(locateSourceFromUrl("spock", "testers/spock.groovy"));
testing = true;
} catch (ClassNotFoundException e) {
}
try {
check("spock.lang.Specification", sources);
testerFiles.add(locateSourceFromUrl("spock", "testers/spock.groovy"));
testing = true;
}
catch (ClassNotFoundException e) {
}
if (testing) {
testerFiles.add(locateSourceFromUrl("tester", "testers/tester.groovy"));
}
if (testing) {
testerFiles.add(locateSourceFromUrl("tester", "testers/tester.groovy"));
}
// Compile - Pass 2 - with appropriate testers added in
files = getFileArguments(nonOptionArguments, testerFiles);
sources = this.compiler.sources(files);
// Compile - Pass 2 - with appropriate testers added in
files = getFileArguments(nonOptionArguments, testerFiles);
sources = this.compiler.sources(files);
if (sources.length == 0) {
throw new RuntimeException("No classes found in '" + files + "'");
}
if (sources.length == 0) {
throw new RuntimeException("No classes found in '" + files + "'");
}
List<Class<?>> testers = new ArrayList<Class<?>>();
List<Class<?>> testers = new ArrayList<Class<?>>();
// Extract list of compiled classes
List<Class<?>> compiled = new ArrayList<Class<?>>();
for (Object source : sources) {
if (source.getClass() == Class.class) {
Class<?> sourceClass = (Class<?>) source;
if (sourceClass.getSuperclass().getName().equals("AbstractTester")) {
testers.add(sourceClass);
}
else {
compiled.add((Class<?>) source);
}
}
}
// Extract list of compiled classes
List<Class<?>> compiled = new ArrayList<Class<?>>();
for (Object source : sources) {
if (source.getClass() == Class.class) {
Class<?> sourceClass = (Class<?>)source;
if (sourceClass.getSuperclass().getName().equals("AbstractTester")) {
testers.add(sourceClass);
} else {
compiled.add((Class<?>)source);
}
}
}
this.results = new TestResults();
this.results = new TestResults();
for (Class<?> tester : testers) {
GroovyObject obj = (GroovyObject) tester.newInstance();
this.results.add((TestResults) obj.invokeMethod("findAndTest", compiled));
}
for (Class<?> tester : testers) {
GroovyObject obj = (GroovyObject)tester.newInstance();
this.results.add((TestResults)obj.invokeMethod("findAndTest", compiled));
}
printReport(this.results);
}
printReport(this.results);
}
private File locateSourceFromUrl(String name, String path) {
try {
File file = File.createTempFile(name, ".groovy");
file.deleteOnExit();
FileUtil.copy(getClass().getClassLoader().getResourceAsStream(path),
file, null);
return file;
}
catch (IOException ex) {
throw new IllegalStateException("Could not create temp file for source: "
+ name);
}
}
private File locateSourceFromUrl(String name, String path) {
try {
File file = File.createTempFile(name, ".groovy");
file.deleteOnExit();
FileUtil.copy(getClass().getClassLoader().getResourceAsStream(path), file, null);
return file;
}
catch (IOException ex) {
throw new IllegalStateException("Could not create temp file for source: "
+ name);
}
}
private Class<?> check(String className, Object[] sources)
throws ClassNotFoundException {
Class<?> classToReturn = null;
ClassNotFoundException classNotFoundException = null;
for (Object source : sources) {
try {
classToReturn = ((Class<?>) source).getClassLoader().loadClass(
className);
}
catch (ClassNotFoundException e) {
classNotFoundException = e;
}
}
if (classToReturn != null) {
return classToReturn;
}
throw classNotFoundException;
}
private Class<?> check(String className, Object[] sources) throws ClassNotFoundException {
Class<?> classToReturn = null;
ClassNotFoundException classNotFoundException = null;
for (Object source : sources) {
try {
classToReturn = ((Class<?>)source).getClassLoader().loadClass(className);
} catch (ClassNotFoundException e) {
classNotFoundException = e;
}
}
if (classToReturn != null) {
return classToReturn;
}
throw classNotFoundException;
}
private File[] getFileArguments(List<?> nonOptionArguments, Set<File> testerFiles) {
List<File> files = new ArrayList<File>();
for (Object option : nonOptionArguments) {
if (option instanceof String) {
String filename = (String) option;
if ("--".equals(filename)) {
break;
}
if (filename.endsWith(".groovy") || filename.endsWith(".java")) {
File file = new File(filename);
if (file.isFile() && file.canRead()) {
files.add(file);
}
else {
URL url = getClass().getClassLoader().getResource(filename);
if (url != null) {
if (url.toString().startsWith("file:")) {
files.add(new File(url.toString().substring(
"file:".length())));
}
}
else {
throw new RuntimeException("Can't find " + filename);
}
}
}
}
}
if (files.size() == 0) {
throw new RuntimeException("Please specify a file to run");
}
for (File testerFile : testerFiles) {
files.add(testerFile);
}
private File[] getFileArguments(List<?> nonOptionArguments, Set<File> testerFiles) {
List<File> files = new ArrayList<File>();
for (Object option : nonOptionArguments) {
if (option instanceof String) {
String filename = (String) option;
if ("--".equals(filename)) {
break;
}
if (filename.endsWith(".groovy") || filename.endsWith(".java")) {
File file = new File(filename);
if (file.isFile() && file.canRead()) {
files.add(file);
}
else {
URL url = getClass().getClassLoader().getResource(filename);
if (url != null) {
if (url.toString().startsWith("file:")) {
files.add(new File(url.toString().substring("file:".length())));
}
}
else {
throw new RuntimeException("Can't find " + filename);
}
}
}
}
}
if (files.size() == 0) {
throw new RuntimeException("Please specify a file to run");
}
return files.toArray(new File[files.size()]);
}
for (File testerFile : testerFiles) {
files.add(testerFile);
}
private void printReport(TestResults results) throws FileNotFoundException {
PrintWriter writer = new PrintWriter("results.txt");
return files.toArray(new File[files.size()]);
}
String header = "Total: " + results.getRunCount() + ", Success: "
+ (results.getRunCount() - results.getFailureCount())
+ ", : Failures: " + results.getFailureCount() + "\n" + "Passed? "
+ results.wasSuccessful();
private void printReport(TestResults results) throws FileNotFoundException {
PrintWriter writer = new PrintWriter("results.txt");
String trailer = "";
String trace = "";
for (Failure failure : results.getFailures()) {
trailer += failure.getDescription().toString();
trace += failure.getTrace() + "\n";
}
String header = "Total: " + results.getRunCount() +
", Success: " + (results.getRunCount()-results.getFailureCount()) +
", : Failures: " + results.getFailureCount() + "\n" +
"Passed? " + results.wasSuccessful();
writer.println(header);
writer.println(trace);
writer.close();
String trailer = "";
String trace = "";
for (Failure failure : results.getFailures()) {
trailer += failure.getDescription().toString();
trace += failure.getTrace() + "\n";
}
Log.info(header);
Log.info(trailer);
}
writer.println(header);
writer.println(trace);
writer.close();
Log.info(header);
Log.info(trailer);
}
}
}
}

View File

@@ -1,14 +0,0 @@
groovy.version: ${groovy.version}
hamcrest.version: ${hamcrest.version}
jetty.version: ${jetty.version}
junit.version: ${junit.version}
reactor.version: ${reactor.version}
spock.version: ${spock.version}
spring.version: ${spring.version}
spring-batch.version: ${spring-batch.version}
spring-boot.version: ${project.version}
spring-rabbit.version: ${spring-rabbit.version}
spring-security.version: ${spring-security.version}
spring-integration.version: ${spring-integration.version}
spring-integration-groovydsl.version: ${spring-integration-groovydsl.version}
tomcat.version: ${tomcat.version}

View File

@@ -29,97 +29,98 @@ import static org.junit.Assert.assertTrue;
/**
* Integration tests to exercise the CLI's test command.
*
*
* @author Greg Turnquist
*/
public class TestCommandIntegrationTests {
@BeforeClass
public static void cleanGrapes() throws Exception {
GrapesCleaner.cleanIfNecessary();
// System.setProperty("ivy.message.logger.level", "3");
}
@BeforeClass
public static void cleanGrapes() throws Exception {
GrapesCleaner.cleanIfNecessary();
// System.setProperty("ivy.message.logger.level", "3");
}
@Before
public void setup() throws Exception {
System.setProperty("disableSpringSnapshotRepos", "true");
new CleanCommand().run("org.springframework");
}
@Before
public void setup() throws Exception {
System.setProperty("disableSpringSnapshotRepos", "true");
new CleanCommand().run("org.springframework");
}
@After
public void teardown() {
System.clearProperty("disableSpringSnapshotRepos");
}
@After
public void teardown() {
System.clearProperty("disableSpringSnapshotRepos");
}
@Test
public void noTests() throws Throwable {
TestCommand command = new TestCommand();
command.run("testscripts/book.groovy");
TestResults results = command.getResults();
assertEquals(0, results.getRunCount());
assertEquals(0, results.getFailureCount());
assertTrue(results.wasSuccessful());
}
@Test
public void noTests() throws Throwable {
TestCommand command = new TestCommand();
command.run("samples/book.groovy");
TestResults results = command.getResults();
assertEquals(0, results.getRunCount());
assertEquals(0, results.getFailureCount());
assertTrue(results.wasSuccessful());
}
@Test
public void empty() throws Exception {
TestCommand command = new TestCommand();
command.run("testscripts/empty.groovy");
TestResults results = command.getResults();
assertEquals(0, results.getRunCount());
assertEquals(0, results.getFailureCount());
assertTrue(results.wasSuccessful());
}
@Test
public void empty() throws Exception {
TestCommand command = new TestCommand();
command.run("samples/empty.groovy");
TestResults results = command.getResults();
assertEquals(0, results.getRunCount());
assertEquals(0, results.getFailureCount());
assertTrue(results.wasSuccessful());
}
@Test(expected = RuntimeException.class)
public void noFile() throws Exception {
try {
TestCommand command = new TestCommand();
command.run("testscripts/nothing.groovy");
} catch (RuntimeException e) {
assertEquals("Can't find testscripts/nothing.groovy", e.getMessage());
throw e;
}
}
@Test(expected = RuntimeException.class)
public void noFile() throws Exception {
try {
TestCommand command = new TestCommand();
command.run("samples/nothing.groovy");
}
catch (RuntimeException e) {
assertEquals("Can't find samples/nothing.groovy", e.getMessage());
throw e;
}
}
@Test
public void appAndTestsInOneFile() throws Exception {
TestCommand command = new TestCommand();
command.run("testscripts/book_and_tests.groovy");
TestResults results = command.getResults();
assertEquals(1, results.getRunCount());
assertEquals(0, results.getFailureCount());
assertTrue(results.wasSuccessful());
}
@Test
public void appAndTestsInOneFile() throws Exception {
TestCommand command = new TestCommand();
command.run("samples/book_and_tests.groovy");
TestResults results = command.getResults();
assertEquals(1, results.getRunCount());
assertEquals(0, results.getFailureCount());
assertTrue(results.wasSuccessful());
}
@Test
public void appInOneFileTestsInAnotherFile() throws Exception {
TestCommand command = new TestCommand();
command.run("testscripts/book.groovy", "testscripts/test.groovy");
TestResults results = command.getResults();
assertEquals(1, results.getRunCount());
assertEquals(0, results.getFailureCount());
assertTrue(results.wasSuccessful());
}
@Test
public void appInOneFileTestsInAnotherFile() throws Exception {
TestCommand command = new TestCommand();
command.run("samples/book.groovy", "samples/test.groovy");
TestResults results = command.getResults();
assertEquals(1, results.getRunCount());
assertEquals(0, results.getFailureCount());
assertTrue(results.wasSuccessful());
}
@Test
public void spockTester() throws Exception {
TestCommand command = new TestCommand();
command.run("testscripts/spock.groovy");
TestResults results = command.getResults();
assertEquals(1, results.getRunCount());
assertEquals(0, results.getFailureCount());
assertTrue(results.wasSuccessful());
}
@Test
public void spockTester() throws Exception {
TestCommand command = new TestCommand();
command.run("samples/spock.groovy");
TestResults results = command.getResults();
assertEquals(1, results.getRunCount());
assertEquals(0, results.getFailureCount());
assertTrue(results.wasSuccessful());
}
@Test
public void spockAndJunitTester() throws Exception {
TestCommand command = new TestCommand();
command.run("testscripts/spock.groovy", "testscripts/book_and_tests.groovy");
TestResults results = command.getResults();
assertEquals(2, results.getRunCount());
assertEquals(0, results.getFailureCount());
assertTrue(results.wasSuccessful());
}
@Test
public void spockAndJunitTester() throws Exception {
TestCommand command = new TestCommand();
command.run("samples/spock.groovy", "samples/book_and_tests.groovy");
TestResults results = command.getResults();
assertEquals(2, results.getRunCount());
assertEquals(0, results.getFailureCount());
assertTrue(results.wasSuccessful());
}
}

View File

@@ -1,11 +1,10 @@
package org.test.command
import joptsimple.OptionSet
@Grab("org.eclipse.jgit:org.eclipse.jgit:2.3.1.201302201838-r")
import org.eclipse.jgit.api.Git
@Grab("org.eclipse.jgit:org.eclipse.jgit:2.3.1.201302201838-r") @Grab("org.eclipse.jgit:org.eclipse.jgit:2.3.1.201302201838-r") @Grab("org.eclipse.jgit:org.eclipse.jgit:2.3.1.201302201838-r") @Grab("org.eclipse.jgit:org.eclipse.jgit:2.3.1.201302201838-r") @Grab("org.eclipse.jgit:org.eclipse.jgit:2.3.1.201302201838-r")
import java.lang.Object
class TestCommand extends OptionHandler {
void options() {