org.sonar.plsqlopen.checks.RedundantExpectationCheck.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zpa-checks Show documentation
Z PL/SQL Analyzer :: Checks
The newest version!
/**
 * Z PL/SQL Analyzer
 * Copyright (C) 2015-2024 Felipe Zorzo
 * mailto:felipe AT felipezorzo DOT com DOT br
 *
 * This program 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 3 of the License, or (at your option) any later version.
 *
 * This program 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 program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.plsqlopen.checks

import com.felipebz.flr.api.AstNode
import org.sonar.plugins.plsqlopen.api.PlSqlGrammar
import org.sonar.plugins.plsqlopen.api.annotations.*
import org.sonar.plugins.plsqlopen.api.matchers.MethodMatcher

@Rule(priority = Priority.MAJOR, tags = [Tags.UTPLSQL, Tags.BUG])
@ConstantRemediation("5min")
@RuleInfo(scope = RuleInfo.Scope.TEST)
@ActivatedByDefault
class RedundantExpectationCheck : AbstractBaseCheck() {

    override fun init() {
        subscribeTo(PlSqlGrammar.METHOD_CALL)
    }

    override fun visitNode(node: AstNode) {
        if (expectMatcher.matches(node)) {
            val expectationNode = node.nextSibling.nextSibling

            val actualValue = expectMatcher.getArgumentsValues(node)[0]

            val matcherArguments = expectMatcher.getArgumentsValues(expectationNode)
            if (matcherArguments.isEmpty()) {
                return
            }

            val expectedValue = matcherArguments[0]
            if (CheckUtils.equalNodes(actualValue, expectedValue)) {
                addIssue(actualValue, getLocalizedMessage()).secondary(expectedValue, "Expected value")
            }
        }
    }

    companion object {
        private val expectMatcher = MethodMatcher.create()
            .packageName("UT")
            .name("EXPECT")
            .withNoParameterConstraint()
    }

}