Add logging to see what is actually sent to Cloud

SkylineCommunications · Dec 16, 2024 · e73f6fb · e73f6fb
1 parent f93ba21
commit e73f6fb
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 10 deletions.
diff --git a/CICD.Tools.CatalogUpload.Lib/CatalogArtifact.cs b/CICD.Tools.CatalogUpload.Lib/CatalogArtifact.cs
@@ -112,7 +112,7 @@ public async Task<ArtifactUploadResult> RegisterAsync(string dmCatalogToken)
         {
             CheckCatalogIdentifier(metaData.CatalogIdentifier);
 
-            var zipArray = await metaData.ToCatalogZipAsync(fs, serializer).ConfigureAwait(false);
+            var zipArray = await metaData.ToCatalogZipAsync(fs, serializer, _logger).ConfigureAwait(false);
             return await catalogService.RegisterCatalogAsync(zipArray, dmCatalogToken, cts.Token).ConfigureAwait(false);
         }
 
@@ -131,7 +131,7 @@ public async Task<ArtifactUploadResult> RegisterAsync()
             }
 
             CheckCatalogIdentifier(metaData.CatalogIdentifier);
-            var zipArray = await metaData.ToCatalogZipAsync(fs, serializer).ConfigureAwait(false);
+            var zipArray = await metaData.ToCatalogZipAsync(fs, serializer, _logger).ConfigureAwait(false);
             return await catalogService.RegisterCatalogAsync(zipArray, keyFromEnv, cts.Token).ConfigureAwait(false);
         }
 

diff --git a/CICD.Tools.CatalogUpload.Lib/CatalogMetaData.cs b/CICD.Tools.CatalogUpload.Lib/CatalogMetaData.cs
@@ -8,11 +8,14 @@
     using System.Text.RegularExpressions;
     using System.Threading.Tasks;
 
+    using Microsoft.Extensions.Logging;
+
     using Skyline.DataMiner.CICD.FileSystem;
     using Skyline.DataMiner.CICD.Tools.CatalogUpload.Lib.CatalogService;
 
     using YamlDotNet.Serialization;
     using YamlDotNet.Serialization.NamingConventions;
+
     using DirectoryInfo = Skyline.DataMiner.CICD.FileSystem.DirectoryInfoWrapper.DirectoryInfo;
 
     /// <summary>
@@ -322,9 +325,9 @@ public bool SearchAndApplyReadMe(IFileSystem fs, string startPath)
         /// Asynchronously creates a zip file containing catalog metadata, README.md, and images folder if available.
         /// </summary>
         /// <returns>A byte array representing the zip file.</returns>
