Merge pull request #33 from EtienneMiret/23-clean-subprojects

Store sass in a "$rootProject/.gradle/sass" subdirectory per subproject

Author: EtienneMiret

src/functionalTest/java/io/miret/etienne/gradle/sass/MultiProjectTest.java

@@ -83,26 +83,14 @@ void stopServer() {
 
   @BeforeEach
   void setupProject() throws IOException {
-    List<String> directories = ImmutableList.of(
-        "app",
-        "lib"
-    );
     List<String> files = ImmutableList.of(
         "app/build.gradle",
         "lib/build.gradle",
         "build.gradle",
         "settings.gradle"
     );
 
-    for (String subDir : directories) {
-      Files.createDirectories(projectDir.resolve(subDir));
-    }
-    for (String resource : files) {
-      try (InputStream input = MultiProjectTest.class.getResourceAsStream("multi-project/" + resource)) {
-        requireNonNull(input, "Missing resource: " + resource);
-        Files.copy(input, projectDir.resolve(resource));
-      }
-    }
+    Utils.copy("/io/miret/etienne/gradle/sass/multi-project", files, projectDir);
   }
 
   @Test

src/functionalTest/java/io/miret/etienne/gradle/sass/MultipleApplyTest.java

@@ -0,0 +1,79 @@
+package io.miret.etienne.gradle.sass;
+
+import com.github.tomakehurst.wiremock.WireMockServer;
+import com.google.common.collect.ImmutableList;
+import org.assertj.core.api.SoftAssertions;
+import org.assertj.core.api.junit.jupiter.InjectSoftAssertions;
+import org.assertj.core.api.junit.jupiter.SoftAssertionsExtension;
+import org.gradle.testkit.runner.GradleRunner;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.junit.jupiter.api.io.TempDir;
+
+import java.io.IOException;
+import java.nio.file.Path;
+import java.util.List;
+
+import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
+import static com.github.tomakehurst.wiremock.client.WireMock.get;
+import static com.github.tomakehurst.wiremock.client.WireMock.urlMatching;
+import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.options;
+import static io.miret.etienne.gradle.sass.Utils.copy;
+import static io.miret.etienne.gradle.sass.Utils.createArchive;
+import static java.util.Collections.singletonMap;
+
+/**
+ * Test applying this plugin in multiple subprojects
+ * instead of only the root project.
+ */
+@ExtendWith(SoftAssertionsExtension.class)
+public class MultipleApplyTest {
+
+  @TempDir
+  Path projectDir;
+
+  @InjectSoftAssertions
+  private SoftAssertions softly;
+
+  private WireMockServer server;
+
+  @BeforeEach
+  void startAndSetupWiremockServer () throws IOException {
+    server = new WireMockServer(options().dynamicPort());
+    server.start();
+    server.stubFor(get(urlMatching("/42.0/dart-sass-.*"))
+        .willReturn(aResponse()
+            .withStatus(200)
+            .withBody(createArchive())
+        )
+    );
+  }
+
+  @BeforeEach
+  void setupProject() throws IOException {
+    List<String> projectResources = ImmutableList.of(
+        "a/build.gradle",
+        "b/build.gradle",
+        "c/build.gradle",
+        "build.gradle",
+        "settings.gradle"
+    );
+    copy("/io/miret/etienne/gradle/sass/multiple-apply", projectResources, projectDir);
+  }
+
+  @Test
+  void should_not_create_dot_gradle_directories_in_subprojects() {
+    GradleRunner runner = GradleRunner.create();
+    runner.withPluginClasspath();
+    runner.withEnvironment(singletonMap("URL", server.baseUrl()));
+    runner.withArguments("installSass");
+    runner.withProjectDir(projectDir.toFile());
+    runner.build();
+
+    softly.assertThat(projectDir.resolve("a/.gradle")).doesNotExist();
+    softly.assertThat(projectDir.resolve("b/.gradle")).doesNotExist();
+    softly.assertThat(projectDir.resolve("c/.gradle")).doesNotExist();
+  }
+
+}

src/functionalTest/java/io/miret/etienne/gradle/sass/SassGradlePlugin_withWar_FunctionalTest.java

@@ -1,32 +1,26 @@
 package io.miret.etienne.gradle.sass;
 
 import com.github.tomakehurst.wiremock.WireMockServer;
-import com.google.common.io.ByteStreams;
-import org.apache.commons.compress.archivers.tar.TarArchiveEntry;
-import org.apache.commons.compress.archivers.tar.TarArchiveOutputStream;
-import org.apache.tools.ant.taskdefs.condition.Os;
 import org.gradle.testkit.runner.GradleRunner;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
 
-import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.zip.GZIPOutputStream;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipInputStream;
-import java.util.zip.ZipOutputStream;
 
 import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
 import static com.github.tomakehurst.wiremock.client.WireMock.get;
 import static com.github.tomakehurst.wiremock.client.WireMock.urlMatching;
 import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.options;
+import static io.miret.etienne.gradle.sass.Utils.createArchive;
 import static java.util.Collections.singletonMap;
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -142,31 +136,4 @@ void should_not_copy_css_to_war () throws Exception {
     }
   }
 
