Properly flush and close formatters. Closes #173

cucumber · Jan 25, 2012 · e50308a · e50308a
1 parent f7ee6f3
commit e50308a
Show file tree

Hide file tree

Showing 19 changed files with 116 additions and 37 deletions.
diff --git a/History.md b/History.md
@@ -1,5 +1,7 @@
 ## In Git
 
+* [Core] Properly flush and close formatters ([#173](https://github.com/cucumber/cucumber-jvm/pull/173) Aslak Hellesøy, David Kowis)
+* [Core] Use Gherkin's internal Gson (Aslak Hellesøy)
 * [JUnit] Better reporting of BEfore and After blocks (Aslak Hellesøy)
 * [Core] Bugfix: Scenario Outlines failing ([#170](https://github.com/cucumber/cucumber-jvm/issues/170) David Kowis, Aslak Hellesøy)
 * [OpenEJB] It's back (was excluded from previous releases because it depended on unreleased libs). (Aslak Hellesøy)

diff --git a/core/pom.xml b/core/pom.xml
@@ -25,10 +25,6 @@
             <groupId>com.googlecode.java-diff-utils</groupId>
             <artifactId>diffutils</artifactId>
         </dependency>
-        <dependency>
-            <groupId>com.google.code.gson</groupId>
-            <artifactId>gson</artifactId>
-        </dependency>
         <dependency>
             <groupId>info.cukes</groupId>
             <artifactId>cucumber-html</artifactId>

diff --git a/core/src/main/java/cucumber/cli/Main.java b/core/src/main/java/cucumber/cli/Main.java
@@ -34,7 +34,7 @@ public static void run(String[] argv, ClassLoader classLoader, RuntimeFactory ru
         String dotCucumber = null;
         boolean isDryRun = false;
 
-        FormatterFactory formatterFactory = new FormatterFactory();
+        FormatterFactory formatterFactory = new FormatterFactory(classLoader);
         MultiFormatter multiFormatter = new MultiFormatter(classLoader);
 
         while (!args.isEmpty()) {
@@ -87,8 +87,12 @@ public static void run(String[] argv, ClassLoader classLoader, RuntimeFactory ru
         if (dotCucumber != null) {
             writeDotCucumber(featurePaths, dotCucumber, runtime);
         }
-        run(featurePaths, filters, multiFormatter, runtime);
+        Formatter formatter = multiFormatter.formatterProxy();
+        Reporter reporter = multiFormatter.reporterProxy();
+        runtime.run(featurePaths, filters, formatter, reporter);
+        formatter.done();
         printSummary(runtime);
+        formatter.close();
         System.exit(runtime.exitStatus());
     }
 
@@ -98,13 +102,6 @@ private static void writeDotCucumber(List<String> featurePaths, String dotCucumb
         runtime.writeStepdefsJson(featurePaths, dotCucumber);
     }
 
-    private static void run(List<String> featurePaths, List<Object> filters, MultiFormatter multiFormatter, Runtime runtime) throws IOException {
-        Formatter formatter = multiFormatter.formatterProxy();
-        Reporter reporter = multiFormatter.reporterProxy();
-        runtime.run(featurePaths, filters, formatter, reporter);
-        formatter.done();
-    }
-
     private static void printSummary(Runtime runtime) {
         new SummaryPrinter(System.out).print(runtime);
     }

diff --git a/core/src/main/java/cucumber/formatter/FormatterFactory.java b/core/src/main/java/cucumber/formatter/FormatterFactory.java
@@ -3,6 +3,7 @@
 import cucumber.runtime.CucumberException;
 import gherkin.formatter.Formatter;
 import gherkin.formatter.JSONFormatter;
+import gherkin.formatter.JSONPrettyFormatter;
 import gherkin.formatter.PrettyFormatter;
 
 import java.io.File;
@@ -12,13 +13,20 @@
 
 public class FormatterFactory {
 
+    private final ClassLoader classLoader;
+
     private static final Map<String, String> BUILTIN_FORMATTERS = new HashMap<String, String>() {{
         put("progress", ProgressFormatter.class.getName());
         put("html", HTMLFormatter.class.getName());
         put("json", JSONFormatter.class.getName());
+        put("json-pretty", JSONPrettyFormatter.class.getName());
         put("pretty", PrettyFormatter.class.getName());
     }};
 
+    public FormatterFactory(ClassLoader classLoader) {
+        this.classLoader = classLoader;
+    }
+
     public Formatter createFormatter(String formatterName, Object out) {
         String className = BUILTIN_FORMATTERS.containsKey(formatterName) ? BUILTIN_FORMATTERS.get(formatterName) : formatterName;
         return createFormatterFromClassName(className, out);
@@ -53,7 +61,7 @@ private Formatter createFormatterFromClassName(String className, Object out) {
 
     private Class<Formatter> getFormatterClass(String className) {
         try {
-            return (Class<Formatter>) Class.forName(className);
+            return (Class<Formatter>) classLoader.loadClass(className);
         } catch (ClassNotFoundException e) {
             throw new CucumberException("Formatter class not found: " + className, e);
         }

diff --git a/core/src/main/java/cucumber/formatter/HTMLFormatter.java b/core/src/main/java/cucumber/formatter/HTMLFormatter.java
@@ -1,8 +1,8 @@
 package cucumber.formatter;
 
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
 import cucumber.runtime.CucumberException;
+import gherkin.deps.com.google.gson.Gson;
+import gherkin.deps.com.google.gson.GsonBuilder;
 import gherkin.formatter.Formatter;
 import gherkin.formatter.Mappable;
 import gherkin.formatter.NiceAppendable;
@@ -104,10 +104,14 @@ public void syntaxError(String state, String event, List<String> legalEvents, St
     @Override
     public void done() {
         jsOut().append("});");
-        jsOut().close();
         copyReportFiles();
     }
 
+    @Override
+    public void close() {
+        jsOut().close();
+    }
+
     private void writeToJsReport(String functionName, Mappable statement) {
         String json = gson.toJson(statement.toMap());
         writeToJsReport(functionName, json);

diff --git a/core/src/main/java/cucumber/formatter/MultiFormatter.java b/core/src/main/java/cucumber/formatter/MultiFormatter.java
@@ -9,6 +9,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Utility for creating a formatter that delegates to multiple underlying formatters.
+ */
 public class MultiFormatter {
     private final List<Formatter> formatters = new ArrayList<Formatter>();
     private final ClassLoader classLoader;
@@ -21,10 +24,6 @@ public void add(Formatter formatter) {
         formatters.add(formatter);
     }
 
-    public boolean isEmpty() {
-        return formatters.isEmpty();
-    }
-
     public Formatter formatterProxy() {
         return (Formatter) Proxy.newProxyInstance(classLoader, new Class<?>[]{Formatter.class}, new InvocationHandler() {
             @Override

diff --git a/core/src/main/java/cucumber/formatter/NullReporter.java b/core/src/main/java/cucumber/formatter/NullReporter.java
@@ -54,6 +54,10 @@ public void syntaxError(String state, String event, List<String> legalEvents, St
     public void done() {
     }
 
+    @Override
+    public void close() {
+    }
+
     @Override
     public void result(Result result) {
     }

diff --git a/core/src/main/java/cucumber/formatter/ProgressFormatter.java b/core/src/main/java/cucumber/formatter/ProgressFormatter.java
@@ -82,6 +82,11 @@ public void done() {
         out.println();
     }
 
+    @Override
+    public void close() {
+        out.close();
+    }
+
     @Override
     public void result(Result result) {
         if (!monochrome) {

diff --git a/core/src/main/java/cucumber/runtime/FeatureBuilder.java b/core/src/main/java/cucumber/runtime/FeatureBuilder.java
@@ -75,6 +75,10 @@ public void syntaxError(String state, String event, List<String> legalEvents, St
     public void done() {
     }
 
+    @Override
+    public void close() {
+    }
+
     public void parse(Resource resource, List<Object> filters) {
         Formatter formatter = this;
         if (!filters.isEmpty()) {

diff --git a/core/src/main/java/cucumber/runtime/RuntimeGlue.java b/core/src/main/java/cucumber/runtime/RuntimeGlue.java
@@ -1,12 +1,12 @@
 package cucumber.runtime;
 
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
 import cucumber.io.FileResourceLoader;
 import cucumber.runtime.autocomplete.MetaStepdef;
 import cucumber.runtime.autocomplete.StepdefGenerator;
 import cucumber.runtime.converters.LocalizedXStreams;
 import cucumber.runtime.model.CucumberFeature;
+import gherkin.deps.com.google.gson.Gson;
+import gherkin.deps.com.google.gson.GsonBuilder;
 import gherkin.formatter.Argument;
 import gherkin.formatter.model.Step;
 

diff --git a/core/src/test/java/cucumber/formatter/FormatterFactoryTest.java b/core/src/test/java/cucumber/formatter/FormatterFactoryTest.java
@@ -2,6 +2,7 @@
 
 import gherkin.formatter.Formatter;
 import gherkin.formatter.JSONFormatter;
+import gherkin.formatter.JSONPrettyFormatter;
 import gherkin.formatter.PrettyFormatter;
 import org.junit.Test;
 
@@ -14,13 +15,18 @@
 
 public class FormatterFactoryTest {
 
-    private final FormatterFactory formatterFactory = new FormatterFactory();
+    private final FormatterFactory formatterFactory = new FormatterFactory(Thread.currentThread().getContextClassLoader());
 
     @Test
     public void shouldInstantiateJsonFormatter() {
         assertThat(formatterFactory.createFormatter("json", System.out), is(JSONFormatter.class));
     }
 
+    @Test
+    public void shouldInstantiateJsonPrettyFormatter() {
+        assertThat(formatterFactory.createFormatter("json-pretty", System.out), is(JSONPrettyFormatter.class));
+    }
+
     @Test
     public void shouldInstantiatePrettyFormatter() {
         assertThat(formatterFactory.createFormatter("pretty", System.out), is(PrettyFormatter.class));

diff --git a/core/src/test/java/cucumber/formatter/HTMLFormatterTest.java b/core/src/test/java/cucumber/formatter/HTMLFormatterTest.java
@@ -32,6 +32,7 @@ public void writes_proper_html() throws IOException {
         Runtime runtime = new Runtime(resourceLoader, gluePaths, classLoader, asList(mock(Backend.class)), false);
         runtime.run(features.get(0), f, f);
         f.done();
+        f.close();
 
         // Let's verify that the JS we wrote parses nicely
 

diff --git a/core/src/test/java/cucumber/formatter/TestFormatter.java b/core/src/test/java/cucumber/formatter/TestFormatter.java
@@ -74,4 +74,9 @@ public void syntaxError(String state, String event, List<String> legalEvents, St
     public void done() {
         throw new UnsupportedOperationException();
     }
+
+    @Override
+    public void close() {
+        throw new UnsupportedOperationException();
+    }
 }
diff --git a/core/src/test/java/cucumber/runtime/RuntimeTest.java b/core/src/test/java/cucumber/runtime/RuntimeTest.java
@@ -2,7 +2,7 @@
 
 import cucumber.io.ClasspathResourceLoader;
 import cucumber.runtime.model.CucumberFeature;
-import gherkin.formatter.JSONFormatter;
+import gherkin.formatter.JSONPrettyFormatter;
 import org.junit.Test;
 
 import java.util.Collections;
@@ -23,12 +23,61 @@ public void runs_feature_with_json_formatter() throws Exception {
                 "  Scenario: scenario name\n" +
                 "    When s\n");
         StringBuilder out = new StringBuilder();
-        JSONFormatter jsonFormatter = new JSONFormatter(out);
+        JSONPrettyFormatter jsonFormatter = new JSONPrettyFormatter(out);
         List<Backend> backends = asList(mock(Backend.class));
         ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
         new Runtime(new ClasspathResourceLoader(classLoader), Collections.<String>emptyList(), classLoader, backends, true).run(feature, jsonFormatter, jsonFormatter);
         jsonFormatter.done();
-        String expected = "[{\"id\":\"feature-name\",\"description\":\"\",\"name\":\"feature name\",\"keyword\":\"Feature\",\"line\":1,\"elements\":[{\"description\":\"\",\"name\":\"background name\",\"keyword\":\"Background\",\"line\":2,\"steps\":[{\"result\":{\"status\":\"undefined\"},\"name\":\"b\",\"keyword\":\"Given \",\"line\":3,\"match\":{}}],\"type\":\"background\"},{\"id\":\"feature-name;scenario-name\",\"description\":\"\",\"name\":\"scenario name\",\"keyword\":\"Scenario\",\"line\":4,\"steps\":[{\"result\":{\"status\":\"undefined\"},\"name\":\"s\",\"keyword\":\"When \",\"line\":5,\"match\":{}}],\"type\":\"scenario\"}],\"uri\":\"test.feature\"}]";
+        String expected = "" +
+                "[\n" +
+                "  {\n" +
+                "    \"id\": \"feature-name\",\n" +
+                "    \"description\": \"\",\n" +
+                "    \"name\": \"feature name\",\n" +
+                "    \"keyword\": \"Feature\",\n" +
+                "    \"line\": 1,\n" +
+                "    \"elements\": [\n" +
+                "      {\n" +
+                "        \"description\": \"\",\n" +
+                "        \"name\": \"background name\",\n" +
+                "        \"keyword\": \"Background\",\n" +
+                "        \"line\": 2,\n" +
+                "        \"steps\": [\n" +
+                "          {\n" +
+                "            \"result\": {\n" +
+                "              \"status\": \"undefined\"\n" +
+                "            },\n" +
+                "            \"name\": \"b\",\n" +
+                "            \"keyword\": \"Given \",\n" +
+                "            \"line\": 3,\n" +
+                "            \"match\": {}\n" +
+                "          }\n" +
+                "        ],\n" +
+                "        \"type\": \"background\"\n" +
+                "      },\n" +
+                "      {\n" +
+                "        \"id\": \"feature-name;scenario-name\",\n" +
+                "        \"description\": \"\",\n" +
+                "        \"name\": \"scenario name\",\n" +
+                "        \"keyword\": \"Scenario\",\n" +
+                "        \"line\": 4,\n" +
+                "        \"steps\": [\n" +
+                "          {\n" +
+                "            \"result\": {\n" +
+                "              \"status\": \"undefined\"\n" +
+                "            },\n" +
+                "            \"name\": \"s\",\n" +
+                "            \"keyword\": \"When \",\n" +
+                "            \"line\": 5,\n" +
+                "            \"match\": {}\n" +
+                "          }\n" +
+                "        ],\n" +
+                "        \"type\": \"scenario\"\n" +
+                "      }\n" +
+                "    ],\n" +
+                "    \"uri\": \"test.feature\"\n" +
+                "  }\n" +
+                "]";
         assertEquals(expected, out.toString());
     }
 }
diff --git a/core/src/test/java/cucumber/runtime/autocomplete/StepdefGeneratorTest.java b/core/src/test/java/cucumber/runtime/autocomplete/StepdefGeneratorTest.java
@@ -1,13 +1,13 @@
 package cucumber.runtime.autocomplete;
 
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
 import cucumber.io.Resource;
 import cucumber.runtime.FeatureBuilder;
 import cucumber.runtime.JdkPatternArgumentMatcher;
 import cucumber.runtime.ParameterType;
 import cucumber.runtime.StepDefinition;
 import cucumber.runtime.model.CucumberFeature;
+import gherkin.deps.com.google.gson.Gson;
+import gherkin.deps.com.google.gson.GsonBuilder;
 import gherkin.formatter.Argument;
 import gherkin.formatter.model.Step;
 import org.junit.Test;

diff --git a/java/src/test/java/cucumber/runtime/java/JavaBackendTest.java b/java/src/test/java/cucumber/runtime/java/JavaBackendTest.java
@@ -7,8 +7,6 @@
 import cucumber.runtime.StepDefinitionMatch;
 import cucumber.runtime.java.test.Stepdefs;
 import gherkin.formatter.model.Step;
-import gherkin.formatter.model.DataTableRow;
-import gherkin.formatter.model.DocString;
 import org.junit.Test;
 
 import java.io.File;

diff --git a/junit/src/main/java/cucumber/junit/Cucumber.java b/junit/src/main/java/cucumber/junit/Cucumber.java
@@ -80,6 +80,7 @@ public void run(RunNotifier notifier) {
         super.run(notifier);
         jUnitReporter.done();
         new SummaryPrinter(System.out).print(runtime);
+        jUnitReporter.close();
     }
 
     private void assertNoDeclaredMethods(Class clazz) {

diff --git a/junit/src/main/java/cucumber/junit/JUnitReporter.java b/junit/src/main/java/cucumber/junit/JUnitReporter.java
@@ -133,4 +133,9 @@ public void syntaxError(String state, String event, List<String> legalEvents, St
     public void done() {
         formatter.done();
     }
+
+    @Override
+    public void close() {
+        formatter.close();
+    }
 }
diff --git a/pom.xml b/pom.xml
@@ -15,7 +15,7 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <outputDirectory>${project.build.directory}</outputDirectory>
-        <gherkin.version>2.7.4</gherkin.version>
+        <gherkin.version>2.7.6</gherkin.version>
         <groovy.version>1.8.5</groovy.version>
     </properties>
     <licenses>
@@ -168,11 +168,6 @@
                 <artifactId>mockito-all</artifactId>
                 <version>1.9.0</version>
             </dependency>
-            <dependency>
-                <groupId>com.google.code.gson</groupId>
-                <artifactId>gson</artifactId>
-                <version>2.1</version>
-            </dependency>
             <dependency>
                 <groupId>org.seleniumhq.selenium</groupId>
                 <artifactId>selenium-chrome-driver</artifactId>