Merge pull request #289 from jglick/dependency-injection

Fix deprecations, avoid `@Inject`

Author: jglick

src/main/java/org/jenkinsci/plugins/workflow/multibranch/JobPropertyStep.java

@@ -44,9 +44,7 @@
 import java.util.Set;
 import java.util.logging.Level;
 import java.util.logging.Logger;
-import jakarta.inject.Inject;
 
-import hudson.model.TaskListener;
 import jenkins.branch.BuildRetentionBranchProperty;
 import jenkins.branch.RateLimitBranchProperty;
 import jenkins.model.Jenkins;
@@ -56,11 +54,11 @@
 import org.jenkinsci.plugins.workflow.graphanalysis.DepthFirstScanner;
 import org.jenkinsci.plugins.workflow.graphanalysis.NodeStepTypePredicate;
 import org.jenkinsci.plugins.workflow.job.WorkflowJob;
-import org.jenkinsci.plugins.workflow.steps.AbstractStepDescriptorImpl;
-import org.jenkinsci.plugins.workflow.steps.AbstractStepImpl;
-import org.jenkinsci.plugins.workflow.steps.AbstractSynchronousStepExecution;
 import org.jenkinsci.plugins.workflow.steps.Step;
-import org.jenkinsci.plugins.workflow.steps.StepContextParameter;
+import org.jenkinsci.plugins.workflow.steps.StepContext;
+import org.jenkinsci.plugins.workflow.steps.StepDescriptor;
+import org.jenkinsci.plugins.workflow.steps.StepExecution;
+import org.jenkinsci.plugins.workflow.steps.SynchronousStepExecution;
 import org.kohsuke.accmod.Restricted;
 import org.kohsuke.accmod.restrictions.DoNotUse;
 import org.kohsuke.stapler.DataBoundConstructor;
@@ -70,7 +68,7 @@
  * Resets the properties of the current job.
  */
 @SuppressWarnings({"unchecked", "rawtypes"}) // TODO JENKINS-26535: cannot bind List<JobProperty<?>>
