TW-84882: if collecting changes fails, still try to publish commit statuses to Space by using the unknown git SHA revision

TW-84882: add tests for fallback revision publishing

TW-84882: if collecting changes fails, still try to publish commit statuses to Space by using the unknown git SHA revision

(cherry picked from commit b370da8)


Merge-request: TC-MR-8046
Merged-by: Andreas Eisele <[email protected]>

Author: aeisele

commit-status-publisher-server/src/main/java/jetbrains/buildServer/commitPublisher/BaseCommitStatusPublisher.java

@@ -16,6 +16,8 @@
 
 package jetbrains.buildServer.commitPublisher;
 
+import java.util.Collection;
+import java.util.Collections;
 import java.util.Map;
 import jetbrains.buildServer.serverSide.*;
 import jetbrains.buildServer.users.User;
@@ -103,6 +105,12 @@ public void setConnectionTimeout(int timeout) {
     myConnectionTimeout = timeout;
   }
 
+  @NotNull
+  @Override
+  public Collection<BuildRevision> getFallbackRevisions() {
+    return Collections.emptyList();
+  }
+
   @Nullable
   public String getVcsRootId() {
     return myParams.get(Constants.VCS_ROOT_ID_PARAM);

commit-status-publisher-server/src/main/java/jetbrains/buildServer/commitPublisher/CommitStatusPublisher.java

@@ -16,6 +16,7 @@
 
 package jetbrains.buildServer.commitPublisher;
 
+import java.util.Collection;
 import jetbrains.buildServer.serverSide.*;
 import jetbrains.buildServer.users.User;
 import org.jetbrains.annotations.NotNull;
@@ -69,6 +70,17 @@ public interface CommitStatusPublisher {
 
   void setConnectionTimeout(int timeout);
 
+  /**
+   * Returns the <em>(VCS specific)</em> fallback revisions to be used if no {@link BuildRevision}s could be determined.
+   * <p>
+   * <em>Note:</em> Publishing statuses to an unknown / fallback revisions only makes sense in very limited use cases.
+   * Currently only {@link jetbrains.buildServer.commitPublisher.space.SpacePublisher} supports this.
+   * </p>
+   *
+   * @return empty collection if this publisher doesn't support fallback revisions
+   */
+  @NotNull
+  Collection<BuildRevision> getFallbackRevisions();
 
   enum Event {
     STARTED("buildStarted", EventPriority.FIRST, true), FINISHED("buildFinished", true),

commit-status-publisher-server/src/main/java/jetbrains/buildServer/commitPublisher/CommitStatusPublisherListener.java

@@ -645,7 +645,7 @@ private boolean shouldFailBuild(@NotNull SBuildType buildType) {
   private Collection<BuildRevision> getQueuedBuildRevisionForVote(@NotNull BuildType buildType,
                                                             @NotNull CommitStatusPublisher publisher,
                                                             @NotNull BuildPromotion buildPromotion) {
-    if (buildPromotion.isFailedToCollectChanges()) return Collections.emptyList();
+    if (buildPromotion.isFailedToCollectChanges()) return publisher.getFallbackRevisions();
 
     if (!((BuildPromotionEx)buildPromotion).isChangeCollectingNeeded(false)) {
       return getBuildRevisionForVote(publisher, buildPromotion.getRevisions());
@@ -819,7 +819,7 @@ public RetryInfo publish(Event event, BuildRevision revision, CommitStatusPublis
 
         @Override
         public Collection<BuildRevision> getRevisions(BuildType buildType, CommitStatusPublisher publisher) {
-          if (buildPromotion.isFailedToCollectChanges()) return Collections.emptyList();
+          if (buildPromotion.isFailedToCollectChanges()) return publisher.getFallbackRevisions();
           return getBuildRevisionForVote(publisher, build.getRevisions());
         }
       };

commit-status-publisher-server/src/main/java/jetbrains/buildServer/commitPublisher/space/SpacePublisher.java

@@ -29,6 +29,7 @@
 import jetbrains.buildServer.serverSide.oauth.space.SpaceConnectDescriber;
 import jetbrains.buildServer.util.StringUtil;
 import jetbrains.buildServer.vcs.VcsModification;
+import jetbrains.buildServer.vcs.VcsRootInstance;
 import jetbrains.buildServer.vcshostings.http.HttpHelper;
 import org.apache.http.HttpHeaders;
 import org.apache.http.entity.ContentType;
@@ -39,6 +40,7 @@
 
 public class SpacePublisher extends HttpBasedCommitStatusPublisher<SpaceBuildStatus> {
   private static final String UNKNOWN_BUILD_CONFIGURATION = "Unknown build configuration";
+  private static final String UNKNWON_GIT_SHA = "0000000000000000000000000000000000000000";
 
   private final SpaceConnectDescriber mySpaceConnector;
   private final Gson myGson = new Gson();
@@ -366,4 +368,23 @@ public void processResponse(HttpHelper.HttpResponse response) throws HttpPublish
       throw new HttpPublisherException(statusCode, response.getStatusText(), "HTTP response error: " + (responseContent != null ? responseContent : "<empty>"));
     }
   }
+
+  /**
+   * Returns the <em>"unknown git SHA"</em> revision.
+   * This revision can serve as a fallback.
+   * Space is able to match safe-merge statuses by build ID.
+   * See: TW-84882
+   *
+   * @return singleton collection of an artificial build revision pointing to {@link #UNKNWON_GIT_SHA}
+   */
+  @NotNull
+  @Override
+  public Collection<BuildRevision> getFallbackRevisions() {
+    final List<VcsRootInstance> vcsRootInstances = myBuildType.getVcsRootInstances();
+    if (vcsRootInstances.isEmpty()) {
+      LOG.warn("unable to construct fallback build revision for Space build " + LogUtil.describe(myBuildType) + ": no VCS root instances found");
+      return super.getFallbackRevisions();
+    }
+    return Collections.singletonList(new BuildRevision(vcsRootInstances.get(0), UNKNWON_GIT_SHA, "", UNKNWON_GIT_SHA));
+  }
 }

commit-status-publisher-server/src/test/java/jetbrains/buildServer/commitPublisher/CommitStatusPublisherListenerTest.java

@@ -30,6 +30,7 @@
 import jetbrains.buildServer.serverSide.executors.ExecutorServices;
 import jetbrains.buildServer.serverSide.impl.BuildTypeImpl;
 import jetbrains.buildServer.serverSide.impl.CancelableTaskHolder;
+import jetbrains.buildServer.serverSide.impl.MockVcsSupport;
 import jetbrains.buildServer.serverSide.impl.RunningBuildState;
 import jetbrains.buildServer.serverSide.impl.beans.VcsRootInstanceContext;
 import jetbrains.buildServer.serverSide.impl.projects.ProjectsWatcher;
@@ -39,10 +40,7 @@
 import jetbrains.buildServer.serverSide.systemProblems.SystemProblemEntry;
 import jetbrains.buildServer.users.SUser;
 import jetbrains.buildServer.users.UserModel;
-import jetbrains.buildServer.util.Dates;
-import jetbrains.buildServer.util.DependencyOptionSupportImpl;
-import jetbrains.buildServer.util.FileUtil;
-import jetbrains.buildServer.util.TestFor;
+import jetbrains.buildServer.util.*;
 import jetbrains.buildServer.util.http.HttpMethod;
 import jetbrains.buildServer.vcs.*;
 import jetbrains.buildServer.vcs.impl.VcsRootInstanceImpl;
@@ -934,6 +932,41 @@ public void should_not_publish_featureless_for_dependency_builds() {
     then(myPublisher.getEventsReceived()).isEmpty();
   }
 
+  @TestFor(issues = "TW-84882")
+  public void should_not_publish_when_collecting_changes_fails() {
+    addBadVcsRootTo(myBuildType);
+    final SQueuedBuild queuedBuild = myBuildType.addToQueue("");
+    assertNotNull(queuedBuild);
+    myServer.flushQueue();
+
+    waitFor(() -> {
+      SBuild build = queuedBuild.getBuildPromotion().getAssociatedBuild();
+      return build != null && build.isFinished();
+    });
+
+    waitForTasksToFinish(Event.FINISHED);
+    then(myPublisher.getEventsReceived()).isEqualTo(Collections.emptyList());
+  }
+
+  @TestFor(issues = "TW-84882")
+  public void should_publish_to_fallback_when_collecting_changes_fails() {
+    addBadVcsRootTo(myBuildType);
+    final VcsRootInstance vcsRootInstance = myBuildType.getVcsRootInstances().iterator().next();
+    final BuildRevision fallback = new BuildRevision(vcsRootInstance, "000", "", "000");
+    myPublisher.setFallbackRevisions(Collections.singletonList(fallback));
+    final SQueuedBuild queuedBuild = myBuildType.addToQueue("");
+    assertNotNull(queuedBuild);
+    myServer.flushQueue();
+
+    waitFor(() -> {
+      SBuild build = queuedBuild.getBuildPromotion().getAssociatedBuild();
+      return build != null && build.isFinished();
+    });
+
+    waitForTasksToFinish(Event.FINISHED);
+    then(myPublisher.getEventsReceived()).containsExactly(Event.STARTED, Event.FAILURE_DETECTED, Event.FINISHED);
+  }
+
   private SVcsModification prepareVcs() {
     return prepareVcs("vcs1", "111", "rev1_2", SetVcsRootIdMode.EXT_ID);
   }
@@ -965,5 +998,18 @@ private void assertIfNoTasks(Event eventType) {
     then(myMultiNodeTasks.findTasks(Collections.singleton(eventType.getName())).isEmpty()).isTrue();
   }
 
+  private void addBadVcsRootTo(final BuildTypeEx addTo) {
+    final MockVcsSupport failSupport = new MockVcsSupport("fail"){
+      @NotNull
+      @Override
+      public String getCurrentVersion(@NotNull final VcsRoot root) {
+        throw new RuntimeException("BAD VCS ROOT");
+      }
+    };
+
+    myServer.getVcsManager().registerVcsSupport(failSupport);
+    myFixture.addVcsRoot("fail", "", addTo);
+  }
+
   private enum SetVcsRootIdMode { DONT, EXT_ID, INT_ID }
 }

commit-status-publisher-server/src/test/java/jetbrains/buildServer/commitPublisher/MockPublisher.java

@@ -48,6 +48,7 @@ class MockPublisher extends BaseCommitStatusPublisher implements CommitStatusPub
   private int mySuccessReceived = 0;
   private final Set<Event> myEventsToWait = new HashSet<Event>();
   private int myShouldFailToPublish = 0;
+  private Collection<BuildRevision> myFallbackRevisions = Collections.emptyList();
 
   private final PublisherLogger myLogger;
 
@@ -359,6 +360,16 @@ public int compareTo(@NotNull Object o) {
     }
   }
 
+  @NotNull
+  @Override
+  public Collection<BuildRevision> getFallbackRevisions() {
+    return myFallbackRevisions;
+  }
+
+  public void setFallbackRevisions(@NotNull Collection<BuildRevision> fallbackRevisions) {
+    myFallbackRevisions = fallbackRevisions;
+  }
+
   class MockState {
     final MockStatus myStatus;
     final String myRevision;