[JENKINS-34502] Provide health metric for a named child of the folder

src/main/java/com/cloudbees/hudson/plugins/folder/AbstractFolder.java

@@ -794,66 +794,60 @@
                 + TimeUnit.MINUTES.toMillis(HEALTH_REPORT_CACHE_REFRESH_MIN * 3L / 4L)
                 + ENTROPY.nextInt((int)TimeUnit.MINUTES.toMillis(HEALTH_REPORT_CACHE_REFRESH_MIN / 2));
         reports = new ArrayList<>();
-        List<FolderHealthMetric.Reporter> reporters = new ArrayList<>(healthMetrics.size());
-        boolean recursive = false;
-        boolean topLevelOnly = true;
+
         for (FolderHealthMetric metric : healthMetrics) {
-            recursive = recursive || metric.getType().isRecursive();
-            topLevelOnly = topLevelOnly && metric.getType().isTopLevelItems();
-            reporters.add(metric.reporter());
+            FolderHealthMetric.Reporter reporter = metric.reporter();
+            observeMetric(metric.getType(), reporter);
+            reports.addAll(reporter.report());
+
         }
         for (AbstractFolderProperty<?> p : getProperties()) {
             for (FolderHealthMetric metric : p.getHealthMetrics()) {
-                recursive = recursive || metric.getType().isRecursive();
-                topLevelOnly = topLevelOnly && metric.getType().isTopLevelItems();
-                reporters.add(metric.reporter());
+                FolderHealthMetric.Reporter reporter = metric.reporter();
+                observeMetric(metric.getType(), reporter);
+                reports.addAll(p.getHealthReports());
             }
         }
