Fixes for 1.4.1

Author: kuiperzone

CHANGES

@@ -1,3 +1,11 @@
++ VERSION 1.4.1; 2023-05-06
+- Bugfix #16: AppImage and Flatpak builds rejected AppStream metadata if conf.AppDescription was empty. Now defaults to AppShortSummary.
+- Bugfix #15: AppImage and Flatpak builds rejected AppStream metadata if conf.AppChangeFileEmpty.
+- Bugfix #14: AppImage failed if conf.IconPaths empty. On Linux a default icon will be used (previously worked but was broken due to change).
+- Bugfix #13: Incorrect </description> tag in AppStream example text (may be uncommented by used)
+- Ships with: appimagetool 13 (2020-12-31)
+- Tested against: rpmbuild RPM version 4.18.1, dpkg 1.21.21, flatpak-builder 1.2.3, InnoSetup 6.2.2
+
 + VERSION 1.4.0; 2023-05-05
 
 - Added 'AppDescription' property to configuration (IMPORTANT NEW FEATURE - see website for information)
@@ -15,6 +23,7 @@
 - Added MACRO section (verbose only) to console output when building a package (useful for debugging)
 - Extensive updates to README documentation
 - Other minor corrections and changes
+- Ships with: appimagetool 13 (2020-12-31)
 - Tested against: rpmbuild RPM version 4.18.1, dpkg 1.21.21, flatpak-builder 1.2.3, InnoSetup 6.2.2
 
 

PupNet.pupnet.conf

@@ -1,10 +1,10 @@
-# PUPNET DEPLOY: 1.4.0
+# PUPNET DEPLOY: 1.4.1
 
 # APP PREAMBLE
 AppBaseName = PupNet
 AppFriendlyName = PupNet Deploy
 AppId = zone.kuiper.pupnet
-AppVersionRelease = 1.4.0[1]
+AppVersionRelease = 1.4.1[1]
 AppShortSummary = Cross-platform deployment utility which packages your .NET project as a ready-to-ship installation file in a single step.
 AppDescription = """
     PupNet Deploy is a cross-platform deployment utility which packages your .NET project as a ready-to-ship
@@ -15,7 +15,7 @@ AppDescription = """
     Linux, Windows, MacOS and Android.
 
     Now, PupNet Deploy allows you to ship your dotnet application as: AppImage for Linux, Setup File for Windows, Flatpak,
-    Deb Package, RPM Package, Plain old Zip.
+    Deb Package, RPM Package, and plain old Zip.
 
     PupNet has good support for internationalization, desktop icons, publisher metadata and custom build operations.
     Although developed for .NET, it is also possible to use it to deploy C++ and other kinds of applications.
@@ -38,17 +38,7 @@ DesktopFile =
 StartCommand = pupnet
 PrimeCategory = Development
 MetaFile = Deploy/PupNet.metainfo.xml
-IconFiles = """
-    Deploy/PupNet.16x16.png
-    Deploy/PupNet.24x24.png
-    Deploy/PupNet.32x32.png
-    Deploy/PupNet.48x48.png
-    Deploy/PupNet.64x64.png
-    Deploy/PupNet.96x96.png
-    Deploy/PupNet.128x128.png
-    Deploy/PupNet.256x256.png
-    Deploy/PupNet.ico
-"""
+IconFiles =
 
 # DOTNET PUBLISH
 DotnetProjectPath =

PupNet/BuildHost.cs

@@ -22,8 +22,7 @@
 namespace KuiperZone.PupNet;
 
 /// <summary>
