Feat(sdk) modify project properties support (#28)

* feat(api): Add project properties model

* feat(api): update property definition class design

* feat(api): add project properties to project class

* feat(api): add relevant properties to nonserialize and nonupdatable classes

* feat(api): add get and set project proptery methods

* feat(api): add projectProperties data type

* feat(test): add tests for project properties

* fix(api): corrected attributes and removed base type for ProjectProperties

* fix(test): removed property in test due to base class change

* feat(api): Update Project Properties when doing a project comparison

* feat(api): Updated CompareAndApply for project properties

* chore(api): fix merge

---------

Co-authored-by: Bo Biene <23037659+BoBiene@users.noreply.github.com>

Author: rlabbeptc

Kepware.Api.Test/ApiClient/AutomaticTagGenerationAsyncTests.cs

@@ -149,8 +149,8 @@ public async Task AutomaticTagGenerationAsync_ShouldReturnFailure_WhenJobFailsAf
                 .ReturnsResponse(HttpStatusCode.OK, JsonSerializer.Serialize(jobStatus), "application/json");
 
             // Act
-            var result = await _kepwareApiClient.ApiServices.AutomaticTagGenerationAsync(UNIT_TEST_CHANNEL, UNIT_TEST_DEVICE, TimeSpan.FromSeconds(2));
-            var completionResult = await result.AwaitCompletionAsync();
+            var result = await _kepwareApiClient.ApiServices.AutomaticTagGenerationAsync(UNIT_TEST_CHANNEL, UNIT_TEST_DEVICE, TimeSpan.FromSeconds(1));
+            var completionResult = await result.AwaitCompletionAsync(TimeSpan.FromMilliseconds(100));
 
             // Assert
             completionResult.Value.ShouldBeFalse();
@@ -175,7 +175,7 @@ public async Task AutomaticTagGenerationAsync_ShouldReturnFailure_WhenJobFailsAf
 
             // Act
             var result = await _kepwareApiClient.ApiServices.AutomaticTagGenerationAsync(UNIT_TEST_CHANNEL, UNIT_TEST_DEVICE, TimeSpan.FromSeconds(5));
-            var completionResult = await result.AwaitCompletionAsync();
+            var completionResult = await result.AwaitCompletionAsync(TimeSpan.FromMilliseconds(100));
 
             // Assert
             completionResult.Value.ShouldBeFalse();

Kepware.Api.Test/ApiClient/ProjectPropertiesTests.cs

@@ -147,8 +147,8 @@ public async Task ReinitializeRuntimeAsync_ShouldReturnFailure_WhenJobFailsAfter
                 .ReturnsResponse(HttpStatusCode.OK, JsonSerializer.Serialize(jobStatus), "application/json");
 
             // Act
-            var result = await _kepwareApiClient.ApiServices.ReinitializeRuntimeAsync(TimeSpan.FromSeconds(2));
-            var completionResult = await result.AwaitCompletionAsync();
+            var result = await _kepwareApiClient.ApiServices.ReinitializeRuntimeAsync(TimeSpan.FromSeconds(1));
+            var completionResult = await result.AwaitCompletionAsync(TimeSpan.FromMilliseconds(100));
 
             // Assert
             completionResult.Value.ShouldBeFalse();
@@ -173,7 +173,7 @@ public async Task ReinitializeRuntimeAsync_ShouldReturnFailure_WhenJobFailsAfter
 
             // Act
             var result = await _kepwareApiClient.ApiServices.ReinitializeRuntimeAsync(TimeSpan.FromSeconds(5));
-            var completionResult = await result.AwaitCompletionAsync();
+            var completionResult = await result.AwaitCompletionAsync(TimeSpan.FromMilliseconds(100));
 
             // Assert
             completionResult.Value.ShouldBeFalse();

Kepware.Api.Test/ApiClient/ReinitializeRuntimeAsyncTests.cs

@@ -23,6 +23,7 @@ public abstract class TestApiClientBase
         protected readonly Mock<HttpMessageHandler> _httpMessageHandlerMock;
         protected readonly Mock<ILogger<KepwareApiClient>> _loggerMock;
         protected readonly Mock<ILogger<AdminApiHandler>> _loggerMockAdmin;
+        protected readonly Mock<ILogger<ProjectApiHandler>> _loggerMockProject;
         protected readonly Mock<ILogger<GenericApiHandler>> _loggerMockGeneric;
         protected readonly Mock<ILoggerFactory> _loggerFactoryMock;
         protected readonly KepwareApiClient _kepwareApiClient;
@@ -33,6 +34,7 @@ protected TestApiClientBase()
             _loggerMock = new Mock<ILogger<KepwareApiClient>>();
             _loggerMockAdmin = new Mock<ILogger<AdminApiHandler>>();
             _loggerMockGeneric = new Mock<ILogger<GenericApiHandler>>();
+            _loggerMockProject = new Mock<ILogger<ProjectApiHandler>>();
             _loggerFactoryMock = new Mock<ILoggerFactory>();
 
             _loggerFactoryMock.Setup(factory => factory.CreateLogger(It.IsAny<string>())).Returns((string name) =>
@@ -43,6 +45,8 @@ protected TestApiClientBase()
                     return _loggerMockAdmin.Object;
                 else if (name == typeof(GenericApiHandler).FullName)
                     return _loggerMockGeneric.Object;
+                else if (name == typeof(ProjectApiHandler).FullName)
+                    return _loggerMockProject.Object;
                 else
                     return Mock.Of<ILogger>();
             });

