RequireThisCheckTest.java

///////////////////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
// Copyright (C) 2001-2022 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.coding;

import static com.google.common.truth.Truth.assertWithMessage;
import static com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.MSG_METHOD;
import static com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.MSG_VARIABLE;

import java.io.File;
import java.lang.reflect.Constructor;
import java.util.Collection;
import java.util.Optional;
import java.util.SortedSet;

import org.antlr.v4.runtime.CommonToken;
import org.junit.jupiter.api.Test;

import com.puppycrawl.tools.checkstyle.AbstractModuleTestSupport;
import com.puppycrawl.tools.checkstyle.DetailAstImpl;
import com.puppycrawl.tools.checkstyle.JavaParser;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.Violation;
import com.puppycrawl.tools.checkstyle.internal.utils.TestUtil;
import com.puppycrawl.tools.checkstyle.utils.CommonUtil;

public class RequireThisCheckTest extends AbstractModuleTestSupport {

    @Override
    protected String getPackageLocation() {
        return "com/puppycrawl/tools/checkstyle/checks/coding/requirethis";
    }

    @Test
    public void testIt() throws Exception {
        final String[] expected = {
            "20:9: " + getCheckMessage(MSG_VARIABLE, "i", ""),
            "26:9: " + getCheckMessage(MSG_METHOD, "method1", ""),
            "40:9: " + getCheckMessage(MSG_VARIABLE, "i", ""),
            "58:13: " + getCheckMessage(MSG_VARIABLE, "z", ""),
            "65:9: " + getCheckMessage(MSG_VARIABLE, "z", ""),
            "122:9: " + getCheckMessage(MSG_VARIABLE, "i", ""),
            "123:9: " + getCheckMessage(MSG_VARIABLE, "i", ""),
            "124:9: " + getCheckMessage(MSG_METHOD, "instanceMethod", ""),
            "130:13: " + getCheckMessage(MSG_METHOD, "instanceMethod", "Issue2240."),
            "131:13: " + getCheckMessage(MSG_VARIABLE, "i", "Issue2240."),
            "143:9: " + getCheckMessage(MSG_METHOD, "foo", ""),
            "151:9: " + getCheckMessage(MSG_VARIABLE, "s", ""),
            "177:16: " + getCheckMessage(MSG_VARIABLE, "a", ""),
            "177:20: " + getCheckMessage(MSG_VARIABLE, "a", ""),
            "177:24: " + getCheckMessage(MSG_VARIABLE, "a", ""),
            "183:16: " + getCheckMessage(MSG_VARIABLE, "b", ""),
            "183:20: " + getCheckMessage(MSG_VARIABLE, "b", ""),
            "183:24: " + getCheckMessage(MSG_VARIABLE, "b", ""),
            "211:25: " + getCheckMessage(MSG_VARIABLE, "field", ""),
        };
        verifyWithInlineConfigParser(
                getPath("InputRequireThisEnumInnerClassesAndBugs.java"),
               expected);
    }

    @Test
    public void testMethodsOnly() throws Exception {
        final String[] expected = {
            "25:9: " + getCheckMessage(MSG_METHOD, "method1", ""),
            "124:9: " + getCheckMessage(MSG_METHOD, "instanceMethod", ""),
            "130:13: " + getCheckMessage(MSG_METHOD, "instanceMethod", "Issue22402."),
            "143:9: " + getCheckMessage(MSG_METHOD, "foo", ""),
        };
        verifyWithInlineConfigParser(
                getPath("InputRequireThisEnumInnerClassesAndBugs2.java"),
               expected);
    }

