Add validation states to migration state logic (#428)

tambling · dylan-smith · web-flow · commit 8736d28aef48 · 2022-06-15T17:03:50.000Z
* First pass at checking for FAILED_VALIDATION

* Oh hey there's an autoformatter!

* Update src/Octoshift/RepositoryMigrationStatus.cs

Co-authored-by: Dylan Smith &lt;dylan-smith@github.com&gt;

* Update ado2gh and add tests

* Add unit tests for RepositoryMigrationStatus

* Autoformat whitespace

* Standardize on RepositoryMigrationStatus methods

* Use state parsing methods in ado2gh MigrateRepoCommand

Co-authored-by: Dylan Smith &lt;dylan-smith@github.com&gt;
diff --git a/src/Octoshift/RepositoryMigrationStatus.cs b/src/Octoshift/RepositoryMigrationStatus.cs
@@ -6,5 +6,11 @@ public static class RepositoryMigrationStatus
         public const string InProgress = "IN_PROGRESS";
         public const string Failed = "FAILED";
         public const string Succeeded = "SUCCEEDED";
+        public const string PendingValidation = "PENDING_VALIDATION";
+        public const string FailedValidation = "FAILED_VALIDATION";
+
+        public static bool IsSucceeded(string migrationState) => migrationState?.Trim().ToUpper() is Succeeded;
+        public static bool IsPending(string migrationState) => migrationState?.Trim().ToUpper() is Queued or InProgress or PendingValidation;
+        public static bool IsFailed(string migrationState) => !(IsPending(migrationState) || IsSucceeded(migrationState));
     }
 }
diff --git a/src/OctoshiftCLI.Tests/RepositoryMigrationStatusTests.cs b/src/OctoshiftCLI.Tests/RepositoryMigrationStatusTests.cs
@@ -0,0 +1,54 @@
+using FluentAssertions;
+using Xunit;
+
+namespace OctoshiftCLI.Tests
+{
+    public class RepositoryMigrationStatusTests
+    {
+        [Fact]
+        public void IsSucceeded_Returns_True_For_Succeeded_Status()
+        {
+            RepositoryMigrationStatus.IsSucceeded(RepositoryMigrationStatus.Succeeded).Should().BeTrue();
+        }
+
+        [Fact]
+        public void IsSucceeded_Returns_False_Otherwise()
+        {
+            RepositoryMigrationStatus.IsSucceeded(RepositoryMigrationStatus.InProgress).Should().BeFalse();
+            RepositoryMigrationStatus.IsSucceeded(RepositoryMigrationStatus.Failed).Should().BeFalse();
+            RepositoryMigrationStatus.IsSucceeded("NOT_A_REAL_STATUS").Should().BeFalse();
+        }
+
+        [Fact]
+        public void IsPending_Returns_True_For_Pending_Statuses()
+        {
+            RepositoryMigrationStatus.IsPending(RepositoryMigrationStatus.Queued).Should().BeTrue();
+            RepositoryMigrationStatus.IsPending(RepositoryMigrationStatus.PendingValidation).Should().BeTrue();
+            RepositoryMigrationStatus.IsPending(RepositoryMigrationStatus.InProgress).Should().BeTrue();
+        }
+
+        [Fact]
+        public void IsPending_Returns_False_Otherwise()
+        {
+            RepositoryMigrationStatus.IsPending(RepositoryMigrationStatus.Succeeded).Should().BeFalse();
+            RepositoryMigrationStatus.IsPending(RepositoryMigrationStatus.Failed).Should().BeFalse();
+            RepositoryMigrationStatus.IsPending("NOT_A_REAL_STATUS").Should().BeFalse();
+        }
+
+        [Fact]
+        public void IsFailed_Returns_True_For_Failed_Or_Invalid_Statuses()
+        {
+            RepositoryMigrationStatus.IsFailed(RepositoryMigrationStatus.Failed).Should().BeTrue();
+            RepositoryMigrationStatus.IsFailed(RepositoryMigrationStatus.FailedValidation).Should().BeTrue();
+            RepositoryMigrationStatus.IsFailed("NOT_A_REAL_STATUS").Should().BeTrue();
+        }
+
+        [Fact]
+        public void IsFailed_Returns_False_For_Pending_Or_Succeeded_Statuses()
+        {
+            RepositoryMigrationStatus.IsFailed(RepositoryMigrationStatus.Queued).Should().BeFalse();
+            RepositoryMigrationStatus.IsFailed(RepositoryMigrationStatus.InProgress).Should().BeFalse();
+            RepositoryMigrationStatus.IsFailed(RepositoryMigrationStatus.Succeeded).Should().BeFalse();
+        }
+    }
+}
diff --git a/src/OctoshiftCLI.Tests/ado2gh/Commands/WaitForMigrationCommandTests.cs b/src/OctoshiftCLI.Tests/ado2gh/Commands/WaitForMigrationCommandTests.cs
@@ -126,6 +126,53 @@ await FluentActions
             _mockGithubApi.VerifyNoOtherCalls();
         }
 
