Make command parameters required

Author: edumserrano

GitHubIssueFormsParser/src/GitHubIssuesParserCli/CliCommands/ParseIssueFormCommand.cs

@@ -3,11 +3,11 @@ namespace GitHubIssuesParserCli.CliCommands;
 [Command("parse-issue-form")]
 public class ParseIssueFormCommand : ICommand
 {
-    [CommandOption("issue-body", 'i', Description = "The body of the GitHub issue form.")]
-    public string? IssueFormBody { get; init; }
+    [CommandOption("issue-body", 'i', IsRequired = true, Description = "The body of the GitHub issue form.")]
+    public string IssueFormBody { get; init; } = default!;
 
-    [CommandOption("template-filepath", 't', Description = "The filepath for the GitHub issue form YAML template.")]
-    public string? TemplateFilepath { get; init; }
+    [CommandOption("template-filepath", 't', IsRequired = true, Description = "The filepath for the GitHub issue form YAML template.")]
+    public string TemplateFilepath { get; init; } = default!;
 
     public async ValueTask ExecuteAsync(IConsole console)
     {

GitHubIssueFormsParser/tests/GitHubIssuesParserCli.Tests/Auxiliary/NormalizedLineEndingsFileReader.cs

@@ -15,6 +15,7 @@ public static string ReadAllText(string path)
             // if it's a Windows OS and contains Windows line endings then do nothing
             return original;
         }
+
         if (Environment.OSVersion.Platform == PlatformID.Win32NT && original.Contains(LF, StringComparison.Ordinal))
         {
             // if it's a Windows OS and doesn't contain Windows line endings then replace

GitHubIssueFormsParser/tests/GitHubIssuesParserCli.Tests/CliCommands/ParseIssueFormCommandValidationTests.cs

@@ -9,7 +9,8 @@ public class ParseIssueFormCommandValidationTests
     [Theory]
     [InlineData(null)]
     [InlineData("")]
-    public async Task ValidateIssueFormBodyParam(string? issueFormBody)
+    [InlineData("   ")]
+    public async Task ValidateIssueFormBodyParam(string issueFormBody)
     {
         using var console = new FakeInMemoryConsole();
         var command = new ParseIssueFormCommand
@@ -30,7 +31,8 @@ public async Task ValidateIssueFormBodyParam(string? issueFormBody)
     [Theory]
     [InlineData(null)]
     [InlineData("")]
-    public async Task ValidateTemplateFilepathParam(string? templateFilepath)
+    [InlineData("   ")]
+    public async Task ValidateTemplateFilepathParam(string templateFilepath)
     {
         using var console = new FakeInMemoryConsole();
         var command = new ParseIssueFormCommand

GitHubIssueFormsParser/tests/GitHubIssuesParserCli.Tests/CliIntegration/CliIntegrationTests.cs

@@ -11,7 +11,7 @@ public class CliIntegrationTests
     /// Tests that if no arguments are passed the CLI returns the help text.
     /// </summary>
     [Fact]
-    public async Task IntegrationTest1()
+    public async Task NoArguments()
     {
         using var console = new FakeInMemoryConsole();
         var app = new IssuesParserCli();
@@ -22,13 +22,47 @@ public async Task IntegrationTest1()
         output.ShouldEndWith(expectedOutput);
     }
 
+    /// <summary>
+    /// Tests that the --issue-body parameter is required for the 'parse-issue-form' command.
+    /// </summary>
+    [Fact]
+    public async Task IssueBodyParamIsRequired()
+    {
+        using var console = new FakeInMemoryConsole();
+        var app = new IssuesParserCli();
+        app.CliApplicationBuilder.UseConsole(console);
+
+        var args = new[] { "parse-issue-form", "--template-filepath", "some filepath" };
+        await app.RunAsync(args);
+        var output = console.ReadOutputString();
+        var expectedOutput = NormalizedLineEndingsFileReader.ReadAllText("./TestFiles/CliOutputRequiredParam.txt");
+        output.ShouldEndWith(expectedOutput);
+    }
+
+    /// <summary>
+    /// Tests that the --template-filepath parameter is required for the 'parse-issue-form' command.
+    /// </summary>
+    [Fact]
+    public async Task TemplateFilepathParamIsRequired()
+    {
+        using var console = new FakeInMemoryConsole();
+        var app = new IssuesParserCli();
+        app.CliApplicationBuilder.UseConsole(console);
+
+        var args = new[] { "parse-issue-form", "--issue-body", "some issue body" };
+        await app.RunAsync(args);
+        var output = console.ReadOutputString();
+        var expectedOutput = NormalizedLineEndingsFileReader.ReadAllText("./TestFiles/CliOutputRequiredParam.txt");
+        output.ShouldEndWith(expectedOutput);
+    }
+
     /// <summary>
     /// Tests the correct value for the options that can be used with the 'parse-issue-form' command.
     /// </summary>
     [Theory]
     [InlineData("-i", "-t")]
     [InlineData("--issue-body", "--template-filepath")]
-    public async Task IntegrationTest2(string issueFormParamName, string templateFilepathParamName)
+    public async Task ExpectedUsage(string issueFormParamName, string templateFilepathParamName)
     {
         using var console = new FakeInMemoryConsole();
         var app = new IssuesParserCli();

GitHubIssueFormsParser/tests/GitHubIssuesParserCli.Tests/GitHubIssuesParserCli.Tests.csproj

@@ -24,6 +24,9 @@
   </ItemGroup>
 
   <ItemGroup>
+    <None Update="TestFiles\CliOutputRequiredParam.txt">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Update="TestFiles\CliOutputNoArgs.txt">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>

GitHubIssueFormsParser/tests/GitHubIssuesParserCli.Tests/TestFiles/CliOutputRequiredParam.txt

@@ -0,0 +1,7 @@
+USAGE
+  testhost parse-issue-form --issue-body <value> --template-filepath <value> [options]
+
+OPTIONS
+* -i|--issue-body   The body of the GitHub issue form. 
+* -t|--template-filepath  The filepath for the GitHub issue form YAML template. 
+  -h|--help         Shows help text.