- F Automatically git-ignore our temp folder

Co-authored-by: Jay Bazuzi <[email protected]>

Author: LarsEckart

.gitignore

@@ -24,4 +24,3 @@ __pycache__/
 *.bak
 
 .gitmessage
-.approval_tests_temp/

approvaltests-tests/src/test/java/org/approvaltests/ApprovedFileLogTest.java

@@ -2,12 +2,15 @@
 
 import com.spun.util.io.FileUtils;
 import org.approvaltests.internal.logs.ApprovedFileLog;
+import org.approvaltests.internal.logs.LoggingUtils;
 import org.approvaltests.namer.ApprovalNamer;
 import org.junit.Assert;
 import org.junit.jupiter.api.Test;
 
 import java.io.File;
 
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
 public class ApprovedFileLogTest
 {
   @Test
@@ -17,9 +20,16 @@ void testLogging()
     ApprovalNamer approvalNamer = Approvals.createApprovalNamer();
     File approvedFile = approvalNamer.getApprovedFile(".txt");
     String prelog = FileUtils.readFile(file);
+    // TODO
     Assert.assertFalse(prelog.contains(approvedFile.getAbsolutePath()));
     Approvals.verify("anything");
     String postlog = FileUtils.readFile(file);
     Assert.assertTrue(postlog.contains(approvedFile.getAbsolutePath()));
   }
+  @Test
+  void testTempDirectoryGetsGitIgnore()
+  {
+    String result = FileUtils.readFile(LoggingUtils.getTempDirectory() + "/.gitignore");
+    assertEquals("*\n", result);
+  }
 }

approvaltests/src/main/java/org/approvaltests/internal/logs/ApprovedFileLog.java

@@ -14,7 +14,7 @@ public class ApprovedFileLog
   }
   public static File get()
   {
-    File file = new File(LoggingUtils.APPROVAL_TEMP_DIRECTORY + "/.approved_files.log");
+    File file = new File(LoggingUtils.getTempDirectory() + "/.approved_files.log");
     FileUtils.createIfNeeded(file.getAbsolutePath());
     return file;
   }

approvaltests/src/main/java/org/approvaltests/internal/logs/FailedFileLog.java

@@ -5,8 +5,6 @@
 
 import java.io.File;
 
-import static org.approvaltests.internal.logs.LoggingUtils.APPROVAL_TEMP_DIRECTORY;
-
 public class FailedFileLog
 {
   static
@@ -19,7 +17,7 @@ private static void downloadApproveAllScriptIfMissing()
   }
   public static File get()
   {
-    File file = new File(APPROVAL_TEMP_DIRECTORY + "/.failed_comparison.log");
+    File file = new File(LoggingUtils.getTempDirectory() + "/.failed_comparison.log");
     FileUtils.createIfNeeded(file.getAbsolutePath());
     return file;
   }

approvaltests/src/main/java/org/approvaltests/internal/logs/LoggingUtils.java

@@ -9,13 +9,12 @@
 
 public class LoggingUtils
 {
-  public static final String APPROVAL_TEMP_DIRECTORY = ".approval_tests_temp";
   public static void downloadScriptIfMissing(String scriptName)
   {
     try
     {
       String extension = SystemUtils.isWindowsEnvironment() ? ".bat" : ".sh";
-      File script = new File(APPROVAL_TEMP_DIRECTORY + "/" + scriptName + extension);
+      File script = new File(getTempDirectory() + "/" + scriptName + extension);
       if (!script.exists())
       {
         String github = "https://raw.githubusercontent.com/approvals/ApprovalTests.Java/refs/heads/master/";
@@ -29,4 +28,10 @@ public static void downloadScriptIfMissing(String scriptName)
       // do nothing
     }
   }
+  public static File getTempDirectory()
+  {
+    File approvalTestsTempDir = new File(".approval_tests_temp");
+    FileUtils.writeFile(new File(approvalTestsTempDir + "/.gitignore"), "*");
+    return approvalTestsTempDir;
+  }
 }

approvaltests/src/main/java/org/approvaltests/reporters/ReporterThatCreatesAnApprovalScript.java

@@ -32,14 +32,14 @@ private static void initializeFile()
   }
   private static void initializeLinux()
   {
-    scriptFile = new File(LoggingUtils.APPROVAL_TEMP_DIRECTORY + "/" + fileName + ".sh");
+    scriptFile = new File(LoggingUtils.getTempDirectory() + "/" + fileName + ".sh");
     FileUtils.createIfNeeded(scriptFile.getAbsolutePath());
     FileUtils.writeFile(scriptFile, "#!/bin/bash\n");
     scriptFile.setExecutable(true);
   }
   private static void initializeWindows()
   {
-    scriptFile = new File(LoggingUtils.APPROVAL_TEMP_DIRECTORY + "\\" + fileName + ".bat");
+    scriptFile = new File(LoggingUtils.getTempDirectory() + "\\" + fileName + ".bat");
     FileUtils.createIfNeeded(scriptFile.getAbsolutePath());
     FileUtils.writeFile(scriptFile, "");
   }