Add "local" connector type

Runs analysis tools on the HEAD of the local git repository and reports
to the log.

Allows someone to check for any comments before pushing to
Gerrit/Gitlab.

Author: Marquis Wong

build.gradle

@@ -72,6 +72,7 @@ dependencies {
     compile 'commons-cli:commons-cli:1.2'
     compile 'com.jayway.jsonpath:json-path:2.4.0'
     compile 'commons-io:commons-io:2.4'
+    compile 'org.eclipse.jgit:org.eclipse.jgit:5.5.1.201910021850-r'
 
     compile 'com.urswolfer.gerrit.client.rest:gerrit-rest-java-client:0.8.8'
 

src/main/java/pl/touk/sputnik/configuration/GeneralOption.java

@@ -19,7 +19,7 @@ public enum GeneralOption implements ConfigurationOption {
     MESSAGE_PROBLEM_FORMAT("message.problemFormat", "Sputnik problem format. {0}: reporter, {1}: message", "There is a problem with {0}: {1}"),
     MESSAGE_SCORE_PASSING_COMMENT("message.scorePassingComment", "Comment when no errors are found", "Perfect!"),
 
-    CONNECTOR_TYPE("connector.type", "Connector: <stash|gerrit|github|saas>", ConnectorType.GERRIT.getName()),
+    CONNECTOR_TYPE("connector.type", "Connector: <stash|gerrit|github|saas|local>", ConnectorType.GERRIT.getName()),
     HOST("connector.host", "Connector server host", "localhost"),
     PORT("connector.port", "Connector server port", "80"),
     PATH("connector.path", "Connector server path", ""),

src/main/java/pl/touk/sputnik/connector/ConnectorFacadeFactory.java

@@ -5,6 +5,7 @@
 import pl.touk.sputnik.configuration.GeneralOptionNotSupportedException;
 import pl.touk.sputnik.connector.gerrit.GerritFacadeBuilder;
 import pl.touk.sputnik.connector.github.GithubFacadeBuilder;
+import pl.touk.sputnik.connector.local.LocalFacadeBuilder;
 import pl.touk.sputnik.connector.saas.SaasFacadeBuilder;
 import pl.touk.sputnik.connector.stash.StashFacadeBuilder;
 
@@ -15,6 +16,7 @@ public class ConnectorFacadeFactory {
     StashFacadeBuilder stashFacadeBuilder = new StashFacadeBuilder();
     GithubFacadeBuilder githubFacadeBuilder = new GithubFacadeBuilder();
     SaasFacadeBuilder saasFacadeBuilder = new SaasFacadeBuilder();
+    LocalFacadeBuilder localFacadeBuilder = new LocalFacadeBuilder();
 
     @NotNull
     public ConnectorFacade build(@NotNull ConnectorType type, Configuration configuration) {
@@ -27,6 +29,9 @@ public ConnectorFacade build(@NotNull ConnectorType type, Configuration configur
                 return githubFacadeBuilder.build(configuration);
             case SAAS:
                 return saasFacadeBuilder.build(configuration);
+            case LOCAL:
+                return localFacadeBuilder.build();
+
             default:
                 throw new GeneralOptionNotSupportedException("Connector " + type.getName() + " is not supported");
         }

src/main/java/pl/touk/sputnik/connector/ConnectorType.java

@@ -13,7 +13,8 @@ public enum ConnectorType {
     GERRIT("gerrit"),
     STASH("stash"),
     GITHUB("github"),
-    SAAS("saas");
+    SAAS("saas"),
+    LOCAL("local");
 
     /** Name used in configuration file. */
     @Getter

src/main/java/pl/touk/sputnik/connector/Connectors.java

@@ -1,5 +1,5 @@
 package pl.touk.sputnik.connector;
 
 public enum Connectors {
-    STASH, GERRIT, GITHUB, SAAS
+    STASH, GERRIT, GITHUB, SAAS, LOCAL
 }

src/main/java/pl/touk/sputnik/connector/gerrit/GerritFacade.java

@@ -85,4 +85,5 @@ public void validate(Configuration configuration) throws GeneralOptionNotSupport
     public void setReview(@NotNull Review review) {
         publish(review);
     }
+
 }

src/main/java/pl/touk/sputnik/connector/local/LocalFacade.java

@@ -0,0 +1,89 @@
+package pl.touk.sputnik.connector.local;
+
+import lombok.extern.slf4j.Slf4j;
+import org.eclipse.jgit.api.Git;
+import org.eclipse.jgit.api.errors.GitAPIException;
+import org.eclipse.jgit.diff.DiffEntry;
+import org.eclipse.jgit.diff.DiffEntry.ChangeType;
+import org.jetbrains.annotations.NotNull;
+import pl.touk.sputnik.configuration.Configuration;
+import pl.touk.sputnik.configuration.GeneralOption;
+import pl.touk.sputnik.configuration.GeneralOptionNotSupportedException;
+import pl.touk.sputnik.connector.ConnectorFacade;
+import pl.touk.sputnik.connector.ConnectorValidator;
+import pl.touk.sputnik.connector.Connectors;
+import pl.touk.sputnik.connector.ReviewPublisher;
+import pl.touk.sputnik.review.Comment;
+import pl.touk.sputnik.review.Review;
+import pl.touk.sputnik.review.ReviewFile;
+
+import java.util.List;
+
+import static java.util.stream.Collectors.toList;
+
+@Slf4j
+public class LocalFacade implements ConnectorFacade, ConnectorValidator, ReviewPublisher {
+    private final Git git;
+
+    public LocalFacade(Git git) {
+        this.git = git;
+    }
+
+    @NotNull
+    @Override
+    public List<ReviewFile> listFiles() {
+        try {
+            List<DiffEntry> diffs = git.diff().call();
+            return diffs.stream()
+                    .filter(this::isNotDeleted)
+                    .map(DiffEntry::getNewPath)
+                    .map(ReviewFile::new)
+                    .collect(toList());
+        } catch (GitAPIException e) {
+            throw new RuntimeException("Error when listing files", e);
+        }
+    }
+
+    private boolean isNotDeleted(DiffEntry aDiffEntry) {
+        return aDiffEntry.getChangeType() != ChangeType.DELETE;
+    }
+
+    @Override
+    public void publish(@NotNull Review review) {
+        for (ReviewFile file : review.getFiles()) {
+            if (file.getComments().isEmpty()) {
+                continue;
+            }
+
+            log.warn("{} comments on {}", file.getComments().size(), file.getReviewFilename());
+            for (Comment comment : file.getComments()) {
+                log.warn("Line {}: {}", comment.getLine(), comment.getMessage());
+            }
+            log.warn("");
+        }
+        for (String message : review.getMessages()) {
+            log.warn(message);
+        }
+    }
+
+    @Override
+    public Connectors name() {
+        return Connectors.LOCAL;
+    }
+
+    @Override
+    public void validate(Configuration configuration) throws GeneralOptionNotSupportedException {
+        boolean commentOnlyChangedLines = Boolean.parseBoolean(configuration
+                .getProperty(GeneralOption.COMMENT_ONLY_CHANGED_LINES));
+
+        if (commentOnlyChangedLines) {
+            throw new GeneralOptionNotSupportedException("This connector does not support "
+                    + GeneralOption.COMMENT_ONLY_CHANGED_LINES.getKey());
+        }
+    }
+
+    @Override
+    public void setReview(@NotNull Review review) {
+        publish(review);
+    }
+}

src/main/java/pl/touk/sputnik/connector/local/LocalFacadeBuilder.java

@@ -0,0 +1,19 @@
+package pl.touk.sputnik.connector.local;
+
+import org.eclipse.jgit.api.Git;
+import org.eclipse.jgit.lib.Repository;
+import org.eclipse.jgit.storage.file.FileRepositoryBuilder;
+
+import java.io.IOException;
+
+public class LocalFacadeBuilder {
+    public LocalFacade build() {
+        try (Repository repository = new FileRepositoryBuilder().readEnvironment().findGitDir().build()) {
+            try (Git git = new Git(repository)) {
+                return new LocalFacade(git);
+            }
+        } catch (IOException e) {
+            throw new RuntimeException("Error getting git repository", e);
+        }
+    }
+}

src/main/java/pl/touk/sputnik/review/ReviewFile.java

@@ -39,5 +39,4 @@ public String getSourceDir() {
     private String createJavaClassName() {
         return StringUtils.substringBeforeLast(ENTRY_PATTERN.matcher(reviewFilename).replaceFirst(""), DOT).replace('/', '.');
     }
-
 }

src/test/java/pl/touk/sputnik/connector/local/LocalFacadeTest.java

@@ -0,0 +1,57 @@
+package pl.touk.sputnik.connector.local;
+
+import com.google.common.collect.ImmutableList;
+import org.eclipse.jgit.api.Git;
+import org.eclipse.jgit.api.errors.GitAPIException;
+import org.eclipse.jgit.diff.DiffEntry;
+import org.eclipse.jgit.diff.DiffEntry.ChangeType;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import pl.touk.sputnik.review.ReviewFile;
+
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Answers.RETURNS_DEEP_STUBS;
+import static org.mockito.Mockito.when;
+
+@ExtendWith(MockitoExtension.class)
+class LocalFacadeTest {
+    private LocalFacade localFacade;
+    @Mock(answer = RETURNS_DEEP_STUBS)
+    private Git git;
+    @Mock
+    private DiffEntry modifiedFile, deletedFile, newFile;
+
+    @BeforeEach
+    void setUp() throws GitAPIException {
+        localFacade = new LocalFacade(git);
+
+        when(modifiedFile.getNewPath()).thenReturn("/path/to/modifiedFile");
+        when(modifiedFile.getChangeType()).thenReturn(ChangeType.MODIFY);
+
+        when(newFile.getNewPath()).thenReturn("/path/to/newFile");
+        when(newFile.getChangeType()).thenReturn(ChangeType.ADD);
+
+        when(deletedFile.getChangeType()).thenReturn(ChangeType.DELETE);
+
+        when(git.diff().call()).thenReturn(ImmutableList.of(modifiedFile, deletedFile, newFile));
+    }
+
+    @Test
+    void shouldParseListFilesResponse() {
+        List<ReviewFile> reviewFiles = localFacade.listFiles();
+        assertThat(reviewFiles).isNotEmpty();
+    }
+
+    @Test
+    void shouldNotListDeletedFiles() {
+        List<ReviewFile> reviewFiles = localFacade.listFiles();
+        assertThat(reviewFiles)
+                .hasSize(2)
+                .extracting(ReviewFile::getReviewFilename).containsExactly(modifiedFile.getNewPath(), newFile.getNewPath());
+    }
+}