91 extend exception for keeping internal info from http response (#94)

reportportal · Oct 22, 2022 · efc1072 · efc1072
1 parent 47da8c3
commit efc1072
Show file tree

Hide file tree

Showing 8 changed files with 72 additions and 31 deletions.
diff --git a/src/ReportPortal.Client/ReportPortalException.cs b/src/ReportPortal.Client/ReportPortalException.cs
diff --git a/src/ReportPortal.Client/Resources/ServiceBaseResource.cs b/src/ReportPortal.Client/Resources/ServiceBaseResource.cs
@@ -114,8 +114,14 @@ private void CheckSuccessStatusCode(HttpResponseMessage response, Stream stream)
             {
                 using (var reader = new StreamReader(stream))
                 {
-                    string body = reader.ReadToEnd();
-                    throw new ReportPortalException($"Response status code does not indicate success: {response.StatusCode} ({(int)response.StatusCode}) {response.RequestMessage.Method} {response.RequestMessage.RequestUri}", new HttpRequestException($"Response message: {body}"));
+                    string responseBody = reader.ReadToEnd();
+
+                    throw new ServiceException(
+                        "Response status code does not indicate success.",
+                        response.StatusCode,
+                        response.RequestMessage.RequestUri,
+                        response.RequestMessage.Method,
+                        responseBody);
                 }
             }
         }

diff --git a/src/ReportPortal.Client/ServiceException.cs b/src/ReportPortal.Client/ServiceException.cs
@@ -0,0 +1,55 @@
+using System;
+using System.Net;
+using System.Net.Http;
+
+namespace ReportPortal.Client
+{
+    /// <summary>
+    /// Occurs when server cannot process a request.
+    /// </summary>
+    public class ServiceException : Exception
+    {
+        /// <summary>
+        /// Initializes a new instance of <see cref="ServiceException"/> class.
+        /// </summary>
+        /// <param name="message">The message that describes the error.</param>
+        /// <param name="httpStatusCode">Response HTTP status code.</param>
+        /// <param name="requestUri">Request Uri.</param>
+        /// <param name="httpMethod">HTTP method.</param>
+        /// <param name="responseBody">Response body.</param>
+        public ServiceException(string message, HttpStatusCode httpStatusCode, Uri requestUri, HttpMethod httpMethod, string responseBody)
+        {
+            HttpStatusCode = httpStatusCode;
+            RequestUri = requestUri;
+            HttpMethod = httpMethod;
+            ResponseBody = responseBody;
+
+            _message = $"{message}\n {httpStatusCode} ({(int)httpStatusCode}) {httpMethod} {requestUri}\n {responseBody}";
+        }
+
+        private readonly string _message;
+
+        /// <summary>
+        /// Gets HTTP status code.
+        /// </summary>
+        public HttpStatusCode HttpStatusCode { get; }
+
+        /// <summary>
+        /// Gets request uri.
+        /// </summary>
+        public Uri RequestUri { get; }
+
+        /// <summary>
+        /// Gets HTTP method.
+        /// </summary>
+        public HttpMethod HttpMethod { get; }
+
+        /// <summary>
+        /// Gets response body.
+        /// </summary>
+        public string ResponseBody { get; }
+
+        /// <inheritdoc/>
+        public override string Message => _message;
+    }
+}
diff --git a/test/ReportPortal.Client.IntegrationTests/BaseFixture.cs b/test/ReportPortal.Client.IntegrationTests/BaseFixture.cs
@@ -6,7 +6,7 @@ public class BaseFixture
     {
         protected static readonly string Username = "default";
         protected static readonly string ProjectName = "default_personal";
-        protected readonly Service Service = new Service(new Uri("https://demo.reportportal.io/api/v1"), ProjectName, "aeb09a3b-18ef-4e9e-b647-4645c0e9a74e");
+        protected readonly Service Service = new Service(new Uri("https://demo.reportportal.io/api/v1"), ProjectName, "0e80c23b-9676-4b6b-8255-18ef1dece8b5");
         //protected static readonly string Username = "default";
         //protected static readonly string ProjectName = "default_personal";
         //protected readonly Service Service = new Service(new Uri("http://localhost:8080/api/v1"), ProjectName, "d562c898-7705-49a4-be6d-17a8121715fa");

diff --git a/test/ReportPortal.Client.IntegrationTests/LaunchItem/GetLaunchesItemFixture.cs b/test/ReportPortal.Client.IntegrationTests/LaunchItem/GetLaunchesItemFixture.cs
@@ -15,7 +15,7 @@ public class GetLaunchesItemFixture : BaseFixture, IClassFixture<LaunchesFixture
         [Fact]
         public async Task GetInvalidLaunch()
         {
-            await Assert.ThrowsAsync<ReportPortalException>(async () => await Service.Launch.GetAsync("invalid_id"));
+            await Assert.ThrowsAsync<ServiceException>(async () => await Service.Launch.GetAsync("invalid_id"));
         }
 
         [Fact]

diff --git a/test/ReportPortal.Client.IntegrationTests/LaunchItem/LaunchItemFixture.cs b/test/ReportPortal.Client.IntegrationTests/LaunchItem/LaunchItemFixture.cs
@@ -336,7 +336,7 @@ public async Task RerunLaunch()
             await Service.Launch.FinishAsync(launch1Response.Uuid, new FinishLaunchRequest { EndTime = DateTime.UtcNow });
 
             // api doesn't allow to finish launch twice?! So when using rerun, we can start launch, but it seems we should not finish launch
-            await Assert.ThrowsAnyAsync<ReportPortalException>(async () => await Service.Launch.FinishAsync(launch2Response.Uuid, new FinishLaunchRequest { EndTime = DateTime.UtcNow }));
+            await Assert.ThrowsAnyAsync<ServiceException>(async () => await Service.Launch.FinishAsync(launch2Response.Uuid, new FinishLaunchRequest { EndTime = DateTime.UtcNow }));
 
             var gotLaunch = await Service.Launch.GetAsync(launch1Response.Uuid);
             await Service.Launch.DeleteAsync(gotLaunch.Id);
@@ -369,7 +369,7 @@ public async Task RerunToSpecificLaunch()
             await Service.Launch.FinishAsync(launch1Response.Uuid, new FinishLaunchRequest { EndTime = DateTime.UtcNow });
 
             // api doesn't allow to finish launch twice?! So when using rerun, we can start launch, but it seems we should not finish launch
-            await Assert.ThrowsAnyAsync<ReportPortalException>(async () => await Service.Launch.FinishAsync(launch2Response.Uuid, new FinishLaunchRequest { EndTime = DateTime.UtcNow }));
+            await Assert.ThrowsAnyAsync<ServiceException>(async () => await Service.Launch.FinishAsync(launch2Response.Uuid, new FinishLaunchRequest { EndTime = DateTime.UtcNow }));
 
             var gotLaunch = await Service.Launch.GetAsync(launch1Response.Uuid);
             await Service.Launch.DeleteAsync(gotLaunch.Id);
@@ -386,7 +386,7 @@ public async Task RerunNonExistingLaunch()
                 IsRerun = true
             };
 
