[FIXED JENKINS-40240] Add .../wrapperMetadata endpoint

jenkinsci · Dec 8, 2016 · 17b4bee · 17b4bee
1 parent a9339b8
commit 17b4bee
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 0 deletions.
diff --git a/src/main/java/io/blueocean/rest/pipeline/editor/PipelineMetadataService.java b/src/main/java/io/blueocean/rest/pipeline/editor/PipelineMetadataService.java
@@ -6,6 +6,8 @@
 import java.util.List;
 import java.util.Set;
 
+import hudson.FilePath;
+import hudson.Launcher;
 import hudson.model.Describable;
 import hudson.tasks.Builder;
 import hudson.tasks.Publisher;
@@ -79,6 +81,26 @@ public String[] doBuildConditions() {
     }
 
 
+    /**
+     * Function to return all applicable step descriptors for the "wrappers" section.
+     */
+    @GET
+    @TreeResponse
+    public ExportedPipelineStep[] doWrapperMetadata() {
+        List<ExportedPipelineStep> wrappers = new ArrayList<>();
+
+        for (StepDescriptor d : StepDescriptor.all()) {
+            if (isWrapper(d)) {
+                ExportedPipelineStep step = getStepMetadata(d);
+                if (step != null) {
+                    wrappers.add(step);
+                }
+            }
+        }
+
+        return wrappers.toArray(new ExportedPipelineStep[wrappers.size()]);
+    }
+
     /**
      * Function to return all step descriptors present in the system when accessed through the REST API
      */
@@ -112,6 +134,13 @@ public ExportedPipelineFunction[] doPipelineStepMetadata() {
         return pd.toArray(new ExportedPipelineFunction[pd.size()]);
     }
 
+    private boolean isWrapper(StepDescriptor d) {
+        return includeStep(d)
+                && d.takesImplicitBlockArgument()
+                && !d.getRequiredContext().contains(FilePath.class)
+                && !d.getRequiredContext().contains(Launcher.class);
+    }
+
     private boolean includeStep(StepDescriptor d) {
         boolean include = true;
         if (ModelASTStep.getBlockedSteps().containsKey(d.getFunctionName())) {

diff --git a/src/test/java/io/blueocean/rest/pipeline/editor/PipelineMetadataServiceTest.java b/src/test/java/io/blueocean/rest/pipeline/editor/PipelineMetadataServiceTest.java
@@ -73,6 +73,26 @@ public void declarativeAgents() throws Exception {
         assertEquals(3, m.getParameters().size());
     }
 
+    @Test
+    public void wrappers() throws Exception {
+        PipelineMetadataService svc = new PipelineMetadataService();
+
+        List<ExportedPipelineStep> wrappers = new ArrayList<>();
+        wrappers.addAll(Arrays.asList(svc.doWrapperMetadata()));
+
+        assertFalse(wrappers.isEmpty());
+
+        ExportedPipelineStep w = null;
+
+        for (ExportedPipelineStep s : wrappers) {
+            if (s.getFunctionName().equals("timeout")) {
+                w = s;
+            }
+        }
+
+        assertNotNull(w);
+    }
+
     @Test
     public void verifyFunctionNames() throws Exception {
         PipelineMetadataService svc = new PipelineMetadataService();