Skip to content

Various refactorings #300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ErikSchierboom merged 6 commits into from
May 4, 2025
Merged

Various refactorings #300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3c646c6
Use file-scoped namespaces
ErikSchierboom May 4, 2025
78160b2
Use sealed class
ErikSchierboom May 4, 2025
0ca2745
Fix warnings
ErikSchierboom May 4, 2025
6479533
Use null pattern matching
ErikSchierboom May 4, 2025
73c004e
Use namespace
ErikSchierboom May 4, 2025
b94599a
Various refactorings
ErikSchierboom May 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 18 additions & 19 deletions src/Exercism.TestRunner.CSharp/Options.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,33 @@

using Humanizer;

namespace Exercism.TestRunner.CSharp
namespace Exercism.TestRunner.CSharp;

internal sealed class Options
{
internal class Options
{
[Value(0, Required = true, HelpText = "The solution's exercise")]
public string Slug { get; }
[Value(0, Required = true, HelpText = "The solution's exercise")]
public string Slug { get; }

[Value(1, Required = true, HelpText = "The directory containing the solution")]
public string InputDirectory { get; }
[Value(1, Required = true, HelpText = "The directory containing the solution")]
public string InputDirectory { get; }

[Value(2, Required = true, HelpText = "The directory to which the results will be written")]
public string OutputDirectory { get; }
[Value(2, Required = true, HelpText = "The directory to which the results will be written")]
public string OutputDirectory { get; }

public Options(string slug, string inputDirectory, string outputDirectory) =>
(Slug, InputDirectory, OutputDirectory) = (slug, inputDirectory, outputDirectory);
public Options(string slug, string inputDirectory, string outputDirectory) =>
(Slug, InputDirectory, OutputDirectory) = (slug, inputDirectory, outputDirectory);

public string TestsFilePath => Path.Combine(InputDirectory, $"{Exercise}Tests.cs");
public string TestsFilePath => Path.Combine(InputDirectory, $"{Exercise}Tests.cs");

public string ProjectFilePath => Path.Combine(InputDirectory, $"{Exercise}.csproj");
public string ProjectFilePath => Path.Combine(InputDirectory, $"{Exercise}.csproj");

public string AssemblyInfoFilePath => Path.Combine(InputDirectory, "AssemblyInfo.cs");
public string AssemblyInfoFilePath => Path.Combine(InputDirectory, "AssemblyInfo.cs");

public string BuildLogFilePath => Path.Combine(InputDirectory, "msbuild.log");
public string BuildLogFilePath => Path.Combine(InputDirectory, "msbuild.log");

public string TestResultsFilePath => Path.Combine(InputDirectory, "TestResults", "tests.trx");
public string TestResultsFilePath => Path.Combine(InputDirectory, "TestResults", "tests.trx");

public string ResultsJsonFilePath => Path.GetFullPath(Path.Combine(OutputDirectory, "results.json"));
public string ResultsJsonFilePath => Path.GetFullPath(Path.Combine(OutputDirectory, "results.json"));

private string Exercise => Slug.Dehumanize().Pascalize();
}
private string Exercise => Slug.Dehumanize().Pascalize();
}
29 changes: 14 additions & 15 deletions src/Exercism.TestRunner.CSharp/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
using CommandLine;

namespace Exercism.TestRunner.CSharp
namespace Exercism.TestRunner.CSharp;

