Make compilation work on Windows (#331)

* Make the Gradle upload plugin work on Windows

* Remove the bash script to generate package-info.java file

* Minor changes to the format

buildSrc/src/main/java/google/registry/gradle/plugin/CoverPageGenerator.java

@@ -26,6 +26,7 @@ import com.google.common.collect.ImmutableSetMultimap;
 import com.google.template.soy.SoyFileSet;
 import com.google.template.soy.tofu.SoyTofu;
 import google.registry.gradle.plugin.ProjectData.TaskData;
+import java.io.File;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.function.Supplier;
@@ -148,10 +149,14 @@ final class CoverPageGenerator {
 
   /** returns a soy-friendly version of the given task data. */
   static ImmutableMap<String, Object> taskDataToSoy(TaskData task) {
+    // Note that all instances of File.separator are replaced with forward slashes so that we can
+    // generate a valid href on Windows.
     return new ImmutableMap.Builder<String, Object>()
         .put("uniqueName", task.uniqueName())
         .put("description", task.description())
-        .put("log", task.log().isPresent() ? getLogPath(task).toString() : "")
+        .put(
+            "log",
+            task.log().isPresent() ? getLogPath(task).toString().replace(File.separator, "/") : "")
         .put(
             "reports",
             task.reports().entrySet().stream()
@@ -161,7 +166,11 @@ final class CoverPageGenerator {
                         entry ->
                             entry.getValue().files().isEmpty()
                                 ? ""
-                                : entry.getValue().entryPoint().toString())))
+                                : entry
+                                    .getValue()
+                                    .entryPoint()
+                                    .toString()
+                                    .replace(File.separator, "/"))))
         .build();
   }
 
@@ -188,8 +197,10 @@ final class CoverPageGenerator {
   }
 
   private static Path getLogPath(TaskData task) {
-    // TODO(guyben):escape uniqueName to guarantee legal file name.
-    return Paths.get("logs", task.uniqueName() + ".log");
+    // We replace colons with dashes so that the resulting filename is always valid, even in
+    // Windows. As a dash is not a valid character in Java identifies, a task name cannot include
+    // it, so the uniqueness of the name is perserved.
+    return Paths.get("logs", task.uniqueName().replace(":", "-") + ".log");
   }
 
   private static Supplier<byte[]> resourceLoader(Path path) {

buildSrc/src/main/java/google/registry/gradle/plugin/GcsPluginUtils.java

@@ -64,7 +64,8 @@ final class GcsPluginUtils {
 
   static void uploadFileToGcs(
       Storage storage, String bucket, Path path, Supplier<byte[]> dataSupplier) {
-    String filename = path.toString();
+    // Replace Windows file separators with forward slashes.
+    String filename = path.toString().replace(File.separator, "/");
     storage.create(
         BlobInfo.newBuilder(bucket, filename).setContentType(getContentType(filename)).build(),
         dataSupplier.get());

buildSrc/src/test/java/google/registry/gradle/plugin/CoverPageGeneratorTest.java

@@ -20,9 +20,11 @@ import static com.google.common.truth.Truth8.assertThat;
 import static google.registry.gradle.plugin.GcsPluginUtils.toByteArraySupplier;
 import static java.nio.charset.StandardCharsets.UTF_8;
 
+import com.google.common.base.Joiner;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableSet;
 import google.registry.gradle.plugin.ProjectData.TaskData;
+import java.io.File;
 import java.nio.file.Paths;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -63,6 +65,8 @@ public final class CoverPageGeneratorTest {
           .setState(TaskData.State.UP_TO_DATE)
           .build();
 
+  private static final Joiner filenameJoiner = Joiner.on(File.separator);
+
   private ImmutableMap<String, String> getGeneratedFiles(ProjectData project) {
     CoverPageGenerator coverPageGenerator = new CoverPageGenerator(project);
     FilesWithEntryPoint files = coverPageGenerator.getFilesToUpload();
@@ -172,8 +176,8 @@ public final class CoverPageGeneratorTest {
   @Test
   public void testGetFilesToUpload_containsCssFile() {
     ImmutableMap<String, String> files = getGeneratedFiles(EMPTY_PROJECT);
-    assertThat(files).containsKey("css/style.css");
-    assertThat(files.get("css/style.css")).contains("body {");
+    assertThat(files).containsKey(filenameJoiner.join("css", "style.css"));
+    assertThat(files.get(filenameJoiner.join("css", "style.css"))).contains("body {");
     assertThat(files.get("index.html"))
         .contains("<link rel=\"stylesheet\" type=\"text/css\" href=\"css/style.css\">");
   }
@@ -191,8 +195,8 @@ public final class CoverPageGeneratorTest {
                         .setLog(toByteArraySupplier("my log data"))
                         .build())
                 .build());
-    assertThat(files).containsEntry("logs/my:name.log", "my log data");
-    assertThat(files.get("index.html")).contains("<a href=\"logs/my:name.log\">[log]</a>");
+    assertThat(files).containsEntry(filenameJoiner.join("logs", "my-name.log"), "my log data");
+    assertThat(files.get("index.html")).contains("<a href=\"logs/my-name.log\">[log]</a>");
   }
 
   @Test
@@ -203,7 +207,7 @@ public final class CoverPageGeneratorTest {
                 .toBuilder()
                 .addTask(EMPTY_TASK_SUCCESS.toBuilder().setUniqueName("my:name").build())
                 .build());
-    assertThat(files).doesNotContainKey("logs/my:name.log");
+    assertThat(files).doesNotContainKey("logs/my-name.log");
     assertThat(files.get("index.html")).contains("<span class=\"report_link_broken\">[log]</span>");
   }
 
@@ -225,7 +229,7 @@ public final class CoverPageGeneratorTest {
                                 Paths.get("path", "report.txt")))
                         .build())
                 .build());
