Skip to content

Avoid invoking Task.project at execution time in ShadowSource #37246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
noojung wants to merge 1 commit into
base: main
Choose a base branch
from
+51 −66
Open

Avoid invoking Task.project at execution time in ShadowSource #37246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 49 additions & 64 deletions buildSrc/src/main/java/org/springframework/build/shadow/ShadowSource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,54 +18,76 @@

import java.io.File;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Set;

import javax.inject.Inject;

import org.gradle.api.DefaultTask;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.artifacts.component.ModuleComponentSelector;
import org.gradle.api.artifacts.query.ArtifactResolutionQuery;
import org.gradle.api.artifacts.result.ArtifactResolutionResult;
import org.gradle.api.artifacts.result.ComponentArtifactsResult;
import org.gradle.api.artifacts.result.DependencyResult;
import org.gradle.api.artifacts.result.ResolutionResult;
import org.gradle.api.artifacts.result.ResolvedArtifactResult;
import org.gradle.api.attributes.Bundling;
import org.gradle.api.attributes.Category;
import org.gradle.api.attributes.DocsType;
import org.gradle.api.attributes.Usage;
import org.gradle.api.file.ArchiveOperations;
import org.gradle.api.file.ConfigurableFileCollection;
import org.gradle.api.file.DirectoryProperty;
import org.gradle.api.file.FileCollection;
import org.gradle.api.file.FileCopyDetails;
import org.gradle.api.file.FileSystemOperations;
import org.gradle.api.file.FileTree;
import org.gradle.api.tasks.Classpath;
import org.gradle.api.model.ObjectFactory;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.InputFiles;
import org.gradle.api.tasks.Nested;
import org.gradle.api.tasks.Optional;
import org.gradle.api.tasks.OutputDirectory;
import org.gradle.api.tasks.PathSensitive;
import org.gradle.api.tasks.PathSensitivity;
import org.gradle.api.tasks.TaskAction;
import org.gradle.jvm.JvmLibrary;
import org.gradle.language.base.artifact.SourcesArtifact;

/**
* Gradle task to add source from shadowed jars into our own source jars.
*
* @author Phillip Webb
* @author Andy Wilkinson
*/
public class ShadowSource extends DefaultTask {
public abstract class ShadowSource extends DefaultTask {

private final DirectoryProperty outputDirectory = getProject().getObjects().directoryProperty();
private final List<Relocation> relocations = new ArrayList<>();

private List<Configuration> configurations = new ArrayList<>();

private final List<Relocation> relocations = new ArrayList<>();
@InputFiles
@PathSensitive(PathSensitivity.NONE)
public abstract ConfigurableFileCollection getSourceJars();

@OutputDirectory
public abstract DirectoryProperty getOutputDirectory();

@Classpath
@Optional
public List<Configuration> getConfigurations() {
return this.configurations;
}
@Inject
protected abstract FileSystemOperations getFileSystemOperations();

@Inject
protected abstract ArchiveOperations getArchiveOperations();

@Inject
protected abstract ObjectFactory getObjectFactory();

public void setConfigurations(List<Configuration> configurations) {
this.configurations = configurations;
for (Configuration configuration : configurations) {
getSourceJars().from(resolveSourceArtifacts(configuration));
}
}

private FileCollection resolveSourceArtifacts(Configuration configuration) {
ObjectFactory objects = getObjectFactory();
return configuration.getIncoming().artifactView(view -> {
view.withVariantReselection();
view.attributes(attributes -> {
attributes.attribute(Usage.USAGE_ATTRIBUTE, objects.named(Usage.class, Usage.JAVA_RUNTIME));
attributes.attribute(Category.CATEGORY_ATTRIBUTE, objects.named(Category.class, Category.DOCUMENTATION));
attributes.attribute(Bundling.BUNDLING_ATTRIBUTE, objects.named(Bundling.class, Bundling.EXTERNAL));
attributes.attribute(DocsType.DOCS_TYPE_ATTRIBUTE, objects.named(DocsType.class, DocsType.SOURCES));
});
}).getFiles();
}

@Nested
Expand All @@ -77,52 +99,15 @@ public void relocate(String pattern, String destination) {
this.relocations.add(new Relocation(pattern, destination));
}

@OutputDirectory
public DirectoryProperty getOutputDirectory() {
return this.outputDirectory;
}

@TaskAction
void syncSourceJarFiles() {
sync(getSourceJarFiles());
}

private List<File> getSourceJarFiles() {
List<File> sourceJarFiles = new ArrayList<>();
for (Configuration configuration : this.configurations) {
ResolutionResult resolutionResult = configuration.getIncoming().getResolutionResult();
resolutionResult.getRootComponent().get().getDependencies().forEach(dependency -> {
Set<ComponentArtifactsResult> artifactsResults = resolveSourceArtifacts(dependency);
for (ComponentArtifactsResult artifactResult : artifactsResults) {
artifactResult.getArtifacts(SourcesArtifact.class).forEach(sourceArtifact -> {
sourceJarFiles.add(((ResolvedArtifactResult) sourceArtifact).getFile());
});
}
});
}
return Collections.unmodifiableList(sourceJarFiles);
}

private Set<ComponentArtifactsResult> resolveSourceArtifacts(DependencyResult dependency) {
ModuleComponentSelector componentSelector = (ModuleComponentSelector) dependency.getRequested();
ArtifactResolutionQuery query = getProject().getDependencies().createArtifactResolutionQuery()
.forModule(componentSelector.getGroup(), componentSelector.getModule(), componentSelector.getVersion());
return executeQuery(query).getResolvedComponents();
}

@SuppressWarnings("unchecked")
private ArtifactResolutionResult executeQuery(ArtifactResolutionQuery query) {
return query.withArtifacts(JvmLibrary.class, SourcesArtifact.class).execute();
}

private void sync(List<File> sourceJarFiles) {
getProject().sync(spec -> {
spec.into(this.outputDirectory);
getFileSystemOperations().sync(spec -> {
spec.into(getOutputDirectory());
spec.eachFile(this::relocateFile);
spec.filter(this::transformContent);
spec.exclude("META-INF/**");
spec.setIncludeEmptyDirs(false);
sourceJarFiles.forEach(sourceJar -> spec.from(zipTree(sourceJar)));
getSourceJars().forEach(sourceJar -> spec.from(zipTree(sourceJar)));
});
}

Expand All @@ -142,7 +127,7 @@ private String transformContent(String content) {
}

private FileTree zipTree(File sourceJar) {
return getProject().zipTree(sourceJar);
return getArchiveOperations().zipTree(sourceJar);
}


Expand Down
4 changes: 2 additions & 2 deletions spring-core/spring-core.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ tasks.register('objenesisSourceJar', Jar) {
}

dependencies {
javapoet("com.palantir.javapoet:javapoet:${javapoetVersion}@jar")
objenesis("org.objenesis:objenesis:${objenesisVersion}@jar")
javapoet("com.palantir.javapoet:javapoet:${javapoetVersion}") { transitive = false }
objenesis("org.objenesis:objenesis:${objenesisVersion}") { transitive = false }
api(files(javapoetRepackJar))
api(files(objenesisRepackJar))
api("commons-logging:commons-logging")
Expand Down