Kepware.Api.Test/ApiClient/_TestApiClientBase.cs

@@ -7,6 +7,7 @@
 using System.Diagnostics;
 using System.Globalization;
 using System.Linq;
+using System.Net.Http;
 using System.Text;
 using System.Text.Json;
 using System.Threading.Tasks;
@@ -67,8 +68,12 @@ public ProjectApiHandler(KepwareApiClient kepwareApiClient, ChannelApiHandler ch
         {
             if (sourceProject.Hash != projectFromApi.Hash)
             {
-                //TODO update project
-                m_logger.LogInformation("[not implemented] Project has changed. Updating project...");
+                m_logger.LogInformation("Project properties has changed. Updating project properties...");
+                var result = await SetProjectPropertiesAsync(projectFromApi, cancellationToken: cancellationToken).ConfigureAwait(false);
+                if (!result)
+                {
+                    m_logger.LogError("Failed to update project properties...");
+                }
             }
             int inserts = 0, updates = 0, deletes = 0;
 
@@ -126,6 +131,76 @@ public ProjectApiHandler(KepwareApiClient kepwareApiClient, ChannelApiHandler ch
         }
         #endregion
 
+        #region ProjectProperties
+
+        /// <summary>
+        /// Gets the project properties from the Kepware server.
+        /// </summary>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        /// <exception cref="InvalidOperationException"></exception>
+        public async Task<Project?> GetProjectPropertiesAsync(CancellationToken cancellationToken = default)
+        {
+            var project = await m_kepwareApiClient.GenericConfig.LoadEntityAsync<Project>(name: null, cancellationToken: cancellationToken).ConfigureAwait(false);
+            return project;
+
+        }
+
+        /// <summary>
+        /// Sets the project properties on the Kepware server.
+        /// </summary>
+        /// <param name="project"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        /// <exception cref="InvalidOperationException"></exception>
+        public async Task<bool> SetProjectPropertiesAsync(Project project, CancellationToken cancellationToken = default)
+        {
+            try
+            {
+                var currentProject = await m_kepwareApiClient.GenericConfig.LoadEntityAsync<Project>(name: null, cancellationToken: cancellationToken).ConfigureAwait(false);
+
+                if (currentProject == null)
+                {
+                    throw new InvalidOperationException("Failed to retrieve current settings");
+                }
+
+                var endpoint = EndpointResolver.ResolveEndpoint<Project>();
+                var diff = project.GetUpdateDiff(currentProject);
+
+                // Need to ensure ProjectId is captured. GetUpdateDiff doesn't return ProjectId on non_NamedEntity types
+                diff.Add(Properties.ProjectId, KepJsonContext.WrapInJsonElement(currentProject.ProjectId));
+
+                m_logger.LogInformation("Updating Project Property Settings on {Endpoint}, values {Diff}", endpoint, diff);
+
+                HttpContent httpContent = new StringContent(
+                         JsonSerializer.Serialize(diff, KepJsonContext.Default.DictionaryStringJsonElement),
+                         Encoding.UTF8,
+                         "application/json"
+                     );
+
+                var response = await m_kepwareApiClient.HttpClient.PutAsync(endpoint, httpContent, cancellationToken).ConfigureAwait(false);
+
+                if (!response.IsSuccessStatusCode)
+                {
+                    var message = await response.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false);
+                    m_logger.LogError("Failed to update Project Property Settings from {Endpoint}: {ReasonPhrase}\n{Message}", endpoint, response.ReasonPhrase, message);
+                }
+                else
+                {
+                    return true;
+                }
+            }
+            catch (HttpRequestException httpEx)
+            {
+                m_logger.LogWarning(httpEx, "Failed to connect to {BaseAddress}", m_kepwareApiClient.HttpClient.BaseAddress);
+                m_kepwareApiClient.OnHttpRequestException(httpEx);
+            }
+
+            return false;
+        }
+
+        #endregion
+
         #region LoadProject
         /// <summary>
         /// Loads the project from the Kepware server.