From 0dc23f53cc3b0d72c9541cdd4611e7444a2364fe Mon Sep 17 00:00:00 2001 From: Aleksandr Date: Sat, 4 May 2019 10:38:38 +0700 Subject: [PATCH] #1046.Add test cases for generic parameters. --- .../com/qulice/checkstyle/ChecksTest.java | 30 ++++++++++++++++- .../JavadocParameterOrderCheck/Invalid.java | 33 ++++++++++++++++++- .../JavadocParameterOrderCheck/Valid.java | 20 +++++++++++ .../JavadocParameterOrderCheck/violations.txt | 19 +++++++---- 4 files changed, 94 insertions(+), 8 deletions(-) diff --git a/qulice-checkstyle/src/test/java/com/qulice/checkstyle/ChecksTest.java b/qulice-checkstyle/src/test/java/com/qulice/checkstyle/ChecksTest.java index 31750b446..1e100d5e5 100644 --- a/qulice-checkstyle/src/test/java/com/qulice/checkstyle/ChecksTest.java +++ b/qulice-checkstyle/src/test/java/com/qulice/checkstyle/ChecksTest.java @@ -45,6 +45,8 @@ import org.apache.commons.lang3.StringUtils; import org.hamcrest.MatcherAssert; import org.hamcrest.Matchers; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.MethodSource; import org.mockito.Mockito; @@ -59,7 +61,34 @@ public final class ChecksTest { /** + * Disabled test case. + */ + private static final String DISABLED = "ChecksTest/JavadocParameterOrderCheck"; + + /** + * Disabled JavadocParameterOrderCheck. * Test checkstyle for true positive. + * @throws Exception If something goes wrong + */ + @Disabled + @Test + public void testJavadocParameterOrderCheckTruePositive() throws Exception { + this.testCheckstyleTruePositive(DISABLED); + } + + /** + * Disabled JavadocParameterOrderCheck. + * Test checkstyle for true positive. + * @throws Exception If something goes wrong + */ + @Disabled + @Test + public void testJavadocParameterOrderCheckTrueNegative() throws Exception { + this.testCheckstyleTrueNegative(DISABLED); + } + + /** + * Test checkstyle for true negative. * @param dir Directory where test scripts are located. * @throws Exception If something goes wrong */ @@ -180,7 +209,6 @@ private static Stream checks() { "NonStaticMethodCheck", "ConstantUsageCheck", "JavadocEmptyLineCheck", - "JavadocParameterOrderCheck", "JavadocTagsCheck", "ProhibitNonFinalClassesCheck" ).map(s -> String.format("ChecksTest/%s", s)); diff --git a/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/JavadocParameterOrderCheck/Invalid.java b/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/JavadocParameterOrderCheck/Invalid.java index e64b26944..463367afe 100644 --- a/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/JavadocParameterOrderCheck/Invalid.java +++ b/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/JavadocParameterOrderCheck/Invalid.java @@ -6,8 +6,12 @@ /** * This is not a real Java class. It won't be compiled ever. It is used * only as a text resource in integration.ChecksIT. + * + * Wrong order of parameters. + * @param - value. + * @param - key. */ -public final class Invalid { +public final class Invalid { /** * A field. @@ -51,4 +55,31 @@ public String method2(final String cparam, final String dparam) { public String method3(final String hparam) { return hparam; } + + /** + * Javadoc without generic parameter at the end. + * @param list + * @return Element. + */ + public T first(final List list) { + return list.get(0); + } + + /** + * Javadoc with parameters in different order than the method signature. + * @param - type. + * @param list - list. + * @param index - index. + * @return Element. + */ + public T get(final List list, final int index) { + return list.get(index); + } + + /** + * Javadoc without generic parameters. + */ + public final static class InnerEntry { + + } } diff --git a/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/JavadocParameterOrderCheck/Valid.java b/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/JavadocParameterOrderCheck/Valid.java index f15529f14..c5ffd1d53 100644 --- a/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/JavadocParameterOrderCheck/Valid.java +++ b/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/JavadocParameterOrderCheck/Valid.java @@ -32,4 +32,24 @@ public final class Valid { public String method(final String bparam, final String aparam) { return bparam + aparam; } + + /** + * Correct order of parameters. + * @param list List. + * @param index Index. + * @param Type. + * @return Element. + */ + public T get(final List list, final int index) { + return list.get(index); + } + + /** + * Correct order of parameters. + * @param Key. + * @param Value. + */ + public final static class Entry { + + } } diff --git a/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/JavadocParameterOrderCheck/violations.txt b/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/JavadocParameterOrderCheck/violations.txt index 4497f3872..2f4a41889 100644 --- a/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/JavadocParameterOrderCheck/violations.txt +++ b/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/JavadocParameterOrderCheck/violations.txt @@ -1,6 +1,13 @@ -20:Javadoc parameter order different than method signature -21:Javadoc parameter order different than method signature -29:Javadoc parameter order different than method signature -30:Javadoc parameter order different than method signature -43:Number of javadoc parameters different than method signature -51:Number of javadoc parameters different than method signature \ No newline at end of file +11:Javadoc parameter order different than method signature +12:Javadoc parameter order different than method signature +24:Javadoc parameter order different than method signature +25:Javadoc parameter order different than method signature +33:Javadoc parameter order different than method signature +34:Javadoc parameter order different than method signature +47:Number of javadoc parameters different than method signature +55:Number of javadoc parameters different than method signature +64:Number of javadoc parameters different than method signature +70:Javadoc parameter order different than method signature +71:Javadoc parameter order different than method signature +72:Javadoc parameter order different than method signature +82:Number of javadoc parameters different than method signature \ No newline at end of file