org.sonar.plugins.common.git.GitTrackedFilePredicate Maven / Gradle / Ivy

Go to download
/*
 * SonarQube Text Plugin
 * Copyright (C) 2021-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.plugins.common.git;

import java.nio.file.Path;
import java.util.Set;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.batch.fs.FilePredicate;
import org.sonar.api.batch.fs.InputFile;
import org.sonar.plugins.common.TextAndSecretsSensor;

public class GitTrackedFilePredicate implements FilePredicate {
  private static final Logger LOG = LoggerFactory.getLogger(GitTrackedFilePredicate.class);
  private final Set untrackedFileNames;
  private final boolean isGitStatusSuccessful;
  private final Path projectRootPath;

  public GitTrackedFilePredicate(Path baseDir, GitService gitService) {
    var gitResult = gitService.retrieveUntrackedFileNames(baseDir);
    this.untrackedFileNames = gitResult.untrackedFileNames();
    this.isGitStatusSuccessful = gitResult.isGitStatusSuccessful();
    this.projectRootPath = baseDir;
    if (!isGitStatusSuccessful) {
      LOG.debug("Unable to retrieve git status");
    }
  }

  @Override
  public boolean apply(InputFile inputFile) {
    if (isGitStatusSuccessful) {
      var filePath = Path.of(inputFile.uri()).toAbsolutePath();
      String relativePath;
      try {
        relativePath = projectRootPath.relativize(filePath).toString();
      } catch (IllegalArgumentException e) {
        LOG.debug("Unable to resolve git status for {}, falling back to analyzing the file if it's associated with a language", inputFile, e);
        return TextAndSecretsSensor.LANGUAGE_FILE_PREDICATE.apply(inputFile);
      }
      return !untrackedFileNames.contains(relativePath);
    } else {
      return true;
    }
  }

  public boolean isGitStatusSuccessful() {
    return isGitStatusSuccessful;
  }
}