feat(pack): support app packing

cmf-cli/Commands/init/InitCommand.cs

@@ -276,7 +276,7 @@ internal void Execute(InitArguments x)
                 }
 
                 args.AddRange(new[]
-{
+                {
                     "--appName", x.appName,
                     "--appId", x.appId,
                     "--appIcon", x.appIcon ?? string.Empty,
@@ -417,6 +417,11 @@ internal void Execute(InitArguments x)
                 x.config.CopyTo(this.fileSystem.Path.Join(envConfigPath, x.config.Name));
                 this.fileSystem.FileInfo.New(this.fileSystem.Path.Join(envConfigPath, ".gitkeep")).Delete();
             }
+
+            if (x.repositoryType == RepositoryType.App)
+            {
+                Log.Information($"Apps need to have an ApplicationVersion package. Make sure you create at least one business package for your application using the addApplicationVersionAssembly flag");
+            }
         }
 
         bool isToIgnoreOptionToken = false;

cmf-cli/Handlers/PackageType/RootPackageTypeHandler.cs

@@ -1,6 +1,13 @@
 using Cmf.CLI.Constants;
+using Cmf.CLI.Core;
 using Cmf.CLI.Core.Enums;
 using Cmf.CLI.Core.Objects;
+using Cmf.CLI.Core.Objects.CmfApp;
+using Cmf.CLI.Core.Utilities;
+using Cmf.CLI.Utilities;
+using System.IO;
+using System.IO.Abstractions;
+using static NuGet.Packaging.PackagingConstants;
 
 
 namespace Cmf.CLI.Handlers
@@ -11,6 +18,15 @@ namespace Cmf.CLI.Handlers
     /// <seealso cref="PackageTypeHandler" />
     public class RootPackageTypeHandler : PackageTypeHandler
     {
+        #region Private Properties
+
+        /// <summary>
+        /// The CMF app data object
+        /// </summary>
+        private CmfApp CmfApp;
+
+        #endregion
+
         /// <summary>
         /// Initializes a new instance of the <see cref="RootPackageTypeHandler" /> class.
         /// </summary>
@@ -27,5 +43,76 @@ public RootPackageTypeHandler(CmfPackage cmfPackage) : base(cmfPackage)
 
             cmfPackage.DFPackageType = PackageType.Generic;
         }
+
+        /// <summary>
+        /// Packs the specified package output dir. If root package is an app, packs app files
+        /// </summary>
+        /// <param name="packageOutputDir"></param>
+        /// <param name="outputDir"></param>
+        public override void Pack(IDirectoryInfo packageOutputDir, IDirectoryInfo outputDir)
+        {
+            if (ExecutionContext.Instance.ProjectConfig?.RepositoryType == RepositoryType.App)
+            {
+                GenerateAppFiles(packageOutputDir, outputDir);
+            }
+
+            base.Pack(packageOutputDir, outputDir);
+        }
+
+        /// <summary>
+        /// Generates the deployment framework app manifest and the app icon image.
+        /// </summary>
+        /// <param name="packageOutputDir">The package output dir.</param>
+        /// <exception cref="CliException"></exception>
+        internal virtual void GenerateAppFiles(IDirectoryInfo packageOutputDir, IDirectoryInfo outputDir)
+        {
+            Log.Debug("Generating App manifest");
+            string path = packageOutputDir.FullName;
+
+            IFileInfo cmfAppFile = fileSystem.FileInfo.New(CliConstants.CmfAppFileName);
+
+            CmfApp = CmfApp.Load(cmfAppFile, fileSystem);
+
+            if (string.IsNullOrWhiteSpace(CmfApp.Content.App.Image.File))
+            {
+                string defaultIconPath = Path.Combine(
+                    FileSystemUtilities.GetProjectRoot(fileSystem, throwException: true).FullName,
+                    CliConstants.AssetsFolder,
+                    CliConstants.DefaultAppIcon);
+
+                CmfApp.Content.App.Image.File = defaultIconPath;
+            }
+            else if (!AppIconUtilities.IsIconValid(CmfApp.Content.App.Image.File))
+            {
+                throw new CliException(string.Format(CoreMessages.InvalidValue, cmfAppFile.FullName));
+            }
+
+            fileSystem.Directory.CreateDirectory(path);
+
+            CmfApp.SaveIcon(path, CliConstants.AppIcon);
+            CmfApp.Content.App.Image.File = CliConstants.AppIcon;
+
+            string manifestPath = Path.Combine(path, CliConstants.DeploymentFrameworkAppManifestFileName);
+            CmfApp.Save(manifestPath);
+
+            string appPackage = $"{CmfApp.Content.App.Name}@{CmfPackage.Version}.zip";
+            string tempzipPath = Path.Combine(packageOutputDir.FullName, appPackage);
+            if (this.fileSystem.File.Exists(tempzipPath))
+            {
+                this.fileSystem.File.Delete(tempzipPath);
+            }
+
+            FileSystemUtilities.ZipDirectory(fileSystem, tempzipPath, packageOutputDir);
+
+            // move to final destination
+            string destZipPath = Path.Combine(outputDir.FullName, appPackage);
+            this.fileSystem.File.Move(tempzipPath, destZipPath, true);
+
+            // clean up folder files
+            string iconDestinationPath = Path.Combine(path, CmfApp.Content.App.Image.File);
+            fileSystem.File.Delete(iconDestinationPath);
+            fileSystem.File.Delete(manifestPath);
+        }
+
     }
 }

