DescriptionSetterPublisherTest.java

package hudson.plugins.descriptionsetter;

import hudson.markup.RawHtmlMarkupFormatter;
import hudson.model.FreeStyleBuild;
import hudson.model.FreeStyleProject;
import hudson.model.Result;
import jenkins.model.Jenkins;
import org.jvnet.hudson.test.HudsonTestCase;

public class DescriptionSetterPublisherTest extends HudsonTestCase {

    public void testSuccessDefaultDescription() throws Exception {
        assertEquals("one", getDescription("text one", Result.SUCCESS, "text (.*)", null, null, null));
    }

    public void testSuccessConfiguredDescription() throws Exception {
        assertEquals(
                "description one",
                getDescription("text one", Result.SUCCESS, "text (.*)", null, "description \\1", null));
    }

    public void testSuccessConfiguredDescription2() throws Exception {
        assertEquals(
                "description one two",
                getDescription(
                        "text one two", Result.SUCCESS, "text (\\w+) (\\w+)", null, "description \\1 \\2", null));
    }

    public void testFailureWithNoFailureRegex() throws Exception {
        assertEquals("one", getDescription("text one", Result.FAILURE, "text (.*)", null, null, null));
    }

    public void testFailureWithFailureRegexAndDefaultDescrption() throws Exception {
        assertEquals("text", getDescription("text one", Result.FAILURE, "text (.*)", "(.*) one", null, null));
    }

    public void testFailureWithFailureRegexAndConfiguredDescription() throws Exception {
        assertEquals(
                "description text",
                getDescription("text one", Result.FAILURE, "text (.*)", "(.*) one", null, "description \\1"));
    }

    public void testSuccessWithFixedDescription() throws Exception {
        assertEquals(
                "description success",
                getDescription("xxx", Result.SUCCESS, null, null, "description success", "description failure"));
    }

    public void testFailureWithFixedDescription() throws Exception {
        assertEquals(
                "description failure",
                getDescription("xxx", Result.FAILURE, null, null, "description success", "description failure"));
    }

    public void testSuccessNoMatch() throws Exception {
        assertEquals(null, getDescription("xxx", Result.SUCCESS, "regex", null, "description success", null));
    }

    public void testURL() throws Exception {
        assertEquals(
                "<a href=\"http://foo/bar\">http://foo/bar</a>",
                getDescription("url:http://foo/bar", Result.SUCCESS, "url:(.*)", null, null, null));
    }

    public void testNullMatch1() throws Exception {
        assertEquals(
                "Match=(MatchOne) MatchTwo",
                getDescription(
                        "Prefix: MatchOne MatchTwo",
                        Result.SUCCESS,
                        "^Prefix: (\\S+)( .*)?$",
                        null,
                        "Match=(\\1)\\2",
                        null));
    }

    public void testNullMatch2() throws Exception {
        assertEquals(
                "Match=(MatchOne)",
                getDescription(
                        "Prefix: MatchOne", Result.SUCCESS, "^Prefix: (\\S+)( .*)?$", null, "Match=(\\1)\\2", null));
    }

    public void testAppendDescriptionInPublisher() throws Exception {
        FreeStyleProject project = createFreeStyleProject();
        project.getBuildersList().add(new DescriptionSetterBuilder("", "test1", false, true));
        project.getPublishersList().add(new DescriptionSetterPublisher("", "", "test2", "", false, true, true));
        FreeStyleBuild build = project.scheduleBuild2(0).get();
        assertEquals("test1 test2", build.getDescription());

        /* Use the safe HTML markup formatter */
        Jenkins.get().setMarkupFormatter(new RawHtmlMarkupFormatter(false));
        FreeStyleBuild buildWithFormatter = project.scheduleBuild2(0).get();
        assertEquals("test1<br>test2", buildWithFormatter.getDescription());
    }

    public void testRewriteDescriptionInPublisher() throws Exception {
        FreeStyleProject project = createFreeStyleProject();
        project.getBuildersList().add(new DescriptionSetterBuilder("", "test1", false, true));
        project.getPublishersList().add(new DescriptionSetterPublisher("", "", "test2", "", false, false, true));
        FreeStyleBuild build = project.scheduleBuild2(0).get();
        assertEquals("test2", build.getDescription());
    }

    private String getDescription(
            String text,
            Result result,
            String regexp,
            String regexpForFailed,
            String description,
            String descriptionForFailed,
            boolean appendMode)
            throws Exception {
        FreeStyleProject project = createFreeStyleProject();
        project.getBuildersList().add(new TestBuilder(text, result));
        project.getPublishersList()
                .add(new DescriptionSetterPublisher(
                        regexp, regexpForFailed, description, descriptionForFailed, false, appendMode, true));
        FreeStyleBuild build = project.scheduleBuild2(0).get();
        return build.getDescription();
    }

    private String getDescription(
            String text,
            Result result,
            String regexp,
            String regexpForFailed,
            String description,
            String descriptionForFailed)
            throws Exception {
        return getDescription(text, result, regexp, regexpForFailed, description, descriptionForFailed, true);
    }
}