[JENKINS-71737] Fix redirect when submitting cloud changes

core/src/main/java/hudson/model/AbstractItem.java

@@ -111,7 +111,7 @@
 // Item doesn't necessarily have to be Actionable, but
 // Java doesn't let multiple inheritance.
 @ExportedBean
-public abstract class AbstractItem extends Actionable implements Item, HttpDeletable, AccessControlled, DescriptorByNameOwner, StaplerProxy {
+public abstract class AbstractItem extends Actionable implements Item, HttpDeletable, AccessControlled, DescriptorByNameOwner, StaplerProxy, Renamable {
 
     private static final Logger LOGGER = Logger.getLogger(AbstractItem.class.getName());
 
@@ -245,6 +245,7 @@ protected void doSetName(String name) {
      * @see #renameTo
      * @since 2.110
      */
+    @Override
     public boolean isNameEditable() {
         return false;
     }
@@ -254,6 +255,7 @@ public boolean isNameEditable() {
      */
     @RequirePOST
     @Restricted(NoExternalUse.class)
+    @Override
     public HttpResponse doConfirmRename(@QueryParameter String newName) throws IOException {
         newName = newName == null ? null : newName.trim();
         FormValidation validationError = doCheckNewName(newName);
@@ -274,6 +276,7 @@ public HttpResponse doConfirmRename(@QueryParameter String newName) throws IOExc
      * {@link FormValidation#error} with a message explaining the problem.
      */
     @Restricted(NoExternalUse.class)
+    @Override
     public @NonNull FormValidation doCheckNewName(@QueryParameter String newName) {
 
         if (!isNameEditable()) {

core/src/main/java/hudson/model/Renamable.java

@@ -0,0 +1,63 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2023 CloudBees, Inc.
+ *
+ * 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 hudson.model;
+
+import edu.umd.cs.findbugs.annotations.NonNull;
+import hudson.util.FormValidation;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.ProtectedExternally;
+import org.kohsuke.stapler.HttpResponse;
+import org.kohsuke.stapler.QueryParameter;
+
+/**
+ * Interface used to create a dedicated page that changes the name property of an Object.
+ * See also {@link jenkins.model.RenameAction}.
+ *
+ * @since TODO
+ */
+@Restricted(ProtectedExternally.class)
+public interface Renamable {
+
+    /**
+     * Controls whether the default rename action is available for this object.
+     *
+     * @return whether the name can be modified by a user
+     */
+    boolean isNameEditable();
+
+    /**
+     * Renames the object
+     *
+     */
+    HttpResponse doConfirmRename(@QueryParameter String newName) throws Exception;
+
+    /**
+     * Controls whether the default rename action is available.
+     *
+     * @return whether object name can be modified by a user
+     */
+    @NonNull
+    FormValidation doCheckNewName(@QueryParameter String newName);
+}

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

@@ -30,15 +30,18 @@
 import hudson.DescriptorExtensionList;
 import hudson.Extension;
 import hudson.ExtensionPoint;
+import hudson.Functions;
 import hudson.Util;
 import hudson.init.InitMilestone;
 import hudson.init.Initializer;
 import hudson.model.Actionable;
 import hudson.model.Computer;
 import hudson.model.Describable;
 import hudson.model.Descriptor;
+import hudson.model.Failure;
 import hudson.model.Label;
 import hudson.model.Node;
+import hudson.model.Renamable;
 import hudson.model.Slave;
 import hudson.security.ACL;
 import hudson.security.AccessControlled;
@@ -47,6 +50,7 @@
 import hudson.slaves.NodeProvisioner.PlannedNode;
 import hudson.util.DescriptorList;
 import hudson.util.FormApply;
+import hudson.util.FormValidation;
 import java.io.IOException;
 import java.util.Collection;
 import java.util.Objects;
@@ -57,9 +61,12 @@
 import org.apache.commons.lang.Validate;
 import org.kohsuke.accmod.Restricted;
 import org.kohsuke.accmod.restrictions.DoNotUse;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.HttpRedirect;
 import org.kohsuke.stapler.HttpResponse;
+import org.kohsuke.stapler.HttpResponses;
+import org.kohsuke.stapler.QueryParameter;
 import org.kohsuke.stapler.StaplerRequest;
 import org.kohsuke.stapler.StaplerResponse;
 import org.kohsuke.stapler.interceptor.RequirePOST;
@@ -107,7 +114,7 @@
  * @see NodeProvisioner
  * @see AbstractCloudImpl
  */
-public abstract class Cloud extends Actionable implements ExtensionPoint, Describable<Cloud>, AccessControlled {
+public abstract class Cloud extends Actionable implements ExtensionPoint, Describable<Cloud>, AccessControlled, Renamable {
 
     /**
      * Uniquely identifies this {@link Cloud} instance among other instances in {@link jenkins.model.Jenkins#clouds}.
@@ -310,8 +317,68 @@ public HttpResponse doDoDelete() throws IOException {
         return new HttpRedirect("..");
     }
 
+
+    @Override
+    public boolean isNameEditable() {
+        return true;
+    }
+
+    @RequirePOST
+    @Restricted(NoExternalUse.class)
+    @Override
+    public HttpResponse doConfirmRename(@QueryParameter String newName) throws IOException, ServletException, Descriptor.FormException {
+        newName = newName == null ? null : newName.trim();
+        FormValidation validationError = doCheckNewName(newName);
+        if (validationError.kind != FormValidation.Kind.OK) {
+            throw new Failure(validationError.getMessage());
+        }
+        this.name = newName;
+
+        // take the user to the renamed cloud top page.
+        return HttpResponses.redirectTo("../" + Functions.encode(newName));
+    }
+
+    @NonNull
+    @Restricted(NoExternalUse.class)
+    @Override
+    public FormValidation doCheckNewName(String newName) {
+        if (!isNameEditable()) {
+            return FormValidation.error("Trying to rename an item that does not support this operation.");
+        }
+        checkPermission(Jenkins.ADMINISTER);
+
+        newName = newName == null ? null : newName.trim();
+
+        try {
+            Jenkins.checkGoodName(newName);
+            assert newName != null; // Would have thrown Failure
+            if (newName.equals(name)) {
+                return FormValidation.warning(hudson.model.Messages.AbstractItem_NewNameUnchanged());
+            }
+            if (Jenkins.get().getCloud(newName) != null) {
+                return FormValidation.warning(jenkins.agents.Messages.CloudSet_CloudAlreadyExists(newName));
+            }
+            checkRename(newName);
+        } catch (Failure e) {
+            return FormValidation.error(e.getMessage());
+        }
+        return FormValidation.ok();
+    }
+
+    /**
+     * Allows subclasses to block renames for domain-specific reasons. Generic validation of the new name
+     * (e.g., null checking, checking for illegal characters, and checking that the name is not in use)
+     * always happens prior to calling this method.
+     *
+     * @param newName the new name for the item
+     * @throws Failure if the rename should be blocked
+     */
+    protected void checkRename(@NonNull String newName) throws Failure {
+
+    }
+
     /**
-     * Accepts the update to the node configuration.
+     * Accepts the update to the node configuration. To change node name see {@link #doConfirmRename(String)}.
      */
     @POST
     public HttpResponse doConfigSubmit(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException, Descriptor.FormException {
@@ -322,11 +389,13 @@ public HttpResponse doConfigSubmit(StaplerRequest req, StaplerResponse rsp) thro
         if (cloud == null) {
             throw new ServletException("No such cloud " + this.name);
         }
-        Cloud result = cloud.reconfigure(req, req.getSubmittedForm());
-        String proposedName = result.name;
-        if (!proposedName.equals(this.name)
-                && j.getCloud(proposedName) != null) {
-            throw new Descriptor.FormException(jenkins.agents.Messages.CloudSet_CloudAlreadyExists(proposedName), "name");
+        JSONObject formData = req.getSubmittedForm();
+        // add the cloud name to the submitted form data
+        formData.put("name", name);
+        Cloud result = cloud.reconfigure(req, formData);
+        if (!(result.name).equals(this.name)) {
+            // Do not rename the cloud in the config page. Use doConfirmRename()
+            result.name = this.name;
         }
         j.clouds.replace(this, result);
         j.save();

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

@@ -226,7 +226,6 @@ private void handleNewCloudPage(Descriptor<Cloud> descriptor, String name, Stapl
         checkName(name);
         JSONObject formData = req.getSubmittedForm();
         formData.put("name", name);
-        formData.put("cloudName", name); // ec2 uses that field name
         formData.remove("mode"); // Cloud descriptors won't have this field.
         req.setAttribute("instance", formData);
         req.setAttribute("descriptor", descriptor);

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

@@ -25,8 +25,8 @@
 package jenkins.model;
 
 import hudson.Extension;
-import hudson.model.AbstractItem;
 import hudson.model.Action;
+import hudson.model.Renamable;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.Set;
@@ -52,15 +52,15 @@ public String getUrlName() {
     }
 
     @Extension
-    public static class TransientActionFactoryImpl extends TransientActionFactory<AbstractItem> {
+    public static class TransientActionFactoryImpl extends TransientActionFactory<Renamable> {
 
         @Override
-        public Class<AbstractItem> type() {
-            return AbstractItem.class;
+        public Class<Renamable> type() {
+            return Renamable.class;
         }
 
         @Override
-        public Collection<? extends Action> createFor(AbstractItem target) {
+        public Collection<? extends Action> createFor(Renamable target) {
             if (target.isNameEditable()) {
                 return Set.of(new RenameAction());
             } else {

core/src/main/resources/hudson/slaves/Cloud/confirm-rename.jelly

@@ -0,0 +1,43 @@
+<!--
+The MIT License
+
+Copyright 2018 CloudBees, Inc.
+
+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:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form" xmlns:i="jelly:fmt">
+  <l:layout title="${%Rename}">
+    <st:include page="sidepanel.jelly" />
+    <l:breadcrumb title="${%Rename}" />
+    <l:main-panel>
+      <h1>${%DescribeRename(it.name)}</h1>
+      <f:form method="post" action="confirmRename" name="config" tableClass="config-table scrollspy">
+        <f:entry title="${%NewName}">
+          <f:textbox name="newName" value="${it.name}" autocomplete="on" checkUrl="checkNewName" checkDependsOn="newName"/>
+        </f:entry>
+        <f:bottomButtonBar>
+          <f:submit value="${%Rename}" />
+        </f:bottomButtonBar>
+      </f:form>
+      <st:adjunct includes="lib.form.confirm" />
+    </l:main-panel>
+  </l:layout>
+</j:jelly>

core/src/main/resources/hudson/slaves/Cloud/confirm-rename.properties

@@ -0,0 +1,25 @@
+# The MIT License
+#
+# Copyright (c) 2018 CloudBees, Inc.
+#
+# 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.
+
+DescribeRename=Rename {0}
+NewName=New Name
+Rename=Rename

core/src/main/resources/hudson/slaves/Cloud/confirm-rename_de.properties

@@ -0,0 +1,3 @@
+DescribeRename={0} umbenennen
+NewName=Neuer Name
+Rename=Umbenennen

core/src/main/resources/hudson/slaves/Cloud/confirm-rename_fr.properties

@@ -0,0 +1 @@
+Rename=Renommer

core/src/main/resources/hudson/slaves/Cloud/confirm-rename_it.properties

@@ -0,0 +1,26 @@
+# The MIT License
+#
+# Italian localization plugin for Jenkins
+# Copyright © 2020 Alessandro Menti
+#
+# 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.
+
+DescribeRename=Rinomina {0}
+NewName=Nuovo nome
+Rename=Rinomina