Added SourceCodeUrl

Author: janstaelensskyline

CICD.Tools.GitHubToCatalogYamlTests/CatalogManagerTests.cs

@@ -106,6 +106,25 @@ public async Task ProcessCatalogYamlAsync_ShouldCreateNewManifestFile_WhenCatalo
             mockFileSystem.Verify(fs => fs.File.WriteAllText(manifestFilePath, It.IsAny<string>()), Times.Once); // Ensure it saves to catalog.yml
         }
 
+        [TestMethod]
+        public async Task ProcessCatalogYamlAsync_ShouldSetSourceCodeUrl_WhenMissing()
+        {
+            // Arrange
+            var repoName = "SkylineCommunications/KPN-AS-OutageReport";
+            var yamlContent = "id: testId\nshort_description: test description"; // No SourceCodeUrl in the initial YAML
+            var expectedSourceCodeUrl = $"https://github.com/{repoName}";
+
+            mockFileSystem.Setup(fs => fs.File.Exists(catalogFilePath)).Returns(true);
+            mockFileSystem.Setup(fs => fs.File.ReadAllText(catalogFilePath)).Returns(yamlContent); // Simulate existing catalog.yml
+
+            // Act
+            await catalogManager.ProcessCatalogYamlAsync(repoName);
+
+            // Assert
+            mockFileSystem.Verify(fs => fs.File.WriteAllText(catalogFilePath, It.Is<string>(s => s.Contains($"source_code_url: {expectedSourceCodeUrl}"))), Times.Once);
+        }
+
+
         [TestMethod]
         public async Task ProcessCatalogYamlAsync_ShouldAssignNewId_WhenIdIsMissing()
         {

Skyline.DataMiner.CICD.Tools.GitHubToCatalogYaml/CatalogManager.cs

@@ -59,10 +59,12 @@ public async Task ProcessCatalogYamlAsync(string repoName, string catalogIdentif
             CatalogYaml catalogYaml = CreateCatalogYaml(deserializer, out string filePath);
             CatalogYaml autoGeneratedCatalogYaml = CreateAutoGeneratedCatalogYaml(deserializer, out string autoGenFilePath);
 
-            await CheckId(catalogYaml, autoGeneratedCatalogYaml, catalogIdentifier);
+            CheckId(catalogYaml, autoGeneratedCatalogYaml, catalogIdentifier);
 
             await CheckShortDescription(catalogYaml);
 
+            CheckSourceCodeUrl(catalogYaml, repoName);
+
             await CheckTags(catalogYaml);
 
             CleanTitle parsedRepoName = CheckTitle(repoName, catalogYaml);
@@ -76,17 +78,19 @@ public async Task ProcessCatalogYamlAsync(string repoName, string catalogIdentif
             // Save both the catalog.yml and the auto-generated-catalog.yml
             // The auto-generated-catalog.yml will be committed & pushed by the pipeline when changed.
             SaveFile(catalogYaml, serializer, outputPath);
-            SaveFile(catalogYaml, serializer, autoGeneratedOutputPath);
-            logger.LogInformation($"Finished. Updated or Created auto-generated file with path: {outputPath}");
             logger.LogInformation($"Finished. Updated or Created file with path: {outputPath}");
+            SaveFile(catalogYaml, serializer, autoGeneratedOutputPath);
+            logger.LogInformation($"Finished. Updated or Created auto-generated file with path: {autoGeneratedOutputPath}");
         }
 
         /// <summary>
-        /// Checks if the catalog ID exists in the YAML file, and if not, it retrieves or generates a new catalog ID from GitHub and updates the file accordingly.
+        /// Checks and sets the ID field in the provided catalog YAML. 
+        /// If the ID is not present or is empty, it attempts to retrieve or create a new ID using the provided catalog identifier, or the ID from the auto-generated catalog YAML.
         /// </summary>
         /// <param name="catalogYaml">The catalog YAML object to check and update.</param>
-        /// <returns>A task that represents the asynchronous operation.</returns>
-        private async Task CheckId(CatalogYaml catalogYaml, CatalogYaml autoGeneratedCatalogYaml, string catalogIdentifier)
+        /// <param name="autoGeneratedCatalogYaml">The auto-generated catalog YAML object used to retrieve the ID if necessary.</param>
+        /// <param name="catalogIdentifier">The catalog identifier to be used if no ID is present in the catalog YAML.</param>
+        private void CheckId(CatalogYaml catalogYaml, CatalogYaml autoGeneratedCatalogYaml, string catalogIdentifier)
         {
             logger.LogDebug("Checking if ID was user provided, otherwise retrieve or create it...");
             if (String.IsNullOrWhiteSpace(catalogYaml.Id))
@@ -129,6 +133,23 @@ private async Task CheckShortDescription(CatalogYaml catalogYaml)
             }
         }
 
+        /// <summary>
+        /// Checks and sets the SourceCodeUrl field in the provided catalog YAML. 
+        /// If the SourceCodeUrl is not present or is empty, it assigns a GitHub repository URL based on the provided repository name.
+        /// </summary>
+        /// <param name="catalogYaml">The catalog YAML object to check and update.</param>
+        /// <param name="repoName">The name of the GitHub repository to generate the SourceCodeUrl.</param>
+        private void CheckSourceCodeUrl(CatalogYaml catalogYaml, string repoName)
+        {
+            logger.LogDebug("Checking if SourceCodeUrl exists, otherwise create sourcecode url from repository name...");
+            if (String.IsNullOrWhiteSpace(catalogYaml.SourceCodeUrl))
+            {
+                var sourceCodeUrl = "https://github.com/" + repoName;
+                catalogYaml.SourceCodeUrl = sourceCodeUrl;
+                logger.LogDebug($"Sourcecode url applied: {sourceCodeUrl}");
+            }
+        }
+
         /// <summary>
         /// Checks if the tags exist in the YAML file. If they are missing, it retrieves repository topics from GitHub and adds them to the YAML file, ensuring that the tags are distinct.
         /// </summary>
@@ -321,7 +342,7 @@ private void SaveFile(CatalogYaml catalogYaml, ISerializer serializer, string ou
             Thread.Sleep(500);
             var updatedYaml = serializer.Serialize(catalogYaml);
 
-            var parentDir = fs.Path.GetDirectoryName(outputPath);         
+            var parentDir = fs.Path.GetDirectoryName(outputPath);
             fs.Directory.CreateDirectory(parentDir);
             fs.Directory.TryAllowWritesOnDirectory(parentDir);