split CheckstyleValidatorTest into several test classes

qulice-checkstyle/src/test/java/com/qulice/checkstyle/CheckstyleValidatorLicenseTest.java

@@ -0,0 +1,132 @@
+/*
+ * Copyright (c) 2011-2024 Qulice.com
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met: 1) Redistributions of source code must retain the above
+ * copyright notice, this list of conditions and the following
+ * disclaimer. 2) Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided
+ * with the distribution. 3) Neither the name of the Qulice.com nor
+ * the names of its contributors may be used to endorse or promote
+ * products derived from this software without specific prior written
+ * permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
+ * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+ * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.qulice.checkstyle;
+
+import com.google.common.base.Joiner;
+import com.qulice.checkstyle.test.extensions.FileToUrl;
+import com.qulice.checkstyle.test.extensions.RunnerConstant;
+import com.qulice.checkstyle.test.extensions.ViolationMatcher;
+import com.qulice.spi.Environment;
+import com.qulice.spi.Violation;
+import java.io.File;
+import java.util.Collection;
+import org.hamcrest.MatcherAssert;
+import org.hamcrest.Matchers;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Test case for license.
+ *
+ * @since 0.3
+ */
+final class CheckstyleValidatorLicenseTest {
+
+    /**
+     * Rule for testing.
+     */
+    private License rule;
+
+    @BeforeEach
+    void setRule() {
+        this.rule = new License();
+    }
+
+    /**
+     * CheckstyleValidator can catch checkstyle violations.
+     * @throws Exception If something wrong happens inside.
+     */
+    @Test
+    void catchesCheckstyleViolationsInLicense() throws Exception {
+        final Environment.Mock mock = new Environment.Mock();
+        final File license = this.rule.savePackageInfo(
+            new File(mock.basedir(), RunnerConstant.DIRECTORY.value())
+        ).withLines("License-1.", "", "License-2.")
+            .withEol("\n")
+            .file();
+        final String content =
+            // @checkstyle StringLiteralsConcatenation (4 lines)
+            "/" + "*\n * License-3.\n *\n * License-2.\n */\n"
+                + "package foo;\n"
+                + "public class Foo { }\n";
+        final String name = "Foo.java";
+        final Environment env = mock.withParam(
+            RunnerConstant.LICENSE_PROP.value(),
+            new FileToUrl(license).toUrl()
+        ).withFile(String.format("src/main/java/foo/%s", name), content);
+        final Collection<Violation> results =
+            new CheckstyleValidator(env)
+                .validate(env.files(name));
+        MatcherAssert.assertThat(
+            "Header validation is expected",
+            results,
+            Matchers.hasItem(
+                new ViolationMatcher(
+                    "Line does not match expected header line of", name
+                )
+            )
+        );
+    }
+
+    /**
+     * CheckstyleValidator does not produce errors when last thing
+     * in file are imports. The only exception that should be thrown is
+     * qulice ValidationException.
+     * @throws Exception In case of error.
+     */
+    @Test
+    void doesNotThrowExceptionIfImportsOnly() throws Exception {
+        final Environment.Mock mock = new Environment.Mock();
+        final File license = this.rule.savePackageInfo(
+            new File(mock.basedir(), RunnerConstant.DIRECTORY.value())
+        ).withLines("License-1.", "", "License-2.")
+            .withEol("\n")
+            .file();
+        final String crlf = "\r\n";
+        final String content = Joiner.on(crlf).join(
+            "package com.google;",
+            crlf,
+            "import java.util.*;"
+        );
+        final String name = "Foo.java";
+        final Environment env = mock.withParam(
+            RunnerConstant.LICENSE_PROP.value(),
+            new FileToUrl(license).toUrl()
+        ).withFile(String.format("src/main/java/foo/%s", name), content);
+        final Collection<Violation> results =
+            new CheckstyleValidator(env).validate(env.files(name));
+        MatcherAssert.assertThat(
+            "Validation error should exist",
+            results,
+            Matchers.not(Matchers.<Violation>empty())
+        );
+    }
+}

qulice-checkstyle/src/test/java/com/qulice/checkstyle/CheckstyleValidatorPartFiveTest.java

@@ -0,0 +1,125 @@
+/*
+ * Copyright (c) 2011-2024 Qulice.com
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met: 1) Redistributions of source code must retain the above
+ * copyright notice, this list of conditions and the following
+ * disclaimer. 2) Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided
+ * with the distribution. 3) Neither the name of the Qulice.com nor
+ * the names of its contributors may be used to endorse or promote
+ * products derived from this software without specific prior written
+ * permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
+ * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+ * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.qulice.checkstyle;
+
+import com.qulice.checkstyle.test.extensions.CheckstyleValidateFileRunner;
+import com.qulice.checkstyle.test.extensions.CheckstyleValidateRunner;
+import com.qulice.checkstyle.test.extensions.ViolationMatcher;
+import org.hamcrest.MatcherAssert;
+import org.hamcrest.Matchers;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Test case to check the following files.
+ * <br/>ValidLambdaAndGenericsAtEndOfLine.java
+ * <br/>InvalidDiamondsUsage.java
+ * <br/>ValidDiamondsUsage.java
+ * <br/>DiamondUsageNotNeeded.java
+ * <br/>ValidLiteralComparisonCheck.java
+ *
+ * @since 0.3
+ */
+final class CheckstyleValidatorPartFiveTest {
+
+    /**
+     * Test runner.
+     */
+    private CheckstyleValidateRunner runner;
+
+    @BeforeEach
+    void setRule() {
+        this.runner = new CheckstyleValidateFileRunner();
+    }
+
+    /**
+     * CheckstyleValidator can allow final static fields and overrides
+     * to have uppercase abbreviations.
+     *
+     * @throws Exception In case of error
+     */
+    @Disabled
+    @Test
+    void checkLambdaAndGenericsAtEndOfLine() throws Exception {
+        this.runner.runValidation("ValidLambdaAndGenericsAtEndOfLine.java", true);
+    }
+
+    /**
+     * CheckstyleValidator can reject non diamond operator usage.
+     * @throws Exception If error
+     */
+    @Test
+    void rejectsNonDiamondOperatorUsage() throws Exception {
+        final String file = "InvalidDiamondsUsage.java";
+        final String name = "DiamondOperatorCheck";
+        final String message = "Use diamond operator";
+        MatcherAssert.assertThat(
+            "Two diamond violations should be found",
+            this.runner.runValidation(file, false),
+            Matchers.hasItems(
+                new ViolationMatcher(message, file, "19", name),
+                new ViolationMatcher(message, file, "29", name)
+            )
+        );
+    }
+
+    /**
+     * CheckstyleValidator can allow diamond operator usage.
+     * @throws Exception If error
+     */
+    @Test
+    void allowsDiamondOperatorUsage() throws Exception {
+        this.runner.runValidation("ValidDiamondsUsage.java", true);
+    }
+
+    /**
+     * CheckstyleValidator allows class name instead of diamond in case
+     * of return statement.
+     * @throws Exception If error
+     */
+    @Test
+    void allowsFullGenericOperatorUsage() throws Exception {
+        this.runner.runValidation("DiamondUsageNotNeeded.java", true);
+    }
+
+    /**
+     * CheckstyleValidator can allow usage of string literals on either sides.
+     * E.g. both {@code txt.equals("contents")}
+     * and {@code "contents".equals(txt)} are valid.
+     * @throws Exception If error
+     */
+    @Test
+    void allowsStringLiteralsOnBothSideInComparisons()
+        throws Exception {
+        this.runner.runValidation("ValidLiteralComparisonCheck.java", true);
+    }
+}