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

Add GitHub App Support for GitHub Issues #513

Merged
merged 3 commits into from
Nov 10, 2020
Merged

Add GitHub App Support for GitHub Issues #513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e31e08
Make GitHubService Authentication call public so it can be leveraged …
kmcdon83 Nov 10, 2020
b5c4175
Update GitHubIssueTracker to use GitHubService Authentication logic t…
kmcdon83 Nov 10, 2020
ccf6551
Fix typo in PR template
kmcdon83 Nov 10, 2020
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
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ By submitting a PR to this repository, you agree to the terms within the [Checkm

### Checklist

- [ ] I have added documentation for new/changed functionality in this PR (if applicable). *If documentaiton is a Wiki Update, please indicate desired changes within PR MD Comment*
- [ ] I have added documentation for new/changed functionality in this PR (if applicable). *If documentation is a Wiki Update, please indicate desired changes within PR MD Comment*
- [ ] All active GitHub checks for tests, formatting, and security are passing
- [ ] The correct base branch is being used
48 changes: 24 additions & 24 deletions src/main/java/com/checkmarx/flow/custom/GitHubIssueTracker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import com.checkmarx.flow.dto.github.LabelsItem;
import com.checkmarx.flow.exception.MachinaException;
import com.checkmarx.flow.exception.MachinaRuntimeException;
import com.checkmarx.flow.service.GitHubService;
import com.checkmarx.flow.utils.HTMLHelper;
import com.checkmarx.flow.utils.ScanUtils;
import com.checkmarx.sdk.dto.ScanResults;
Expand Down Expand Up @@ -37,13 +38,15 @@ public class GitHubIssueTracker implements IssueTracker {
private final GitHubProperties properties;
private final FlowProperties flowProperties;
private final ScmConfigOverrider scmConfigOverrider;
private final GitHubService gitHubService;

public GitHubIssueTracker(@Qualifier("flowRestTemplate") RestTemplate restTemplate, GitHubProperties properties, FlowProperties flowProperties,
ScmConfigOverrider scmConfigOverrider) {
ScmConfigOverrider scmConfigOverrider, GitHubService gitHubService) {
this.restTemplate = restTemplate;
this.properties = properties;
this.flowProperties = flowProperties;
this.scmConfigOverrider = scmConfigOverrider;
this.gitHubService = gitHubService;
}

@Override
Expand Down Expand Up @@ -76,7 +79,7 @@ public List<Issue> getIssues(ScanRequest request) {

log.info("Executing getIssues GitHub API call: {}", apiUrl);
List<Issue> issues = new ArrayList<>();
HttpEntity<?> httpEntity = new HttpEntity<>(createAuthHeaders(request));
HttpEntity<?> httpEntity = new HttpEntity<>(gitHubService.createAuthHeaders(request));

ResponseEntity<com.checkmarx.flow.dto.github.Issue[]> response = restTemplate.exchange(apiUrl,
HttpMethod.GET, httpEntity, com.checkmarx.flow.dto.github.Issue[].class);
Expand All @@ -99,19 +102,23 @@ public List<Issue> getIssues(ScanRequest request) {
ResponseEntity<com.checkmarx.flow.dto.github.Issue[]> responsePage = restTemplate.exchange(next, HttpMethod.GET,
httpEntity, com.checkmarx.flow.dto.github.Issue[].class);

if (responsePage.getBody() != null) {
for (com.checkmarx.flow.dto.github.Issue issue : responsePage.getBody()) {
Issue i = mapToIssue(issue);
if (i != null && i.getTitle().startsWith(request.getProduct().getProduct())) {
issues.add(i);
}
}
}
mapIssues(request, issues, responsePage);
next = getNextURIFromHeaders(responsePage.getHeaders(), "link", "next");
}
return issues;
}

private void mapIssues(ScanRequest request, List<Issue> issues, ResponseEntity<com.checkmarx.flow.dto.github.Issue[]> responsePage) {
if (responsePage.getBody() != null) {
for (com.checkmarx.flow.dto.github.Issue issue : responsePage.getBody()) {
Issue i = mapToIssue(issue);
if (i != null && i.getTitle().startsWith(request.getProduct().getProduct())) {
issues.add(i);
}
}
}
}


private Issue mapToIssue(com.checkmarx.flow.dto.github.Issue issue){
if(issue == null){
Expand Down Expand Up @@ -139,7 +146,7 @@ private Issue mapToIssue(com.checkmarx.flow.dto.github.Issue issue){
*/
private Issue getIssue(String issueUrl, ScanRequest scanRequest) {
log.info("Executing getIssue GitHub API call");
HttpEntity<Object> httpEntity = new HttpEntity<>(createAuthHeaders(scanRequest));
HttpEntity<Object> httpEntity = new HttpEntity<>(gitHubService.createAuthHeaders(scanRequest));
ResponseEntity<com.checkmarx.flow.dto.github.Issue> response =
restTemplate.exchange(issueUrl, HttpMethod.GET, httpEntity, com.checkmarx.flow.dto.github.Issue.class);

Expand All @@ -154,7 +161,7 @@ private Issue getIssue(String issueUrl, ScanRequest scanRequest) {
*/
private void addComment(String issueUrl, String comment, ScanRequest scanRequest) {
log.debug("Executing add comment GitHub API call with following comment {}", comment);
HttpEntity<String> httpEntity = new HttpEntity<>(getJSONComment(comment).toString(), createAuthHeaders(scanRequest));
HttpEntity<String> httpEntity = new HttpEntity<>(getJSONComment(comment).toString(), gitHubService.createAuthHeaders(scanRequest));
restTemplate.exchange(issueUrl.concat("/comments"), HttpMethod.POST, httpEntity, String.class);
}

Expand All @@ -167,7 +174,8 @@ public Issue createIssue(ScanResults.XIssue resultIssue, ScanRequest request) {
.concat("/issues");
ResponseEntity<com.checkmarx.flow.dto.github.Issue> response;
try {
HttpEntity<String> httpEntity = new HttpEntity<>(getJSONCreateIssue(resultIssue, request).toString(), createAuthHeaders(request));
HttpEntity<String> httpEntity = new HttpEntity<>(getJSONCreateIssue(resultIssue, request).toString(),
gitHubService.createAuthHeaders(request));
response = restTemplate.exchange(apiUrl, HttpMethod.POST, httpEntity, com.checkmarx.flow.dto.github.Issue.class);
} catch (HttpClientErrorException e) {
log.error("Error occurred while creating GitHub Issue", e);
Expand All @@ -182,14 +190,15 @@ public Issue createIssue(ScanResults.XIssue resultIssue, ScanRequest request) {
@Override
public void closeIssue(Issue issue, ScanRequest request) throws MachinaException {
log.info("Executing closeIssue GitHub API call");
HttpEntity httpEntity = new HttpEntity<>(getJSONCloseIssue().toString(), createAuthHeaders(request));
HttpEntity<String> httpEntity = new HttpEntity<>(getJSONCloseIssue().toString(), gitHubService.createAuthHeaders(request));
restTemplate.exchange(issue.getUrl(), HttpMethod.POST, httpEntity, Issue.class);
}

@Override
public Issue updateIssue(Issue issue, ScanResults.XIssue resultIssue, ScanRequest request) throws MachinaException {
log.info("Executing updateIssue GitHub API call");
HttpEntity<String> httpEntity = new HttpEntity<>(getJSONUpdateIssue(resultIssue, request).toString(), createAuthHeaders(request));
HttpEntity<String> httpEntity = new HttpEntity<>(getJSONUpdateIssue(resultIssue, request).toString(),
gitHubService.createAuthHeaders(request));
ResponseEntity<com.checkmarx.flow.dto.github.Issue> response;
try {
response = restTemplate.exchange(issue.getUrl(), HttpMethod.POST, httpEntity, com.checkmarx.flow.dto.github.Issue.class);
Expand Down Expand Up @@ -326,15 +335,6 @@ private JSONObject getJSONCloseIssue() {
return requestBody;
}

/**
* @return Header consisting of API token used for authentication
*/
private HttpHeaders createAuthHeaders(ScanRequest scanRequest) {
HttpHeaders httpHeaders = new HttpHeaders();
httpHeaders.set(HttpHeaders.AUTHORIZATION, "token ".concat(scmConfigOverrider.determineConfigToken(properties, scanRequest.getScmInstance())));
return httpHeaders;
}

private static String getNextURIFromHeaders(HttpHeaders headers, final String headerName, final String rel) {
if (headerName == null) {
return null;
Expand Down
4 changes: 1 addition & 3 deletions src/main/java/com/checkmarx/flow/service/GitHubService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ public GitHubService(@Qualifier("flowRestTemplate") RestTemplate restTemplate,
this.gitHubAppAuthService = gitHubAppAuthService;
}

private HttpHeaders createAuthHeaders(ScanRequest scanRequest){
public HttpHeaders createAuthHeaders(ScanRequest scanRequest){
HttpHeaders httpHeaders;
if(!StringUtils.isEmpty(properties.getAppId()) &&
!StringUtils.isEmpty(properties.getAppKeyFile()) &&
Expand All @@ -97,8 +97,6 @@ private HttpHeaders createAuthHeaders(ScanRequest scanRequest){
);
httpHeaders = new HttpHeaders();
httpHeaders.set(HttpHeaders.AUTHORIZATION, "token ".concat(token));


}
else{
httpHeaders = new HttpHeaders();
Expand Down