Exclude by jar type when running and packaging with Maven

This commit updates the Maven Plugin to filter dependencies based on
the Spring-Boot-Jar-Type entry in their manifest. Jars with a
Spring-Boot-Jar-Type of dependencies-starter or annotation-processor
are excluded.

See gh-22036

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/test/java/org/springframework/boot/maven/DependencyFilterMojoTests.java

@@ -16,17 +16,25 @@
 
 package org.springframework.boot.maven;
 
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.nio.file.Path;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Set;
+import java.util.UUID;
+import java.util.jar.JarOutputStream;
+import java.util.jar.Manifest;
 
 import org.apache.maven.artifact.Artifact;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter;
 import org.apache.maven.shared.artifact.filter.collection.ScopeFilter;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.BDDMockito.given;
@@ -39,6 +47,9 @@ import static org.mockito.Mockito.mock;
  */
 class DependencyFilterMojoTests {
 
+	@TempDir
+	static Path temp;
+
 	@Test
 	void filterDependencies() throws MojoExecutionException {
 		TestableDependencyFilterMojo mojo = new TestableDependencyFilterMojo(Collections.emptyList(), "com.foo");
@@ -97,20 +108,50 @@ class DependencyFilterMojoTests {
 		assertThat(artifacts).containsExactly(one, three, four);
 	}
 
+	@Test
+	void excludeByJarType() throws MojoExecutionException {
+		TestableDependencyFilterMojo mojo = new TestableDependencyFilterMojo(Collections.emptyList(), "");
+		Artifact one = createArtifact("com.foo", "one", null, "dependencies-starter");
+		Artifact two = createArtifact("com.bar", "two");
+		Set<Artifact> artifacts = mojo.filterDependencies(one, two);
+		assertThat(artifacts).containsExactly(two);
+	}
+
 	private static Artifact createArtifact(String groupId, String artifactId) {
 		return createArtifact(groupId, artifactId, null);
 	}
 
 	private static Artifact createArtifact(String groupId, String artifactId, String scope) {
+		return createArtifact(groupId, artifactId, scope, null);
+	}
+
+	private static Artifact createArtifact(String groupId, String artifactId, String scope, String jarType) {
 		Artifact a = mock(Artifact.class);
 		given(a.getGroupId()).willReturn(groupId);
 		given(a.getArtifactId()).willReturn(artifactId);
 		if (scope != null) {
 			given(a.getScope()).willReturn(scope);
 		}
+		given(a.getFile()).willReturn(createArtifactFile(jarType));
 		return a;
 	}
 
+	private static File createArtifactFile(String jarType) {
+		Path jarPath = temp.resolve(UUID.randomUUID().toString() + ".jar");
+		Manifest manifest = new Manifest();
+		manifest.getMainAttributes().putValue("Manifest-Version", "1.0");
+		if (jarType != null) {
+			manifest.getMainAttributes().putValue("Spring-Boot-Jar-Type", jarType);
+		}
+		try {
+			new JarOutputStream(new FileOutputStream(jarPath.toFile()), manifest).close();
+		}
+		catch (IOException ex) {
+			throw new RuntimeException(ex);
+		}
+		return jarPath.toFile();
+	}
+
 	private static final class TestableDependencyFilterMojo extends AbstractDependencyFilterMojo {
 
 		private final ArtifactsFilter[] additionalFilters;

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/test/java/org/springframework/boot/maven/JarTypeFilterTests.java

@@ -0,0 +1,81 @@
+/*
+ * Copyright 2012-2020 the original author or authors.
+ *
+ * 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
+ *
+ *      https://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 org.springframework.boot.maven;
+
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.nio.file.Path;
+import java.util.jar.JarOutputStream;
+import java.util.jar.Manifest;
+
+import org.apache.maven.artifact.Artifact;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.BDDMockito.given;
+import static org.mockito.Mockito.mock;
+
+/**
+ * Tests for {@link JarTypeFilter}.
+ *
+ * @author Andy Wilkinson
+ */
+class JarTypeFilterTests {
+
+	@TempDir
+	Path temp;
+
+	@Test
+	void whenArtifactHasNoJarTypeThenItIsIncluded() {
+		assertThat(new JarTypeFilter().filter(createArtifact(null))).isFalse();
+	}
+
+	@Test
+	void whenArtifactHasJarTypeThatIsNotExcludedThenItIsIncluded() {
+		assertThat(new JarTypeFilter().filter(createArtifact("something-included"))).isFalse();
+	}
+
+	@Test
+	void whenArtifactHasDependenciesStarterJarTypeThenItIsExcluded() {
+		assertThat(new JarTypeFilter().filter(createArtifact("dependencies-starter"))).isTrue();
+	}
+
+	@Test
+	void whenArtifactHasAnnotationProcessorJarTypeThenItIsExcluded() {
+		assertThat(new JarTypeFilter().filter(createArtifact("annotation-processor"))).isTrue();
+	}
+
+	private Artifact createArtifact(String jarType) {
+		Path jarPath = this.temp.resolve("test.jar");
+		Manifest manifest = new Manifest();
+		manifest.getMainAttributes().putValue("Manifest-Version", "1.0");
+		if (jarType != null) {
+			manifest.getMainAttributes().putValue("Spring-Boot-Jar-Type", jarType);
+		}
+		try {
+			new JarOutputStream(new FileOutputStream(jarPath.toFile()), manifest).close();
+		}
+		catch (IOException ex) {
+			throw new RuntimeException(ex);
+		}
+		Artifact artifact = mock(Artifact.class);
+		given(artifact.getFile()).willReturn(jarPath.toFile());
+		return artifact;
+	}
+
+}