feat(api): #45 updated service handing and tests

Author: rlabbeptc

Kepware.Api.Test/ApiClient/AutomaticTagGenerationAsyncTests.cs

@@ -48,11 +48,15 @@ public async Task AutomaticTagGenerationAsync_ShouldReturnKepServerJobPromise_Wh
 
             // Act
             var result = await _kepwareApiClient.ApiServices.AutomaticTagGenerationAsync(UNIT_TEST_CHANNEL, UNIT_TEST_DEVICE, TimeSpan.FromSeconds(30));
+            var jobResult = await result.AwaitCompletionAsync();
 
             // Assert
             result.ShouldNotBeNull();
             result.Endpoint.ShouldBe(ENDPOINT_TAG_GENERATION);
             result.JobTimeToLive.ShouldBe(TimeSpan.FromSeconds(30));
+            jobResult.Value.ShouldBeFalse();
+            jobResult.IsSuccess.ShouldBeFalse();
+            jobResult.ResponseCode.ShouldBe(ApiResponseCode.BadRequest);
         }
 
         [Fact]
@@ -113,6 +117,7 @@ public async Task AutomaticTagGenerationAsync_ShouldReturnSuccess_WhenJobComplet
             // Assert
             completionResult.Value.ShouldBeTrue();
             completionResult.IsSuccess.ShouldBeTrue();
+            completionResult.ResponseCode.ShouldBe(ApiResponseCode.Success);
         }
 
         [Fact]
@@ -135,6 +140,7 @@ public async Task AutomaticTagGenerationAsync_ShouldReturnSuccess_WhenJobComplet
             // Assert
             completionResult.Value.ShouldBeTrue();
             completionResult.IsSuccess.ShouldBeTrue();
+            completionResult.ResponseCode.ShouldBe(ApiResponseCode.Success);
         }
 
         [Fact]
@@ -155,6 +161,7 @@ public async Task AutomaticTagGenerationAsync_ShouldReturnFailure_WhenJobFailsAf
             // Assert
             completionResult.Value.ShouldBeFalse();
             completionResult.IsSuccess.ShouldBeFalse();
+            completionResult.ResponseCode.ShouldBe(ApiResponseCode.Timeout);
         }
 
         [Fact]
@@ -180,6 +187,8 @@ public async Task AutomaticTagGenerationAsync_ShouldReturnFailure_WhenJobFailsAf
             // Assert
             completionResult.Value.ShouldBeFalse();
             completionResult.IsSuccess.ShouldBeFalse();
+            completionResult.ResponseCode.ShouldBe(ApiResponseCode.ServiceUnavailable);
+            completionResult.Message.ShouldBe(jobStatusFailed.Message);
         }
     }
 }

Kepware.Api.Test/ApiClient/ReinitializeRuntimeAsyncTests.cs

@@ -46,11 +46,16 @@ public async Task ReinitializeRuntimeAsync_ShouldReturnKepServerJobPromise_WhenA
 
             // Act
             var result = await _kepwareApiClient.ApiServices.ReinitializeRuntimeAsync(TimeSpan.FromSeconds(30));
-
+            var jobResult = await result.AwaitCompletionAsync();
+            
             // Assert
             result.ShouldNotBeNull();
             result.Endpoint.ShouldBe("/config/v1/project/services/ReinitializeRuntime");
             result.JobTimeToLive.ShouldBe(TimeSpan.FromSeconds(30));
+            jobResult.Value.ShouldBeFalse();
+            jobResult.IsSuccess.ShouldBeFalse();
+            jobResult.ResponseCode.ShouldBe(ApiResponseCode.BadRequest);
+            
         }
 
         [Fact]
@@ -111,6 +116,7 @@ public async Task ReinitializeRuntimeAsync_ShouldReturnSuccess_WhenJobCompletesS
             // Assert
             completionResult.Value.ShouldBeTrue();
             completionResult.IsSuccess.ShouldBeTrue();
+            completionResult.ResponseCode.ShouldBe(ApiResponseCode.Success);
         }
 
         [Fact]
@@ -133,6 +139,7 @@ public async Task ReinitializeRuntimeAsync_ShouldReturnSuccess_WhenJobCompletesS
             // Assert
             completionResult.Value.ShouldBeTrue();
             completionResult.IsSuccess.ShouldBeTrue();
+            completionResult.ResponseCode.ShouldBe(ApiResponseCode.Success);
         }
 
         [Fact]
@@ -153,6 +160,8 @@ public async Task ReinitializeRuntimeAsync_ShouldReturnFailure_WhenJobFailsAfter
             // Assert
             completionResult.Value.ShouldBeFalse();
             completionResult.IsSuccess.ShouldBeFalse();
+            completionResult.ResponseCode.ShouldBe(ApiResponseCode.Timeout);
+
         }
 
         [Fact]
@@ -178,6 +187,8 @@ public async Task ReinitializeRuntimeAsync_ShouldReturnFailure_WhenJobFailsAfter
             // Assert
             completionResult.Value.ShouldBeFalse();
             completionResult.IsSuccess.ShouldBeFalse();
+            completionResult.ResponseCode.ShouldBe(ApiResponseCode.ServiceUnavailable);
+            completionResult.Message.ShouldBe(jobStatusFailed.Message);
         }
     }
 }

Kepware.Api.TestIntg/appsettings.json

@@ -4,8 +4,8 @@
     "TestServer": {
       "Host": "http://localhost",
       "Port": 57412,
-      "UserName": "Administrator",
-      "Password": "ReallyStrongPassword400!"
+      "UserName": "Test",
+      "Password": "Kepware400400400"
     }
   }
 }

Kepware.Api/ClientHandler/ServicesApiHandler.cs

@@ -63,9 +63,17 @@ public async Task<KepServerJobPromise> ReinitializeRuntimeAsync(TimeSpan timeToL
 
             var response = await m_kepwareApiClient.HttpClient.PutAsync(ENDPOINT_REINITIALIZE_RUNTIME, httpContent, cancellationToken).ConfigureAwait(false);
 
-
             var message = await response.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false);
 
+            if (!response.IsSuccessStatusCode)
+            {
+                return new KepServerJobPromise(
+                    ENDPOINT_REINITIALIZE_RUNTIME, 
+                    timeToLive, 
+                    (ApiResponseCode)(int)response.StatusCode, 
+                    $"ReinitializeRuntimeAsync request failed with status code {(ApiResponseCode)(int)response.StatusCode} and message: {message}");
+            }
+
             try
             {
                 var jobResponse = JsonSerializer.Deserialize<JobResponseMessage>(message, KepJsonContext.Default.JobResponseMessage);
@@ -142,6 +150,15 @@ public async Task<KepServerJobPromise> AutomaticTagGenerationAsync(string channe
 
             var message = await response.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false);
 
+            if (!response.IsSuccessStatusCode)
+            {
+                return new KepServerJobPromise(
+                    endpoint,
+                    timeToLive,
+                    (ApiResponseCode)(int)response.StatusCode,
+                    $"AutomaticTagGeneration request failed with status code {(ApiResponseCode)(int)response.StatusCode} and message: {message}");
+            }
+
             try
             {
                 var jobResponse = JsonSerializer.Deserialize<JobResponseMessage>(message, KepJsonContext.Default.JobResponseMessage);