org.sonar.python.checks.FunctionComplexityCheck Maven / Gradle / Ivy
/*
* SonarQube Python Plugin
* Copyright (C) 2011-2024 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
*
* 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 Sonar Source-Available License for more details.
*
* You should have received a copy of the Sonar Source-Available License
* along with this program; if not, see https://sonarsource.com/license/ssal/
*/
package org.sonar.python.checks;
import org.sonar.check.Rule;
import org.sonar.check.RuleProperty;
import org.sonar.plugins.python.api.PythonSubscriptionCheck;
import org.sonar.plugins.python.api.tree.FunctionDef;
import org.sonar.plugins.python.api.tree.Tree;
import org.sonar.python.metrics.ComplexityVisitor;
@Rule(key = "FunctionComplexity")
public class FunctionComplexityCheck extends PythonSubscriptionCheck {
private static final int DEFAULT_MAXIMUM_FUNCTION_COMPLEXITY_THRESHOLD = 15;
private static final String MESSAGE = "Function has a complexity of %s which is greater than %s authorized.";
@RuleProperty(
key = "maximumFunctionComplexityThreshold",
description = "The maximum authorized complexity in function",
defaultValue = "" + DEFAULT_MAXIMUM_FUNCTION_COMPLEXITY_THRESHOLD)
int maximumFunctionComplexityThreshold = DEFAULT_MAXIMUM_FUNCTION_COMPLEXITY_THRESHOLD;
@Override
public void initialize(Context context) {
context.registerSyntaxNodeConsumer(Tree.Kind.FUNCDEF, ctx -> {
FunctionDef funcDef = (FunctionDef) ctx.syntaxNode();
int complexity = ComplexityVisitor.complexity(funcDef);
if (complexity > maximumFunctionComplexityThreshold) {
String message = String.format(MESSAGE, complexity, maximumFunctionComplexityThreshold);
ctx.addIssue(funcDef.name(), message)
.withCost(complexity - maximumFunctionComplexityThreshold);
}
});
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy