| //////////////////////////////////////////////////////////////////////////////// |
| // 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.puppycrawl.tools.checkstyle.checks.javadoc; |
| |
| import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck.MSG_LINE_BEFORE; |
| import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck.MSG_MISPLACED_TAG; |
| import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck.MSG_REDUNDANT_PARAGRAPH; |
| import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck.MSG_TAG_AFTER; |
| import static org.junit.Assert.assertArrayEquals; |
| |
| import org.junit.Test; |
| |
| import com.puppycrawl.tools.checkstyle.AbstractModuleTestSupport; |
| import com.puppycrawl.tools.checkstyle.DefaultConfiguration; |
| import com.puppycrawl.tools.checkstyle.api.TokenTypes; |
| import com.puppycrawl.tools.checkstyle.utils.CommonUtils; |
| |
| public class JavadocParagraphCheckTest extends AbstractModuleTestSupport { |
| @Override |
| protected String getPackageLocation() { |
| return "com/puppycrawl/tools/checkstyle/checks/javadoc/javadocparagraph"; |
| } |
| |
| @Test |
| public void testGetRequiredTokens() { |
| final JavadocParagraphCheck checkObj = new JavadocParagraphCheck(); |
| final int[] expected = {TokenTypes.BLOCK_COMMENT_BEGIN}; |
| assertArrayEquals("Default required tokens are invalid", |
| expected, checkObj.getRequiredTokens()); |
| } |
| |
| @Test |
| public void testCorrect() throws Exception { |
| final DefaultConfiguration checkConfig = createModuleConfig(JavadocParagraphCheck.class); |
| final String[] expected = CommonUtils.EMPTY_STRING_ARRAY; |
| |
| verify(checkConfig, getPath("InputJavadocParagraphCorrect.java"), expected); |
| } |
| |
| @Test |
| public void testIncorrect() throws Exception { |
| final DefaultConfiguration checkConfig = createModuleConfig(JavadocParagraphCheck.class); |
| final String[] expected = { |
| "7: " + getCheckMessage(MSG_MISPLACED_TAG), |
| "7: " + getCheckMessage(MSG_LINE_BEFORE), |
| "8: " + getCheckMessage(MSG_MISPLACED_TAG), |
| "8: " + getCheckMessage(MSG_LINE_BEFORE), |
| "14: " + getCheckMessage(MSG_MISPLACED_TAG), |
| "14: " + getCheckMessage(MSG_LINE_BEFORE), |
| "16: " + getCheckMessage(MSG_MISPLACED_TAG), |
| "23: " + getCheckMessage(MSG_LINE_BEFORE), |
| "25: " + getCheckMessage(MSG_MISPLACED_TAG), |
| "32: " + getCheckMessage(MSG_MISPLACED_TAG), |
| "32: " + getCheckMessage(MSG_LINE_BEFORE), |
| "32: " + getCheckMessage(MSG_REDUNDANT_PARAGRAPH), |
| "33: " + getCheckMessage(MSG_MISPLACED_TAG), |
| "33: " + getCheckMessage(MSG_LINE_BEFORE), |
| "34: " + getCheckMessage(MSG_MISPLACED_TAG), |
| "34: " + getCheckMessage(MSG_LINE_BEFORE), |
| "35: " + getCheckMessage(MSG_MISPLACED_TAG), |
| "35: " + getCheckMessage(MSG_LINE_BEFORE), |
| "39: " + getCheckMessage(MSG_MISPLACED_TAG), |
| "39: " + getCheckMessage(MSG_LINE_BEFORE), |
| "45: " + getCheckMessage(MSG_MISPLACED_TAG), |
| "45: " + getCheckMessage(MSG_REDUNDANT_PARAGRAPH), |
| "48: " + getCheckMessage(MSG_MISPLACED_TAG), |
| "50: " + getCheckMessage(MSG_MISPLACED_TAG), |
| "50: " + getCheckMessage(MSG_LINE_BEFORE), |
| "51: " + getCheckMessage(MSG_MISPLACED_TAG), |
| "51: " + getCheckMessage(MSG_LINE_BEFORE), |
| "61: " + getCheckMessage(MSG_REDUNDANT_PARAGRAPH), |
| "62: " + getCheckMessage(MSG_TAG_AFTER), |
| "70: " + getCheckMessage(MSG_MISPLACED_TAG), |
| "70: " + getCheckMessage(MSG_LINE_BEFORE), |
| "72: " + getCheckMessage(MSG_MISPLACED_TAG), |
| "75: " + getCheckMessage(MSG_MISPLACED_TAG), |
| "75: " + getCheckMessage(MSG_LINE_BEFORE), |
| "81: " + getCheckMessage(MSG_TAG_AFTER), |
| "82: " + getCheckMessage(MSG_TAG_AFTER), |
| }; |
| verify(checkConfig, getPath("InputJavadocParagraphIncorrect.java"), expected); |
| } |
| |
| @Test |
| public void testAllowNewlineParagraph() throws Exception { |
| final DefaultConfiguration checkConfig = createModuleConfig(JavadocParagraphCheck.class); |
| checkConfig.addAttribute("allowNewlineParagraph", "false"); |
| final String[] expected = { |
| "7: " + getCheckMessage(MSG_LINE_BEFORE), |
| "8: " + getCheckMessage(MSG_LINE_BEFORE), |
| "14: " + getCheckMessage(MSG_LINE_BEFORE), |
| "23: " + getCheckMessage(MSG_LINE_BEFORE), |
| "32: " + getCheckMessage(MSG_LINE_BEFORE), |
| "32: " + getCheckMessage(MSG_REDUNDANT_PARAGRAPH), |
| "33: " + getCheckMessage(MSG_LINE_BEFORE), |
| "34: " + getCheckMessage(MSG_LINE_BEFORE), |
| "35: " + getCheckMessage(MSG_LINE_BEFORE), |
| "39: " + getCheckMessage(MSG_LINE_BEFORE), |
| "45: " + getCheckMessage(MSG_REDUNDANT_PARAGRAPH), |
| "50: " + getCheckMessage(MSG_LINE_BEFORE), |
| "51: " + getCheckMessage(MSG_LINE_BEFORE), |
| "61: " + getCheckMessage(MSG_REDUNDANT_PARAGRAPH), |
| "62: " + getCheckMessage(MSG_TAG_AFTER), |
| "70: " + getCheckMessage(MSG_LINE_BEFORE), |
| "75: " + getCheckMessage(MSG_LINE_BEFORE), |
| "81: " + getCheckMessage(MSG_TAG_AFTER), |
| "82: " + getCheckMessage(MSG_TAG_AFTER), |
| }; |
| verify(checkConfig, getPath("InputJavadocParagraphIncorrect.java"), expected); |
| } |
| } |