Andy Wilkinson
4 years ago
commit
fa1d4a4d1d
@ -0,0 +1,52 @@
|
||||
/*
|
||||
* 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.gradle.plugin;
|
||||
|
||||
import java.io.File;
|
||||
import java.util.Collections;
|
||||
import java.util.Set;
|
||||
import java.util.jar.JarFile;
|
||||
|
||||
import org.gradle.api.file.FileCollection;
|
||||
import org.gradle.api.specs.Spec;
|
||||
|
||||
/**
|
||||
* A {@link Spec} for {@link FileCollection#filter(Spec) filtering} {@code FileCollection}
|
||||
* to remove jar files based on their {@code Spring-Boot-Jar-Type} as defined in the
|
||||
* manifest. Jars of type {@code dependencies-starter} are excluded.
|
||||
*
|
||||
* @author Andy Wilkinson
|
||||
*/
|
||||
class JarTypeFileSpec implements Spec<File> {
|
||||
|
||||
private static final Set<String> EXCLUDED_JAR_TYPES = Collections.singleton("dependencies-starter");
|
||||
|
||||
@Override
|
||||
public boolean isSatisfiedBy(File file) {
|
||||
try (JarFile jar = new JarFile(file)) {
|
||||
String jarType = jar.getManifest().getMainAttributes().getValue("Spring-Boot-Jar-Type");
|
||||
if (jarType != null && EXCLUDED_JAR_TYPES.contains(jarType)) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
catch (Exception ex) {
|
||||
// Continue
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,25 @@
|
||||
plugins {
|
||||
id 'java'
|
||||
id 'org.springframework.boot' version '{version}'
|
||||
}
|
||||
|
||||
bootJar {
|
||||
mainClassName = 'com.example.Application'
|
||||
}
|
||||
|
||||
repositories {
|
||||
flatDir {
|
||||
dirs 'repository'
|
||||
}
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation(name: "standard")
|
||||
implementation(name: "starter")
|
||||
}
|
||||
|
||||
bootJar {
|
||||
layered {
|
||||
enabled = false
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,19 @@
|
||||
plugins {
|
||||
id 'war'
|
||||
id 'org.springframework.boot' version '{version}'
|
||||
}
|
||||
|
||||
bootWar {
|
||||
mainClassName = 'com.example.Application'
|
||||
}
|
||||
|
||||
repositories {
|
||||
flatDir {
|
||||
dirs 'repository'
|
||||
}
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation(name: "standard")
|
||||
implementation(name: "starter")
|
||||
}
|
||||
@ -0,0 +1,15 @@
|
||||
plugins {
|
||||
id 'java'
|
||||
id 'org.springframework.boot' version '{version}'
|
||||
}
|
||||
|
||||
repositories {
|
||||
flatDir {
|
||||
dirs 'repository'
|
||||
}
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation(name: "standard")
|
||||
implementation(name: "starter")
|
||||
}
|
||||
@ -0,0 +1,54 @@
|
||||
/*
|
||||
* 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.IOException;
|
||||
import java.util.Arrays;
|
||||
import java.util.Collections;
|
||||
import java.util.HashSet;
|
||||
import java.util.Set;
|
||||
import java.util.jar.JarFile;
|
||||
|
||||
import org.apache.maven.artifact.Artifact;
|
||||
|
||||
/**
|
||||
* A {@link DependencyFilter} that filters dependencies based on the jar type declared in
|
||||
* their manifest.
|
||||
*
|
||||
* @author Andy Wilkinson
|
||||
*/
|
||||
class JarTypeFilter extends DependencyFilter {
|
||||
|
||||
private static final Set<String> EXCLUDED_JAR_TYPES = Collections
|
||||
.unmodifiableSet(new HashSet<>(Arrays.asList("annotation-processor", "dependencies-starter")));
|
||||
|
||||
JarTypeFilter() {
|
||||
super(Collections.emptyList());
|
||||
}
|
||||
|
||||
@Override
|
||||
protected boolean filter(Artifact artifact) {
|
||||
try (JarFile jarFile = new JarFile(artifact.getFile())) {
|
||||
String jarType = jarFile.getManifest().getMainAttributes().getValue("Spring-Boot-Jar-Type");
|
||||
return jarType != null && EXCLUDED_JAR_TYPES.contains(jarType);
|
||||
}
|
||||
catch (IOException ex) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@ -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;
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue