[JENKINS-43507] Migrate Bitbucket Plugin to Traits #53
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,158 +25,124 @@ | |
|
|
||
| import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketApi; | ||
| import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketBuildStatus; | ||
| import edu.umd.cs.findbugs.annotations.NonNull; | ||
| import hudson.Extension; | ||
| import hudson.FilePath; | ||
| import hudson.model.Result; | ||
| import hudson.model.Run; | ||
| import hudson.model.TaskListener; | ||
| import hudson.model.listeners.RunListener; | ||
| import hudson.model.listeners.SCMListener; | ||
| import hudson.plugins.mercurial.MercurialSCMSource; | ||
| import hudson.scm.SCM; | ||
| import hudson.scm.SCMRevisionState; | ||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import javax.annotation.CheckForNull; | ||
| import jenkins.plugins.git.AbstractGitSCMSource; | ||
| import jenkins.scm.api.SCMHeadObserver; | ||
| import jenkins.scm.api.SCMRevision; | ||
| import jenkins.scm.api.SCMRevisionAction; | ||
| import jenkins.scm.api.SCMSource; | ||
| import org.jenkinsci.plugins.displayurlapi.DisplayURLProvider; | ||
|
|
||
| /** | ||
| * This class encapsulates all Bitbucket notifications logic. | ||
| * {@link JobCompletedListener} sends a notification to Bitbucket after a build finishes. | ||
| * Only builds derived from a job that was created as part of a multi branch project will be processed by this listener. | ||
| */ | ||
| public class BitbucketBuildStatusNotifications { | ||
|
|
||
| private static void createStatus(@NonNull Run<?, ?> build, @NonNull TaskListener listener, | ||
| @NonNull BitbucketApi bitbucket, @NonNull String hash) | ||
| throws IOException, InterruptedException { | ||
| String url; | ||
| try { | ||
| url = DisplayURLProvider.get().getRunURL(build); | ||
| } catch (IllegalStateException e) { | ||
| listener.getLogger().println( | ||
| "Can not determine Jenkins root URL. Commit status notifications are disabled until a root URL is" | ||
| + " configured in Jenkins global configuration."); | ||
| return; | ||
| } | ||
| String key = build.getParent().getFullName(); // use the job full name as the key for the status | ||
| String name = build.getDisplayName(); // use the build number as the display name of the status | ||
| BitbucketBuildStatus status; | ||
| Result result = build.getResult(); | ||
| if (Result.SUCCESS.equals(result)) { | ||
| status = new BitbucketBuildStatus(hash, "This commit looks good", "SUCCESSFUL", url, key, name); | ||
| } else if (Result.UNSTABLE.equals(result)) { | ||
| status = new BitbucketBuildStatus(hash, "This commit has test failures", "FAILED", url, key, name); | ||
| } else if (Result.FAILURE.equals(result)) { | ||
| status = new BitbucketBuildStatus(hash, "There was a failure building this commit", "FAILED", url, key, | ||
| name); | ||
| } else if (result != null) { // ABORTED etc. | ||
| status = new BitbucketBuildStatus(hash, "Something is wrong with the build of this commit", "FAILED", url, | ||
| key, name); | ||
| } else { | ||
| status = new BitbucketBuildStatus(hash, "The tests have started...", "INPROGRESS", url, key, name); | ||
| } | ||
| new BitbucketChangesetCommentNotifier(bitbucket).buildStatus(status); | ||
| if (result != null) { | ||
| listener.getLogger().println("[Bitbucket] Build result notified"); | ||
| } | ||
| } | ||
|
|
||
| private static void sendNotifications(Run<?, ?> build, TaskListener listener) | ||
| throws IOException, InterruptedException { | ||
| final SCMSource s = SCMSource.SourceByItem.findSource(build.getParent()); | ||
| if (!(s instanceof BitbucketSCMSource)) { | ||
| return; | ||
| } | ||
| BitbucketSCMSource source = (BitbucketSCMSource) s; | ||
| if (new BitbucketSCMSourceContext(null, SCMHeadObserver.none()) | ||
| .withTraits(source.getTraits()) | ||
| .notificationsDisabled()) { | ||
|
There was a problem hiding this comment. I guess I'll find a notification trait later in the review... There was a problem hiding this comment. Nope. I do not see the value in there being a notification disabling trait in the core plugin. But if somebody wants to write such a trait in an extension plugin they need this to disable the notifications... given that there are a number of people seeking just that I thought it worth the minor YAGNI to add this |
||
| return; | ||
| } | ||
| SCMRevision r = SCMRevisionAction.getRevision(build); // TODO JENKINS-44648 getRevision(s, build) | ||
| String hash = getHash(r); | ||
| if (hash == null) { | ||
| return; | ||
| } | ||
| if (r instanceof PullRequestSCMRevision) { | ||
| listener.getLogger().println("[Bitbucket] Notifying pull request build result"); | ||
| createStatus(build, listener, source.buildBitbucketClient((PullRequestSCMHead) r.getHead()), hash); | ||
|
|
||
| } else { | ||
| listener.getLogger().println("[Bitbucket] Notifying commit build result"); | ||
| createStatus(build, listener, source.buildBitbucketClient(), hash); | ||
| } | ||
| } | ||
|
|
||
| @CheckForNull | ||
| private static String getHash(@CheckForNull SCMRevision revision) { | ||
| if (revision instanceof PullRequestSCMRevision) { | ||
| // unwrap | ||
| revision = ((PullRequestSCMRevision) revision).getPull(); | ||
| } | ||
| if (revision instanceof MercurialSCMSource.MercurialRevision) { | ||
| return ((MercurialSCMSource.MercurialRevision) revision).getHash(); | ||
| } else if (revision instanceof AbstractGitSCMSource.SCMRevisionImpl) { | ||
| return ((AbstractGitSCMSource.SCMRevisionImpl) revision).getHash(); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
|
There was a problem hiding this comment. Diff on this class in horrible, difficult to follow changes, but I think it's ok. There was a problem hiding this comment. Part of the issue here is that it is actually also fixing bugs that I found during the refactoring... and then after I found them I noticed that others had raise JIRA issues for these bugs... and in some cases also PRs... e.g. #52 was a parallel fix to the fix I had developed here |
||
| /** | ||
| * Sends notifications to Bitbucket on Checkout (for the "In Progress" Status). | ||
| */ | ||
| @Extension | ||
| public static class JobCheckOutListener extends SCMListener { | ||
|
|
||
| @Override | ||
| public void onCheckout(Run<?, ?> build, SCM scm, FilePath workspace, TaskListener listener, File changelogFile, | ||
| SCMRevisionState pollingBaseline) throws Exception { | ||
| try { | ||
| sendNotifications(build, listener); | ||
| } catch (IOException | InterruptedException e) { | ||
| e.printStackTrace(listener.error("Could not send notifications")); | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't this be 2.2.0-SNAPSHOT to match what is in master?