+        [Fact]
+        public async Task With_Migration_ID_That_Fails_Validation()
+        {
+            // Arrange
+            const string failureReason = "FAILURE_REASON";
+
+            _mockGithubApi.SetupSequence(x => x.GetMigration(MIGRATION_ID).Result)
+                .Returns((State: RepositoryMigrationStatus.PendingValidation, RepositoryName: TARGET_REPO, FailureReason: null))
+                .Returns((State: RepositoryMigrationStatus.PendingValidation, RepositoryName: TARGET_REPO, FailureReason: null))
+                .Returns((State: RepositoryMigrationStatus.FailedValidation, RepositoryName: TARGET_REPO, FailureReason: failureReason));
+
+            _mockGithubApiFactory.Setup(m => m.Create(It.IsAny<string>(), It.IsAny<string>())).Returns(_mockGithubApi.Object);
+
+            var actualLogOutput = new List<string>();
+            _mockOctoLogger.Setup(m => m.LogInformation(It.IsAny<string>())).Callback<string>(s => actualLogOutput.Add(s));
+            _mockOctoLogger.Setup(m => m.LogError(It.IsAny<string>())).Callback<string>(s => actualLogOutput.Add(s));
+
+            var expectedLogOutput = new List<string>
+            {
+                $"Waiting for {TARGET_REPO} migration (ID: {MIGRATION_ID}) to finish...",
+                $"Migration {MIGRATION_ID} for {TARGET_REPO} is {RepositoryMigrationStatus.PendingValidation}",
+                $"Waiting {WAIT_INTERVAL} seconds...",
+                $"Migration {MIGRATION_ID} for {TARGET_REPO} is {RepositoryMigrationStatus.PendingValidation}",
+                $"Waiting {WAIT_INTERVAL} seconds...",
+                $"Migration {MIGRATION_ID} failed for {TARGET_REPO}"
+            };
+
+            // Act
+            await FluentActions
+                .Invoking(async () => await _command.Invoke(MIGRATION_ID))
+                .Should()
+                .ThrowAsync<OctoshiftCliException>()
+                .WithMessage(failureReason);
+
+            // Assert
+
+            _mockOctoLogger.Verify(m => m.LogInformation(It.IsAny<string>()), Times.Exactly(5));
+            _mockOctoLogger.Verify(m => m.LogError(It.IsAny<string>()), Times.Once);
+
+            _mockGithubApi.Verify(m => m.GetMigration(MIGRATION_ID), Times.Exactly(3));
+
+            actualLogOutput.Should().Equal(expectedLogOutput);
+
+            _mockOctoLogger.VerifyNoOtherCalls();
+            _mockGithubApi.VerifyNoOtherCalls();
+        }
+
         [Fact]
         public async Task It_Uses_The_Github_Pat_When_Provided()
         {
diff --git a/src/OctoshiftCLI.Tests/gei/Commands/WaitForMigrationCommandTests.cs b/src/OctoshiftCLI.Tests/gei/Commands/WaitForMigrationCommandTests.cs
@@ -126,6 +126,53 @@ await FluentActions
             _mockGithubApi.VerifyNoOtherCalls();
         }
 