-    assertThat(files).containsEntry("path/report.txt", "report content");
+    assertThat(files).containsEntry(filenameJoiner.join("path", "report.txt"), "report content");
     assertThat(files.get("index.html")).contains("<a href=\"path/report.txt\">[someReport]</a>");
   }
 
@@ -244,7 +248,7 @@ public final class CoverPageGeneratorTest {
                                 ImmutableMap.of(), Paths.get("path", "report.txt")))
                         .build())
                 .build());
-    assertThat(files).doesNotContainKey("path/report.txt");
+    assertThat(files).doesNotContainKey(filenameJoiner.join("path", "report.txt"));
     assertThat(files.get("index.html"))
         .contains("<span class=\"report_link_broken\">[someReport]</span>");
   }
@@ -275,12 +279,15 @@ public final class CoverPageGeneratorTest {
                                 ImmutableMap.of(), Paths.get("path-empty", "report.txt")))
                         .build())
                 .build());
-    assertThat(files).containsEntry("path-filled/report.txt", "report content");
-    assertThat(files).containsEntry("path-filled/other/file.txt", "some other content");
-    assertThat(files).containsEntry("logs/my:name.log", "log data");
+    assertThat(files)
+        .containsEntry(filenameJoiner.join("path-filled", "report.txt"), "report content");
+    assertThat(files)
+        .containsEntry(
+            filenameJoiner.join("path-filled", "other", "file.txt"), "some other content");
+    assertThat(files).containsEntry(filenameJoiner.join("logs", "my-name.log"), "log data");
     assertThat(files.get("index.html"))
         .contains("<a href=\"path-filled/report.txt\">[filledReport]</a>");
-    assertThat(files.get("index.html")).contains("<a href=\"logs/my:name.log\">[log]</a>");
+    assertThat(files.get("index.html")).contains("<a href=\"logs/my-name.log\">[log]</a>");
     assertThat(files.get("index.html"))
         .contains("<span class=\"report_link_broken\">[emptyReport]</span>");
   }

buildSrc/src/test/java/google/registry/gradle/plugin/GcsPluginUtilsTest.java

@@ -29,6 +29,7 @@ import static org.mockito.Mockito.verifyNoMoreInteractions;
 
 import com.google.cloud.storage.BlobInfo;
 import com.google.cloud.storage.Storage;
+import com.google.common.base.Joiner;
 import com.google.common.collect.ImmutableMap;
 import java.io.File;
 import java.nio.file.Files;
