Skip to content

Commit a6dc196

Browse files
committed
Cleanup formatting and make CI pass
Fix CI Use environment newline
1 parent ab679bc commit a6dc196

File tree

3 files changed

+50
-51
lines changed

3 files changed

+50
-51
lines changed

src/System.CommandLine.Subsystems.Tests/ErrorReportingFunctionalTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,4 +131,4 @@ public void When_no_help_option_is_present_then_help_is_not_shown_for_parse_erro
131131
output.ToString().Should().NotShowHelp();
132132
}
133133
*/
134-
}
134+
}
Lines changed: 46 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,68 @@
11
// Copyright (c) .NET Foundation and contributors. All rights reserved.
22
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
33

4-
using System.Reflection;
54
using FluentAssertions;
65
using Xunit;
76
using System.CommandLine.Parsing;
8-
using static System.Runtime.InteropServices.JavaScript.JSType;
97

10-
namespace System.CommandLine.Subsystems.Tests
8+
namespace System.CommandLine.Subsystems.Tests;
9+
10+
public class ErrorReportingSubsystemTests
1111
{
12-
public class ErrorReportingSubsystemTests
12+
[Fact]
13+
public void Report_when_single_error_writes_to_console_hack()
1314
{
14-
[Fact]
15-
public void Report_when_single_error_writes_to_console_hack()
16-
{
17-
var error = new ParseError("a sweet error message");
18-
var errors = new List<ParseError> { error };
19-
var errorSubsystem = new ErrorReportingSubsystem();
20-
var consoleHack = new ConsoleHack().RedirectToBuffer(true);
15+
var error = new ParseError("a sweet error message");
16+
var errors = new List<ParseError> { error };
17+
var errorSubsystem = new ErrorReportingSubsystem();
18+
var consoleHack = new ConsoleHack().RedirectToBuffer(true);
2119

22-
errorSubsystem.Report(consoleHack, errors);
20+
errorSubsystem.Report(consoleHack, errors);
2321

24-
consoleHack.GetBuffer().Trim().Should().Be(error.Message);
25-
}
22+
consoleHack.GetBuffer().Trim().Should().Be(error.Message);
23+
}
2624

27-
[Fact]
28-
public void Report_when_multiple_error_writes_to_console_hack()
29-
{
30-
var error = new ParseError("a sweet error message");
31-
var anotherError = new ParseError("another sweet error message");
32-
var errors = new List<ParseError> { error, anotherError };
33-
var errorSubsystem = new ErrorReportingSubsystem();
34-
var consoleHack = new ConsoleHack().RedirectToBuffer(true);
25+
[Fact]
26+
public void Report_when_multiple_error_writes_to_console_hack()
27+
{
28+
var error = new ParseError("a sweet error message");
29+
var anotherError = new ParseError("another sweet error message");
30+
var errors = new List<ParseError> { error, anotherError };
31+
var errorSubsystem = new ErrorReportingSubsystem();
32+
var consoleHack = new ConsoleHack().RedirectToBuffer(true);
3533

36-
errorSubsystem.Report(consoleHack, errors);
34+
errorSubsystem.Report(consoleHack, errors);
3735

38-
consoleHack.GetBuffer().Trim().Should().Be($"{error.Message}\r\n{anotherError.Message}");
39-
}
36+
consoleHack.GetBuffer().Trim().Should().Be($"{error.Message}{Environment.NewLine}{anotherError.Message}");
37+
}
4038

41-
[Fact]
42-
public void Report_when_no_errors_writes_nothing_to_console_hack()
43-
{
44-
var errors = new List<ParseError> { };
45-
var errorSubsystem = new ErrorReportingSubsystem();
46-
var consoleHack = new ConsoleHack().RedirectToBuffer(true);
39+
[Fact]
40+
public void Report_when_no_errors_writes_nothing_to_console_hack()
41+
{
42+
var errors = new List<ParseError> { };
43+
var errorSubsystem = new ErrorReportingSubsystem();
44+
var consoleHack = new ConsoleHack().RedirectToBuffer(true);
4745

48-
errorSubsystem.Report(consoleHack, errors);
46+
errorSubsystem.Report(consoleHack, errors);
4947

50-
consoleHack.GetBuffer().Trim().Should().Be("");
51-
}
48+
consoleHack.GetBuffer().Trim().Should().Be("");
49+
}
5250

53-
[Theory]
54-
[InlineData("-v", false)]
55-
[InlineData("-x", true)]
56-
[InlineData("", false)]
57-
public void GetIsActivated_tests(string input, bool result)
58-
{
59-
var rootCommand = new CliRootCommand {new CliOption<bool>("-v")};
60-
var configuration = new CliConfiguration(rootCommand);
61-
var errorSubsystem = new ErrorReportingSubsystem();
62-
Subsystem.Initialize(errorSubsystem, configuration);
51+
[Theory]
52+
[InlineData("-v", false)]
53+
[InlineData("-x", true)]
54+
[InlineData("", false)]
55+
public void GetIsActivated_tests(string input, bool result)
56+
{
57+
var rootCommand = new CliRootCommand {new CliOption<bool>("-v")};
58+
var configuration = new CliConfiguration(rootCommand);
59+
var errorSubsystem = new ErrorReportingSubsystem();
60+
IReadOnlyList<string> args = [""];
61+
Subsystem.Initialize(errorSubsystem, configuration, args);
6362

64-
var parseResult = CliParser.Parse(rootCommand, input, configuration);
65-
var isActive = Subsystem.GetIsActivated(errorSubsystem, parseResult);
63+
var parseResult = CliParser.Parse(rootCommand, input, configuration);
64+
var isActive = Subsystem.GetIsActivated(errorSubsystem, parseResult);
6665

67-
isActive.Should().Be(result);
68-
}
66+
isActive.Should().Be(result);
6967
}
7068
}

src/System.CommandLine.Subsystems/ErrorReportingSubsystem.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@
88
namespace System.CommandLine;
99

1010
/// <summary>
11-
///
11+
/// Subsystem for reporting errors
1212
/// </summary>
1313
/// <remarks>
14+
/// This class, including interface, is likey to change as powderhouse continues
1415
/// </remarks>
1516
public class ErrorReportingSubsystem : CliSubsystem
1617
{
@@ -21,6 +22,7 @@ public ErrorReportingSubsystem(IAnnotationProvider? annotationProvider = null)
2122
protected internal override bool GetIsActivated(ParseResult? parseResult)
2223
=> parseResult is not null && parseResult.Errors.Any();
2324

25+
// TODO: properly test execute directly when parse result is usable in tests
2426
protected internal override CliExit Execute(PipelineContext pipelineContext)
2527
{
2628
var _ = pipelineContext.ParseResult
@@ -31,7 +33,6 @@ protected internal override CliExit Execute(PipelineContext pipelineContext)
3133
return CliExit.SuccessfullyHandled(pipelineContext.ParseResult);
3234
}
3335

34-
// TODO: internal, protected virtual?
3536
public void Report(ConsoleHack consoleHack, IReadOnlyList<ParseError> errors)
3637
{
3738
ConsoleHelpers.ResetTerminalForegroundColor();

0 commit comments

Comments
 (0)