Merge pull request #1938 from pjanouse/JENKINS-31776

[JENKINS-31776] CLI command online-node extracted from core to CLI

core/src/main/java/hudson/cli/OnlineNodeCommand.java

+/*
+ * The MIT License
+ *
+ * Copyright 2015 Red Hat, 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.cli;
+
+import hudson.Extension;
+import hudson.model.Computer;
+import jenkins.model.Jenkins;
+
+import org.acegisecurity.AccessDeniedException;
+import org.kohsuke.args4j.Argument;
+
+import java.util.logging.Logger;
+
+/**
+ * @author pjanouse
+ * @since TODO
+ */
+@Extension
+public class OnlineNodeCommand extends CLICommand {
+
+    @Argument(metaVar="NAME", usage="Slave name, or empty string for master")
+    public String computerName;
+
+    private static final Logger LOGGER = Logger.getLogger(OnlineNodeCommand.class.getName());
+
+    @Override
+    public String getShortDescription() {
+
+        return Messages.OnlineNodeCommand_ShortDescription();
+    }
+
+    @Override
+    protected int run() throws Exception {
+
+        boolean errorOccurred = false;
+
+        final Jenkins jenkins = Jenkins.getInstance();
+
+        Computer computer = jenkins.getComputer(computerName);
+
+        if (computer == null) {
+            stderr.println(hudson.model.Messages.Computer_NoSuchSlaveExists(computerName, null));
+            errorOccurred = true;
+        } else {
+            try {
+                computer.cliOnline();
+            } catch (AccessDeniedException e) {
+                stderr.println(e.getMessage());
+                errorOccurred = true;
+            } catch (Exception e) {
+                final String errorMsg = String.format("Unexpected exception occurred during performing online operation on node '%s': %s",
+                        computer == null ? "(null)" : computer.getName(),
+                        e.getMessage());
+                stderr.println(errorMsg);
+                LOGGER.warning(errorMsg);
+                errorOccurred = true;
+            }
+        }
+
+        return errorOccurred ? 1 : 0;
+    }
+
+}

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

@@ -522,7 +522,6 @@ public /*transient*/ abstract class Computer extends Actionable implements Acces
         setTemporarilyOffline(true, new ByCLI(cause));
     }
 
