Only add FirstCheckoutCompletedInvisibleAction if this build is using BitbucketSCMSource (#404)

* Only add FirstCheckoutCompletedInvisibleAction if this build is using BitbucketSCMSource

* Added test to verify that FirstCheckoutCompletedInvisibleAction is not added to unrelated builds

* Update BitbucketBuildStatusNotificationsTest.java

The IDE says this cast isn't needed, but it is.

* Fix imports

* Fix import order

Co-authored-by: Liam Newman <[email protected]>

Author: jglick

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketBuildStatusNotifications.java

@@ -147,19 +147,19 @@ private static void createStatus(@NonNull Run<?, ?> build, @NonNull TaskListener
         }
     }
 
-    private static void sendNotifications(Run<?, ?> build, TaskListener listener)
+    private static @CheckForNull BitbucketSCMSource findBitbucketSCMSource(Run<?, ?> build) {
+        SCMSource s = SCMSource.SourceByItem.findSource(build.getParent());
+        return s instanceof BitbucketSCMSource ? (BitbucketSCMSource) s : null;
+    }
+
+    private static void sendNotifications(BitbucketSCMSource source, Run<?, ?> build, TaskListener listener)
             throws IOException, InterruptedException {
-        final SCMSource s = SCMSource.SourceByItem.findSource(build.getParent());
-        if (!(s instanceof BitbucketSCMSource)) {
-            return;
-        }
-        BitbucketSCMSource source = (BitbucketSCMSource) s;
         BitbucketSCMSourceContext sourceContext = new BitbucketSCMSourceContext(null,
             SCMHeadObserver.none()).withTraits(source.getTraits());
         if (sourceContext.notificationsDisabled()) {
             return;
         }
-        SCMRevision r = SCMRevisionAction.getRevision(s, build);
+        SCMRevision r = SCMRevisionAction.getRevision(source, build);
         if (r == null) {
             return;
         }
@@ -230,6 +230,10 @@ public static class JobCheckOutListener extends SCMListener {
         @Override
         public void onCheckout(Run<?, ?> build, SCM scm, FilePath workspace, TaskListener listener, File changelogFile,
                                SCMRevisionState pollingBaseline) throws Exception {
+            BitbucketSCMSource source = findBitbucketSCMSource(build);
+            if (source == null) {
+                return;
+            }
 
             boolean hasCompletedCheckoutBefore =
                 build.getAction(FirstCheckoutCompletedInvisibleAction.class) != null;
@@ -238,7 +242,7 @@ public void onCheckout(Run<?, ?> build, SCM scm, FilePath workspace, TaskListene
                 build.addAction(new FirstCheckoutCompletedInvisibleAction());
 
                 try {
-                    sendNotifications(build, listener);
+                    sendNotifications(source, build, listener);
                 } catch (IOException | InterruptedException e) {
                     e.printStackTrace(listener.error("Could not send notifications"));
                 }
@@ -254,8 +258,13 @@ public static class JobCompletedListener extends RunListener<Run<?, ?>> {
 
         @Override
         public void onCompleted(Run<?, ?> build, TaskListener listener) {
+            BitbucketSCMSource source = findBitbucketSCMSource(build);
+            if (source == null) {
+                return;
+            }
+
             try {
-                sendNotifications(build, listener);
+                sendNotifications(source, build, listener);
             } catch (IOException | InterruptedException e) {
                 e.printStackTrace(listener.error("Could not send notifications"));
             }

src/test/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketBuildStatusNotificationsTest.java

@@ -0,0 +1,56 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2020 CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package com.cloudbees.jenkins.plugins.bitbucket;
+
+import hudson.model.Action;
+import hudson.model.FreeStyleBuild;
+import hudson.model.FreeStyleProject;
+import java.util.List;
+import org.junit.Rule;
+import org.junit.Test;
+import org.jvnet.hudson.test.JenkinsRule;
+import org.jvnet.hudson.test.SingleFileSCM;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.hasItem;
+import static org.hamcrest.Matchers.instanceOf;
+import static org.hamcrest.Matchers.not;
+
+public class BitbucketBuildStatusNotificationsTest {
+
+    @Rule
+    public JenkinsRule r = new JenkinsRule();
+
+    // TODO test of effectiveness of FirstCheckoutCompletedInvisibleAction (#130)
+
+    @Test
+    public void noInappropriateFirstCheckoutCompletedInvisibleAction() throws Exception {
+        FreeStyleProject p = r.createFreeStyleProject();
+        p.setScm(new SingleFileSCM("file", "contents"));
+        FreeStyleBuild b = r.buildAndAssertSuccess(p);
+        assertThat((List<Action>)b.getAllActions(), not(hasItem(instanceOf(FirstCheckoutCompletedInvisibleAction.class))));
+    }
+
+}