Handle GQL error response (#467)

github · Jun 28, 2022 · 027a1e0 · 027a1e0
1 parent 56019ae
commit 027a1e0
Show file tree

Hide file tree

Showing 2 changed files with 132 additions and 0 deletions.
diff --git a/src/Octoshift/GithubApi.cs b/src/Octoshift/GithubApi.cs
@@ -278,6 +278,8 @@ mutation startRepositoryMigration(
             var response = await _client.PostAsync(url, payload);
             var data = JObject.Parse(response);
 
+            EnsureSuccessGraphQLResponse(data);
+
             return (string)data["data"]["startRepositoryMigration"]["repositoryMigration"]["id"];
         }
 
@@ -617,5 +619,15 @@ private static Mannequin BuildMannequin(JToken mannequin)
                                     : null
             };
         }
+
+        private void EnsureSuccessGraphQLResponse(JObject response)
+        {
+            if (response.TryGetValue("errors", out var jErrors) && jErrors is JArray { Count: > 0 } errors)
+            {
+                var error = (JObject)errors[0];
+                var errorMessage = error.TryGetValue("message", out var jMessage) ? (string)jMessage : null;
+                throw new OctoshiftCliException($"{errorMessage ?? "UNKNOWN"}");
+            }
+        }
     }
 }
diff --git a/src/OctoshiftCLI.Tests/GithubApiTests.cs b/src/OctoshiftCLI.Tests/GithubApiTests.cs
@@ -609,6 +609,126 @@ mutation startRepositoryMigration(
             expectedRepositoryMigrationId.Should().Be(actualRepositoryMigrationId);
         }
 
+        [Fact]
+        public async Task StartMigration_Throws_When_GraphQL_Response_Has_Errors()
+        {
+            // Arrange
+            const string expectedErrorMessage = "Please make sure that githubPat includes the workflow scope";
+            const string response = $@"
+            {{
+                ""data"": {{ 
+                    ""startRepositoryMigration"": null
+                 }},
+                ""errors"": [
+                     {{
+                        ""type"": ""FORBIDDEN"",
+                        ""path"": [
+                            ""startRepositoryMigration""
+                         ],
+                        ""locations"": [
+                            {{
+                                ""line"": 13,
+                                ""column"": 17
+                            }}
+                         ],
+                        ""message"": ""{expectedErrorMessage}""
+                     }}
+                 ]
+            }}";
+
+            _githubClientMock
+                .Setup(m => m.PostAsync(It.IsAny<string>(), It.IsAny<object>()))
+                .ReturnsAsync(response);
+
+            // Act, Assert
+            await _githubApi.Invoking(api => api.StartMigration(
+                    It.IsAny<string>(),
+                    It.IsAny<string>(),
+                    It.IsAny<string>(),
+                    It.IsAny<string>(),
+                    It.IsAny<string>(),
+                    It.IsAny<string>()))
+                .Should()
+                .ThrowAsync<OctoshiftCliException>()
+                .WithMessage(expectedErrorMessage);
+        }
+
+        [Fact]
+        public async Task StartMigration_Does_Not_Include_Error_Message_If_Missing()
+        {
+            // Arrange
+            const string response = @"
+            {
+                ""data"": { 
+                    ""startRepositoryMigration"": null
+                 },
+                ""errors"": [
+                     {
+                        ""type"": ""FORBIDDEN"",
+                        ""path"": [
+                            ""startRepositoryMigration""
+                         ],
+                        ""locations"": [
+                            {
+                                ""line"": 13,
+                                ""column"": 17
+                            }
+                         ]
+                     }
+                 ]
+            }";
+
+            const string expectedErrorMessage = "UNKNOWN";
+
+            _githubClientMock
+                .Setup(m => m.PostAsync(It.IsAny<string>(), It.IsAny<object>()))
+                .ReturnsAsync(response);
+
+            // Act, Assert
+            await _githubApi.Invoking(api => api.StartMigration(
+                    It.IsAny<string>(),
+                    It.IsAny<string>(),
+                    It.IsAny<string>(),
+                    It.IsAny<string>(),
+                    It.IsAny<string>(),
+                    It.IsAny<string>()))
+                .Should()
+                .ThrowAsync<OctoshiftCliException>()
+                .WithMessage(expectedErrorMessage);
+        }
+
+        [Fact]
+        public async Task StartMigration_Does_Not_Throw_When_Errors_Is_Empty()
+        {
+            // Arrange
+            const string response = @"
+            {
+                ""data"": { 
+                    ""startRepositoryMigration"": {
+                        ""repositoryMigration"": {
+                            ""id"": ""RM_kgC4NjFhNmE2NGU2ZWE1YTQwMDA5ODliZjhi""
+                         }
+                     }
+                 },
+                ""errors"": []
+            }";
+
+            _githubClientMock
+                .Setup(m => m.PostAsync(It.IsAny<string>(), It.IsAny<object>()))
+                .ReturnsAsync(response);
+
+            // Act, Assert
+            await _githubApi.Invoking(api => api.StartMigration(
+                    It.IsAny<string>(),
+                    It.IsAny<string>(),
+                    It.IsAny<string>(),
+                    It.IsAny<string>(),
+                    It.IsAny<string>(),
+                    It.IsAny<string>()))
+                .Should()
+                .NotThrowAsync<OctoshiftCliException>();
+        }
+
         [Fact]
         public async Task GetMigration_Returns_The_Migration_State_And_Repository_Name()
         {