Merge pull request #83 from soboko/feature/jsonSupport

Added ability to generate a git properties file in json format.

Author: ktoso

pom.xml

@@ -94,6 +94,12 @@
       <version>${maven-plugin-api.version}</version>
     </dependency>
 
+    <dependency>
+      <groupId>com.fasterxml.jackson.core</groupId>
+      <artifactId>jackson-databind</artifactId>
+      <version>2.2.3</version>
+    </dependency>
+
     <dependency>
       <groupId>com.google.inject</groupId>
       <artifactId>guice</artifactId>

src/main/java/pl/project13/maven/git/GitCommitIdMojo.java

@@ -17,6 +17,7 @@
 
 package pl.project13.maven.git;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.io.Closeables;
 import com.google.common.io.Files;
@@ -188,6 +189,14 @@ public class GitCommitIdMojo extends AbstractMojo {
   @SuppressWarnings("UnusedDeclaration")
   private int abbrevLength;
 
+  /**
+   * The format to save properties in. Valid options are "properties" (default) and "json".
+   *
+   * @parameter default-value="properties"
+   */
+  @SuppressWarnings("UnusedDeclaration")
+  private String format;
+
   /**
    * The prefix to expose the properties on, for example 'git' would allow you to access '${git.branch}'
    *
@@ -462,9 +471,14 @@ void generatePropertiesFile(@NotNull Properties properties, File base, String pr
       Files.createParentDirs(gitPropsFile);
 
       fileWriter = new FileWriter(gitPropsFile);
-      properties.store(fileWriter, "Generated by Git-Commit-Id-Plugin");
-
-      log("Writing properties file to [", gitPropsFile.getAbsolutePath(), "] (for module ", project.getName() + (++counter), ")...");
+      if ("json".equalsIgnoreCase(format)) {
+        log("Writing json file to [", gitPropsFile.getAbsolutePath(), "] (for module ", project.getName() + (++counter), ")...");
+        ObjectMapper mapper = new ObjectMapper();
+        mapper.writeValue(fileWriter, properties);
+      } else {
+        log("Writing properties file to [", gitPropsFile.getAbsolutePath(), "] (for module ", project.getName() + (++counter), ")...");
+        properties.store(fileWriter, "Generated by Git-Commit-Id-Plugin");
+      }
 
     } catch (IOException ex) {
       throw new RuntimeException("Cannot create custom git properties file: " + gitPropsFile, ex);
@@ -554,7 +568,7 @@ protected String determineBranchNameOnBuildServer(Repository git, Map<String, St
       log("Detected that running on CI enviroment, but using repository branch, no GIT_BRANCH detected.");
       return git.getBranch();
     }else {
-      log("Using enviroment variable based branch name.", "GIT_BRANCH =", enviromentBasedBranch);
+      log("Using environment variable based branch name.", "GIT_BRANCH =", enviromentBasedBranch);
       return enviromentBasedBranch;
     }
   }
@@ -574,6 +588,10 @@ private boolean runningOnBuildServer(Map<String, String> env) {
 
   // SETTERS FOR TESTS ----------------------------------------------------
 
+  public void setFormat(String format) {
+    this.format = format;
+  }
+
   public void setVerbose(boolean verbose) {
     this.verbose = verbose;
   }

src/test/java/pl/project13/maven/git/GitCommitIdMojoIntegrationTest.java

@@ -19,15 +19,22 @@
 
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.project.MavenProject;
-import org.fest.util.Files;
+import org.codehaus.plexus.util.FileUtils;
 import org.junit.Test;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.google.common.io.Files;
 import pl.project13.maven.git.FileSystemMavenSandbox.CleanUp;
 import pl.project13.test.utils.AssertException;
 
 import java.io.File;
+import java.nio.charset.Charset;
+import java.util.HashMap;
+import java.util.Map;
 import java.util.Properties;
 
 import static org.fest.assertions.Assertions.assertThat;
+import static org.junit.Assert.assertEquals;
 import static org.mockito.internal.util.reflection.Whitebox.setInternalState;
 
 public class GitCommitIdMojoIntegrationTest extends GitIntegrationTest {
@@ -128,31 +135,65 @@ public void run() throws Exception {
   }
 
   @Test
-  public void shouldGenerateCustomPropertiesFile() throws Exception {
-    // given
-    mavenSandbox.withParentProject("my-pom-project", "pom")
-                .withChildProject("my-jar-module", "jar")
-                .withGitRepoInChild(AvailableGitTestRepo.GIT_COMMIT_ID)
-                .create(CleanUp.CLEANUP_FIRST);
+  public void shouldGenerateCustomPropertiesFileProperties() throws Exception {
+      // given
+      mavenSandbox.withParentProject("my-pom-project", "pom")
+          .withChildProject("my-jar-module", "jar")
+          .withGitRepoInChild(AvailableGitTestRepo.GIT_COMMIT_ID)
+          .create(CleanUp.CLEANUP_FIRST);
 
-    MavenProject targetProject = mavenSandbox.getChildProject();
+      MavenProject targetProject = mavenSandbox.getChildProject();
 
-    String targetFilePath = "target/classes/custom-git.properties";
-    File expectedFile = new File(targetProject.getBasedir(), targetFilePath);
+      String targetFilePath = "target/classes/custom-git.properties";
+      File expectedFile = new File(targetProject.getBasedir(), targetFilePath);
 
-    setProjectToExecuteMojoIn(targetProject);
-    alterMojoSettings("generateGitPropertiesFile", true);
-    alterMojoSettings("generateGitPropertiesFilename", targetFilePath);
+      setProjectToExecuteMojoIn(targetProject);
+      alterMojoSettings("generateGitPropertiesFile", true);
+      alterMojoSettings("generateGitPropertiesFilename", targetFilePath);
 
-    // when
-    try {
-      mojo.execute();
-
-      // then
-      assertThat(expectedFile).exists();
-    } finally {
-      Files.delete(expectedFile);
-    }
+      // when
+      try {
+        mojo.execute();
+
+        // then
+        assertThat(expectedFile).exists();
+      } finally {
+        FileUtils.forceDelete(expectedFile);
+      }
+  }
+
+  @Test
+  public void shouldGenerateCustomPropertiesFileJson() throws Exception {
+      // given
+      mavenSandbox.withParentProject("my-pom-project", "pom")
+          .withChildProject("my-jar-module", "jar")
+          .withGitRepoInChild(AvailableGitTestRepo.GIT_COMMIT_ID)
+          .create(CleanUp.CLEANUP_FIRST);
+
+      MavenProject targetProject = mavenSandbox.getChildProject();
+
+      String targetFilePath = "target/classes/custom-git.properties";
+      File expectedFile = new File(targetProject.getBasedir(), targetFilePath);
+
+      setProjectToExecuteMojoIn(targetProject);
+      alterMojoSettings("generateGitPropertiesFile", true);
+      alterMojoSettings("generateGitPropertiesFilename", targetFilePath);
+      alterMojoSettings("format", "json");
+
+      // when
+      try {
+        mojo.execute();
+
+        // then
+        assertThat(expectedFile).exists();
+        String json = Files.toString(expectedFile, Charset.defaultCharset());
+        ObjectMapper om = new ObjectMapper();
+        Map<String, String> map = new HashMap<String, String>();
+        map = om.readValue(expectedFile, map.getClass());
+        assertThat(map.size() > 10);
+      } finally {
+        FileUtils.forceDelete(expectedFile);
+      }
   }
 
   private void alterMojoSettings(String parameterName, Object parameterValue) {