-public class JobPropertyStep extends AbstractStepImpl {
+public class JobPropertyStep extends Step {
 
     private final List<JobProperty> properties;
 
@@ -88,14 +86,22 @@ public Map<JobPropertyDescriptor,JobProperty> getPropertiesMap() {
         return Descriptor.toMap((List) properties);
     }
 
-    public static class Execution extends AbstractSynchronousStepExecution<Void> {
+    @Override public StepExecution start(StepContext context) throws Exception {
+        return new Execution(this, context);
+    }
+
+    public static class Execution extends SynchronousStepExecution<Void> {
 
-        @Inject transient JobPropertyStep step;
-        @StepContextParameter transient Run<?,?> build;
-        @StepContextParameter transient TaskListener l;
+        private transient final JobPropertyStep step;
+
+        Execution(JobPropertyStep step, StepContext context) {
+            super(context);
+            this.step = step;
+        }
 
         @SuppressWarnings("unchecked") // untypable
         @Override protected Void run() throws Exception {
+            Run<?,?> build = getContext().get(Run.class);
             Job<?,?> job = build.getParent();
 
             JobPropertyTrackerAction previousAction = job.getAction(JobPropertyTrackerAction.class);
@@ -162,11 +168,7 @@ public static class Execution extends AbstractSynchronousStepExecution<Void> {
 
     }
 
-    @Extension public static class DescriptorImpl extends AbstractStepDescriptorImpl {
-
-        public DescriptorImpl() {
-            super(Execution.class);
-        }
+    @Extension public static class DescriptorImpl extends StepDescriptor {
 
         @Override public String getFunctionName() {
             return "properties";
@@ -177,6 +179,10 @@ public DescriptorImpl() {
             return "Set job properties";
         }
 
+        @Override public Set<? extends Class<?>> getRequiredContext() {
+            return Set.of(Run.class);
+        }
+
         @Override public Step newInstance(@NonNull StaplerRequest req, @NonNull JSONObject formData) throws FormException {
             if (req == null) { // should not happen
                 return super.newInstance(null, formData);

src/main/java/org/jenkinsci/plugins/workflow/multibranch/ReadTrustedStep.java

@@ -41,7 +41,7 @@
 
 import java.io.File;
 import java.io.IOException;
-import jakarta.inject.Inject;
+import java.util.Set;
 import jenkins.branch.Branch;
 import jenkins.model.Jenkins;
 import jenkins.scm.api.SCMFileSystem;
@@ -54,10 +54,11 @@
 import org.jenkinsci.plugins.workflow.cps.steps.LoadStepExecution;
 import org.jenkinsci.plugins.workflow.flow.FlowDefinition;
 import org.jenkinsci.plugins.workflow.job.WorkflowJob;
-import org.jenkinsci.plugins.workflow.steps.AbstractStepDescriptorImpl;
-import org.jenkinsci.plugins.workflow.steps.AbstractStepImpl;
-import org.jenkinsci.plugins.workflow.steps.AbstractSynchronousNonBlockingStepExecution;
-import org.jenkinsci.plugins.workflow.steps.StepContextParameter;
+import org.jenkinsci.plugins.workflow.steps.Step;
+import org.jenkinsci.plugins.workflow.steps.StepContext;
+import org.jenkinsci.plugins.workflow.steps.StepDescriptor;
+import org.jenkinsci.plugins.workflow.steps.StepExecution;
+import org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution;
 import org.jenkinsci.plugins.workflow.steps.scm.GenericSCMStep;
 import org.jenkinsci.plugins.workflow.steps.scm.SCMStep;
 import org.kohsuke.stapler.DataBoundConstructor;
@@ -69,7 +70,7 @@
  * May be used in combination with {@code evaluate} to delegate to more Pipeline Groovy, as a substitute for {@link SCMBinder},
  * at least until {@link LoadStepExecution} has been split into an abstract part that a {@code loadTrusted} step could extend.
  */
-public class ReadTrustedStep extends AbstractStepImpl {
+public class ReadTrustedStep extends Step {
 
     // Intentionally using the same key as CpsScmFlowDefinition.
     private static final HMACConfidentialKey CHECKOUT_DIR_KEY = new HMACConfidentialKey(CpsScmFlowDefinition.class, "filePathWithSuffix", 32);
@@ -85,13 +86,22 @@ public String getPath() {
         return path;
     }
 
-    public static class Execution extends AbstractSynchronousNonBlockingStepExecution<String> {
+    @Override public StepExecution start(StepContext context) throws Exception {
+        return new Execution(this, context);
+    }
+
+    public static class Execution extends SynchronousNonBlockingStepExecution<String> {
 
-        @Inject private transient ReadTrustedStep step;
-        @StepContextParameter private transient Run<?,?> build;
-        @StepContextParameter private transient TaskListener listener;
+        private transient final ReadTrustedStep step;
+
+        Execution(ReadTrustedStep step, StepContext context) {
+            super(context);
+            this.step = step;
+        }
 
         @Override protected String run() throws Exception {
+            Run<?,?> build = getContext().get(Run.class);
+            TaskListener listener = getContext().get(TaskListener.class);
             Job<?, ?> job = build.getParent();
             // Portions adapted from SCMBinder, SCMVar, and CpsScmFlowDefinition:
             SCM standaloneSCM = null;
@@ -253,11 +263,7 @@ private static boolean isDescendant(FilePath child, FilePath parent) throws IOEx
 
     }
 
-    @Extension public static class DescriptorImpl extends AbstractStepDescriptorImpl {
-
-        public DescriptorImpl() {
-            super(Execution.class);
-        }
+    @Extension public static class DescriptorImpl extends StepDescriptor {
 
         @Override public String getFunctionName() {
             return "readTrusted";
@@ -268,6 +274,10 @@ public DescriptorImpl() {
             return "Read trusted file from SCM";
         }
 
+        @Override public Set<? extends Class<?>> getRequiredContext() {
+            return Set.of(Run.class, TaskListener.class);
+        }
+
     }
 
 }