@@ -45,6 +46,8 @@ import org.junit.runners.JUnit4;
 @RunWith(JUnit4.class)
 public final class GcsPluginUtilsTest {
 
+  private static final Joiner filenameJoiner = Joiner.on(File.separator);
+
   @Rule public final TemporaryFolder folder = new TemporaryFolder();
 
   @Test
@@ -155,8 +158,10 @@ public final class GcsPluginUtilsTest {
     FilesWithEntryPoint files =
         readFilesWithEntryPoint(destination, Optional.of(ignoredHint), root);
 
-    assertThat(files.entryPoint().toString()).isEqualTo("some/path/file.txt");
-    assertThat(readAllFiles(files)).containsExactly("some/path/file.txt", "some data");
+    assertThat(files.entryPoint().toString())
+        .isEqualTo(filenameJoiner.join("some", "path", "file.txt"));
+    assertThat(readAllFiles(files))
+        .containsExactly(filenameJoiner.join("some", "path", "file.txt"), "some data");
   }
 
   @Test
@@ -171,7 +176,7 @@ public final class GcsPluginUtilsTest {
     FilesWithEntryPoint files =
         readFilesWithEntryPoint(destination, Optional.of(ignoredHint), root);
 
-    assertThat(files.entryPoint().toString()).isEqualTo("non/existing.txt");
+    assertThat(files.entryPoint().toString()).isEqualTo(filenameJoiner.join("non", "existing.txt"));
     assertThat(files.files()).isEmpty();
   }
 
@@ -187,7 +192,7 @@ public final class GcsPluginUtilsTest {
     FilesWithEntryPoint files =
         readFilesWithEntryPoint(destination, Optional.of(ignoredHint), root);
 
-    assertThat(files.entryPoint().toString()).isEqualTo("some/path");
+    assertThat(files.entryPoint().toString()).isEqualTo(filenameJoiner.join("some", "path"));
     assertThat(files.files()).isEmpty();
   }
 
@@ -205,8 +210,10 @@ public final class GcsPluginUtilsTest {
     FilesWithEntryPoint files =
         readFilesWithEntryPoint(destination, Optional.of(ignoredHint), root);
 
-    assertThat(files.entryPoint().toString()).isEqualTo("some/path/a/file.txt");
-    assertThat(readAllFiles(files)).containsExactly("some/path/a/file.txt", "some data");
+    assertThat(files.entryPoint().toString())
+        .isEqualTo(filenameJoiner.join("some", "path", "a", "file.txt"));
+    assertThat(readAllFiles(files))
+        .containsExactly(filenameJoiner.join("some", "path", "a", "file.txt"), "some data");
   }
 
   /**
@@ -232,8 +239,10 @@ public final class GcsPluginUtilsTest {
 
     FilesWithEntryPoint files = readFilesWithEntryPoint(destination, Optional.empty(), root);
 
-    assertThat(files.entryPoint().toString()).isEqualTo("some/path/path.zip");
-    assertThat(readAllFiles(files).keySet()).containsExactly("some/path/path.zip");
+    assertThat(files.entryPoint().toString())
+        .isEqualTo(filenameJoiner.join("some", "path", "path.zip"));
+    assertThat(readAllFiles(files).keySet())
+        .containsExactly(filenameJoiner.join("some", "path", "path.zip"));
   }
 
   /**
@@ -261,8 +270,10 @@ public final class GcsPluginUtilsTest {
     FilesWithEntryPoint files =
         readFilesWithEntryPoint(destination, Optional.of(badEntryPoint), root);
 
-    assertThat(files.entryPoint().toString()).isEqualTo("some/path/path.zip");
-    assertThat(readAllFiles(files).keySet()).containsExactly("some/path/path.zip");
+    assertThat(files.entryPoint().toString())
+        .isEqualTo(filenameJoiner.join("some", "path", "path.zip"));
+    assertThat(readAllFiles(files).keySet())
+        .containsExactly(filenameJoiner.join("some", "path", "path.zip"));
   }
 
   @Test
@@ -285,12 +296,13 @@ public final class GcsPluginUtilsTest {
     FilesWithEntryPoint files =
         readFilesWithEntryPoint(destination, Optional.of(goodEntryPoint), root);
 
-    assertThat(files.entryPoint().toString()).isEqualTo("some/path/index.html");
+    assertThat(files.entryPoint().toString())
+        .isEqualTo(filenameJoiner.join("some", "path", "index.html"));
     assertThat(readAllFiles(files))
         .containsExactly(
-            "some/path/index.html", "some data",
-            "some/path/a/index.html", "wrong index",
-            "some/path/c/style.css", "css file",
-            "some/path/my_image.png", "images");
+            filenameJoiner.join("some", "path", "index.html"), "some data",
+            filenameJoiner.join("some", "path", "a", "index.html"), "wrong index",
+            filenameJoiner.join("some", "path", "c", "style.css"), "css file",
+            filenameJoiner.join("some", "path", "my_image.png"), "images");
   }
 }