Skip to content

Commit

Permalink
Fix null credentialsId passed to GitSCM when authentication is userna…
Browse files Browse the repository at this point in the history 
…me/password or the StandardUsernameCredential provided by the BitbucketAuthenticator is null. (#924)
  • Loading branch information
@nfalco79
nfalco79 authored Nov 26, 2024
1 parent 3ee8748 commit 6a215c8
Show file tree
Hide file tree
Showing 4 changed files with 519 additions and 647 deletions.
6 changes: 6 additions & 0 deletions pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,12 @@
<artifactId>mockito-core</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.assertj</groupId>
<artifactId>assertj-core</artifactId>
<version>3.26.3</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>git</artifactId>
Expand Down
109 changes: 64 additions & 45 deletions src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSource.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
import com.cloudbees.jenkins.plugins.bitbucket.server.client.repository.BitbucketServerRepository;
import com.cloudbees.plugins.credentials.CredentialsNameProvider;
import com.cloudbees.plugins.credentials.common.StandardCredentials;
import com.cloudbees.plugins.credentials.common.StandardUsernameCredentials;
import com.damnhandy.uri.template.UriTemplate;
import com.fasterxml.jackson.databind.util.StdDateFormat;
import edu.umd.cs.findbugs.annotations.CheckForNull;
Expand All @@ -66,6 +67,7 @@
import hudson.model.Items;
import hudson.model.TaskListener;
import hudson.plugins.git.GitSCM;
import hudson.plugins.git.extensions.GitSCMExtension;
import hudson.scm.SCM;
import hudson.security.AccessControlled;
import hudson.util.FormFillFailure;
Expand Down Expand Up @@ -377,6 +379,7 @@ public String getEndpointJenkinsRootUrl() {
return AbstractBitbucketEndpoint.getEndpointJenkinsRootUrl(serverUrl);
}

@Override
@NonNull
public List<SCMSourceTrait> getTraits() {
return Collections.unmodifiableList(traits);
Expand All @@ -397,11 +400,11 @@ public void setBitbucketServerUrl(String url) {
if (endpoint != null) {
// we have a match
setServerUrl(endpoint.getServerUrl());
return;
} else {
LOGGER.log(Level.WARNING, "Call to legacy setBitbucketServerUrl({0}) method is configuring a url missing "
+ "from the global configuration.", url);
setServerUrl(url);
}
LOGGER.log(Level.WARNING, "Call to legacy setBitbucketServerUrl({0}) method is configuring a url missing "
+ "from the global configuration.", url);
setServerUrl(url);
}

@Deprecated
Expand All @@ -422,8 +425,8 @@ public String getBitbucketServerUrl() {
@CheckForNull
public String getCheckoutCredentialsId() {
for (SCMSourceTrait t : traits) {
if (t instanceof SSHCheckoutTrait) {
return StringUtils.defaultString(((SSHCheckoutTrait) t).getCredentialsId(), DescriptorImpl.ANONYMOUS);
if (t instanceof SSHCheckoutTrait sshTrait) {
return StringUtils.defaultString(sshTrait.getCredentialsId(), DescriptorImpl.ANONYMOUS);
}
}
return DescriptorImpl.SAME;
Expand All @@ -446,8 +449,8 @@ public void setCheckoutCredentialsId(String checkoutCredentialsId) {
@NonNull
public String getIncludes() {
for (SCMSourceTrait trait : traits) {
if (trait instanceof WildcardSCMHeadFilterTrait) {
return ((WildcardSCMHeadFilterTrait) trait).getIncludes();
if (trait instanceof WildcardSCMHeadFilterTrait wildcardTrait) {
return wildcardTrait.getIncludes();
}
}
return "*";
Expand Down Expand Up @@ -588,8 +591,7 @@ protected void retrieve(@CheckForNull SCMSourceCriteria criteria, @NonNull SCMHe
@Override
protected Iterable<BitbucketPullRequest> create() {
try {
if (event instanceof HasPullRequests) {
HasPullRequests hasPrEvent = (HasPullRequests) event;
if (event instanceof HasPullRequests hasPrEvent) {
return getBitbucketPullRequestsFromEvent(hasPrEvent, listener);
}

Expand Down Expand Up @@ -1000,12 +1002,34 @@ private BitbucketCommit findPRDestinationCommit(BitbucketPullRequest pr, TaskLis
public SCM build(SCMHead head, SCMRevision revision) {
initCloneLinks();

boolean sshAuth = traits.stream()
.anyMatch(SSHCheckoutTrait.class::isInstance);
String scmCredentialsId = credentialsId;

BitbucketAuthenticator authenticator = authenticator();
return new BitbucketGitSCMBuilder(this, head, revision, null)
.withExtension(new GitClientAuthenticatorExtension(authenticator == null || sshAuth ? null : authenticator.getCredentialsForSCM()))
GitSCMExtension scmExtension;
if (authenticator != null) {

Check warning on line 1009 in src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSource.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Partially covered line 

Line 1009 is only partially covered, one branch is missing
// workaround to force git-plugin to use the configured username/password credentialsId as is
// remove this workaround as https://github.com/jenkinsci/bitbucket-branch-source-plugin/pull/867 will be merged
boolean sshAuth = traits.stream()
.anyMatch(SSHCheckoutTrait.class::isInstance);
if (sshAuth) {
// trait will do the magic
scmCredentialsId = null;
scmExtension = new GitClientAuthenticatorExtension(null);
} else {
StandardUsernameCredentials scmCredentials = authenticator.getCredentialsForSCM();
// extension overrides the configured credentialsId with a custom StandardUsernameCredentials provided by the Authenticator
scmExtension = new GitClientAuthenticatorExtension(scmCredentials);
if (scmCredentials != null) {
// will be overridden by git extension
scmCredentialsId = null;
}
}
} else {

Check warning on line 1027 in src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSource.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Not covered lines 

Lines 1012-1027 are not covered by tests
scmExtension = new GitClientAuthenticatorExtension(null);
}

return new BitbucketGitSCMBuilder(this, head, revision, scmCredentialsId)
.withExtension(scmExtension)
.withCloneLinks(primaryCloneLinks, mirrorCloneLinks)
.withTraits(traits)
.build();
Expand Down Expand Up @@ -1115,20 +1139,18 @@ protected List<Action> retrieveActions(@NonNull SCMHead head,
template = UriTemplate.fromTemplate(getServerUrl() + CLOUD_REPO_TEMPLATE + "/{branchOrPR}/{prIdOrHead}")
.set("owner", repoOwner)
.set("repo", repository);
if (head instanceof PullRequestSCMHead) {
PullRequestSCMHead pr = (PullRequestSCMHead) head;
template.set("branchOrPR", "pull-requests").set("prIdOrHead", pr.getId());
if (head instanceof PullRequestSCMHead prHead) {

Check warning on line 1142 in src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSource.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Partially covered line 

Line 1142 is only partially covered, one branch is missing
template.set("branchOrPR", "pull-requests").set("prIdOrHead", prHead.getId());

Check warning on line 1143 in src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSource.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Not covered line 

Line 1143 is not covered by tests
} else {
template.set("branchOrPR", "branch").set("prIdOrHead", head.getName());
}
} else {
if (head instanceof PullRequestSCMHead) {
PullRequestSCMHead pr = (PullRequestSCMHead) head;
if (head instanceof PullRequestSCMHead prHead) {
template = UriTemplate
.fromTemplate(getServerUrl() + SERVER_REPO_TEMPLATE + "/pull-requests/{id}/overview")
.set("owner", repoOwner)
.set("repo", repository)
.set("id", pr.getId());
.set("id", prHead.getId());
} else {
template = UriTemplate
.fromTemplate(getServerUrl() + SERVER_REPO_TEMPLATE + "/compare/commits{?sourceBranch}")
Expand All @@ -1137,10 +1159,9 @@ protected List<Action> retrieveActions(@NonNull SCMHead head,
.set("sourceBranch", Constants.R_HEADS + head.getName());
}
}
if (head instanceof PullRequestSCMHead) {
PullRequestSCMHead pr = (PullRequestSCMHead) head;
title = getPullRequestTitleCache().get(pr.getId());
ContributorMetadataAction contributor = getPullRequestContributorCache().get(pr.getId());
if (head instanceof PullRequestSCMHead prHead) {
title = getPullRequestTitleCache().get(prHead.getId());
ContributorMetadataAction contributor = getPullRequestContributorCache().get(prHead.getId());
if (contributor != null) {
result.add(contributor);
}
Expand All @@ -1149,8 +1170,8 @@ protected List<Action> retrieveActions(@NonNull SCMHead head,
result.add(new BitbucketLink("icon-bitbucket-branch", url));
result.add(new ObjectMetadataAction(title, null, url));
SCMSourceOwner owner = getOwner();
if (owner instanceof Actionable) {
for (BitbucketDefaultBranch p : ((Actionable) owner).getActions(BitbucketDefaultBranch.class)) {
if (owner instanceof Actionable actionable) {

Check warning on line 1173 in src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSource.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Partially covered line 

Line 1173 is only partially covered, one branch is missing
for (BitbucketDefaultBranch p : actionable.getActions(BitbucketDefaultBranch.class)) {

Check warning on line 1174 in src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSource.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Partially covered line 

Line 1174 is only partially covered, one branch is missing
if (StringUtils.equals(getRepoOwner(), p.getRepoOwner())
&& StringUtils.equals(repository, p.getRepository())
&& StringUtils.equals(p.getDefaultBranch(), head.getName())) {
Expand Down Expand Up @@ -1371,8 +1392,7 @@ public ListBoxModel doFillCredentialsIdItems(@AncestorInPath SCMSourceOwner cont
public ListBoxModel doFillRepositoryItems(@AncestorInPath SCMSourceOwner context,
@QueryParameter String serverUrl,
@QueryParameter String credentialsId,
@QueryParameter String repoOwner)
throws IOException, InterruptedException {
@QueryParameter String repoOwner) throws IOException {
BitbucketSupplier<ListBoxModel> listBoxModelSupplier = bitbucket -> {
ListBoxModel result = new ListBoxModel();
BitbucketTeam team = bitbucket.getTeam();
Expand Down Expand Up @@ -1439,6 +1459,7 @@ public List<NamedArrayList<? extends SCMSourceTraitDescriptor>> getTraitsDescrip
return result;
}

@Override
public List<SCMSourceTrait> getTraitsDefaults() {
return Arrays.asList(
new BranchDiscoveryTrait(true, false),
Expand All @@ -1465,7 +1486,6 @@ public void record(@NonNull SCMHead scmHead, SCMRevision revision, boolean isMat
request.listener().getLogger().println(" Met criteria");
} else {
request.listener().getLogger().println(" Does not meet criteria");
return;
}

}
Expand All @@ -1484,8 +1504,8 @@ public BitbucketProbeFactory(BitbucketApi bitbucket, BitbucketSCMSourceRequest r
@NonNull
@Override
public Probe create(@NonNull final SCMHead head, @CheckForNull final I revisionInfo) throws IOException, InterruptedException {
final String hash = (revisionInfo instanceof BitbucketCommit) //
? ((BitbucketCommit) revisionInfo).getHash() //
final String hash = (revisionInfo instanceof BitbucketCommit bbRevision) //

Check warning on line 1507 in src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSource.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Partially covered line 

Line 1507 is only partially covered, one branch is missing
? bbRevision.getHash() //
: (String) revisionInfo;

return new SCMSourceCriteria.Probe() {
Expand All @@ -1501,8 +1521,8 @@ public long lastModified() {
try {
BitbucketCommit commit = null;
if (hash != null) {
commit = (revisionInfo instanceof BitbucketCommit) //
? (BitbucketCommit) revisionInfo //
commit = (revisionInfo instanceof BitbucketCommit bbRevision) //
? bbRevision //

Check warning on line 1525 in src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSource.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Not covered lines 

Lines 1524-1525 are not covered by tests
: bitbucket.resolveCommit(hash);
}

Expand Down Expand Up @@ -1559,8 +1579,7 @@ public SCMRevision create(@NonNull SCMHead head,
BitbucketCommit targetCommit = asCommit(targetInput);

SCMRevision revision;
if (head instanceof PullRequestSCMHead) {
PullRequestSCMHead prHead = (PullRequestSCMHead) head;
if (head instanceof PullRequestSCMHead prHead) {
SCMHead targetHead = prHead.getTarget();

return new PullRequestSCMRevision( //
Expand All @@ -1574,10 +1593,10 @@ public SCMRevision create(@NonNull SCMHead head,
}

private BitbucketCommit asCommit(I input) throws IOException, InterruptedException {
if (input instanceof String) {
return client.resolveCommit((String) input);
} else if (input instanceof BitbucketCommit) {
return (BitbucketCommit) input;
if (input instanceof String value) {
return client.resolveCommit(value);
} else if (input instanceof BitbucketCommit commit) {
return commit;
}
return null;
}
Expand Down Expand Up @@ -1626,14 +1645,14 @@ public WrappedException(Throwable cause) {

public void unwrap() throws IOException, InterruptedException {
Throwable cause = getCause();
if (cause instanceof IOException) {
throw (IOException) cause;
if (cause instanceof IOException ioEx) {
throw ioEx;
}
if (cause instanceof InterruptedException) {
throw (InterruptedException) cause;
if (cause instanceof InterruptedException interruptedEx) {

Check warning on line 1651 in src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSource.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Partially covered line 

Line 1651 is only partially covered, one branch is missing
throw interruptedEx;
}
if (cause instanceof RuntimeException) {
throw (RuntimeException) cause;
if (cause instanceof RuntimeException rtEx) {
throw rtEx;

Check warning on line 1655 in src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSource.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Not covered lines 

Lines 1654-1655 are not covered by tests
}
throw this;
}
Expand Down
13 changes: 0 additions & 13 deletions ...ees/jenkins/plugins/bitbucket/api/credentials/BitbucketUsernamePasswordAuthenticator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,7 @@
package com.cloudbees.jenkins.plugins.bitbucket.api.credentials;

import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketAuthenticator;
import com.cloudbees.plugins.credentials.CredentialsScope;
import com.cloudbees.plugins.credentials.common.StandardUsernameCredentials;
import com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials;
import com.cloudbees.plugins.credentials.impl.UsernamePasswordCredentialsImpl;
import hudson.model.Descriptor.FormException;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.apache.http.HttpHost;
Expand Down Expand Up @@ -79,13 +75,4 @@ public void configureContext(HttpClientContext context, HttpHost host) {
context.setAuthCache(authCache);
}

@Override
public StandardUsernameCredentials getCredentialsForSCM() {
try {
return new UsernamePasswordCredentialsImpl(
CredentialsScope.GLOBAL, getId(), null, httpCredentials.getUserName(), httpCredentials.getPassword());
} catch (FormException e) {
throw new RuntimeException(e);
}
}
}
Loading

0 comments on commit 6a215c8

Please sign in to comment.