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

#738: Prevent missing pull request data from causing API errors #847

Merged
merged 1 commit into from
Jan 1, 2024
Merged

#738: Prevent missing pull request data from causing API errors #847

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 4 additions & 8 deletions src/main/java/com/github/mc1arke/sonarqube/plugin/scanner/BranchConfigurationFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (C) 2022 Michael Clarke
* Copyright (C) 2022-2024 Michael Clarke
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
Expand Down Expand Up @@ -40,13 +40,9 @@ public BranchConfiguration createBranchConfiguration(String branchName, ProjectB
}

public BranchConfiguration createPullRequestConfiguration(String pullRequestKey, String pullRequestBranch, String pullRequestBase, ProjectBranches branches) {
if (branches.isEmpty()) {
return new CommunityBranchConfiguration(pullRequestBranch, BranchType.PULL_REQUEST, null, pullRequestBase, pullRequestKey);
}

String referenceBranch = branches.get(pullRequestBase) == null ? branches.defaultBranchName() : findReferenceBranch(pullRequestBase, branches);
return new CommunityBranchConfiguration(pullRequestBranch, BranchType.PULL_REQUEST, referenceBranch, pullRequestBase, pullRequestKey);

String targetBranch = Optional.ofNullable(pullRequestBase).orElse(branches.defaultBranchName());
String referenceBranch = findReferenceBranch(targetBranch, branches);
return new CommunityBranchConfiguration(pullRequestBranch, BranchType.PULL_REQUEST, referenceBranch, targetBranch, pullRequestKey);
}

