Add skip frontmatter settings

devlead · Nov 28, 2023 · 14cf440 · 14cf440
1 parent 419f32b
commit 14cf440
Show file tree

Hide file tree

Showing 9 changed files with 87 additions and 21 deletions.
diff --git a/...tensionsTests.AddFrontmatter.verified.txt → ...e_skipFrontmatterOrder=False.verified.txt b/...tensionsTests.AddFrontmatter.verified.txt → ...e_skipFrontmatterOrder=False.verified.txt
diff --git a/...tmatterSummary=False_skipFrontmatterModified=False_skipFrontmatterOrder=True.verified.txt b/...tmatterSummary=False_skipFrontmatterModified=False_skipFrontmatterOrder=True.verified.txt
@@ -0,0 +1,5 @@
+---
+summary: Summary
+modifiedby: ARI
+modified: 9999-12-31 23:59
+---
diff --git a/...tmatterSummary=False_skipFrontmatterModified=True_skipFrontmatterOrder=False.verified.txt b/...tmatterSummary=False_skipFrontmatterModified=True_skipFrontmatterOrder=False.verified.txt
@@ -0,0 +1,5 @@
+---
+summary: Summary
+modifiedby: ARI
+order: 0
+---
diff --git a/...tmatterSummary=True_skipFrontmatterModified=False_skipFrontmatterOrder=False.verified.txt b/...tmatterSummary=True_skipFrontmatterModified=False_skipFrontmatterOrder=False.verified.txt
@@ -0,0 +1,5 @@
+---
+modifiedby: ARI
+modified: 9999-12-31 23:59
+order: 0
+---
diff --git a/...matterSummary=False_skipFrontmatterModified=False_skipFrontmatterOrder=False.verified.txt b/...matterSummary=False_skipFrontmatterModified=False_skipFrontmatterOrder=False.verified.txt
@@ -0,0 +1 @@
+emptyString
diff --git a/src/ARI.Tests/Unit/Extensions/TextWriterMarkdownExtensionsTests.cs b/src/ARI.Tests/Unit/Extensions/TextWriterMarkdownExtensionsTests.cs
@@ -1,26 +1,44 @@
 using ARI.Models.Tenant;
 using ARI.Models.Tenant.Subscription;
 using ARI.Models.Tenant.Subscription.ResourceGroup;
