[JENKINS-75534] DiscardOldBranch trait uses AuthorDate of HEAD commit to determine branch age rather than CommitDate (#1021)

Change authorTimestamp to committerTimestamp for Bitbucket DataCenter commit details to reflect the same date that Bitbucket Cloud send in the commit details.
Improve help of DiscardOldTagTrait

Author: nfalco79

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/client/branch/BitbucketServerCommit.java

@@ -48,7 +48,7 @@ public class BitbucketServerCommit implements BitbucketCommit {
     @JsonCreator
     public BitbucketServerCommit(@NonNull @JsonProperty("message") String message, //
                                  @NonNull @JsonProperty("id") String hash, //
-                                 @NonNull @JsonProperty("authorTimestamp") long dateMillis, //
+                                 @NonNull @JsonProperty("committerTimestamp") long dateMillis, //
                                  @Nullable @JsonProperty("author") BitbucketServerAuthor author) {
         // date it is not in the payload
         this(message, hash, dateMillis, author != null ? MessageFormat.format(GIT_COMMIT_AUTHOR, author.getName(), author.getEmail()) : null);

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/trait/DiscardOldBranchTrait.java

@@ -67,10 +67,16 @@ public int getKeepForDays() {
 
     @Override
     protected void decorateContext(SCMSourceContext<?, ?> context) {
-        context.withFilter(new ExcludeOldSCMHeadBranch());
+        context.withFilter(new ExcludeOldSCMHeadBranch(keepForDays));
     }
 
-    public final class ExcludeOldSCMHeadBranch extends SCMHeadFilter {
+    public static final class ExcludeOldSCMHeadBranch extends SCMHeadFilter {
+        private int keepForDays;
+
+        public ExcludeOldSCMHeadBranch(int keepForDays) {
+            this.keepForDays = keepForDays;
+        }
+
         @Override
         public boolean isExcluded(SCMSourceRequest request, SCMHead head) throws IOException, InterruptedException {
             if (keepForDays > 0) {

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/trait/DiscardOldTagTrait.java

@@ -29,7 +29,7 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 import hudson.Extension;
 import hudson.util.FormValidation;
-import java.util.concurrent.TimeUnit;
+import java.time.LocalDate;
 import jenkins.scm.api.SCMHead;
 import jenkins.scm.api.SCMSource;
 import jenkins.scm.api.mixin.TagSCMHead;
@@ -70,21 +70,28 @@ protected void decorateContext(SCMSourceContext<?, ?> context) {
 
     public static final class ExcludeOldSCMTag extends SCMHeadPrefilter {
 
-        private final long expiryMs;
+        private final int keepForDays;
 
         public ExcludeOldSCMTag(int keepForDays) {
-            this.expiryMs = System.currentTimeMillis() - TimeUnit.DAYS.toMillis(keepForDays);
+            this.keepForDays = keepForDays;
         }
 
         @Override
         public boolean isExcluded(@NonNull SCMSource source, @NonNull SCMHead head) {
-            if (!(head instanceof TagSCMHead tagHead)) {
+            if (!(head instanceof TagSCMHead tagHead) || tagHead.getTimestamp() == 0) {
+                // it's not a tag or can not resolve tag commit timestamp
                 return false;
             }
-            long tagTimestamp = tagHead.getTimestamp();
-            return tagTimestamp > 0 && tagTimestamp < expiryMs;
+
+            LocalDate commitDate = asLocalDate(tagHead.getTimestamp());
+            LocalDate expiryDate = LocalDate.now().minusDays(keepForDays);
+            return commitDate.isBefore(expiryDate);
         }
 
+        @NonNull
+        private LocalDate asLocalDate(@NonNull long milliseconds) {
+            return new java.sql.Date(milliseconds).toLocalDate();
+        }
     }
 
     @Symbol("bitbucketDiscardOldTag")

src/main/resources/com/cloudbees/jenkins/plugins/bitbucket/trait/DiscardOldTagTrait/help-keepForDays.html

@@ -22,5 +22,6 @@
  - THE SOFTWARE.
  -->
 <div>
-    Number of days after the tag creation before it is discarded.
+    Number of days since the commit date referred by the tag before it is discarded.<br/>
+    (Note: Since Bitbucket does not provide API to gather annotated tag details there are not differences between tag and annotated one)
 </div>

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

@@ -53,7 +53,7 @@ static void init(JenkinsRule rule) {
         j = rule;
     }
 
-    private static Stream<Arguments> revisionData() {
+    private static Stream<Arguments> revisionDataProvider() {
         return Stream.of(Arguments.of("branch on cloud", new BranchDiscoveryTrait(true, true), BitbucketCloudEndpoint.SERVER_URL), //
                 Arguments.of("branch on server", new BranchDiscoveryTrait(true, true), "localhost"), //
                 Arguments.of("PR on cloud", new OriginPullRequestDiscoveryTrait(2), BitbucketCloudEndpoint.SERVER_URL), //
@@ -66,7 +66,7 @@ private static Stream<Arguments> revisionData() {
     }
 
     @ParameterizedTest(name = "verify revision informations from {0}")
-    @MethodSource("revisionData")
+    @MethodSource("revisionDataProvider")
     void verify_revision_informations_are_valued(String testName, SCMSourceTrait trait, String serverURL) throws Exception {
         BitbucketMockApiFactory.add(serverURL, getApiMockClient(serverURL));
         BitbucketSCMSource source = new BitbucketSCMSource("amuniz", "test-repos");

src/test/java/com/cloudbees/jenkins/plugins/bitbucket/trait/DiscardOldTagTraitTest.java

@@ -34,7 +34,6 @@
 import jenkins.scm.api.trait.SCMHeadPrefilter;
 import jenkins.scm.impl.NullSCMSource;
 import org.apache.commons.lang3.time.DateUtils;
-import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.Arguments;
 import org.junit.jupiter.params.provider.MethodSource;
@@ -43,41 +42,25 @@
 
 class DiscardOldTagTraitTest {
 
-    static Stream<Arguments> verify_that_tag_is_not_excluded_args() {
+    static Stream<Arguments> tagSCMHeadProvider() {
         return Stream.of(
-            Arguments.argumentSet("too_recent",
-                new BitbucketTagSCMHead("tag/1234", DateUtils.addDays(new Date(), -4).getTime())),
-            Arguments.argumentSet("no_timestamp", new BitbucketTagSCMHead("tag/zer0", 0L)),
-            Arguments.argumentSet("not_a_tag", new BranchSCMHead("someBranch"))
+            Arguments.argumentSet("expired", new BitbucketTagSCMHead("tag/1234", DateUtils.addDays(new Date(), -6).getTime()), true),
+            Arguments.argumentSet("too_recent", new BitbucketTagSCMHead("tag/1234", DateUtils.addDays(new Date(), -4).getTime()), false),
+            Arguments.argumentSet("no_timestamp", new BitbucketTagSCMHead("tag/zer0", 0L), false),
+            Arguments.argumentSet("not_a_tag", new BranchSCMHead("someBranch"), false)
         );
     }
 
     @ParameterizedTest
-    @MethodSource("verify_that_tag_is_not_excluded_args")
-    void verify_that_tag_is_not_excluded(SCMHead head) {
+    @MethodSource("tagSCMHeadProvider")
+    void verify_that_tag_is_not_excluded(SCMHead head, boolean expectedResult) {
         DiscardOldTagTrait trait = new DiscardOldTagTrait(5);
         BitbucketSCMSourceContext ctx = new BitbucketSCMSourceContext(null, SCMHeadObserver.none());
         trait.decorateContext(ctx);
         assertThat(ctx.prefilters()).hasAtLeastOneElementOfType(ExcludeOldSCMTag.class);
 
         for (SCMHeadPrefilter filter : ctx.prefilters()) {
-            assertThat(filter.isExcluded(new NullSCMSource(), head)).isFalse();
-        }
-    }
-
-    @Test
-    void verify_that_tag_is_excluded_if_expired() {
-        DiscardOldTagTrait trait = new DiscardOldTagTrait(5);
-        BitbucketSCMSourceContext ctx = new BitbucketSCMSourceContext(null, SCMHeadObserver.none());
-        trait.decorateContext(ctx);
-        assertThat(ctx.prefilters()).hasAtLeastOneElementOfType(ExcludeOldSCMTag.class);
-
-        Date now = new Date();
-
-        BitbucketTagSCMHead head = new BitbucketTagSCMHead("tag/1234", DateUtils.addDays(now, -6).getTime());
-
-        for (SCMHeadPrefilter filter : ctx.prefilters()) {
-            assertThat(filter.isExcluded(new NullSCMSource(), head)).isTrue();
+            assertThat(filter.isExcluded(new NullSCMSource(), head)).isEqualTo(expectedResult);
         }
     }