-    @CLIMethod(name="online-node")
     public void cliOnline() throws ExecutionException, InterruptedException {
         checkPermission(CONNECT);
         setTemporarilyOffline(false, null);

core/src/main/resources/hudson/cli/Messages.properties

@@ -85,3 +85,4 @@ DeleteNodeCommand.ShortDescription=Deletes node(s)
 
 ReloadJobCommand.ShortDescription=Reload job(s)
 
+OnlineNodeCommand.ShortDescription=Resume using a node for performing builds, to cancel out the earlier "offline-node" command.

core/src/main/resources/hudson/cli/Messages_da.properties

 DeleteNodeCommand.ShortDescription=Sletter en node
 DeleteJobCommand.ShortDescription=Sletter et job
+
+OnlineNodeCommand.ShortDescription=Genoptag brugen af en byggenode, for at annullere en tidligere udstedt "offline-node" kommando.

core/src/main/resources/hudson/cli/Messages_de.properties

 DeleteNodeCommand.ShortDescription=Knoten l\u00f6schen.
 DeleteJobCommand.ShortDescription=Job l\u00f6schen.
+
+OnlineNodeCommand.ShortDescription=Knoten wird wieder f\u00fcr neue Builds verwendet. Hebt ein vorausgegangenes "offline-node"-Kommando auf.

core/src/main/resources/hudson/cli/Messages_es.properties

@@ -50,3 +50,5 @@ SetBuildDescriptionCommand.ShortDescription=Establece la descripci
 DeleteJobCommand.ShortDescription=Borrar una tarea
 
 DeleteNodeCommand.ShortDescription=Borrar un nodo
+
+OnlineNodeCommand.ShortDescription=Continuar usando un nodo y candelar el comando "offline-node" mas reciente.

core/src/main/resources/hudson/cli/Messages_it.properties

 DeleteNodeCommand.ShortDescription=Cancella un nodo
 DeleteJobCommand.ShortDescription=Cancella un job
+
+OnlineNodeCommand.ShortDescription=Resume using a node for performing builds, to cancel out the earlier "offline-node" command.

core/src/main/resources/hudson/cli/Messages_ja.properties

@@ -72,3 +72,5 @@ BuildCommand.CLICause.CannotBuildUnknownReasons=\
 
 DeleteNodeCommand.ShortDescription=\u30ce\u30fc\u30c9\u3092\u524a\u9664\u3057\u307e\u3059\u3002
 DeleteJobCommand.ShortDescription=\u30b8\u30e7\u30d6\u3092\u524a\u9664\u3057\u307e\u3059\u3002
+
+OnlineNodeCommand.ShortDescription=\u76f4\u524d\u306b\u5b9f\u884c\u3057\u305f"online-node"\u30b3\u30de\u30f3\u30c9\u3092\u53d6\u308a\u6d88\u3057\u3001\u30d3\u30eb\u30c9\u3092\u5b9f\u884c\u3059\u308b\u30ce\u30fc\u30c9\u306e\u4f7f\u7528\u3092\u518d\u958b\u3057\u307e\u3059\u3002

core/src/main/resources/hudson/cli/Messages_pt_BR.properties

@@ -118,3 +118,5 @@ DeleteJobCommand.ShortDescription=Remover uma job(s)
 
 ReloadJobCommand.ShortDescription=\
  Recarrega job(s) do disco.
+
+OnlineNodeCommand.ShortDescription=Continuar usando um n\u00f3 para realizar os builds

core/src/main/resources/hudson/model/Messages.properties

@@ -95,7 +95,6 @@ CLI.disable-job.shortDescription=Disables a job.
 CLI.enable-job.shortDescription=Enables a job.
 CLI.disconnect-node.shortDescription=Disconnects from a node.
 CLI.connect-node.shortDescription=Reconnect to a node.
-CLI.online-node.shortDescription=Resume using a node for performing builds, to cancel out the earlier "offline-node" command.
 CLI.offline-node.shortDescription=Stop using a node for performing builds temporarily, until the next "online-node" command.
 CLI.wait-node-online.shortDescription=Wait for a node to become online.
 CLI.wait-node-offline.shortDescription=Wait for a node to become offline.

core/src/main/resources/hudson/model/Messages_da.properties

@@ -216,7 +216,6 @@ Queue.InProgress=Et byg er allerede i gang
 Computer.DeletePermission.Description=Denne rettighed tillader brugere at slette eksisterende slaver.
 UpdateCenter.Status.ConnectionFailed= 
 UpdateCenter.PluginCategory.maven=Maven
-CLI.online-node.shortDescription=Genoptag brugen af en byggenode, for at annullere en tidligere udstedt "offline-node" kommando.
 Computer.Permissions.Title=Slave
 BallColor.Success=Succes
 UpdateCenter.PluginCategory.upload=Artifaktsendere

core/src/main/resources/hudson/model/Messages_de.properties

@@ -84,7 +84,6 @@ CLI.enable-job.shortDescription=Job aktivieren.
 CLI.connect-node.shortDescription=Erneut mit Knoten verbinden.
 CLI.disconnect-node.shortDescription=Knoten trennen.
 CLI.offline-node.shortDescription=Knoten wird bis zum n\u00e4chsten "online-node"-Kommando f\u00fcr keine neuen Builds verwendet.
-CLI.online-node.shortDescription=Knoten wird wieder f\u00fcr neue Builds verwendet. Hebt ein vorausgegangenes "offline-node"-Kommando auf.
 CLI.safe-restart.shortDescription=Startet Jenkins neu.
 Queue.init=Build-Warteschlange neu initialisieren
 

core/src/main/resources/hudson/model/Messages_es.properties

@@ -61,7 +61,6 @@ CLI.disable-job.shortDescription=Desactivar una tarea
 CLI.enable-job.shortDescription=Activar una tarea
 CLI.disconnect-node.shortDescription=Desconectarse de un nodo
 CLI.connect-node.shortDescription=Reconectarse con un nodo
-CLI.online-node.shortDescription=Continuar usando un nodo y candelar el comando "offline-node" mas reciente.
 CLI.offline-node.shortDescription=Dejar de utilizar un nodo temporalmente hasta que se ejecute el comando "online-node".
 
 Computer.Caption=Remoto {0}

core/src/main/resources/hudson/model/Messages_it.properties

@@ -78,7 +78,6 @@ CLI.disable-job.shortDescription=Disabilita un job
 CLI.enable-job.shortDescription=Abilita un job
 CLI.disconnect-node.shortDescription=Disconnects from a node
 CLI.connect-node.shortDescription=Riconnettersi ad un nodo
-CLI.online-node.shortDescription=Resume using a node for performing builds, to cancel out the earlier "offline-node" command.
 CLI.offline-node.shortDescription=Stop using a node for performing builds temporarily, until the next "online-node" command.
 CLI.wait-node-online.shortDescription=Attende che il nodo sia attivo
 CLI.wait-node-offline.shortDescription=Attende che un nodo sia disattivo

core/src/main/resources/hudson/model/Messages_ja.properties

@@ -320,7 +320,6 @@ CLI.disable-job.shortDescription=\u30b8\u30e7\u30d6\u3092\u7121\u52b9\u5316\u305
 CLI.enable-job.shortDescription=\u30b8\u30e7\u30d6\u3092\u6709\u52b9\u5316\u3057\u307e\u3059\u3002
 CLI.disconnect-node.shortDescription=\u30ce\u30fc\u30c9\u3068\u306e\u63a5\u7d9a\u3092\u5207\u65ad\u3057\u307e\u3059\u3002
 CLI.connect-node.shortDescription=\u30ce\u30fc\u30c9\u3068\u518d\u63a5\u7d9a\u3057\u307e\u3059\u3002
-CLI.online-node.shortDescription=\u76f4\u524d\u306b\u5b9f\u884c\u3057\u305f"online-node"\u30b3\u30de\u30f3\u30c9\u3092\u53d6\u308a\u6d88\u3057\u3001\u30d3\u30eb\u30c9\u3092\u5b9f\u884c\u3059\u308b\u30ce\u30fc\u30c9\u306e\u4f7f\u7528\u3092\u518d\u958b\u3057\u307e\u3059\u3002
 CLI.offline-node.shortDescription="online-node"\u30b3\u30de\u30f3\u30c9\u304c\u5b9f\u884c\u3055\u308c\u308b\u307e\u3067\u3001\u30d3\u30eb\u30c9\u3092\u5b9f\u884c\u3059\u308b\u30ce\u30fc\u30c9\u306e\u4f7f\u7528\u3092\u4e00\u6642\u7684\u306b\u505c\u6b62\u3057\u307e\u3059\u3002
 CLI.wait-node-online.shortDescription=\u30ce\u30fc\u30c9\u304c\u30aa\u30f3\u30e9\u30a4\u30f3\u306b\u306a\u308b\u306e\u3092\u5f85\u3061\u307e\u3059\u3002
 CLI.wait-node-offline.shortDescription=\u30ce\u30fc\u30c9\u304c\u30aa\u30d5\u30e9\u30a4\u30f3\u306b\u306a\u308b\u306e\u3092\u5f85\u3061\u307e\u3059\u3002

core/src/main/resources/hudson/model/Messages_pt_BR.properties

@@ -357,8 +357,6 @@ UpdateCenter.Status.ConnectionFailed=Erro ao conectar {0} /
 UpdateCenter.PluginCategory.maven=Maven
 # Slave
 Computer.Permissions.Title=Slave
-# Resume using a node for performing builds, to cancel out the earlier "offline-node" command.
-CLI.online-node.shortDescription=Continuar usando um n\u00f3 para realizar os builds
 # Artifact Uploaders
 UpdateCenter.PluginCategory.upload=Carregadores de artefatos
 # Last unstable build

test/src/test/java/hudson/cli/OnlineNodeCommandTest.java

+/*
+ * The MIT License
+ *
+ * Copyright 2015 Red Hat, 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.
+ */
+
+/**
+ * @author pjanouse
+ */
+
+package hudson.cli;
+
+import hudson.model.Computer;
+import hudson.slaves.DumbSlave;
+import jenkins.model.Jenkins;
+import org.junit.Before;
+import org.junit.Ignore;
+import org.junit.Rule;
+import org.junit.Test;
+import org.jvnet.hudson.test.JenkinsRule;
+
+import static hudson.cli.CLICommandInvoker.Matcher.failedWith;
+import static hudson.cli.CLICommandInvoker.Matcher.hasNoStandardOutput;
+import static hudson.cli.CLICommandInvoker.Matcher.succeededSilently;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.containsString;
+import static org.hamcrest.Matchers.equalTo;
+
+public class OnlineNodeCommandTest {
+
+    private CLICommandInvoker command;
+
+    @Rule public final JenkinsRule j = new JenkinsRule();
+
+    @Before public void setUp() {
+
+        command = new CLICommandInvoker(j, "online-node");
+    }
+
+    @Test public void onlineNodeShouldFailWithoutComputerConnectPermission() throws Exception {
+
+        j.createSlave("aNode", "", null);
+
+        final CLICommandInvoker.Result result = command
+                .authorizedTo(Jenkins.READ)
+                .invokeWithArgs("aNode");
+
+        assertThat(result, failedWith(1));
+        assertThat(result, hasNoStandardOutput());
+        assertThat(result.stderr(), containsString("user is missing the Slave/Connect permission"));
+    }
+
+    @Test public void onlineNodeShouldFailIfNodeDoesNotExist() throws Exception {
+        final CLICommandInvoker.Result result = command
+                .authorizedTo(Computer.CONNECT, Jenkins.READ)
+                .invokeWithArgs("never_created");
+        assertThat(result, failedWith(1));
+        assertThat(result, hasNoStandardOutput());
+        assertThat(result.stderr(), containsString("No such slave \"never_created\" exists."));
+
+    }
+
+    @Test public void onlineNodeShouldSucceed() throws Exception {
+
+        DumbSlave slave = j.createSlave("aNode", "", null);
+
+        CLICommandInvoker.Result result = command
+                .authorizedTo(Computer.CONNECT, Jenkins.READ)
+                .invokeWithArgs("aNode");
+
+        assertThat(result, succeededSilently());
+        if (slave.toComputer().isConnecting()) {
+            System.out.println("Waiting until online in progress...");
+            slave.toComputer().waitUntilOnline();
+        }
+        assertThat(slave.toComputer().isOnline(), equalTo(true));
+    }
+
+    @Test public void onlineNodeShouldSucceedOnOnlineNode() throws Exception {
+
+        DumbSlave slave = j.createSlave("aNode", "", null);
+
+        if (slave.toComputer().isConnecting()) {
+            System.out.println("Waiting until online in progress...");
+            slave.toComputer().waitUntilOnline();
+        }
+
+        assertThat(slave.toComputer().isOnline(), equalTo(true));
+
+        CLICommandInvoker.Result result = command
+                .authorizedTo(Computer.CONNECT, Jenkins.READ)
+                .invokeWithArgs("aNode");
+
+        assertThat(result, succeededSilently());
+        assertThat(slave.toComputer().isOnline(), equalTo(true));
+    }
+
+    @Test public void onlineNodeShouldSucceedOnOfflieNode() throws Exception {
+
+        DumbSlave slave = j.createSlave("aNode", "", null);
+
+        if (slave.toComputer().isConnecting()) {
+            System.out.println("Waiting until online in progress...");
+            slave.toComputer().waitUntilOnline();
+        }
+
+        assertThat(slave.toComputer().isOnline(), equalTo(true));
+
+        slave.toComputer().setTemporarilyOffline(true);
+        slave.toComputer().waitUntilOffline();
+        assertThat(slave.toComputer().isOffline(), equalTo(true));
+
+        CLICommandInvoker.Result result = command
+                .authorizedTo(Computer.CONNECT, Jenkins.READ)
+                .invokeWithArgs("aNode");
+
+        assertThat(result, succeededSilently());
+        if (slave.toComputer().isConnecting()) {
+            System.out.println("Waiting until online in progress...");
+            slave.toComputer().waitUntilOnline();
+        }
+
+        assertThat(slave.toComputer().isOnline(), equalTo(true));
+    }
+
+    @Test public void onlineNodeShouldSucceedOnDisconnectedNode() throws Exception {
+
+        DumbSlave slave = j.createSlave("aNode", "", null);
+
+        if (slave.toComputer().isConnecting()) {
+            System.out.println("Waiting until online in progress...");
+            slave.toComputer().waitUntilOnline();
+        }
+
+        assertThat(slave.toComputer().isOnline(), equalTo(true));
+        slave.toComputer().disconnect();
+        slave.toComputer().waitUntilOffline();
+        assertThat(slave.toComputer().isOffline(), equalTo(true));
+
+        CLICommandInvoker.Result result = command
+                .authorizedTo(Computer.CONNECT, Jenkins.READ)
+                .invokeWithArgs("aNode");
+
+        assertThat(result, succeededSilently());
+        if (slave.toComputer().isConnecting()) {
+            System.out.println("Waiting until online in progress...");
+            slave.toComputer().waitUntilOnline();
+        }
+
+        assertThat(slave.toComputer().isOnline(), equalTo(false));
+    }
+
+    @Test public void onlineNodeShouldSucceedOnDisconnectingNode() throws Exception {
+
+        DumbSlave slave = j.createSlave("aNode", "", null);
+
+        if (slave.toComputer().isConnecting()) {
+            System.out.println("Waiting until online in progress...");
+            slave.toComputer().waitUntilOnline();
+        }
+
+        assertThat(slave.toComputer().isOnline(), equalTo(true));
+        slave.toComputer().disconnect();
+
+        CLICommandInvoker.Result result = command
+                .authorizedTo(Computer.CONNECT, Jenkins.READ)
+                .invokeWithArgs("aNode");
+
+        assertThat(result, succeededSilently());
+        if (slave.toComputer().isConnecting()) {
+            System.out.println("Waiting until online in progress...");
+            slave.toComputer().waitUntilOnline();
+        }
+
+        assertThat(slave.toComputer().isOnline(), equalTo(false));
+    }
+
+}