[JENKINS-70729] Rework clouds management into multiple pages

core/src/main/java/hudson/slaves/Cloud.java

@@ -46,13 +46,23 @@
 import hudson.security.PermissionScope;
 import hudson.slaves.NodeProvisioner.PlannedNode;
 import hudson.util.DescriptorList;
+import java.io.IOException;
 import java.util.Collection;
 import java.util.Objects;
 import java.util.concurrent.Future;
+import javax.servlet.ServletException;
 import jenkins.model.Jenkins;
+import net.sf.json.JSONObject;
 import org.kohsuke.accmod.Restricted;
 import org.kohsuke.accmod.restrictions.DoNotUse;
 import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.HttpRedirect;
+import org.kohsuke.stapler.HttpResponse;
+import org.kohsuke.stapler.StaplerRequest;
+import org.kohsuke.stapler.StaplerResponse;
+import org.kohsuke.stapler.export.Exported;
+import org.kohsuke.stapler.interceptor.RequirePOST;
+import org.kohsuke.stapler.verb.POST;
 
 /**
  * Creates {@link Node}s to dynamically expand/shrink the agents attached to Hudson.
@@ -122,7 +132,7 @@ public String getDisplayName() {
      * @return Jenkins relative URL.
      */
     public @NonNull String getUrl() {
-        return "cloud/" + Util.rawEncode(name);
+        return "cloud/" + Util.rawEncode(name) + "/";
     }
 
     @Override
@@ -275,6 +285,62 @@ public static void registerPermissions() {
         Objects.hash(PERMISSION_SCOPE, PROVISION);
     }
 