-        if (recursive) {
-            Stack<Iterable<? extends Item>> stack = new Stack<>();
-            stack.push(getItems());
-            if (topLevelOnly) {
-                while (!stack.isEmpty()) {
-                    for (Item item : stack.pop()) {
-                        if (item instanceof TopLevelItem) {
-                            for (FolderHealthMetric.Reporter reporter : reporters) {
+
+        Collections.sort(reports);
+        healthReports = reports; // idempotent write
+        return reports;
+    }
+
+    private void observeMetric(FolderHealthMetric.Type type, FolderHealthMetric.Reporter reporter) {
+        if (type.isWithChildren()) {
+            if (type.isRecursive()) {
+                Stack<Iterable<? extends Item>> stack = new Stack<>();
+                stack.push(getItems());
+                if (type.isTopLevelItems()) {
+                    while (!stack.isEmpty()) {
+                        for (Item item : stack.pop()) {
+                            if (item instanceof TopLevelItem) {
                                 reporter.observe(item);
+                                if (item instanceof Folder) {
+                                    stack.push(((Folder) item).getItems());
+                                }
                             }
+                        }
+                    }
+                } else {
+                    while (!stack.isEmpty()) {
+                        for (Item item : stack.pop()) {
+                            reporter.observe(item);
                             if (item instanceof Folder) {
                                 stack.push(((Folder) item).getItems());
                             }
                         }
                     }
                 }
             } else {
-                while (!stack.isEmpty()) {
-                    for (Item item : stack.pop()) {
-                        for (FolderHealthMetric.Reporter reporter : reporters) {
-                            reporter.observe(item);
-                        }
-                        if (item instanceof Folder) {
-                            stack.push(((Folder) item).getItems());
-                        }
-                    }
-                }
-            }
-        } else {
-            for (Item item: getItems()) {
-                for (FolderHealthMetric.Reporter reporter : reporters) {
+                for (Item item : getItems()) {
                     reporter.observe(item);
                 }
             }
+        } else {
+            reporter.observe(this);
         }
-        for (FolderHealthMetric.Reporter reporter : reporters) {
-            reports.addAll(reporter.report());
-        }
-        for (AbstractFolderProperty<?> p : getProperties()) {
-            reports.addAll(p.getHealthReports());
-        }
-
-        Collections.sort(reports);
-        healthReports = reports; // idempotent write
-        return reports;
     }
 
     public DescribableList<FolderHealthMetric, FolderHealthMetricDescriptor> getHealthMetrics() {

src/main/java/com/cloudbees/hudson/plugins/folder/health/FolderHealthMetric.java

@@ -70,19 +70,26 @@ public interface Reporter {
     }
 
     public enum Type {
-        IMMEDIATE_TOP_LEVEL_ITEMS(false, true),
-        RECURSIVE_TOP_LEVEL_ITEMS(true, true),
-        IMMEDIATE_ALL_ITEMS(false, false),
-        RECURSIVE_ALL_ITEMS(true, false);
-
+
+        SELF_ONLY(false, false, false),
+        IMMEDIATE_TOP_LEVEL_ITEMS(true, false, true),
+        RECURSIVE_TOP_LEVEL_ITEMS(true, true, true),
+        IMMEDIATE_ALL_ITEMS(true, false, false),
+        RECURSIVE_ALL_ITEMS(true, true, false);
+
+        private final boolean withChildren;
         private final boolean recursive;
-
         private final boolean topLevelItems;
 
-        Type(boolean recursive, boolean topLevelItems) {
+        Type(boolean withChildren, boolean recursive, boolean topLevelItems) {
+            this.withChildren = withChildren;
             this.recursive = recursive;
             this.topLevelItems = topLevelItems;
         }
+
+        public boolean isWithChildren() {
+            return withChildren;
+        }
 
         public boolean isRecursive() {
             return recursive;

src/main/java/com/cloudbees/hudson/plugins/folder/health/NamedChildHealthMetric.java

@@ -0,0 +1,153 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2013 CloudBees.
+ *
+ * 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 com.cloudbees.hudson.plugins.folder.health;
+
+import java.util.Collections;
+import java.util.List;
+
+import org.apache.commons.lang.StringUtils;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.DoNotUse;
+import org.kohsuke.stapler.AncestorInPath;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.QueryParameter;
+
+import hudson.Extension;
+import hudson.model.AutoCompletionCandidates;
+import hudson.model.HealthReport;
+import hudson.model.Item;
+import hudson.model.ItemGroup;
+
+/**
+ * A health metric for a named child item.
+ * 
+ * @author strangelookingnerd
+ *
+ */
+public class NamedChildHealthMetric extends FolderHealthMetric {
+
+    private String childName;
+
+    /**
+     * Ctor.
+     * 
+     * @param childName
+     *            name of the child
+     */
+    @DataBoundConstructor
+    public NamedChildHealthMetric(String childName) {
+        this.childName = childName;
+    }
+
+    /**
+     * @return the name of the child.
+     */
+    public String getChildName() {
+        return childName;
+    }
+
+    @Override
+    public Type getType() {
+        return Type.SELF_ONLY;
+    }
+
+    @Override
+    public Reporter reporter() {
+        return new ReporterImpl(childName);
+    }
+
+    /**
+     * Descriptor Implementation.
+     * 
+     * @author strangelookingnerd
+     *
+     */
+    @Extension(ordinal = 400)
+    public static class DescriptorImpl extends FolderHealthMetricDescriptor {
+
+        private static final String DEFAULT = "";
+
+        @Override
+        public String getDisplayName() {
+            return Messages.NamedChildHealthMetric_DisplayName();
+        }
+
+        @Override
+        public FolderHealthMetric createDefault() {
+            return new NamedChildHealthMetric(DEFAULT);
+        }
+
+        /**
+         * Auto-completion for the "child names" field in the configuration.
+         * 
+         * @param value
+         *            the input
+         * @param container
+         *            the context
+         * @return the candidates
+         */
+        @Restricted(DoNotUse.class)
+        public AutoCompletionCandidates doAutoCompleteChildName(@QueryParameter String value,
+                @AncestorInPath ItemGroup<Item> container) {
+            AutoCompletionCandidates candidates = new AutoCompletionCandidates();
+            for (Item item : container.getItems()) {
+                if (StringUtils.startsWith(item.getName(), value)) {
+                    candidates.add(item.getName());
+                }
+            }
+            return candidates;
+        }
+    }
+
+    private static class ReporterImpl implements Reporter {
+        private HealthReport report = null;
+        private String childName;
+
+        /**
+         * Ctor.
+         * 
+         * @param childName
+         *            name of the child
+         */
+        public ReporterImpl(String childName) {
+            this.childName = childName;
+        }
+
+        @Override
+        public void observe(Item item) {
+            if (item instanceof ItemGroup) {
+                Item child = ((ItemGroup<Item>) item).getItem(childName);
+                if (child != null) {
+                    report = getHealthReport(child);
+                }
+            }
+        }
+
+        @Override
+        public List<HealthReport> report() {
+            return report != null ? Collections.singletonList(report) : Collections.emptyList();
+        }
+    }
+}

src/main/resources/com/cloudbees/hudson/plugins/folder/health/Messages.properties

@@ -1,2 +1,3 @@
 Folder.HealthWrap=Worst health: {0}: {1}
-WorstChildHealthMetric.DisplayName=Child item with worst health
+WorstChildHealthMetric.DisplayName=Child item with worst health
+NamedChildHealthMetric.DisplayName=Child item with the given name

src/main/resources/com/cloudbees/hudson/plugins/folder/health/Messages_ja.properties

@@ -21,4 +21,5 @@
 # THE SOFTWARE.
 
 Folder.HealthWrap=\u6700\u60aa\u306e\u5065\u5168\u6027: {0}: {1}
-WorstChildHealthMetric.DisplayName=Child item with worst health
+WorstChildHealthMetric.DisplayName=Child item with worst health
+NamedChildHealthMetric.DisplayName=Child item with the given name

src/main/resources/com/cloudbees/hudson/plugins/folder/health/NamedChildHealthMetric/config.jelly

@@ -0,0 +1,25 @@
+<!--
+The MIT License
+Copyright 2013 CloudBees.
+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.
+-->
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:f="/lib/form">
+  <f:entry title="${%ChildName}" help="${descriptor.getHelpFile('childName')}">
+    <f:textbox field="childName" />
+  </f:entry>
+</j:jelly>

src/main/resources/com/cloudbees/hudson/plugins/folder/health/NamedChildHealthMetric/config.properties

@@ -0,0 +1 @@
+ChildName=Child Name

src/main/resources/com/cloudbees/hudson/plugins/folder/health/NamedChildHealthMetric/help-childName.html

@@ -0,0 +1,3 @@
+<div>
+    Controls the child item within this folder representing to the health of this folder.
+</div>