R: move test utilities into a Utilities namespace, add ConsoleAssertions

jonsequitur · jonsequitur · commit 9d494ebb1344 · 2020-04-14T11:33:17.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -149,3 +149,6 @@ _ReSharper.*/
 buildlog.txt
 nCrunchTemp*
 TestResults/
+
+.fake
+.ionide
diff --git a/src/System.CommandLine.DragonFruit.Tests/ConfigureFromMethodTests.cs b/src/System.CommandLine.DragonFruit.Tests/ConfigureFromMethodTests.cs
@@ -6,8 +6,8 @@
 using System.CommandLine.Invocation;
 using System.CommandLine.IO;
 using System.CommandLine.Parsing;
-using System.CommandLine.Tests;
 using System.CommandLine.Tests.Binding;
+using System.CommandLine.Tests.Utility;
 using System.IO;
 using FluentAssertions;
 using System.Linq;
diff --git a/src/System.CommandLine.Rendering.Tests/ConsoleRendererTests.cs b/src/System.CommandLine.Rendering.Tests/ConsoleRendererTests.cs
@@ -12,6 +12,7 @@
 using static System.Environment;
 using System.CommandLine.Rendering.Views;
 using System.CommandLine.Tests;
+using System.CommandLine.Tests.Utility;
 
 namespace System.CommandLine.Rendering.Tests
 {
diff --git a/src/System.CommandLine.Rendering.Tests/TableRenderingTests.cs b/src/System.CommandLine.Rendering.Tests/TableRenderingTests.cs
@@ -9,6 +9,7 @@
 using Xunit.Abstractions;
 using System.CommandLine.Rendering.Views;
 using System.CommandLine.Tests;
+using System.CommandLine.Tests.Utility;
 using static System.Environment;
 
 namespace System.CommandLine.Rendering.Tests
diff --git a/src/System.CommandLine.Rendering.Tests/TerminalModeTests.cs b/src/System.CommandLine.Rendering.Tests/TerminalModeTests.cs
@@ -6,6 +6,7 @@
 using System.CommandLine.IO;
 using System.CommandLine.Parsing;
 using System.CommandLine.Tests;
+using System.CommandLine.Tests.Utility;
 using System.Threading.Tasks;
 using FluentAssertions;
 using Xunit;
diff --git a/src/System.CommandLine.Rendering.Tests/TestTerminalTests.cs b/src/System.CommandLine.Rendering.Tests/TestTerminalTests.cs
@@ -2,6 +2,7 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using System.CommandLine.Tests;
+using System.CommandLine.Tests.Utility;
 using System.Drawing;
 using FluentAssertions;
 using System.Linq;
diff --git a/src/System.CommandLine.Rendering.Tests/TextSpanVisitorTests.cs b/src/System.CommandLine.Rendering.Tests/TextSpanVisitorTests.cs
@@ -3,6 +3,7 @@
 
 using System.Collections.Generic;
 using System.CommandLine.Tests;
+using System.CommandLine.Tests.Utility;
 using FluentAssertions;
 using System.Linq;
 using Xunit;
diff --git a/src/System.CommandLine.Rendering.Tests/TextStyleRenderingTests.cs b/src/System.CommandLine.Rendering.Tests/TextStyleRenderingTests.cs
@@ -1,7 +1,7 @@
 ﻿// Copyright (c) .NET Foundation and contributors. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-using System.CommandLine.Tests;
+using System.CommandLine.Tests.Utility;
 using System.Drawing;
 using FluentAssertions;
 using Xunit;
diff --git a/src/System.CommandLine.Rendering.Tests/ViewRenderingTests.cs b/src/System.CommandLine.Rendering.Tests/ViewRenderingTests.cs
@@ -6,6 +6,7 @@
 using System.CommandLine.Parsing;
 using System.CommandLine.Rendering.Views;
 using System.CommandLine.Tests;
+using System.CommandLine.Tests.Utility;
 using System.Drawing;
 using FluentAssertions;
 using Microsoft.Extensions.DependencyInjection;
diff --git a/src/System.CommandLine.Rendering.Tests/Views/ContentViewTests.cs b/src/System.CommandLine.Rendering.Tests/Views/ContentViewTests.cs
@@ -4,6 +4,7 @@
 using System.Collections.Generic;
 using System.CommandLine.Rendering.Views;
 using System.CommandLine.Tests;
+using System.CommandLine.Tests.Utility;
 using System.Drawing;
 using FluentAssertions;
 using Xunit;
diff --git a/src/System.CommandLine.Rendering.Tests/Views/ContentView{T}Tests.cs b/src/System.CommandLine.Rendering.Tests/Views/ContentView{T}Tests.cs
@@ -3,6 +3,7 @@
 
 using System.CommandLine.Rendering.Views;
 using System.CommandLine.Tests;
+using System.CommandLine.Tests.Utility;
 using System.Drawing;
 using FluentAssertions;
 using Xunit;
diff --git a/src/System.CommandLine.Rendering.Tests/Views/GridViewTests.cs b/src/System.CommandLine.Rendering.Tests/Views/GridViewTests.cs
@@ -4,6 +4,7 @@
 using System.CommandLine.IO;
 using System.CommandLine.Rendering.Views;
 using System.CommandLine.Tests;
+using System.CommandLine.Tests.Utility;
 using System.Drawing;
 using FluentAssertions;
 using Xunit;
diff --git a/src/System.CommandLine.Rendering.Tests/Views/LayoutViewTests.cs b/src/System.CommandLine.Rendering.Tests/Views/LayoutViewTests.cs
@@ -3,6 +3,7 @@
 
 using System.CommandLine.Rendering.Views;
 using System.CommandLine.Tests;
+using System.CommandLine.Tests.Utility;
 using FluentAssertions;
 using Xunit;
 
diff --git a/src/System.CommandLine.Rendering.Tests/Views/ScreenViewTests.cs b/src/System.CommandLine.Rendering.Tests/Views/ScreenViewTests.cs
@@ -4,6 +4,7 @@
 using System.Collections.Generic;
 using System.CommandLine.Rendering.Views;
 using System.CommandLine.Tests;
+using System.CommandLine.Tests.Utility;
 using System.Linq;
 using System.Threading;
 using FluentAssertions;
diff --git a/src/System.CommandLine.Rendering.Tests/Views/StackLayoutViewTests.cs b/src/System.CommandLine.Rendering.Tests/Views/StackLayoutViewTests.cs
@@ -3,6 +3,7 @@
 
 using System.CommandLine.Rendering.Views;
 using System.CommandLine.Tests;
+using System.CommandLine.Tests.Utility;
 using System.Drawing;
 using FluentAssertions;
 using Xunit;
diff --git a/src/System.CommandLine.Suggest.Tests/DotnetSuggestEndToEndTests.cs b/src/System.CommandLine.Suggest.Tests/DotnetSuggestEndToEndTests.cs
@@ -3,6 +3,7 @@
 
 using System.CommandLine.Invocation;
 using System.CommandLine.Tests;
+using System.CommandLine.Tests.Utility;
 using System.IO;
 using FluentAssertions;
 using System.Linq;
diff --git a/src/System.CommandLine.Tests/Binding/HandlerDescriptorTests.cs b/src/System.CommandLine.Tests/Binding/HandlerDescriptorTests.cs
@@ -2,6 +2,7 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using System.CommandLine.Binding;
+using System.CommandLine.Tests.Utility;
 using System.IO;
 using FluentAssertions;
 using System.Linq;
diff --git a/src/System.CommandLine.Tests/Binding/ModelDescriptorTests.cs b/src/System.CommandLine.Tests/Binding/ModelDescriptorTests.cs
@@ -2,6 +2,7 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using System.CommandLine.Binding;
+using System.CommandLine.Tests.Utility;
 using FluentAssertions;
 using System.Linq;
 using Xunit;
diff --git a/src/System.CommandLine.Tests/CollectionHelpers.cs b/src/System.CommandLine.Tests/CollectionHelpers.cs
diff --git a/src/System.CommandLine.Tests/Invocation/CancelOnProcessTerminationTests.cs b/src/System.CommandLine.Tests/Invocation/CancelOnProcessTerminationTests.cs
@@ -4,6 +4,7 @@
 using System.CommandLine.Builder;
 using System.CommandLine.Invocation;
 using System.CommandLine.Parsing;
+using System.CommandLine.Tests.Utility;
 using System.Diagnostics;
 using System.Runtime.InteropServices;
 using System.Threading;
diff --git a/src/System.CommandLine.Tests/ParserTests.MultipleArguments.cs b/src/System.CommandLine.Tests/ParserTests.MultipleArguments.cs
@@ -3,6 +3,7 @@
 
 using System.Collections.Generic;
 using System.CommandLine.Parsing;
+using System.CommandLine.Tests.Utility;
 using FluentAssertions;
 using Xunit;
 
diff --git a/src/System.CommandLine.Tests/ParserTests.cs b/src/System.CommandLine.Tests/ParserTests.cs
@@ -5,6 +5,7 @@
 using System.CommandLine.Builder;
 using System.CommandLine.Invocation;
 using System.CommandLine.Parsing;
+using System.CommandLine.Tests.Utility;
 using System.IO;
 using FluentAssertions;
 using FluentAssertions.Equivalency;
diff --git a/src/System.CommandLine.Tests/Parsing/CommandLineStringSplitterTests.cs b/src/System.CommandLine.Tests/Parsing/CommandLineStringSplitterTests.cs
@@ -2,6 +2,7 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using System.CommandLine.Parsing;
+using System.CommandLine.Tests.Utility;
 using System.IO;
 using FluentAssertions;
 using Xunit;
diff --git a/src/System.CommandLine.Tests/ResponseFileTests.cs b/src/System.CommandLine.Tests/ResponseFileTests.cs
@@ -4,6 +4,7 @@
 using System.Collections.Generic;
 using System.CommandLine.Builder;
 using System.CommandLine.Parsing;
+using System.CommandLine.Tests.Utility;
 using System.IO;
 using FluentAssertions;
 using System.Linq;
diff --git a/src/System.CommandLine.Tests/SplitCommandLineTests.cs b/src/System.CommandLine.Tests/SplitCommandLineTests.cs
@@ -2,6 +2,7 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using System.CommandLine.Parsing;
+using System.CommandLine.Tests.Utility;
 using System.IO;
 using FluentAssertions;
 using Xunit;
diff --git a/src/System.CommandLine.Tests/UseHelpTests.cs b/src/System.CommandLine.Tests/UseHelpTests.cs
@@ -5,8 +5,10 @@
 using System.CommandLine.Invocation;
 using System.CommandLine.IO;
 using System.CommandLine.Parsing;
+using System.CommandLine.Tests.Utility;
 using System.Threading.Tasks;
 using FluentAssertions;
+using FluentAssertions.Primitives;
 using Xunit;
 
 namespace System.CommandLine.Tests
@@ -70,7 +72,7 @@ public async Task UseHelp_accepts_default_values(string value)
 
             await parser.InvokeAsync($"command {value}", _console);
 
-            _console.Out.ToString().Should().StartWith("Usage:");
+            _console.Should().ShowHelp();
         }
 
         [Fact]
