Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Do not duplicate file comments in Stash #157

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Do not duplicate file comments in Stash #157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf3614b
Do not duplicate file comments
platan Oct 15, 2016
936f357
Constant for file comment line position
platan Oct 16, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/main/java/pl/touk/sputnik/connector/stash/StashFacade.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@

@Slf4j
public class StashFacade implements ConnectorFacade {
private static final int FILE_COMMENT_LINE_POSITION = 0;
private StashConnector stashConnector;
private ObjectMapper objectMapper = new ObjectMapper();
private final Configuration configuration;
Expand Down Expand Up @@ -150,14 +151,23 @@ SingleFileChanges changesForSingleFile(String filename) {
String response = stashConnector.getDiffByLine(filename);
List<JSONObject> diffJsonList = JsonPath.read(response, "$.diffs[*].hunks[*].segments[*]");
List<JSONObject> lineCommentJsonList = JsonPath.read(response, "$.diffs[*].lineComments[*]['text', 'id']");
List<JSONObject> fileCommentJsonList = JsonPath.read(response, "$.diffs[*].fileComments[*]['text', 'id']");
List<DiffSegment> segments = transform(diffJsonList, DiffSegment.class);
List<LineComment> lineComments = transform(lineCommentJsonList, LineComment.class);
List<LineComment> fileComments = transform(fileCommentJsonList, LineComment.class);
SingleFileChanges changes = SingleFileChanges.builder().filename(filename).build();
for (DiffSegment segment : segments) {
for (LineSegment line : segment.lines) {
changes.addChange(line.destination, ChangeType.valueOf(segment.type), getComment(lineComments, line.commentIds));
}
}
if (!fileComments.isEmpty()) {
List<String> comments = new ArrayList<>();
for (LineComment lineComment : fileComments) {
comments.add(lineComment.text);
}
changes.addChange(FILE_COMMENT_LINE_POSITION, ChangeType.NONE, comments);
}
return changes;
} catch (URISyntaxException | IOException e) {
throw new StashException("Error parsing json strings to objects", e);
Expand Down
30 changes: 30 additions & 0 deletions src/test/java/pl/touk/sputnik/connector/stash/StashFacadeTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,13 @@
import com.github.tomakehurst.wiremock.junit.WireMockRule;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import junitparams.JUnitParamsRunner;
import junitparams.Parameters;
import junitparams.naming.TestCaseName;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import pl.touk.sputnik.HttpConnectorEnv;
import pl.touk.sputnik.configuration.Configuration;
import pl.touk.sputnik.configuration.ConfigurationSetup;
Expand All @@ -18,6 +22,7 @@
import static com.github.tomakehurst.wiremock.client.WireMock.*;
import static org.assertj.core.api.Assertions.assertThat;

@RunWith(JUnitParamsRunner.class)
public class StashFacadeTest extends HttpConnectorEnv {

private static String SOME_PULL_REQUEST_ID = "12314";
Expand Down Expand Up @@ -108,4 +113,29 @@ public void shouldSkipDeletedFiles() throws Exception {
assertThat(files).extracting("reviewFilename").containsOnly("src/main/java/example/App2.java");
}

@Parameters({"/json/stash-diff-no-file-comments.json, 1",
"/json/stash-diff-with-file-comment.json, 0"})
@TestCaseName("file comment should be send {2} time(s)")
@Test
public void fileComments(String diffFile, int expectedNumberOfCommentsSent) throws Exception {
String pullRequestResourceUrl = String.format("%s/rest/api/1.0/projects/%s/repos/%s/pull-requests/%s",
FacadeConfigUtil.PATH, SOME_PROJECT_KEY, SOME_REPOSITORY, SOME_PULL_REQUEST_ID);
stubGet(urlMatching(pullRequestResourceUrl + "/diff.*"), diffFile);
stubGet(urlEqualTo(pullRequestResourceUrl + "/changes"), "/json/stash-changes-for-file-violation.json");
stubFor(post(urlEqualTo(pullRequestResourceUrl + "/comments")).willReturn(aResponse().withStatus(200)));
String filename = "src/main/java/com/example/app/Runner.java";
Review review = new Review(ImmutableList.of(new ReviewFile(filename)), ReviewFormatterFactory.get(config));
review.addError("Checkstyle", new Violation(filename, 0, "File does not end with a newline.", Severity.WARNING));
review.getMessages().add("Total 1 violations found");

stashFacade.publish(review);

verify(expectedNumberOfCommentsSent, postRequestedFor(urlEqualTo(pullRequestResourceUrl + "/comments"))
.withRequestBody(equalToJson("{\"text\":\"[Checkstyle] WARNING: File does not end with a newline.\"," +
"\"anchor\":{\"line\":0," +
"\"lineType\":\"CONTEXT\"," +
"\"fileType\":null," +
"\"path\":\"src/main/java/com/example/app/Runner.java\",\n" +
"\"srcPath\":\"src/main/java/com/example/app/Runner.java\"}}")));
}
}
35 changes: 35 additions & 0 deletions src/test/resources/json/stash-changes-for-file-violation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"fromHash": "f18cca8d4070ad89c4d65bbcee1d74875113819f",
"toHash": "646afa05e6c3487eeceb91efb1adde1d568a0256",
"values": [
{
"contentId": "e772f87e63e99dc933113accf2d973610929af6a",
"fromContentId": "11ccbe4b07de2e5eaa65fabfb58bfc8bbb32c98c",
"path": {
"components": [
"src",
"main",
"java",
"com",
"example",
"app",
"Runner.java"
],
"parent": "src/main/java/com/example/app",
"name": "Runner.java",
"extension": "java",
"toString": "src/main/java/com/example/app/Runner.java"
},
"executable": false,
"percentUnchanged": -1,
"type": "MODIFY",
"nodeType": "FILE",
"srcExecutable": false
}
],
"size": 1,
"isLastPage": true,
"start": 0,
"limit": 25,
"nextPageStart": null
}
106 changes: 106 additions & 0 deletions src/test/resources/json/stash-diff-no-file-comments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
{
"fromHash": "f18cca8d4070ad89c4d65bbcee1d74875113819f",
"toHash": "646afa05e6c3487eeceb91efb1adde1d568a0256",
"contextLines": 10,
"whitespace": "SHOW",
"diffs": [
{
"source": {
"components": [
"src",
"main",
"java",
"com",
"example",
"app",
"Runner.java"
],
"parent": "src/main/java/com/example/app",
"name": "Runner.java",
"extension": "java",
"toString": "src/main/java/com/example/app/Runner.java"
},
"destination": {
"components": [
"src",
"main",
"java",
"com",
"example",
"app",
"Runner.java"
],
"parent": "src/main/java/com/example/app",
"name": "Runner.java",
"extension": "java",
"toString": "src/main/java/com/example/app/Runner.java"
},
"hunks": [
{
"sourceLine": 1,
"sourceSpan": 5,
"destinationLine": 1,
"destinationSpan": 5,
"segments": [
{
"type": "CONTEXT",
"lines": [
{
"source": 1,
"destination": 1,
"line": "package com.example.app;",
"truncated": false
},
{
"source": 2,
"destination": 2,
"line": "",
"truncated": false
},
{
"source": 3,
"destination": 3,
"line": "public interface Runner {",
"truncated": false
},
{
"source": 4,
"destination": 4,
"line": " void run();",
"truncated": false
}
],
"truncated": false
},
{
"type": "REMOVED",
"lines": [
{
"source": 5,
"destination": 5,
"line": "}",
"truncated": false
}
],
"truncated": false
},
{
"type": "ADDED",
"lines": [
{
"source": 6,
"destination": 5,
"line": "}",
"truncated": false
}
],
"truncated": false
}
],
"truncated": false
}
],
"truncated": false
}
]
}
131 changes: 131 additions & 0 deletions src/test/resources/json/stash-diff-with-file-comment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
{
"fromHash": "f18cca8d4070ad89c4d65bbcee1d74875113819f",
"toHash": "646afa05e6c3487eeceb91efb1adde1d568a0256",
"contextLines": 10,
"whitespace": "SHOW",
"diffs": [
{
"source": {
"components": [
"src",
"main",
"java",
"com",
"example",
"app",
"Runner.java"
],
"parent": "src/main/java/com/example/app",
"name": "Runner.java",
"extension": "java",
"toString": "src/main/java/com/example/app/Runner.java"
},
"destination": {
"components": [
"src",
"main",
"java",
"com",
"example",
"app",
"Runner.java"
],
"parent": "src/main/java/com/example/app",
"name": "Runner.java",
"extension": "java",
"toString": "src/main/java/com/example/app/Runner.java"
},
"hunks": [
{
"sourceLine": 1,
"sourceSpan": 5,
"destinationLine": 1,
"destinationSpan": 5,
"segments": [
{
"type": "CONTEXT",
"lines": [
{
"source": 1,
"destination": 1,
"line": "package com.example.app;",
"truncated": false
},
{
"source": 2,
"destination": 2,
"line": "",
"truncated": false
},
{
"source": 3,
"destination": 3,
"line": "public interface Runner {",
"truncated": false
},
{
"source": 4,
"destination": 4,
"line": " void run();",
"truncated": false
}
],
"truncated": false
},
{
"type": "REMOVED",
"lines": [
{
"source": 5,
"destination": 5,
"line": "}",
"truncated": false
}
],
"truncated": false
},
{
"type": "ADDED",
"lines": [
{
"source": 6,
"destination": 5,
"line": "}",
"truncated": false
}
],
"truncated": false
}
],
"truncated": false
}
],
"truncated": false,
"fileComments": [
{
"id": 225,
"version": 0,
"text": "[Checkstyle] WARNING: File does not end with a newline.",
"author": {
"name": "admin",
"emailAddress": "[email protected]",
"id": 1,
"displayName": "Administrator",
"active": true,
"slug": "admin",
"type": "NORMAL"
},
"createdDate": 1476558804537,
"updatedDate": 1476558804537,
"comments": [],
"attributes": {},
"tasks": [],
"permittedOperations": {
"editable": true,
"deletable": true
}
}
]
}
]
}