Introduce FilesCreateTempFileToFile Refaster rule (#1162)

PicnicSupermarket · Aug 7, 2024 · a433a90 · a433a90
1 parent 5a37d65
commit a433a90
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 0 deletions.
diff --git a/error-prone-contrib/src/main/java/tech/picnic/errorprone/refasterrules/FileRules.java b/error-prone-contrib/src/main/java/tech/picnic/errorprone/refasterrules/FileRules.java
@@ -2,12 +2,15 @@
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 
+import com.google.errorprone.refaster.Refaster;
 import com.google.errorprone.refaster.annotation.AfterTemplate;
 import com.google.errorprone.refaster.annotation.BeforeTemplate;
+import java.io.File;
 import java.io.IOException;
 import java.nio.charset.Charset;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.nio.file.attribute.FileAttribute;
 import tech.picnic.errorprone.refaster.annotation.OnlineDocumentation;
 
 /** Refaster rules related to expressions dealing with files. */
@@ -40,4 +43,24 @@ String after(Path path) throws IOException {
       return Files.readString(path);
     }
   }
+
+  /**
+   * Prefer {@link Files#createTempFile(String, String, FileAttribute[])} over alternatives that
+   * create files with more liberal permissions.
+   */
+  static final class FilesCreateTempFileToFile {
+    @BeforeTemplate
+    @SuppressWarnings("java:S5443" /* This violation will be rewritten. */)
+    File before(String prefix, String suffix) throws IOException {
+      return Refaster.anyOf(
+          File.createTempFile(prefix, suffix), File.createTempFile(prefix, suffix, null));
+    }
+
+    @AfterTemplate
+    @SuppressWarnings(
+        "java:S5443" /* On POSIX systems the file will only have user read-write permissions. */)
+    File after(String prefix, String suffix) throws IOException {
+      return Files.createTempFile(prefix, suffix).toFile();
+    }
+  }
 }
diff --git a/...e-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/FileRulesTestInput.java b/...e-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/FileRulesTestInput.java
@@ -1,5 +1,7 @@
 package tech.picnic.errorprone.refasterrules;
 
+import com.google.common.collect.ImmutableSet;
+import java.io.File;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
@@ -14,4 +16,9 @@ String testFilesReadStringWithCharset() throws IOException {
   String testFilesReadString() throws IOException {
     return Files.readString(Paths.get("foo"), StandardCharsets.UTF_8);
   }
+
+  ImmutableSet<File> testFilesCreateTempFileToFile() throws IOException {
+    return ImmutableSet.of(
+        File.createTempFile("foo", "bar"), File.createTempFile("baz", "qux", null));
+  }
 }
diff --git a/...-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/FileRulesTestOutput.java b/...-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/FileRulesTestOutput.java
@@ -1,5 +1,7 @@
 package tech.picnic.errorprone.refasterrules;
 
+import com.google.common.collect.ImmutableSet;
+import java.io.File;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
@@ -14,4 +16,9 @@ String testFilesReadStringWithCharset() throws IOException {
   String testFilesReadString() throws IOException {
     return Files.readString(Paths.get("foo"));
   }
+
+  ImmutableSet<File> testFilesCreateTempFileToFile() throws IOException {
+    return ImmutableSet.of(
+        Files.createTempFile("foo", "bar").toFile(), Files.createTempFile("baz", "qux").toFile());
+  }
 }