Merge pull request #25 from marques-work/honor-stdin

Plugin CLI should accept STDIN input for syntax check

Author: tomzo

README.md

@@ -91,6 +91,28 @@ Then to validate your `gopipeline.json` file run something like:
 java -jar /usr/lib/gocd-json-plugin/json-config-plugin.jar syntax mypipe.gopipeline.json
 ```
 
+## Usage with `gocd` command-line helper
+
+This is a product in development, so its command syntax is not stable and there are no distributed binaries yet.
+
+The `gocd` tool is built in [golang](https://golang.org/) so you will need to familiarize yourself with how to set up your [go workspace](https://golang.org/doc/code.html#Workspaces).
+
+Build the `gocd` binary:
+
+```bash
+go get github.com/gocd-contrib/gocd-cli
+cd ${GOPATH:-~/go}/src/github.com/gocd-contrib/gocd-cli
+./build.sh
+```
+
+Follow the steps on [https://github.com/gocd-contrib/gocd-cli](https://github.com/gocd-contrib/gocd-cli) to install the plugin jar to the correct place.
+
+Then:
+
+```bash
+./gocd configrepo check -i json.config.plugin /path/to/your-pipeline.gopipeline.json
+```
+
 ## Usage with IDE and docker
 
 [IDE](https://github.com/ai-traders/ide) is a bash script, a cli wrapper around docker to help with running development tasks in docker.
@@ -746,7 +768,7 @@ Optionally any task can have `run_if` and `on_cancel`.
       "docs",
       "install"
     ],
-    "working_directory": null      
+    "working_directory": null
 }
 ```
 

build.gradle

@@ -1,5 +1,5 @@
 group = 'com.thoughtworks.go'
-version = '0.3.1'
+version = '0.3.2'
 
 apply plugin: 'java'
 

src/com.tw.go.config.json/ConfigDirectoryParser.java