public static class Program
{
public static class Program
{
public static void Main(string[] args) =>
Parser.Default
.ParseArguments<Options>(args)
.WithParsed(CreateTestResults);
public static void Main(string[] args) =>
Parser.Default
.ParseArguments<Options>(args)
.WithParsed(CreateTestResults);

private static void CreateTestResults(Options options)
{
Console.WriteLine($"[{DateTimeOffset.UtcNow:u}] Running test runner for '{options.Slug}' solution...");
private static void CreateTestResults(Options options)
{
Console.WriteLine($"[{DateTimeOffset.UtcNow:u}] Running test runner for '{options.Slug}' solution...");

var testSuite = TestSuite.FromOptions(options);
var testRun = testSuite.Run();
testRun.WriteToFile(options.ResultsJsonFilePath);
var testSuite = TestSuite.FromOptions(options);
var testRun = testSuite.Run();
testRun.WriteToFile(options.ResultsJsonFilePath);

Console.WriteLine($"[{DateTimeOffset.UtcNow:u}] Ran test runner for '{options.Slug}' solution");
}
Console.WriteLine($"[{DateTimeOffset.UtcNow:u}] Ran test runner for '{options.Slug}' solution");
}
}
4 changes: 3 additions & 1 deletion src/Exercism.TestRunner.CSharp/StringExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
public static class StringExtensions
namespace Exercism.TestRunner.CSharp;

public static class StringExtensions
{
public static string UseUnixNewlines(this string str) =>
str.Replace("\r\n", "\n");
Expand Down
251 changes: 124 additions & 127 deletions src/Exercism.TestRunner.CSharp/TestResultParser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,149 +5,146 @@
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.Win32.SafeHandles;

namespace Exercism.TestRunner.CSharp
namespace Exercism.TestRunner.CSharp;

internal static class TestResultParser
{
internal static class TestResultParser
internal static TestResult[] FromFile(string logFilePath, SyntaxTree testsSyntaxTree)
{
internal static TestResult[] FromFile(string logFilePath, SyntaxTree testsSyntaxTree)
{
using var fileStream = File.OpenRead(logFilePath);
var result = (XmlTestRun)new XmlSerializer(typeof(XmlTestRun)).Deserialize(fileStream);

if (result.Results == null)
return Array.Empty<TestResult>();

return result.ToTestResults(testsSyntaxTree);
}
using var fileStream = File.OpenRead(logFilePath);
var result = new XmlSerializer(typeof(XmlTestRun)).Deserialize(fileStream) as XmlTestRun;

private static TestResult[] ToTestResults(this XmlTestRun result, SyntaxTree testsSyntaxTree)
{
var methodDeclarations =
testsSyntaxTree
.GetRoot()
.DescendantNodes()
.OfType<MethodDeclarationSyntax>()
.ToArray();

var testResults =
from unitTestResult in result.Results.UnitTestResult
let testMethodDeclaration = unitTestResult.TestMethod(methodDeclarations)
orderby testMethodDeclaration.GetLocation().GetLineSpan().StartLinePosition.Line
select ToTestResult(unitTestResult, testMethodDeclaration);

return testResults.ToArray();
}

private static TestResult ToTestResult(XmlUnitTestResult xmlUnitTestResult, MethodDeclarationSyntax testMethodDeclaration) =>
new()
{
Name = xmlUnitTestResult.Name(),
Status = xmlUnitTestResult.Status(),
Message = xmlUnitTestResult.Message(),
Output = xmlUnitTestResult.Output(),
TaskId = testMethodDeclaration.TaskId(),
TestCode = testMethodDeclaration.TestCode()
};

private static MethodDeclarationSyntax TestMethod(this XmlUnitTestResult xmlUnitTestResult, IEnumerable<MethodDeclarationSyntax> methodDeclarations)
{
var classAndMethodName = xmlUnitTestResult.TestName.Split(".");
var className = classAndMethodName[0];
var methodName = classAndMethodName[1].Split('(')[0];

return methodDeclarations.Single(method =>
method.Identifier.Text == methodName &&
method.Parent is ClassDeclarationSyntax classDeclaration &&
classDeclaration.Identifier.Text == className);
}

private static string Name(this XmlUnitTestResult xmlUnitTestResult) =>
xmlUnitTestResult.TestName
.Substring(xmlUnitTestResult.TestName.LastIndexOf(".", StringComparison.Ordinal) + 1)
.Humanize();

private static TestStatus Status(this XmlUnitTestResult xmlUnitTestResult) =>
xmlUnitTestResult.Outcome switch
{
"Passed" => TestStatus.Pass,
"Failed" => TestStatus.Fail,
_ => TestStatus.Error
};

private static string Message(this XmlUnitTestResult xmlUnitTestResult) =>
xmlUnitTestResult.Output?.ErrorInfo?.Message?.UseUnixNewlines()?.Trim();

private static string Output(this XmlUnitTestResult xmlUnitTestResult) =>
xmlUnitTestResult.Output?.StdOut?.UseUnixNewlines()?.Trim();

private static string TestCode(this MethodDeclarationSyntax testMethod)
{
if (testMethod.Body != null)
return SyntaxFactory.List(testMethod.Body.Statements.Select(statement => statement.WithoutLeadingTrivia())).ToString();

return testMethod.ExpressionBody!
.Expression
.WithoutLeadingTrivia()
.ToString();
}

private static int? TaskId(this MethodDeclarationSyntax testMethod) =>
testMethod.AttributeLists
.SelectMany(attributeList => attributeList.Attributes)
.Where(attribute =>
attribute.Name.ToString() == "Task" &&
attribute.ArgumentList != null &&
attribute.ArgumentList.Arguments.Count == 1 &&
attribute.ArgumentList.Arguments[0].Expression.IsKind(SyntaxKind.NumericLiteralExpression))
.Select(attribute => (LiteralExpressionSyntax)attribute.ArgumentList.Arguments[0].Expression)
.Select(taskNumberExpression => (int?)taskNumberExpression.Token.Value!)
.FirstOrDefault();
return result?.Results is null ? [] : result.ToTestResults(testsSyntaxTree);
}

[XmlRoot(ElementName = "Output", Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public class XmlOutput
private static TestResult[] ToTestResults(this XmlTestRun result, SyntaxTree testsSyntaxTree)
{
[XmlElement(ElementName = "StdOut", Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public string StdOut { get; set; }
var methodDeclarations =
testsSyntaxTree
.GetRoot()
.DescendantNodes()
.OfType<MethodDeclarationSyntax>()
.ToArray();

var testResults =
from unitTestResult in result.Results.UnitTestResult
let testMethodDeclaration = unitTestResult.TestMethod(methodDeclarations)
orderby testMethodDeclaration.GetLocation().GetLineSpan().StartLinePosition.Line
select ToTestResult(unitTestResult, testMethodDeclaration);

[XmlElement(ElementName = "ErrorInfo",
Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public XmlErrorInfo ErrorInfo { get; set; }
return testResults.ToArray();
}

[XmlRoot(ElementName = "UnitTestResult", Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public class XmlUnitTestResult
private static TestResult ToTestResult(XmlUnitTestResult xmlUnitTestResult, MethodDeclarationSyntax testMethodDeclaration) =>
new()
{
Name = xmlUnitTestResult.Name(),
Status = xmlUnitTestResult.Status(),
Message = xmlUnitTestResult.Message(),
Output = xmlUnitTestResult.Output(),
TaskId = testMethodDeclaration.TaskId(),
TestCode = testMethodDeclaration.TestCode()
};

private static MethodDeclarationSyntax TestMethod(this XmlUnitTestResult xmlUnitTestResult, IEnumerable<MethodDeclarationSyntax> methodDeclarations)
{
[XmlElement(ElementName = "Output", Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public XmlOutput Output { get; set; }
var classAndMethodName = xmlUnitTestResult.TestName.Split(".");
var className = classAndMethodName[0];
var methodName = classAndMethodName[1].Split('(')[0];

return methodDeclarations.Single(method =>
method.Identifier.Text == methodName &&
method.Parent is ClassDeclarationSyntax classDeclaration &&
classDeclaration.Identifier.Text == className);
}

[XmlAttribute(AttributeName = "testName")]
public string TestName { get; set; }
private static string Name(this XmlUnitTestResult xmlUnitTestResult) =>
xmlUnitTestResult.TestName
.Substring(xmlUnitTestResult.TestName.LastIndexOf(".", StringComparison.Ordinal) + 1)
.Humanize();

[XmlAttribute(AttributeName = "outcome")]
public string Outcome { get; set; }
}
private static TestStatus Status(this XmlUnitTestResult xmlUnitTestResult) =>
xmlUnitTestResult.Outcome switch
{
"Passed" => TestStatus.Pass,
"Failed" => TestStatus.Fail,
_ => TestStatus.Error
};

[XmlRoot(ElementName = "ErrorInfo", Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public class XmlErrorInfo
{
[XmlElement(ElementName = "Message", Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public string Message { get; set; }
}
private static string? Message(this XmlUnitTestResult xmlUnitTestResult) =>
xmlUnitTestResult.Output?.ErrorInfo?.Message?.UseUnixNewlines()?.Trim();

[XmlRoot(ElementName = "Results", Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public class XmlResults
{
[XmlElement(ElementName = "UnitTestResult",
Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public List<XmlUnitTestResult> UnitTestResult { get; set; }
}
private static string? Output(this XmlUnitTestResult xmlUnitTestResult) =>
xmlUnitTestResult.Output?.StdOut?.UseUnixNewlines()?.Trim();

[XmlRoot(ElementName = "TestRun", Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public class XmlTestRun
private static string TestCode(this MethodDeclarationSyntax testMethod)
{
[XmlElement(ElementName = "Results", Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public XmlResults Results { get; set; }
if (testMethod.Body is not null)
return SyntaxFactory.List(testMethod.Body.Statements.Select(statement => statement.WithoutLeadingTrivia())).ToString();

return testMethod.ExpressionBody!
.Expression
.WithoutLeadingTrivia()
.ToString();
}

private static int? TaskId(this MethodDeclarationSyntax testMethod) =>
testMethod.AttributeLists
.SelectMany(attributeList => attributeList.Attributes)
.Where(attribute =>
attribute.Name.ToString() == "Task" &&
attribute.ArgumentList != null &&
attribute.ArgumentList.Arguments.Count == 1 &&
attribute.ArgumentList.Arguments[0].Expression.IsKind(SyntaxKind.NumericLiteralExpression))
.Select(attribute => (LiteralExpressionSyntax)attribute.ArgumentList!.Arguments[0].Expression)
.Select(taskNumberExpression => (int?)taskNumberExpression.Token.Value!)
.FirstOrDefault();
}

[XmlRoot(ElementName = "Output", Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public sealed class XmlOutput
{
[XmlElement(ElementName = "StdOut", Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public string? StdOut { get; set; }

[XmlElement(ElementName = "ErrorInfo",
Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public XmlErrorInfo? ErrorInfo { get; set; }
}

[XmlRoot(ElementName = "UnitTestResult", Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public sealed class XmlUnitTestResult
{
[XmlElement(ElementName = "Output", Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public XmlOutput? Output { get; set; }

[XmlAttribute(AttributeName = "testName")]
public required string TestName { get; set; }

[XmlAttribute(AttributeName = "outcome")]
public required string Outcome { get; set; }
}

[XmlRoot(ElementName = "ErrorInfo", Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public sealed class XmlErrorInfo
{
[XmlElement(ElementName = "Message", Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public string? Message { get; set; }
}

[XmlRoot(ElementName = "Results", Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public sealed class XmlResults
{
[XmlElement(ElementName = "UnitTestResult",
Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public List<XmlUnitTestResult>? UnitTestResult { get; set; }
}

[XmlRoot(ElementName = "TestRun", Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public sealed class XmlTestRun
{
[XmlElement(ElementName = "Results", Namespace = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010")]
public required XmlResults Results { get; set; }
}
Loading