From a6203831c0efc651844476e38fdfc7d6af01ee7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oliver=20Gond=C5=BEa?= Date: Mon, 10 Jun 2013 23:18:51 +0200 Subject: [PATCH] Introduce CLICommandInvoker for testing purposes --- .../java/hudson/cli/CLICommandInvoker.java | 154 ++++++++++++++++++ .../hudson/cli/CreateNodeCommandTest.java | 82 +++------- .../java/hudson/cli/GetNodeCommandTest.java | 79 +++------ .../hudson/cli/UpdateNodeCommandTest.java | 79 +++------ 4 files changed, 227 insertions(+), 167 deletions(-) create mode 100644 test/src/main/java/hudson/cli/CLICommandInvoker.java diff --git a/test/src/main/java/hudson/cli/CLICommandInvoker.java b/test/src/main/java/hudson/cli/CLICommandInvoker.java new file mode 100644 index 0000000000..85cda1d04b --- /dev/null +++ b/test/src/main/java/hudson/cli/CLICommandInvoker.java @@ -0,0 +1,154 @@ +/* + * The MIT License + * + * Copyright 2013 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.model.User; +import hudson.security.Permission; +import hudson.security.GlobalMatrixAuthorizationStrategy; + +import java.io.ByteArrayOutputStream; +import java.io.InputStream; +import java.io.PrintStream; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; +import java.util.Locale; + +import org.jvnet.hudson.test.JenkinsRule; + +/** + * Helper class to invoke {@link CLICommand} and check the response. + * + * @author ogondza + */ +public class CLICommandInvoker { + + private static final String username = "user"; + private final JenkinsRule rule; + private final CLICommand command; + + private InputStream stdin; + private List args = Collections.emptyList(); + private List permissions = Collections.emptyList(); + private Locale locale = Locale.ENGLISH; + + public CLICommandInvoker(final JenkinsRule rule, final CLICommand command) { + + this.rule = rule; + this.command = command; + } + + public CLICommandInvoker authorizedTo(final Permission... permissions) { + + this.permissions = Arrays.asList(permissions); + return this; + } + + public CLICommandInvoker withStdin(final InputStream stdin) { + + this.stdin = stdin; + return this; + } + + public CLICommandInvoker withArgs(final String... args) { + + this.args = Arrays.asList(args); + return this; + } + + public Result invokeWithArgs(final String... args) { + + return withArgs(args).invoke(); + } + + public Result invoke() { + + setAuth(); + + final ByteArrayOutputStream out = new ByteArrayOutputStream(); + final ByteArrayOutputStream err = new ByteArrayOutputStream(); + + final int returnCode = command.main( + args, locale, stdin, new PrintStream(out), new PrintStream(err) + ); + + return new Result(returnCode, out, err); + } + + private void setAuth() { + + if (permissions.isEmpty()) return; + + JenkinsRule.DummySecurityRealm realm = rule.createDummySecurityRealm(); + realm.addGroups(username, "group"); + rule.jenkins.setSecurityRealm(realm); + + GlobalMatrixAuthorizationStrategy auth = new GlobalMatrixAuthorizationStrategy(); + for(Permission p: permissions) { + auth.add(p, username); + } + rule.jenkins.setAuthorizationStrategy(auth); + + command.setTransportAuth(user().impersonate()); + } + + public User user() { + + return User.get(username); + } + + public static class Result { + + private final int result; + private final ByteArrayOutputStream out; + private final ByteArrayOutputStream err; + + private Result( + final int result, + final ByteArrayOutputStream out, + final ByteArrayOutputStream err + ) { + + this.result = result; + this.out = out; + this.err = err; + } + + public int returnCode() { + + return result; + } + + public String stdout() { + + return out.toString(); + } + + public String stderr() { + + return err.toString(); + } + } +} diff --git a/test/src/test/java/hudson/cli/CreateNodeCommandTest.java b/test/src/test/java/hudson/cli/CreateNodeCommandTest.java index 1089fac941..ac081735ee 100644 --- a/test/src/test/java/hudson/cli/CreateNodeCommandTest.java +++ b/test/src/test/java/hudson/cli/CreateNodeCommandTest.java @@ -29,16 +29,7 @@ import static org.hamcrest.Matchers.containsString; import static org.hamcrest.Matchers.equalTo; import static org.hamcrest.text.IsEmptyString.isEmptyString; import hudson.model.Node; -import hudson.model.User; import hudson.security.Permission; -import hudson.security.GlobalMatrixAuthorizationStrategy; - -import java.io.ByteArrayOutputStream; -import java.io.InputStream; -import java.io.PrintStream; -import java.util.Arrays; -import java.util.Locale; - import jenkins.model.Jenkins; import org.junit.Before; @@ -48,40 +39,38 @@ import org.jvnet.hudson.test.JenkinsRule; public class CreateNodeCommandTest { - private final ByteArrayOutputStream out = new ByteArrayOutputStream(); - private final ByteArrayOutputStream err = new ByteArrayOutputStream(); - private InputStream in; - - private CreateNodeCommand command; + private CLICommandInvoker command; @Rule public final JenkinsRule j = new JenkinsRule(); @Before public void setUp() { - command = new CreateNodeCommand(); + command = new CLICommandInvoker(j, new CreateNodeCommand()); } @Test public void createNodeShouldFailWithoutAdministerPermision() throws Exception { - forUser("user"); + final CLICommandInvoker.Result result = command + .authorizedTo(Permission.READ) + .withStdin(getClass().getResourceAsStream("node.xml")) + .invoke() + ; - in = getClass().getResourceAsStream("node.xml"); - final int result = execute(); - - assertThat(err.toString(), containsString("user is missing the Administer permission")); - assertThat("No output expected", out.toString(), isEmptyString()); - assertThat("Command is expected to fail", result, equalTo(-1)); + assertThat(result.stderr(), containsString("user is missing the Administer permission")); + assertThat("No output expected", result.stdout(), isEmptyString()); + assertThat("Command is expected to fail", result.returnCode(), equalTo(-1)); } @Test public void createNode() throws Exception { - forUser("administrator"); + final CLICommandInvoker.Result result = command + .authorizedTo(Jenkins.ADMINISTER) + .withStdin(getClass().getResourceAsStream("node.xml")) + .invoke() + ; - in = getClass().getResourceAsStream("node.xml"); - final int result = execute(); - - assertThat("No error output expected", err.toString(), isEmptyString()); - assertThat("Command is expected to succeed", result, equalTo(0)); + assertThat("No error output expected", result.stderr(), isEmptyString()); + assertThat("Command is expected to succeed", result.returnCode(), equalTo(0)); final Node updatedSlave = j.jenkins.getNode("SlaveFromXML"); assertThat(updatedSlave.getNodeName(), equalTo("SlaveFromXML")); @@ -90,37 +79,16 @@ public class CreateNodeCommandTest { @Test public void createNodeShouldFailIfNodeAlreadyExist() throws Exception { - forUser("administrator"); - j.createSlave("SlaveFromXML", null, null); - in = getClass().getResourceAsStream("node.xml"); - final int result = execute(); + final CLICommandInvoker.Result result = command + .authorizedTo(Jenkins.ADMINISTER) + .withStdin(getClass().getResourceAsStream("node.xml")) + .invoke() + ; - assertThat(err.toString(), containsString("Node 'SlaveFromXML' already exists")); - assertThat("No output expected", out.toString(), isEmptyString()); - assertThat("Command is expected to fail", result, equalTo(-1)); - } - - private void forUser(final String user) { - - JenkinsRule.DummySecurityRealm realm = j.createDummySecurityRealm(); - realm.addGroups("user", "group"); - realm.addGroups("administrator", "administrator"); - j.jenkins.setSecurityRealm(realm); - - GlobalMatrixAuthorizationStrategy auth = new GlobalMatrixAuthorizationStrategy(); - auth.add(Permission.READ, "group"); - auth.add(Jenkins.ADMINISTER, "administrator"); - j.jenkins.setAuthorizationStrategy(auth); - - command.setTransportAuth(User.get(user).impersonate()); - } - - private int execute(final String... args) { - - return command.main( - Arrays.asList(args), Locale.ENGLISH, in, new PrintStream(out), new PrintStream(err) - ); + assertThat(result.stderr(), containsString("Node 'SlaveFromXML' already exists")); + assertThat("No output expected", result.stdout(), isEmptyString()); + assertThat("Command is expected to fail", result.returnCode(), equalTo(-1)); } } diff --git a/test/src/test/java/hudson/cli/GetNodeCommandTest.java b/test/src/test/java/hudson/cli/GetNodeCommandTest.java index 26be160250..d483704501 100644 --- a/test/src/test/java/hudson/cli/GetNodeCommandTest.java +++ b/test/src/test/java/hudson/cli/GetNodeCommandTest.java @@ -29,18 +29,9 @@ import static org.hamcrest.Matchers.containsString; import static org.hamcrest.Matchers.equalTo; import static org.hamcrest.Matchers.startsWith; import static org.hamcrest.text.IsEmptyString.isEmptyString; -import hudson.model.User; import hudson.security.Permission; -import hudson.security.GlobalMatrixAuthorizationStrategy; - -import java.io.ByteArrayOutputStream; -import java.io.PrintStream; -import java.util.Arrays; -import java.util.Locale; - import jenkins.model.Jenkins; -import org.apache.commons.io.input.NullInputStream; import org.junit.Before; import org.junit.Rule; import org.junit.Test; @@ -48,75 +39,53 @@ import org.jvnet.hudson.test.JenkinsRule; public class GetNodeCommandTest { - private final ByteArrayOutputStream out = new ByteArrayOutputStream(); - private final ByteArrayOutputStream err = new ByteArrayOutputStream(); - - private GetNodeCommand command; + private CLICommandInvoker command; @Rule public final JenkinsRule j = new JenkinsRule(); @Before public void setUp() { - command = new GetNodeCommand(); + command = new CLICommandInvoker(j, new GetNodeCommand()); } @Test public void getNodeShouldFailWithoutAdministerPermision() throws Exception { - forUser("user"); - j.createSlave("MySlave", null, null); - final int result = execute("MySlave"); + final CLICommandInvoker.Result result = command + .authorizedTo(Permission.READ) + .invokeWithArgs("MySlave") + ; - assertThat(err.toString(), containsString("user is missing the Administer permission")); - assertThat("No output expected", out.toString(), isEmptyString()); - assertThat("Command is expected to fail", result, equalTo(-1)); + assertThat(result.stderr(), containsString("user is missing the Administer permission")); + assertThat("No output expected", result.stdout(), isEmptyString()); + assertThat("Command is expected to fail", result.returnCode(), equalTo(-1)); } @Test public void getNodeShouldYieldConfigXml() throws Exception { - forUser("administrator"); - j.createSlave("MySlave", null, null); - final int result = execute("MySlave"); + final CLICommandInvoker.Result result = command + .authorizedTo(Jenkins.ADMINISTER) + .invokeWithArgs("MySlave") + ; - assertThat(out.toString(), startsWith("")); - assertThat(out.toString(), containsString("MySlave")); - assertThat("No error output expected", err.toString(), isEmptyString()); - assertThat("Command is expected to succeed", result, equalTo(0)); + assertThat(result.stdout(), startsWith("")); + assertThat(result.stdout(), containsString("MySlave")); + assertThat("No error output expected", result.stderr(), isEmptyString()); + assertThat("Command is expected to succeed", result.returnCode(), equalTo(0)); } @Test public void getNodeShouldFailIfNodeDoesNotExist() throws Exception { - forUser("administrator"); + final CLICommandInvoker.Result result = command + .authorizedTo(Jenkins.ADMINISTER) + .invokeWithArgs("MySlave") + ; - final int result = execute("MySlave"); - - assertThat(err.toString(), containsString("No such node 'MySlave'")); - assertThat("No output expected", out.toString(), isEmptyString()); - assertThat("Command is expected to fail", result, equalTo(-1)); - } - - private void forUser(final String user) { - - JenkinsRule.DummySecurityRealm realm = j.createDummySecurityRealm(); - realm.addGroups("user", "group"); - realm.addGroups("administrator", "administrator"); - j.jenkins.setSecurityRealm(realm); - - GlobalMatrixAuthorizationStrategy auth = new GlobalMatrixAuthorizationStrategy(); - auth.add(Permission.READ, "group"); - auth.add(Jenkins.ADMINISTER, "administrator"); - j.jenkins.setAuthorizationStrategy(auth); - - command.setTransportAuth(User.get(user).impersonate()); - } - - private int execute(final String... args) { - - return command.main( - Arrays.asList(args), Locale.ENGLISH, new NullInputStream(0), new PrintStream(out), new PrintStream(err) - ); + assertThat(result.stderr(), containsString("No such node 'MySlave'")); + assertThat("No output expected", result.stdout(), isEmptyString()); + assertThat("Command is expected to fail", result.returnCode(), equalTo(-1)); } } diff --git a/test/src/test/java/hudson/cli/UpdateNodeCommandTest.java b/test/src/test/java/hudson/cli/UpdateNodeCommandTest.java index 7423ba8853..b7d1db0f62 100644 --- a/test/src/test/java/hudson/cli/UpdateNodeCommandTest.java +++ b/test/src/test/java/hudson/cli/UpdateNodeCommandTest.java @@ -30,16 +30,7 @@ import static org.hamcrest.Matchers.equalTo; import static org.hamcrest.Matchers.nullValue; import static org.hamcrest.text.IsEmptyString.isEmptyString; import hudson.model.Node; -import hudson.model.User; import hudson.security.Permission; -import hudson.security.GlobalMatrixAuthorizationStrategy; - -import java.io.ByteArrayOutputStream; -import java.io.InputStream; -import java.io.PrintStream; -import java.util.Arrays; -import java.util.Locale; - import jenkins.model.Jenkins; import org.junit.Before; @@ -49,43 +40,41 @@ import org.jvnet.hudson.test.JenkinsRule; public class UpdateNodeCommandTest { - private final ByteArrayOutputStream out = new ByteArrayOutputStream(); - private final ByteArrayOutputStream err = new ByteArrayOutputStream(); - private InputStream in; - - private UpdateNodeCommand command; + private CLICommandInvoker command; @Rule public final JenkinsRule j = new JenkinsRule(); @Before public void setUp() { - command = new UpdateNodeCommand(); + command = new CLICommandInvoker(j, new UpdateNodeCommand()); } @Test public void updateNodeShouldFailWithoutAdministerPermision() throws Exception { - forUser("user"); - j.createSlave("MySlave", null, null); - final int result = execute("MySlave"); + final CLICommandInvoker.Result result = command + .authorizedTo(Permission.READ) + .invokeWithArgs("MySlave") + ; - assertThat(err.toString(), containsString("user is missing the Administer permission")); - assertThat("No output expected", out.toString(), isEmptyString()); - assertThat("Command is expected to fail", result, equalTo(-1)); + assertThat(result.stderr(), containsString("user is missing the Administer permission")); + assertThat("No output expected", result.stdout(), isEmptyString()); + assertThat("Command is expected to fail", result.returnCode(), equalTo(-1)); } @Test public void updateNodeShouldModifyNodeConfiguration() throws Exception { - forUser("administrator"); - j.createSlave("MySlave", null, null); - in = getClass().getResourceAsStream("node.xml"); - final int result = execute("MySlave"); + final CLICommandInvoker.Result result = command + .authorizedTo(Jenkins.ADMINISTER) + .withStdin(getClass().getResourceAsStream("node.xml")) + .invokeWithArgs("MySlave") + ; - assertThat("No error output expected", err.toString(), isEmptyString()); - assertThat("Command is expected to succeed", result, equalTo(0)); + assertThat("No error output expected", result.stderr(), isEmptyString()); + assertThat("Command is expected to succeed", result.returnCode(), equalTo(0)); assertThat("A slave with old name should not exist", j.jenkins.getNode("MySlave"), nullValue()); @@ -96,34 +85,14 @@ public class UpdateNodeCommandTest { @Test public void updateNodeShouldFailIfNodeDoesNotExist() throws Exception { - forUser("administrator"); + final CLICommandInvoker.Result result = command + .authorizedTo(Jenkins.ADMINISTER) + .withStdin(getClass().getResourceAsStream("node.xml")) + .invokeWithArgs("MySlave") + ; - final int result = execute("MySlave"); - - assertThat(err.toString(), containsString("No such node 'MySlave'")); - assertThat("No output expected", out.toString(), isEmptyString()); - assertThat("Command is expected to fail", result, equalTo(-1)); - } - - private void forUser(final String user) { - - JenkinsRule.DummySecurityRealm realm = j.createDummySecurityRealm(); - realm.addGroups("user", "group"); - realm.addGroups("administrator", "administrator"); - j.jenkins.setSecurityRealm(realm); - - GlobalMatrixAuthorizationStrategy auth = new GlobalMatrixAuthorizationStrategy(); - auth.add(Permission.READ, "group"); - auth.add(Jenkins.ADMINISTER, "administrator"); - j.jenkins.setAuthorizationStrategy(auth); - - command.setTransportAuth(User.get(user).impersonate()); - } - - private int execute(final String... args) { - - return command.main( - Arrays.asList(args), Locale.ENGLISH, in, new PrintStream(out), new PrintStream(err) - ); + assertThat(result.stderr(), containsString("No such node 'MySlave'")); + assertThat("No output expected", result.stdout(), isEmptyString()); + assertThat("Command is expected to fail", result.returnCode(), equalTo(-1)); } }