Clean up

Tyrrrz · Nov 23, 2023 · 2a1a4a0 · 2a1a4a0
1 parent 1f57973
commit 2a1a4a0
Show file tree

Hide file tree

Showing 12 changed files with 89 additions and 92 deletions.
diff --git a/CliWrap.Tests.Dummy/Commands/EnvironmentCommand.cs b/CliWrap.Tests.Dummy/Commands/EnvironmentCommand.cs
@@ -0,0 +1,21 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using CliFx;
+using CliFx.Attributes;
+using CliFx.Infrastructure;
+
+namespace CliWrap.Tests.Dummy.Commands;
+
+[Command("env")]
+public class EnvironmentCommand : ICommand
+{
+    [CommandParameter(0)]
+    public IReadOnlyList<string> Names { get; init; } = Array.Empty<string>();
+
+    public async ValueTask ExecuteAsync(IConsole console)
+    {
+        foreach (var name in Names)
+            await console.Output.WriteLineAsync(Environment.GetEnvironmentVariable(name));
+    }
+}
diff --git a/CliWrap.Tests.Dummy/Commands/ExitCommand.cs b/CliWrap.Tests.Dummy/Commands/ExitCommand.cs
@@ -9,7 +9,7 @@ namespace CliWrap.Tests.Dummy.Commands;
 [Command("exit")]
 public class ExitCommand : ICommand
 {
-    [CommandOption("code")]
+    [CommandParameter(0)]
     public int ExitCode { get; init; }
 
     public ValueTask ExecuteAsync(IConsole console)

diff --git a/...Dummy/Commands/PrintStdInLengthCommand.cs → ...ests.Dummy/Commands/LengthStdInCommand.cs b/...Dummy/Commands/PrintStdInLengthCommand.cs → ...ests.Dummy/Commands/LengthStdInCommand.cs
@@ -4,16 +4,12 @@
 using CliFx;
 using CliFx.Attributes;
 using CliFx.Infrastructure;
-using CliWrap.Tests.Dummy.Commands.Shared;
 
 namespace CliWrap.Tests.Dummy.Commands;
 
-[Command("print length stdin")]
-public class PrintStdInLengthCommand : ICommand
+[Command("length stdin")]
+public class LengthStdInCommand : ICommand
 {
-    [CommandOption("target")]
-    public OutputTarget Target { get; init; } = OutputTarget.StdOut;
-
     public async ValueTask ExecuteAsync(IConsole console)
     {
         using var buffer = MemoryPool<byte>.Shared.Rent(81920);
@@ -28,7 +24,6 @@ public async ValueTask ExecuteAsync(IConsole console)
             totalBytesRead += bytesRead;
         }
 
-        foreach (var writer in console.GetWriters(Target))
-            await writer.WriteLineAsync(totalBytesRead.ToString(CultureInfo.InvariantCulture));
+        await console.Output.WriteLineAsync(totalBytesRead.ToString(CultureInfo.InvariantCulture));
     }
 }
diff --git a/CliWrap.Tests.Dummy/Commands/PrintEnvironmentVariablesCommand.cs b/CliWrap.Tests.Dummy/Commands/PrintEnvironmentVariablesCommand.cs
diff --git a/CliWrap.Tests.Dummy/Commands/PrintWorkingDirCommand.cs b/CliWrap.Tests.Dummy/Commands/PrintWorkingDirCommand.cs
diff --git a/CliWrap.Tests.Dummy/Commands/SleepCommand.cs b/CliWrap.Tests.Dummy/Commands/SleepCommand.cs
@@ -9,7 +9,7 @@ namespace CliWrap.Tests.Dummy.Commands;
 [Command("sleep")]
 public class SleepCommand : ICommand
 {
-    [CommandOption("duration")]
+    [CommandParameter(0)]
     public TimeSpan Duration { get; init; } = TimeSpan.FromSeconds(1);
 
     public async ValueTask ExecuteAsync(IConsole console)

diff --git a/CliWrap.Tests.Dummy/Commands/WorkingDirectoryCommand.cs b/CliWrap.Tests.Dummy/Commands/WorkingDirectoryCommand.cs
@@ -0,0 +1,14 @@
+using System.IO;
+using System.Threading.Tasks;
+using CliFx;
+using CliFx.Attributes;
+using CliFx.Infrastructure;
+
+namespace CliWrap.Tests.Dummy.Commands;
+
+[Command("cwd")]
+public class WorkingDirectoryCommand : ICommand
+{
+    public async ValueTask ExecuteAsync(IConsole console) =>
+        await console.Output.WriteLineAsync(Directory.GetCurrentDirectory());
+}
diff --git a/CliWrap.Tests/CancellationSpecs.cs b/CliWrap.Tests/CancellationSpecs.cs
@@ -23,8 +23,8 @@ public async Task I_can_execute_a_command_and_cancel_it_immediately()
         var stdOutBuffer = new StringBuilder();
 
         var cmd =
-            Cli.Wrap(Dummy.Program.FilePath)
-                .WithArguments(new[] { "sleep", "--duration", "00:00:20" }) | stdOutBuffer;
+            Cli.Wrap(Dummy.Program.FilePath).WithArguments(new[] { "sleep", "00:00:20" })
+            | stdOutBuffer;
 
         // Act
         var task = cmd.ExecuteAsync(cts.Token);
@@ -47,8 +47,8 @@ public async Task I_can_execute_a_command_and_cancel_it_after_a_delay()
         var stdOutBuffer = new StringBuilder();
 
         var cmd =
-            Cli.Wrap(Dummy.Program.FilePath)
-                .WithArguments(new[] { "sleep", "--duration", "00:00:20" }) | stdOutBuffer;
+            Cli.Wrap(Dummy.Program.FilePath).WithArguments(new[] { "sleep", "00:00:20" })
+            | stdOutBuffer;
 
         // Act
         var task = cmd.ExecuteAsync(cts.Token);
@@ -84,8 +84,7 @@ void HandleStdOut(string line)
         );
 
         var cmd =