@@ -3,14 +3,16 @@
 import com.google.gson.JsonElement;
 
 import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
 
 class ConfigDirectoryParser {
     private ConfigDirectoryScanner scanner;
-    private JsonFileParser parser;
+    private JsonConfigParser parser;
     private String pipelinePattern;
     private String environmentPattern;
 
-    ConfigDirectoryParser(ConfigDirectoryScanner scanner, JsonFileParser parser, String pipelinePattern, String environmentPattern) {
+    ConfigDirectoryParser(ConfigDirectoryScanner scanner, JsonConfigParser parser, String pipelinePattern, String environmentPattern) {
         this.scanner = scanner;
         this.parser = parser;
         this.pipelinePattern = pipelinePattern;
@@ -19,18 +21,26 @@ class ConfigDirectoryParser {
 
     JsonConfigCollection parseDirectory(File baseDir) {
         JsonConfigCollection config = new JsonConfigCollection();
-        for (String environmentFile : scanner.getFilesMatchingPattern(baseDir, environmentPattern)) {
-            JsonElement environment = JsonFileParser.processFile(config, parser, new File(baseDir, environmentFile));
-            if (null != environment) {
-                config.addEnvironment(environment, environmentFile);
+        File currentFile;
+
+        try {
+            for (String environmentFile : scanner.getFilesMatchingPattern(baseDir, environmentPattern)) {
+                currentFile = new File(baseDir, environmentFile);
+                JsonElement environment = JsonConfigParser.parseStream(config, parser, new FileInputStream(currentFile), currentFile.getPath());
+                if (null != environment) {
+                    config.addEnvironment(environment, environmentFile);
+                }
             }
-        }
 
-        for (String pipelineFile : scanner.getFilesMatchingPattern(baseDir, pipelinePattern)) {
-            JsonElement pipeline = JsonFileParser.processFile(config, parser, new File(baseDir, pipelineFile));
-            if (null != pipeline) {
-                config.addPipeline(pipeline, pipelineFile);
+            for (String pipelineFile : scanner.getFilesMatchingPattern(baseDir, pipelinePattern)) {
+                currentFile = new File(baseDir, pipelineFile);
+                JsonElement pipeline = JsonConfigParser.parseStream(config, parser, new FileInputStream(currentFile), currentFile.getPath());
+                if (null != pipeline) {
+                    config.addPipeline(pipeline, pipelineFile);
+                }
             }
+        } catch (FileNotFoundException e) {
+            config.addError(new PluginError(e.getMessage()));
         }
 
         return config;

src/com.tw.go.config.json/JsonConfigParser.java

@@ -0,0 +1,56 @@
+package com.tw.go.config.json;
+
+import com.google.gson.JsonElement;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonParseException;
+import com.google.gson.JsonParser;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.io.Reader;
+
+import static java.lang.String.format;
+
+public class JsonConfigParser {
+
+    private final JsonParser parser;
+
+    public JsonConfigParser() {
+        parser = new JsonParser();
+    }
+
+    public static JsonElement parseStream(JsonConfigCollection result, InputStream input, String location) {
+        return parseStream(result, new JsonConfigParser(), input, location);
+    }
+
+    public static JsonElement parseStream(JsonConfigCollection result, JsonConfigParser parser, InputStream input, String location) {
+        try (InputStreamReader contentReader = new InputStreamReader(input)) {
+            if (input.available() < 1) {
+                result.addError(new PluginError("File is empty", location));
+                return null;
+            }
+
+            JsonElement el = parser.parse(contentReader);
+
+            if (el == null || el.isJsonNull()) {
+                PluginError error = new PluginError("File is empty", location);
+                result.addError(error);
+            } else if (el.equals(new JsonObject())) {
+                PluginError error = new PluginError("Definition is empty", location);
+                result.addError(error);
+            } else {
+                return el;
+            }
+        } catch (IOException | JsonParseException e) {
+            PluginError error = new PluginError(format("Failed to parse file as JSON: %s", e.getMessage()), location);
+            result.addError(error);
+        }
+
+        return null;
+    }
+
+    private JsonElement parse(Reader reader) {
+        return parser.parse(reader);
+    }
+}

src/com.tw.go.config.json/JsonConfigPlugin.java

@@ -115,7 +115,7 @@ private GoPluginApiResponse handleParseDirectoryRequest(GoPluginApiRequest reque
             ParsedRequest parsed = ParsedRequest.parse(request);
             File baseDir = new File(parsed.getStringParam("directory"));
 
-            JsonFileParser parser = new JsonFileParser();
+            JsonConfigParser parser = new JsonConfigParser();
             PluginSettings settings = getPluginSettings();
             ConfigDirectoryScanner scanner = new AntDirectoryScanner();
 

src/com.tw.go.config.json/JsonFileParser.java

@@ -4,10 +4,13 @@
 import com.beust.jcommander.ParameterException;
 import com.google.gson.JsonObject;
 import com.tw.go.config.json.JsonConfigCollection;
-import com.tw.go.config.json.JsonFileParser;
+import com.tw.go.config.json.JsonConfigParser;
 import com.tw.go.config.json.PluginError;
 
 import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.InputStream;
 
 import static java.lang.String.format;
 
@@ -44,24 +47,38 @@ public static void main(String[] args) {
         JsonConfigCollection collection = new JsonConfigCollection();
         JsonObject result = collection.getJsonObject();
 
-        File file = new File(syntax.file);
+        String location = getLocation(syntax.file);
 
         try {
-            JsonFileParser.processFile(collection, new JsonFileParser(), file);
+            JsonConfigParser.parseStream(collection, getFileAsStream(syntax.file), location);
         } catch (Exception e) {
-            collection.addError(new PluginError(e.getMessage(), file.getAbsolutePath()));
+            collection.addError(new PluginError(e.getMessage(), location));
         }
 
         result.remove("environments");
         result.remove("pipelines");
 
         if (collection.getErrors().size() > 0) {
-            die(syntax.quiet, 1, result.toString());
+            die(1, result.toString());
         } else {
-            die(syntax.quiet, 0, "OK");
+            die(0, "OK");
         }
     }
 
+    private static String getLocation(String file) {
+        return "-".equals(file) ? "<STDIN>" : file;
+    }
+
+    private static InputStream getFileAsStream(String file) {
+        InputStream s = null;
+        try {
+            s = "-".equals(file) ? System.in : new FileInputStream(new File(".", file));
+        } catch (FileNotFoundException e) {
+            die(1, e.getMessage());
+        }
+        return s;
+    }
+
     private static void echo(String message, Object... items) {
         System.out.println(format(message, items));
     }
@@ -79,13 +96,6 @@ private static void die(int exitCode, String message, Object... items) {
         System.exit(exitCode);
     }
 
-    private static void die(boolean quietly, int exitCode, String message, Object... items) {
-        if (quietly) {
-            System.exit(exitCode);
-        }
-        die(exitCode, message, items);
-    }
-
     private static void printUsageAndExit(int exitCode, JCommander cmd, String command) {
         StringBuilder out = new StringBuilder();
         if (null == command) {

src/com.tw.go.config.json/cli/JsonPluginCli.java

@@ -3,9 +3,6 @@
 import com.beust.jcommander.Parameter;
 
 class SyntaxCmd {
-    @Parameter(names = {"--quiet", "-q"}, description = "Silence output; validation indicated only by exit status")
-    boolean quiet;
-
     @Parameter(names = {"--help", "-h"}, help = true, description = "Print this help message")
     boolean help;
 

src/com.tw.go.config.json/cli/SyntaxCmd.java

@@ -28,7 +28,7 @@ public void SetUp() throws Exception {
         FileUtils.deleteDirectory(directory);
 
         parser = new ConfigDirectoryParser(
-                new AntDirectoryScanner(), new JsonFileParser(),
+                new AntDirectoryScanner(), new JsonConfigParser(),
                 JsonConfigPlugin.DEFAULT_PIPELINE_PATTERN,
                 JsonConfigPlugin.DEFAULT_ENVIRONMENT_PATTERN);