-        public async Task<byte[]> ToCatalogZipAsync(IFileSystem fs, ISerializer serializer)
+        public async Task<byte[]> ToCatalogZipAsync(IFileSystem fs, ISerializer serializer, ILogger logger)
         {
-            CatalogYaml catalogYaml = new CatalogYaml()
+            CatalogYaml catalogYaml = new CatalogYaml
             {
                 Id = CatalogIdentifier,
                 DocumentationUrl = DocumentationUrl,
@@ -339,6 +342,8 @@ public async Task<byte[]> ToCatalogZipAsync(IFileSystem fs, ISerializer serializ
 
             var yaml = serializer.Serialize(catalogYaml);
 
+            logger.LogDebug($"manifest.yml for zip:{Environment.NewLine}{yaml}");
+
             // Create a zip file in memory that contains manifest.yml, README.md, and an Images folder as expected by the API
             using var memoryStream = new MemoryStream();
             using (var archive = new ZipArchive(memoryStream, ZipArchiveMode.Create, true))

diff --git a/CICD.Tools.CatalogUpload.LibTests/CatalogService/CatalogMetaDataTests.cs b/CICD.Tools.CatalogUpload.LibTests/CatalogService/CatalogMetaDataTests.cs
@@ -3,7 +3,7 @@
     using System.IO.Compression;
 
     using FluentAssertions;
-
+    using Microsoft.Extensions.Logging;
     using Microsoft.VisualStudio.TestTools.UnitTesting;
 
     using Moq;
@@ -354,6 +354,7 @@ public async Task ToCatalogZipAsync_ShouldCreateValidZipFile()
             // Arrange
             var mockFileSystem = new Mock<IFileSystem>();
             var mockSerializer = new Mock<ISerializer>();
+            var mockLogger = new Mock<ILogger>();
 
             // Mock YAML serialization
             mockSerializer.Setup(s => s.Serialize(It.IsAny<CatalogYaml>()))
@@ -385,7 +386,7 @@ public async Task ToCatalogZipAsync_ShouldCreateValidZipFile()
             };
 
             // Act
-            byte[] result = await catalogMetaData.ToCatalogZipAsync(mockFileSystem.Object, mockSerializer.Object);
+            byte[] result = await catalogMetaData.ToCatalogZipAsync(mockFileSystem.Object, mockSerializer.Object, mockLogger.Object);
 
             // Assert
             using var zipStream = new MemoryStream(result);
@@ -426,6 +427,7 @@ public async Task ToCatalogZipAsync_NoReadmeFile_ShouldNotIncludeReadme()
             // Arrange
             var mockFileSystem = new Mock<IFileSystem>();
             var mockSerializer = new Mock<ISerializer>();
+            var mockLogger = new Mock<ILogger>();
 
             // Mock YAML serialization
             mockSerializer.Setup(s => s.Serialize(It.IsAny<CatalogYaml>()))
@@ -450,7 +452,7 @@ public async Task ToCatalogZipAsync_NoReadmeFile_ShouldNotIncludeReadme()
             };
 
             // Act
-            byte[] result = await catalogMetaData.ToCatalogZipAsync(mockFileSystem.Object, mockSerializer.Object);
+            byte[] result = await catalogMetaData.ToCatalogZipAsync(mockFileSystem.Object, mockSerializer.Object, mockLogger.Object);
 
             // Assert
             using var zipStream = new MemoryStream(result);
@@ -482,6 +484,7 @@ public async Task ToCatalogZipAsync_ImagesFolderEmpty_ShouldNotIncludeImages()
             // Arrange
             var mockFileSystem = new Mock<IFileSystem>();
             var mockSerializer = new Mock<ISerializer>();
+            var mockLogger = new Mock<ILogger>();
 
             // Mock YAML serialization
             mockSerializer.Setup(s => s.Serialize(It.IsAny<CatalogYaml>()))
@@ -505,7 +508,7 @@ public async Task ToCatalogZipAsync_ImagesFolderEmpty_ShouldNotIncludeImages()
             };
 
             // Act
-            byte[] result = await catalogMetaData.ToCatalogZipAsync(mockFileSystem.Object, mockSerializer.Object);
+            byte[] result = await catalogMetaData.ToCatalogZipAsync(mockFileSystem.Object, mockSerializer.Object, mockLogger.Object);
 
             // Assert
             using var zipStream = new MemoryStream(result);
@@ -530,6 +533,7 @@ public async Task ToCatalogZipAsync_NoReadmeOrImages_ShouldOnlyContainManifest()
             // Arrange
             var mockFileSystem = new Mock<IFileSystem>();
             var mockSerializer = new Mock<ISerializer>();
+            var mockLogger = new Mock<ILogger>();
 
             // Mock YAML serialization
             mockSerializer.Setup(s => s.Serialize(It.IsAny<CatalogYaml>()))
@@ -546,7 +550,7 @@ public async Task ToCatalogZipAsync_NoReadmeOrImages_ShouldOnlyContainManifest()
             };
 
             // Act
-            byte[] result = await catalogMetaData.ToCatalogZipAsync(mockFileSystem.Object, mockSerializer.Object);
+            byte[] result = await catalogMetaData.ToCatalogZipAsync(mockFileSystem.Object, mockSerializer.Object, mockLogger.Object);
 
             // Assert
             using var zipStream = new MemoryStream(result);
@@ -571,6 +575,7 @@ public async Task ToCatalogZipAsync_LargeNumberOfImageFiles_ShouldIncludeAllImag
             // Arrange
             var mockFileSystem = new Mock<IFileSystem>();
             var mockSerializer = new Mock<ISerializer>();
+            var mockLogger = new Mock<ILogger>();
 
             // Mock YAML serialization
             mockSerializer.Setup(s => s.Serialize(It.IsAny<CatalogYaml>()))
@@ -601,7 +606,7 @@ public async Task ToCatalogZipAsync_LargeNumberOfImageFiles_ShouldIncludeAllImag
             };
 
             // Act
-            byte[] result = await catalogMetaData.ToCatalogZipAsync(mockFileSystem.Object, mockSerializer.Object);
+            byte[] result = await catalogMetaData.ToCatalogZipAsync(mockFileSystem.Object, mockSerializer.Object, mockLogger.Object);
 
             // Assert
             using var zipStream = new MemoryStream(result);