GitBucketLinkAnnotatorTest.java

/*
 * The MIT License
 *
 * Copyright (c) 2013, Seiji Sogabe
 *
 * 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 org.jenkinsci.plugins.gitbucket;

import hudson.MarkupText;
import hudson.model.FreeStyleBuild;
import hudson.model.FreeStyleProject;
import org.junit.Test;

import static org.junit.Assert.assertEquals;
import static org.mockito.Matchers.anyString;
import static org.mockito.Matchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

public class GitBucketLinkAnnotatorTest {

    private static final String GITBUCKET_URL = "http://bacons.ddo.jp/gitbucket/jenkins/gitbucket-plugin/";

    @Test
    public void testAnnoate() {
        FreeStyleProject job = mock(FreeStyleProject.class);
        FreeStyleBuild build = mock(FreeStyleBuild.class);
        GitBucketProjectProperty gpp =  new GitBucketProjectProperty(GITBUCKET_URL, true);
        when(build.getProject()).thenReturn(job);
        when(job.getProperty(GitBucketProjectProperty.class)).thenReturn(gpp);

        MarkupText text = mock(MarkupText.class);

        GitBucketLinkAnnotator target = spy(new GitBucketLinkAnnotator());
        target.annotate(build, null, text);

        verify(target, times(1)).annotate(text, GITBUCKET_URL);
    }

    @Test
    public void testAnnoate_NoProjectProperty() {
    	FreeStyleProject job = mock(FreeStyleProject.class);
    	FreeStyleBuild build = mock(FreeStyleBuild.class);
        GitBucketProjectProperty gpp = null;
        when(build.getProject()).thenReturn(job);
        when(job.getProperty(GitBucketProjectProperty.class)).thenReturn(gpp);

        MarkupText text = mock(MarkupText.class);

        GitBucketLinkAnnotator target = spy(new GitBucketLinkAnnotator());
        target.annotate(build, null, text);

        verify(target, never()).annotate(eq(text), anyString());
    }

    @Test
    public void testAnnoate_LinkDisabled() {
    	FreeStyleProject job = mock(FreeStyleProject.class);
    	FreeStyleBuild build = mock(FreeStyleBuild.class);
        GitBucketProjectProperty gpp = new GitBucketProjectProperty(GITBUCKET_URL, false);
        when(build.getProject()).thenReturn(job);
        when(job.getProperty(GitBucketProjectProperty.class)).thenReturn(gpp);

        MarkupText text = mock(MarkupText.class);

        GitBucketLinkAnnotator target = spy(new GitBucketLinkAnnotator());
        target.annotate(build, null, text);

        verify(target, never()).annotate(eq(text), anyString());
    }

    @Test
    public void testAnnotateIssueMarkupText() {
        assertAnnotatedTextEquals(
                "(Close #1) Fixed XSS.",
                "(<a href='" + GITBUCKET_URL + "issues/1'>Close #1</a>) Fixed XSS.");
        assertAnnotatedTextEquals(
                "(close #1) Fixed XSS.",
                "(<a href='" + GITBUCKET_URL + "issues/1'>close #1</a>) Fixed XSS.");
        assertAnnotatedTextEquals(
                "(closes #1) Fixed XSS.",
                "(<a href='" + GITBUCKET_URL + "issues/1'>closes #1</a>) Fixed XSS.");
        assertAnnotatedTextEquals(
                "(closed #1) Fixed XSS.",
                "(<a href='" + GITBUCKET_URL + "issues/1'>closed #1</a>) Fixed XSS.");
        assertAnnotatedTextEquals(
                "(fix #1) Fixed XSS.",
                "(<a href='" + GITBUCKET_URL + "issues/1'>fix #1</a>) Fixed XSS.");
        assertAnnotatedTextEquals(
                "(fixes #1) Fixed XSS.",
                "(<a href='" + GITBUCKET_URL + "issues/1'>fixes #1</a>) Fixed XSS.");
        assertAnnotatedTextEquals(
                "(fixed #1) Fixed XSS.",
                "(<a href='" + GITBUCKET_URL + "issues/1'>fixed #1</a>) Fixed XSS.");
        assertAnnotatedTextEquals(
                "(resolve #1) Fixed XSS.",
                "(<a href='" + GITBUCKET_URL + "issues/1'>resolve #1</a>) Fixed XSS.");
        assertAnnotatedTextEquals(
                "(resolves #1) Fixed XSS.",
                "(<a href='" + GITBUCKET_URL + "issues/1'>resolves #1</a>) Fixed XSS.");
        assertAnnotatedTextEquals(
                "(resolved #1) Fixed XSS.",
                "(<a href='" + GITBUCKET_URL + "issues/1'>resolved #1</a>) Fixed XSS.");
        assertAnnotatedTextEquals(
                "(refs #1) Fixed XSS.",
                "(<a href='" + GITBUCKET_URL + "issues/1'>refs #1</a>) Fixed XSS.");
        assertAnnotatedTextEquals(
                "(refs 1) Fixed XSS.",
                "(<a href='" + GITBUCKET_URL + "issues/1'>refs 1</a>) Fixed XSS.");
        assertAnnotatedTextEquals(
                "(issue #100) Fixed XSS.",
                "(<a href='" + GITBUCKET_URL + "issues/100'>issue #100</a>) Fixed XSS.");
        assertAnnotatedTextEquals(
                "(issue 100) Fixed XSS.",
                "(<a href='" + GITBUCKET_URL + "issues/100'>issue 100</a>) Fixed XSS.");
        assertAnnotatedTextEquals(
                "(Close #1) (Fixed #3) Fixed XSS.",
                "(<a href='" + GITBUCKET_URL + "issues/1'>Close #1</a>) "
                        + "(<a href='" + GITBUCKET_URL + "issues/3'>Fixed #3</a>) Fixed XSS.");
    }

    @Test
    public void testAnnotatePullsMarkupText() {
        assertAnnotatedTextEquals(
                "pull #1 Fixed typo.",
                "<a href='" + GITBUCKET_URL + "pulls/1'>pull #1</a> Fixed typo.");
        assertAnnotatedTextEquals(
                "pull 100 Fixed typo.",
                "<a href='" + GITBUCKET_URL + "pulls/100'>pull 100</a> Fixed typo.");
    }

    @Test
    public void testAnnotateWikiMarkupText() {
        assertAnnotatedTextEquals(
                "wiki maven",
                "<a href='" + GITBUCKET_URL + "wiki/maven'>wiki maven</a>");
        assertAnnotatedTextEquals(
                "wiki GitBucket is a Github clone.",
                "<a href='" + GITBUCKET_URL + "wiki/GitBucket'>wiki GitBucket</a> is a Github clone.");
    }

    private void assertAnnotatedTextEquals(String originalText, String expectedAnnotatedText) {
        MarkupText markupText = new MarkupText(originalText);
        GitBucketLinkAnnotator annotator = new GitBucketLinkAnnotator();
        annotator.annotate(markupText, GITBUCKET_URL);
        assertEquals(expectedAnnotatedText, markupText.toString(false));
    }
}