Added possibility to specify encoding for generated git.properties/git.json file.

If no encoding is configured, platform encoding will be used as before.

Resolves #130

Author: frankbregulla1111

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

@@ -22,6 +22,7 @@
 import com.google.common.base.Function;
 import com.google.common.base.Predicate;
 import com.google.common.base.Predicates;
+import com.google.common.base.Strings;
 import com.google.common.collect.Lists;
 import com.google.common.io.Closeables;
 import com.google.common.io.Files;
@@ -34,9 +35,8 @@
 import pl.project13.maven.git.log.MavenLoggerBridge;
 import pl.project13.maven.git.util.PropertyManager;
 
-import java.io.File;
-import java.io.FileWriter;
-import java.io.IOException;
+import java.io.*;
+import java.nio.charset.Charset;
 import java.text.SimpleDateFormat;
 import java.util.Collections;
 import java.util.Date;
@@ -272,6 +272,13 @@ public class GitCommitIdMojo extends AbstractMojo {
   @SuppressWarnings("UnusedDeclaration")
   private List<String> excludeProperties = Collections.emptyList();
 
+  /**
+   * Specifies the character encoding for the properties file that is generated by this plugin
+   *
+   * @parameter  expression="${encoding}" default-value="${project.reporting.outputEncoding}
+   * @since 2.1.11
+   */
+  private String encoding;
 
   /**
    * The properties we store our data in and then expose them
@@ -487,25 +494,39 @@ void loadGitDataWithJGit(@NotNull Properties properties) throws IOException, Moj
   }
 
   void generatePropertiesFile(@NotNull Properties properties, File base, String propertiesFilename) throws IOException {
-    FileWriter fileWriter = null;
+    Writer outputWriter = null;
     File gitPropsFile = craftPropertiesOutputFile(base, propertiesFilename);
     try {
       Files.createParentDirs(gitPropsFile);
 
-      fileWriter = new FileWriter(gitPropsFile);
+      outputWriter = new OutputStreamWriter(new FileOutputStream(gitPropsFile), determineEncoding());
       if ("json".equalsIgnoreCase(format)) {
         log("Writing json file to [", gitPropsFile.getAbsolutePath(), "] (for module ", project.getName(), ")...");
         ObjectMapper mapper = new ObjectMapper();
-        mapper.writeValue(fileWriter, properties);
+        mapper.writeValue(outputWriter, properties);
       } else {
         log("Writing properties file to [", gitPropsFile.getAbsolutePath(), "] (for module ", project.getName(), ")...");
-        properties.store(fileWriter, "Generated by Git-Commit-Id-Plugin");
+        properties.store(outputWriter, "Generated by Git-Commit-Id-Plugin");
       }
 
     } catch (IOException ex) {
       throw new RuntimeException("Cannot create custom git properties file: " + gitPropsFile, ex);
     } finally {
-      Closeables.closeQuietly(fileWriter);
+      Closeables.closeQuietly(outputWriter);
+    }
+  }
+
+  private String determineEncoding() {
+    if (Strings.isNullOrEmpty(this.encoding) )
+    {
+        getLog().warn(
+                "File encoding has not been set, using platform encoding " + Charset.defaultCharset().name()
+                        + ", i.e. build is platform dependent!" );
+        return Charset.defaultCharset().name();
+    }
+    else
+    {
+        return this.encoding;
     }
   }
 

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

@@ -57,7 +57,7 @@ public enum AvailableGitTestRepo {
    */
   WITH_LIGHTWEIGHT_TAG_BEFORE_ANNOTATED_TAG("src/test/resources/_git_lightweight_tag_before_annotated_tag"),
   WITH_TAG_ON_DIFFERENT_BRANCH("src/test/resources/_git_with_tag_on_different_branch"),
-
+  WITH_ONE_COMMIT_WITH_SPECIAL_CHARACTERS("src/test/resources/_git_one_commit_with_umlaut"),
   MAVEN_GIT_COMMIT_ID_PLUGIN(".git");
 
   private String dir;

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

@@ -241,6 +241,43 @@ public void shouldGenerateCustomPropertiesFileJson(boolean useNativeGit) throws
     }
   }
 
