ParserTester.java

package hudson.plugins.warnings.parser;

import static junit.framework.Assert.*;
import hudson.plugins.analysis.util.model.FileAnnotation;
import hudson.plugins.analysis.util.model.Priority;

import java.io.InputStreamReader;
import java.io.Reader;

/**
 * Base class for parser tests. Provides an assertion test for warnings.
 */
public abstract class ParserTester {
    /**
     * Checks the properties of the specified warning.
     *
     * @param annotation the warning to check
     * @param lineNumber the expected line number
     * @param message the expected message
     * @param fileName the expected filename
     * @param type the expected type
     * @param category the expected category
     * @param priority the expected priority
     */
    protected void checkWarning(final FileAnnotation annotation, final int lineNumber, final String message, final String fileName, final String type, final String category, final Priority priority) {
        assertTrue("Annotation is of wrong type.", annotation instanceof Warning);
        Warning warning = (Warning)annotation;
        assertEquals("Wrong type of warning detected.", type, warning.getType());
        assertEquals("Wrong priority detected.", priority, warning.getPriority());
        assertEquals("Wrong category of warning detected.", category, warning.getCategory());
        assertEquals("Wrong number of ranges detected.", 1, warning.getLineRanges().size());
        assertEquals("Wrong ranges start detected.", lineNumber, warning.getLineRanges().iterator().next().getStart());
        assertEquals("Wrong ranges end detected.", lineNumber, warning.getLineRanges().iterator().next().getEnd());
        assertEquals("Wrong message detected.", message, warning.getMessage());
        assertEquals("Wrong filename detected.", fileName, warning.getFileName());
    }

    /**
     * Returns an input stream with the warnings.
     *
     * @return an input stream
     */
    protected Reader openFile() {
        return openFile(getWarningsFile());
    }

    /**
     * Returns an input stream with the warnings.
     *
     * @param fileName
     *            the file to read
     * @return an input stream
     */
    protected Reader openFile(final String fileName) {
        return new InputStreamReader(ParserTester.class.getResourceAsStream(fileName));
    }

    /**
     * Returns the file name of the warnings file.
     *
     * @return the warnings file name
     */
    protected abstract String getWarningsFile();
}