-  private byte[] createArchive () throws IOException {
-    ByteArrayOutputStream bytes = new ByteArrayOutputStream ();
-    if (Os.isFamily (Os.FAMILY_WINDOWS)) {
-      try (
-          ZipOutputStream zip = new ZipOutputStream (bytes);
-          InputStream sass = SassGradlePlugin_withWar_FunctionalTest.class.getResourceAsStream ("sass.bat")
-      ) {
-        zip.putNextEntry (new ZipEntry ("dart-sass/sass.bat"));
-        ByteStreams.copy (sass, zip);
-      }
-    } else {
-      try (
-          GZIPOutputStream gz = new GZIPOutputStream (bytes);
-          TarArchiveOutputStream tgz = new TarArchiveOutputStream (gz);
-          InputStream sass = SassGradlePlugin_withWar_FunctionalTest.class.getResourceAsStream ("sass.sh")
-      ) {
-        TarArchiveEntry entry = new TarArchiveEntry ("dart-sass/sass");
-        entry.setSize (sass.available ());
-        entry.setMode (0755);
-        tgz.putArchiveEntry (entry);
-        ByteStreams.copy (sass, tgz);
-        tgz.closeArchiveEntry ();
-      }
-    }
-    return bytes.toByteArray ();
-  }
-
 }

src/functionalTest/java/io/miret/etienne/gradle/sass/Utils.java