-/// Handles Console interaction, publishes the dotnet application and creates and executes a concrete instance of
-/// <see cref="PackageBuilder"/>.
+/// Creates a concrete instance of <see cref="PackageBuilder"/>, and handles the Console interaction with the user.
 /// </summary>
 public class BuildHost
 {

PupNet/Builders/AppImageBuilder.cs

@@ -220,6 +220,11 @@ public override void Create(string? desktop, string? metainfo)
         {
             Operations.CopyFile(IconSource, Path.Combine(BuildRoot, Configuration.AppId + Path.GetExtension(IconSource)));
         }
+        else
+        {
+            // Icon expected on Linux. Defaults to be provided in none in conf
+            throw new InvalidOperationException("Expected IconSource but was null");
+        }
 
         // IMPORTANT - Create AppRun link
         // ln -s {target} {link}

PupNet/ConfigurationReader.cs

@@ -373,11 +373,11 @@ public string ToString(DocStyles style)
                 $"Mandatory single line application summary text in default (English) language."));
 
         sb.Append(CreateHelpField(nameof(AppDescription), AppDescription, true, style,
-                $"Optional multi-line (surround with triple \"\"\" quotes) application description which provides",
-                $"longer explanation than {nameof(AppShortSummary)} in default language. Text separated by an empty line will be",
-                $"treated as separate paragraphs. Avoid complex formatting and do not use HTML or markdown. This content",
-                $"is used by package builders where supported, including RPM and DEB, and may optionally be used to",
-                $"populate the '<description>' element in the AppStream metadata through the use of a macro variable."));
+                $"Multi-line (surround with triple \"\"\" quotes) application description which provides longer explanation",
+                $"than {nameof(AppShortSummary)} in default language. Optional but it is recommended to specify this. Text",
+                $"separated by an empty line will be treated as separate paragraphs. Avoid complex formatting and do not",
+                $"use HTML or markdown. This content is used by package builders where supported, including RPM and DEB,",
+                $"and is used to populate the {MacroId.AppStreamDescriptionXml.ToVar()} element used in AppStream metadata."));
 
         sb.Append(CreateHelpField(nameof(AppLicenseId), AppLicenseId, style,
                 $"Mandatory application license ID. This should be one of the recognized SPDX license",
@@ -392,11 +392,9 @@ public string ToString(DocStyles style)
                 $"Optional path to application changelog file. IMPORTANT. If given, this file should contain version",
                 $"information in a predefined format. Namely, it should contain one or more version headings of form:",
                 $"'+ VERSION;DATE', under which are to be listed change items of form: '- Change description'. Formatted",
-                $"information will be parsed and used to populate AppStream metadata. Additionally, it will be packaged",
-                $"with the application and used with package builders where supported. NOTE. Superfluous text in the file",
-                $"is ignored, so the file may also contain README information.",
-                $"For information: {Program.ProjectUrl}."));
-
+                $"information will be parsed and used to expand the {MacroId.AppStreamChangelogXml.ToVar()} macro used",
+                $"for AppStream metadata (superfluous text is ignored, so the file may also contain README information).",
+                $"The given file will also be packaged with the application verbatim. See: {Program.ProjectUrl}."));
 
 
         sb.Append(CreateBreaker("PUBLISHER", style));

PupNet/MacroExpander.cs

@@ -65,8 +65,6 @@ public MacrosExpander(PackageBuilder builder)
         dict.Add(MacroId.DesktopTerminal, conf.DesktopTerminal.ToString().ToLowerInvariant());
         dict.Add(MacroId.PrimeCategory, conf.PrimeCategory ?? "");
 
-        dict.Add(MacroId.AppStreamDescriptionXml, GetXmlDescription(conf.AppDescription));
-        dict.Add(MacroId.AppStreamChangelogXml, builder.ChangeLog.ToString(true));
         dict.Add(MacroId.AppVersion, builder.AppVersion);
         dict.Add(MacroId.PackageRelease, builder.PackageRelease);
         dict.Add(MacroId.DeployKind, args.Kind.ToString().ToLowerInvariant());
@@ -82,6 +80,27 @@ public MacrosExpander(PackageBuilder builder)
         dict.Add(MacroId.InstallBin, builder.InstallBin);
         dict.Add(MacroId.InstallExec, builder.InstallExec);
 
