refactor(retest): acknowledge successful reruns and simplify head matching and test fixtures

Author: ayagmar

README.adoc

@@ -252,6 +252,7 @@ features: [ RETEST_PULL_REQUEST_WORKFLOWS ]
 ----
 
 Only failed jobs from the latest run of each workflow are retriggered. If the latest run is still in progress, the bot asks you to retry once it completes.
+When reruns are started, the bot posts a confirmation comment linking to the workflow runs.
 
 This feature requires:
 

src/main/java/io/quarkus/bot/ApproveWorkflow.java

@@ -21,6 +21,7 @@
 import io.quarkus.bot.config.Feature;
 import io.quarkus.bot.config.QuarkusGitHubBotConfig;
 import io.quarkus.bot.config.QuarkusGitHubBotConfigFile;
+import io.quarkus.bot.util.GHPullRequests;
 import io.quarkus.bot.util.PullRequestFilesMatcher;
 import io.quarkus.cache.CacheKey;
 import io.quarkus.cache.CacheResult;
@@ -90,36 +91,19 @@ private void checkUser(GHEventPayload.WorkflowRun workflowPayload, QuarkusGitHub
     }
 
     private void checkFiles(QuarkusGitHubBotConfigFile quarkusBotConfigFile, GHWorkflowRun workflowRun,
-            ApprovalStatus approval) {
+            ApprovalStatus approval) throws IOException {
         String sha = workflowRun.getHeadSha();
 
-        // Now we want to get the pull request we're supposed to be checking.
-        // It would be nice to use commit.listPullRequests() but that only returns something if the
-        // base and head of the PR are from the same repository, which rules out most scenarios where we would want to do an approval
-
-        String fullyQualifiedBranchName = workflowRun.getHeadRepository().getOwnerName() + ":" + workflowRun.getHeadBranch();
-
-        PagedIterable<GHPullRequest> pullRequestsForThisBranch = workflowRun.getRepository().queryPullRequests()
-                .head(fullyQualifiedBranchName)
-                .list();
-
-        // The number of PRs with matching branch name should be exactly one, but if the PR
-        // has been closed it sometimes disappears from the list; also, if two branch names
-        // start with the same string, both will turn up in the query.
-        for (GHPullRequest pullRequest : pullRequestsForThisBranch) {
-
-            // Only look at PRs whose commit sha matches
-            if (sha.equals(pullRequest.getHead().getSha())) {
-
-                for (QuarkusGitHubBotConfigFile.WorkflowApprovalRule rule : quarkusBotConfigFile.workflows.rules) {
-                    // We allow if the files or directories match the allow rule ...
-                    if (matchRuleFromChangedFiles(pullRequest, rule.allow)) {
-                        approval.shouldApprove = true;
-                    }
-                    // ... unless we also match the unless rule
-                    if (matchRuleFromChangedFiles(pullRequest, rule.unless)) {
-                        approval.shouldNotApprove = true;
-                    }
+        for (GHPullRequest pullRequest : GHPullRequests.matchingHeadPullRequests(workflowRun.getRepository(),
+                workflowRun.getHeadRepository(), workflowRun.getHeadBranch(), sha)) {
+            for (QuarkusGitHubBotConfigFile.WorkflowApprovalRule rule : quarkusBotConfigFile.workflows.rules) {
+                // We allow if the files or directories match the allow rule ...
+                if (matchRuleFromChangedFiles(pullRequest, rule.allow)) {
+                    approval.shouldApprove = true;
+                }
+                // ... unless we also match the unless rule
+                if (matchRuleFromChangedFiles(pullRequest, rule.unless)) {
+                    approval.shouldNotApprove = true;
                 }
             }
         }

src/main/java/io/quarkus/bot/retest/GitHubFailedJobsRerunner.java

@@ -66,7 +66,7 @@ public void rerunFailedJobs(GHEventPayload.IssueComment issueCommentPayload, GHW
         }
     }
 
-    URI rerunFailedJobsUri(GHEventPayload.IssueComment issueCommentPayload, GHWorkflowRun workflowRun) {
+    private URI rerunFailedJobsUri(GHEventPayload.IssueComment issueCommentPayload, GHWorkflowRun workflowRun) {
         String normalizedApiUrl = normalizeApiUrl(gitHubApiUrl(issueCommentPayload));
 
         // TODO switch to GHWorkflowRun.rerunFailedJobs() when Hub4j adds native support for rerunning failed jobs.

src/main/java/io/quarkus/bot/retest/RetestCli.java

@@ -6,16 +6,15 @@
 
 import io.quarkiverse.githubapp.ConfigFile;
 import io.quarkiverse.githubapp.command.airline.CliOptions;
-import io.quarkiverse.githubapp.command.airline.CommandOptions;
-import io.quarkiverse.githubapp.command.airline.CommandOptions.ReactionStrategy;
+import io.quarkiverse.githubapp.command.airline.CliOptions.ParseErrorStrategy;
 import io.quarkus.bot.config.QuarkusGitHubBotConfigFile;
 
 /**
  * Command-airline entry point for comment commands handled by the bot.
  */
 @Cli(name = "@quarkusbot", commands = RetestCommand.class)
 @CliOptions(aliases = {
-        "@quarkus-bot" }, parseErrorHandler = RetestParseErrorHandler.class, defaultCommandOptions = @CommandOptions(reactionStrategy = ReactionStrategy.NONE))
+        "@quarkus-bot" }, parseErrorStrategy = ParseErrorStrategy.NONE)
 class RetestCli {
 }
 

src/main/java/io/quarkus/bot/retest/RetestCommand.java

@@ -1,8 +1,10 @@
 package io.quarkus.bot.retest;
 
 import java.io.IOException;
+import java.net.URL;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.stream.Collectors;
 
 import jakarta.inject.Inject;
 
@@ -23,6 +25,7 @@
 import io.quarkus.bot.config.Feature;
 import io.quarkus.bot.config.QuarkusGitHubBotConfig;
 import io.quarkus.bot.config.QuarkusGitHubBotConfigFile;
+import io.quarkus.bot.service.GHIssueCommentService;
 
 /**
  * Handles {@code @quarkusbot retest} comments on pull requests.
@@ -43,6 +46,9 @@ class RetestCommand implements RetestCommandHandler {
     @Inject
     FailedJobsRerunner failedJobsRerunner;
 
+    @Inject
+    GHIssueCommentService issueCommentService;
+
     @Override
     public void run(QuarkusGitHubBotConfigFile quarkusBotConfigFile, GHEventPayload.IssueComment issueCommentPayload) {
         if (!Feature.RETEST_PULL_REQUEST_WORKFLOWS.isEnabled(quarkusBotConfigFile)) {
@@ -56,11 +62,11 @@ public void run(QuarkusGitHubBotConfigFile quarkusBotConfigFile, GHEventPayload.
 
         RetestWorkflowSelection workflowSelection = getWorkflowSelection(pullRequest);
 
-        if (!workflowSelection.hasEligibleRuns()) {
+        if (workflowSelection.eligibleRuns().isEmpty()) {
             throw RetestCommandException.noEligibleWorkflowRuns(workflowSelection.noEligibleReason());
         }
 
-        List<Long> startedWorkflowRunIds = new ArrayList<>();
+        List<GHWorkflowRun> startedWorkflowRuns = new ArrayList<>();
         for (GHWorkflowRun workflowRun : workflowSelection.eligibleRuns()) {
             if (quarkusBotConfig.isDryRun()) {
                 LOG.infof("Pull request #%d - Retest failed jobs for workflow run #%d (dry-run)",
@@ -70,15 +76,21 @@ public void run(QuarkusGitHubBotConfigFile quarkusBotConfigFile, GHEventPayload.
 
             try {
                 failedJobsRerunner.rerunFailedJobs(issueCommentPayload, workflowRun);
-                startedWorkflowRunIds.add(workflowRun.getId());
+                startedWorkflowRuns.add(workflowRun);
             } catch (RuntimeException e) {
-                if (startedWorkflowRunIds.isEmpty()) {
+                if (startedWorkflowRuns.isEmpty()) {
                     throw e;
                 }
 
-                throw RetestCommandException.partialRerunFailure(startedWorkflowRunIds, workflowRun.getId(), e);
+                throw RetestCommandException.partialRerunFailure(
+                        startedWorkflowRuns.stream().map(GHWorkflowRun::getId).toList(), workflowRun.getId(), e);
             }
         }
+
+        if (!startedWorkflowRuns.isEmpty()) {
+            issueCommentService.addComment(issueCommentPayload.getIssue(), successMessage(startedWorkflowRuns), false,
+                    quarkusBotConfig.isDryRun());
+        }
     }
 
     private static GHPullRequest getPullRequest(GHEventPayload.IssueComment issueCommentPayload) {
@@ -97,4 +109,27 @@ private RetestWorkflowSelection getWorkflowSelection(GHPullRequest pullRequest)
             throw RetestCommandException.unableToInspectWorkflowRuns(e);
         }
     }
+
+    private static String successMessage(List<GHWorkflowRun> startedWorkflowRuns) {
+        String workflowRunLinks = startedWorkflowRuns.stream()
+                .map(RetestCommand::workflowRunReference)
+                .collect(Collectors.joining(", "));
+        String label = startedWorkflowRuns.size() == 1 ? "workflow run " : "workflow runs ";
+        return ":arrows_counterclockwise: Retest started for failed jobs in " + label + workflowRunLinks + ".";
+    }
+
+    private static String workflowRunReference(GHWorkflowRun workflowRun) {
+        String label = "#" + workflowRun.getId();
+        URL htmlUrl;
+        try {
+            htmlUrl = workflowRun.getHtmlUrl();
+        } catch (IOException e) {
+            return label;
+        }
+        if (htmlUrl == null) {
+            return label;
+        }
+
+        return "[" + label + "](" + htmlUrl + ")";
+    }
 }

src/main/java/io/quarkus/bot/retest/RetestCommandException.java

@@ -28,11 +28,6 @@ static RetestCommandException featureDisabled() {
         return new RetestCommandException(":warning: Pull request workflow retest is disabled for this repository.");
     }
 
-    static RetestCommandException ambiguousPullRequestHead() {
-        return new RetestCommandException(
-                ":warning: Multiple pull requests share the same head branch and commit, so retest was skipped.");
-    }
-
     static RetestCommandException pullRequestNotOpen() {
         return new RetestCommandException(":warning: Retest is only available on open pull requests.");
     }

src/main/java/io/quarkus/bot/retest/RetestCommentFormatter.java

@@ -3,21 +3,18 @@
 import jakarta.inject.Inject;
 import jakarta.inject.Singleton;
 
-import org.jboss.logging.Logger;
 import org.kohsuke.github.GHEventPayload;
 
 import io.quarkiverse.githubapp.command.airline.ExecutionErrorHandler;
-import io.quarkus.bot.GHIssueCommentService;
 import io.quarkus.bot.config.QuarkusGitHubBotConfig;
+import io.quarkus.bot.service.GHIssueCommentService;
 
 /**
  * Formats command failures as pull-request comments.
  */
 @Singleton
 class RetestExecutionErrorHandler implements ExecutionErrorHandler {
 
-    private static final Logger LOG = Logger.getLogger(RetestExecutionErrorHandler.class);
-
     @Inject
     QuarkusGitHubBotConfig quarkusBotConfig;
 
@@ -34,20 +31,14 @@ public void handleExecutionError(GHEventPayload.IssueComment issueCommentPayload
 
         String commandLine = executionErrorContext.commandExecutionContext().getCommandLine();
         String message = formatMessage(commandLine, executionErrorContext.exception());
-        String location = issueCommentPayload.getRepository().getFullName() + "#" + issueCommentPayload.getIssue().getNumber();
-
-        try {
-            issueCommentService.addCommentOrThrow(issueCommentPayload.getIssue(), message, false, quarkusBotConfig.isDryRun());
-        } catch (Exception e) {
-            LOG.warn("Error trying to add retest execution error comment for command in " + location, e);
-        }
+        issueCommentService.addComment(issueCommentPayload.getIssue(), message, false, quarkusBotConfig.isDryRun());
     }
 
-    static String formatMessage(String commandLine, Exception exception) {
-        String userMessage = exception instanceof RetestCommandException retestCommandException
-                ? retestCommandException.userMessage()
-                : ":rotating_light: An error occurred while executing the command.";
+    private static String formatMessage(String commandLine, Exception exception) {
+        if (exception instanceof RetestCommandException retestCommandException) {
+            return retestCommandException.userMessage();
+        }
 
-        return RetestCommentFormatter.formatCommandMessage(commandLine, userMessage);
+        return ":rotating_light: An error occurred while executing `" + commandLine + "`.";
     }
 }