@@ -0,0 +1,93 @@
+package io.miret.etienne.gradle.sass;
+
+import com.google.common.io.ByteStreams;
+import org.apache.commons.compress.archivers.tar.TarArchiveEntry;
+import org.apache.commons.compress.archivers.tar.TarArchiveOutputStream;
+import org.apache.tools.ant.taskdefs.condition.Os;
+
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.Collection;
+import java.util.Objects;
+import java.util.zip.GZIPOutputStream;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipOutputStream;
+
+public class Utils {
+
+  /**
+   * Copies classpath resources to a directory.
+   * <p>
+   * Each resource will be searched in the classpath from {@code base} and
+   * copied to {@code destination}. That is, for {@code base = "/io/miret/"},
+   * {@code destination = "/var/tmp"} and a {@code foo/bar.txt} resource,
+   * the {@code /io/miret/foo/bar.txt} classpath resource will be copied
+   * to {@code /var/tmp/foo/bar.txt}.
+   * <p>
+   * Intermediate directories will be created as needed.
+   *
+   * @param base base name for the resources, must include the starting '/'.
+   * @param resources the set of file resources to copy, relative to base.
+   * @param destination a path that points to an existing directory.
+   */
+  public static void copy(
+      String base,
+      Collection<String> resources,
+      Path destination
+  ) throws IOException {
+    if (!base.startsWith("/")) {
+      throw new IllegalArgumentException("Base resource name must start with a '/'");
+    }
+    for (String resourceStr : resources) {
+      Path resourcePath = Paths.get(resourceStr);
+      if (resourcePath.isAbsolute()) {
+        throw new IllegalArgumentException("Absolute path provided: " + resourceStr);
+      }
+      Path target = destination.resolve(resourcePath);
+      Files.createDirectories(target.getParent());
+      try (InputStream input = Utils.class.getResourceAsStream(base + "/" + resourceStr)) {
+        Objects.requireNonNull(input, "No such resource: " + resourceStr);
+        Files.copy(input, target);
+      }
+    }
+  }
+
+  /**
+   * Creates an archive with the dummy sass executable from classpath.
+   * On Windows, this is a ZIP archive with {@code sass.bat}.
+   * Elsewhere, this is a gzipped, tar archive with {@code sass.sh}.
+   */
+  public static byte[] createArchive() throws IOException {
+    ByteArrayOutputStream bytes = new ByteArrayOutputStream ();
+    if (Os.isFamily (Os.FAMILY_WINDOWS)) {
+      try (
+          ZipOutputStream zip = new ZipOutputStream (bytes);
+          InputStream sass = SassGradlePlugin_withWar_FunctionalTest.class.getResourceAsStream ("sass.bat")
+      ) {
+        assert sass != null;
+        zip.putNextEntry (new ZipEntry("dart-sass/sass.bat"));
+        ByteStreams.copy (sass, zip);
+      }
+    } else {
+      try (
+          GZIPOutputStream gz = new GZIPOutputStream (bytes);
+          TarArchiveOutputStream tgz = new TarArchiveOutputStream (gz);
+          InputStream sass = SassGradlePlugin_withWar_FunctionalTest.class.getResourceAsStream ("sass.sh")
+      ) {
+        assert sass != null;
+        TarArchiveEntry entry = new TarArchiveEntry ("dart-sass/sass");
+        entry.setSize (sass.available ());
+        entry.setMode (0755);
+        tgz.putArchiveEntry (entry);
+        ByteStreams.copy (sass, tgz);
+        tgz.closeArchiveEntry ();
+      }
+    }
+    return bytes.toByteArray ();
+  }
+
+}

src/functionalTest/resources/io/miret/etienne/gradle/sass/multiple-apply/a/build.gradle

@@ -0,0 +1,8 @@
+plugins {
+  id 'io.miret.etienne.sass'
+}
+
+sass {
+  version = '42.0'
+  baseUrl = System.getenv("URL")
+}

src/functionalTest/resources/io/miret/etienne/gradle/sass/multiple-apply/b/build.gradle

@@ -0,0 +1,8 @@
+plugins {
+  id 'io.miret.etienne.sass'
+}
+
+sass {
+  version = '42.0'
+  baseUrl = System.getenv("URL")
+}

src/functionalTest/resources/io/miret/etienne/gradle/sass/multiple-apply/build.gradle

@@ -0,0 +1,8 @@
+plugins {
+  id 'io.miret.etienne.sass'
+}
+
+sass {
+  version = '42.0'
+  baseUrl = System.getenv("URL")
+}

src/functionalTest/resources/io/miret/etienne/gradle/sass/multiple-apply/c/build.gradle

@@ -0,0 +1,4 @@
+rootProject.name = 'test-multiple-apply'
+include 'a'
+include 'b'
+include 'c'

src/functionalTest/resources/io/miret/etienne/gradle/sass/multiple-apply/settings.gradle

@@ -5,6 +5,7 @@
 import org.gradle.api.Project;
 
 import java.io.File;
+import java.nio.file.Path;
 
 @Getter
 @Setter
@@ -19,10 +20,14 @@ public class SassGradlePluginExtension {
   private boolean autoCopy;
 
   public SassGradlePluginExtension (Project project) {
+    Path projectPath = project.getRootDir()
+        .toPath()
+        .relativize(project.getProjectDir().toPath());
     this.version = "1.54.0";
-    this.directory = project.getProjectDir ()
+    this.directory = project.getRootDir()
         .toPath ()
         .resolve (".gradle/sass")
+        .resolve(projectPath)
         .toFile ();
     this.baseUrl = "https://github.com/sass/dart-sass/releases/download";
     this.autoCopy = true;