Skip to content

Commit eea9c6d

Browse files
nfalco79nfalco79
authored
Replace the avatar cache beta implementation with default one provided by the scm-api plugin. (#978)
There are two action that store the AvatarImage, BitbucketTeamAvatarMetadataAction and BitbucketRepoAvatarMetadataAction. The BitbucketTeamAvatarMetadataAction holds the metadata to retrieve the team/project avatar of an organization folder. The BitbucketRepoAvatarMetadataAction holds the metadata to retrieve the repository avatar of single multi branch repository. The SVG images generated by bitbucket are not supported by ImageIO, those images are replaced with Jenkins random images. The use of avatar image as job icon is disabled by default, a new trait will configure the project to use as icon the Bitbucket avatar.
1 parent d5bdec0 commit eea9c6d

36 files changed

+881
-1454
lines changed

‎pom.xml

+3-1
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,12 @@
3131
<gitHubRepo>jenkinsci/bitbucket-branch-source-plugin</gitHubRepo>
3232
<jenkins.baseline>2.479</jenkins.baseline>
3333
<jenkins.version>${jenkins.baseline}.1</jenkins.version>
34-
<hpi.compatibleSinceVersion>2.0</hpi.compatibleSinceVersion>
34+
<hpi.compatibleSinceVersion>934.0</hpi.compatibleSinceVersion>
3535
<!-- Jenkins.MANAGE is still in Beta -->
3636
<useBeta>true</useBeta>
3737
<tagNameFormat>@{project.version}</tagNameFormat>
38+
<!-- because eclipse generate a JUnit5 run configuration with placeholder not replaced in the jvm argument section! -->
39+
<surefire.forkNumber>1</surefire.forkNumber>
3840
</properties>
3941

4042
<developers>

‎src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMNavigator.java

+52-51
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,19 @@
2626
import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketApi;
2727
import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketApiFactory;
2828
import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketAuthenticator;
29+
import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketCloudWorkspace;
2930
import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketRepository;
3031
import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketTeam;
3132
import com.cloudbees.jenkins.plugins.bitbucket.client.repository.UserRoleInRepository;
3233
import com.cloudbees.jenkins.plugins.bitbucket.endpoints.AbstractBitbucketEndpoint;
3334
import com.cloudbees.jenkins.plugins.bitbucket.endpoints.BitbucketCloudEndpoint;
3435
import com.cloudbees.jenkins.plugins.bitbucket.endpoints.BitbucketEndpointConfiguration;
3536
import com.cloudbees.jenkins.plugins.bitbucket.endpoints.BitbucketServerEndpoint;
37+
import com.cloudbees.jenkins.plugins.bitbucket.impl.avatars.BitbucketTeamAvatarMetadataAction;
3638
import com.cloudbees.jenkins.plugins.bitbucket.impl.util.BitbucketCredentials;
3739
import com.cloudbees.jenkins.plugins.bitbucket.impl.util.MirrorListSupplier;
3840
import com.cloudbees.jenkins.plugins.bitbucket.server.BitbucketServerWebhookImplementation;
39-
import com.cloudbees.jenkins.plugins.bitbucket.server.client.repository.BitbucketServerProject;
41+
import com.cloudbees.jenkins.plugins.bitbucket.trait.ShowBitbucketAvatarTrait;
4042
import com.cloudbees.plugins.credentials.CredentialsNameProvider;
4143
import com.cloudbees.plugins.credentials.common.StandardCredentials;
4244
import edu.umd.cs.findbugs.annotations.CheckForNull;
@@ -323,7 +325,7 @@ public void setPattern(String pattern) {
323325
@RestrictedSince("2.2.0")
324326
@DataBoundSetter
325327
public void setAutoRegisterHooks(boolean autoRegisterHook) {
326-
traits.removeIf(trait -> trait instanceof WebhookRegistrationTrait);
328+
traits.removeIf(WebhookRegistrationTrait.class::isInstance);
327329
traits.add(new WebhookRegistrationTrait(
328330
autoRegisterHook ? WebhookRegistration.ITEM : WebhookRegistration.DISABLE
329331
));
@@ -334,8 +336,8 @@ public void setAutoRegisterHooks(boolean autoRegisterHook) {
334336
@RestrictedSince("2.2.0")
335337
public boolean isAutoRegisterHooks() {
336338
for (SCMTrait<? extends SCMTrait<?>> t : traits) {
337-
if (t instanceof WebhookRegistrationTrait) {
338-
return ((WebhookRegistrationTrait) t).getMode() != WebhookRegistration.DISABLE;
339+
if (t instanceof WebhookRegistrationTrait hookTrait) {
340+
return hookTrait.getMode() != WebhookRegistration.DISABLE;
339341
}
340342
}
341343
return true;
@@ -348,8 +350,8 @@ public boolean isAutoRegisterHooks() {
348350
@NonNull
349351
public String getCheckoutCredentialsId() {
350352
for (SCMTrait<?> t : traits) {
351-
if (t instanceof SSHCheckoutTrait) {
352-
return StringUtils.defaultString(((SSHCheckoutTrait) t).getCredentialsId(), BitbucketSCMSource
353+
if (t instanceof SSHCheckoutTrait sshTrait) {
354+
return StringUtils.defaultString(sshTrait.getCredentialsId(), BitbucketSCMSource
353355
.DescriptorImpl.ANONYMOUS);
354356
}
355357
}
@@ -361,7 +363,7 @@ public String getCheckoutCredentialsId() {
361363
@RestrictedSince("2.2.0")
362364
@DataBoundSetter
363365
public void setCheckoutCredentialsId(String checkoutCredentialsId) {
364-
traits.removeIf(trait -> trait instanceof SSHCheckoutTrait);
366+
traits.removeIf(SSHCheckoutTrait.class::isInstance);
365367
if (checkoutCredentialsId != null && !BitbucketSCMSource.DescriptorImpl.SAME.equals(checkoutCredentialsId)) {
366368
traits.add(new SSHCheckoutTrait(checkoutCredentialsId));
367369
}
@@ -372,8 +374,8 @@ public void setCheckoutCredentialsId(String checkoutCredentialsId) {
372374
@RestrictedSince("2.2.0")
373375
public String getPattern() {
374376
for (SCMTrait<?> trait : traits) {
375-
if (trait instanceof RegexSCMSourceFilterTrait) {
376-
return ((RegexSCMSourceFilterTrait) trait).getRegex();
377+
if (trait instanceof RegexSCMSourceFilterTrait regexTrait) {
378+
return regexTrait.getRegex();
377379
}
378380
}
379381
return ".*";
@@ -421,8 +423,8 @@ public String getEndpointJenkinsRootUrl() {
421423
@NonNull
422424
public String getIncludes() {
423425
for (SCMTrait<?> trait : traits) {
424-
if (trait instanceof WildcardSCMHeadFilterTrait) {
425-
return ((WildcardSCMHeadFilterTrait) trait).getIncludes();
426+
if (trait instanceof WildcardSCMHeadFilterTrait wildcardTrait) {
427+
return wildcardTrait.getIncludes();
426428
}
427429
}
428430
return "*";
@@ -435,12 +437,11 @@ public String getIncludes() {
435437
public void setIncludes(@NonNull String includes) {
436438
for (int i = 0; i < traits.size(); i++) {
437439
SCMTrait<?> trait = traits.get(i);
438-
if (trait instanceof WildcardSCMHeadFilterTrait) {
439-
WildcardSCMHeadFilterTrait existing = (WildcardSCMHeadFilterTrait) trait;
440-
if ("*".equals(includes) && "".equals(existing.getExcludes())) {
440+
if (trait instanceof WildcardSCMHeadFilterTrait wildcardTrait) {
441+
if ("*".equals(includes) && "".equals(wildcardTrait.getExcludes())) {
441442
traits.remove(i);
442443
} else {
443-
traits.set(i, new WildcardSCMHeadFilterTrait(includes, existing.getExcludes()));
444+
traits.set(i, new WildcardSCMHeadFilterTrait(includes, wildcardTrait.getExcludes()));
444445
}
445446
return;
446447
}
@@ -456,8 +457,8 @@ public void setIncludes(@NonNull String includes) {
456457
@NonNull
457458
public String getExcludes() {
458459
for (SCMTrait<?> trait : traits) {
459-
if (trait instanceof WildcardSCMHeadFilterTrait) {
460-
return ((WildcardSCMHeadFilterTrait) trait).getExcludes();
460+
if (trait instanceof WildcardSCMHeadFilterTrait wildcardTrait) {
461+
return wildcardTrait.getExcludes();
461462
}
462463
}
463464
return "";
@@ -470,12 +471,11 @@ public String getExcludes() {
470471
public void setExcludes(@NonNull String excludes) {
471472
for (int i = 0; i < traits.size(); i++) {
472473
SCMTrait<?> trait = traits.get(i);
473-
if (trait instanceof WildcardSCMHeadFilterTrait) {
474-
WildcardSCMHeadFilterTrait existing = (WildcardSCMHeadFilterTrait) trait;
475-
if ("*".equals(existing.getIncludes()) && "".equals(excludes)) {
474+
if (trait instanceof WildcardSCMHeadFilterTrait wildcardTrait) {
475+
if ("*".equals(wildcardTrait.getIncludes()) && "".equals(excludes)) {
476476
traits.remove(i);
477477
} else {
478-
traits.set(i, new WildcardSCMHeadFilterTrait(existing.getIncludes(), excludes));
478+
traits.set(i, new WildcardSCMHeadFilterTrait(wildcardTrait.getIncludes(), excludes));
479479
}
480480
return;
481481
}
@@ -569,37 +569,39 @@ public List<Action> retrieveActions(@NonNull SCMNavigatorOwner owner,
569569

570570
BitbucketAuthenticator authenticator = AuthenticationTokens.convert(BitbucketAuthenticator.authenticationContext(serverUrl), credentials);
571571

572-
BitbucketApi bitbucket = BitbucketApiFactory.newInstance(serverUrl, authenticator, repoOwner, null, null);
573-
BitbucketTeam team = bitbucket.getTeam();
574-
if (team != null) {
575-
String defaultTeamUrl;
576-
if (team instanceof BitbucketServerProject) {
577-
defaultTeamUrl = serverUrl + "/projects/" + team.getName();
572+
try (BitbucketApi client = BitbucketApiFactory.newInstance(serverUrl, authenticator, repoOwner, projectKey, null)) {
573+
BitbucketTeam team = client.getTeam();
574+
String avatarURL = null;
575+
String teamURL;
576+
String teamDisplayName;
577+
if (team != null) {
578+
if (showAvatar()) {
579+
avatarURL = team.getAvatar();
580+
}
581+
teamURL = team.getLink("html");
582+
teamDisplayName = StringUtils.defaultIfBlank(team.getDisplayName(), team.getName());
583+
if (StringUtils.isNotBlank(teamURL)) {
584+
if (team instanceof BitbucketCloudWorkspace wks) {
585+
teamURL = serverUrl + "/" + wks.getSlug();
586+
} else {
587+
teamURL = serverUrl + "/projects/" + team.getName();
588+
}
589+
}
590+
listener.getLogger().printf("Team: %s%n", HyperlinkNote.encodeTo(teamURL, teamDisplayName));
578591
} else {
579-
defaultTeamUrl = serverUrl + "/" + team.getName();
592+
teamURL = serverUrl + "/" + repoOwner;
593+
teamDisplayName = repoOwner;
594+
listener.getLogger().println("Could not resolve team details");
580595
}
581-
String teamUrl = StringUtils.defaultIfBlank(team.getLink("html"), defaultTeamUrl);
582-
String teamDisplayName = StringUtils.defaultIfBlank(team.getDisplayName(), team.getName());
583-
result.add(new ObjectMetadataAction(
584-
teamDisplayName,
585-
null,
586-
teamUrl
587-
));
588-
result.add(new BitbucketTeamMetadataAction(serverUrl, credentials, team.getName()));
589-
result.add(new BitbucketLink("icon-bitbucket-logo", teamUrl));
590-
listener.getLogger().printf("Team: %s%n", HyperlinkNote.encodeTo(teamUrl, teamDisplayName));
591-
} else {
592-
String teamUrl = serverUrl + "/" + repoOwner;
593-
result.add(new ObjectMetadataAction(
594-
repoOwner,
595-
null,
596-
teamUrl
597-
));
598-
result.add(new BitbucketTeamMetadataAction(null, null, null));
599-
result.add(new BitbucketLink("icon-bitbucket-logo", teamUrl));
600-
listener.getLogger().println("Could not resolve team details");
596+
result.add(new ObjectMetadataAction(teamDisplayName, null, teamURL));
597+
result.add(new BitbucketTeamAvatarMetadataAction(avatarURL, serverUrl, owner.getFullName(), credentialsId));
598+
result.add(new BitbucketLink("icon-bitbucket-logo", teamURL));
599+
return result;
601600
}
602-
return result;
601+
}
602+
603+
private boolean showAvatar() {
604+
return traits.stream().anyMatch(ShowBitbucketAvatarTrait.class::isInstance);
603605
}
604606

605607
@Symbol("bitbucket")
@@ -629,7 +631,6 @@ public String getIconClassName() {
629631
return "icon-bitbucket-scm-navigator";
630632
}
631633

632-
@SuppressWarnings("unchecked")
633634
@Override
634635
public SCMNavigator newInstance(String name) {
635636
BitbucketSCMNavigator instance = new BitbucketSCMNavigator(StringUtils.defaultString(name));
@@ -708,7 +709,7 @@ public List<NamedArrayList<? extends SCMTraitDescriptor<?>>> getTraitsDescriptor
708709
}
709710
}
710711
List<NamedArrayList<? extends SCMTraitDescriptor<?>>> result = new ArrayList<>();
711-
NamedArrayList.select(all, "Repositories", it -> it instanceof SCMNavigatorTraitDescriptor, true, result);
712+
NamedArrayList.select(all, "Repositories", SCMNavigatorTraitDescriptor.class::isInstance, true, result);
712713
NamedArrayList.select(all, "Within repository", NamedArrayList
713714
.anyOf(NamedArrayList.withAnnotation(Discovery.class),
714715
NamedArrayList.withAnnotation(Selection.class)),

‎src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSource.java

+26-31
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
import com.cloudbees.jenkins.plugins.bitbucket.endpoints.BitbucketEndpointConfiguration;
4444
import com.cloudbees.jenkins.plugins.bitbucket.endpoints.BitbucketServerEndpoint;
4545
import com.cloudbees.jenkins.plugins.bitbucket.hooks.HasPullRequests;
46+
import com.cloudbees.jenkins.plugins.bitbucket.impl.avatars.BitbucketRepoAvatarMetadataAction;
4647
import com.cloudbees.jenkins.plugins.bitbucket.impl.extension.BitbucketEnvVarExtension;
4748
import com.cloudbees.jenkins.plugins.bitbucket.impl.extension.GitClientAuthenticatorExtension;
4849
import com.cloudbees.jenkins.plugins.bitbucket.impl.util.BitbucketApiUtils;
@@ -53,6 +54,7 @@
5354
import com.cloudbees.jenkins.plugins.bitbucket.server.BitbucketServerWebhookImplementation;
5455
import com.cloudbees.jenkins.plugins.bitbucket.server.client.BitbucketServerAPIClient;
5556
import com.cloudbees.jenkins.plugins.bitbucket.server.client.repository.BitbucketServerRepository;
57+
import com.cloudbees.jenkins.plugins.bitbucket.trait.ShowBitbucketAvatarTrait;
5658
import com.cloudbees.plugins.credentials.CredentialsNameProvider;
5759
import com.cloudbees.plugins.credentials.common.StandardCredentials;
5860
import com.damnhandy.uri.template.UriTemplate;
@@ -65,12 +67,9 @@
6567
import hudson.RestrictedSince;
6668
import hudson.Util;
6769
import hudson.console.HyperlinkNote;
68-
import hudson.init.InitMilestone;
69-
import hudson.init.Initializer;
7070
import hudson.model.Action;
7171
import hudson.model.Actionable;
7272
import hudson.model.Item;
73-
import hudson.model.Items;
7473
import hudson.model.TaskListener;
7574
import hudson.plugins.git.GitSCM;
7675
import hudson.scm.SCM;
@@ -97,7 +96,6 @@
9796
import java.util.logging.Logger;
9897
import jenkins.authentication.tokens.api.AuthenticationTokens;
9998
import jenkins.model.Jenkins;
100-
import jenkins.plugins.git.MergeWithGitSCMExtension;
10199
import jenkins.plugins.git.traits.GitBrowserSCMSourceTrait;
102100
import jenkins.scm.api.SCMHead;
103101
import jenkins.scm.api.SCMHeadCategory;
@@ -152,14 +150,6 @@ public class BitbucketSCMSource extends SCMSource {
152150
private static final String CLOUD_REPO_TEMPLATE = "{/owner,repo}";
153151
private static final String SERVER_REPO_TEMPLATE = "/projects{/owner}/repos{/repo}";
154152

155-
/**
156-
* Mapping classes after refactoring for backward compatibility.
157-
*/
158-
@Initializer(before = InitMilestone.PLUGINS_STARTED)
159-
public static void aliases() {
160-
Items.XSTREAM2.addCompatibilityAlias("com.cloudbees.jenkins.plugins.bitbucket.MergeWithGitSCMExtension", MergeWithGitSCMExtension.class);
161-
}
162-
163153
/** How long to delay events received from Bitbucket in order to allow the API caches to sync. */
164154
private static /*mostly final*/ int eventDelaySeconds =
165155
Math.min(
@@ -1107,29 +1097,34 @@ protected List<Action> retrieveActions(@CheckForNull SCMSourceEvent event,
11071097
throws IOException, InterruptedException {
11081098
// TODO when we have support for trusted events, use the details from event if event was from trusted source
11091099
List<Action> result = new ArrayList<>();
1110-
final BitbucketApi bitbucket = buildBitbucketClient();
1111-
gatherPrimaryCloneLinks(bitbucket);
1112-
BitbucketRepository r = bitbucket.getRepository();
1113-
result.add(new BitbucketRepoMetadataAction(r));
1114-
String defaultBranch = bitbucket.getDefaultBranch();
1115-
if (StringUtils.isNotBlank(defaultBranch)) {
1116-
result.add(new BitbucketDefaultBranch(repoOwner, repository, defaultBranch));
1100+
try (BitbucketApi bitbucket = buildBitbucketClient()) {
1101+
gatherPrimaryCloneLinks(bitbucket);
1102+
BitbucketRepository repo = bitbucket.getRepository();
1103+
result.add(new BitbucketRepoAvatarMetadataAction(showAvatar() ? repo : null));
1104+
String defaultBranch = bitbucket.getDefaultBranch();
1105+
if (StringUtils.isNotBlank(defaultBranch)) {
1106+
result.add(new BitbucketDefaultBranch(repoOwner, repository, defaultBranch));
1107+
}
1108+
UriTemplate template;
1109+
if (BitbucketApiUtils.isCloud(getServerUrl())) {
1110+
template = UriTemplate.fromTemplate(getServerUrl() + CLOUD_REPO_TEMPLATE);
1111+
} else {
1112+
template = UriTemplate.fromTemplate(getServerUrl() + SERVER_REPO_TEMPLATE);
1113+
}
1114+
String url = template
1115+
.set("owner", repoOwner)
1116+
.set("repo", repository)
1117+
.expand();
1118+
result.add(new BitbucketLink("icon-bitbucket-repo", url));
1119+
result.add(new ObjectMetadataAction(repo.getRepositoryName(), null, url));
11171120
}
1118-
UriTemplate template;
1119-
if (BitbucketApiUtils.isCloud(getServerUrl())) {
1120-
template = UriTemplate.fromTemplate(getServerUrl() + CLOUD_REPO_TEMPLATE);
1121-
} else {
1122-
template = UriTemplate.fromTemplate(getServerUrl() + SERVER_REPO_TEMPLATE);
1123-
}
1124-
String url = template
1125-
.set("owner", repoOwner)
1126-
.set("repo", repository)
1127-
.expand();
1128-
result.add(new BitbucketLink("icon-bitbucket-repo", url));
1129-
result.add(new ObjectMetadataAction(r.getRepositoryName(), null, url));
11301121
return result;
11311122
}
11321123

1124+
private boolean showAvatar() {
1125+
return traits.stream().anyMatch(ShowBitbucketAvatarTrait.class::isInstance);
1126+
}
1127+
11331128
@NonNull
11341129
@Override
11351130
protected List<Action> retrieveActions(@NonNull SCMHead head,

‎src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSourceRequest.java

+9-10
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,6 @@ public class BitbucketSCMSourceRequest extends SCMSourceRequest {
114114
*/
115115
@CheckForNull
116116
private Iterable<BitbucketBranch> branches;
117-
// TODO private Iterable<BitbucketTag> tags;
118117
/**
119118
* The BitbucketApi that is used for the request.
120119
*/
@@ -164,13 +163,13 @@ protected BitbucketSCMSourceRequest(@NonNull final BitbucketSCMSource source,
164163
for (SCMHead h : includes) {
165164
if (h instanceof BranchSCMHead) {
166165
branchNames.add(h.getName());
167-
} else if (h instanceof PullRequestSCMHead) {
168-
pullRequestNumbers.add(((PullRequestSCMHead) h).getId());
166+
} else if (h instanceof PullRequestSCMHead prHead) {
167+
pullRequestNumbers.add(prHead.getId());
169168
if (SCMHeadOrigin.DEFAULT.equals(h.getOrigin())) {
170-
branchNames.add(((PullRequestSCMHead) h).getOriginName());
169+
branchNames.add(prHead.getOriginName());
171170
}
172-
if (((PullRequestSCMHead) h).getCheckoutStrategy() == ChangeRequestCheckoutStrategy.MERGE) {
173-
branchNames.add(((PullRequestSCMHead) h).getTarget().getName());
171+
if (prHead.getCheckoutStrategy() == ChangeRequestCheckoutStrategy.MERGE) {
172+
branchNames.add(prHead.getTarget().getName());
174173
}
175174
} else if (h instanceof BitbucketTagSCMHead) {
176175
tagNames.add(h.getName());
@@ -431,11 +430,11 @@ public final Iterable<BitbucketBranch> getTags() {
431430
*/
432431
@Override
433432
public void close() throws IOException {
434-
if (pullRequests instanceof Closeable) {
435-
((Closeable) pullRequests).close();
433+
if (pullRequests instanceof Closeable closable) {
434+
closable.close();
436435
}
437-
if (branches instanceof Closeable) {
438-
((Closeable) branches).close();
436+
if (branches instanceof Closeable closable) {
437+
closable.close();
439438
}
440439
super.close();
441440
}

0 commit comments

Comments
 (0)