Modify Scenario Test to check tagged pull requests

test/ProductConstructionService.ScenarioTests/CodeFlowScenarioTestBase.cs

@@ -19,15 +19,16 @@ protected async Task<PullRequest> CheckForwardFlowGitHubPullRequest(
         string targetRepoName,
         string targetBranch,
         string[] testFiles,
-        Dictionary<string, string> testFilePatches)
+        Dictionary<string, string> testFilePatches,
+        PullRequestCleanupOperation cleanupOperation = PullRequestCleanupOperation.Close)
     {
         // When we expect updates from multiple repos (batchable subscriptions), we need to wait until the PR gets updated with the second repository after it is created
         // Otherwise it might try to validate the contents before all updates are in place
         PullRequest pullRequest = repoUpdates.Length > 1
             ? await WaitForUpdatedPullRequestAsync(targetRepoName, targetBranch)
             : await WaitForPullRequestAsync(targetRepoName, targetBranch);
 
-        await using (CleanUpPullRequestAfter(TestParameters.GitHubTestOrg, targetRepoName, pullRequest))
+        await using (CleanUpPullRequestAfter(TestParameters.GitHubTestOrg, targetRepoName, pullRequest, cleanupOperation))
         {
             IReadOnlyList<PullRequestFile> files = await GitHubApi.PullRequest.Files(
                 TestParameters.GitHubTestOrg,
@@ -200,9 +201,10 @@ public async Task<PullRequest> WaitForPullRequestComment(
         string targetRepo,
         string targetBranch,
         string partialComment,
+        ItemStateFilter prState = ItemStateFilter.Open,
         int attempts = 40)
     {
-        PullRequest pullRequest = await WaitForPullRequestAsync(targetRepo, targetBranch);
+        PullRequest pullRequest = await WaitForPullRequestAsync(targetRepo, targetBranch, prState);
 
         while (attempts-- > 0)
         {

test/ProductConstructionService.ScenarioTests/ScenarioTestBase.cs

@@ -12,12 +12,12 @@
 using Microsoft.DotNet.DarcLib.Models.AzureDevOps;
 using Microsoft.DotNet.DarcLib.Models.Darc;
 using Microsoft.DotNet.Internal.Testing.Utility;
+using Microsoft.DotNet.ProductConstructionService.Client;
+using Microsoft.DotNet.ProductConstructionService.Client.Models;
 using Microsoft.Extensions.Logging;
 using Newtonsoft.Json.Linq;
 using NuGet.Configuration;
 using NUnit.Framework;
-using Microsoft.DotNet.ProductConstructionService.Client;
-using Microsoft.DotNet.ProductConstructionService.Client.Models;
 using ProductConstructionService.ScenarioTests.ObjectHelpers;
 
 [assembly: Parallelizable(ParallelScope.Fixtures)]
@@ -46,7 +46,7 @@ public void BaseSetup()
         _packageNameSalt = Guid.NewGuid().ToString().Substring(0, 8);
     }
 
-    protected async Task<Octokit.PullRequest> WaitForPullRequestAsync(string targetRepo, string targetBranch)
+    protected async Task<Octokit.PullRequest> WaitForPullRequestAsync(string targetRepo, string targetBranch, Octokit.ItemStateFilter prState = Octokit.ItemStateFilter.Open)
     {
         Octokit.Repository repo = await GitHubApi.Repository.Get(TestParameters.GitHubTestOrg, targetRepo);
 
@@ -56,6 +56,7 @@ public void BaseSetup()
             IReadOnlyList<Octokit.PullRequest> prs = await GitHubApi.PullRequest.GetAllForRepository(repo.Id, new Octokit.PullRequestRequest
             {
                 Base = targetBranch,
+                State = prState
             });
 
             if (prs.Count == 1)
@@ -1189,10 +1190,21 @@ protected string GetUniqueAssetName(string packageName)
         return $"{packageName}.{_packageNameSalt}";
     }
 
-    protected static IAsyncDisposable CleanUpPullRequestAfter(string owner, string repo, Octokit.PullRequest pullRequest)
+    protected static IAsyncDisposable CleanUpPullRequestAfter(
+        string owner,
+        string repo,
+        Octokit.PullRequest pullRequest,
+        PullRequestCleanupOperation cleanupOperation = PullRequestCleanupOperation.Close)
         => AsyncDisposable.Create(async () =>
         {
-            await ClosePullRequest(owner, repo, pullRequest);
+            if (cleanupOperation == PullRequestCleanupOperation.Merge)
+            {
+                await MergePullRequest(owner, repo, pullRequest);
+            }
+            else
+            {
+                await ClosePullRequest(owner, repo, pullRequest);
+            }
         });
 
     protected static async Task ClosePullRequest(string owner, string repo, Octokit.PullRequest pullRequest)
@@ -1220,6 +1232,34 @@ protected static async Task ClosePullRequest(string owner, string repo, Octokit.
         }
     }
 
+    protected static async Task MergePullRequest(string owner, string repo, Octokit.PullRequest pullRequest)
+    {
+        try
+        {
+            await GitHubApi.PullRequest.Merge(
+                owner,
+                repo,
+                pullRequest.Number,
+                new Octokit.MergePullRequest
+                {
+                    CommitMessage = "Merge pull request",
+                    MergeMethod = Octokit.PullRequestMergeMethod.Merge
+                });
+        }
+        catch
+        {
+            // Closed already
+        }
+        try
+        {
+            await GitHubApi.Git.Reference.Delete(owner, repo, $"heads/{pullRequest.Head.Ref}");
+        }
+        catch
+        {
+            // branch already deleted
+        }
+    }
+
     protected static async Task CreateTargetBranchAndExecuteTest(string targetBranchName, string targetDirectory, Func<Task> test)
     {
         // first create a new target branch
@@ -1285,3 +1325,9 @@ protected static async Task WaitForNewCommitInPullRequest(string repo, Octokit.P
         return pr;
     }
 }
+
+internal enum PullRequestCleanupOperation
+{
+    Close,
+    Merge
+}

test/ProductConstructionService.ScenarioTests/ScenarioTests/ScenarioTests_CodeFlow.cs

@@ -98,12 +98,21 @@ await CreateTargetBranchAndExecuteTest(targetBranchName, vmrDirectory.Directory,
                             TestRepository.VmrTestRepoName,
                             targetBranchName,
                             [$"src/{TestRepository.TestRepo1Name}/{TestFile1Name}"],
-                            TestFilePatches);
+                            TestFilePatches,
+                            PullRequestCleanupOperation.Merge);
 
                         await CheckIfPullRequestCommentExists(
                             TestRepository.VmrTestRepoName,
                             pr,
-                            [$"https://github.com/maestro-auth-test/maestro-test1/pull/{testPrNumber}"]);
+                            // here we're testing for a URI with () around, since that's what we write during the codeflow udpates
+                            [$"(https://github.com/maestro-auth-test/maestro-test1/pull/{testPrNumber})"]);
+
+                        await WaitForPullRequestComment(
+                            TestRepository.VmrTestRepoName,
+                            targetBranchName,
+                            // here we test for this specific format because that's how we tag PRs after merging the forward flow
+                            $"- https://github.com/maestro-auth-test/maestro-test1/pull/{testPrNumber}",
+                            Octokit.ItemStateFilter.Closed);
                     }
                 }
             }