+        [Fact]
+        public async Task With_Migration_ID_That_Fails_Validation()
+        {
+            // Arrange
+            const string failureReason = "FAILURE_REASON";
+
+            _mockGithubApi.SetupSequence(x => x.GetMigration(MIGRATION_ID).Result)
+                .Returns((State: RepositoryMigrationStatus.PendingValidation, RepositoryName: TARGET_REPO, FailureReason: null))
+                .Returns((State: RepositoryMigrationStatus.PendingValidation, RepositoryName: TARGET_REPO, FailureReason: null))
+                .Returns((State: RepositoryMigrationStatus.FailedValidation, RepositoryName: TARGET_REPO, FailureReason: failureReason));
+
+            _mockTargetGithubApiFactory.Setup(m => m.Create(It.IsAny<string>(), It.IsAny<string>())).Returns(_mockGithubApi.Object);
+
+            var actualLogOutput = new List<string>();
+            _mockOctoLogger.Setup(m => m.LogInformation(It.IsAny<string>())).Callback<string>(s => actualLogOutput.Add(s));
+            _mockOctoLogger.Setup(m => m.LogError(It.IsAny<string>())).Callback<string>(s => actualLogOutput.Add(s));
+
+            var expectedLogOutput = new List<string>
+            {
+                $"Waiting for {TARGET_REPO} migration (ID: {MIGRATION_ID}) to finish...",
+                $"Migration {MIGRATION_ID} for {TARGET_REPO} is {RepositoryMigrationStatus.PendingValidation}",
+                $"Waiting {WAIT_INTERVAL} seconds...",
+                $"Migration {MIGRATION_ID} for {TARGET_REPO} is {RepositoryMigrationStatus.PendingValidation}",
+                $"Waiting {WAIT_INTERVAL} seconds...",
+                $"Migration {MIGRATION_ID} failed for {TARGET_REPO}"
+            };
+
+            // Act
+            await FluentActions
+                .Invoking(async () => await _command.Invoke(MIGRATION_ID))
+                .Should()
+                .ThrowAsync<OctoshiftCliException>()
+                .WithMessage(failureReason);
+
+            // Assert
+
+            _mockOctoLogger.Verify(m => m.LogInformation(It.IsAny<string>()), Times.Exactly(5));
+            _mockOctoLogger.Verify(m => m.LogError(It.IsAny<string>()), Times.Once);
+
+            _mockGithubApi.Verify(m => m.GetMigration(MIGRATION_ID), Times.Exactly(3));
+
+            actualLogOutput.Should().Equal(expectedLogOutput);
+
+            _mockOctoLogger.VerifyNoOtherCalls();
+            _mockGithubApi.VerifyNoOtherCalls();
+        }
+
         [Fact]
         public async Task It_Uses_Github_Target_Pat_When_Provided()
         {
diff --git a/src/ado2gh/Commands/MigrateRepoCommand.cs b/src/ado2gh/Commands/MigrateRepoCommand.cs
@@ -132,14 +132,14 @@ public async Task Invoke(string adoOrg, string adoTeamProject, string adoRepo, s
 
             var (migrationState, _, failureReason) = await githubApi.GetMigration(migrationId);
 
-            while (migrationState.Trim().ToUpper() is "IN_PROGRESS" or "QUEUED")
+            while (RepositoryMigrationStatus.IsPending(migrationState))
             {
                 _log.LogInformation($"Migration in progress (ID: {migrationId}). State: {migrationState}. Waiting 10 seconds...");
                 await Task.Delay(10000);
                 (migrationState, _, failureReason) = await githubApi.GetMigration(migrationId);
             }
 
-            if (migrationState.Trim().ToUpper() == "FAILED")
+            if (RepositoryMigrationStatus.IsFailed(migrationState))
             {
                 _log.LogError($"Migration Failed. Migration ID: {migrationId}");
                 throw new OctoshiftCliException(failureReason);
diff --git a/src/ado2gh/Commands/WaitForMigrationCommand.cs b/src/ado2gh/Commands/WaitForMigrationCommand.cs
@@ -57,19 +57,18 @@ public async Task Invoke(string migrationId, string githubPat = null, bool verbo
 
             while (true)
             {
-                switch (state)
+                if (RepositoryMigrationStatus.IsSucceeded(state))
                 {
-                    case RepositoryMigrationStatus.Failed:
-                        _log.LogError($"Migration {migrationId} failed for {repositoryName}");
-                        throw new OctoshiftCliException(failureReason);
-                    case RepositoryMigrationStatus.Succeeded:
-                        _log.LogSuccess($"Migration {migrationId} succeeded for {repositoryName}");
-                        return;
-                    default: // IN_PROGRESS, QUEUED
-                        _log.LogInformation($"Migration {migrationId} for {repositoryName} is {state}");
-                        break;
+                    _log.LogSuccess($"Migration {migrationId} succeeded for {repositoryName}");
+                    return;
+                }
+                else if (RepositoryMigrationStatus.IsFailed(state))
+                {
+                    _log.LogError($"Migration {migrationId} failed for {repositoryName}");
+                    throw new OctoshiftCliException(failureReason);
                 }
 
+                _log.LogInformation($"Migration {migrationId} for {repositoryName} is {state}");
                 _log.LogInformation($"Waiting {WaitIntervalInSeconds} seconds...");
                 await Task.Delay(WaitIntervalInSeconds * 1000);
 
diff --git a/src/gei/Commands/MigrateRepoCommand.cs b/src/gei/Commands/MigrateRepoCommand.cs
@@ -221,14 +221,14 @@ public async Task Invoke(MigrateRepoCommandArgs args)
 
             var (migrationState, _, failureReason) = await githubApi.GetMigration(migrationId);
 
-            while (migrationState.Trim().ToUpper() is "IN_PROGRESS" or "QUEUED")
+            while (RepositoryMigrationStatus.IsPending(migrationState))
             {
                 _log.LogInformation($"Migration in progress (ID: {migrationId}). State: {migrationState}. Waiting 10 seconds...");
                 await Task.Delay(10000);
                 (migrationState, _, failureReason) = await githubApi.GetMigration(migrationId);
             }
 
-            if (migrationState.Trim().ToUpper() == "FAILED")
+            if (RepositoryMigrationStatus.IsFailed(migrationState))
             {
                 _log.LogError($"Migration Failed. Migration ID: {migrationId}");
                 throw new OctoshiftCliException(failureReason);
diff --git a/src/gei/Commands/WaitForMigrationCommand.cs b/src/gei/Commands/WaitForMigrationCommand.cs
@@ -57,19 +57,18 @@ public async Task Invoke(string migrationId, string githubTargetPat = null, bool
 
             while (true)
             {
-                switch (state)
+                if (RepositoryMigrationStatus.IsSucceeded(state))
                 {
-                    case RepositoryMigrationStatus.Failed:
-                        _log.LogError($"Migration {migrationId} failed for {repositoryName}");
-                        throw new OctoshiftCliException(failureReason);
-                    case RepositoryMigrationStatus.Succeeded:
-                        _log.LogSuccess($"Migration {migrationId} succeeded for {repositoryName}");
-                        return;
-                    default: // IN_PROGRESS, QUEUED
-                        _log.LogInformation($"Migration {migrationId} for {repositoryName} is {state}");
-                        break;
+                    _log.LogSuccess($"Migration {migrationId} succeeded for {repositoryName}");
+                    return;
+                }
+                else if (RepositoryMigrationStatus.IsFailed(state))
+                {
+                    _log.LogError($"Migration {migrationId} failed for {repositoryName}");
+                    throw new OctoshiftCliException(failureReason);
                 }
 
+                _log.LogInformation($"Migration {migrationId} for {repositoryName} is {state}");
                 _log.LogInformation($"Waiting {WaitIntervalInSeconds} seconds...");
                 await Task.Delay(WaitIntervalInSeconds * 1000);
 

Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,11 @@ public static class RepositoryMigrationStatus`
`6`	`6`	`public const string InProgress = "IN_PROGRESS";`
`7`	`7`	`public const string Failed = "FAILED";`
`8`	`8`	`public const string Succeeded = "SUCCEEDED";`
	`9`	`+ public const string PendingValidation = "PENDING_VALIDATION";`
	`10`	`+ public const string FailedValidation = "FAILED_VALIDATION";`
	`11`	`+`
	`12`	`+ public static bool IsSucceeded(string migrationState) => migrationState?.Trim().ToUpper() is Succeeded;`
	`13`	`+ public static bool IsPending(string migrationState) => migrationState?.Trim().ToUpper() is Queued or InProgress or PendingValidation;`
	`14`	`+ public static bool IsFailed(string migrationState) => !(IsPending(migrationState) \|\| IsSucceeded(migrationState));`
`9`	`15`	`}`
`10`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -132,14 +132,14 @@ public async Task Invoke(string adoOrg, string adoTeamProject, string adoRepo, s`
`132`	`132`
`133`	`133`	`var (migrationState, _, failureReason) = await githubApi.GetMigration(migrationId);`
`134`	`134`
`135`		`- while (migrationState.Trim().ToUpper() is "IN_PROGRESS" or "QUEUED")`
	`135`	`+ while (RepositoryMigrationStatus.IsPending(migrationState))`
`136`	`136`	`{`
`137`	`137`	`_log.LogInformation($"Migration in progress (ID: {migrationId}). State: {migrationState}. Waiting 10 seconds...");`
`138`	`138`	`await Task.Delay(10000);`
`139`	`139`	`(migrationState, _, failureReason) = await githubApi.GetMigration(migrationId);`
`140`	`140`	`}`
`141`	`141`
`142`		`- if (migrationState.Trim().ToUpper() == "FAILED")`
	`142`	`+ if (RepositoryMigrationStatus.IsFailed(migrationState))`
`143`	`143`	`{`
`144`	`144`	`_log.LogError($"Migration Failed. Migration ID: {migrationId}");`
`145`	`145`	`throw new OctoshiftCliException(failureReason);`
Original file line number	Diff line number	Diff line change
`@@ -221,14 +221,14 @@ public async Task Invoke(MigrateRepoCommandArgs args)`
`221`	`221`
`222`	`222`	`var (migrationState, _, failureReason) = await githubApi.GetMigration(migrationId);`
`223`	`223`
`224`		`- while (migrationState.Trim().ToUpper() is "IN_PROGRESS" or "QUEUED")`
	`224`	`+ while (RepositoryMigrationStatus.IsPending(migrationState))`
`225`	`225`	`{`
`226`	`226`	`_log.LogInformation($"Migration in progress (ID: {migrationId}). State: {migrationState}. Waiting 10 seconds...");`
`227`	`227`	`await Task.Delay(10000);`
`228`	`228`	`(migrationState, _, failureReason) = await githubApi.GetMigration(migrationId);`
`229`	`229`	`}`
`230`	`230`
`231`		`- if (migrationState.Trim().ToUpper() == "FAILED")`
	`231`	`+ if (RepositoryMigrationStatus.IsFailed(migrationState))`
`232`	`232`	`{`
`233`	`233`	`_log.LogError($"Migration Failed. Migration ID: {migrationId}");`
`234`	`234`	`throw new OctoshiftCliException(failureReason);`