Reformat declarative pipeline (#344)

* added symbol annotations for easier naming in pipeline

* added test and example for declarative pipeline

src/main/java/io/jenkins/plugins/bitbucketpushandpullrequest/filter/pullrequest/cloud/BitBucketPPRPullRequestApprovedActionFilter.java

@@ -1,32 +1,32 @@
 /*******************************************************************************
  * The MIT License
- * 
+ *
  * Copyright (C) 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 io.jenkins.plugins.bitbucketpushandpullrequest.filter.pullrequest.cloud;
 
 import static io.jenkins.plugins.bitbucketpushandpullrequest.common.BitBucketPPRConst.PULL_REQUEST_REVIEWER;
 import java.io.File;
 import java.io.IOException;
 import java.util.logging.Logger;
 
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.DataBoundSetter;
 
@@ -37,7 +37,6 @@
 import io.jenkins.plugins.bitbucketpushandpullrequest.model.BitBucketPPRHookEvent;
 import io.jenkins.plugins.bitbucketpushandpullrequest.model.cloud.BitBucketPPRParticipant;
 
-
 public class BitBucketPPRPullRequestApprovedActionFilter
     extends BitBucketPPRPullRequestActionFilter {
   private static final Logger logger =
@@ -71,8 +70,8 @@ public boolean shouldTriggerBuild(BitBucketPPRAction bitbucketAction) {
   }
 
   @Override
-  public BitBucketPPRTriggerCause getCause(File pollingLog, BitBucketPPRAction pullRequestAction, 
-      BitBucketPPRHookEvent bitBucketEvent)
+  public BitBucketPPRTriggerCause getCause(
+      File pollingLog, BitBucketPPRAction pullRequestAction, BitBucketPPRHookEvent bitBucketEvent)
       throws IOException {
     return new BitBucketPPRPullRequestApprovedCause(pollingLog, pullRequestAction, bitBucketEvent);
   }
@@ -81,12 +80,13 @@ public BitBucketPPRTriggerCause getCause(File pollingLog, BitBucketPPRAction pul
   public boolean shouldSendApprove() {
     return false;
   }
-  
+
   @Override
   public boolean shouldSendDecline() {
     return false;
   }
 
+  @Symbol("bitbucketCloudPullRequestApproved")
   @Extension
   public static class ActionFilterDescriptorImpl extends BitBucketPPRPullRequestActionDescriptor {
 
@@ -102,7 +102,9 @@ public boolean getTriggerOnlyIfAllReviewersApproved() {
 
   private boolean allReviewersHaveApproved(BitBucketPPRAction pullRequestAction) {
     return pullRequestAction.getPayload().getPullRequest().getParticipants().stream()
-        .filter(p -> isReviewer(p) && !p.getApproved()).count() == 0;
+            .filter(p -> isReviewer(p) && !p.getApproved())
+            .count()
+        == 0;
   }
 
   private boolean isReviewer(BitBucketPPRParticipant pullRequestParticipant) {

src/main/java/io/jenkins/plugins/bitbucketpushandpullrequest/filter/pullrequest/cloud/BitBucketPPRPullRequestCommentCreatedActionFilter.java

@@ -24,6 +24,7 @@
 import java.io.File;
 import java.io.IOException;
 
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.DataBoundSetter;
 
@@ -64,22 +65,23 @@ public void setCommentFilter(String commentFilter) {
 
   @Override
   public boolean shouldTriggerBuild(BitBucketPPRAction bitbucketAction) {
-    return matches(allowedBranches, bitbucketAction.getTargetBranch(), null) &&
-        hasInComment(bitbucketAction.getComment(), null);
-    }
+    return matches(allowedBranches, bitbucketAction.getTargetBranch(), null)
+        && hasInComment(bitbucketAction.getComment(), null);
+  }
 
   @Override
-  public BitBucketPPRTriggerCause getCause(File pollingLog, BitBucketPPRAction pullRequestAction, 
-      BitBucketPPRHookEvent bitBucketEvent)
+  public BitBucketPPRTriggerCause getCause(
+      File pollingLog, BitBucketPPRAction pullRequestAction, BitBucketPPRHookEvent bitBucketEvent)
       throws IOException {
-    return new BitBucketPPRPullRequestCommentCreatedCause(pollingLog, pullRequestAction, bitBucketEvent);
+    return new BitBucketPPRPullRequestCommentCreatedCause(
+        pollingLog, pullRequestAction, bitBucketEvent);
   }
 
   @Override
   public boolean shouldSendApprove() {
     return false;
   }
-  
+
   @Override
   public boolean shouldSendDecline() {
     return false;
@@ -89,6 +91,7 @@ public boolean hasInComment(String comment, EnvVars vars) {
     return BitBucketPPRUtils.matchWithRegex(comment, commentFilter, vars);
   }
 
+  @Symbol("bitbucketCloudPullRequestCommentCreated")
   @Extension
   public static class ActionFilterDescriptorImpl extends BitBucketPPRPullRequestActionDescriptor {
 
@@ -100,8 +103,14 @@ public String getDisplayName() {
 
   @Override
   public String toString() {
-    return "BitBucketPPRPullRequestCommentCreatedActionFilter [getDescriptor()=" + getDescriptor()
-        + ", getClass()=" + getClass() + ", hashCode()=" + hashCode() + ", toString()="
-        + super.toString() + "]";
+    return "BitBucketPPRPullRequestCommentCreatedActionFilter [getDescriptor()="
+        + getDescriptor()
+        + ", getClass()="
+        + getClass()
+        + ", hashCode()="
+        + hashCode()
+        + ", toString()="
+        + super.toString()
+        + "]";
   }
 }

src/main/java/io/jenkins/plugins/bitbucketpushandpullrequest/filter/pullrequest/cloud/BitBucketPPRPullRequestCommentDeletedActionFilter.java

@@ -24,6 +24,7 @@
 import java.io.File;
 import java.io.IOException;
 
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.DataBoundSetter;
 
@@ -56,22 +57,24 @@ public boolean shouldTriggerBuild(BitBucketPPRAction bitbucketAction) {
   }
 
   @Override
-  public BitBucketPPRTriggerCause getCause(File pollingLog, BitBucketPPRAction pullRequestAction, 
-      BitBucketPPRHookEvent bitBucketEvent)
+  public BitBucketPPRTriggerCause getCause(
+      File pollingLog, BitBucketPPRAction pullRequestAction, BitBucketPPRHookEvent bitBucketEvent)
       throws IOException {
-    return new BitBucketPPRPullRequestCommentDeletedCause(pollingLog, pullRequestAction, bitBucketEvent);
+    return new BitBucketPPRPullRequestCommentDeletedCause(
+        pollingLog, pullRequestAction, bitBucketEvent);
   }
 
   @Override
   public boolean shouldSendApprove() {
     return false;
   }
-  
+
   @Override
   public boolean shouldSendDecline() {
     return false;
   }
 
+  @Symbol("bitbucketCloudPullRequestCommentDeletedActionFilter")
   @Extension
   public static class ActionFilterDescriptorImpl extends BitBucketPPRPullRequestActionDescriptor {
 
@@ -83,8 +86,14 @@ public String getDisplayName() {
 
   @Override
   public String toString() {
-    return "BitBucketPPRPullRequestCommentDeletedActionFilter [getDescriptor()=" + getDescriptor()
-        + ", getClass()=" + getClass() + ", hashCode()=" + hashCode() + ", toString()="
-        + super.toString() + "]";
+    return "BitBucketPPRPullRequestCommentDeletedActionFilter [getDescriptor()="
+        + getDescriptor()
+        + ", getClass()="
+        + getClass()
+        + ", hashCode()="
+        + hashCode()
+        + ", toString()="
+        + super.toString()
+        + "]";
   }
 }

src/main/java/io/jenkins/plugins/bitbucketpushandpullrequest/filter/pullrequest/cloud/BitBucketPPRPullRequestCommentUpdatedActionFilter.java

@@ -24,6 +24,7 @@
 import java.io.File;
 import java.io.IOException;
 
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.DataBoundSetter;
 
@@ -69,17 +70,18 @@ public boolean shouldTriggerBuild(BitBucketPPRAction bitbucketAction) {
   }
 
   @Override
-  public BitBucketPPRTriggerCause getCause(File pollingLog, BitBucketPPRAction pullRequestAction, 
-      BitBucketPPRHookEvent bitBucketEvent)
+  public BitBucketPPRTriggerCause getCause(
+      File pollingLog, BitBucketPPRAction pullRequestAction, BitBucketPPRHookEvent bitBucketEvent)
       throws IOException {
-    return new BitBucketPPRPullRequestCommentUpdatedCause(pollingLog, pullRequestAction, bitBucketEvent);
+    return new BitBucketPPRPullRequestCommentUpdatedCause(
+        pollingLog, pullRequestAction, bitBucketEvent);
   }
 
   @Override
   public boolean shouldSendApprove() {
     return false;
   }
-  
+
   @Override
   public boolean shouldSendDecline() {
     return false;
@@ -89,6 +91,7 @@ public boolean hasInComment(String comment, EnvVars vars) {
     return BitBucketPPRUtils.matchWithRegex(comment, commentFilter, vars);
   }
 
+  @Symbol("bitbucketCloudPullRequestCommentUpdated")
   @Extension
   public static class ActionFilterDescriptorImpl extends BitBucketPPRPullRequestActionDescriptor {
 
@@ -100,8 +103,14 @@ public String getDisplayName() {
 
   @Override
   public String toString() {
-    return "BitBucketPPRPullRequestCommentUpdatedActionFilter [getDescriptor()=" + getDescriptor()
-        + ", getClass()=" + getClass() + ", hashCode()=" + hashCode() + ", toString()="
-        + super.toString() + "]";
+    return "BitBucketPPRPullRequestCommentUpdatedActionFilter [getDescriptor()="
+        + getDescriptor()
+        + ", getClass()="
+        + getClass()
+        + ", hashCode()="
+        + hashCode()
+        + ", toString()="
+        + super.toString()
+        + "]";
   }
 }

src/main/java/io/jenkins/plugins/bitbucketpushandpullrequest/filter/pullrequest/cloud/BitBucketPPRPullRequestCreatedActionFilter.java

@@ -1,17 +1,17 @@
 /*******************************************************************************
  * The MIT License
- * 
+ *
  * Copyright (C) 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,
@@ -24,6 +24,7 @@
 import java.io.File;
 import java.io.IOException;
 
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.DataBoundSetter;
 
@@ -56,7 +57,7 @@ public void setAllowedBranches(String allowedBranches) {
   public void setIsToApprove(boolean isToApprove) {
     this.isToApprove = isToApprove;
   }
-  
+
   @DataBoundSetter
   public void setIsToDecline(boolean isToDecline) {
     this.isToDecline = isToDecline;
@@ -68,8 +69,8 @@ public boolean shouldTriggerBuild(BitBucketPPRAction bitbucketAction) {
   }
 
   @Override
-  public BitBucketPPRTriggerCause getCause(File pollingLog, BitBucketPPRAction pullRequestAction, 
-      BitBucketPPRHookEvent bitBucketEvent)
+  public BitBucketPPRTriggerCause getCause(
+      File pollingLog, BitBucketPPRAction pullRequestAction, BitBucketPPRHookEvent bitBucketEvent)
       throws IOException {
     return new BitBucketPPRPullRequestCreatedCause(pollingLog, pullRequestAction, bitBucketEvent);
   }
@@ -78,12 +79,13 @@ public BitBucketPPRTriggerCause getCause(File pollingLog, BitBucketPPRAction pul
   public boolean shouldSendApprove() {
     return isToApprove;
   }
-  
+
   @Override
   public boolean shouldSendDecline() {
     return isToDecline;
   }
 
+  @Symbol("bitbucketCloudPullRequestCreatedActionFilter")
   @Extension
   public static class ActionFilterDescriptorImpl extends BitBucketPPRPullRequestActionDescriptor {
 
@@ -95,8 +97,14 @@ public String getDisplayName() {
 
   @Override
   public String toString() {
-    return "BitBucketPPRPullRequestCreatedActionFilter [getDescriptor()=" + getDescriptor()
-        + ", getClass()=" + getClass() + ", hashCode()=" + hashCode() + ", toString()="
-        + super.toString() + "]";
+    return "BitBucketPPRPullRequestCreatedActionFilter [getDescriptor()="
+        + getDescriptor()
+        + ", getClass()="
+        + getClass()
+        + ", hashCode()="
+        + hashCode()
+        + ", toString()="
+        + super.toString()
+        + "]";
   }
 }