org.jenkinsci.plugins.conditionalbuildstep.BuilderChain Maven / Gradle / Ivy

/*
 * The MIT License
 *
 * Copyright (C) 2011 by Dominik Bartholdi
 *
 * 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.conditionalbuildstep;

import hudson.Extension;
import hudson.Launcher;
import hudson.model.BuildListener;
import hudson.model.AbstractBuild;
import hudson.model.AbstractProject;
import hudson.tasks.BuildStep;
import hudson.tasks.BuildStepDescriptor;
import hudson.tasks.Builder;

import java.io.IOException;
import java.util.List;

/**
 * A builder not directly configurable via UI, instances are only created for transitive usage to wrap the execution of multiple builders.
 * 
 * @author Dominik Bartholdi (imod)
 * 
 */
public class BuilderChain extends Builder {

    private final List conditionalbuilders;

    public BuilderChain(final List conditionalbuilders) {
        this.conditionalbuilders = conditionalbuilders;
    }

    @Override
    public boolean prebuild(AbstractBuild build, BuildListener listener) {
        boolean shouldContinue = true;
        for (BuildStep buildStep : conditionalbuilders) {
            if (!shouldContinue) {
                break;
            }
            shouldContinue = buildStep.prebuild(build, listener);
        }
        return shouldContinue;
    }

    @Override
    public boolean perform(AbstractBuild build, Launcher launcher, BuildListener listener) throws IOException, InterruptedException {
        boolean shouldContinue = true;
        for (BuildStep buildStep : conditionalbuilders) {
            if (!shouldContinue) {
                break;
            }
            shouldContinue = buildStep.perform(build, launcher, listener);
        }
        return shouldContinue;
    }

    @Override
    public DescriptorImpl getDescriptor() {
        return (DescriptorImpl) super.getDescriptor();
    }

    @Extension
    public static final class DescriptorImpl extends BuildStepDescriptor {

        @SuppressWarnings("rawtypes")
        @Override
        public boolean isApplicable(Class jobType) {
            return false;
        }

        @Override
        public String getDisplayName() {
            return "BuilderChain";
        }

    }

}