show response body when call to GitHub fails

Author: edumserrano

MarkdownLinkCheckLogParser/src/MarkdownLinkCheckLogParserCli/GitHub/Exceptions/GitHubHttpClientException.cs

@@ -2,8 +2,8 @@ namespace MarkdownLinkCheckLogParserCli.GitHub.Exceptions;
 
 public class GitHubHttpClientException : Exception
 {
-    internal GitHubHttpClientException(HttpStatusCode statusCode, HttpMethod method, Uri? requestUri)
-        : base($"Failed to download workflow run logs. Got {(int)statusCode} {statusCode} from {method} {requestUri}.")
+    internal GitHubHttpClientException(HttpMethod method, Uri? requestUri, HttpStatusCode statusCode, string responseBody)
+        : base($"Failed to download workflow run logs. Got {(int)statusCode} {statusCode} from {method} {requestUri}.{Environment.NewLine}With response body:{Environment.NewLine}{responseBody}")
     {
     }
 }

MarkdownLinkCheckLogParser/src/MarkdownLinkCheckLogParserCli/GitHub/GitHubHttpClient.cs

@@ -32,7 +32,8 @@ public async Task<ZipArchive> DownloadWorkflowRunLogsAsync(GitHubRepository repo
         var httpResponse = await _httpClient.SendAsync(httpRequest, HttpCompletionOption.ResponseHeadersRead);
         if (!httpResponse.IsSuccessStatusCode)
         {
-            throw new GitHubHttpClientException(httpResponse.StatusCode, httpRequest.Method, httpRequest.RequestUri);
+            var errorResponseBody = await httpResponse.Content.ReadAsStringAsync();
+            throw new GitHubHttpClientException(httpRequest.Method, httpRequest.RequestUri, httpResponse.StatusCode, errorResponseBody);
         }
 
         var responseStream = await httpResponse.Content.ReadAsStreamAsync();

MarkdownLinkCheckLogParser/tests/MarkdownLinkCheckLogParserCli.Tests/Auxiliary/StatusCodeHandler.cs

@@ -3,15 +3,20 @@ namespace MarkdownLinkCheckLogParserCli.Tests.Auxiliary;
 internal sealed class StatusCodeHandler : DelegatingHandler
 {
     private readonly HttpStatusCode _statusCode;
+    private readonly string _responseBody;
 
-    public StatusCodeHandler(HttpStatusCode statusCode)
+    public StatusCodeHandler(HttpStatusCode statusCode, string responseBody)
     {
         _statusCode = statusCode;
+        _responseBody = responseBody;
     }
 
     protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
     {
-        var httpResponseMessage = new HttpResponseMessage(_statusCode);
+        var httpResponseMessage = new HttpResponseMessage(_statusCode)
+        {
+            Content = new StringContent(_responseBody),
+        };
         return Task.FromResult(httpResponseMessage);
     }
 }

MarkdownLinkCheckLogParser/tests/MarkdownLinkCheckLogParserCli.Tests/CliCommands/ParseLogCommandDependencyErrorTests.cs

@@ -16,7 +16,8 @@ public class ParseLogCommandDependencyErrorTests
     [InlineData(HttpStatusCode.InternalServerError)]
     public async Task GitHubHttpClientFailsToDownloadLogs(HttpStatusCode gitHubHttpClientResponseStatusCode)
     {
-        using var handler = new StatusCodeHandler(gitHubHttpClientResponseStatusCode);
+        var errorResponseBody = "Oops, something went wrong.";
+        using var handler = new StatusCodeHandler(gitHubHttpClientResponseStatusCode, errorResponseBody);
         using var httpClient = new HttpClient(handler)
         {
             BaseAddress = new Uri("https://api.github.com"),
@@ -34,11 +35,13 @@ public async Task GitHubHttpClientFailsToDownloadLogs(HttpStatusCode gitHubHttpC
         var exception = await Should.ThrowAsync<CommandException>(() => command.ExecuteAsync(console).AsTask());
         var expectedErrorMessage = @$"An error occurred trying to execute the command to parse the log from a Markdown link check step.
 Error:
-- Failed to download workflow run logs. Got {(int)gitHubHttpClientResponseStatusCode} {gitHubHttpClientResponseStatusCode} from GET https://api.github.com/repos/repo-name/actions/runs/run-id/logs.";
+- Failed to download workflow run logs. Got {(int)gitHubHttpClientResponseStatusCode} {gitHubHttpClientResponseStatusCode} from GET https://api.github.com/repos/repo-name/actions/runs/run-id/logs.
+With response body:
+{errorResponseBody}";
         exception.Message.ShouldBe(expectedErrorMessage);
         exception.InnerException.ShouldNotBeNull();
         exception.InnerException.ShouldBeAssignableTo<GitHubHttpClientException>();
-        exception.InnerException.Message.ShouldBe($"Failed to download workflow run logs. Got {(int)gitHubHttpClientResponseStatusCode} {gitHubHttpClientResponseStatusCode} from GET https://api.github.com/repos/repo-name/actions/runs/run-id/logs.");
+        exception.InnerException.Message.ShouldBe($"Failed to download workflow run logs. Got {(int)gitHubHttpClientResponseStatusCode} {gitHubHttpClientResponseStatusCode} from GET https://api.github.com/repos/repo-name/actions/runs/run-id/logs.{Environment.NewLine}With response body:{Environment.NewLine}{errorResponseBody}");
     }
 
     /// <summary>