com.google.cloud.tools.jib.maven.extension.springboot.JibSpringBootExtension Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2020 Google LLC.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.cloud.tools.jib.maven.extension.springboot;

import com.google.cloud.tools.jib.api.JavaContainerBuilder;
import com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan;
import com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer;
import com.google.cloud.tools.jib.api.buildplan.FileEntry;
import com.google.cloud.tools.jib.api.buildplan.LayerObject;
import com.google.cloud.tools.jib.maven.extension.JibMavenPluginExtension;
import com.google.cloud.tools.jib.maven.extension.MavenData;
import com.google.cloud.tools.jib.plugins.extension.ExtensionLogger;
import com.google.cloud.tools.jib.plugins.extension.ExtensionLogger.LogLevel;
import com.google.cloud.tools.jib.plugins.extension.JibPluginExtensionException;
import com.google.common.annotations.VisibleForTesting;
import java.io.File;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.function.Predicate;
import java.util.stream.Collectors;
import org.apache.maven.model.Plugin;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.util.xml.Xpp3Dom;

public class JibSpringBootExtension implements JibMavenPluginExtension {

  @Override
  public Optional> getExtraConfigType() {
    return Optional.empty();
  }

  @Override
  public ContainerBuildPlan extendContainerBuildPlan(
      ContainerBuildPlan buildPlan,
      Map properties,
      Optional config,
      MavenData mavenData,
      ExtensionLogger logger)
      throws JibPluginExtensionException {
    logger.log(LogLevel.LIFECYCLE, "Running Jib Spring Boot extension");

    if (!shouldExcludeDevtools(mavenData.getMavenProject(), logger)) {
      logger.log(LogLevel.INFO, "Keeping spring-boot-devtools (if any)");
      return buildPlan;
    }
    logger.log(LogLevel.INFO, "Removing spring-boot-devtools (if any)");

    List newLayers =
        buildPlan
            .getLayers()
            .stream()
            .map(JibSpringBootExtension::filterOutDevtools)
            .collect(Collectors.toList());
    return buildPlan.toBuilder().setLayers(newLayers).build();
  }

  @VisibleForTesting
  static boolean isDevtoolsJar(File file) {
    return file.getName().startsWith("spring-boot-devtools-") && file.getName().endsWith(".jar");
  }

  @VisibleForTesting
  static boolean shouldExcludeDevtools(MavenProject project, ExtensionLogger logger) {
    Plugin bootPlugin = project.getPlugin("org.springframework.boot:spring-boot-maven-plugin");
    if (bootPlugin == null) {
      logger.log(
          LogLevel.WARN,
          "Jib Spring Boot extension: project doesn't have spring-boot-maven-plugin?");
      return true;
    }

    Xpp3Dom configuration = (Xpp3Dom) bootPlugin.getConfiguration();
    if (configuration != null) {
      Xpp3Dom excludeDevtools = configuration.getChild("excludeDevtools");
      if (excludeDevtools != null) {
        return "true".equalsIgnoreCase(excludeDevtools.getValue());
      }
    }
    return true; // Spring Boot's  default is true.
  }

  @VisibleForTesting
  static LayerObject filterOutDevtools(LayerObject layerObject) {
    String dependencyLayerName = JavaContainerBuilder.LayerType.DEPENDENCIES.getName();
    if (!dependencyLayerName.equals(layerObject.getName())) {
      return layerObject;
    }

    FileEntriesLayer layer = (FileEntriesLayer) layerObject;
    Predicate notDevtoolsJar =
        fileEntry -> !isDevtoolsJar(fileEntry.getSourceFile().toFile());
    List newEntries =
        layer.getEntries().stream().filter(notDevtoolsJar).collect(Collectors.toList());
    return layer.toBuilder().setEntries(newEntries).build();
  }
}