Preparation for CatalogReferences

Author: MichielOda

Sdk/Helpers/CatalogReferencesHelper.cs

@@ -0,0 +1,92 @@
+namespace Skyline.DataMiner.Sdk.Helpers
+{
+    using System;
+    using System.Collections.Generic;
+    using System.IO;
+    using System.Linq;
+    using System.Net.Http;
+    using System.Xml;
+    using System.Xml.Linq;
+
+    using Skyline.DataMiner.CICD.FileSystem;
+    using Skyline.DataMiner.CICD.Parsers.Common.VisualStudio.Projects;
+
+    internal static class CatalogReferencesHelper
+    {
+        public static bool TryResolveCatalogReferences(Project packageProject, out List<string> includedPackages, out string errorMessage)
+        {
+            includedPackages = null;
+            errorMessage = null;
+
+            string rootFolder = FileSystem.Instance.Directory.GetParentDirectory(packageProject.ProjectDirectory);
+            const string xmlFileName = "CatalogReferences.xml";
+            string xmlFilePath = FileSystem.Instance.Path.Combine(packageProject.ProjectDirectory, "PackageContent", xmlFileName);
+
+            try
+            {
+                includedPackages = ResolveCatalogReferences(xmlFilePath);
+                return true;
+            }
+            catch (FileNotFoundException)
+            {
+                errorMessage = $"{xmlFileName} could not be found. Please make sure this file has been added with the default content.";
+            }
+            catch (XmlException xe)
+            {
+                errorMessage = $"XmlException: Please validate the {xmlFileName} file. ({xe.Message})";
+            }
+            catch (Exception e)
+            {
+                errorMessage = $"Unexpected exception occured: {e}";
+            }
+
+            return false;
+        }
+
+        private static List<string> ResolveCatalogReferences(string xmlFilePath)
+        {
+            throw new NotSupportedException();
+
+            // Load the XML file
+            var doc = XDocument.Load(xmlFilePath);
+            XNamespace ns = "http://www.skyline.be/catalogReferences";
+
+            var catalogItems = doc.Descendants(ns + "CatalogReference").ToList();
+
+            using (HttpClient client = new HttpClient())
+            {
+                //ICatalogService service = Downloader.FromCatalog(client);
+                foreach (XElement catalogItem in catalogItems)
+                {
+                    if (!Guid.TryParse(catalogItem.Attribute("id")?.Value, out Guid catalogItemGuid))
+                    {
+                        continue;
+                    }
+
+                    XElement selection = catalogItem.Element(ns + "Selection");
+                    if (selection == null || !selection.HasElements)
+                    {
+                        continue;
+                    }
+
+                    string specific = selection.Element(ns + "Specific")?.Value;
+                    if (!String.IsNullOrWhiteSpace(specific))
+                    {
+                        //CatalogIdentifier identifier = CatalogIdentifier.WithVersion(catalogItemGuid, specific);
+
+                        // Download specific version (if exists)
+                        continue;
+                    }
+
+                    XElement range = selection.Element(ns + "Range");
+                    if (!String.IsNullOrWhiteSpace(range?.Value))
+                    {
+                        Boolean.TryParse(range.Attribute("allowPrerelease")?.Value, out bool allowPrerelease);
+                        //CatalogIdentifier identifier = CatalogIdentifier.WithRange(catalogItemGuid, range.Value, allowPrerelease);
+                        // Download latest version of range
+                    }
+                }
+            }
+        }
+    }
+}

Sdk/Helpers/ProjectReferenceHelper.cs Sdk/Helpers/ProjectReferencesHelper.cs

@@ -12,7 +12,7 @@
     using Skyline.DataMiner.CICD.FileSystem;
     using Skyline.DataMiner.CICD.Parsers.Common.VisualStudio.Projects;
 
-    internal static class ProjectReferenceHelper
+    internal static class ProjectReferencesHelper
     {
         public static bool TryResolveProjectReferences(Project packageProject, out List<string> includedProjectPaths, out string errorMessage)
         {
@@ -130,13 +130,5 @@ private static bool MatchesPattern(string filePath, string pattern)
             string normalizedPattern = pattern.Replace("*", ".*").Replace(@"\", @"\\");
             return Regex.IsMatch(filePath, normalizedPattern, RegexOptions.IgnoreCase);
         }
-
-        private class SolutionFilter
-        {
-            public string Path { get; set; }
-
-            public string[] Projects { get; set; }
-        }
-
     }
 }

Sdk/Tasks/DmappCreation.cs

@@ -106,7 +106,10 @@ public override bool Execute()
                     baseLocation = FileSystem.Instance.Path.GetFullPath(FileSystem.Instance.Path.Combine(preparedData.Project.ProjectDirectory, BaseOutputPath));
                 }
 
-                string destinationFilePath = Path.Combine(baseLocation, Configuration, $"{PackageId}.{PackageVersion}.dmapp");
+                string destinationFilePath = FileSystem.Instance.Path.Combine(baseLocation, Configuration, $"{PackageId}.{PackageVersion}.dmapp");
+
+                // Create directories in case they don't exist yet
+                FileSystem.Instance.Directory.CreateDirectory(FileSystem.Instance.Path.GetDirectoryName(destinationFilePath));
                 IAppPackage package = appPackageBuilder.Build();
                 string about = package.CreatePackage(destinationFilePath);
                 Log.LogMessage(MessageImportance.Low, $"About created package:{Environment.NewLine}{about}");
@@ -160,7 +163,7 @@ private void AddProjectToPackage(PackageCreationData preparedData, AppPackage.Ap
 
         private void PackageProjectReferences(PackageCreationData preparedData, AppPackage.AppPackageBuilder appPackageBuilder)
         {
-            if (!ProjectReferenceHelper.TryResolveProjectReferences(preparedData.Project, out List<string> includedProjectPaths, out string errorMessage))
+            if (!ProjectReferencesHelper.TryResolveProjectReferences(preparedData.Project, out List<string> includedProjectPaths, out string errorMessage))
             {
                 Log.LogError(errorMessage);
                 return;