[JENKINS-57903]- Refactor PromotionConditionDescriptor extension Point to make it Pipeline Compatible.

pom.xml

@@ -178,4 +178,4 @@
       <scope>test</scope>
     </dependency>
   </dependencies>
-</project>
+</project>

src/main/java/hudson/plugins/promoted_builds/AddPromotionBadge.java

@@ -0,0 +1,122 @@
+package hudson.plugins.promoted_builds;
+
+import hudson.EnvVars;
+import hudson.Extension;
+import hudson.FilePath;
+import hudson.Launcher;
+import hudson.model.*;
+import hudson.tasks.BuildStepDescriptor;
+import hudson.tasks.BuildStepMonitor;
+import hudson.tasks.Recorder;
+import jenkins.tasks.SimpleBuildStep;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
+
+import java.io.IOException;
+import java.io.PrintStream;
+
+public class AddPromotionBadge extends Recorder implements SimpleBuildStep, Describable{
+
+    private String boxName = "Promotion Badges";
+    private boolean gold;
+    private boolean silver;
+
+    @Extension
+    public static final DescriptorImpl DESCRIPTOR = new DescriptorImpl();
+
+    @DataBoundConstructor
+    public AddPromotionBadge(String boxName, boolean gold, boolean silver){
+        this.boxName = boxName;
+        this.gold = gold;
+        this.silver = silver;
+    }
+
+    public String getBoxName(){
+        return boxName;
+    }
+
+    @DataBoundSetter
+    public void setBoxName(String boxName){
+        this.boxName = boxName;
+    }
+
+
+    public boolean getGold(){
+        return gold;
+    }
+
+    @DataBoundSetter
+    public void setGold(boolean gold){
+        this.gold = gold;
+    }
+
+    public boolean getSilver(){
+        return silver;
+    }
+
+    @DataBoundSetter
+    public void setSilver(boolean silver){
+        this.silver = silver;
+    }
+
+    public BuildStepMonitor getRequiredMonitorService(){
+        return BuildStepMonitor.NONE;
+    }
+
+
+    @Override
+    public void perform(Run<?, ?> build, FilePath workspace, Launcher launcher, final TaskListener listener)
+            throws InterruptedException, IOException {
+
+        PrintStream logger = listener.getLogger();
+        logger.println("Started initialization");
+
+        Result buildResult = build.getResult();
+
+        if (Result.SUCCESS.equals(buildResult)) {
+            logger.println("The pipeline build is successful!!");
+
+            if(gold == true){
+                // How to assign actual badge icons??
+              }
+
+        }
+
+        String temp;
+
+        if(build instanceof AbstractBuild){
+            EnvVars vars = build.getEnvironment(listener);
+            vars.overrideAll(((AbstractBuild)build).getBuildVariables());
+            temp = vars.expand(boxName);
+        }else{
+            temp = boxName;
+        }
+
+        logger.println("Starting the pipeline build");
+        logger.println("Will assign badges once the pipeline build is successful in promotion");
+
+    }
+
+
+    public static final class DescriptorImpl extends BuildStepDescriptor<AddPromotionBadge>{
+
+        private DescriptorImpl(){
+            super(AddPromotionBadge.class);
+        }
+
+        public String getDisplayName(){
+            return "Add Promotion Badges";
+        }
+
+
+        @Override
+        public boolean isApplicable(Class<? extends AbstractProject> a){
+            return true;
+        }
+
+    }
+
+
+
+
+}

src/main/java/hudson/plugins/promoted_builds/Promotion.java

@@ -23,6 +23,7 @@
 import hudson.model.Run;
 import hudson.model.User;
 import hudson.plugins.promoted_builds.conditions.ManualCondition;
+import hudson.plugins.promoted_builds.pipeline.PromotionRun;
 import hudson.plugins.promoted_builds.util.JenkinsHelper;
 import hudson.security.Permission;
 import hudson.security.PermissionGroup;
@@ -60,11 +61,11 @@
 import org.kohsuke.stapler.StaplerResponse;
 
 /**
- * Records a promotion process.
+ * Records a promotion process for {@link AbstractProject}s.
  *
  * @author Kohsuke Kawaguchi
  */