cmf-cli/resources/templateFiles/app_manifest.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<App id="$(id)"
+	 version="$(version)"
+	 author="$(author)"
+	 name="$(name)"
+	 description="$(description)"
+	 xmlns:metadata="$(metadata)">
+	<metadata:Framework version="$(frameworkVersion)"/>
+	<metadata:LicensedApplication name="$(licensedApplication)"/>
+	<metadata:Image file="$(image)"/>
+</App>

core/Commands/TemplateCommand.cs

@@ -6,6 +6,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Cmf.CLI.Core.Constants;
+using Cmf.CLI.Core.Enums;
 using Cmf.CLI.Core.Objects;
 using Cmf.CLI.Utilities;
 using Microsoft.Extensions.DependencyInjection;

core/Constants/CoreConstants.cs

@@ -31,6 +31,11 @@ public static class CoreConstants
         /// </summary>
         public const string PackageJson = "package.json";
 
+        /// <summary>
+        /// The CMF app file name
+        /// </summary>
+        public const string CmfAppFileName = "cmfapp.json";
+
         /// <summary>
         /// The project config file name, located in the project root
         /// </summary>

core/Objects/CmfApp.cs

@@ -0,0 +1,164 @@
+using System;
+using System.IO;
+using System.IO.Abstractions;
+using System.Linq;
+using System.Xml.Serialization;
+using Cmf.CLI.Core.Enums;
+using Cmf.CLI.Utilities;
+using Newtonsoft.Json;
+
+namespace Cmf.CLI.Core.Objects.CmfApp;
+
+/// <summary>
+/// CMF App data
+/// </summary>
+public record AppData
+{
+    public string id { get; set; }
+    public string name { get; set; }
+    public string author { get; set; }
+    public string description { get; set; }
+    public string targetFramework { get; set; }
+    public string licensedApplication { get; set; }
+    public string icon { get; set; }
+}
+
+/// <summary>
+/// Target framework of the app
+/// </summary>
+public record Framework
+{
+    [XmlAttribute("version")]
+    public string Version { get; set; }
+}
+
+/// <summary>
+/// App license related data
+/// </summary>
+public record LicensedApplication
+{
+    [XmlAttribute("name")]
+    public string Name { get; set; }
+}
+
+/// <summary>
+/// App icon file information
+/// </summary>
+public record Image
+{
+    [XmlAttribute("file")]
+    public string File { get; set; }
+}
+
+/// <summary>
+/// CMF App data object for serialization Version 1
+/// </summary>
+[XmlRoot("App")]
+public record CmfAppV1
+{
+    [XmlAttribute("id")] public string Id { get; set; }
+    [XmlAttribute("author")] public string Author { get; set; }
+    [XmlAttribute("name")] public string Name { get; set; }
+    [XmlAttribute("description")] public string Description { get; set; }
+    [XmlElement(Namespace = "urn:cmf:dp:xml:ns:app-metadata-v1")] public Framework Framework { get; set; }
+    [XmlElement(Namespace = "urn:cmf:dp:xml:ns:app-metadata-v1")] public LicensedApplication LicensedApplication { get; set; }
+    [XmlElement(Namespace = "urn:cmf:dp:xml:ns:app-metadata-v1")] public Image Image { get; set; }
+}
+
+/// <summary>
+/// CMF App container for data and metadata
+/// </summary>
+public record AppContainer
+{
+    public record HeaderRec
+    {
+        public string Version => "1.0";
+        public string Encoding => "utf-8";
+    }
+
+    [JsonProperty("?xml")] public HeaderRec Header => new HeaderRec();
+
+    [XmlElement("App")]
+    [JsonProperty("App")] public CmfAppV1 App { get; set; }
+}
+
+/// <summary>
+/// CMF App content data object handler class
+/// </summary>
+public class CmfApp
+{
+    public IFileInfo FileInfo { get; private set; }
+    public PackageLocation Location { get; private set; }
+    public IFileSystem FileSystem { get; private set; }
+    public AppContainer Content { get; private set; }
+    public string PackageName => Content.App.Id;
+
+    /// <summary>
+    /// Loads CmfApp data object from a specified file using file system from the execution context.
+    /// </summary>
+    /// <param name="file">The file to load the CmfApp from.</param>
+    /// <param name="fileSystem">Optional parameter specifying the file system to use for file operations.</param>
+    /// <returns>The loaded CmfApp instance.</returns>
+    public static CmfApp Load(IFileInfo file, IFileSystem fileSystem = null)
+    {
+        fileSystem ??= ExecutionContext.Instance.FileSystem;
+        if (!file.Exists)
+        {
+            throw new CliException(string.Format(CoreMessages.NotFound, file.FullName));
+        }
+
+        string fileContent = file.ReadToString();
+
+        var appData = JsonConvert.DeserializeObject<AppData>(fileContent);
+
+        CmfAppV1 cmfAppData = new()
+        {
+            Id = appData.id,
+            Author = appData.author,
+            Name = appData.name,
+            Description = appData.description,
+            Framework = new Framework { Version = appData.targetFramework },
+            LicensedApplication = new LicensedApplication { Name = appData.licensedApplication },
+            Image = new Image { File = appData.icon }
+        };
+
+        CmfApp cmfApp = new()
+        {
+            Content = new AppContainer { App = cmfAppData },
+            FileInfo = file,
+            Location = PackageLocation.Local,
+            FileSystem = fileSystem,
+        };
+
+        return cmfApp;
+    }
+
+    /// <summary>
+    /// Serializes the content of the CmfApp instance and saves it to the specified path as an XML file.
+    /// </summary>
+    /// <param name="path">The path where the XML file will be saved.</param>
+    public void Save(string path)
+    {
+        XmlSerializer serializer = new(typeof(AppContainer));
+        using StringWriter writer = new();
+
+        serializer.Serialize(writer, Content);
+        string xmlString = writer.ToString();
+        FileSystem.File.WriteAllText(path, xmlString);
+    }
+
+    /// <summary>
+    /// Saves the icon associated with the CmfApp instance to the specified destination.
+    /// </summary>
+    /// <param name="iconDestination">The destination path where the icon will be saved.</param>
+    public void SaveIcon(string path, string iconName)
+    {
+        string iconDestinationPath = Path.Combine(path, iconName);
+
+        string iconSource = Content.App.Image.File;
+
+        byte[] iconBytes = FileSystem.File.ReadAllBytes(iconSource);
+
+        FileSystem.File.WriteAllBytes(iconDestinationPath, iconBytes);
+    }
+}

