org.sonar.go.plugin.PullRequestAwareVisitor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-go-plugin Show documentation

SonarQube analyzer for Go language

There is a newer version: 1.24.0.3049

/*
 * SonarSource Go
 * Copyright (C) 2018-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.go.plugin;

import org.sonar.api.batch.fs.InputFile;
import org.sonar.go.visitors.TreeVisitor;

/**
 * A type of Visitor that can leverage previous results rather than recompute findings from scratch.
 */
public abstract class PullRequestAwareVisitor extends TreeVisitor {
  /**
   * Tries to copy the cached results from a previous analysis into the cache for the next one.
   *
   * @param inputFileContext The input file and its context
   * @return true if successful, false otherwise.
   */
  public abstract boolean reusePreviousResults(InputFileContext inputFileContext);

  /**
   * The simplest logic to test that the cache can be used for a given file, without checking that the cache contains
   * any relevant data.
   * Should be called by callers of {@link #reusePreviousResults(InputFileContext)} or any overriding implementation.
   */
  public boolean canReusePreviousResults(InputFileContext inputFileContext) {
    return inputFileContext.sensorContext.canSkipUnchangedFiles() &&
      inputFileContext.sensorContext.isCacheEnabled() &&
      inputFileContext.inputFile.status() == InputFile.Status.SAME;
  }
}