/*
* The MIT License
*
* Copyright 2016 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.FreeStyleBuild;
import hudson.model.FreeStyleProject;
import hudson.model.QueueTest;
import hudson.util.OneShotEvent;
import jenkins.model.Jenkins;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.jvnet.hudson.test.JenkinsRule;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.FutureTask;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicInteger;
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;
import static org.hamcrest.Matchers.hasSize;
import static org.junit.Assert.fail;
public class QuietDownCommandTest {
private CLICommandInvoker command;
private final static QueueTest.TestFlyweightTask task
= new QueueTest.TestFlyweightTask(new AtomicInteger(), null);
@Rule
public final JenkinsRule j = new JenkinsRule();
@Before
public void setUp() {
command = new CLICommandInvoker(j, "quiet-down");
}
@Test
public void quietDownShouldFailWithoutAdministerPermission() throws Exception {
final CLICommandInvoker.Result result = command
.authorizedTo(Jenkins.READ)
.invoke();
assertThat(result, failedWith(6));
assertThat(result, hasNoStandardOutput());
assertThat(result.stderr(), containsString("ERROR: user is missing the Overall/Administer permission"));
}
@Test
public void quietDownShouldSuccess() throws Exception {
final CLICommandInvoker.Result result = command
.authorizedTo(Jenkins.READ, Jenkins.ADMINISTER)
.invoke();
assertThat(result, succeededSilently());
assertJenkinsInQuietMode();
}
@Test
public void quietDownShouldSuccessWithBlock() throws Exception {
final CLICommandInvoker.Result result = command
.authorizedTo(Jenkins.READ, Jenkins.ADMINISTER)
.invokeWithArgs("-block");
assertThat(result, succeededSilently());
assertJenkinsInQuietMode();
}
@Test
public void quietDownShouldSuccessWithTimeout() throws Exception {
final CLICommandInvoker.Result result = command
.authorizedTo(Jenkins.READ, Jenkins.ADMINISTER)
.invokeWithArgs("-timeout", "0");
assertThat(result, succeededSilently());
assertJenkinsInQuietMode();
}
@Test
public void quietDownShouldSuccessWithBlockAndTimeout() throws Exception {
final CLICommandInvoker.Result result = command
.authorizedTo(Jenkins.READ, Jenkins.ADMINISTER)
.invokeWithArgs("-block", "-timeout", "0");
assertThat(result, succeededSilently());
assertJenkinsInQuietMode();
}
@Test
public void quietDownShouldFailWithEmptyTimeout() throws Exception {
final CLICommandInvoker.Result result = command
.authorizedTo(Jenkins.READ, Jenkins.ADMINISTER)
.invokeWithArgs("-timeout");
assertThat(result, failedWith(2));
assertThat(result, hasNoStandardOutput());
assertThat(result.stderr(), containsString("ERROR: Option \"-timeout\" takes an operand"));
}
@Test
public void quietDownShouldSuccessOnAlreadyQuietDownedJenkins() throws Exception {
j.jenkins.getActiveInstance().doQuietDown();
assertJenkinsInQuietMode();
final CLICommandInvoker.Result result = command
.authorizedTo(Jenkins.READ, Jenkins.ADMINISTER)
.invoke();
assertThat(result, succeededSilently());
assertJenkinsInQuietMode();
}
@Test
public void quietDownShouldSuccessWithBlockOnAlreadyQuietDownedJenkins() throws Exception {
j.jenkins.getActiveInstance().doQuietDown(true, 0);
assertJenkinsInQuietMode();
final CLICommandInvoker.Result result = command
.authorizedTo(Jenkins.READ, Jenkins.ADMINISTER)
.invokeWithArgs("-block");
assertThat(result, succeededSilently());
assertJenkinsInQuietMode();
}
@Test
public void quietDownShouldSuccessWithBlockAndTimeoutOnAlreadyQuietDownedJenkins() throws Exception {
j.jenkins.getActiveInstance().doQuietDown(true, 0);
assertJenkinsInQuietMode();
final long time_before = System.currentTimeMillis();
final CLICommandInvoker.Result result = command
.authorizedTo(Jenkins.READ, Jenkins.ADMINISTER)
.invokeWithArgs("-block", "-timeout", "20000");
assertThat(result, succeededSilently());
assertThat(System.currentTimeMillis() < time_before + 20000, equalTo(true));
assertJenkinsInQuietMode();
}
//
// Scenario - quiet-down is called without block when executor is running
// Result - CLI call result is available immediately, execution won't be affected
//
@Test
public void quietDownShouldSuccessAndRunningExecutor() throws Exception {
final FreeStyleProject project = j.createFreeStyleProject("aProject");
final OneShotEvent finish = new OneShotEvent();
final Future<FreeStyleBuild> build = OnlineNodeCommandTest.startBlockingAndFinishingBuild(project, finish);
assertThat(((FreeStyleProject) j.jenkins.getItem("aProject")).getBuilds(), hasSize(1));
final CLICommandInvoker.Result result = command
.authorizedTo(Jenkins.READ, Jenkins.ADMINISTER)
.invoke();
assertThat(result, succeededSilently());
assertJenkinsInQuietMode();
finish.signal();
build.get();
assertThat(((FreeStyleProject) j.jenkins.getItem("aProject")).getBuilds(), hasSize(1));
assertThat(project.isBuilding(), equalTo(false));
j.assertBuildStatusSuccess(build);
assertJenkinsInQuietMode();
}
//
// Scenario - quiet-down is called with block when executor is running
// Expected result - CLI call is blocked indefinitely, execution won't be affected
//
@Test
public void quietDownShouldSuccessWithBlockAndRunningExecutor() throws Exception {
final FreeStyleProject project = j.createFreeStyleProject("aProject");
final ExecutorService threadPool = Executors.newSingleThreadExecutor();
final OneShotEvent beforeCli = new OneShotEvent();
final OneShotEvent finish = new OneShotEvent();
final Future<FreeStyleBuild> build = OnlineNodeCommandTest.startBlockingAndFinishingBuild(project, finish);
assertThat(((FreeStyleProject) j.jenkins.getItem("aProject")).getBuilds(), hasSize(1));
boolean timeoutOccurred = false;
final FutureTask exec_task = new FutureTask(new Callable() {
public Object call() {
assertJenkinsNotInQuietMode();
beforeCli.signal();
final CLICommandInvoker.Result result = command
.authorizedTo(Jenkins.READ, Jenkins.ADMINISTER)
.invokeWithArgs("-block");
fail("Should never return from previous CLI call!");
return null;
}
});
try {
threadPool.submit(exec_task);
beforeCli.block();
Thread.sleep(1000); // Left a room for calling CLI
assertJenkinsInQuietMode();
exec_task.get(10, TimeUnit.SECONDS);
} catch (TimeoutException e) {
timeoutOccurred = true;
}
if(!timeoutOccurred)
fail("Missing timeout for CLI call");
finish.signal();
build.get();
assertThat(((FreeStyleProject) j.jenkins.getItem("aProject")).getBuilds(), hasSize(1));
assertThat(project.isBuilding(), equalTo(false));
j.assertBuildStatusSuccess(build);
exec_task.cancel(true);
assertJenkinsInQuietMode();
}
//
// Scenario - quiet-down is called with block and zero timeout when executor is running
// Expected result - CLI call is blocked indefinitely, execution won't be affected
//
@Test
public void quietDownShouldSuccessWithBlockAndZeroTimeoutAndRunningExecutor() throws Exception {
final FreeStyleProject project = j.createFreeStyleProject("aProject");
final ExecutorService threadPool = Executors.newSingleThreadExecutor();
final OneShotEvent beforeCli = new OneShotEvent();
final OneShotEvent finish = new OneShotEvent();
final Future<FreeStyleBuild> build = OnlineNodeCommandTest.startBlockingAndFinishingBuild(project, finish);
assertThat(((FreeStyleProject) j.jenkins.getItem("aProject")).getBuilds(), hasSize(1));
boolean timeoutOccurred = false;
final FutureTask exec_task = new FutureTask(new Callable() {
public Object call() {
assertJenkinsNotInQuietMode();
beforeCli.signal();
final CLICommandInvoker.Result result = command
.authorizedTo(Jenkins.READ, Jenkins.ADMINISTER)
.invokeWithArgs("-block", "-timeout", "0");
fail("Should never return from previous CLI call!");
return null;
}
});
try {
threadPool.submit(exec_task);
beforeCli.block();
Thread.sleep(1000); // Left a room for calling CLI
assertJenkinsInQuietMode();
exec_task.get(10, TimeUnit.SECONDS);
} catch (TimeoutException e) {
timeoutOccurred = true;
}
if(!timeoutOccurred)
fail("Missing timeout for CLI call");
finish.signal();
build.get();
assertThat(((FreeStyleProject) j.jenkins.getItem("aProject")).getBuilds(), hasSize(1));
assertThat(project.isBuilding(), equalTo(false));
j.assertBuildStatusSuccess(build);
exec_task.cancel(true);
assertJenkinsInQuietMode();
}
//
// Scenario - quiet-down is called with block and a timeout when executor is running
// Expected result - CLI call return after TIMEOUT seconds, execution won't be affected
//
@Test
public void quietDownShouldSuccessWithBlockPlusExpiredTimeoutAndRunningExecutor() throws Exception {
final int TIMEOUT = 5000;
final FreeStyleProject project = j.createFreeStyleProject("aProject");
final ExecutorService threadPool = Executors.newSingleThreadExecutor();
final OneShotEvent beforeCli = new OneShotEvent();
final OneShotEvent finish = new OneShotEvent();
final Future<FreeStyleBuild> build = OnlineNodeCommandTest.startBlockingAndFinishingBuild(project, finish);
assertThat(((FreeStyleProject) j.jenkins.getItem("aProject")).getBuilds(), hasSize(1));
final FutureTask exec_task = new FutureTask(new Callable() {
public Object call() {
assertJenkinsNotInQuietMode();
final long time_before = System.currentTimeMillis();
beforeCli.signal();
final CLICommandInvoker.Result result = command
.authorizedTo(Jenkins.READ, Jenkins.ADMINISTER)
.invokeWithArgs("-block", "-timeout", Integer.toString(TIMEOUT));
assertThat(result, succeededSilently());
assertThat(System.currentTimeMillis() > time_before + TIMEOUT, equalTo(true));
assertJenkinsInQuietMode();
return null;
}
});
threadPool.submit(exec_task);
beforeCli.block();
Thread.sleep(1000); // Left a room for calling CLI
assertJenkinsInQuietMode();
try {
exec_task.get(2*TIMEOUT, TimeUnit.MILLISECONDS);
} catch (TimeoutException e) {
fail("Blocking call didn't finish after timeout!");
}
assertThat(exec_task.isDone(), equalTo(true));
finish.signal();
build.get();
assertThat(((FreeStyleProject) j.jenkins.getItem("aProject")).getBuilds(), hasSize(1));
assertThat(project.isBuilding(), equalTo(false));
j.assertBuildStatusSuccess(build);
assertJenkinsInQuietMode();
}
//
// Scenario - quiet-down is called with block and a timeout when executor is running
// Expected result - CLI call shouldn't return (killed by other thread), execution won't be affected
//
@Test
public void quietDownShouldSuccessWithBlockPlusNonExpiredTimeoutAndRunningExecutor() throws Exception {
final int TIMEOUT = 5000;
final FreeStyleProject project = j.createFreeStyleProject("aProject");
final ExecutorService threadPool = Executors.newSingleThreadExecutor();
final OneShotEvent beforeCli = new OneShotEvent();
final OneShotEvent finish = new OneShotEvent();
final Future<FreeStyleBuild> build = OnlineNodeCommandTest.startBlockingAndFinishingBuild(project, finish);
assertThat(((FreeStyleProject) j.jenkins.getItem("aProject")).getBuilds(), hasSize(1));
boolean timeoutOccurred = false;
final FutureTask exec_task = new FutureTask(new Callable() {
public Object call() {
assertJenkinsNotInQuietMode();
beforeCli.signal();
final CLICommandInvoker.Result result = command
.authorizedTo(Jenkins.READ, Jenkins.ADMINISTER)
.invokeWithArgs("-block", "-timeout", Integer.toString(2*TIMEOUT));
fail("Blocking call shouldn't finish, should be killed by called thread!");
return null;
}
});
threadPool.submit(exec_task);
beforeCli.block();
Thread.sleep(1000); // Left a room for calling CLI
assertJenkinsInQuietMode();
final boolean timeout_occured = false;
try {
exec_task.get(TIMEOUT, TimeUnit.MILLISECONDS);
} catch (TimeoutException e) {
timeoutOccurred = true;
}
if(!timeoutOccurred)
fail("Missing timeout for CLI call");
finish.signal();
build.get();
assertThat(((FreeStyleProject) j.jenkins.getItem("aProject")).getBuilds(), hasSize(1));
assertThat(project.isBuilding(), equalTo(false));
j.assertBuildStatusSuccess(build);
assertJenkinsInQuietMode();
}
//
// Scenario - quiet-down is called with block when executor is finishing
// Expected result - CLI call finish and the execution too
//
@Test
public void quietDownShouldSuccessWithBlockAndFinishingExecutor() throws Exception {
final FreeStyleProject project = j.createFreeStyleProject("aProject");
final ExecutorService threadPool = Executors.newSingleThreadExecutor();
final OneShotEvent beforeCli = new OneShotEvent();
final OneShotEvent finish = new OneShotEvent();
final Future<FreeStyleBuild> build = OnlineNodeCommandTest.startBlockingAndFinishingBuild(project, finish);
assertThat(((FreeStyleProject) j.jenkins.getItem("aProject")).getBuilds(), hasSize(1));
boolean timeoutOccurred = false;
final FutureTask exec_task = new FutureTask(new Callable() {
public Object call() {
assertJenkinsNotInQuietMode();
final long time_before = System.currentTimeMillis();
beforeCli.signal();
final CLICommandInvoker.Result result = command
.authorizedTo(Jenkins.READ, Jenkins.ADMINISTER)
.invokeWithArgs("-block");
assertThat(result, succeededSilently());
assertThat(System.currentTimeMillis() > time_before + 1000, equalTo(true));
assertJenkinsInQuietMode();
return null;
}
});
threadPool.submit(exec_task);
beforeCli.block();
Thread.sleep(1000); // Left a room for calling CLI
assertJenkinsInQuietMode();
finish.signal();
build.get();
assertThat(((FreeStyleProject) j.jenkins.getItem("aProject")).getBuilds(), hasSize(1));
assertThat(project.isBuilding(), equalTo(false));
j.assertBuildStatusSuccess(build);
assertJenkinsInQuietMode();
exec_task.get(1, TimeUnit.SECONDS);
assertJenkinsInQuietMode();
}
//
// Scenario - quiet-down is called with block and timeout when executor is finishing
// Expected result - CLI call finish and the execution too
//
@Test
public void quietDownShouldSuccessWithBlockAndNonExpiredTimeoutAndFinishingExecutor() throws Exception {
final int TIMEOUT = 5000;
final FreeStyleProject project = j.createFreeStyleProject("aProject");
final ExecutorService threadPool = Executors.newSingleThreadExecutor();
final OneShotEvent beforeCli = new OneShotEvent();
final OneShotEvent finish = new OneShotEvent();
final Future<FreeStyleBuild> build = OnlineNodeCommandTest.startBlockingAndFinishingBuild(project, finish);
assertThat(((FreeStyleProject) j.jenkins.getItem("aProject")).getBuilds(), hasSize(1));
boolean timeoutOccurred = false;
final FutureTask exec_task = new FutureTask(new Callable() {
public Object call() {
assertJenkinsNotInQuietMode();
final long time_before = System.currentTimeMillis();
beforeCli.signal();
final CLICommandInvoker.Result result = command
.authorizedTo(Jenkins.READ, Jenkins.ADMINISTER)
.invokeWithArgs("-block", "-timeout", Integer.toString(TIMEOUT));
assertThat(result, succeededSilently());
assertThat(System.currentTimeMillis() > time_before + 1000, equalTo(true));
assertThat(System.currentTimeMillis() < time_before + TIMEOUT, equalTo(true));
assertJenkinsInQuietMode();
return null;
}
});
threadPool.submit(exec_task);
beforeCli.block();
Thread.sleep(1000); // Left a room for calling CLI
assertJenkinsInQuietMode();
finish.signal();
build.get();
assertThat(((FreeStyleProject) j.jenkins.getItem("aProject")).getBuilds(), hasSize(1));
assertThat(project.isBuilding(), equalTo(false));
j.assertBuildStatusSuccess(build);
assertJenkinsInQuietMode();
exec_task.get(1, TimeUnit.SECONDS);
}
private final void assertJenkinsInQuietMode() {
assertJenkinsInQuietMode(j);
}
private final void assertJenkinsNotInQuietMode() {
assertJenkinsNotInQuietMode(j);
}
public static final void assertJenkinsInQuietMode(final JenkinsRule j) {
assertThat(j.jenkins.getActiveInstance().getQueue().isBlockedByShutdown(task), equalTo(true));
}
public static final void assertJenkinsNotInQuietMode(final JenkinsRule j) {
assertThat(j.jenkins.getActiveInstance().getQueue().isBlockedByShutdown(task), equalTo(false));
}
}