PluginIT.java

/**
 * Copyright 2010 Mirko Friedenhagen
 */

package hudson.plugins.jobConfigHistory;

import static org.hamcrest.CoreMatchers.containsString;
import static org.junit.Assert.assertThat;

import java.io.IOException;
import java.util.List;

import org.junit.Assert;
import org.jvnet.hudson.test.recipes.LocalData;
import org.xml.sax.SAXException;

import com.gargoylesoftware.htmlunit.TextPage;
import com.gargoylesoftware.htmlunit.html.HtmlAnchor;
import com.gargoylesoftware.htmlunit.html.HtmlButton;
import com.gargoylesoftware.htmlunit.html.HtmlForm;
import com.gargoylesoftware.htmlunit.html.HtmlPage;
import com.gargoylesoftware.htmlunit.html.HtmlRadioButtonInput;
import com.gargoylesoftware.htmlunit.html.HtmlTextArea;
import com.gargoylesoftware.htmlunit.xml.XmlPage;

/**
 * @author mfriedenhagen
 */
public class PluginIT extends AbstractHudsonTestCaseDeletingInstanceDir {

	private class JobPage {

		private final HtmlPage jobPage;
		private final String jobConfigHistoryLink;

		public JobPage() throws IOException, SAXException {
			this.jobPage = webClient.goTo("job/" + JOB_NAME);
			this.jobConfigHistoryLink = getJobConfigHistoryLink();
		}

		public final String getJobConfigHistoryLink() {
			return "job/" + JOB_NAME + "/jobConfigHistory";
		}

		public void checkHistoryLink() {
			assertXPath(jobPage,
					"//a[@href=\"/" + jobConfigHistoryLink + "\"]");
		}
	}

	private class ConfigPage {

		private final HtmlPage configPage;

		/**
		 * @param configPage
		 * @throws SAXException
		 * @throws IOException
		 */
		public ConfigPage() throws IOException, SAXException {
			this.configPage = webClient.goTo("job/" + JOB_NAME + "/configure");
		}

		public void setNewDescription(final String text) throws Exception {
			final HtmlForm configForm = configPage.getFormByName("config");
			final HtmlTextArea descriptionTextArea = configForm
					.getTextAreaByName("description");
			descriptionTextArea.setText(text);
			submit(configForm);
		}
	}

	private class BasicHistoryPage {

		final HtmlPage historyPage;

		public BasicHistoryPage(HtmlPage historyPage)
				throws IOException, SAXException {
			this.historyPage = historyPage;
			assertThat(historyPage.getTitleText(),
					containsString("Configuration History [Jenkins]"));
		}

		public List<HtmlAnchor> getConfigOutputLinks(final String type) {
			final List<HtmlAnchor> hrefs = historyPage.getByXPath(
					"//a[contains(@href, \"configOutput?type=" + type + "\")]");
			return hrefs;
		}

	}

	private class AllJobConfigHistoryPage extends BasicHistoryPage {

		public AllJobConfigHistoryPage(HtmlPage historyPage)
				throws IOException, SAXException {
			super(historyPage);
			Assert.assertEquals("All Configuration History [Jenkins]",
					historyPage.getTitleText());
		}

	}

	private class HistoryPage extends BasicHistoryPage {

		public HistoryPage() throws IOException, SAXException {
			super(webClient.goTo("job/" + JOB_NAME + "/jobConfigHistory"));
			Assert.assertEquals("Job Configuration History [Jenkins]",
					historyPage.getTitleText());
		}

		public HtmlPage getDiffPage() throws IOException {
			final HtmlForm diffFilesForm = historyPage
					.getFormByName("diffFiles");
			return (HtmlPage) diffFilesForm.submit((HtmlButton) last(
					diffFilesForm.getHtmlElementsByTagName("button")));
		}

		public void setCheckedTimestamp1RadioButton(int index,
				boolean isChecked) {
			getTimestampRadioButton("timestamp1", index).setChecked(isChecked);
		}

		public void setCheckedTimestamp2RadioButton(int index,
				boolean isChecked) {
			getTimestampRadioButton("timestamp2", index).setChecked(isChecked);
		}

		public void assertNoHistoryEntriesAvailable() {
			assertThat(historyPage.asXml(),
					containsString("No job configuration history available"));
		}

		private HtmlRadioButtonInput getTimestampRadioButton(final String name,
				int index) {
			final HtmlForm diffFilesForm = historyPage
					.getFormByName("diffFiles");
			return (HtmlRadioButtonInput) diffFilesForm.getInputsByName(name)
					.get(index);
		}

	}