@@ -157,12 +159,9 @@ public void UseHelp_can_be_called_more_than_once_on_the_same_CommandLineBuilder(
                          .UseHelp()
                          .Build();
 
-            var console1 = new TestConsole();
-
-            parser.Invoke(commandline, console1);
+            parser.Invoke(commandline, _console);
 
-            console1.Out.ToString().Should().Contain("Usage:");
-            console1.Error.ToString().Should().BeEmpty();
+            _console.Should().ShowHelp();
         }
 
         [Theory]
@@ -175,16 +174,15 @@ public void UseHelp_can_be_called_more_than_once_on_the_same_command_with_differ
                 new Command("inner")
             };
 
-            var parser1 = new CommandLineBuilder(root)
-                          .UseHelp()
-                          .Build();
+            var parser = new CommandLineBuilder(root)
+                         .UseHelp()
+                         .Build();
 
             var console1 = new TestConsole();
 
-            parser1.Invoke(commandline, console1);
+            parser.Invoke(commandline, console1);
 
-            console1.Out.ToString().Should().Contain("Usage:");
-            console1.Error.ToString().Should().BeEmpty();
+            console1.Should().ShowHelp();
 
             var parser2 = new CommandLineBuilder(root)
                           .UseHelp()
@@ -193,8 +191,7 @@ public void UseHelp_can_be_called_more_than_once_on_the_same_command_with_differ
 
             parser2.Invoke(commandline, console2);
 