+        if (conf.AppDescription.Count != 0)
+        {
+            dict.Add(MacroId.AppStreamDescriptionXml, GetXmlDescription(conf.AppDescription));
+        }
+        else
+        {
+            // Macro cannot be empty - use mandatory AppShortSummary instead
+            dict.Add(MacroId.AppStreamDescriptionXml, $"<p>{SecurityElement.Escape(conf.AppShortSummary)}</p>");
+        }
+
+        if (builder.ChangeLog.Items.Count != 0)
+        {
+            dict.Add(MacroId.AppStreamChangelogXml, builder.ChangeLog.ToString(true));
+        }
+        else
+        {
+            // Macro cannot be empty - manufacture minimal change
+            var change = $"<release version=\"{builder.AppVersion}\" date=\"{DateTime.UtcNow.ToString("yyyy-MM-dd")}\">";
+            dict.Add(MacroId.AppStreamChangelogXml, change);
+        }
+
         Dictionary = dict;
     }
 

PupNet/PackageBuilder.cs

@@ -24,7 +24,12 @@ namespace KuiperZone.PupNet;
 /// <summary>
 /// A base class for package build operations. It defines a working build directory structure under which the
 /// application is to be published by dotnet, along with other assets such a desktop, AppStream metadata
-/// and icons. The subclass is to define package specific values and operations by overriding key members.
+/// and icons (think 'AppDir' for AppImage, or BUILDROOT for RPM). It is Linux centric, where on Windows unused
+/// properties are ignored. The subclass is to define package specific values and operations by overriding key
+/// members, and implement the build operation. The build operation is a two-stage process in which
+/// <see cref="Create"/> is first called and information present on the console. Note that many of properties of
+/// this class are public purely to make them accessible to <see cref="BuildHost"/> class so they can be presented
+/// to the user. When the user confirms <see cref="BuildPackage"/> is called to perform the build.
 /// </summary>
 public abstract class PackageBuilder
 {
@@ -59,12 +64,18 @@ public PackageBuilder(ConfigurationReader conf, PackageKind kind)
 
         if (IconPaths.Count == 0)
         {
-            // Always has some linux icons
+            // Fallback to embedded icons on Linux
             IconPaths = GetShareIconPaths(Configuration.DesktopTerminal ? DefaultTerminalIcons : DefaultGuiIcons);
         }
 
         IconSource = GetSourceIcon(kind, Configuration.IconFiles);
 
+        if (IconSource == null)
+        {
+            // Fallback to embedded icons on Linux
+            IconSource = GetSourceIcon(kind, Configuration.DesktopTerminal ? DefaultTerminalIcons : DefaultGuiIcons);
+        }
+
         // Ignore fact file might not exist if AssertPaths if false (test only)
         if (Configuration.AssertPaths || File.Exists(Configuration.AppChangeFile))
         {
@@ -334,13 +345,14 @@ public virtual string? MetaBuildPath
     /// <summary>
     /// Gets the source path of the "prime" icon, i.e. the single icon considered to be the most generally suitable.
     /// On Linux this is the first SVG file encountered, or the largest PNG otherwise. On Windows, it is the first ICO
-    /// file encountered.
+    /// file encountered. It is a full path to the source icon on build.
     /// </summary>
     public string? IconSource { get; }
 
     /// <summary>
-    /// A sequence of source icon paths (key) and their destinations (value) under <see cref="PackageBuilder.BuildShareIcons"/>.
-    /// Default generic icons are provided if the configuration supplies none. Always empty on Windows.
+    /// A sequence of source icon paths (key) and their install destinations (value) under
+    /// <see cref="PackageBuilder.BuildShareIcons"/>. Default generic icons are provided if the configuration supplies
+    /// none. Always empty on Windows.
     /// </summary>
     public IReadOnlyDictionary<string, string> IconPaths { get; }
 
@@ -655,7 +667,7 @@ private static IReadOnlyCollection<string> GetDefaultIcons(bool terminal)
         string name = terminal ? "terminal" : "generic";
 
         // Leave windows icon out - leave InnoSetup to assign own
-        // list.Add(Path.Combine(AssemblyDirectory, $"{name}.icon"));
+        // list.Add(Path.Combine(AssemblyDirectory, $"{name}.ico"));
 
         list.Add(Path.Combine(AssemblyDirectory, $"{name}.16x16.png"));
         list.Add(Path.Combine(AssemblyDirectory, $"{name}.24x24.png"));

TODO

@@ -1,5 +1,6 @@
 Add multiple --kind values to arguments?
 Add <ul> parsing to AppDescription
+Implement auto system test for maximal and minimal conf files
 
 
 DONE