-            await Assert.ThrowsAnyAsync<ReportPortalException>(async () => await Service.Launch.StartAsync(request));
+            await Assert.ThrowsAnyAsync<ServiceException>(async () => await Service.Launch.StartAsync(request));
         }
     }
 }
diff --git a/test/ReportPortal.Client.IntegrationTests/Negative/Negative.cs b/test/ReportPortal.Client.IntegrationTests/Negative/Negative.cs
@@ -19,14 +19,14 @@ public async Task IncorrectHost()
         public async Task IncorrectUrlInCorrectHost()
         {
             var service = new Service(new Uri("https://rp.epam.com/api/blabla/"), "p", "p");
-            await Assert.ThrowsAsync<ReportPortalException>(async () => await service.Launch.StartAsync(new StartLaunchRequest { Name = "abc" }));
+            await Assert.ThrowsAsync<ServiceException>(async () => await service.Launch.StartAsync(new StartLaunchRequest { Name = "abc" }));
         }
 
         [Fact]
         public async Task IncorrectUuid()
         {
             var service = new Service(new Uri("https://rp.epam.com/api/v1/"), "default_project", "incorrect_uuid");
-            await Assert.ThrowsAsync<ReportPortalException>(async () => await service.Launch.GetAsync());
+            await Assert.ThrowsAsync<ServiceException>(async () => await service.Launch.GetAsync());
         }
     }
 }
diff --git a/test/ReportPortal.Client.IntegrationTests/TestItem/UpdateTestItemFixture.cs b/test/ReportPortal.Client.IntegrationTests/TestItem/UpdateTestItemFixture.cs
@@ -107,8 +107,8 @@ public async Task UpdateOfInProgressIsNotAllowed()
 
             Func<Task> act = async () => await Service.TestItem.UpdateAsync(tempTest.Id, updateRequest);
 
-            var exp = await act.Should().ThrowExactlyAsync<ReportPortalException>();
-            exp.WithInnerExceptionExactly<HttpRequestException>().WithMessage("*Unable to update status*");
+            var exp = await act.Should().ThrowExactlyAsync<ServiceException>();
+            exp.Which.ResponseBody.Should().Contain("Unable to update status");
 
             await Service.TestItem.FinishAsync(test.Uuid, new FinishTestItemRequest
             {