-            console2.Out.ToString().Should().Contain("Usage:");
-            console2.Error.ToString().Should().BeEmpty();
+            console2.Should().ShowHelp();
         }
     }
 }
diff --git a/src/System.CommandLine.Tests/Utility/AssertionExtensions.cs b/src/System.CommandLine.Tests/Utility/AssertionExtensions.cs
@@ -1,12 +1,12 @@
 ﻿// Copyright (c) .NET Foundation and contributors. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-using FluentAssertions;
 using System.Linq;
+using FluentAssertions;
 using FluentAssertions.Collections;
 using FluentAssertions.Execution;
 
-namespace System.CommandLine.Tests
+namespace System.CommandLine.Tests.Utility
 {
     public static class AssertionExtensions
     {
@@ -43,5 +43,15 @@ public static AndConstraint<StringCollectionAssertions> BeEquivalentSequenceTo(
         {
             return assertions.BeEquivalentTo(expectedValues, c => c.WithStrictOrderingFor(s => s));
         }
+
+        public static ConsoleAssertions Should(this IConsole console) => new ConsoleAssertions(console);
+
+        public static AndConstraint<ConsoleAssertions> ShowHelp(this ConsoleAssertions assertions)
+        {
+            assertions.Subject.Out.ToString().Should().Contain("Usage:");
+            assertions.Subject.Error.ToString().Should().BeEmpty();
+
+            return new AndConstraint<ConsoleAssertions>(assertions);
+        }
     }
-}
+}
diff --git a/src/System.CommandLine.Tests/Utility/ConsoleAssertions.cs b/src/System.CommandLine.Tests/Utility/ConsoleAssertions.cs
@@ -0,0 +1,20 @@
+﻿// Copyright (c) .NET Foundation and contributors. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// Copyright (c) .NET Foundation and contributors. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using FluentAssertions.Primitives;
+
+namespace System.CommandLine.Tests.Utility
+{
+    public class ConsoleAssertions : ReferenceTypeAssertions<IConsole, ConsoleAssertions>
+    {
+        public ConsoleAssertions(IConsole console)
+        {
+            Subject = console;
+        }
+
+        protected override string Identifier => nameof(IConsole);
+    }
+}
diff --git a/src/System.CommandLine.Tests/Utility/LinuxOnlyTheory.cs b/src/System.CommandLine.Tests/Utility/LinuxOnlyTheory.cs
@@ -2,18 +2,17 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using System.Runtime.InteropServices;
-using Microsoft.DotNet.PlatformAbstractions;
 using Xunit;
 