	private WebClient webClient;

	private static final String JOB_NAME = "bar";

	@Override
	public void before() throws Throwable {
		super.before();
		webClient = createWebClient();
	}

	public void testAllProjectsConfigurationHistoryPage()
			throws IOException, SAXException {
		new AllJobConfigHistoryPage(webClient.goTo("jobConfigHistory/"));
	}

	@LocalData
	public void testJobPage() throws IOException, SAXException {
		new JobPage().checkHistoryLink();
	}

	@LocalData
	public void testHistoryPageWithOutEntries()
			throws IOException, SAXException {
		new HistoryPage().assertNoHistoryEntriesAvailable();
	}

	@LocalData
	public void testSaveConfiguration() throws Exception {
		final String firstDescription = "just a test";
		final String secondDescription = "just a second test";
		{
			new ConfigPage().setNewDescription(firstDescription);
			final List<HtmlAnchor> hrefs = new HistoryPage()
					.getConfigOutputLinks("xml");
			Assert.assertTrue(hrefs.size() >= 1);
			final HtmlAnchor xmlAnchor = hrefs.get(0);
			final XmlPage xmlPage = (XmlPage) xmlAnchor.click();
			assertThat(xmlPage.asXml(), containsString(firstDescription));
		}
		{
			new ConfigPage().setNewDescription(secondDescription);
			final List<HtmlAnchor> hrefs = new HistoryPage()
					.getConfigOutputLinks("raw");
			Assert.assertTrue(hrefs.size() >= 2);
			final HtmlAnchor rawAnchor = hrefs.get(0);
			final TextPage firstRaw = (TextPage) rawAnchor.click();
			assertThat(firstRaw.getContent(),
					containsString(secondDescription));
		}
		final AllJobConfigHistoryPage allJobConfigHistoryPage = new AllJobConfigHistoryPage(
				webClient.goTo("jobConfigHistory/?filter=jobs"));
		final List<HtmlAnchor> allRawHRefs = allJobConfigHistoryPage
				.getConfigOutputLinks("raw");
		Assert.assertTrue(allRawHRefs.size() >= 2);
		final List<? extends HtmlAnchor> allXmlHRefs = allJobConfigHistoryPage
				.getConfigOutputLinks("xml");
		Assert.assertTrue(allXmlHRefs.size() >= 2);
		final TextPage firstRawOfAll = (TextPage) allRawHRefs.get(0).click();
		assertThat(firstRawOfAll.getContent(),
				containsString(secondDescription));
		final HistoryPage historyPage = new HistoryPage();
		historyPage.setCheckedTimestamp1RadioButton(0, true);
		historyPage.setCheckedTimestamp2RadioButton(1, true);
		final HtmlPage diffPage = historyPage.getDiffPage();
		final String diffPageContent = diffPage.asXml();
		assertThat(diffPageContent,
				containsString("<td class=\"diff_original\">"));
		assertThat(diffPageContent,
				containsString("<td class=\"diff_revised\">"));
		assertThat(diffPageContent, containsString(
				"<description>just a test</description>"));
		assertThat(diffPageContent, containsString(
				"<description>just a second test</description>"));
	}

	/**
	 * Checks whether history of a single system configuration is displayed
	 * correctly and contains correct link targets.
	 */
	public void testHistoryPageOfSingleSystemConfig() {
		final String firstDescription = "just a test";
		final String secondDescription = "just a second test";
		final int sleepTime = 1100;

		try {
			jenkins.setSystemMessage(firstDescription);
			Thread.sleep(sleepTime);
			jenkins.setSystemMessage(secondDescription);
			Thread.sleep(sleepTime);
		} catch (Exception ex) {
			Assert.fail("Unable to prepare Jenkins instance: " + ex);
		}

		try {
			final HtmlPage historyPage = webClient.goTo(
					JobConfigHistoryConsts.URLNAME + "/history?name=config");
			final List<HtmlAnchor> allRawHRefs = historyPage.getByXPath(
					"//a[contains(@href, \"configOutput?type=raw\")]");
			Assert.assertTrue(
					"Check that there are at least 2 links for raw output.",
					allRawHRefs.size() >= 2);
			final TextPage firstRawOfAll = (TextPage) allRawHRefs.get(0)
					.click();
			assertThat(
					"Check that the first raw output link leads to the right target.",
					firstRawOfAll.getContent(),
					containsString(secondDescription));
		} catch (Exception ex) {
			Assert.fail(
					"Unable to complete testHistoryPageOfSingleSystemConfig: "
							+ ex);
		}
	}
}