org.sonar.java.checks.spring.BeforeAndAfterTransactionContractCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-checks Show documentation
The newest version!
/*
 * SonarQube Java
 * Copyright (C) 2012-2025 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.java.checks.spring;

import java.util.List;
import org.sonar.check.Rule;
import org.sonar.java.checks.helpers.SpringUtils;
import org.sonar.java.model.declaration.MethodTreeImpl;
import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
import org.sonar.plugins.java.api.JavaFileScannerContext;
import org.sonar.plugins.java.api.semantic.Symbol;
import org.sonar.plugins.java.api.tree.Tree;
import org.sonar.plugins.java.api.tree.VariableTree;

@Rule(key = "S7190")
public class BeforeAndAfterTransactionContractCheck extends IssuableSubscriptionVisitor {

  private static final String BEFORE_TRANSACTION_FQN = "org.springframework.test.context.transaction.BeforeTransaction";
  private static final String AFTER_TRANSACTION_FQN = "org.springframework.test.context.transaction.AfterTransaction";
  private static final List TRANSACTION_ANNOTATIONS = List.of(BEFORE_TRANSACTION_FQN, AFTER_TRANSACTION_FQN);

  private static final String TEST_INFO_FQN = "org.junit.jupiter.api.TestInfo";

  private static final String RETURN_VOID_MESSAGE = "%s method should return void.";
  private static final String NO_PARAMETERS_MESSAGE = "%s method should not have parameters.";

  @Override
  public List nodesToVisit() {
    return List.of(Tree.Kind.METHOD);
  }

  @Override
  public void visitNode(Tree tree) {
    MethodTreeImpl methodTree = (MethodTreeImpl) tree;
    if (methodTree.symbol().metadata().isAnnotatedWith(BEFORE_TRANSACTION_FQN)) {
      checkReturnType(methodTree, "@BeforeTransaction");
      checkParameters(methodTree, "@BeforeTransaction");
    } else if (methodTree.symbol().metadata().isAnnotatedWith(AFTER_TRANSACTION_FQN)) {
      checkReturnType(methodTree, "@AfterTransaction");
      checkParameters(methodTree, "@AfterTransaction");
    }
  }

  private void checkReturnType(MethodTreeImpl methodTree, String annotationName) {
    if (!methodTree.returnType().symbolType().isVoid()) {
      String message = String.format(RETURN_VOID_MESSAGE, annotationName);
      reportIssue(methodTree.returnType(), message, getSecondaryLocations(methodTree), null);
    }
  }

  private void checkParameters(MethodTreeImpl methodTree, String annotationName) {
    List parameters = methodTree.parameters();
    if (!parameters.isEmpty() && parameters.stream().anyMatch(parameter -> !isParameterAllowed(parameter))) {
      String message = String.format(NO_PARAMETERS_MESSAGE, annotationName);
      var first = methodTree.parameters().get(0);
      var last = methodTree.parameters().get(methodTree.parameters().size() - 1);
      reportIssue(first, last, message, getSecondaryLocations(methodTree), null);
    }
  }

  private static boolean isParameterAllowed(VariableTree parameter) {
    Symbol parameterSymbol = parameter.symbol();
    if (parameterSymbol.type().is(TEST_INFO_FQN)) {
      return true;
    }
    return SpringUtils.isAutowired(parameterSymbol);
  }

  private static List getSecondaryLocations(MethodTreeImpl methodTree) {
    return methodTree.modifiers().annotations().stream()
      .filter(annotation -> TRANSACTION_ANNOTATIONS.contains(annotation.symbolType().fullyQualifiedName()))
      .map(annotation -> new JavaFileScannerContext.Location("Annotation", annotation))
      .toList();
  }

}