ChangeTest.java

/*
This file is part of Delivery Pipeline Plugin.

Delivery Pipeline Plugin is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Delivery Pipeline Plugin is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Delivery Pipeline Plugin.
If not, see <http://www.gnu.org/licenses/>.
*/
package se.diabol.jenkins.pipeline.domain;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;

import hudson.MarkupText;
import hudson.model.AbstractBuild;
import hudson.model.FreeStyleProject;
import hudson.scm.ChangeLogAnnotator;
import hudson.scm.ChangeLogSet;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.jvnet.hudson.test.FakeChangeLogSCM;
import org.jvnet.hudson.test.JenkinsRule;
import org.jvnet.hudson.test.MockFolder;
import se.diabol.jenkins.pipeline.test.FakeRepositoryBrowserSCM;
import se.diabol.jenkins.pipeline.test.MeanFakeRepositoryBrowserSCM;
import se.diabol.jenkins.pipeline.test.ParentAwareSCM;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.List;
import java.util.logging.Handler;
import java.util.logging.Logger;
import java.util.logging.StreamHandler;

public class ChangeTest {

    @Rule
    public JenkinsRule jenkins = new JenkinsRule();


    private static Logger log = Logger.getLogger(Change.class.getName()); // matches the logger in the affected class
    private static OutputStream logCapturingStream;
    private static StreamHandler customLogHandler;

    @Before
    public void attachLogCapturer() {
        logCapturingStream = new ByteArrayOutputStream();
        Handler[] handlers = log.getParent().getHandlers();
        customLogHandler = new StreamHandler(logCapturingStream, handlers[0].getFormatter());
        log.addHandler(customLogHandler);
    }

    public String getTestCapturedLog() throws IOException {
        customLogHandler.flush();
        return logCapturingStream.toString();
    }

    @Test
    public void testGetChangesNoBrowser() throws Exception {
        FreeStyleProject project = jenkins.createFreeStyleProject("build");
        FakeChangeLogSCM scm = new FakeChangeLogSCM();
        scm.addChange().withAuthor("test-user").withMsg("Fixed bug");
        project.setScm(scm);
        jenkins.setQuietPeriod(0);
        jenkins.buildAndAssertSuccess(project);
        AbstractBuild build = project.getLastBuild();
        List<Change> changes = Change.getChanges(build);
        assertNotNull(changes);
        assertEquals(1, changes.size());
        Change change = changes.get(0);
        assertEquals("Fixed bug", change.getMessage());
        assertEquals("test-user", change.getAuthor().getName());
        assertNull(change.getCommitId());
        assertNull(change.getChangeLink());
    }

    @Test
    public void testGetChangesWithBrowser() throws Exception {
        FreeStyleProject project = jenkins.createFreeStyleProject("build");
        FakeRepositoryBrowserSCM scm = new FakeRepositoryBrowserSCM();
        scm.addChange().withAuthor("test-user").withMsg("Fixed bug");
        project.setScm(scm);
        jenkins.setQuietPeriod(0);
        jenkins.buildAndAssertSuccess(project);
        AbstractBuild build = project.getLastBuild();
        List<Change> changes = Change.getChanges(build);
        assertNotNull(changes);
        assertEquals(1, changes.size());
        Change change = changes.get(0);
        assertEquals("Fixed bug", change.getMessage());
        assertEquals("test-user", change.getAuthor().getName());
        assertNull(change.getCommitId());
        assertEquals("http://somewhere.com/test-user", change.getChangeLink());
    }

    @Test
    public void testGetChangesWithAnnotator() throws Exception {
        ChangeLogAnnotator.all().add(new ChangeLogAnnotator() {
            @Override
            public void annotate(AbstractBuild<?, ?> build, ChangeLogSet.Entry change, MarkupText text) {
                text.addMarkup(0, "Something huge: ");
            }
        });
        FreeStyleProject project = jenkins.createFreeStyleProject("build");
        ParentAwareSCM scm = new ParentAwareSCM();
        scm.addChange().withAuthor("test-user").withMsg("Fixed bug");
        project.setScm(scm);
        jenkins.setQuietPeriod(0);
        jenkins.buildAndAssertSuccess(project);
        AbstractBuild build = project.getLastBuild();
        List<Change> changes = Change.getChanges(build);
        assertNotNull(changes);
        assertEquals(1, changes.size());
        Change change = changes.get(0);
        assertEquals("Something huge: Fixed bug", change.getMessage());
    }

    @Test
    public void testGetChangesWithBrowserThrowIOException() throws Exception {
        MockFolder folder = jenkins.createFolder("Folder");
        FreeStyleProject project = folder.createProject(FreeStyleProject.class, "build");
        MeanFakeRepositoryBrowserSCM scm = new MeanFakeRepositoryBrowserSCM();
        scm.addChange().withAuthor("test-user").withMsg("Fixed bug");
        project.setScm(scm);
        jenkins.setQuietPeriod(0);
        jenkins.buildAndAssertSuccess(project);
        AbstractBuild build = project.getLastBuild();
        List<Change> changes = Change.getChanges(build);
        assertNotNull(changes);
        assertEquals(1, changes.size());
        Change change = changes.get(0);
        assertEquals("Fixed bug", change.getMessage());
        assertEquals("test-user", change.getAuthor().getName());
        assertNull(change.getCommitId());
        assertNull(change.getChangeLink());

        String capturedLog = getTestCapturedLog();
        Assert.assertTrue(capturedLog.contains("Could not get changeset link for: Folder » build #1"));
    }


}