org.jenkins_ci.plugins.run_condition.RunCondition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of run-condition Show documentation
Define conditions for the execution of build steps
The newest version!
/*
 * The MIT License
 *
 * Copyright (C) 2011 by Anthony Robinson
 *
 * 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.jenkins_ci.plugins.run_condition;

import hudson.DescriptorExtensionList;
import hudson.ExtensionPoint;
import hudson.model.AbstractBuild;
import hudson.model.BuildListener;
import hudson.model.Describable;
import hudson.model.Descriptor;
import hudson.model.Hudson;

/**
 * Define a condition that can be used to decide whether to run a BuildStep or not.
 * 
 * A Run condition should not make any changes to the build or the build environment.
 * If the information that is required to make the decision is not available, then the RunCondition should
 * either explicitly throw an exception (or just allow one to be thrown) rather than handling it and trying to decide whether the build
 * should run based on bad data. This allows a user to choose what should happen - which could be different in different contexts.
 */
public abstract class RunCondition implements Describable, ExtensionPoint {

    public static DescriptorExtensionList all() {
        return Hudson.getInstance().getDescriptorList(RunCondition.class);
    }

    /**
     * Decide whether to run the prebuild method in the BuildStep.
     * 
     * If the condition depends, or may depend, on something that may be affected by the build itself, then it is probably safest to always
     * return true here. (@TODO review this once the plugin has been in use for a while with a variety of conditions and BuildSteps)
     * If the condition is not dependent on the state of the build i.e. just looks at the build timestamp, then this method should
     * return the same as the runPerform method.
     * 
     * @return true if the prebuild method of the BuildStep should run
     * 
     * @see org.jenkins_ci.plugins.run_condition.common.AlwaysPrebuildRunCondition
     * @see org.jenkins_ci.plugins.run_condition.common.PrebuildSameAsPerformRunCondition
     */
    public abstract boolean runPrebuild(final AbstractBuild build, final BuildListener listener) throws Exception;

    /**
     * Decide whether to run the perform method in the BuildStep.
     * 
     * @return true if the perform method of the BuildStep should run
     */
    public abstract boolean runPerform(final AbstractBuild build, final BuildListener listener) throws Exception;

    public RunConditionDescriptor getDescriptor() {
        return (RunConditionDescriptor)Hudson.getInstance().getDescriptor(getClass());
    }

    public static abstract class RunConditionDescriptor extends Descriptor {

        protected RunConditionDescriptor() { }

        protected RunConditionDescriptor(Class clazz) {
            super(clazz);
        }

    }

}