tests/Fixtures/pack/app/.project-config.json

@@ -0,0 +1,30 @@
+{
+  "ProjectName": "CF58AABF",
+  "NPMRegistry": "http://npm_registry/",
+  "RepositoryType": "App",
+  "BaseLayer": "Core",
+  "NuGetRegistry": "htt://nuget_registry/",
+  "RepositoryURL": "https://repo_url/collection/project/_git/repo",
+  "EnvironmentName": "system_name",
+  "DefaultDomain": "DOMAIN",
+  "RESTPort": "1234",
+  "Tenant": "tenant",
+  "MESVersion": "10.2.1",
+  "NugetVersion": "10.0.0",
+  "TestScenariosNugetVersion": "10.0.0",
+  "IsSslEnabled": "True",
+  "vmHostname": "app_server_address",
+  "DBReplica1": "server1\\instance",
+  "DBReplica2": "server2\\instance",
+  "DBServerOnline": "server1\\instance",
+  "DBServerODS": "server2\\instance",
+  "DBServerDWH": "server3\\instance",
+  "ReportServerURI": "http://reporting_services/Reports",
+  "AlwaysOn": "False",
+  "InstallationPath": "install_path",
+  "DBBackupPath": "backup_share",
+  "TemporaryPath": "temp_folder",
+  "HTMLPort": "443",
+  "GatewayPort": "5678",
+  "ReleaseEnvironmentConfig": "config.json"
+}

tests/Fixtures/pack/app/cmfapp.json

@@ -0,0 +1,9 @@
+{
+  "id": "MockId",
+  "name": "MockName",
+  "author": "MockAuthor",
+  "description": "MockDescription",
+  "targetFramework": "10.0.0",
+  "licensedApplication": "MockId",
+  "icon": ""
+}

tests/Fixtures/pack/app/cmfpackage.json

@@ -0,0 +1,15 @@
+{
+  "packageId": "Cmf.Custom.Package",
+  "version": "1.0.0",
+  "description": "This package deploys Critical Manufacturing  Customization",
+  "packageType": "Root",
+  "isInstallable": true,
+  "isUniqueInstall": false,
+  "dependencies": [
+    {
+      "id": "Cmf.Environment",
+      "version": "10.2.1",
+      "mandatory": false
+    }
+  ]
+}