aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-scanner-engine/src/main/java/org/sonar/scm/git/JGitUtils.java
blob: bc38a55e61928886e62391fb12b586b1a9ed8acd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/*
 * SonarQube
 * Copyright (C) 2009-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 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.scm.git;

import java.io.IOException;
import java.nio.file.Path;
import java.util.List;
import org.eclipse.jgit.api.Git;
import org.eclipse.jgit.api.errors.GitAPIException;
import org.eclipse.jgit.lib.ObjectReader;
import org.eclipse.jgit.lib.Repository;

public class JGitUtils {

  private JGitUtils() {
  }

  public static Repository buildRepository(Path basedir) {
    try {
      Repository repo = GitScmProvider.getVerifiedRepositoryBuilder(basedir).build();
      try (ObjectReader objReader = repo.getObjectDatabase().newReader()) {
        // SONARSCGIT-2 Force initialization of shallow commits to avoid later concurrent modification issue
        objReader.getShallowCommits();
        return repo;
      }
    } catch (IOException e) {
      throw new IllegalStateException("Unable to open Git repository", e);
    }
  }

  // Return a list of scm ignored paths relative to the baseDir.
  public static List<String> getAllIgnoredPaths(Path baseDir) {
    try (Repository repo = buildRepository(baseDir)) {
      Path workTreePath = repo.getWorkTree().toPath();
      Path baseDirAbs = baseDir.toAbsolutePath().normalize();

      try (Git git = new Git(repo)) {
        return git.status().call().getIgnoredNotInIndex().stream()
          // Convert to absolute path
          .map(filePathStr -> workTreePath.resolve(filePathStr).normalize())
          // Exclude any outside of the baseDir
          .filter(filePath -> filePath.startsWith(baseDirAbs))
          // Make path relative to the baseDir
          .map(baseDir::relativize)
          .map(Path::toString)
          .sorted()
          .toList();
      } catch (GitAPIException e) {
        throw new RuntimeException(e);
      }
    }
  }
}