/*
* 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.FilePath;
import hudson.model.FreeStyleProject;
import hudson.model.Job;
import hudson.tasks.Shell;
import jenkins.model.Jenkins;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.jvnet.hudson.test.JenkinsRule;
import java.io.File;
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;
/**
* @author pjanouse
*/
public class ReloadJobCommandTest {
private CLICommandInvoker command;
@Rule public final JenkinsRule j = new JenkinsRule();
@Before public void setUp() {
command = new CLICommandInvoker(j, "reload-job");
}
@Test public void reloadJobShouldFailWithoutJobConfigurePermission() throws Exception {
FreeStyleProject project = j.createFreeStyleProject("aProject");
project.getBuildersList().add(new Shell("echo 1"));
assertThat(project.scheduleBuild2(0).get().getLog(), containsString("echo 1"));
changeProjectOnTheDisc(project, "echo 1", "echo 2");
final CLICommandInvoker.Result result = command
.authorizedTo(Job.READ, Jenkins.READ)
.invokeWithArgs("aProject");
assertThat(result, failedWith(6));
assertThat(result, hasNoStandardOutput());
assertThat(result.stderr(), containsString("ERROR: user is missing the Job/Configure permission"));
assertThat(project.scheduleBuild2(0).get().getLog(), containsString("echo 1"));
}
@Test public void reloadJobShouldFailWithoutJobReadPermission() throws Exception {
FreeStyleProject project = j.createFreeStyleProject("aProject");
project.getBuildersList().add(new Shell("echo 1"));
assertThat(project.scheduleBuild2(0).get().getLog(), containsString("echo 1"));
changeProjectOnTheDisc(project, "echo 1", "echo 2");
final CLICommandInvoker.Result result = command
.authorizedTo(Job.CONFIGURE, Jenkins.READ)
.invokeWithArgs("aProject");
assertThat(result, failedWith(3));
assertThat(result, hasNoStandardOutput());
assertThat(result.stderr(), containsString("ERROR: No such job \u2018aProject\u2019 exists."));
assertThat(project.scheduleBuild2(0).get().getLog(), containsString("echo 1"));
}
@Test public void reloadJobShouldSucceed() throws Exception {
FreeStyleProject project = j.createFreeStyleProject("aProject");
project.getBuildersList().add(new Shell("echo 1"));
assertThat(project.scheduleBuild2(0).get().getLog(), containsString("echo 1"));
changeProjectOnTheDisc(project, "echo 1", "echo 2");
final CLICommandInvoker.Result result = command
.authorizedTo(Job.READ, Job.CONFIGURE, Jenkins.READ)
.invokeWithArgs("aProject");
assertThat(result, succeededSilently());
assertThat(project.scheduleBuild2(0).get().getLog(), containsString("echo 2"));
}
@Test public void reloadJobShouldFailIfJobDoesNotExist() throws Exception {
final CLICommandInvoker.Result result = command
.authorizedTo(Job.READ, Job.CONFIGURE, Jenkins.READ)
.invokeWithArgs("never_created");
assertThat(result, failedWith(3));
assertThat(result, hasNoStandardOutput());
assertThat(result.stderr(), containsString("ERROR: No such job \u2018never_created\u2019 exists."));
}
@Test public void reloadJobShouldFailIfJobDoesNotExistButNearExists() throws Exception {
FreeStyleProject project = j.createFreeStyleProject("never_created");
final CLICommandInvoker.Result result = command
.authorizedTo(Job.READ, Job.CONFIGURE, Jenkins.READ)
.invokeWithArgs("never_created1");
assertThat(result, failedWith(3));
assertThat(result, hasNoStandardOutput());
assertThat(result.stderr(), containsString("ERROR: No such job \u2018never_created1\u2019 exists. Perhaps you meant \u2018never_created\u2019?"));
}
@Test public void reloadJobManyShouldSucceed() throws Exception {
FreeStyleProject project1 = j.createFreeStyleProject("aProject1");
project1.getBuildersList().add(new Shell("echo 1"));
FreeStyleProject project2 = j.createFreeStyleProject("aProject2");
project2.getBuildersList().add(new Shell("echo 1"));
FreeStyleProject project3 = j.createFreeStyleProject("aProject3");
project3.getBuildersList().add(new Shell("echo 1"));
assertThat(project1.scheduleBuild2(0).get().getLog(), containsString("echo 1"));
assertThat(project2.scheduleBuild2(0).get().getLog(), containsString("echo 1"));
assertThat(project3.scheduleBuild2(0).get().getLog(), containsString("echo 1"));
changeProjectOnTheDisc(project1, "echo 1", "echo 2");
changeProjectOnTheDisc(project2, "echo 1", "echo 2");
changeProjectOnTheDisc(project3, "echo 1", "echo 2");
final CLICommandInvoker.Result result = command
.authorizedTo(Job.READ, Job.CONFIGURE, Jenkins.READ)
.invokeWithArgs("aProject1", "aProject2", "aProject3");
assertThat(result, succeededSilently());
assertThat(project1.scheduleBuild2(0).get().getLog(), containsString("echo 2"));
assertThat(project2.scheduleBuild2(0).get().getLog(), containsString("echo 2"));
assertThat(project3.scheduleBuild2(0).get().getLog(), containsString("echo 2"));
}
@Test public void reloadJobManyShouldFailIfFirstJobDoesNotExist() throws Exception {
FreeStyleProject project1 = j.createFreeStyleProject("aProject1");
project1.getBuildersList().add(new Shell("echo 1"));
FreeStyleProject project2 = j.createFreeStyleProject("aProject2");
project2.getBuildersList().add(new Shell("echo 1"));
assertThat(project1.scheduleBuild2(0).get().getLog(), containsString("echo 1"));
assertThat(project2.scheduleBuild2(0).get().getLog(), containsString("echo 1"));
changeProjectOnTheDisc(project1, "echo 1", "echo 2");
changeProjectOnTheDisc(project2, "echo 1", "echo 2");
final CLICommandInvoker.Result result = command
.authorizedTo(Job.READ, Job.CONFIGURE, Jenkins.READ)
.invokeWithArgs("never_created", "aProject1", "aProject2");
assertThat(result, failedWith(5));
assertThat(result, hasNoStandardOutput());
assertThat(result.stderr(), containsString("never_created: No such job \u2018never_created\u2019 exists."));
assertThat(result.stderr(), containsString("ERROR: Error occured while performing this command, see previous stderr output."));
assertThat(project1.scheduleBuild2(0).get().getLog(), containsString("echo 2"));
assertThat(project2.scheduleBuild2(0).get().getLog(), containsString("echo 2"));
}
@Test public void reloadJobManyShouldFailIfMiddleJobDoesNotExist() throws Exception {
FreeStyleProject project1 = j.createFreeStyleProject("aProject1");
project1.getBuildersList().add(new Shell("echo 1"));
FreeStyleProject project2 = j.createFreeStyleProject("aProject2");
project2.getBuildersList().add(new Shell("echo 1"));
assertThat(project1.scheduleBuild2(0).get().getLog(), containsString("echo 1"));
assertThat(project2.scheduleBuild2(0).get().getLog(), containsString("echo 1"));
changeProjectOnTheDisc(project1, "echo 1", "echo 2");
changeProjectOnTheDisc(project2, "echo 1", "echo 2");
final CLICommandInvoker.Result result = command
.authorizedTo(Job.READ, Job.CONFIGURE, Jenkins.READ)
.invokeWithArgs("aProject1", "never_created", "aProject2");
assertThat(result, failedWith(5));
assertThat(result, hasNoStandardOutput());
assertThat(result.stderr(), containsString("never_created: No such job \u2018never_created\u2019 exists."));
assertThat(result.stderr(), containsString("ERROR: Error occured while performing this command, see previous stderr output."));
assertThat(project1.scheduleBuild2(0).get().getLog(), containsString("echo 2"));
assertThat(project2.scheduleBuild2(0).get().getLog(), containsString("echo 2"));
}
@Test public void reloadJobManyShouldFailIfLastJobDoesNotExist() throws Exception {
FreeStyleProject project1 = j.createFreeStyleProject("aProject1");
project1.getBuildersList().add(new Shell("echo 1"));
FreeStyleProject project2 = j.createFreeStyleProject("aProject2");
project2.getBuildersList().add(new Shell("echo 1"));
assertThat(project1.scheduleBuild2(0).get().getLog(), containsString("echo 1"));
assertThat(project2.scheduleBuild2(0).get().getLog(), containsString("echo 1"));
changeProjectOnTheDisc(project1, "echo 1", "echo 2");
changeProjectOnTheDisc(project2, "echo 1", "echo 2");
final CLICommandInvoker.Result result = command
.authorizedTo(Job.READ, Job.CONFIGURE, Jenkins.READ)
.invokeWithArgs("aProject1", "aProject2", "never_created");
assertThat(result, failedWith(5));
assertThat(result, hasNoStandardOutput());
assertThat(result.stderr(), containsString("never_created: No such job \u2018never_created\u2019 exists."));
assertThat(result.stderr(), containsString("ERROR: Error occured while performing this command, see previous stderr output."));
assertThat(project1.scheduleBuild2(0).get().getLog(), containsString("echo 2"));
assertThat(project2.scheduleBuild2(0).get().getLog(), containsString("echo 2"));
}
@Test public void reloadJobManyShouldFailIfMoreJobsDoNotExist() throws Exception {
FreeStyleProject project1 = j.createFreeStyleProject("aProject1");
project1.getBuildersList().add(new Shell("echo 1"));
FreeStyleProject project2 = j.createFreeStyleProject("aProject2");
project2.getBuildersList().add(new Shell("echo 1"));
assertThat(project1.scheduleBuild2(0).get().getLog(), containsString("echo 1"));
assertThat(project2.scheduleBuild2(0).get().getLog(), containsString("echo 1"));
changeProjectOnTheDisc(project1, "echo 1", "echo 2");
changeProjectOnTheDisc(project2, "echo 1", "echo 2");
final CLICommandInvoker.Result result = command
.authorizedTo(Job.READ, Job.CONFIGURE, Jenkins.READ)
.invokeWithArgs("aProject1", "never_created1", "never_created2", "aProject2");
assertThat(result, failedWith(5));
assertThat(result, hasNoStandardOutput());
assertThat(result.stderr(), containsString("never_created1: No such job \u2018never_created1\u2019 exists."));
assertThat(result.stderr(), containsString("never_created2: No such job \u2018never_created2\u2019 exists."));
assertThat(result.stderr(), containsString("ERROR: Error occured while performing this command, see previous stderr output."));
assertThat(project1.scheduleBuild2(0).get().getLog(), containsString("echo 2"));
assertThat(project2.scheduleBuild2(0).get().getLog(), containsString("echo 2"));
}
@Test public void reloadJobManyShouldSucceedEvenAJobIsSpecifiedTwice() throws Exception {
FreeStyleProject project1 = j.createFreeStyleProject("aProject1");
project1.getBuildersList().add(new Shell("echo 1"));
FreeStyleProject project2 = j.createFreeStyleProject("aProject2");
project2.getBuildersList().add(new Shell("echo 1"));
assertThat(project1.scheduleBuild2(0).get().getLog(), containsString("echo 1"));
assertThat(project2.scheduleBuild2(0).get().getLog(), containsString("echo 1"));
changeProjectOnTheDisc(project1, "echo 1", "echo 2");
changeProjectOnTheDisc(project2, "echo 1", "echo 2");
final CLICommandInvoker.Result result = command
.authorizedTo(Job.READ, Job.CONFIGURE, Jenkins.READ)
.invokeWithArgs("aProject1", "aProject2", "aProject1");
assertThat(result, succeededSilently());
assertThat(project1.scheduleBuild2(0).get().getLog(), containsString("echo 2"));
assertThat(project2.scheduleBuild2(0).get().getLog(), containsString("echo 2"));
}
/**
* Modify a project directly on the disc
*
* @param project modified project
* @param oldstr old configuration item - for rewrite
* @param newstr rew configuration item - after rewrite
* @throws Exception if an issue occurred
*/
private void changeProjectOnTheDisc(final FreeStyleProject project, final String oldstr,
final String newstr) throws Exception {
FilePath fp = new FilePath(new File(project.getRootDir()+"/config.xml"));
fp.write(fp.readToString().replace(oldstr, newstr), null);
}
}