    @Test
    public void testFieldsOnly() throws Exception {
        final String[] expected = {
            "19:9: " + getCheckMessage(MSG_VARIABLE, "i", ""),
            "39:9: " + getCheckMessage(MSG_VARIABLE, "i", ""),
            "58:13: " + getCheckMessage(MSG_VARIABLE, "z", ""),
            "65:9: " + getCheckMessage(MSG_VARIABLE, "z", ""),
            "122:9: " + getCheckMessage(MSG_VARIABLE, "i", ""),
            "123:9: " + getCheckMessage(MSG_VARIABLE, "i", ""),
            "131:13: " + getCheckMessage(MSG_VARIABLE, "i", "Issue22403."),
            "152:9: " + getCheckMessage(MSG_VARIABLE, "s", ""),
            "179:16: " + getCheckMessage(MSG_VARIABLE, "a", ""),
            "179:20: " + getCheckMessage(MSG_VARIABLE, "a", ""),
            "179:24: " + getCheckMessage(MSG_VARIABLE, "a", ""),
            "185:16: " + getCheckMessage(MSG_VARIABLE, "b", ""),
            "185:20: " + getCheckMessage(MSG_VARIABLE, "b", ""),
            "185:24: " + getCheckMessage(MSG_VARIABLE, "b", ""),
        };
        verifyWithInlineConfigParser(
                getPath("InputRequireThisEnumInnerClassesAndBugs3.java"),
               expected);
    }

    @Test
    public void testFieldsInExpressions() throws Exception {
        final String[] expected = {
            "18:28: " + getCheckMessage(MSG_VARIABLE, "id", ""),
            "19:28: " + getCheckMessage(MSG_VARIABLE, "length", ""),
            "20:28: " + getCheckMessage(MSG_VARIABLE, "length", ""),
            "21:26: " + getCheckMessage(MSG_VARIABLE, "length", ""),
            "22:26: " + getCheckMessage(MSG_VARIABLE, "length", ""),
            "23:25: " + getCheckMessage(MSG_VARIABLE, "length", ""),
            "24:25: " + getCheckMessage(MSG_VARIABLE, "length", ""),
            "25:26: " + getCheckMessage(MSG_VARIABLE, "length", ""),
            "26:26: " + getCheckMessage(MSG_VARIABLE, "length", ""),
            "27:33: " + getCheckMessage(MSG_VARIABLE, "b", ""),
            "28:36: " + getCheckMessage(MSG_VARIABLE, "b", ""),
            "29:26: " + getCheckMessage(MSG_VARIABLE, "length", ""),
            "30:26: " + getCheckMessage(MSG_VARIABLE, "length", ""),
            "31:28: " + getCheckMessage(MSG_VARIABLE, "length", ""),
            "32:26: " + getCheckMessage(MSG_VARIABLE, "length", ""),
            "33:26: " + getCheckMessage(MSG_VARIABLE, "length", ""),
            "34:26: " + getCheckMessage(MSG_VARIABLE, "length", ""),
            "35:31: " + getCheckMessage(MSG_VARIABLE, "b", ""),
            "36:32: " + getCheckMessage(MSG_VARIABLE, "b", ""),
        };
        verifyWithInlineConfigParser(
                getPath("InputRequireThisExpressions.java"),
               expected);
    }

    @Test
    public void testGenerics() throws Exception {
        final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
        verifyWithInlineConfigParser(
                getPath("InputRequireThis15Extensions.java"), expected);
    }

    @Test
    public void testGithubIssue41() throws Exception {
        final String[] expected = {
            "16:19: " + getCheckMessage(MSG_VARIABLE, "number", ""),
            "17:16: " + getCheckMessage(MSG_METHOD, "other", ""),
        };
        verifyWithInlineConfigParser(
                getPath("InputRequireThisSimple.java"),
                expected);
    }

    @Test
    public void testTokensNotNull() {
        final RequireThisCheck check = new RequireThisCheck();
        assertWithMessage("Acceptable tokens should not be null")
            .that(check.getAcceptableTokens())
            .isNotNull();
        assertWithMessage("Default tokens should not be null")
            .that(check.getDefaultTokens())
            .isNotNull();
        assertWithMessage("Required tokens should not be null")
            .that(check.getRequiredTokens())
            .isNotNull();
    }