-public class Promotion extends AbstractBuild<PromotionProcess,Promotion> {
+public class Promotion extends AbstractBuild<PromotionProcess,Promotion> implements PromotionRun {
 
     public Promotion(PromotionProcess job) throws IOException {
         super(job);
@@ -113,6 +114,7 @@ public EnvVars getEnvironment(TaskListener listener) throws IOException, Interru
 
         // Augment environment with target build's information
         String rootUrl = JenkinsHelper.getInstance().getRootUrl();
+        //TODO: Refactor to Run
         AbstractBuild<?, ?> target = getTarget();
         if(rootUrl!=null)
             e.put("PROMOTED_URL",rootUrl+target.getUrl());
@@ -162,7 +164,7 @@ public EnvVars getEnvironment(TaskListener listener) throws IOException, Interru
         }
 
         // Allow the promotion status to contribute to build environment
-        getStatus().buildEnvVars(this, e);
+        getStatus().buildEnvVars(this, e, listener);
 
         return e;
     }
@@ -239,6 +241,21 @@ public String getUserId() {
         return User.getUnknown().getId();
     }
 
+    @Nonnull
+    @Override
+    public Run<?, ?> getPromotedRun() {
+        return getTarget();
+    }
+
+
+    @Nonnull
+    @Override
+    public Run<?, ?> getPromotionRun() {
+        return this;
+    }
+
+    //TODO: move to a default method
+    @Override
     public List<ParameterValue> getParameterValues(){
       List<ParameterValue> values=new ArrayList<ParameterValue>();
       ParametersAction parametersAction=getParametersActions(this);

src/main/java/hudson/plugins/promoted_builds/PromotionBadge.java

@@ -2,8 +2,12 @@
 
 import hudson.EnvVars;
 import hudson.model.AbstractBuild;
+import hudson.model.Run;
+import hudson.model.TaskListener;
 import org.kohsuke.stapler.export.ExportedBean;
 
+import javax.annotation.Nonnull;
+
 /**
  * Captures the information about how/when the promotion criteria is satisfied.
  *
@@ -18,11 +22,22 @@ public abstract class PromotionBadge {
     /**
      * Called by {@link Status} to allow promotion badges to contribute environment variables.
      *
-     * @param build
-     *      The calling build. Never null.
+     * @param run
+     *      The calling run.
      * @param env
      *      Environment variables should be added to this map.
      */
+    public void buildEnvVars(@Nonnull Run<?,?> run,  EnvVars env, TaskListener listener) {
+        // Default implementation when the method is not overridden
+        if (run instanceof AbstractBuild) {
+            buildEnvVars((AbstractBuild<?,?>)run, env);
+        }
+    }
+
+    /**
+     * @deprecated Use {@link #buildEnvVars(Run, EnvVars, TaskListener)}
+     */
+    @Deprecated
     public void buildEnvVars(AbstractBuild<?,?> build, EnvVars env) {
         // by default don't contribute any variables
     }

src/main/java/hudson/plugins/promoted_builds/PromotionConditionDescriptor.java

@@ -2,6 +2,10 @@
 
 import hudson.model.AbstractProject;
 import hudson.model.Descriptor;
+import hudson.model.Job;
+import hudson.model.TaskListener;
+
+import javax.annotation.Nonnull;
 
 /**
  * {@link Descriptor} for {@link PromotionCondition}.
@@ -25,5 +29,11 @@ protected PromotionConditionDescriptor() {
      * @return
      *      true to allow user to configure this promotion condition for the given project.
      */
+    public boolean isApplicable(@Nonnull Job<?,?> item,@Nonnull TaskListener listener){
+        if(item instanceof AbstractProject){
+            return isApplicable((AbstractProject)item, TaskListener.NULL);
+        }
+        return isApplicable((Job) item, listener);
+    }
     public abstract boolean isApplicable(AbstractProject<?,?> item);
 }

src/main/java/hudson/plugins/promoted_builds/Status.java

@@ -9,6 +9,8 @@
 import hudson.model.ParameterDefinition;
 import hudson.model.ParameterValue;
 import hudson.model.Result;
+import hudson.model.Run;
+import hudson.model.TaskListener;
 import hudson.plugins.promoted_builds.conditions.ManualCondition;
 import hudson.util.Iterators;
 import net.sf.json.JSONArray;
@@ -147,17 +149,29 @@ public AbstractBuild<?,?> getTarget() {
         return _parent != null ? _parent.owner : null;
     }
 
+
+
     /**
      * Called by {@link Promotion} to allow status to contribute environment variables.
      *
-     * @param build
-     *      The calling build. Never null.
+     * @param run
+     *      The calling run
      * @param env
      *      Environment variables should be added to this map.
      */
+    public void buildEnvVars(Run<?,?> run, EnvVars env, TaskListener listener) {
+        for (PromotionBadge badge : badges) {
+            badge.buildEnvVars(run, env, listener);
+        }
+    }
+
+    /**
+     * @deprecated Use {@link #buildEnvVars(Run, EnvVars, TaskListener)}
+     */
+    @Deprecated
     public void buildEnvVars(AbstractBuild<?,?> build, EnvVars env) {
         for (PromotionBadge badge : badges) {
-            badge.buildEnvVars(build, env);
+            badge.buildEnvVars(build, env, TaskListener.NULL);
         }
     }
 

src/main/java/hudson/plugins/promoted_builds/conditions/DownstreamPassCondition.java

@@ -7,19 +7,9 @@
 import hudson.Extension;
 import hudson.Util;
 import hudson.console.HyperlinkNote;
-import hudson.model.AbstractBuild;
-import hudson.model.AbstractProject;
-import hudson.model.AutoCompletionCandidates;
-import hudson.model.Cause;
+import hudson.model.*;
 import hudson.model.Cause.UpstreamCause;
-import hudson.model.Fingerprint;
 import hudson.model.Fingerprint.BuildPtr;
-import hudson.model.InvisibleAction;
-import hudson.model.Item;
-import hudson.model.ItemGroup;
-import hudson.model.Result;
-import hudson.model.Run;
-import hudson.model.TaskListener;
 import hudson.model.listeners.RunListener;
 import hudson.plugins.promoted_builds.JobPropertyImpl;
 import hudson.plugins.promoted_builds.PromotionBadge;
@@ -46,6 +36,7 @@
 import java.util.Stack;
 
 import javax.annotation.CheckForNull;
+import javax.annotation.Nonnull;
 
 import org.kohsuke.stapler.export.Exported;
 
@@ -205,6 +196,13 @@ void add(AbstractBuild<?,?> b) {
 
     @Extension
     public static final class DescriptorImpl extends PromotionConditionDescriptor {
+        public boolean isApplicable(@Nonnull Job<?,?> item, @Nonnull TaskListener listener) {
+            if(item instanceof AbstractProject){
+                return isApplicable((AbstractProject)item, TaskListener.NULL);
+            }
+            return true;
+        }
+
         public boolean isApplicable(AbstractProject<?,?> item) {
             return true;
         }

src/main/java/hudson/plugins/promoted_builds/conditions/GroovyCondition.java

@@ -5,6 +5,8 @@
 import hudson.PluginManager;
 import hudson.Util;
 import hudson.model.AbstractBuild;
+import hudson.model.Run;
+import hudson.model.TaskListener;
 import hudson.plugins.promoted_builds.PromotionBadge;
 import hudson.plugins.promoted_builds.PromotionCondition;
 import hudson.plugins.promoted_builds.PromotionProcess;
@@ -130,8 +132,7 @@ public String getDisplayLabel() {
         }
 
         @Override
-        public void buildEnvVars(final AbstractBuild<?, ?> build, final EnvVars env) {
-            super.buildEnvVars(build, env);
+        public void buildEnvVars(final Run<?, ?> build, final EnvVars env, TaskListener listener) {
             for (final Map.Entry<String, String> entry :
                     variables.entrySet()) {
                 env.put(entry.getKey(), entry.getValue());