hudson.plugins.timestamper.TimestampNoteTest.java Source code

Introduction

Here is the source code for hudson.plugins.timestamper.TimestampNoteTest.java

Source

/*
 * The MIT License
 * 
 * Copyright (c) 2010 Steven G. Brown
 * 
 * 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.plugins.timestamper;

import static org.hamcrest.CoreMatchers.is;
import static org.junit.Assert.assertThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import hudson.MarkupText;
import hudson.console.ConsoleNote;
import hudson.model.Run;
import hudson.tasks._ant.AntTargetNote;

import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;

import javax.servlet.http.HttpServletRequest;

import org.apache.commons.lang.SerializationUtils;
import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.powermock.api.mockito.PowerMockito;
import org.powermock.core.classloader.annotations.PrepareForTest;
import org.powermock.modules.junit4.rule.PowerMockRule;
import org.powermock.reflect.Whitebox;

import com.google.common.base.Supplier;

/**
 * Unit test for the {@link TimestampNote} class.
 * 
 * @author Steven G. Brown
 */
@SuppressWarnings("boxing")
@PrepareForTest(Run.class)
public class TimestampNoteTest {

    private static final String FORMAT = "HH:mm:ss";

    private static final String OTHER_FORMAT = "HHmmss";

    /**
     */
    @Rule
    public PowerMockRule powerMockRule = new PowerMockRule();

    private TimeZone systemDefaultTimeZone;

    private String currentSystemTimeFormat;

    /**
     * @throws Exception
     */
    @Before
    public void setUp() throws Exception {
        systemDefaultTimeZone = TimeZone.getDefault();
        // Set the time zone to get consistent results.
        TimeZone.setDefault(TimeZone.getTimeZone("GMT"));
        setSystemTimeFormat(FORMAT);
    }

    /**
     */
    @After
    public void tearDown() {
        TimeZone.setDefault(systemDefaultTimeZone);
    }

    /**
     */
    @Test
    public void testGetTimestamp() {
        Run<?, ?> build = PowerMockito.mock(Run.class);
        when(build.getTimeInMillis()).thenReturn(1l);

        TimestampNote note = new TimestampNote(3);
        assertThat(note.getTimestamp(build), is(new Timestamp(2, 3)));
    }

    /**
     */
    @Test
    public void testTimestampNote_DefaultFormat() {
        assertThat(annotate("line", new TimestampNote(0)), is(timestamp(0) + "line"));
    }

    /**
     */
    @Test
    public void testTimestampNote_NonDefaultFormat() {
        setSystemTimeFormat(OTHER_FORMAT);
        assertThat(annotate("line", new TimestampNote(0)), is(timestamp(0) + "line"));
    }

    /**
     */
    @Test
    public void testSerialization_DefaultFormat() {
        assertThat(annotate("line", serialize(new TimestampNote(0))), is(timestamp(0) + "line"));
    }

    /**
     */
    @Test
    public void testSerialization_NonDefaultFormat() {
        setSystemTimeFormat(OTHER_FORMAT);
        assertThat(annotate("line", serialize(new TimestampNote(0))), is(timestamp(0) + "line"));
    }

    /**
     */
    @Test
    public void testTimestampThenAntTargetNote() {
        assertThat(annotate("target:", new TimestampNote(0), new AntTargetNote()),
                is(timestamp(0) + "<b class=ant-target>target</b>:"));
    }

    /**
     */
    @Test
    public void testAntTargetNoteThenTimestamp() {
        assertThat(annotate("target:", new AntTargetNote(), new TimestampNote(0)),
                is(timestamp(0) + "<b class=ant-target>target</b>:"));
    }

    private void setSystemTimeFormat(final String systemTimeFormat) {
        Whitebox.setInternalState(TimestamperConfig.class, Supplier.class, new Supplier<TimestampFormatter>() {

            public TimestampFormatter get() {
                HttpServletRequest request = mock(HttpServletRequest.class);
                return new TimestampFormatter(systemTimeFormat, "", request);
            }
        });
        currentSystemTimeFormat = systemTimeFormat;
    }

    @SuppressWarnings({ "rawtypes", "unchecked" })
    private String annotate(String text, ConsoleNote... notes) {
        Object context = mock(Run.class);
        MarkupText markupText = new MarkupText(text);
        for (ConsoleNote note : notes) {
            note.annotate(context, markupText, 0);
        }
        return markupText.toString(true);
    }

    private TimestampNote serialize(TimestampNote note) {
        return (TimestampNote) SerializationUtils.clone(note);
    }

    private String timestamp(long millisSinceEpoch) {
        return TimestamperTestAssistant
                .span(new SimpleDateFormat(currentSystemTimeFormat).format(new Date(millisSinceEpoch)));
    }
}