+  @Test
+  @Parameters(value = {"UTF-8", "ISO-8859-1"})
+  public void shouldGenerateCustomPropertiesFileJsonWithCustomEncoding(String encoding) throws Exception {
+    // given
+    mavenSandbox.withParentProject("my-pom-project", "pom")
+                .withChildProject("my-jar-module", "jar")
+                .withGitRepoInChild(AvailableGitTestRepo.WITH_ONE_COMMIT_WITH_SPECIAL_CHARACTERS)
+                .create(CleanUp.CLEANUP_FIRST);
+
+    MavenProject targetProject = mavenSandbox.getChildProject();
+
+    String targetFilePath = "target/classes/custom-git.properties";
+    File expectedFile = new File(targetProject.getBasedir(), targetFilePath);
+    Charset charset = Charset.forName(encoding);
+
+    setProjectToExecuteMojoIn(targetProject);
+    alterMojoSettings("generateGitPropertiesFile", true);
+    alterMojoSettings("generateGitPropertiesFilename", targetFilePath);
+    alterMojoSettings("format", "json");
+    alterMojoSettings("useNativeGit", true);
+    alterMojoSettings("encoding", charset.name());
+    // when
+    try {
+      mojo.execute();
+
+      // then
+      assertThat(expectedFile).exists();
+      String json = Files.toString(expectedFile, charset);
+      ObjectMapper om = new ObjectMapper();
+      Map<String, String> map = new HashMap<String, String>();
+      map = om.readValue(json, map.getClass());
+      assertThat(map.size() > 10);
+    } finally {
+      FileUtils.forceDelete(expectedFile);
+    }
+  }
+
   @Test
   @Parameters(method = "useNativeGit")
   public void shouldSkipWithoutFailOnNoGitDirectoryWhenNoGitRepoFound(boolean useNativeGit) throws Exception {

src/test/resources/_git_one_commit_with_umlaut/COMMIT_EDITMSG

@@ -0,0 +1 @@
+initial commit on test project

src/test/resources/_git_one_commit_with_umlaut/HEAD

@@ -0,0 +1 @@
+ref: refs/heads/master

src/test/resources/_git_one_commit_with_umlaut/ORIG_HEAD

@@ -0,0 +1 @@
+0b0181b49468f45e573eaf3562f163107c5c121d

src/test/resources/_git_one_commit_with_umlaut/config

@@ -0,0 +1,14 @@
+[core]
+	repositoryformatversion = 0
+	filemode = false
+	bare = false
+	logallrefupdates = true
+	symlinks = false
+	ignorecase = true
+	hideDotFiles = dotGitOnly
+[user]
+	name = John Doe
+	email = [email protected]
+[receive]
+	denynonfastforwards = false
+	denyCurrentBranch = ignore

src/test/resources/_git_one_commit_with_umlaut/description

@@ -0,0 +1 @@
+Unnamed repository; edit this file 'description' to name the repository.

src/test/resources/_git_one_commit_with_umlaut/hooks/applypatch-msg.sample

@@ -0,0 +1,15 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message taken by
+# applypatch from an e-mail message.
+#
+# The hook should exit with non-zero status after issuing an
+# appropriate message if it wants to stop the commit.  The hook is
+# allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "applypatch-msg".
+
+. git-sh-setup
+test -x "$GIT_DIR/hooks/commit-msg" &&
+	exec "$GIT_DIR/hooks/commit-msg" ${1+"$@"}
+:

src/test/resources/_git_one_commit_with_umlaut/hooks/commit-msg.sample

@@ -0,0 +1,24 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message.
+# Called by "git commit" with one argument, the name of the file
+# that has the commit message.  The hook should exit with non-zero
+# status after issuing an appropriate message if it wants to stop the
+# commit.  The hook is allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "commit-msg".
+
+# Uncomment the below to add a Signed-off-by line to the message.
+# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
+# hook is more suited to it.
+#
+# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
+
+# This example catches duplicate Signed-off-by lines.
+
+test "" = "$(grep '^Signed-off-by: ' "$1" |
+	 sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
+	echo >&2 Duplicate Signed-off-by lines.
+	exit 1
+}