+    @Exported
+    public String getIcon() {
+        return "symbol-cloud";
+    }
+
+    public String getIconClassName() {
+        return "symbol-cloud";
+    }
+
+    @SuppressWarnings("unused") // stapler
+    public String getIconAltText() {
+        return getClass().getSimpleName().replace("Cloud", "");
+    }
+
+    /**
+     * Deletes the cloud.
+     */
+    @RequirePOST
+    public HttpResponse doDoDelete() throws IOException {
+        checkPermission(Jenkins.ADMINISTER);
+        Jenkins.get().clouds.remove(this);
+        return new HttpRedirect("../..");
+    }
+
+    /**
+     * Accepts the update to the node configuration.
+     */
+    @POST
+    public void doConfigSubmit(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException, Descriptor.FormException {
+        checkPermission(Jenkins.ADMINISTER);
+
+        String proposedName = Util.fixEmptyAndTrim(req.getSubmittedForm().getString("name"));
+        Jenkins.checkGoodName(proposedName);
+
+        Cloud cloud = Jenkins.get().getCloud(name);
+        if (cloud == null) {
+            throw new ServletException("No such cloud " + name);
+        }
+
+        if (!proposedName.equals(name)
+                && Jenkins.get().getCloud(proposedName) != null) {
+            throw new Descriptor.FormException(jenkins.agents.Messages.CloudSet_CloudAlreadyExists(proposedName), "name");
+        }
+
+        Cloud result = cloud.reconfigure(req, req.getSubmittedForm());
+        Jenkins.get().clouds.replace(this, result);
+
+        // take the user back to the cloud top page.
+        rsp.sendRedirect2("../../" + result.getUrl());
+    }
+
+    public Cloud reconfigure(@NonNull final StaplerRequest req, JSONObject form) throws Descriptor.FormException {
+        if (form == null)     return null;
+        return getDescriptor().newInstance(req, form);
+    }
+
     /**
      * Parameter object for {@link hudson.slaves.Cloud}.
      * @since 2.259

core/src/main/java/jenkins/agents/CloudSet.java

@@ -0,0 +1,209 @@
+package jenkins.agents;
+
+import hudson.Extension;
+import hudson.Util;
+import hudson.model.AbstractModelObject;
+import hudson.model.AutoCompletionCandidates;
+import hudson.model.Describable;
+import hudson.model.Descriptor;
+import hudson.model.Failure;
+import hudson.model.RootAction;
+import hudson.slaves.Cloud;
+import hudson.util.FormValidation;
+import java.io.IOException;
+import java.util.List;
+import java.util.stream.Collectors;
+import javax.servlet.ServletException;
+import jenkins.model.Jenkins;
+import jenkins.model.ModelObjectWithChildren;
+import jenkins.model.ModelObjectWithContextMenu;
+import net.sf.json.JSONObject;
+import org.kohsuke.stapler.QueryParameter;
+import org.kohsuke.stapler.StaplerFallback;
+import org.kohsuke.stapler.StaplerRequest;
+import org.kohsuke.stapler.StaplerResponse;
+import org.kohsuke.stapler.export.Exported;
+import org.kohsuke.stapler.export.ExportedBean;
+import org.kohsuke.stapler.interceptor.RequirePOST;
+import org.kohsuke.stapler.verb.POST;
+
+@ExportedBean
+@Extension
+public class CloudSet extends AbstractModelObject implements Describable<CloudSet>, StaplerFallback, ModelObjectWithChildren, RootAction {
+    @Override
+    public Descriptor<CloudSet> getDescriptor() {
+        return Jenkins.get().getDescriptorOrDie(CloudSet.class);
+    }
+
+    @Override
+    public String getIconFileName() {
+        return null;
+    }
+
+    @Override
+    public String getDisplayName() {
+        return Messages.CloudSet_DisplayName();
+    }
+
+    @Override
+    public String getUrlName() {
+        return "cloudSet";
+    }
+
+    @Override
+    public String getSearchUrl() {
+        return "/cloudSet/";
+    }
+
+    @Exported(name = "cloud", inline = true)
+    public Jenkins.CloudList get_all() {
+        return Jenkins.get().clouds;
+    }
+
+    @Override
+    public ModelObjectWithContextMenu.ContextMenu doChildrenContextMenu(StaplerRequest request, StaplerResponse response) throws Exception {
+        ModelObjectWithContextMenu.ContextMenu m = new ModelObjectWithContextMenu.ContextMenu();
+        get_all().stream().forEach(c -> m.add(c));
+        return m;
+    }
+
+    @Override
+    public Object getStaplerFallback() {
+        return Jenkins.get();
+    }
+
+    /**
+     * Gets all the agent names.
+     */
+    @SuppressWarnings("unused") // stapler
+    public List<String> get_cloudNames() {
+        return Jenkins.get().clouds
+                .stream()
+                .map(c -> c.name)
+                .collect(Collectors.toList());
+    }
+
+    /**
+     * Makes sure that the given name is good as an agent name.
+     * @return trimmed name if valid; throws ParseException if not
+     */
+    public String checkName(String name) throws Failure {
+        if (name == null)
+            throw new Failure("Query parameter 'name' is required");
+
+        name = name.trim();
+        Jenkins.checkGoodName(name);
+
+        if (Jenkins.get().getCloud(name) != null)
+            throw new Failure(Messages.CloudSet_CloudAlreadyExists(name));
+
+        // looks good
+        return name;
+    }
+
+    @SuppressWarnings("unused") // stapler
+    public FormValidation doCheckName(@QueryParameter String value) {
+        Jenkins.get().checkPermission(Jenkins.ADMINISTER);
+        if (Util.fixEmpty(value) == null) {
+            return FormValidation.ok();
+        }
+        try {
+            checkName(value);
+            return FormValidation.ok();
+        } catch (Failure e) {
+            return FormValidation.error(e.getMessage());
+        }
+    }
+
+    /**
+     * First check point in creating a new cloud.
+     */
+    @RequirePOST
+    public synchronized void doCreateItem(StaplerRequest req, StaplerResponse rsp,
+                                          @QueryParameter String name, @QueryParameter String mode,
+                                          @QueryParameter String from) throws IOException, ServletException, Descriptor.FormException {
+        final Jenkins jenkins = Jenkins.get();
+        jenkins.checkPermission(Jenkins.ADMINISTER);
+
+        if (mode != null && mode.equals("copy")) {
+            name = checkName(name);
+
+            Cloud src = jenkins.getCloud(from);
+            if (src == null) {
+                if (Util.fixEmpty(from) == null) {
+                    throw new Failure(Messages.CloudSet_SpecifyCloudToCopy());
+                } else {
+                    throw new Failure(Messages.CloudSet_NoSuchCloud(from));
+                }
+            }
+
+            // copy through XStream
+            String xml = Jenkins.XSTREAM.toXML(src);
+            // Not great, but cloud name is final
+            xml = xml.replace("<name>" + src.name + "</name>", "<name>" + name + "</name>");
+            Cloud result = (Cloud) Jenkins.XSTREAM.fromXML(xml);
+            jenkins.clouds.add(result);
+            // send the browser to the config page
+            rsp.sendRedirect2(result.getUrl() + "configure");
+        } else {
+            // proceed to step 2
+            if (mode == null) {
+                throw new Failure("No mode given");
+            }
+
+            Descriptor<Cloud> d = Cloud.all().findByName(mode);
+            if (d == null) {
+                throw new Failure("No node type ‘" + mode + "’ is known");
+            }
+            handleNewCloudPage(d, name, req, rsp);
+        }
+    }
+
+    private void handleNewCloudPage(Descriptor<Cloud> descriptor, String name, StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException, Descriptor.FormException {
+        checkName(name);
+        JSONObject formData = req.getSubmittedForm();
+        formData.put("name", name);
+        formData.put("cloudName", name);
+        formData.remove("mode"); // Cloud descriptors won't have this field.
+        Cloud instance = descriptor.newInstance(req, formData); // Not great but that's the best I have so far to pass the given name.
+        req.setAttribute("instance", instance);
+        req.setAttribute("descriptor", descriptor);
+        req.getView(this, "_new.jelly").forward(req, rsp);
+    }
+
+    /**
+     * Really creates a new agent.
+     */
+    @POST
+    public synchronized void doDoCreateItem(StaplerRequest req, StaplerResponse rsp,
+                                            @QueryParameter("_.name") String name,
+                                            @QueryParameter String type) throws IOException, ServletException, Descriptor.FormException {
+        final Jenkins app = Jenkins.get();
+        app.checkPermission(Jenkins.ADMINISTER);
+        String fixedName = Util.fixEmptyAndTrim(name);
+        checkName(fixedName);
+
+        JSONObject formData = req.getSubmittedForm();
+        formData.put("_.name", fixedName);
+
+        Cloud result = Cloud.all().find(type).newInstance(req, formData);
+        app.clouds.add(result);
+
+        // take the user back to the cloud list top page
+        rsp.sendRedirect2(".");
+    }
+
+    @Extension
+    public static class DescriptorImpl extends Descriptor<CloudSet> {
+        /**
+         * Auto-completion for the "copy from" field in the new cloud page.
+         */
+        public AutoCompletionCandidates doAutoCompleteCopyNewItemFrom(@QueryParameter final String value) {
+            final AutoCompletionCandidates r = new AutoCompletionCandidates();
+            Jenkins.get().clouds.stream()
+                    .filter(c -> c.name.startsWith(value))
+                    .forEach(c -> r.add(c.name));
+            return r;
+        }
+    }
+}

core/src/main/java/jenkins/agents/CloudsLink.java

@@ -0,0 +1,37 @@
+package jenkins.agents;
+
+import edu.umd.cs.findbugs.annotations.NonNull;
+import hudson.Extension;
+import hudson.model.ManagementLink;
+import org.jenkinsci.Symbol;
+
+@Extension
+@Symbol("clouds")
+public class CloudsLink extends ManagementLink {
+
+    @Override
+    public String getDisplayName() {
+        return Messages.CloudsLink_DisplayName();
+    }
+
+    @Override
+    public String getDescription() {
+        return Messages.CloudsLink_Description();
+    }
+
+    @Override
+    public String getIconFileName() {
+        return "symbol-cloud";
+    }
+
+    @Override
+    public String getUrlName() {
+        return "cloudSet";
+    }
+
+    @NonNull
+    @Override
+    public Category getCategory() {
+        return Category.CONFIGURATION;
+    }
+}

core/src/main/java/jenkins/management/NodesLink.java

@@ -39,7 +39,7 @@ public class NodesLink extends ManagementLink {
 
     @Override
     public String getIconFileName() {
-        return "symbol-cloud";
+        return "symbol-computer";
     }
 
     @Override

core/src/main/java/jenkins/model/ModelObjectWithContextMenu.java

@@ -10,6 +10,7 @@
 import hudson.model.Job;
 import hudson.model.ModelObject;
 import hudson.model.Node;
+import hudson.slaves.Cloud;
 import java.io.IOException;
 import java.net.URI;
 import java.net.URISyntaxException;
@@ -207,6 +208,13 @@ public ContextMenu add(Computer c) {
                 .withContextRelativeUrl(c.getUrl()));
         }
 
+        public ContextMenu add(Cloud c) {
+            return add(new MenuItem()
+                    .withDisplayName(c.getDisplayName())
+                    .withIconClass(c.getIconClassName())
+                    .withContextRelativeUrl(c.getUrl()));
+        }
+
         /**
          * Adds a child item when rendering context menu of its parent.
          *

core/src/main/resources/hudson/model/ComputerSet/index.jelly

@@ -31,7 +31,7 @@ THE SOFTWARE.
   <st:include page="sidepanel.jelly" />
   <!-- no need for additional breadcrumb here as we're on an index page already including breadcrumb -->
   <l:main-panel>
-    <l:app-bar title="${%Manage nodes and clouds}">
+    <l:app-bar title="${%Manage nodes}">
       <l:hasAdministerOrManage>
         <j:getStatic var="createPermission" className="hudson.model.Computer" field="CREATE"/>
         <j:if test="${h.hasPermission(createPermission)}">

core/src/main/resources/hudson/model/ComputerSet/sidepanel.jelly

@@ -30,8 +30,8 @@ THE SOFTWARE.
   <l:header />
   <l:side-panel>
     <l:tasks>
-      <l:task href="../configureClouds" icon="symbol-cloud" permission="${app.SYSTEM_READ}"
-              title="${app.hasPermission(app.ADMINISTER) ? '%Configure Clouds' : '%View Clouds'}"/>
+      <l:task href="../computer" icon="symbol-computer" permission="${app.SYSTEM_READ}"
+              title="${app.hasPermission(app.ADMINISTER) ? '%Configure Nodes' : '%View Nodes'}"/>
       <l:task href="configure" icon="symbol-settings" permissions="${app.MANAGE_AND_SYSTEM_READ}" title="${%Node Monitoring}"/>
     </l:tasks>
     <t:queue items="${app.queue.items}" />