Merge branch 'main' into 23-feat-doc-1_0_0-release-documentation-updates

Author: rlabbeptc

Kepware.Api.Test/Serializer/YamlSerializerTests.cs

@@ -0,0 +1,120 @@
+using System.IO;
+using System.Threading;
+using System.Threading.Tasks;
+using Xunit;
+using Moq;
+using Microsoft.Extensions.Logging;
+using Kepware.Api.Model;
+using Kepware.Api.Serializer;
+using Shouldly;
+
+namespace Kepware.Api.Test.Serializer
+{
+
+    public class YamlSerializerTests
+    {
+        private static YamlSerializer CreateSerializer() =>
+            new YamlSerializer(new Mock<ILogger<YamlSerializer>>().Object);
+
+        [Fact]
+        public async Task LoadFromYaml_Should_Set_Name_From_Directory()
+        {
+            var serializer = CreateSerializer();
+            var path = Path.Combine(Path.GetTempPath(), "Channel1");
+            var file = Path.Combine(path, "channel.yaml");
+
+            Directory.CreateDirectory(path);
+            await File.WriteAllTextAsync(file, "description: test");
+
+            try
+            {
+                var result = await serializer.LoadFromYaml<Channel>(file);
+                result.Name.ShouldBe("Channel1");
+            }
+            finally
+            {
+                if (File.Exists(file)) File.Delete(file);
+                if (Directory.Exists(path)) Directory.Delete(path, true);
+            }
+        }
+
+        [Fact]
+        public async Task LoadFromYaml_Should_Create_Default_Entity_When_File_Missing()
+        {
+            var serializer = CreateSerializer();
+            var path = Path.Combine(Path.GetTempPath(), "ChannelMissing");
+            var file = Path.Combine(path, "missing.yaml");
+            Directory.CreateDirectory(path);
+
+            try
+            {
+                var result = await serializer.LoadFromYaml<Channel>(file);
+                result.ShouldNotBeNull();
+                result.Name.ShouldBe("ChannelMissing");
+            }
+            finally
+            {
+                if (Directory.Exists(path)) Directory.Delete(path, true);
+            }
+        }
+
+        [Fact]
+        public async Task SaveAsYaml_Should_Not_Overwrite_When_Content_Is_Same()
+        {
+            var serializer = CreateSerializer();
+            var path = Path.Combine(Path.GetTempPath(), "SameContent");
+            var file = Path.Combine(path, "file.yaml");
+
+            var entity = new Channel { Name = "Test" };
+            await serializer.SaveAsYaml(file, entity);
+
+            var initialWriteTime = File.GetLastWriteTimeUtc(file);
+            await Task.Delay(100); // Ensure timestamp could change
+
+            await serializer.SaveAsYaml(file, entity);
+            File.GetLastWriteTimeUtc(file).ShouldBe(initialWriteTime); // Should not have changed
+        }
+
+        [Fact]
+        public async Task SaveAsYaml_Should_Write_File_When_Not_Exists()
+        {
+            var serializer = CreateSerializer();
+            var path = Path.Combine(Path.GetTempPath(), "WriteNew");
+            var file = Path.Combine(path, "new.yaml");
+
+            if (Directory.Exists(path)) Directory.Delete(path, true);
+            var entity = new Channel { Name = "New" };
+            entity.Description = "New description";
+
+            await serializer.SaveAsYaml(file, entity);
+            File.Exists(file).ShouldBeTrue();
+
+            if (File.Exists(file)) File.Delete(file);
+            if (Directory.Exists(path)) Directory.Delete(path, true);
+        }
+
+
+        [Fact]
+        public async Task SaveAsYaml_Should_Delete_File_When_Default_Values()
+        {
+            var serializer = CreateSerializer();
+            var path = Path.Combine(Path.GetTempPath(), "WriteNew");
+            var file = Path.Combine(path, "new.yaml");
+
+            if (Directory.Exists(path)) Directory.Delete(path, true);
+            var entity = new Channel { Name = "New" };
+            entity.Description = "New description";
+
+            await serializer.SaveAsYaml(file, entity);
+            File.Exists(file).ShouldBeTrue();
+
+            if (File.Exists(file)) File.Delete(file);
+            if (Directory.Exists(path)) Directory.Delete(path, true);
+
+            entity.Description = null; // Set to default value
+
+            await serializer.SaveAsYaml(file, entity);
+            File.Exists(file).ShouldBeFalse();
+        }
+    }
+}

Kepware.Api/Serializer/YamlSerializer.cs

@@ -8,6 +8,7 @@
 using YamlDotNet.Serialization;
 using Microsoft.Extensions.Logging;
 using Kepware.Api.Util;
+using System.IO;
 
 namespace Kepware.Api.Serializer
 {
@@ -68,7 +69,11 @@ public async Task<T> LoadFromYaml<T>(string filePath, CancellationToken cancella
 
             if (entity is NamedEntity namedEntity)
             {
-                namedEntity.Name = file.DirectoryName!.Split('\\').Last().UnescapeDiskEntry();
+                if (file.Directory == null)
+                    throw new InvalidOperationException($"Directory of file {filePath} is null");
+
+                // Use DirectoryInfo.Name for robust, platform-independent directory name extraction
+                namedEntity.Name = file.Directory.Name.UnescapeDiskEntry();
             }
 
             return entity;
@@ -83,7 +88,7 @@ public async Task<T> LoadFromYaml<T>(string filePath, CancellationToken cancella
         public async Task SaveAsYaml(string filePath, object entity, CancellationToken cancellationToken = default)
         {
             var yaml = _serializer.Serialize(entity);
-            Directory.CreateDirectory(Path.GetDirectoryName(filePath)!); // Erstelle Verzeichnis, falls es nicht existiert
+            Directory.CreateDirectory(Path.GetDirectoryName(filePath)!); // Create directory if it doesn't exist
 
             if (yaml.Trim().Equals("{}"))
             {

README.md

@@ -2,6 +2,8 @@
 
 [![Build Status](https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/actions/workflows/dotnet.yml/badge.svg)](https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/actions)
 [![Build Status](https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/actions/workflows/docker-build-and-push.yml/badge.svg)](https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/actions)
+[![NuGet](https://img.shields.io/nuget/v/Kepware.Api.svg)](https://www.nuget.org/packages/Kepware.Api/)
+
 
 ## Overview
 The Kepware Configuration API SDK for .NET provides tools and libraries to interact with the Kepware Configuration REST API, enabling configuration management for Kepware servers. This repository includes examples and utilities to streamline development for deployment tools, including a service for continuous synchronization and an API client library.