Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FIXED JENKINS-40906] Resolve an SCM from an SCMSource and a list of …
…candidate target branch names
- Loading branch information
Showing
3 changed files
with
445 additions
and
2 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
290 changes: 290 additions & 0 deletions
290
src/main/java/org/jenkinsci/plugins/workflow/multibranch/ResolveScmStep.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,290 @@ | ||
| /* | ||
| * The MIT License | ||
| * | ||
| * Copyright (c) 2017 CloudBees, Inc. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in | ||
| * all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| * THE SOFTWARE. | ||
| * | ||
| */ | ||
|
|
||
| package org.jenkinsci.plugins.workflow.multibranch; | ||
|
|
||
| import edu.umd.cs.findbugs.annotations.CheckForNull; | ||
| import edu.umd.cs.findbugs.annotations.NonNull; | ||
| import hudson.AbortException; | ||
| import hudson.Extension; | ||
| import hudson.model.Descriptor; | ||
| import hudson.model.TaskListener; | ||
| import hudson.scm.SCM; | ||
| import java.io.PrintStream; | ||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.LinkedHashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import jenkins.scm.api.SCMHead; | ||
| import jenkins.scm.api.SCMHeadObserver; | ||
| import jenkins.scm.api.SCMRevision; | ||
| import jenkins.scm.api.SCMSource; | ||
| import org.apache.commons.lang.StringUtils; | ||
| import org.jenkinsci.plugins.workflow.steps.AbstractStepDescriptorImpl; | ||
| import org.jenkinsci.plugins.workflow.steps.AbstractSynchronousStepExecution; | ||
| import org.jenkinsci.plugins.workflow.steps.Step; | ||
| import org.jenkinsci.plugins.workflow.steps.StepContext; | ||
| import org.jenkinsci.plugins.workflow.steps.StepExecution; | ||
| import org.kohsuke.stapler.DataBoundConstructor; | ||
| import org.kohsuke.stapler.DataBoundSetter; | ||
|
|
||
| /** | ||
| * Resolves an {@link SCM} from a {@link SCMSource} using a priority list of target branch names. | ||
| * | ||
| * @since FIXME | ||
| */ | ||
| public class ResolveScmStep extends Step { | ||
|
|
||
| /** | ||
| * The {@link SCMSource} | ||
| */ | ||
| @NonNull | ||
| private final SCMSource source; | ||
|
|
||
| /** | ||
| * The {@link SCMSource} | ||
| */ | ||
| @NonNull | ||
| private final List<String> targets; | ||
|
|
||
| /** | ||
| * If {@code true} then {@code null} will be returned in the event that none of the target branch names can be | ||
| * resolved. | ||
| */ | ||
| private boolean ignoreErrors; | ||
|
|
||
| /** | ||
| * Constructor. | ||
| * | ||
| * @param source The {@link SCMSource} | ||
| * @param targets The {@link SCMSource} | ||
| */ | ||
| @DataBoundConstructor | ||
| public ResolveScmStep(@NonNull SCMSource source, @NonNull List<String> targets) { | ||
| this.source = source; | ||
| this.targets = new ArrayList<String>(targets); | ||
| } | ||
|
|
||
| /** | ||
| * Gets the {@link SCMSource} to resolve from. | ||
| * | ||
| * @return the {@link SCMSource} to resolve from. | ||
| */ | ||
| @NonNull | ||
| public SCMSource getSource() { | ||
| return source; | ||
| } | ||
|
|
||
| /** | ||
| * Gets the {@link SCMHead} names to try and resolve. | ||
| * | ||
| * @return the {@link SCMHead} names to try and resolve. | ||
| */ | ||
| @NonNull | ||
| public List<String> getTargets() { | ||
| return Collections.unmodifiableList(targets); | ||
| } | ||
|
|
||
| /** | ||
| * Returns {@code true} if and only if errors will be ignored. | ||
| * | ||
| * @return {@code true} if and only if errors will be ignored. | ||
| */ | ||
| public boolean isIgnoreErrors() { | ||
| return ignoreErrors; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the error handling behaviour. | ||
| * | ||
| * @param ignoreErrors {@code true} if and only if errors will be ignored. | ||
| */ | ||
| @DataBoundSetter | ||
| public void setIgnoreErrors(boolean ignoreErrors) { | ||
| this.ignoreErrors = ignoreErrors; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| @Override | ||
| public StepExecution start(StepContext context) throws Exception { | ||
| return new Execution(context, this); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| @Override | ||
| public String toString() { | ||
| return "ResolveScmStep{" + | ||
| "source=" + source + | ||
| ", targets=" + targets + | ||
| ", ignoreErrors=" + ignoreErrors + | ||
| '}'; | ||
| } | ||
|
|
||
| /** | ||
| * Our {@link Descriptor}. | ||
| */ | ||
| @Extension(optional = true) | ||
| public static class DescriptorImpl extends AbstractStepDescriptorImpl { | ||
|
|
||
| /** | ||
| * Default constructor. | ||
| */ | ||
| public DescriptorImpl() { | ||
| super(Execution.class); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| @Override | ||
| public String getFunctionName() { | ||
| return "resolveScm"; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| @Override | ||
| public String getDisplayName() { | ||
| return "Resolves an SCM from an SCM Source and a list of candidate target branch names"; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Our {@link StepExecution}. | ||
| */ | ||
| public static class Execution extends AbstractSynchronousStepExecution<SCM> { | ||
|
|
||
| /** | ||
| * Ensure consistent serialization. | ||
| */ | ||
| private static final long serialVersionUID = 1L; | ||
|
|
||
| /** | ||
| * The step. | ||
| */ | ||
| private transient final ResolveScmStep step; | ||
|
|
||
| /** | ||
| * Our constructor (avoiding Guice injection). | ||
| * | ||
| * @param context the context. | ||
| * @param step the step. | ||
| */ | ||
| Execution(StepContext context, ResolveScmStep step) { | ||
| super(context); | ||
| this.step = step; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| @Override | ||
| protected SCM run() throws Exception { | ||
| StepContext context = getContext(); | ||
| TaskListener listener = context.get(TaskListener.class); | ||
| assert listener != null; | ||
| PrintStream out = listener.getLogger(); | ||
| SCMSource source = step.source; | ||
| out.printf("Checking for first existing branch from %s...%n", step.getTargets()); | ||
| SCMRevision fetch = source.fetch(new ObserverImpl(step.getTargets()), listener).result(); | ||
| if (fetch == null) { | ||
| out.println("Could not find any matching branch%n"); | ||
| if (step.isIgnoreErrors()) { | ||
| return null; | ||
| } | ||
| throw new AbortException("Could not find any matching branch"); | ||
| } | ||
| out.printf("Found %s at revision %s%n", fetch.getHead().getName(), fetch); | ||
| return source.build(fetch.getHead(), fetch); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * An observer that collects the {@link SCMRevision} of a named {@link SCMHead} from a list of priority | ||
| * candidates and stops observing when the preferred candidate is found. | ||
| */ | ||
| private static class ObserverImpl extends SCMHeadObserver { | ||
| /** | ||
| * The heads we are looking for | ||
| */ | ||
| private final Map<String, SCMRevision> revision = new LinkedHashMap<String, SCMRevision>(); | ||
|
|
||
| /** | ||
| * Constructor. | ||
| * | ||
| * @param heads the {@link SCMHead#getName()} to get the {@link SCMRevision} of. | ||
| */ | ||
| public ObserverImpl(@NonNull List<String> heads) { | ||
| heads.getClass(); // fail fast if null | ||
| for (String head : heads) { | ||
| if (StringUtils.isNotBlank(head)) { | ||
| revision.put(head, null); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Returns the result. | ||
| * | ||
| * @return the result. | ||
| */ | ||
| @CheckForNull | ||
| public SCMRevision result() { | ||
| for (SCMRevision r : revision.values()) { | ||
| if (r != null) { | ||
| return r; | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| @Override | ||
| public void observe(@NonNull SCMHead head, @NonNull SCMRevision revision) { | ||
| if (this.revision.containsKey(head.getName())) { | ||
| this.revision.put(head.getName(), revision); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| @Override | ||
| public boolean isObserving() { | ||
| return revision.values().iterator().next() == null; | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } |
Oops, something went wrong.