org.sonar.plugins.scm.git.JGitBlameCommand.java Source code

Introduction

Here is the source code for org.sonar.plugins.scm.git.JGitBlameCommand.java

Source

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube 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.
 *
 * SonarQube 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.plugins.scm.git;

import org.eclipse.jgit.api.Git;
import org.eclipse.jgit.api.errors.GitAPIException;
import org.eclipse.jgit.diff.RawTextComparator;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.lib.RepositoryBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.batch.fs.InputFile;
import org.sonar.api.batch.scm.BlameCommand;
import org.sonar.api.batch.scm.BlameLine;
import org.sonar.api.scan.filesystem.PathResolver;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;

public class JGitBlameCommand extends BlameCommand {

    private static final Logger LOG = LoggerFactory.getLogger(JGitBlameCommand.class);

    private final PathResolver pathResolver;

    public JGitBlameCommand(PathResolver pathResolver) {
        this.pathResolver = pathResolver;
    }

    @Override
    public void blame(BlameInput input, BlameOutput output) {
        File basedir = input.fileSystem().baseDir();
        Repository repo = buildRepository(basedir);
        try {
            Git git = Git.wrap(repo);
            File gitBaseDir = repo.getWorkTree();
            ExecutorService executorService = Executors
                    .newFixedThreadPool(Runtime.getRuntime().availableProcessors() + 1);
            List<Future<Void>> tasks = submitTasks(input, output, git, gitBaseDir, executorService);
            waitForTaskToComplete(tasks);
        } finally {
            repo.close();
        }
    }

    private void waitForTaskToComplete(List<Future<Void>> tasks) {
        for (Future<Void> task : tasks) {
            try {
                task.get();
            } catch (ExecutionException e) {
                // Unwrap ExecutionException
                throw e.getCause() instanceof RuntimeException ? (RuntimeException) e.getCause()
                        : new IllegalStateException(e.getCause());
            } catch (InterruptedException e) {
                throw new IllegalStateException(e);
            }
        }
    }

    private List<Future<Void>> submitTasks(BlameInput input, BlameOutput output, Git git, File gitBaseDir,
            ExecutorService executorService) {
        List<Future<Void>> tasks = new ArrayList<Future<Void>>();
        for (InputFile inputFile : input.filesToBlame()) {
            tasks.add(submitTask(output, git, gitBaseDir, inputFile, executorService));
        }
        return tasks;
    }

    private Repository buildRepository(File basedir) {
        try {
            return new RepositoryBuilder().findGitDir(basedir).setMustExist(true).build();
        } catch (IOException e) {
            throw new IllegalStateException("Unable to open Git repository", e);
        }
    }

    private Future<Void> submitTask(final BlameOutput output, final Git git, final File gitBaseDir,
            final InputFile inputFile, ExecutorService executorService) {
        return executorService.submit(new Callable<Void>() {
            @Override
            public Void call() throws GitAPIException {
                blame(output, git, gitBaseDir, inputFile);
                return null;
            }
        });
    }

    private void blame(BlameOutput output, Git git, File gitBaseDir, InputFile inputFile) throws GitAPIException {
        String filename = pathResolver.relativePath(gitBaseDir, inputFile.file());
        org.eclipse.jgit.blame.BlameResult blameResult = git.blame()
                // Equivalent to -w command line option
                .setTextComparator(RawTextComparator.WS_IGNORE_ALL).setFilePath(filename).call();
        List<BlameLine> lines = new ArrayList<BlameLine>();
        for (int i = 0; i < blameResult.getResultContents().size(); i++) {
            if (blameResult.getSourceAuthor(i) == null || blameResult.getSourceCommit(i) == null) {
                LOG.info("Author: " + blameResult.getSourceAuthor(i));
                LOG.info("Source commit: " + blameResult.getSourceCommit(i));
                throw new IllegalStateException("Unable to blame file " + inputFile.relativePath()
                        + ". No blame info at line " + (i + 1) + ". Is file commited?");
            }
            lines.add(new org.sonar.api.batch.scm.BlameLine().date(blameResult.getSourceAuthor(i).getWhen())
                    .revision(blameResult.getSourceCommit(i).getName())
                    .author(blameResult.getSourceAuthor(i).getEmailAddress()));
        }
        if (lines.size() == inputFile.lines() - 1) {
            // SONARPLUGINS-3097 Git do not report blame on last empty line
            lines.add(lines.get(lines.size() - 1));
        }
        output.blameResult(inputFile, lines);
    }

}