Skip to content

Commit e1344e1

Browse files
Marquis WongMarquis Wong
Marquis Wong
authored and
Marquis Wong
committed
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.
1 parent f4d3393 commit e1344e1

File tree

10 files changed

+276
-4
lines changed

10 files changed

+276
-4
lines changed

‎build.gradle‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ dependencies {
7272
compile 'commons-cli:commons-cli:1.2'
7373
compile 'com.jayway.jsonpath:json-path:2.4.0'
7474
compile 'commons-io:commons-io:2.4'
75+
compile 'org.eclipse.jgit:org.eclipse.jgit:5.5.1.201910021850-r'
7576

7677
compile 'com.urswolfer.gerrit.client.rest:gerrit-rest-java-client:0.8.8'
7778

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public enum GeneralOption implements ConfigurationOption {
1919
MESSAGE_PROBLEM_FORMAT("message.problemFormat", "Sputnik problem format. {0}: reporter, {1}: message", "There is a problem with {0}: {1}"),
2020
MESSAGE_SCORE_PASSING_COMMENT("message.scorePassingComment", "Comment when no errors are found", "Perfect!"),
2121

22-
CONNECTOR_TYPE("connector.type", "Connector: <stash|gerrit|github|saas>", ConnectorType.GERRIT.getName()),
22+
CONNECTOR_TYPE("connector.type", "Connector: <stash|gerrit|github|saas|local>", ConnectorType.GERRIT.getName()),
2323
HOST("connector.host", "Connector server host", "localhost"),
2424
PORT("connector.port", "Connector server port", "80"),
2525
PATH("connector.path", "Connector server path", ""),

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import pl.touk.sputnik.configuration.GeneralOptionNotSupportedException;
66
import pl.touk.sputnik.connector.gerrit.GerritFacadeBuilder;
77
import pl.touk.sputnik.connector.github.GithubFacadeBuilder;
8+
import pl.touk.sputnik.connector.local.LocalFacadeBuilder;
89
import pl.touk.sputnik.connector.saas.SaasFacadeBuilder;
910
import pl.touk.sputnik.connector.stash.StashFacadeBuilder;
1011

@@ -15,6 +16,7 @@ public class ConnectorFacadeFactory {
1516
StashFacadeBuilder stashFacadeBuilder = new StashFacadeBuilder();
1617
GithubFacadeBuilder githubFacadeBuilder = new GithubFacadeBuilder();
1718
SaasFacadeBuilder saasFacadeBuilder = new SaasFacadeBuilder();
19+
LocalFacadeBuilder localFacadeBuilder = new LocalFacadeBuilder();
1820

1921
@NotNull
2022
public ConnectorFacade build(@NotNull ConnectorType type, Configuration configuration) {
@@ -27,6 +29,8 @@ public ConnectorFacade build(@NotNull ConnectorType type, Configuration configur
2729
return githubFacadeBuilder.build(configuration);
2830
case SAAS:
2931
return saasFacadeBuilder.build(configuration);
32+
case LOCAL:
33+
return localFacadeBuilder.build();
3034
default:
3135
throw new GeneralOptionNotSupportedException("Connector " + type.getName() + " is not supported");
3236
}

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ public enum ConnectorType {
1313
GERRIT("gerrit"),
1414
STASH("stash"),
1515
GITHUB("github"),
16-
SAAS("saas");
16+
SAAS("saas"),
17+
LOCAL("local");
1718

1819
/** Name used in configuration file. */
1920
@Getter

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
package pl.touk.sputnik.connector;
22

33
public enum Connectors {
4-
STASH, GERRIT, GITHUB, SAAS
4+
STASH, GERRIT, GITHUB, SAAS, LOCAL
55
}

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

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
package pl.touk.sputnik.connector.local;
2+
3+
import lombok.AllArgsConstructor;
4+
import lombok.extern.slf4j.Slf4j;
5+
import org.eclipse.jgit.diff.DiffEntry;
6+
import org.eclipse.jgit.diff.DiffEntry.ChangeType;
7+
import org.eclipse.jgit.diff.DiffFormatter;
8+
import org.eclipse.jgit.lib.Constants;
9+
import org.eclipse.jgit.lib.ObjectId;
10+
import org.eclipse.jgit.lib.Repository;
11+
import org.jetbrains.annotations.NotNull;
12+
import pl.touk.sputnik.configuration.Configuration;
13+
import pl.touk.sputnik.configuration.GeneralOption;
14+
import pl.touk.sputnik.configuration.GeneralOptionNotSupportedException;
15+
import pl.touk.sputnik.connector.ConnectorFacade;
16+
import pl.touk.sputnik.connector.ConnectorValidator;
17+
import pl.touk.sputnik.connector.Connectors;
18+
import pl.touk.sputnik.connector.ReviewPublisher;
19+
import pl.touk.sputnik.review.Comment;
20+
import pl.touk.sputnik.review.Review;
21+
import pl.touk.sputnik.review.ReviewFile;
22+
23+
import java.io.IOException;
24+
import java.util.List;
25+
26+
import static java.util.stream.Collectors.toList;
27+
28+
@AllArgsConstructor
29+
@Slf4j
30+
public class LocalFacade implements ConnectorFacade, ConnectorValidator, ReviewPublisher {
31+
private final Repository repository;
32+
private final DiffFormatter diffFormatter;
33+
private final LocalFacadeOutput output;
34+
35+
@NotNull
36+
@Override
37+
public List<ReviewFile> listFiles() {
38+
try {
39+
ObjectId head = repository.resolve(Constants.HEAD);
40+
ObjectId headParent = repository.resolve(Constants.HEAD + "^");
41+
List<DiffEntry> diffs = diffFormatter.scan(headParent, head);
42+
return diffs.stream()
43+
.filter(this::isNotDeleted)
44+
.map(DiffEntry::getNewPath)
45+
.map(ReviewFile::new)
46+
.collect(toList());
47+
} catch (IOException e) {
48+
throw new RuntimeException("Error when listing files", e);
49+
}
50+
}
51+
52+
private boolean isNotDeleted(DiffEntry aDiffEntry) {
53+
return aDiffEntry.getChangeType() != ChangeType.DELETE;
54+
}
55+
56+
@Override
57+
public void publish(@NotNull Review review) {
58+
long numFilesWithComments = review.getFiles().stream().filter(files -> !files.getComments().isEmpty()).count();
59+
if (numFilesWithComments == 0) {
60+
output.info("No sputnik comments");
61+
return;
62+
}
63+
64+
for (String message : review.getMessages()) {
65+
output.warn(message);
66+
}
67+
68+
for (ReviewFile file : review.getFiles()) {
69+
if (file.getComments().isEmpty()) {
70+
continue;
71+
}
72+
73+
output.warn("");
74+
75+
output.warn("{} comment(s) on {}", file.getComments().size(), file.getReviewFilename());
76+
for (Comment comment : file.getComments()) {
77+
output.warn("Line {}: {}", comment.getLine(), comment.getMessage());
78+
}
79+
}
80+
}
81+
82+
@Override
83+
public Connectors name() {
84+
return Connectors.LOCAL;
85+
}
86+
87+
@Override
88+
public void validate(Configuration configuration) throws GeneralOptionNotSupportedException {
89+
boolean commentOnlyChangedLines = Boolean.parseBoolean(configuration
90+
.getProperty(GeneralOption.COMMENT_ONLY_CHANGED_LINES));
91+
92+
if (commentOnlyChangedLines) {
93+
throw new GeneralOptionNotSupportedException("This connector does not support "
94+
+ GeneralOption.COMMENT_ONLY_CHANGED_LINES.getKey());
95+
}
96+
}
97+
98+
@Override
99+
public void setReview(@NotNull Review review) {
100+
publish(review);
101+
}
102+
}

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

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
package pl.touk.sputnik.connector.local;
2+
3+
import org.eclipse.jgit.diff.DiffFormatter;
4+
import org.eclipse.jgit.lib.Repository;
5+
import org.eclipse.jgit.storage.file.FileRepositoryBuilder;
6+
import org.eclipse.jgit.util.io.NullOutputStream;
7+
8+
import java.io.IOException;
9+
10+
public class LocalFacadeBuilder {
11+
public LocalFacade build() {
12+
try (Repository repository = new FileRepositoryBuilder().readEnvironment().findGitDir().build()) {
13+
try (DiffFormatter diffFormatter = new DiffFormatter(NullOutputStream.INSTANCE)) {
14+
diffFormatter.setRepository(repository);
15+
return new LocalFacade(repository, diffFormatter, new LocalFacadeOutput());
16+
}
17+
} catch (IOException e) {
18+
throw new RuntimeException("Error getting git repository", e);
19+
}
20+
}
21+
}

‎src/main/java/pl/touk/sputnik/connector/local/LocalFacadeOutput.java‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
package pl.touk.sputnik.connector.local;
2+
3+
import lombok.AllArgsConstructor;
4+
import lombok.extern.slf4j.Slf4j;
5+
6+
@AllArgsConstructor
7+
@Slf4j
8+
public class LocalFacadeOutput {
9+
void info(String message, Object ... arguments) {
10+
log.info(message, arguments);
11+
}
12+
13+
void warn(String message, Object ... arguments) {
14+
log.warn(message, arguments);
15+
}
16+
}

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,4 @@ public String getSourceDir() {
3939
private String createJavaClassName() {
4040
return StringUtils.substringBeforeLast(ENTRY_PATTERN.matcher(reviewFilename).replaceFirst(""), DOT).replace('/', '.');
4141
}
42-
4342
}

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

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
package pl.touk.sputnik.connector.local;
2+
3+
import com.google.common.collect.ImmutableList;
4+
import org.eclipse.jgit.diff.DiffEntry;
5+
import org.eclipse.jgit.diff.DiffEntry.ChangeType;
6+
import org.eclipse.jgit.diff.DiffFormatter;
7+
import org.eclipse.jgit.lib.Constants;
8+
import org.eclipse.jgit.lib.ObjectId;
9+
import org.eclipse.jgit.lib.Repository;
10+
import org.junit.jupiter.api.BeforeEach;
11+
import org.junit.jupiter.api.Test;
12+
import org.junit.jupiter.api.extension.ExtendWith;
13+
import org.mockito.InOrder;
14+
import org.mockito.Mock;
15+
import org.mockito.Mockito;
16+
import org.mockito.junit.jupiter.MockitoExtension;
17+
import pl.touk.sputnik.review.Comment;
18+
import pl.touk.sputnik.review.Review;
19+
import pl.touk.sputnik.review.ReviewFile;
20+
21+
import java.io.IOException;
22+
import java.util.List;
23+
24+
import static org.assertj.core.api.Assertions.assertThat;
25+
import static org.mockito.Answers.RETURNS_DEEP_STUBS;
26+
import static org.mockito.ArgumentMatchers.anyString;
27+
import static org.mockito.Mockito.mock;
28+
import static org.mockito.Mockito.never;
29+
import static org.mockito.Mockito.verify;
30+
import static org.mockito.Mockito.when;
31+
32+
@ExtendWith(MockitoExtension.class)
33+
class LocalFacadeTest {
34+
@Mock(answer = RETURNS_DEEP_STUBS)
35+
private Repository repo;
36+
@Mock
37+
private DiffFormatter diffFormatter;
38+
@Mock
39+
private DiffEntry modifiedFile;
40+
@Mock
41+
private DiffEntry deletedFile;
42+
@Mock
43+
private DiffEntry newFile;
44+
@Mock
45+
private Review review;
46+
@Mock
47+
private LocalFacadeOutput output;
48+
49+
private LocalFacade localFacade;
50+
51+
@BeforeEach
52+
void setUp() {
53+
localFacade = new LocalFacade(repo, diffFormatter, output);
54+
}
55+
56+
private void setUpDiff() throws IOException {
57+
when(modifiedFile.getNewPath()).thenReturn("/path/to/modifiedFile");
58+
when(modifiedFile.getChangeType()).thenReturn(ChangeType.MODIFY);
59+
60+
when(newFile.getNewPath()).thenReturn("/path/to/newFile");
61+
when(newFile.getChangeType()).thenReturn(ChangeType.ADD);
62+
63+
when(deletedFile.getChangeType()).thenReturn(ChangeType.DELETE);
64+
65+
ObjectId head = mock(ObjectId.class);
66+
ObjectId headParent = mock(ObjectId.class);
67+
when(repo.resolve(Constants.HEAD)).thenReturn(head);
68+
when(repo.resolve(Constants.HEAD + "^")).thenReturn(headParent);
69+
when(diffFormatter.scan(headParent, head)).thenReturn(ImmutableList.of(modifiedFile, deletedFile, newFile));
70+
}
71+
72+
@Test
73+
void shouldParseListFilesResponse() throws IOException {
74+
setUpDiff();
75+
76+
List<ReviewFile> reviewFiles = localFacade.listFiles();
77+
assertThat(reviewFiles).isNotEmpty();
78+
}
79+
80+
@Test
81+
void shouldNotListDeletedFiles() throws IOException {
82+
setUpDiff();
83+
84+
List<ReviewFile> reviewFiles = localFacade.listFiles();
85+
assertThat(reviewFiles)
86+
.hasSize(2)
87+
.extracting(ReviewFile::getReviewFilename).containsExactly(modifiedFile.getNewPath(), newFile.getNewPath());
88+
}
89+
90+
@Test
91+
void shouldPublishNoCommentsIfAllFilesHaveNoComments() {
92+
ReviewFile review1 = mock(ReviewFile.class);
93+
ReviewFile review2 = mock(ReviewFile.class);
94+
when(review.getFiles()).thenReturn(ImmutableList.of(review1, review2));
95+
96+
localFacade.publish(review);
97+
98+
verify(output).info("No sputnik comments");
99+
verify(output, never()).warn(anyString());
100+
}
101+
102+
@Test
103+
void shouldWarnWithCommentsAndLineNumbers() {
104+
ReviewFile review1 = mock(ReviewFile.class);
105+
when(review1.getReviewFilename()).thenReturn("/path/to/file1");
106+
ReviewFile review2 = mock(ReviewFile.class);
107+
ReviewFile review3 = mock(ReviewFile.class);
108+
when(review3.getReviewFilename()).thenReturn("/path/to/file3");
109+
when(review1.getComments()).thenReturn(ImmutableList.of(new Comment(11, "Comment 1"), new Comment(14, "Comment 2")));
110+
when(review3.getComments()).thenReturn(ImmutableList.of(new Comment(15, "Comment 3")));
111+
when(review.getMessages()).thenReturn(ImmutableList.of("message 1", "message 2"));
112+
when(review.getFiles()).thenReturn(ImmutableList.of(review1, review2, review3));
113+
114+
localFacade.publish(review);
115+
116+
verify(output, never()).info(anyString());
117+
InOrder order = Mockito.inOrder(output);
118+
order.verify(output).warn("message 1");
119+
order.verify(output).warn("message 2");
120+
order.verify(output).warn("");
121+
order.verify(output).warn("{} comment(s) on {}", 2, "/path/to/file1");
122+
order.verify(output).warn("Line {}: {}", 11, "Comment 1");
123+
order.verify(output).warn("Line {}: {}", 14, "Comment 2");
124+
order.verify(output).warn("");
125+
order.verify(output).warn("{} comment(s) on {}", 1, "/path/to/file3");
126+
order.verify(output).warn("Line {}: {}", 15, "Comment 3");
127+
}
128+
}

0 commit comments

Comments
 (0)