    @Test
    public void testWithAnonymousClass() throws Exception {
        final String[] expected = {
            "29:25: " + getCheckMessage(MSG_METHOD, "doSideEffect", ""),
            "33:24: " + getCheckMessage(MSG_VARIABLE, "bar", "InputRequireThisAnonymousEmpty."),
            "56:17: " + getCheckMessage(MSG_VARIABLE, "foobar", ""),
        };
        verifyWithInlineConfigParser(
                getPath("InputRequireThisAnonymousEmpty.java"),
                expected);
    }

    @Test
    public void testDefaultSwitch() {
        final RequireThisCheck check = new RequireThisCheck();

        final DetailAstImpl ast = new DetailAstImpl();
        ast.initialize(new CommonToken(TokenTypes.ENUM, "ENUM"));

        check.visitToken(ast);
        final SortedSet<Violation> violations = check.getViolations();

        assertWithMessage("No exception violations expected")
            .that(violations)
            .isEmpty();
    }

    @Test
    public void testValidateOnlyOverlappingFalse() throws Exception {
        final String[] expected = {
            "29:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "30:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal1", ""),
            "31:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal2", ""),
            "32:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal3", ""),
            "36:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal1", ""),
            "37:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal2", ""),
            "38:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal3", ""),
            "42:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal1", ""),
            "46:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal3", ""),
            "50:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal1", ""),
            "52:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "54:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal3", ""),
            "58:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal2", ""),
            "59:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal3", ""),
            "69:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal1", ""),
            "70:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal2", ""),
            "89:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "128:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "137:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "141:9: " + getCheckMessage(MSG_METHOD, "method1", ""),
            "177:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal1", ""),
            "178:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal2", ""),
            "179:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal3", ""),
            "181:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "185:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal1", ""),
            "186:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal2", ""),
            "187:9: " + getCheckMessage(MSG_VARIABLE, "fieldFinal3", ""),
            "189:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "194:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "198:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "219:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "226:29: " + getCheckMessage(MSG_VARIABLE, "booleanField", ""),
            "237:21: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "247:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "262:9: " + getCheckMessage(MSG_VARIABLE, "booleanField", ""),
            "271:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "279:18: " + getCheckMessage(MSG_METHOD, "addSuf2F", ""),
            "284:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "284:18: " + getCheckMessage(MSG_METHOD, "addSuf2F", ""),
            "310:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "349:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "383:25: " + getCheckMessage(MSG_METHOD, "getAction", ""),
            "385:20: " + getCheckMessage(MSG_METHOD, "processAction", ""),
            "393:16: " + getCheckMessage(MSG_METHOD, "processAction", ""),
            "499:22: " + getCheckMessage(MSG_VARIABLE, "add", ""),
        };
        verifyWithInlineConfigParser(
                getPath("InputRequireThisValidateOnlyOverlappingFalse.java"), expected);
    }

    @Test
    public void testValidateOnlyOverlappingTrue() throws Exception {
        final String[] expected = {
            "29:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "52:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "89:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "128:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "181:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "189:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "247:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "262:9: " + getCheckMessage(MSG_VARIABLE, "booleanField", ""),
            "271:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "284:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "310:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
            "348:9: " + getCheckMessage(MSG_VARIABLE, "field1", ""),
        };
        verifyWithInlineConfigParser(
                getPath("InputRequireThisValidateOnlyOverlappingTrue.java"), expected);
    }

    @Test
    public void testValidateOnlyOverlappingTrue2() throws Exception {
        final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
        verifyWithInlineConfigParser(
                getPath("InputRequireThisValidateOnlyOverlappingTrue2.java"), expected);
    }

    @Test
    public void testReceiverParameter() throws Exception {
        final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
        verifyWithInlineConfigParser(
                getPath("InputRequireThisReceiver.java"), expected);
    }

    @Test
    public void testBraceAlone() throws Exception {
        final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
        verifyWithInlineConfigParser(
                getPath("InputRequireThisBraceAlone.java"), expected);
    }

    @Test
    public void testStatic() throws Exception {
        final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
        verifyWithInlineConfigParser(
                getPath("InputRequireThisStatic.java"), expected);
    }

    @Test
    public void testMethodReferences() throws Exception {
        final String[] expected = {
            "24:9: " + getCheckMessage(MSG_VARIABLE, "tags", ""),
        };
        verifyWithInlineConfigParser(
                getPath("InputRequireThisMethodReferences.java"), expected);
    }

    @Test
    public void testAllowLocalVars() throws Exception {
        final String[] expected = {
            "18:9: " + getCheckMessage(MSG_VARIABLE, "s1", ""),
            "26:9: " + getCheckMessage(MSG_VARIABLE, "s1", ""),
            "39:9: " + getCheckMessage(MSG_VARIABLE, "s2", ""),
            "44:9: " + getCheckMessage(MSG_VARIABLE, "s2", ""),
            "50:9: " + getCheckMessage(MSG_VARIABLE, "s2", ""),
            "51:16: " + getCheckMessage(MSG_VARIABLE, "s1", ""),
        };
        verifyWithInlineConfigParser(
                getPath("InputRequireThisAllowLocalVars.java"), expected);
    }

    @Test
    public void testAllowLambdaParameters() throws Exception {
        final String[] expected = {
            "24:9: " + getCheckMessage(MSG_VARIABLE, "s1", ""),
            "46:21: " + getCheckMessage(MSG_VARIABLE, "z", ""),
            "71:29: " + getCheckMessage(MSG_VARIABLE, "a", ""),
            "71:34: " + getCheckMessage(MSG_VARIABLE, "b", ""),
        };
        verifyWithInlineConfigParser(
                getPath("InputRequireThisAllowLambdaParameters.java"), expected);
    }

    @Test
    public void testCatchVariables() throws Exception {
        final String[] expected = {
            "38:21: " + getCheckMessage(MSG_VARIABLE, "ex", ""),
        };
        verifyWithInlineConfigParser(
                getPath("InputRequireThisCatchVariables.java"), expected);
    }

    @Test
    public void testEnumConstant() throws Exception {
        final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
        verifyWithInlineConfigParser(
                getPath("InputRequireThisEnumConstant.java"), expected);
    }

    @Test
    public void testAnnotationInterface() throws Exception {
        final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
        verifyWithInlineConfigParser(
                getPath("InputRequireThisAnnotationInterface.java"), expected);
    }

    @Test
    public void testFor() throws Exception {
        final String[] expected = {
            "22:13: " + getCheckMessage(MSG_VARIABLE, "bottom", ""),
            "30:34: " + getCheckMessage(MSG_VARIABLE, "name", ""),
        };
        verifyWithInlineConfigParser(
                getPath("InputRequireThisFor.java"), expected);
    }

    @Test
    public void testFinalInstanceVariable() throws Exception {
        final String[] expected = {
            "18:9: " + getCheckMessage(MSG_VARIABLE, "y", ""),
            "19:9: " + getCheckMessage(MSG_VARIABLE, "z", ""),
        };
        verifyWithInlineConfigParser(
                getPath("InputRequireThisFinalInstanceVariable.java"), expected);
    }

    @Test
    public void test() throws Exception {
        final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
        verifyWithInlineConfigParser(
                getPath("InputRequireThisCaseGroup.java"), expected);
    }

    @Test
    public void testExtendedMethod() throws Exception {
        final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
        verifyWithInlineConfigParser(
                getPath("InputRequireThisExtendedMethod.java"), expected);
    }

    @Test
    public void testRecordsAndCompactCtors() throws Exception {
        final String[] expected = {
            "18:13: " + getCheckMessage(MSG_METHOD, "method1", ""),
            "19:13: " + getCheckMessage(MSG_METHOD, "method2", ""),
            "20:13: " + getCheckMessage(MSG_METHOD, "method3", ""),
            "30:13: " + getCheckMessage(MSG_METHOD, "method1", ""),
            "56:13: " + getCheckMessage(MSG_METHOD, "method1", ""),
            "57:13: " + getCheckMessage(MSG_METHOD, "method2", ""),
            "58:13: " + getCheckMessage(MSG_METHOD, "method3", ""),
            "68:13: " + getCheckMessage(MSG_METHOD, "method1", ""),
        };
        verifyWithInlineConfigParser(
                getNonCompilablePath("InputRequireThisRecordsAndCompactCtors.java"),
                expected);
    }

    @Test
    public void testRecordCompactCtors() throws Exception {
        final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
        verifyWithInlineConfigParser(
                getNonCompilablePath("InputRequireThisRecordCompactCtors.java"),
                expected);
    }

    @Test
    public void testRecordsAsTopLevel() throws Exception {
        final String[] expected = {
            "17:9: " + getCheckMessage(MSG_METHOD, "method1", ""),
            "18:9: " + getCheckMessage(MSG_METHOD, "method2", ""),
            "19:9: " + getCheckMessage(MSG_METHOD, "method3", ""),
            "26:9: " + getCheckMessage(MSG_METHOD, "method1", ""),
            "30:21: " + getCheckMessage(MSG_VARIABLE, "x", ""),
            "38:17: " + getCheckMessage(MSG_VARIABLE, "y", ""),
            "45:9: " + getCheckMessage(MSG_METHOD, "method1", ""),
        };
        verifyWithInlineConfigParser(
                getNonCompilablePath("InputRequireThisRecordAsTopLevel.java"),
                expected);
    }

    @Test
    public void testRecordsDefault() throws Exception {
        final String[] expected = {
            "26:9: " + getCheckMessage(MSG_VARIABLE, "x", ""),
        };
        verifyWithInlineConfigParser(
                getNonCompilablePath("InputRequireThisRecordDefault.java"),
                expected);
    }

    @Test
    public void testUnusedMethod() throws Exception {
        final DetailAstImpl ident = new DetailAstImpl();
        ident.setText("testName");

        final Class<?> cls = Class.forName(RequireThisCheck.class.getName() + "$CatchFrame");
        final Constructor<?> constructor = cls.getDeclaredConstructors()[0];
        constructor.setAccessible(true);
        final Object o = constructor.newInstance(null, ident);

        final DetailAstImpl actual = TestUtil.invokeMethod(o, "getFrameNameIdent");
        assertWithMessage("expected ident token")
            .that(actual)
            .isSameInstanceAs(ident);
        assertWithMessage("expected catch frame type")
            .that(TestUtil.invokeMethod(o, "getType").toString())
            .isEqualTo("CATCH_FRAME");
    }

    /**
     * We cannot reproduce situation when visitToken is called and leaveToken is not.
     * So, we have to use reflection to be sure that even in such situation
     * state of the field will be cleared.
     *
     * @throws Exception when code tested throws exception
     */
    @Test
    public void testClearState() throws Exception {
        final RequireThisCheck check = new RequireThisCheck();
        final DetailAST root = JavaParser.parseFile(
                new File(getPath("InputRequireThisSimple.java")),
                JavaParser.Options.WITHOUT_COMMENTS);
        final Optional<DetailAST> classDef = TestUtil.findTokenInAstByPredicate(root,
            ast -> ast.getType() == TokenTypes.CLASS_DEF);

        assertWithMessage("Ast should contain CLASS_DEF")
                .that(classDef.isPresent())
                .isTrue();
        assertWithMessage("State is not cleared on beginTree")
                .that(TestUtil.isStatefulFieldClearedDuringBeginTree(check, classDef.get(),
                        "current", current -> ((Collection<?>) current).isEmpty()))
                .isTrue();
    }

}