Configurable gradle configurations (#3034)

cromefire · web-flow · commit 14dc2fae61f8 · 2021-03-01T15:48:24.000-05:00
diff --git a/jib-core/src/integration-test/java/com/google/cloud/tools/jib/api/ContainerizerIntegrationTest.java b/jib-core/src/integration-test/java/com/google/cloud/tools/jib/api/ContainerizerIntegrationTest.java
@@ -96,7 +96,7 @@ public static void setUp() throws URISyntaxException, IOException {
 
   /**
    * Lists the files in the {@code resourcePath} resources directory and builds a {@link
-   * LayerConfiguration} from those files.
+   * FileEntriesLayer} from those files.
    */
   private static FileEntriesLayer makeLayerConfiguration(
       String resourcePath, String pathInContainer) throws URISyntaxException, IOException {
diff --git a/jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/BuildDockerTask.java b/jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/BuildDockerTask.java
@@ -106,7 +106,11 @@ public void buildDocker()
     TempDirectoryProvider tempDirectoryProvider = new TempDirectoryProvider();
 
     GradleProjectProperties projectProperties =
-        GradleProjectProperties.getForProject(getProject(), getLogger(), tempDirectoryProvider);
+        GradleProjectProperties.getForProject(
+            getProject(),
+            getLogger(),
+            tempDirectoryProvider,
+            jibExtension.getConfigurationName().get());
     GlobalConfig globalConfig = GlobalConfig.readConfig();
     Future<Optional<String>> updateCheckFuture =
         TaskCommon.newUpdateChecker(projectProperties, globalConfig, getLogger());
diff --git a/jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/BuildImageTask.java b/jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/BuildImageTask.java
@@ -94,7 +94,11 @@ public void buildImage()
     TempDirectoryProvider tempDirectoryProvider = new TempDirectoryProvider();
 
     GradleProjectProperties projectProperties =
-        GradleProjectProperties.getForProject(getProject(), getLogger(), tempDirectoryProvider);
+        GradleProjectProperties.getForProject(
+            getProject(),
+            getLogger(),
+            tempDirectoryProvider,
+            jibExtension.getConfigurationName().get());
     GlobalConfig globalConfig = GlobalConfig.readConfig();
     Future<Optional<String>> updateCheckFuture =
         TaskCommon.newUpdateChecker(projectProperties, globalConfig, getLogger());
diff --git a/jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/BuildTarTask.java b/jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/BuildTarTask.java
@@ -95,7 +95,8 @@ public FileCollection getInputFiles() {
             .stream()
             .map(ExtraDirectoryParameters::getFrom)
             .collect(Collectors.toList());
-    return GradleProjectProperties.getInputFiles(getProject(), extraDirectories);
+    return GradleProjectProperties.getInputFiles(
+        getProject(), extraDirectories, jibExtension.getConfigurationName().get());
   }
 
   /**
@@ -127,7 +128,11 @@ public void buildTar()
     TempDirectoryProvider tempDirectoryProvider = new TempDirectoryProvider();
 
     GradleProjectProperties projectProperties =
-        GradleProjectProperties.getForProject(getProject(), getLogger(), tempDirectoryProvider);
+        GradleProjectProperties.getForProject(
+            getProject(),
+            getLogger(),
+            tempDirectoryProvider,
+            jibExtension.getConfigurationName().get());
     GlobalConfig globalConfig = GlobalConfig.readConfig();
     Future<Optional<String>> updateCheckFuture =
         TaskCommon.newUpdateChecker(projectProperties, globalConfig, getLogger());
diff --git a/jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/GradleProjectProperties.java b/jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/GradleProjectProperties.java
@@ -70,7 +70,6 @@
 import org.gradle.api.artifacts.component.ProjectComponentIdentifier;
 import org.gradle.api.file.FileCollection;
 import org.gradle.api.logging.Logger;
-import org.gradle.api.plugins.JavaPlugin;
 import org.gradle.api.plugins.JavaPluginConvention;
 import org.gradle.api.plugins.WarPlugin;
 import org.gradle.api.tasks.SourceSet;
@@ -104,10 +103,15 @@ public class GradleProjectProperties implements ProjectProperties {
    * @param project a gradle project
    * @param logger a gradle logging instance to use for logging during the build
    * @param tempDirectoryProvider for scratch space during the build
+   * @param configurationName the configuration of which the dependencies should be packed into the
+   *     container
    * @return a GradleProjectProperties instance to use in a jib build
    */
   public static GradleProjectProperties getForProject(
-      Project project, Logger logger, TempDirectoryProvider tempDirectoryProvider) {
+      Project project,
+      Logger logger,
+      TempDirectoryProvider tempDirectoryProvider,
+      String configurationName) {
     Supplier<List<JibGradlePluginExtension<?>>> extensionLoader =
         () -> {
           List<JibGradlePluginExtension<?>> extensions = new ArrayList<>();
@@ -117,7 +121,8 @@ public static GradleProjectProperties getForProject(
           }
           return extensions;
         };
-    return new GradleProjectProperties(project, logger, tempDirectoryProvider, extensionLoader);
+    return new GradleProjectProperties(
+        project, logger, tempDirectoryProvider, extensionLoader, configurationName);
   }
 
   String getWarFilePath() {
@@ -155,16 +160,19 @@ private static boolean isProgressFooterEnabled(Project project) {
   private final ConsoleLogger consoleLogger;
   private final TempDirectoryProvider tempDirectoryProvider;
   private final Supplier<List<JibGradlePluginExtension<?>>> extensionLoader;
+  private final String configurationName;
 
   @VisibleForTesting
   GradleProjectProperties(
       Project project,
       Logger logger,
       TempDirectoryProvider tempDirectoryProvider,
-      Supplier<List<JibGradlePluginExtension<?>>> extensionLoader) {
+      Supplier<List<JibGradlePluginExtension<?>>> extensionLoader,
+      String configurationName) {
     this.project = project;
     this.tempDirectoryProvider = tempDirectoryProvider;
     this.extensionLoader = extensionLoader;
+    this.configurationName = configurationName;
     ConsoleLoggerBuilder consoleLoggerBuilder =
         (isProgressFooterEnabled(project)
                 ? ConsoleLoggerBuilder.rich(singleThreadedExecutor, false)
@@ -193,7 +201,7 @@ public JibContainerBuilder createJibContainerBuilder(
           project.files(
               project
                   .getConfigurations()
-                  .getByName(JavaPlugin.RUNTIME_CLASSPATH_CONFIGURATION_NAME)
+                  .getByName(configurationName)
                   .getResolvedConfiguration()
                   .getResolvedArtifacts()
                   .stream()
@@ -219,7 +227,8 @@ public JibContainerBuilder createJibContainerBuilder(
       FileCollection classesOutputDirectories =
           mainSourceSet.getOutput().getClassesDirs().filter(File::exists);
       Path resourcesOutputDirectory = mainSourceSet.getOutput().getResourcesDir().toPath();
-      FileCollection allFiles = mainSourceSet.getRuntimeClasspath().filter(File::exists);
+      FileCollection allFiles =
+          project.getConfigurations().getByName(configurationName).filter(File::exists);
 
       FileCollection nonProjectDependencies =
           allFiles
@@ -298,7 +307,7 @@ public List<Path> getClassFiles() throws IOException {
   @Override
   public List<Path> getDependencies() {
     List<Path> dependencies = new ArrayList<>();
-    FileCollection runtimeClasspath = getMainSourceSet().getRuntimeClasspath();
+    FileCollection runtimeClasspath = project.getConfigurations().getByName(configurationName);
     // To be on the safe side with the order, calling "forEach" first (no filtering operations).
     runtimeClasspath.forEach(
         file -> {
@@ -387,12 +396,10 @@ public boolean isWarProject() {
    * @param extraDirectories the image's configured extra directories
    * @return the input files
    */
-  static FileCollection getInputFiles(Project project, List<Path> extraDirectories) {
-    JavaPluginConvention javaPluginConvention =
-        project.getConvention().getPlugin(JavaPluginConvention.class);
-    SourceSet mainSourceSet = javaPluginConvention.getSourceSets().getByName(MAIN_SOURCE_SET_NAME);
+  static FileCollection getInputFiles(
+      Project project, List<Path> extraDirectories, String configurationName) {
     List<FileCollection> dependencyFileCollections = new ArrayList<>();
-    dependencyFileCollections.add(mainSourceSet.getRuntimeClasspath());
+    dependencyFileCollections.add(project.getConfigurations().getByName(configurationName));
 
     extraDirectories
         .stream()
diff --git a/jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/JibExtension.java b/jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/JibExtension.java
@@ -21,6 +21,7 @@
 import org.gradle.api.Action;
 import org.gradle.api.Project;
 import org.gradle.api.model.ObjectFactory;
+import org.gradle.api.plugins.JavaPlugin;
 import org.gradle.api.provider.ListProperty;
 import org.gradle.api.provider.Property;
 import org.gradle.api.tasks.Input;
@@ -94,6 +95,7 @@ public class JibExtension {
   private final SkaffoldParameters skaffold;
   private final Property<Boolean> allowInsecureRegistries;
   private final Property<String> containerizingMode;
+  private final Property<String> configurationName;
   private final ListProperty<ExtensionParameters> pluginExtensions;
   private final ExtensionParametersSpec extensionParametersSpec;
 
@@ -118,6 +120,10 @@ public JibExtension(Project project) {
         objectFactory.newInstance(ExtensionParametersSpec.class, pluginExtensions);
     allowInsecureRegistries = objectFactory.property(Boolean.class);
     containerizingMode = objectFactory.property(String.class);
+    configurationName =
+        objectFactory
+            .property(String.class)
+            .convention(JavaPlugin.RUNTIME_CLASSPATH_CONFIGURATION_NAME);
 
     // Sets defaults.
     allowInsecureRegistries.set(DEFAULT_ALLOW_INSECURE_REGISTIRIES);
@@ -221,6 +227,22 @@ public String getContainerizingMode() {
     return property != null ? property : containerizingMode.get();
   }
 
+  /**
+   * Returns the configurationName property while setting it to the value of the system property if
+   * present.
+   *
+   * @return The configurationName property
+   */
+  @Input
+  @Optional
+  public Property<String> getConfigurationName() {
+    String property = System.getProperty(PropertyNames.CONFIGURATION_NAME);
+    if (property != null) {
+      configurationName.set(property);
+    }
+    return configurationName;
+  }
+
   @Nested
   @Optional
   public ListProperty<ExtensionParameters> getPluginExtensions() {
diff --git a/jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/JibPlugin.java b/jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/JibPlugin.java
@@ -183,12 +183,16 @@ public void apply(Project project) {
           }
 
           SourceSet mainSourceSet =
-              project
+              projectAfterEvaluation
                   .getConvention()
                   .getPlugin(JavaPluginConvention.class)
                   .getSourceSets()
                   .getByName(SourceSet.MAIN_SOURCE_SET_NAME);
           jibDependencies.add(mainSourceSet.getRuntimeClasspath());
+          jibDependencies.add(
+              projectAfterEvaluation
+                  .getConfigurations()
+                  .getByName(jibExtension.getConfigurationName().get()));
 
           Set<TaskProvider<?>> jibTaskProviders =
               ImmutableSet.of(buildImageTask, buildDockerTask, buildTarTask, syncMapTask);
diff --git a/jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/skaffold/FilesTaskV2.java b/jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/skaffold/FilesTaskV2.java
@@ -38,7 +38,6 @@
 import org.gradle.api.artifacts.ProjectDependency;
 import org.gradle.api.artifacts.PublishArtifact;
 import org.gradle.api.initialization.Settings;
-import org.gradle.api.plugins.JavaPlugin;
 import org.gradle.api.plugins.JavaPluginConvention;
 import org.gradle.api.tasks.SourceSet;
 import org.gradle.api.tasks.TaskAction;
@@ -110,7 +109,7 @@ public void listFiles() throws IOException {
 
     // Add SNAPSHOT, non-project dependency jars
     for (File file :
-        project.getConfigurations().getByName(JavaPlugin.RUNTIME_CLASSPATH_CONFIGURATION_NAME)) {
+        project.getConfigurations().getByName(jibExtension.getConfigurationName().get())) {
       if (!projectDependencyJars.contains(file) && file.toString().contains("SNAPSHOT")) {
         skaffoldFilesOutput.addInput(file.toPath());
         projectDependencyJars.add(file); // Add to set to avoid printing the same files twice
@@ -192,18 +191,20 @@ private void addProjectFiles(Project project) {
    * @return the set of project dependencies
    */
   private Set<ProjectDependency> findProjectDependencies(Project project) {
+    Preconditions.checkNotNull(jibExtension);
+
     Set<ProjectDependency> projectDependencies = new HashSet<>();
     Deque<Project> projects = new ArrayDeque<>();
     projects.push(project);
 
+    String configurationName = jibExtension.getConfigurationName().get();
+
     while (!projects.isEmpty()) {
       Project currentProject = projects.pop();
 
       // Search through all dependencies
       Configuration runtimeClasspath =
-          currentProject
-              .getConfigurations()
-              .findByName(JavaPlugin.RUNTIME_CLASSPATH_CONFIGURATION_NAME);
+          currentProject.getConfigurations().findByName(configurationName);
       if (runtimeClasspath != null) {
         for (Configuration configuration : runtimeClasspath.getHierarchy()) {
           for (Dependency dependency : configuration.getDependencies()) {
diff --git a/jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/skaffold/SyncMapTask.java b/jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/skaffold/SyncMapTask.java
@@ -51,7 +51,11 @@ public void listFilesAndTargets() {
 
     try (TempDirectoryProvider tempDirectoryProvider = new TempDirectoryProvider()) {
       GradleProjectProperties projectProperties =
-          GradleProjectProperties.getForProject(getProject(), getLogger(), tempDirectoryProvider);
+          GradleProjectProperties.getForProject(
+              getProject(),
+              getLogger(),
+              tempDirectoryProvider,
+              jibExtension.getConfigurationName().get());
 
       GradleRawConfiguration configuration = new GradleRawConfiguration(jibExtension);
 
diff --git a/jib-gradle-plugin/src/test/java/com/google/cloud/tools/jib/gradle/GradleProjectPropertiesExtensionTest.java b/jib-gradle-plugin/src/test/java/com/google/cloud/tools/jib/gradle/GradleProjectPropertiesExtensionTest.java
@@ -39,6 +39,7 @@
 import org.gradle.api.logging.Logger;
 import org.gradle.api.logging.configuration.ConsoleOutput;
 import org.gradle.api.model.ObjectFactory;
+import org.gradle.api.plugins.JavaPlugin;
 import org.hamcrest.CoreMatchers;
 import org.hamcrest.MatcherAssert;
 import org.junit.Assert;
@@ -233,7 +234,11 @@ public void setUp() {
 
     gradleProjectProperties =
         new GradleProjectProperties(
-            mockProject, mockLogger, mockTempDirectoryProvider, () -> loadedExtensions);
+            mockProject,
+            mockLogger,
+            mockTempDirectoryProvider,
+            () -> loadedExtensions,
+            JavaPlugin.RUNTIME_CLASSPATH_CONFIGURATION_NAME);
   }
 
   @Test
diff --git a/jib-gradle-plugin/src/test/java/com/google/cloud/tools/jib/gradle/GradleProjectPropertiesTest.java b/jib-gradle-plugin/src/test/java/com/google/cloud/tools/jib/gradle/GradleProjectPropertiesTest.java
@@ -64,6 +64,7 @@
 import org.gradle.api.artifacts.dsl.DependencyHandler;
 import org.gradle.api.java.archives.internal.DefaultManifest;
 import org.gradle.api.logging.Logger;
+import org.gradle.api.plugins.JavaPlugin;
 import org.gradle.api.plugins.JavaPluginConvention;
 import org.gradle.api.tasks.bundling.War;
 import org.gradle.jvm.tasks.Jar;
@@ -158,7 +159,11 @@ public void setUp() throws URISyntaxException, IOException {
 
     gradleProjectProperties =
         new GradleProjectProperties(
-            project, mockLogger, mockTempDirectoryProvider, mockExtensionLoader);
+            project,
+            mockLogger,
+            mockTempDirectoryProvider,
+            mockExtensionLoader,
+            JavaPlugin.RUNTIME_CLASSPATH_CONFIGURATION_NAME);
   }
 
   @Test
@@ -284,7 +289,11 @@ public void testCreateContainerBuilder_noClassesFiles()
 
     gradleProjectProperties =
         new GradleProjectProperties(
-            project, mockLogger, mockTempDirectoryProvider, mockExtensionLoader);
+            project,
+            mockLogger,
+            mockTempDirectoryProvider,
+            mockExtensionLoader,
+            JavaPlugin.RUNTIME_CLASSPATH_CONFIGURATION_NAME);
 
     gradleProjectProperties.createJibContainerBuilder(
         JavaContainerBuilder.from(RegistryImage.named("base")), ContainerizingMode.EXPLODED);
diff --git a/jib-plugins-common/src/main/java/com/google/cloud/tools/jib/plugins/common/PropertyNames.java b/jib-plugins-common/src/main/java/com/google/cloud/tools/jib/plugins/common/PropertyNames.java
@@ -57,6 +57,7 @@ public class PropertyNames {
   public static final String OUTPUT_PATHS_IMAGE_JSON = "jib.outputPaths.imageJson";
   public static final String OUTPUT_PATHS_TAR = "jib.outputPaths.tar";
   public static final String CONTAINERIZING_MODE = "jib.containerizingMode";
+  public static final String CONFIGURATION_NAME = "jib.configurationName";
   public static final String SKIP = "jib.skip";
 
   public static final String CONTAINERIZE = "jib.containerize";
