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

import java.io.File;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import org.junit.jupiter.api.Test;

import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
import com.puppycrawl.tools.checkstyle.checks.coding.StringLiteralEqualityCheck;

public class XpathRegressionStringLiteralEqualityTest extends AbstractXpathTestSupport {

    private final String checkName = StringLiteralEqualityCheck.class.getSimpleName();

    @Override
    protected String getCheckName() {
        return checkName;
    }

    @Test
    public void testOne() throws Exception {
        final File fileToProcess =
                new File(getPath("SuppressionXpathRegressionStringLiteralEquality.java"));
        final DefaultConfiguration moduleConfig =
                createModuleConfig(StringLiteralEqualityCheck.class);
        final String[] expectedViolation = {
            "6:17: " + getCheckMessage(StringLiteralEqualityCheck.class,
                    StringLiteralEqualityCheck.MSG_KEY, "=="),
        };
        final List<String> expectedXpathQueries = Arrays.asList(
            "/COMPILATION_UNIT"
                + "/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionStringLiteralEquality']]"
                + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='myFunction']]"
                + "/SLIST/LITERAL_IF/EXPR",
            "/COMPILATION_UNIT"
                + "/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionStringLiteralEquality']]"
                + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='myFunction']]"
                + "/SLIST/LITERAL_IF/EXPR/EQUAL[./IDENT[@text='foo']]"

        );

        runVerifications(moduleConfig, fileToProcess, expectedViolation,
                expectedXpathQueries);
    }

    @Test
    public void testTwo() throws Exception {
        final File fileToProcess =
                new File(getPath("SuppressionXpathRegressionStringLiteralEquality1.java"));
        final DefaultConfiguration moduleConfig =
                createModuleConfig(StringLiteralEqualityCheck.class);
        final String[] expectedViolation = {
            "6:20: " + getCheckMessage(StringLiteralEqualityCheck.class,
                    StringLiteralEqualityCheck.MSG_KEY, "!="),
        };
        final List<String> expectedXpathQueries = Arrays.asList(
            "/COMPILATION_UNIT"
                + "/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionStringLiteralEquality1']]"
                + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='myFunction']]"
                + "/SLIST/LITERAL_WHILE/EXPR",
            "/COMPILATION_UNIT"
                + "/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionStringLiteralEquality1']]"
                + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='myFunction']]"
                + "/SLIST/LITERAL_WHILE/EXPR/NOT_EQUAL[./IDENT[@text='foo']]"

        );

        runVerifications(moduleConfig, fileToProcess, expectedViolation,
                expectedXpathQueries);
    }

    @Test
    public void testThree() throws Exception {
        final File fileToProcess =
                new File(getPath("SuppressionXpathRegressionStringLiteralEquality2.java"));
        final DefaultConfiguration moduleConfig =
                createModuleConfig(StringLiteralEqualityCheck.class);
        final String[] expectedViolation = {
            "6:29: " + getCheckMessage(StringLiteralEqualityCheck.class,
                    StringLiteralEqualityCheck.MSG_KEY, "=="),
        };
        final List<String> expectedXpathQueries = Collections.singletonList(
            "/COMPILATION_UNIT"
                + "/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionStringLiteralEquality2']]"
                + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='myFunction']]"
                + "/SLIST/VARIABLE_DEF[./IDENT[@text='flag']]"
                + "/ASSIGN/EXPR/EQUAL[./IDENT[@text='foo']]"

        );

        runVerifications(moduleConfig, fileToProcess, expectedViolation,
                expectedXpathQueries);
    }
}
