SinceFormatCheckTest.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This 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 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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 this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.tool.checkstyle;

import java.io.File;
import java.io.IOException;

import org.junit.Before;
import org.junit.Test;

import com.puppycrawl.tools.checkstyle.BaseCheckTestSupport;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;

/**
 * Unit tests for {@link SinceFormatCheck}.
 *
 * @version $Id: 4a31a3fce6b1cf782d3896b5193fcb2b141548a6 $
 * @since 8.3
 */
public class SinceFormatCheckTest extends BaseCheckTestSupport
{
    private DefaultConfiguration checkConfig;

    @Before
    public void setUp()
    {
        this.checkConfig = createCheckConfig(SinceFormatCheck.class);
    }

    @Test
    public void checkWithMultipleSinceSeparatedByComma() throws Exception
    {
        final String[] expected = {
            "29:1: There must be only a single version per @since tag for "
            + "[org.xwiki.tool.checkstyle.test.TestClassWithNoSinceJavadocTagAtClassLevel]. Got [8.0, 6.0]"
        };

        verify(this.checkConfig, getPath("TestClassWithMultipleSinceSeparatedByComma.java"), expected);
    }

    @Test
    public void checkWithMultipleSinceSeparatedBySlash() throws Exception
    {
        final String[] expected = {
            "29:5: There must be only a single version per @since tag for "
            + "[org.xwiki.tool.checkstyle.test.TestClassWithNoSinceJavadocTagAtClassLevel.something()]. Got [6.0/8.0]"
        };

        verify(this.checkConfig, getPath("TestClassWithMultipleSinceSeparatedBySlash.java"), expected);
    }

    @Override
    protected String getPath(String filename) throws IOException
    {
        return (new File("src/test/resources/org/xwiki/tool/checkstyle/test/since/" + filename)).getCanonicalPath();
    }
}