-
Notifications
You must be signed in to change notification settings - Fork 4.5k
/
IvyPublishPlugin.java
206 lines (184 loc) · 11.8 KB
/
IvyPublishPlugin.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
/*
* Copyright 2012 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
*
* 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 org.gradle.api.publish.ivy.plugins;
import org.gradle.api.NamedDomainObjectFactory;
import org.gradle.api.NamedDomainObjectList;
import org.gradle.api.NamedDomainObjectSet;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.artifacts.repositories.IvyArtifactRepository;
import org.gradle.api.attributes.Usage;
import org.gradle.api.file.DirectoryProperty;
import org.gradle.api.internal.artifacts.Module;
import org.gradle.api.internal.artifacts.configurations.DependencyMetaDataProvider;
import org.gradle.api.internal.file.FileResolver;
import org.gradle.api.model.ObjectFactory;
import org.gradle.api.plugins.ExtensionContainer;
import org.gradle.api.plugins.JavaPlatformPlugin;
import org.gradle.api.plugins.PluginManager;
import org.gradle.api.publish.PublishingExtension;
import org.gradle.api.publish.internal.versionmapping.VersionMappingStrategyInternal;
import org.gradle.api.publish.ivy.IvyArtifact;
import org.gradle.api.publish.ivy.IvyPublication;
import org.gradle.api.publish.ivy.internal.artifact.IvyArtifactNotationParserFactory;
import org.gradle.api.publish.ivy.internal.publication.DefaultIvyPublication;
import org.gradle.api.publish.ivy.internal.publication.DefaultIvyPublicationIdentity;
import org.gradle.api.publish.ivy.internal.publication.IvyPublicationInternal;
import org.gradle.api.publish.ivy.internal.publisher.IvyPublicationIdentity;
import org.gradle.api.publish.ivy.internal.versionmapping.DefaultVersionMappingStrategy;
import org.gradle.api.publish.ivy.tasks.GenerateIvyDescriptor;
import org.gradle.api.publish.ivy.tasks.PublishToIvyRepository;
import org.gradle.api.publish.plugins.PublishingPlugin;
import org.gradle.api.publish.tasks.GenerateModuleMetadata;
import org.gradle.api.tasks.SourceSet;
import org.gradle.api.tasks.SourceSetContainer;
import org.gradle.api.tasks.TaskContainer;
import org.gradle.api.tasks.TaskProvider;
import org.gradle.internal.reflect.Instantiator;
import org.gradle.internal.typeconversion.NotationParser;
import org.gradle.model.Path;
import javax.inject.Inject;
import java.util.Set;
import static org.apache.commons.lang.StringUtils.capitalize;
/**
* Adds the ability to publish in the Ivy format to Ivy repositories.
*
* @since 1.3
*/
public class IvyPublishPlugin implements Plugin<Project> {
private final Instantiator instantiator;
private final ObjectFactory objectFactory;
private final DependencyMetaDataProvider dependencyMetaDataProvider;
private final FileResolver fileResolver;
@Inject
public IvyPublishPlugin(Instantiator instantiator, ObjectFactory objectFactory, DependencyMetaDataProvider dependencyMetaDataProvider, FileResolver fileResolver) {
this.instantiator = instantiator;
this.objectFactory = objectFactory;
this.dependencyMetaDataProvider = dependencyMetaDataProvider;
this.fileResolver = fileResolver;
}
@Override
public void apply(final Project project) {
project.getPluginManager().apply(PublishingPlugin.class);
project.getExtensions().configure(PublishingExtension.class, extension -> {
extension.getPublications().registerFactory(IvyPublication.class, new IvyPublicationFactory(dependencyMetaDataProvider,
instantiator,
objectFactory,
fileResolver,
project.getPluginManager(),
project.getExtensions()
));
createTasksLater(project, extension, project.getLayout().getBuildDirectory());
});
}
private void createTasksLater(final Project project, final PublishingExtension publishingExtension, final DirectoryProperty buildDir) {
final TaskContainer tasks = project.getTasks();
final NamedDomainObjectSet<IvyPublicationInternal> publications = publishingExtension.getPublications().withType(IvyPublicationInternal.class);
final NamedDomainObjectList<IvyArtifactRepository> repositories = publishingExtension.getRepositories().withType(IvyArtifactRepository.class);
repositories.all(repository -> tasks.register(publishAllToSingleRepoTaskName(repository), publish -> {
publish.setDescription("Publishes all Maven publications produced by this project to the " + repository.getName() + " repository.");
publish.setGroup(PublishingPlugin.PUBLISH_TASK_GROUP);
}));
publications.all(publication -> {
final String publicationName = publication.getName();
createGenerateIvyDescriptorTask(tasks, publicationName, publication, buildDir);
createGenerateMetadataTask(tasks, publication, publications, buildDir);
createPublishTaskForEachRepository(tasks, publication, publicationName, repositories);
});
}
private String publishAllToSingleRepoTaskName(IvyArtifactRepository repository) {
return "publishAllPublicationsTo" + capitalize(repository.getName()) + "Repository";
}
private void createPublishTaskForEachRepository(final TaskContainer tasks, final IvyPublicationInternal publication, final String publicationName, NamedDomainObjectList<IvyArtifactRepository> repositories) {
repositories.all(repository -> {
final String repositoryName = repository.getName();
final String publishTaskName = "publish" + capitalize(publicationName) + "PublicationTo" + capitalize(repositoryName) + "Repository";
createPublishToRepositoryTask(tasks, publication, publicationName, repository, repositoryName, publishTaskName);
});
}
private void createPublishToRepositoryTask(TaskContainer tasks, final IvyPublicationInternal publication, final String publicationName, final IvyArtifactRepository repository, final String repositoryName, final String publishTaskName) {
tasks.register(publishTaskName, PublishToIvyRepository.class, publishTask -> {
publishTask.setPublication(publication);
publishTask.setRepository(repository);
publishTask.setGroup(PublishingPlugin.PUBLISH_TASK_GROUP);
publishTask.setDescription("Publishes Ivy publication '" + publicationName + "' to Ivy repository '" + repositoryName + "'.");
});
tasks.named(PublishingPlugin.PUBLISH_LIFECYCLE_TASK_NAME, task -> task.dependsOn(publishTaskName));
tasks.named(publishAllToSingleRepoTaskName(repository), publish -> publish.dependsOn(publishTaskName));
}
private void createGenerateIvyDescriptorTask(TaskContainer tasks, final String publicationName, final IvyPublicationInternal publication, @Path("buildDir") final DirectoryProperty buildDir) {
final String descriptorTaskName = "generateDescriptorFileFor" + capitalize(publicationName) + "Publication";
TaskProvider<GenerateIvyDescriptor> generatorTask = tasks.register(descriptorTaskName, GenerateIvyDescriptor.class, descriptorTask -> {
descriptorTask.setDescription("Generates the Ivy Module Descriptor XML file for publication '" + publicationName + "'.");
descriptorTask.setGroup(PublishingPlugin.PUBLISH_TASK_GROUP);
descriptorTask.setDescriptor(publication.getDescriptor());
if (descriptorTask.getDestination() == null) {
descriptorTask.setDestination(buildDir.file("publications/" + publicationName + "/ivy.xml"));
}
});
publication.setIvyDescriptorGenerator(generatorTask);
}
private void createGenerateMetadataTask(final TaskContainer tasks, final IvyPublicationInternal publication, final Set<IvyPublicationInternal> publications, final DirectoryProperty buildDir) {
final String publicationName = publication.getName();
String descriptorTaskName = "generateMetadataFileFor" + capitalize(publicationName) + "Publication";
TaskProvider<GenerateModuleMetadata> generatorTask = tasks.register(descriptorTaskName, GenerateModuleMetadata.class, generateTask -> {
generateTask.setDescription("Generates the Gradle metadata file for publication '" + publicationName + "'.");
generateTask.setGroup(PublishingPlugin.PUBLISH_TASK_GROUP);
generateTask.getPublication().set(publication);
generateTask.getPublications().set(publications);
generateTask.getOutputFile().convention(buildDir.file("publications/" + publicationName + "/module.json"));
});
publication.setModuleDescriptorGenerator(generatorTask);
}
private static class IvyPublicationFactory implements NamedDomainObjectFactory<IvyPublication> {
private final Instantiator instantiator;
private final DependencyMetaDataProvider dependencyMetaDataProvider;
private final ObjectFactory objectFactory;
private final FileResolver fileResolver;
private final PluginManager plugins;
private final ExtensionContainer extensionContainer;
private IvyPublicationFactory(DependencyMetaDataProvider dependencyMetaDataProvider, Instantiator instantiator, ObjectFactory objectFactory, FileResolver fileResolver,
PluginManager plugins, ExtensionContainer extensionContainer) {
this.dependencyMetaDataProvider = dependencyMetaDataProvider;
this.instantiator = instantiator;
this.objectFactory = objectFactory;
this.fileResolver = fileResolver;
this.plugins = plugins;
this.extensionContainer = extensionContainer;
}
@Override
public IvyPublication create(String name) {
Module module = dependencyMetaDataProvider.getModule();
IvyPublicationIdentity publicationIdentity = new DefaultIvyPublicationIdentity(module);
NotationParser<Object, IvyArtifact> notationParser = new IvyArtifactNotationParserFactory(instantiator, fileResolver, publicationIdentity).create();
VersionMappingStrategyInternal versionMappingStrategy = objectFactory.newInstance(DefaultVersionMappingStrategy.class);
configureDefaultConfigurationsUsedWhenMappingToResolvedVersions(versionMappingStrategy);
return objectFactory.newInstance(DefaultIvyPublication.class, name, publicationIdentity, notationParser, versionMappingStrategy);
}
private void configureDefaultConfigurationsUsedWhenMappingToResolvedVersions(VersionMappingStrategyInternal versionMappingStrategy) {
plugins.withPlugin("org.gradle.java", plugin -> {
SourceSet mainSourceSet = extensionContainer.getByType(SourceSetContainer.class).getByName(SourceSet.MAIN_SOURCE_SET_NAME);
// setup the default configurations used when mapping to resolved versions
versionMappingStrategy.defaultResolutionConfiguration(Usage.JAVA_API, mainSourceSet.getCompileClasspathConfigurationName());
versionMappingStrategy.defaultResolutionConfiguration(Usage.JAVA_RUNTIME, mainSourceSet.getRuntimeClasspathConfigurationName());
});
plugins.withPlugin("org.gradle.java-platform", plugin -> {
versionMappingStrategy.defaultResolutionConfiguration(Usage.JAVA_API, JavaPlatformPlugin.CLASSPATH_CONFIGURATION_NAME);
versionMappingStrategy.defaultResolutionConfiguration(Usage.JAVA_RUNTIME, JavaPlatformPlugin.CLASSPATH_CONFIGURATION_NAME);
});
}
}
}