Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[JENKINS-46785] Strategy to enable / disable publishers in pipelines
- Loading branch information
Showing
9 changed files
with
275 additions
and
145 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
197 changes: 197 additions & 0 deletions
197
...ins-plugin/src/main/java/org/jenkinsci/plugins/pipeline/maven/MavenPublisherStrategy.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,197 @@ | ||
| package org.jenkinsci.plugins.pipeline.maven; | ||
|
|
||
| import hudson.DescriptorExtensionList; | ||
| import hudson.model.Descriptor; | ||
| import hudson.model.TaskListener; | ||
| import jenkins.model.Jenkins; | ||
|
|
||
| import java.io.PrintWriter; | ||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
|
|
||
| import javax.annotation.Nonnull; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** | ||
| * @author <a href="mailto:cleclerc@cloudbees.com">Cyrille Le Clerc</a> | ||
| */ | ||
| public enum MavenPublisherStrategy { | ||
|
|
||
| IMPLICIT("Implicit") { | ||
| /** | ||
| * <p>Build the list of {@link MavenPublisher}s that should be invoked for the build execution of the given {@link TaskListener} | ||
| * with the desired configuration. | ||
| * </p> | ||
| * <p> | ||
| * The desired configuration is based on: | ||
| * </p> | ||
| * <ul> | ||
| * <li>The default configuration of the publishers</li> | ||
| * <li>The global configuration of the publishers defined in the "Global Tools Configuration' section</li> | ||
| * <li>The configuration specified in the {@code withMaven(options=[...])} step</li> | ||
| * </ul> | ||
| * @param configuredPublishers | ||
| * @param listener | ||
| */ | ||
| @Nonnull | ||
| public List<MavenPublisher> buildPublishersList(@Nonnull List<MavenPublisher> configuredPublishers, @Nonnull TaskListener listener) { | ||
|
|
||
| // configuration passed as parameter of "withMaven(options=[...]){}" | ||
| // mavenPublisher.descriptor.id -> mavenPublisher | ||
| Map<String, MavenPublisher> configuredPublishersById = new HashMap<>(); | ||
| for (MavenPublisher mavenPublisher : configuredPublishers) { | ||
| if (mavenPublisher == null) { | ||
| // skip null publisher options injected by Jenkins pipeline, probably caused by a missing plugin | ||
| } else { | ||
| configuredPublishersById.put(mavenPublisher.getDescriptor().getId(), mavenPublisher); | ||
| } | ||
| } | ||
|
|
||
| // configuration defined globally | ||
| Map<String, MavenPublisher> globallyConfiguredPublishersById = new HashMap<>(); | ||
| GlobalPipelineMavenConfig globalPipelineMavenConfig = GlobalPipelineMavenConfig.get(); | ||
|
|
||
| List<MavenPublisher> globallyConfiguredPublishers = globalPipelineMavenConfig == null ? Collections.<MavenPublisher>emptyList() : globalPipelineMavenConfig.getPublisherOptions(); | ||
| if (globallyConfiguredPublishers == null) { | ||
| globallyConfiguredPublishers = Collections.emptyList(); | ||
| } | ||
| for (MavenPublisher mavenPublisher : globallyConfiguredPublishers) { | ||
| globallyConfiguredPublishersById.put(mavenPublisher.getDescriptor().getId(), mavenPublisher); | ||
| } | ||
|
|
||
|
|
||
| // mavenPublisher.descriptor.id -> mavenPublisher | ||
| Map<String, MavenPublisher> defaultPublishersById = new HashMap<>(); | ||
| DescriptorExtensionList<MavenPublisher, Descriptor<MavenPublisher>> descriptorList = Jenkins.getInstance().getDescriptorList(MavenPublisher.class); | ||
| for (Descriptor<MavenPublisher> descriptor : descriptorList) { | ||
| try { | ||
| defaultPublishersById.put(descriptor.getId(), descriptor.clazz.newInstance()); | ||
| } catch (InstantiationException | IllegalAccessException e) { | ||
| PrintWriter error = listener.error("[withMaven] Exception instantiation default config for Maven Publisher '" + descriptor.getDisplayName() + "' / " + descriptor.getId() + ": " + e); | ||
| e.printStackTrace(error); | ||
| error.close(); | ||
| LOGGER.log(Level.WARNING, "Exception instantiating " + descriptor.clazz + ": " + e, e); | ||
| e.printStackTrace(); | ||
| } | ||
| } | ||
|
|
||
|
|
||
| if (LOGGER.isLoggable(Level.FINE)) { | ||
| listener.getLogger().println("[withMaven] Maven Publishers with configuration provided by the pipeline: " + configuredPublishersById.values()); | ||
| listener.getLogger().println("[withMaven] Maven Publishers with configuration defined globally: " + globallyConfiguredPublishersById.values()); | ||
| listener.getLogger().println("[withMaven] Maven Publishers with default configuration: " + defaultPublishersById.values()); | ||
| } | ||
|
|
||
| // TODO FILTER | ||
| List<MavenPublisher> results = new ArrayList<>(); | ||
| for (Map.Entry<String, MavenPublisher> entry : defaultPublishersById.entrySet()) { | ||
| String publisherId = entry.getKey(); | ||
| MavenPublisher publisher = buildConfiguredMavenPublisher( | ||
| configuredPublishersById.get(publisherId), | ||
| globallyConfiguredPublishersById.get(publisherId), | ||
| entry.getValue(), | ||
| listener); | ||
| results.add(publisher); | ||
| } | ||
| Collections.sort(results); | ||
| return results; | ||
| } | ||
| }, | ||
|
|
||
| EXPLICIT("Explicit") { | ||
| @Nonnull | ||
| @Override | ||
| public List<MavenPublisher> buildPublishersList | ||
| (@Nonnull List<MavenPublisher> configuredPublishers, @Nonnull TaskListener listener) { | ||
|
|
||
| // filter null entries caused by missing plugins | ||
| List<MavenPublisher> result = new ArrayList<>(); | ||
| for(MavenPublisher publisher: configuredPublishers) { | ||
| if (publisher != null) { | ||
| result.add(publisher); | ||
| } | ||
| } | ||
|
|
||
| if (LOGGER.isLoggable(Level.FINE)) { | ||
| listener.getLogger().println("[withMaven] Maven Publishers: " + result); | ||
| } | ||
| return result; | ||
| } | ||
| }; | ||
| final String description; | ||
|
|
||
| MavenPublisherStrategy(String description) { | ||
| this.description = description; | ||
| } | ||
|
|
||
| public MavenPublisher buildConfiguredMavenPublisher(@Nullable MavenPublisher pipelinePublisher, @Nullable MavenPublisher globallyConfiguredPublisher, @Nonnull MavenPublisher defaultPublisher, @Nonnull TaskListener listener) { | ||
|
|
||
| MavenPublisher result; | ||
| String logMessage; | ||
|
|
||
| if (pipelinePublisher == null && globallyConfiguredPublisher == null) { | ||
| result = defaultPublisher; | ||
| logMessage = "default"; | ||
| } else if (pipelinePublisher == null && globallyConfiguredPublisher != null) { | ||
| result = globallyConfiguredPublisher; | ||
| logMessage = "globally"; | ||
| } else if (pipelinePublisher != null && globallyConfiguredPublisher == null) { | ||
| result = pipelinePublisher; | ||
| logMessage = "pipeline"; | ||
| } else if (pipelinePublisher != null && globallyConfiguredPublisher != null) { | ||
| // workaround FindBugs "Bug kind and pattern: NP - NP_NULL_ON_SOME_PATH" | ||
| // check pipelinePublisher and globallyConfiguredPublisher are non null even if it is useless | ||
|
|
||
| result = pipelinePublisher; | ||
| logMessage = "pipeline"; | ||
| listener.getLogger().println("[withMaven] WARNING merging publisher configuration defined in the 'Global Tool Configuration' and at the pipeline level is not yet supported." + | ||
| " Use pipeline level configuration for '" + result.getDescriptor().getDisplayName() + "'"); | ||
| // | ||
| // PropertyDescriptor[] propertyDescriptors = PropertyUtils.getPropertyDescriptors(defaultPublisher); | ||
| // for(PropertyDescriptor propertyDescriptor: propertyDescriptors) { | ||
| // Method readMethod = propertyDescriptor.getReadMethod(); | ||
| // Method writeMethod = propertyDescriptor.getWriteMethod(); | ||
| // | ||
| // Object defaultValue = readMethod.invoke(defaultPublisher); | ||
| // Object globallyDefinedValue = readMethod.invoke(globallyConfiguredPublisher); | ||
| // Object pipelineValue = readMethod.invoke(pipelinePublisher); | ||
| // } | ||
| } else { | ||
| throw new IllegalStateException("Should not happen, workaround for Findbugs NP_NULL_ON_SOME_PATH above"); | ||
| } | ||
|
|
||
| if (LOGGER.isLoggable(Level.FINE)) | ||
| listener.getLogger().println("[withMaven] Use " + logMessage + " defined publisher for '" + result.getDescriptor().getDisplayName() + "'"); | ||
| return result; | ||
|
|
||
| } | ||
|
|
||
| public String getDescription() { | ||
| return description; | ||
| } | ||
|
|
||
| /** | ||
| * <p>Build the list of {@link MavenPublisher}s that should be invoked for the build execution of the given {@link TaskListener} | ||
| * with the desired configuration. | ||
| * </p> | ||
| * <p> | ||
| * The desired configuration is based on: | ||
| * </p> | ||
| * <ul> | ||
| * <li>The default configuration of the publishers</li> | ||
| * <li>The global configuration of the publishers defined in the "Global Tools Configuration' section</li> | ||
| * <li>The configuration specified in the {@code withMaven(options=[...])} step</li> | ||
| * </ul> | ||
| * @param configuredPublishers | ||
| * @param listener | ||
| */ | ||
| @Nonnull | ||
| public abstract List<MavenPublisher> buildPublishersList(@Nonnull List<MavenPublisher> configuredPublishers, @Nonnull TaskListener listener); | ||
|
|
||
| private final static Logger LOGGER = Logger.getLogger(MavenPublisherStrategy.class.getName()); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.