-            Cli.Wrap(Dummy.Program.FilePath)
-                .WithArguments(new[] { "sleep", "--duration", "00:00:20" }) | target;
+            Cli.Wrap(Dummy.Program.FilePath).WithArguments(new[] { "sleep", "00:00:20" }) | target;
 
         // Act
         var task = cmd.ExecuteAsync(CancellationToken.None, cts.Token);
@@ -105,8 +104,7 @@ public async Task I_can_execute_a_command_with_buffering_and_cancel_it_immediate
         using var cts = new CancellationTokenSource();
         cts.Cancel();
 
-        var cmd = Cli.Wrap(Dummy.Program.FilePath)
-            .WithArguments(new[] { "sleep", "--duration", "00:00:20" });
+        var cmd = Cli.Wrap(Dummy.Program.FilePath).WithArguments(new[] { "sleep", "00:00:20" });
 
         // Act & assert
         var ex = await Assert.ThrowsAnyAsync<OperationCanceledException>(
@@ -123,8 +121,7 @@ public async Task I_can_execute_a_command_with_buffering_and_cancel_it_after_a_d
         using var cts = new CancellationTokenSource();
         cts.CancelAfter(TimeSpan.FromSeconds(0.2));
 
-        var cmd = Cli.Wrap(Dummy.Program.FilePath)
-            .WithArguments(new[] { "sleep", "--duration", "00:00:20" });
+        var cmd = Cli.Wrap(Dummy.Program.FilePath).WithArguments(new[] { "sleep", "00:00:20" });
 
         // Act & assert
         var ex = await Assert.ThrowsAnyAsync<OperationCanceledException>(
@@ -141,8 +138,7 @@ public async Task I_can_execute_a_command_with_buffering_and_cancel_it_gracefull
         using var cts = new CancellationTokenSource();
         cts.CancelAfter(TimeSpan.FromSeconds(0.2));
 
-        var cmd = Cli.Wrap(Dummy.Program.FilePath)
-            .WithArguments(new[] { "sleep", "--duration", "00:00:20" });
+        var cmd = Cli.Wrap(Dummy.Program.FilePath).WithArguments(new[] { "sleep", "00:00:20" });
 
         // Act & assert
         var ex = await Assert.ThrowsAnyAsync<OperationCanceledException>(
@@ -165,8 +161,7 @@ public async Task I_can_execute_a_command_as_a_pull_based_event_stream_and_cance
         using var cts = new CancellationTokenSource();
         cts.Cancel();
 
-        var cmd = Cli.Wrap(Dummy.Program.FilePath)
-            .WithArguments(new[] { "sleep", "--duration", "00:00:20" });
+        var cmd = Cli.Wrap(Dummy.Program.FilePath).WithArguments(new[] { "sleep", "00:00:20" });
 
         // Act & assert
         var ex = await Assert.ThrowsAnyAsync<OperationCanceledException>(async () =>
@@ -188,8 +183,7 @@ public async Task I_can_execute_a_command_as_a_pull_based_event_stream_and_cance
         using var cts = new CancellationTokenSource();
         cts.CancelAfter(TimeSpan.FromSeconds(0.2));
 
-        var cmd = Cli.Wrap(Dummy.Program.FilePath)
-            .WithArguments(new[] { "sleep", "--duration", "00:00:20" });
+        var cmd = Cli.Wrap(Dummy.Program.FilePath).WithArguments(new[] { "sleep", "00:00:20" });
 
         // Act & assert
         var ex = await Assert.ThrowsAnyAsync<OperationCanceledException>(async () =>
@@ -211,8 +205,7 @@ public async Task I_can_execute_a_command_as_a_pull_based_event_stream_and_cance
         using var cts = new CancellationTokenSource();
         cts.CancelAfter(TimeSpan.FromSeconds(0.2));
 
-        var cmd = Cli.Wrap(Dummy.Program.FilePath)
-            .WithArguments(new[] { "sleep", "--duration", "00:00:20" });
+        var cmd = Cli.Wrap(Dummy.Program.FilePath).WithArguments(new[] { "sleep", "00:00:20" });
 
         // Act & assert
         var ex = await Assert.ThrowsAnyAsync<OperationCanceledException>(async () =>
@@ -241,8 +234,7 @@ public async Task I_can_execute_a_command_as_a_push_based_event_stream_and_cance
         using var cts = new CancellationTokenSource();
         cts.Cancel();
 
-        var cmd = Cli.Wrap(Dummy.Program.FilePath)
-            .WithArguments(new[] { "sleep", "--duration", "00:00:20" });
+        var cmd = Cli.Wrap(Dummy.Program.FilePath).WithArguments(new[] { "sleep", "00:00:20" });
 
         // Act & assert
         var ex = await Assert.ThrowsAnyAsync<OperationCanceledException>(
@@ -268,8 +260,7 @@ public async Task I_can_execute_a_command_as_a_push_based_event_stream_and_cance
         using var cts = new CancellationTokenSource();
         cts.CancelAfter(TimeSpan.FromSeconds(0.2));
 
-        var cmd = Cli.Wrap(Dummy.Program.FilePath)
-            .WithArguments(new[] { "sleep", "--duration", "00:00:20" });
+        var cmd = Cli.Wrap(Dummy.Program.FilePath).WithArguments(new[] { "sleep", "00:00:20" });
 
         // Act & assert
         var ex = await Assert.ThrowsAnyAsync<OperationCanceledException>(
@@ -295,8 +286,7 @@ public async Task I_can_execute_a_command_as_a_push_based_event_stream_and_cance
         using var cts = new CancellationTokenSource();
         cts.CancelAfter(TimeSpan.FromSeconds(0.2));
 
-        var cmd = Cli.Wrap(Dummy.Program.FilePath)
-            .WithArguments(new[] { "sleep", "--duration", "00:00:20" });
+        var cmd = Cli.Wrap(Dummy.Program.FilePath).WithArguments(new[] { "sleep", "00:00:20" });
 
         // Act & assert
         var ex = await Assert.ThrowsAnyAsync<OperationCanceledException>(

diff --git a/CliWrap.Tests/EnvironmentSpecs.cs b/CliWrap.Tests/EnvironmentSpecs.cs
@@ -3,6 +3,7 @@
 using System.Threading.Tasks;
 using CliWrap.Buffered;
 using CliWrap.Tests.Utils;
+using CliWrap.Tests.Utils.Extensions;
 using FluentAssertions;
 using Xunit;
 
@@ -17,7 +18,7 @@ public async Task I_can_execute_a_command_with_a_custom_working_directory()
         using var dir = TempDir.Create();
 
         var cmd = Cli.Wrap(Dummy.Program.FilePath)
-            .WithArguments("print cwd")
+            .WithArguments("cwd")
             .WithWorkingDirectory(dir.Path);
 
         // Act
@@ -34,14 +35,14 @@ public async Task I_can_execute_a_command_with_additional_environment_variables(
         var env = new Dictionary<string, string?> { ["foo"] = "bar", ["hello"] = "world" };
 
         var cmd = Cli.Wrap(Dummy.Program.FilePath)
-            .WithArguments("print env")
+            .WithArguments(new[] { "env", "foo", "hello" })
             .WithEnvironmentVariables(env);
 
         // Act
         var result = await cmd.ExecuteBufferedAsync();
 
         // Assert
-        result.StandardOutput.Trim().Should().ContainAll("[foo] = bar", "[hello] = world");
+        result.StandardOutput.Should().ConsistOfLines("bar", "world");
     }
 
     [Fact(Timeout = 15000)]
@@ -58,7 +59,9 @@ public async Task I_can_execute_a_command_with_some_environment_variables_overwr
         using (TempEnvironmentVariable.Set(variableToUnset, "unset")) // will be unset
         {
             var cmd = Cli.Wrap(Dummy.Program.FilePath)
-                .WithArguments("print env")
+                .WithArguments(
+                    new[] { "env", variableToKeep, variableToOverwrite, variableToUnset }
+                )
                 .WithEnvironmentVariables(
                     e => e.Set(variableToOverwrite, "overwritten").Set(variableToUnset, null)
                 );
@@ -67,20 +70,7 @@ public async Task I_can_execute_a_command_with_some_environment_variables_overwr
             var result = await cmd.ExecuteBufferedAsync();
 
             // Assert
-            result
-                .StandardOutput
-                .Trim()
-                .Should()
-                .ContainAll($"[{variableToKeep}] = keep", $"[{variableToOverwrite}] = overwritten");
-
-            result
-                .StandardOutput
-                .Trim()
-                .Should()
-                .NotContainAny(
-                    $"[{variableToOverwrite}] = overwrite",
-                    $"[{variableToUnset}] = unset"
-                );
+            result.StandardOutput.Should().ConsistOfLines("keep", "overwritten");
         }
     }
 }
diff --git a/CliWrap.Tests/PipingSpecs.cs b/CliWrap.Tests/PipingSpecs.cs
@@ -129,7 +129,7 @@ public async Task I_can_execute_a_command_and_pipe_the_stdin_from_another_comman
         var cmd =
             Cli.Wrap(Dummy.Program.FilePath)
                 .WithArguments(new[] { "generate binary", "--length", "100000" })
-            | Cli.Wrap(Dummy.Program.FilePath).WithArguments("print length stdin");
+            | Cli.Wrap(Dummy.Program.FilePath).WithArguments("length stdin");
 
         // Act
         var result = await cmd.ExecuteBufferedAsync();
@@ -147,7 +147,7 @@ public async Task I_can_execute_a_command_and_pipe_the_stdin_from_a_chain_of_com
             | Cli.Wrap(Dummy.Program.FilePath).WithArguments("echo stdin")
             | Cli.Wrap(Dummy.Program.FilePath)
                 .WithArguments(new[] { "echo stdin", "--length", "5" })
-            | Cli.Wrap(Dummy.Program.FilePath).WithArguments("print length stdin");
+            | Cli.Wrap(Dummy.Program.FilePath).WithArguments("length stdin");
 
         // Act
         var result = await cmd.ExecuteBufferedAsync();

diff --git a/CliWrap.Tests/Utils/Extensions/AssertionExtensions.cs b/CliWrap.Tests/Utils/Extensions/AssertionExtensions.cs
@@ -0,0 +1,22 @@
+using System;
+using System.Collections.Generic;
+using FluentAssertions;
+using FluentAssertions.Primitives;
+
+namespace CliWrap.Tests.Utils.Extensions;
+
+internal static class AssertionExtensions
+{
+    public static void ConsistOfLines(
+        this StringAssertions assertions,
+        IEnumerable<string> lines
+    ) =>
+        assertions
+            .Subject
+            .Split(new[] { '\n', '\r' }, StringSplitOptions.RemoveEmptyEntries)
+            .Should()
+            .Equal(lines);
+
+    public static void ConsistOfLines(this StringAssertions assertions, params string[] lines) =>
+        assertions.ConsistOfLines((IEnumerable<string>)lines);
+}
diff --git a/CliWrap.Tests/ValidationSpecs.cs b/CliWrap.Tests/ValidationSpecs.cs
@@ -17,7 +17,7 @@ public class ValidationSpecs
     public async Task I_can_try_to_execute_a_command_and_get_an_error_if_it_returns_a_non_zero_exit_code()
     {
         // Arrange
-        var cmd = Cli.Wrap(Dummy.Program.FilePath).WithArguments(new[] { "exit", "--code", "1" });
+        var cmd = Cli.Wrap(Dummy.Program.FilePath).WithArguments(new[] { "exit", "1" });
 
         // Act & assert
         var ex = await Assert.ThrowsAsync<CommandExecutionException>(
@@ -34,7 +34,7 @@ public async Task I_can_try_to_execute_a_command_and_get_an_error_if_it_returns_
     public async Task I_can_try_to_execute_a_command_with_buffering_and_get_a_detailed_error_if_it_returns_a_non_zero_exit_code()
     {
         // Arrange
-        var cmd = Cli.Wrap(Dummy.Program.FilePath).WithArguments(new[] { "exit", "--code", "1" });
+        var cmd = Cli.Wrap(Dummy.Program.FilePath).WithArguments(new[] { "exit", "1" });
 
         // Act & assert
         var ex = await Assert.ThrowsAsync<CommandExecutionException>(
@@ -53,7 +53,7 @@ public async Task I_can_execute_a_command_without_validating_the_exit_code()
     {
         // Arrange
         var cmd = Cli.Wrap(Dummy.Program.FilePath)
-            .WithArguments(new[] { "exit", "--code", "1" })
+            .WithArguments(new[] { "exit", "1" })
             .WithValidation(CommandResultValidation.None);
 
         // Act