private static String findReferenceBranch(String targetBranch, ProjectBranches branches) {
Expand Down
18 changes: 11 additions & 7 deletions .../github/mc1arke/sonarqube/plugin/server/pullrequest/ws/pullrequest/action/ListAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (C) 2009-2023 SonarSource SA (mailto:info AT sonarsource DOT com), Michael Clarke
* Copyright (C) 2009-2024 SonarSource SA (mailto:info AT sonarsource DOT com), Michael Clarke
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
Expand Down Expand Up @@ -120,10 +120,12 @@ private static void addPullRequest(ProjectPullRequests.ListWsResponse.Builder re
ProjectPullRequests.PullRequest.Builder builder = ProjectPullRequests.PullRequest.newBuilder();
builder.setKey(branch.getKey());

DbProjectBranches.PullRequestData pullRequestData = Objects.requireNonNull(branch.getPullRequestData(), "Pull request data should be available for branch type PULL_REQUEST");
builder.setBranch(pullRequestData.getBranch());
Optional.ofNullable(Strings.emptyToNull(pullRequestData.getUrl())).ifPresent(builder::setUrl);
Optional.ofNullable(Strings.emptyToNull(pullRequestData.getTitle())).ifPresent(builder::setTitle);
Optional<DbProjectBranches.PullRequestData> optionalPullRequestData = Optional.ofNullable(branch.getPullRequestData());
optionalPullRequestData.ifPresent(pullRequestData -> {
builder.setBranch(pullRequestData.getBranch());
Optional.ofNullable(Strings.emptyToNull(pullRequestData.getUrl())).ifPresent(builder::setUrl);
Optional.ofNullable(Strings.emptyToNull(pullRequestData.getTitle())).ifPresent(builder::setTitle);
});

if (mergeBranch.isPresent()) {
String mergeBranchKey = mergeBranch.get().getKey();
Expand All @@ -132,8 +134,10 @@ private static void addPullRequest(ProjectPullRequests.ListWsResponse.Builder re
builder.setIsOrphan(true);
}

if (StringUtils.isNotEmpty(pullRequestData.getTarget())) {
builder.setTarget(pullRequestData.getTarget());
Optional<String> pullRequestTarget = optionalPullRequestData.map(DbProjectBranches.PullRequestData::getTarget)
.filter(StringUtils::isNotEmpty);
if (pullRequestTarget.isPresent()) {
builder.setTarget(pullRequestTarget.get());
} else {
mergeBranch.ifPresent(branchDto -> builder.setTarget(branchDto.getKey()));
}
Expand Down
46 changes: 42 additions & 4 deletions ...test/java/com/github/mc1arke/sonarqube/plugin/scanner/BranchConfigurationFactoryTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (C) 2022 Michael Clarke
* Copyright (C) 2022-2024 Michael Clarke
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
Expand All @@ -19,6 +19,7 @@
package com.github.mc1arke.sonarqube.plugin.scanner;

import org.junit.jupiter.api.Test;
import org.sonar.api.utils.MessageException;
import org.sonar.scanner.scan.branch.BranchConfiguration;
import org.sonar.scanner.scan.branch.BranchInfo;
import org.sonar.scanner.scan.branch.BranchType;
Expand Down Expand Up @@ -70,14 +71,51 @@ void shouldReturnBranchWithSelfReferenceIfSpecifiedBranchDoesExist() {
}

@Test
void shouldReturnPullRequestWithNoTargetIfNoProjectBranchesExist() {
void shouldThrowErrorIfAttemptingToCreatePullRequestWithNoTargetIfNoProjectBranchesExist() {
ProjectBranches projectBranches = mock(ProjectBranches.class);
when(projectBranches.isEmpty()).thenReturn(true);
when(projectBranches.defaultBranchName()).thenReturn("default-branch-name");

BranchConfigurationFactory underTest = new BranchConfigurationFactory();
BranchConfiguration actual = underTest.createPullRequestConfiguration("key", "source", "target", projectBranches);
assertThatThrownBy(() -> underTest.createPullRequestConfiguration("key", "source", null, projectBranches))
.usingRecursiveComparison()
.isEqualTo(MessageException.of("No branch exists in Sonarqube with the name default-branch-name"));
}

@Test
void shouldThrowErrorIfAttemptingToCreatePullRequestWithTargetIfNoProjectBranchesExist() {
ProjectBranches projectBranches = mock(ProjectBranches.class);
when(projectBranches.isEmpty()).thenReturn(true);

BranchConfigurationFactory underTest = new BranchConfigurationFactory();
assertThatThrownBy(() -> underTest.createPullRequestConfiguration("key", "source", "target", projectBranches))
.usingRecursiveComparison()
.isEqualTo(MessageException.of("No branch exists in Sonarqube with the name target"));
}

@Test
void shouldThrowErrorIfAttemptingToCreatePullRequestWithTargetBranchThatDoesNotExist() {
ProjectBranches projectBranches = mock(ProjectBranches.class);
when(projectBranches.isEmpty()).thenReturn(false);

BranchConfigurationFactory underTest = new BranchConfigurationFactory();
assertThatThrownBy(() -> underTest.createPullRequestConfiguration("key", "source", "target-branch", projectBranches))
.usingRecursiveComparison()
.isEqualTo(MessageException.of("No branch exists in Sonarqube with the name target-branch"));
}

@Test
void shouldReturnPullRequestWithTargetOfDefaultBranchIfTargetNotSpecifiedAndDefaultExists() {
ProjectBranches projectBranches = mock(ProjectBranches.class);
when(projectBranches.isEmpty()).thenReturn(false);
when(projectBranches.defaultBranchName()).thenReturn("defaultBranch");
BranchInfo branchInfo = new BranchInfo("defaultBranch", BranchType.BRANCH, true, null);
when(projectBranches.get("defaultBranch")).thenReturn(branchInfo);

BranchConfigurationFactory underTest = new BranchConfigurationFactory();
BranchConfiguration actual = underTest.createPullRequestConfiguration("key", "source", null, projectBranches);

assertThat(actual).usingRecursiveComparison().isEqualTo(new CommunityBranchConfiguration("source", BranchType.PULL_REQUEST, null, "target", "key"));
assertThat(actual).usingRecursiveComparison().isEqualTo(new CommunityBranchConfiguration("source", BranchType.PULL_REQUEST, "defaultBranch", "defaultBranch", "key"));
}

@Test
Expand Down
15 changes: 13 additions & 2 deletions ...hub/mc1arke/sonarqube/plugin/server/pullrequest/ws/pullrequest/action/ListActionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (C) 2022-2023 Michael Clarke
* Copyright (C) 2022-2024 Michael Clarke
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
Expand Down Expand Up @@ -118,7 +118,12 @@ void shouldExecuteRequestWithValidParameter() {
.setBranch("prBranch2")
.setTitle("title3")
.setUrl("url3")
.build())));
.build()),
new BranchDto()
.setBranchType(BranchType.PULL_REQUEST)
.setKey("prKey4")
.setUuid("uuid5")
.setMergeBranchUuid("uuid2")));

when(branchDao.selectByUuids(any(), any())).thenReturn(List.of(new BranchDto()
.setUuid("uuid2")
Expand Down Expand Up @@ -166,6 +171,12 @@ void shouldExecuteRequestWithValidParameter() {
.setUrl("url3")
.setTarget("branch2Key")
.build())
.addPullRequests(ProjectPullRequests.PullRequest.newBuilder()
.setKey("prKey4")
.setBase("branch2Key")
.setStatus(ProjectPullRequests.Status.newBuilder().build())
.setTarget("branch2Key")
.build())
.build();


Expand Down
Loading