-namespace System.CommandLine.Tests
+namespace System.CommandLine.Tests.Utility
 {
     public class LinuxOnlyTheory : TheoryAttribute
     {
         public LinuxOnlyTheory()
         {
             if (!RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
             {
-                this.Skip = "This test requires Linux to run";
+                Skip = "This test requires Linux to run";
             }
         }
     }
diff --git a/src/System.CommandLine.Tests/Utility/NonWindowsOnlyFactAttribute.cs b/src/System.CommandLine.Tests/Utility/NonWindowsOnlyFactAttribute.cs
@@ -4,15 +4,15 @@
 using Microsoft.DotNet.PlatformAbstractions;
 using Xunit;
 
-namespace System.CommandLine.Tests
+namespace System.CommandLine.Tests.Utility
 {
     public class NonWindowsOnlyFactAttribute : FactAttribute
     {
         public NonWindowsOnlyFactAttribute()
         {
             if (RuntimeEnvironment.OperatingSystemPlatform == Platform.Windows)
             {
-                this.Skip = "This test requires non-Windows to run";
+                Skip = "This test requires non-Windows to run";
             }
         }
     }
diff --git a/src/System.CommandLine.Tests/Utility/ReleaseBuildOnlyFactAttribute.cs b/src/System.CommandLine.Tests/Utility/ReleaseBuildOnlyFactAttribute.cs
@@ -3,7 +3,7 @@
 
 using Xunit;
 
-namespace System.CommandLine.Tests
+namespace System.CommandLine.Tests.Utility
 {
     public class ReleaseBuildOnlyFactAttribute : FactAttribute
     {
diff --git a/src/System.CommandLine.Tests/Utility/RemoteExecution.cs b/src/System.CommandLine.Tests/Utility/RemoteExecution.cs
diff --git a/src/System.CommandLine.Tests/Utility/RemoteExecutor.cs b/src/System.CommandLine.Tests/Utility/RemoteExecutor.cs
diff --git a/src/System.CommandLine.Tests/Utility/WindowsOnlyFactAttribute.cs b/src/System.CommandLine.Tests/Utility/WindowsOnlyFactAttribute.cs

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`using static System.Environment;`
`13`	`13`	`using System.CommandLine.Rendering.Views;`
`14`	`14`	`using System.CommandLine.Tests;`
	`15`	`+using System.CommandLine.Tests.Utility;`
`15`	`16`
`16`	`17`	`namespace System.CommandLine.Rendering.Tests`
`17`	`18`	`{`