////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2017 the original author or authors.
//
// This library 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 library 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 library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.google.checkstyle.test.chapter7javadoc.rule72thesummaryfragment;
import java.io.File;
import java.io.IOException;
import org.junit.Test;
import com.google.checkstyle.test.base.BaseCheckTestSupport;
import com.puppycrawl.tools.checkstyle.api.Configuration;
import com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck;
import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
public class SummaryJavadocTest extends BaseCheckTestSupport {
@Override
protected String getPath(String fileName) throws IOException {
return super.getPath("chapter7javadoc" + File.separator + "rule72thesummaryfragment"
+ File.separator + fileName);
}
@Test
public void testCorrect() throws Exception {
final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
final Configuration checkConfig = getCheckConfig("SummaryJavadoc");
final String filePath = getPath("InputCorrectSummaryJavaDocCheck.java");
final Integer[] warnList = getLinesWithWarn(filePath);
verify(checkConfig, filePath, expected, warnList);
}
@Test
public void testIncorrect() throws Exception {
final String msgFirstSentence = getCheckMessage(SummaryJavadocCheck.class,
"summary.first.sentence");
final String msgForbiddenFragment = getCheckMessage(SummaryJavadocCheck.class,
"summary.javaDoc");
final String[] expected = {
"14: " + msgFirstSentence,
"37: " + msgFirstSentence,
"47: " + msgForbiddenFragment,
"58: " + msgForbiddenFragment,
"69: " + msgFirstSentence,
"83: " + msgForbiddenFragment,
"103: " + msgFirstSentence,
};
final Configuration checkConfig = getCheckConfig("SummaryJavadoc");
final String filePath = getPath("InputIncorrectSummaryJavaDocCheck.java");
final Integer[] warnList = getLinesWithWarn(filePath);
verify(checkConfig, filePath, expected, warnList);
}
}