/*
* 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.
*/
package hudson.cli;
import hudson.Util;
import hudson.model.FreeStyleProject;
import hudson.model.ListView;
import hudson.model.Node;
import hudson.model.User;
import hudson.tasks.Mailer;
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 java.io.File;
import java.io.FileWriter;
import java.io.IOException;
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;
/**
* @author pjanouse
*/
public class ReloadConfigurationCommandTest {
private CLICommandInvoker command;
@Rule public final JenkinsRule j = new JenkinsRule();
@Before public void setUp() {
command = new CLICommandInvoker(j, "reload-configuration");
}
@Test
public void reloadConfigurationShouldFailWithoutAdministerPermission() throws Exception {
final CLICommandInvoker.Result result = command
.authorizedTo(Jenkins.READ).invoke();
assertThat(result, failedWith(6));
assertThat(result, hasNoStandardOutput());
assertThat(result.stderr(), containsString("user is missing the Overall/Administer permission"));
}
@Test
public void reloadMasterConfig() throws Exception {
Node node = j.jenkins;
node.setLabelString("oldLabel");
modifyNode(node);
assertThat(node.getLabelString(), equalTo("newLabel"));
}
@Test
public void reloadSlaveConfig() throws Exception {
Node node = j.createSlave("a_slave", "oldLabel", null);
modifyNode(node);
node = j.jenkins.getNode("a_slave");
assertThat(node.getLabelString(), equalTo("newLabel"));
}
private void modifyNode(Node node) throws Exception {
replace(node.getNodeName().equals("") ? "config.xml" : String.format("nodes/%s/config.xml",node.getNodeName()), "oldLabel", "newLabel");
assertThat(node.getLabelString(), equalTo("oldLabel"));
reloadJenkinsConfigurationViaCliAndWait();
}
@Test
public void reloadUserConfig() throws Exception {
User user = User.get("some_user", true, null);
user.setFullName("oldName");
user.save();
replace("users/some_user/config.xml", "oldName", "newName");
assertThat(user.getFullName(), equalTo("oldName"));
reloadJenkinsConfigurationViaCliAndWait();
assertThat(user.getFullName(), equalTo("newName"));
}
@Test
public void reloadJobConfig() throws Exception {
FreeStyleProject project = j.createFreeStyleProject("a_project");
project.setDescription("oldDescription");
replace("jobs/a_project/config.xml", "oldDescription", "newDescription");
assertThat( project.getDescription(), equalTo("oldDescription"));
reloadJenkinsConfigurationViaCliAndWait();
project = j.jenkins.getItem("a_project", j.jenkins, FreeStyleProject.class);
assertThat(project.getDescription(), equalTo("newDescription"));
}
@Test
public void reloadViewConfig() throws Exception {
ListView view = new ListView("a_view");
j.jenkins.addView(view);
view.setIncludeRegex("oldIncludeRegex");
view.save();
replace("config.xml", "oldIncludeRegex", "newIncludeRegex");
assertThat(view.getIncludeRegex(), equalTo("oldIncludeRegex"));
reloadJenkinsConfigurationViaCliAndWait();
view = (ListView) j.jenkins.getView("a_view");
assertThat(view.getIncludeRegex(), equalTo("newIncludeRegex"));
}
@Ignore // Until fixed JENKINS-8217
@Test
public void reloadDescriptorConfig() throws Exception {
Mailer.DescriptorImpl desc = j.jenkins.getExtensionList(Mailer.DescriptorImpl.class).get(0);;
desc.setDefaultSuffix("@oldSuffix");
desc.save();
replace("hudson.tasks.Mailer.xml", "@oldSuffix", "@newSuffix");
assertThat(desc.getDefaultSuffix(), equalTo("@oldSuffix"));
reloadJenkinsConfigurationViaCliAndWait();
assertThat(desc.getDefaultSuffix(), equalTo("@newSuffix"));
}
private void reloadJenkinsConfigurationViaCliAndWait() throws Exception {
final CLICommandInvoker.Result result = command
.authorizedTo(Jenkins.READ, Jenkins.ADMINISTER).invoke();
assertThat(result, succeededSilently());
// reload-configuration is performed in a separate thread
// we have to wait until it finishes
while (!(j.jenkins.servletContext.getAttribute("app") instanceof Jenkins)) {
System.out.println("Jenkins reload operation is performing, sleeping 1s...");
Thread.sleep(1000);
}
}
private void replace(String path, String search, String replace) {
File configFile = new File(j.jenkins.getRootDir(), path);
try {
String oldConfig = Util.loadFile(configFile);
String newConfig = oldConfig.replaceAll(search, replace);
FileWriter fw = new FileWriter(configFile);
fw.write(newConfig);
fw.close();
} catch (IOException ex) {
throw new AssertionError(ex);
}
}
}