+using Spectre.Console.Cli;
 
 namespace ARI.Tests.Unit.Extensions;
 
 [TestFixture]
 public class TextWriterMarkdownExtensionsTests
 {
-    [Test]
-    public async Task AddFrontmatter()
+    [TestCase(false, false, false, false)]
+    [TestCase(true, false, false, false)]
+    [TestCase(false, true, false, false)]
+    [TestCase(false, false, true, false)]
+    [TestCase(false, false, false, true)]
+    public async Task AddFrontmatter(
+        bool skipFrontmatter,
+        bool skipFrontmatterSummary,
+        bool skipFrontmatterModified,
+        bool skipFrontmatterOrder
+        )
     {
         // Given
         var sw = new StringWriter();
         var lastUpdateTime = DateTimeOffset.MaxValue;
         var summary = "Summary";
         var order = 0;
 
+        var settings = new ARI.Commands.Settings.InventorySettings
+        { 
+            SkipFrontmatter = skipFrontmatter,
+            SkipFrontmatterSummary = skipFrontmatterSummary,
+            SkipFrontmatterModified = skipFrontmatterModified,
+            SkipFrontmatterOrder = skipFrontmatterOrder
+        };
         // When
         await sw.AddFrontmatter(
             lastUpdateTime,
             summary,
-            order
+            order,
+            settings
             );
 
         // Then

diff --git a/src/ARI/Commands/InventoryCommand.cs b/src/ARI/Commands/InventoryCommand.cs
@@ -41,7 +41,8 @@ public override async Task<int> ExecuteAsync(CommandContext context, InventorySe
             await writer.AddFrontmatter(
                 modified,
                 $"Tenant {tenant.DisplayName} ({tenant.TenantId})",
-                1
+                1,
+                settings
             );
 
             await writer.AddTenantOverview(tenant);
@@ -51,7 +52,8 @@ await writer.AddFrontmatter(
             await writer.AddFrontmatter(
                 modified,
                 "Azure Inventory",
-                1
+                1,
+                settings
             );
         }
 
@@ -72,7 +74,8 @@ await ForEachAsync(
                 await writer.AddFrontmatter(
                     modified,
                     $"Subscription {subscription.DisplayName} ({subscription.TenantId})",
-                    subscription.Order
+                    subscription.Order,
+                    settings
                     );
 
                 await writer.AddSubscriptionOverview(subscription);
@@ -97,7 +100,8 @@ await ForEachAsync(
                         await writer.AddFrontmatter(
                             modified,
                             $"Resource Group {resourceGroup.Name} ({subscription.SubscriptionId})",
-                            resourceGroup.Order
+                            resourceGroup.Order,
+                            settings
                             );
 
                         await writer.AddResourceGroupOverview(resourceGroup);
@@ -157,7 +161,8 @@ await ForEachAsync(
                                 await writer.AddFrontmatter(
                                     modified,
                                     $"Resource {resource.Name} ({subscription.SubscriptionId})",
-                                    resource.Order
+                                    resource.Order,
+                                    settings
                                     );
 
                                 await writer.AddResourceOverview(resource);

diff --git a/src/ARI/Commands/Settings/InventorySettings.cs b/src/ARI/Commands/Settings/InventorySettings.cs
@@ -22,4 +22,16 @@ public class InventorySettings : CommandSettings
 
     [CommandOption("--markdown-name")]
     public string MarkdownName { get; set; } = "index";
+
+    [CommandOption("--skip-frontmatter")]
+    public bool SkipFrontmatter { get; set; }
+
+    [CommandOption("--skip-frontmatter-summary")]
+    public bool SkipFrontmatterSummary { get; set; }
+
+    [CommandOption("--skip-frontmatter-modifed")]
+    public bool SkipFrontmatterModified { get; set; }
+
+    [CommandOption("--skip-frontmatter-order")]
+    public bool SkipFrontmatterOrder { get; set; }
 }
diff --git a/src/ARI/Extensions/TextWriterMarkdownExtensions.cs b/src/ARI/Extensions/TextWriterMarkdownExtensions.cs
@@ -15,20 +15,35 @@ public static async Task AddFrontmatter(
         this TextWriter writer,
         DateTimeOffset lastUpdateTime,
         string summary,
-        int order)
+        int order,
+        InventorySettings settings
+        )
     {
-        await writer.WriteLineAsync(
-            FormattableString.Invariant(
-                    $$"""
-                    ---
-                    summary: {{summary}}
-                    modifiedby: ARI
-                    modified: {{lastUpdateTime:yyyy-MM-dd HH:mm}}
-                    order: {{order}}
-                    ---
-                    """
-                )
-            );
+        if (settings.SkipFrontmatter)
+        {
+            return;
+        }
+
+        await writer.WriteLineAsync("---");
+
+        if (!settings.SkipFrontmatterSummary)
+        {
+            await writer.WriteLineAsync(FormattableString.Invariant($"summary: {summary}"));
+        }
+
+        await writer.WriteLineAsync(FormattableString.Invariant($"modifiedby: ARI"));
+
+        if (!settings.SkipFrontmatterModified)
+        {
+            await writer.WriteLineAsync(FormattableString.Invariant($"modified: {lastUpdateTime:yyyy-MM-dd HH:mm}"));
+        }
+
+        if (!settings.SkipFrontmatterOrder)
+        {
+            await writer.WriteLineAsync(FormattableString.Invariant($"order: {order}"));
+        }
+
+        await writer.WriteLineAsync("---");
     }
 
     public static async Task AddTenantOverview(