partially revert 614975e and ensure that the plugin works when there is a relative or full path configured as output property

Author: TheSnoozer

src/main/java/pl/project13/core/GitCommitIdPlugin.java

@@ -306,6 +306,7 @@ public static void runPlugin(@Nonnull Callback cb, @Nullable Properties contextP
               cb.getProjectName()
       ).maybeGeneratePropertiesFile(
               properties,
+              cb.getProjectBaseDir(),
               cb.getGenerateGitPropertiesFile(),
               cb.getPropertiesSourceCharset(),
               cb.shouldPropertiesEscapeUnicode()

src/main/java/pl/project13/core/PropertiesFileGenerator.java

@@ -27,6 +27,7 @@
 import java.io.*;
 import java.nio.charset.Charset;
 import java.nio.file.Files;
+import java.nio.file.Paths;
 import java.util.Comparator;
 import java.util.Properties;
 
@@ -46,8 +47,15 @@ public PropertiesFileGenerator(LogInterface log, BuildFileChangeListener buildFi
     this.projectName = projectName;
   }
 
-  public void maybeGeneratePropertiesFile(@Nonnull Properties localProperties, File gitPropsFile, Charset sourceCharset, boolean escapeUnicode) throws GitCommitIdExecutionException {
+  public void maybeGeneratePropertiesFile(
+          @Nonnull Properties localProperties,
+          File projectDir,
+          File propsFile,
+          Charset sourceCharset,
+          boolean escapeUnicode
+  ) throws GitCommitIdExecutionException {
     try {
+      final File gitPropsFile = craftPropertiesOutputFile(projectDir, propsFile);
       final boolean isJsonFormat = CommitIdPropertiesOutputFormat.JSON.equals(propertiesOutputFormat);
 
       boolean shouldGenerate = true;
@@ -114,4 +122,15 @@ public static OrderedProperties createOrderedProperties() {
             .withOrdering(Comparator.nullsLast(Comparator.naturalOrder()))
             .build();
   }
+
+  private static File craftPropertiesOutputFile(File projectDir, File propsFile) {
+    File returnPath;
+    if (propsFile.isAbsolute()) {
+      returnPath = propsFile;
+    } else {
+      returnPath = projectDir.toPath().resolve(propsFile.toPath()).toFile();
+    }
+
+    return returnPath;
+  }
 }

src/test/java/pl/project13/core/PropertiesFileGeneratorTest.java

@@ -24,13 +24,15 @@
 import pl.project13.core.log.LogInterface;
 import pl.project13.core.util.BuildFileChangeListener;
 
+import java.io.File;
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.Properties;
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
 import static org.mockito.Mockito.mock;
 
 public class PropertiesFileGeneratorTest {
@@ -57,7 +59,8 @@ public void generatedPropertiesFileDoesNotEscapeUnicode() throws GitCommitIdExec
     properties.put(GitCommitPropertyConstant.COMMIT_MESSAGE_SHORT, "測試中文");
 
     Path propertiesPath = temporaryFolder.getRoot().toPath().resolve("git.properties");
-    propertiesFileGenerator.maybeGeneratePropertiesFile(properties, propertiesPath.toFile(), UTF_8, false);
+    propertiesFileGenerator.maybeGeneratePropertiesFile(
+            properties, temporaryFolder.getRoot(), propertiesPath.toFile(), UTF_8, false);
 
     byte[] bytes = Files.readAllBytes(propertiesPath);
     String actualContent = new String(bytes, UTF_8);
@@ -76,7 +79,8 @@ public void generatedPropertiesFileEscapeUnicode() throws GitCommitIdExecutionEx
     properties.put(GitCommitPropertyConstant.COMMIT_MESSAGE_SHORT, "測試中文");
 
     Path propertiesPath = temporaryFolder.getRoot().toPath().resolve("git.properties");
-    propertiesFileGenerator.maybeGeneratePropertiesFile(properties, propertiesPath.toFile(), UTF_8, true);
+    propertiesFileGenerator.maybeGeneratePropertiesFile(
+            properties, temporaryFolder.getRoot(), propertiesPath.toFile(), UTF_8, true);
 
     byte[] bytes = Files.readAllBytes(propertiesPath);
     String actualContent = new String(bytes, UTF_8);
@@ -94,7 +98,8 @@ public void generatedPropertiesFileDoesNotContainDateComment() throws GitCommitI
     properties.put(GitCommitPropertyConstant.BRANCH, "develop");
 
     Path propertiesPath = temporaryFolder.getRoot().toPath().resolve("git.properties");
-    propertiesFileGenerator.maybeGeneratePropertiesFile(properties, propertiesPath.toFile(), UTF_8, true);
+    propertiesFileGenerator.maybeGeneratePropertiesFile(
+            properties, temporaryFolder.getRoot(), propertiesPath.toFile(), UTF_8, true);
 
     byte[] bytes = Files.readAllBytes(propertiesPath);
     String actualContent = new String(bytes, UTF_8);
@@ -111,10 +116,12 @@ public void rereadGeneratedPropertiesFile() throws GitCommitIdExecutionException
     properties.put(GitCommitPropertyConstant.BRANCH, "develop");
 
     Path propertiesPath = temporaryFolder.getRoot().toPath().resolve("git.properties");
-    propertiesFileGenerator.maybeGeneratePropertiesFile(properties, propertiesPath.toFile(), UTF_8, true);
+    propertiesFileGenerator.maybeGeneratePropertiesFile(
+            properties, temporaryFolder.getRoot(), propertiesPath.toFile(), UTF_8, true);
 
     // Re-read the generated properties file.
-    propertiesFileGenerator.maybeGeneratePropertiesFile(properties, propertiesPath.toFile(), UTF_8, true);
+    propertiesFileGenerator.maybeGeneratePropertiesFile(
+            properties, temporaryFolder.getRoot(), propertiesPath.toFile(), UTF_8, true);
 
     byte[] bytes = Files.readAllBytes(propertiesPath);
     String actualContent = new String(bytes, UTF_8);
@@ -123,4 +130,23 @@ public void rereadGeneratedPropertiesFile() throws GitCommitIdExecutionException
         + "commit.id.full=b5993378ffadd1f84dc8da220b9204d157ec0f29\n";
     assertEquals(expectedContent, actualContent);
   }
+
+  @Test
+  public void worksWithRelativeFileLocation() throws GitCommitIdExecutionException, IOException {
+    Properties properties = new Properties();
+    properties.put(GitCommitPropertyConstant.COMMIT_ID_FULL, "b5993378ffadd1f84dc8da220b9204d157ec0f29");
+
+    Path relativePath = new File("src/blah/blub/git.properties").toPath();
+    propertiesFileGenerator.maybeGeneratePropertiesFile(
+            properties, temporaryFolder.getRoot(), relativePath.toFile(), UTF_8, false);
+
+
+    Path absolutePath = temporaryFolder.getRoot().toPath().resolve("src/blah/blub/git.properties");
+    assertTrue(absolutePath.toFile().exists());
+    byte[] bytes = Files.readAllBytes(absolutePath);
+    String actualContent = new String(bytes, UTF_8);
+    String expectedContent = "#Generated by Git-Commit-Id-Plugin\n"
+            + "commit.id.full=b5993378ffadd1f84dc8da220b9204d157ec0f29\n";
+    assertEquals(expectedContent, actualContent);
+  }
 }