org.sonar.plugins.checkstyle.CheckstyleExecutorTest.java Source code

Introduction

Here is the source code for org.sonar.plugins.checkstyle.CheckstyleExecutorTest.java

Source

/*
 * Sonar, open source software quality management tool.
 * Copyright (C) 2008-2011 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * Sonar is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * Sonar 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Sonar; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonar.plugins.checkstyle;

import com.puppycrawl.tools.checkstyle.api.AuditEvent;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang.StringUtils;
import org.hamcrest.BaseMatcher;
import org.hamcrest.Description;
import org.junit.Test;

import java.io.File;
import java.nio.charset.Charset;
import java.util.Arrays;

import static org.hamcrest.core.Is.is;
import static org.junit.Assert.assertThat;
import static org.junit.internal.matchers.StringContains.containsString;
import static org.mockito.Matchers.anyObject;
import static org.mockito.Mockito.*;

public class CheckstyleExecutorTest {

    @Test
    public void execute() throws Exception {
        CheckstyleConfiguration conf = mockConf();
        CheckstyleAuditListener listener = mockListener();
        CheckstyleExecutor executor = new CheckstyleExecutor(conf, listener, getClass().getClassLoader());
        executor.execute();

        verify(listener, times(1)).auditStarted((AuditEvent) anyObject());
        verify(listener, times(1)).auditFinished((AuditEvent) anyObject());
        verify(listener, times(1)).fileStarted(argThat(newFilenameMatcher("Hello.java")));
        verify(listener, times(1)).fileFinished(argThat(newFilenameMatcher("Hello.java")));
        verify(listener, times(1)).fileStarted(argThat(newFilenameMatcher("World.java")));
        verify(listener, times(1)).fileFinished(argThat(newFilenameMatcher("World.java")));
        verify(listener, atLeast(1)).addError(argThat(newErrorMatcher("Hello.java",
                "com.puppycrawl.tools.checkstyle.checks.coding.EmptyStatementCheck")));
    }

    @Test
    public void canGenerateXMLReport() throws Exception {
        CheckstyleConfiguration conf = mockConf();
        File report = new File("target/test-tmp/checkstyle-report.xml");
        when(conf.getTargetXMLReport()).thenReturn(report);
        CheckstyleAuditListener listener = mockListener();
        CheckstyleExecutor executor = new CheckstyleExecutor(conf, listener, getClass().getClassLoader());
        executor.execute();

        assertThat(report.exists(), is(true));
        assertThat(FileUtils.readFileToString(report), containsString("<error"));
    }

    private BaseMatcher<AuditEvent> newErrorMatcher(final String filename, final String rule) {
        return new BaseMatcher<AuditEvent>() {
            public boolean matches(Object o) {
                AuditEvent event = (AuditEvent) o;
                return StringUtils.endsWith(event.getFileName(), filename)
                        && StringUtils.equals(event.getSourceName(), rule);
            }

            public void describeTo(Description description) {
            }
        };
    }

    private BaseMatcher<AuditEvent> newFilenameMatcher(final String filename) {
        return new BaseMatcher<AuditEvent>() {
            public boolean matches(Object o) {
                AuditEvent event = (AuditEvent) o;
                return StringUtils.endsWith(event.getFileName(), filename);
            }

            public void describeTo(Description description) {
            }
        };
    }

    private CheckstyleAuditListener mockListener() {
        return mock(CheckstyleAuditListener.class);
    }

    private CheckstyleConfiguration mockConf() throws Exception {
        CheckstyleConfiguration conf = mock(CheckstyleConfiguration.class);
        when(conf.getCharset()).thenReturn(Charset.defaultCharset());
        when(conf.getCheckstyleConfiguration()).thenReturn(
                CheckstyleConfiguration.toCheckstyleConfiguration(new File("test-resources/checkstyle-conf.xml")));
        when(conf.getSourceFiles()).thenReturn(
                Arrays.<File>asList(new File("test-resources/Hello.java"), new File("test-resources/World.java")));
        return conf;
    }
}