Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 014af1f

Browse files
dupdobdupdob
committedFeb 2, 2024
chore: keep on refining design
1 parent f7a877e commit 014af1f

21 files changed

+389
-67
lines changed
 

‎docs/technical-reference/Mutation Orchestration Design.md

+313
Large diffs are not rendered by default.

‎src/Stryker.Core/Stryker.Core.UnitTest/Compiling/CSharpRollbackProcessTests.cs

+1
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,7 @@ private void RefreshAccountNumber()
204204
}
205205

206206
var mutant = mutator.Mutate(syntaxTree, null);
207+
207208
helpers.Add(mutant);
208209

209210
var references = new List<string> {

‎src/Stryker.Core/Stryker.Core.UnitTest/Mutants/CsharpMutantOrchestratorTests.cs

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
using System.Collections.Generic;
21
using System.Linq;
32
using Microsoft.CodeAnalysis.CSharp;
4-
using Microsoft.CodeAnalysis.CSharp.Syntax;
53
using Shouldly;
64
using Stryker.Core.Mutants;
75
using Stryker.Core.Mutators;
@@ -502,9 +500,9 @@ string SomeLocalFunction()
502500
public void ShouldMutateConditionalExpressionOnArrayDeclaration()
503501
{
504502
var source =
505-
@"public static IEnumerable<int> Foo() => new int[] { }.ToArray().Any(x => x==1)?.OrderBy(e => e).ToList();";
503+
@"public static IEnumerable<int> Foo() => new int[] { }.ToArray()!.Any(x => x==1)?.OrderBy(e => e).ToList();";
506504
var expected =
507-
@"public static IEnumerable<int> Foo() => (StrykerNamespace.MutantControl.IsActive(2)?new int[] { }.ToArray().Any(x => x==1)?.OrderByDescending(e => e).ToList():(StrykerNamespace.MutantControl.IsActive(0)?new int[] { }.ToArray().All(x => x==1):new int[] { }.ToArray().Any(x => (StrykerNamespace.MutantControl.IsActive(1)?x!=1:x==1)))?.OrderBy(e => e).ToList());";
505+
@"public static IEnumerable<int> Foo() => (StrykerNamespace.MutantControl.IsActive(2)?new int[] { }.ToArray()!.Any(x => x==1)?.OrderByDescending(e => e).ToList():(StrykerNamespace.MutantControl.IsActive(0)?new int[] { }.ToArray()!.All(x => x==1):new int[] { }.ToArray()!.Any(x => (StrykerNamespace.MutantControl.IsActive(1)?x!=1:x==1)))?.OrderBy(e => e).ToList());";
508506

509507
ShouldMutateSourceInClassToExpected(source, expected);
510508
}

‎src/Stryker.Core/Stryker.Core/Helpers/RoslynHelper.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public static bool IsAStringExpression(this ExpressionSyntax node) =>
2323
/// </summary>
2424
/// <param name="node">expression to check</param>
2525
/// <returns>true if it contains a declaration</returns>
26-
public static bool ContainsDeclarations(this ExpressionSyntax node) =>
26+
public static bool ContainsDeclarations(this SyntaxNode node) =>
2727
node.ContainsNodeThatVerifies(x =>
2828
x.IsKind(SyntaxKind.DeclarationExpression) || x.IsKind(SyntaxKind.DeclarationPattern));
2929

‎src/Stryker.Core/Stryker.Core/Mutants/CsharpMutantOrchestrator.cs

+9-6
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ namespace Stryker.Core.Mutants;
1616
/// <inheritdoc/>
1717
public class CsharpMutantOrchestrator : BaseMutantOrchestrator<SyntaxTree, SemanticModel>
1818
{
19-
private readonly TypeBasedStrategy<SyntaxNode, INodeMutator> _specificOrchestrator =
19+
private readonly TypeBasedStrategy<SyntaxNode, INodeOrchestrator> _specificOrchestrator =
2020
new();
2121

2222
private ILogger Logger { get; }
@@ -32,7 +32,11 @@ public CsharpMutantOrchestrator(MutantPlacer placer, IEnumerable<IMutator> mutat
3232
Logger = ApplicationLogging.LoggerFactory.CreateLogger<CsharpMutantOrchestrator>();
3333

3434
// declare node specific orchestrators. Note that order is relevant, they should be declared from more specific to more generic one
35-
_specificOrchestrator.RegisterHandlers(new List<INodeMutator>
35+
_specificOrchestrator.RegisterHandlers(BuildOrchestratorList());
36+
}
37+
38+
private static List<INodeOrchestrator> BuildOrchestratorList() =>
39+
new()
3640
{
3741
// Those node types describe compile time constants and thus cannot be mutated at run time
3842
// attributes
@@ -69,14 +73,13 @@ public CsharpMutantOrchestrator(MutantPlacer placer, IEnumerable<IMutator> mutat
6973
// ensure declaration are mutated at the block level
7074
new LocalDeclarationOrchestrator(),
7175
new InvocationExpressionOrchestrator(),
72-
76+
new MemberDefinitionOrchestrator<MemberDeclarationSyntax>(),
7377
new MutateAtStatementLevelOrchestrator<AssignmentExpressionSyntax>(),
7478
new BlockOrchestrator(),
7579
new StatementSpecificOrchestrator<StatementSyntax>(),
7680
new ExpressionSpecificOrchestrator<ExpressionSyntax>(),
7781
new SyntaxNodeOrchestrator()
78-
});
79-
}
82+
};
8083

8184
private static List<IMutator> DefaultMutatorList() =>
8285
new()
@@ -119,7 +122,7 @@ public override SyntaxTree Mutate(SyntaxTree input, SemanticModel semanticModel)
119122
// search for node specific handler
120123
input.WithRootAndOptions(GetHandler(input.GetRoot()).Mutate(input.GetRoot(), semanticModel, new MutationContext(this)), input.Options);
121124

122-
internal INodeMutator GetHandler(SyntaxNode currentNode) => _specificOrchestrator.FindHandler(currentNode);
125+
internal INodeOrchestrator GetHandler(SyntaxNode currentNode) => _specificOrchestrator.FindHandler(currentNode);
123126

124127
internal IEnumerable<Mutant> GenerateMutationsForNode(SyntaxNode current, SemanticModel semanticModel, MutationContext context)
125128
{

‎src/Stryker.Core/Stryker.Core/Mutants/CsharpNodeOrchestrators/AccessorSyntaxOrchestrator.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ internal class AccessorSyntaxOrchestrator : BaseFunctionOrchestrator<AccessorDec
1111
{
1212
protected override (BlockSyntax block, ExpressionSyntax expression) GetBodies(AccessorDeclarationSyntax node) => (node.Body, node.ExpressionBody?.Expression);
1313

14-
protected override ParameterListSyntax Parameters(AccessorDeclarationSyntax node) => SyntaxFactory.ParameterList();
14+
protected override ParameterListSyntax ParameterList(AccessorDeclarationSyntax node) => SyntaxFactory.ParameterList();
1515

1616
protected override TypeSyntax ReturnType(AccessorDeclarationSyntax node) => node.ReturnType();
1717

‎src/Stryker.Core/Stryker.Core/Mutants/CsharpNodeOrchestrators/AnonymousFunctionExpressionOrchestrator.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ internal class AnonymousFunctionExpressionOrchestrator : BaseFunctionOrchestrato
88
{
99
protected override (BlockSyntax block, ExpressionSyntax expression) GetBodies(AnonymousFunctionExpressionSyntax node) => (node.Block, node.ExpressionBody);
1010

11-
protected override ParameterListSyntax Parameters(AnonymousFunctionExpressionSyntax node) => node switch {ParenthesizedLambdaExpressionSyntax parenthesizedLambda => parenthesizedLambda.ParameterList,
11+
protected override ParameterListSyntax ParameterList(AnonymousFunctionExpressionSyntax node) => node switch {ParenthesizedLambdaExpressionSyntax parenthesizedLambda => parenthesizedLambda.ParameterList,
1212
SimpleLambdaExpressionSyntax simpleLambda => SyntaxFactory.ParameterList(SyntaxFactory.SingletonSeparatedList(simpleLambda.Parameter)),
1313
_ => throw new ArgumentOutOfRangeException(nameof(node), node, null)
1414
};

‎src/Stryker.Core/Stryker.Core/Mutants/CsharpNodeOrchestrators/BaseFunctionOrchestrator.cs

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
using System;
2-
using System.Linq;
32
using Microsoft.CodeAnalysis;
43
using Microsoft.CodeAnalysis.CSharp;
54
using Microsoft.CodeAnalysis.CSharp.Syntax;
@@ -15,7 +14,7 @@ namespace Stryker.Core.Mutants.CsharpNodeOrchestrators;
1514
/// </summary>
1615
/// <typeparam name="T">SyntaxNode type</typeparam>
1716
/// <remarks>This class is helpful because there is no (useful) shared parent class for those syntax construct</remarks>
18-
internal abstract class BaseFunctionOrchestrator<T> : NodeSpecificOrchestrator<T, T>, IInstrumentCode where T : SyntaxNode
17+
internal abstract class BaseFunctionOrchestrator<T> :MemberDefinitionOrchestrator<T>, IInstrumentCode where T : SyntaxNode
1918
{
2019
protected BaseFunctionOrchestrator() => Marker = MutantPlacer.RegisterEngine(this, true);
2120

@@ -24,20 +23,19 @@ internal abstract class BaseFunctionOrchestrator<T> : NodeSpecificOrchestrator<T
2423
/// <inheritdoc/>
2524
public string InstrumentEngineId => GetType().Name;
2625

27-
/// <inheritdoc/>
28-
protected override MutationContext PrepareContext(T node, MutationContext context) => base.PrepareContext(node, context.Enter(MutationControl.Member));
29-
30-
/// <inheritdoc/>
31-
protected override void RestoreContext(MutationContext context) => base.RestoreContext(context.Leave());
32-
26+
/// <summary>
27+
/// Get the function body (block or expression)
28+
/// </summary>
29+
/// <param name="node"></param>
30+
/// <returns>a tuple with the block body as first item and the expression body as the second. At least one of them is expected to be null.</returns>
3331
protected abstract (BlockSyntax block, ExpressionSyntax expression) GetBodies(T node);
3432

3533
/// <summary>
3634
/// Gets the parameter list of the function
3735
/// </summary>
3836
/// <param name="node">instance of <see cref="T"/></param>
3937
/// <returns>a parameter list</returns>
40-
protected abstract ParameterListSyntax Parameters(T node);
38+
protected abstract ParameterListSyntax ParameterList(T node);
4139

4240
/// <summary>
4341
/// Get the return type
@@ -51,6 +49,7 @@ internal abstract class BaseFunctionOrchestrator<T> : NodeSpecificOrchestrator<T
5149
/// </summary>
5250
/// <param name="node">instance of <see cref="T"/></param>
5351
/// <param name="blockBody">desired body</param>
52+
/// <param name="expressionBody">desired expression body</param>
5453
/// <returns>an instance of <typeparamref name="T"/> with <paramref name="blockBody"/> body</returns>
5554
protected abstract T SwitchToThisBodies(T node, BlockSyntax blockBody, ExpressionSyntax expressionBody);
5655

@@ -76,6 +75,7 @@ protected T ConvertToBlockBody(T node, TypeSyntax returnType)
7675
var blockBody = GenerateBlockBody(expression, returnType);
7776
return SwitchToThisBodies(node, blockBody, null).WithAdditionalAnnotations(Marker);
7877
}
78+
7979
/// <inheritdoc/>
8080
public SyntaxNode RemoveInstrumentation(SyntaxNode node)
8181
{
@@ -105,7 +105,7 @@ protected override T InjectMutations(T sourceNode, T targetNode, SemanticModel s
105105
}
106106
var wasInExpressionForm = GetBodies(sourceNode).expression != null;
107107
var returnType = ReturnType(sourceNode);
108-
var parameters = Parameters(sourceNode).Parameters;
108+
var parameters = ParameterList(sourceNode).Parameters;
109109

110110
// no mutations to inject
111111
if (!context.HasLeftOverMutations)

‎src/Stryker.Core/Stryker.Core/Mutants/CsharpNodeOrchestrators/BaseMethodDeclarationOrchestrator.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ internal class BaseMethodDeclarationOrchestrator<T> : BaseFunctionOrchestrator<T
1313
{
1414
protected override (BlockSyntax block, ExpressionSyntax expression) GetBodies(T node) => (node.Body, node.ExpressionBody?.Expression);
1515

16-
protected override ParameterListSyntax Parameters(T node) => node.ParameterList;
16+
protected override ParameterListSyntax ParameterList(T node) => node.ParameterList;
1717

1818
protected override TypeSyntax ReturnType(T node)
1919
{

‎src/Stryker.Core/Stryker.Core/Mutants/NodeOrchestratorBase.cs ‎src/Stryker.Core/Stryker.Core/Mutants/CsharpNodeOrchestrators/CommentParser.cs

+11-11
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@
99

1010
namespace Stryker.Core.Mutants.CsharpNodeOrchestrators;
1111

12-
internal abstract class NodeOrchestratorBase
12+
internal static class CommentParser
1313
{
14-
private static readonly Regex _pattern = new("^\\s*\\/\\/\\s*Stryker", RegexOptions.Compiled | RegexOptions.IgnoreCase, TimeSpan.FromMilliseconds(20));
15-
private static readonly Regex _parser = new("^\\s*\\/\\/\\s*Stryker\\s*(disable|restore)\\s*(once|)\\s*([^:]*)\\s*:?(.*)$", RegexOptions.Compiled | RegexOptions.IgnoreCase, TimeSpan.FromMilliseconds(20));
16-
private static readonly ILogger _logger = ApplicationLogging.LoggerFactory.CreateLogger<NodeOrchestratorBase>();
14+
private static readonly Regex Pattern = new("^\\s*\\/\\/\\s*Stryker", RegexOptions.Compiled | RegexOptions.IgnoreCase, TimeSpan.FromMilliseconds(20));
15+
private static readonly Regex Parser = new("^\\s*\\/\\/\\s*Stryker\\s*(disable|restore)\\s*(once|)\\s*([^:]*)\\s*:?(.*)$", RegexOptions.Compiled | RegexOptions.IgnoreCase, TimeSpan.FromMilliseconds(20));
16+
private static readonly ILogger Logger = ApplicationLogging.LoggerFactory.CreateLogger("CommentParser");
1717

18-
public static MutationContext ParseStrykerComment(MutationContext context, Match match, SyntaxNode node)
18+
private static MutationContext ParseStrykerComment(MutationContext context, Match match, SyntaxNode node)
1919
{
2020
const int ModeGroup = 1;
2121
const int OnceGroup = 2;
@@ -34,7 +34,7 @@ public static MutationContext ParseStrykerComment(MutationContext context, Match
3434
"disable" => true,
3535
_ => false,
3636
};
37-
37+
3838
Mutator[] filteredMutators;
3939
if (match.Groups[MutatorsGroup].Value.ToLower().Trim() == "all")
4040
{
@@ -52,7 +52,7 @@ public static MutationContext ParseStrykerComment(MutationContext context, Match
5252
}
5353
else
5454
{
55-
_logger.LogError(
55+
Logger.LogError(
5656
$"{labels[i]} not recognized as a mutator at {node.GetLocation().GetMappedLineSpan().StartLinePosition}, {node.SyntaxTree.FilePath}. Legal values are {string.Join(',', Enum.GetValues<Mutator>())}.");
5757
}
5858
}
@@ -61,27 +61,27 @@ public static MutationContext ParseStrykerComment(MutationContext context, Match
6161
return context.FilterMutators(disable, filteredMutators, match.Groups[OnceGroup].Value.ToLower() == "once", comment);
6262
}
6363

64-
protected static MutationContext ParseNodeComments(SyntaxNode node, MutationContext context)
64+
public static MutationContext ParseNodeComments(SyntaxNode node, MutationContext context)
6565
{
6666
foreach (var commentTrivia in node.GetLeadingTrivia()
6767
.Where(t => t.IsKind(SyntaxKind.SingleLineCommentTrivia) ||
6868
t.IsKind(SyntaxKind.MultiLineCommentTrivia)).Select(t => t.ToString()))
6969
{
7070
// perform a quick pattern check to see if it is a 'Stryker comment'
71-
if (!_pattern.Match(commentTrivia).Success)
71+
if (!Pattern.Match(commentTrivia).Success)
7272
{
7373
continue;
7474
}
7575

76-
var match = _parser.Match(commentTrivia);
76+
var match = Parser.Match(commentTrivia);
7777
if (match.Success)
7878
{
7979
// this is a Stryker comments, now we parse it
8080
context = ParseStrykerComment(context, match, node);
8181
break;
8282
}
8383

84-
_logger.LogWarning(
84+
Logger.LogWarning(
8585
$"Invalid Stryker comments at {node.GetLocation().GetMappedLineSpan().StartLinePosition}, {node.SyntaxTree.FilePath}.");
8686
}
8787

‎src/Stryker.Core/Stryker.Core/Mutants/CsharpNodeOrchestrators/ExpressionBodiedPropertyOrchestrator.cs

+7-8
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ namespace Stryker.Core.Mutants.CsharpNodeOrchestrators;
77

88
internal class ExpressionBodiedPropertyOrchestrator : BaseFunctionOrchestrator<PropertyDeclarationSyntax>
99
{
10-
protected override bool CanHandle(PropertyDeclarationSyntax t) => t.ExpressionBody!= null || t.Initializer!=null;
10+
protected override bool CanHandle(PropertyDeclarationSyntax t) => t.ExpressionBody!= null || (t.Initializer!=null && t.IsStatic());
1111

1212
protected override (BlockSyntax block, ExpressionSyntax expression) GetBodies(PropertyDeclarationSyntax node) => (node.GetAccessor()?.Body, node.ExpressionBody?.Expression);
1313

14-
protected override ParameterListSyntax Parameters(PropertyDeclarationSyntax node) => SyntaxFactory.ParameterList();
14+
protected override ParameterListSyntax ParameterList(PropertyDeclarationSyntax node) => SyntaxFactory.ParameterList();
1515

1616
protected override TypeSyntax ReturnType(PropertyDeclarationSyntax node) => node.Type;
1717

@@ -31,18 +31,17 @@ protected override PropertyDeclarationSyntax SwitchToThisBodies(PropertyDeclarat
3131

3232
protected override PropertyDeclarationSyntax OrchestrateChildrenMutation(PropertyDeclarationSyntax node, SemanticModel semanticModel, MutationContext context)
3333
{
34-
if (!node.IsStatic())
34+
if (node.Initializer == null)
3535
{
3636
return base.OrchestrateChildrenMutation(node, semanticModel, context);
3737
}
3838

3939
var children = node.ReplaceNodes(node.ChildNodes(), (original, _) =>
40-
MutateSingleNode(original, semanticModel, original == node.Initializer ? context.EnterStatic() : context));
41-
if (children.Initializer != null)
4240
{
43-
children = children.WithInitializer(children.Initializer.WithValue(context.PlaceStaticContextMarker(children.Initializer.Value)));
44-
}
45-
return children;
41+
var context1 = original == node.Initializer ? context.EnterStatic() : context;
42+
return context1.FindHandler(original).Mutate(original, semanticModel, context1);
43+
});
44+
return children.WithInitializer(children.Initializer.WithValue(context.PlaceStaticContextMarker(children.Initializer.Value)));
4645
}
4746

4847
}

‎src/Stryker.Core/Stryker.Core/Mutants/CsharpNodeOrchestrators/INodeMutator.cs ‎src/Stryker.Core/Stryker.Core/Mutants/CsharpNodeOrchestrators/INodeOrchestrator.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
namespace Stryker.Core.Mutants.CsharpNodeOrchestrators;
55

6-
internal interface INodeMutator : ITypeHandler<SyntaxNode>
6+
internal interface INodeOrchestrator : ITypeHandler<SyntaxNode>
77
{
88
SyntaxNode Mutate(SyntaxNode node, SemanticModel semanticModel, MutationContext context);
99
}

‎src/Stryker.Core/Stryker.Core/Mutants/CsharpNodeOrchestrators/InvocationExpressionOrchestrator.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ protected override MutationContext StoreMutations(InvocationExpressionSyntax nod
1414
IEnumerable<Mutant> mutations,
1515
MutationContext context) =>
1616
// if the expression contains a declaration, it must be controlled at the block level.
17-
context.AddMutations(mutations, node.ContainsDeclarations() ? MutationControl.Block : MutationControl.Expression);
17+
context.AddMutations(mutations, node.ArgumentList.ContainsDeclarations() ? MutationControl.Block : MutationControl.Expression);
1818

1919
protected override MutationContext PrepareContext(InvocationExpressionSyntax node, MutationContext context) =>
2020
// invocation with a member binding expression must be controlled at a higher expression level

‎src/Stryker.Core/Stryker.Core/Mutants/CsharpNodeOrchestrators/LocalFunctionStatementOrchestrator.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ internal class LocalFunctionStatementOrchestrator : BaseFunctionOrchestrator<Loc
99
{
1010
protected override (BlockSyntax block, ExpressionSyntax expression) GetBodies(LocalFunctionStatementSyntax node) => (node.Body, node.ExpressionBody?.Expression);
1111

12-
protected override ParameterListSyntax Parameters(LocalFunctionStatementSyntax node) => node.ParameterList;
12+
protected override ParameterListSyntax ParameterList(LocalFunctionStatementSyntax node) => node.ParameterList;
1313

1414
protected override TypeSyntax ReturnType(LocalFunctionStatementSyntax node)
1515
{

‎src/Stryker.Core/Stryker.Core/Mutants/CsharpNodeOrchestrators/MemberAccessExpressionOrchestrator.cs

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
using System.Collections.Generic;
21
using Microsoft.CodeAnalysis.CSharp.Syntax;
32

43
namespace Stryker.Core.Mutants.CsharpNodeOrchestrators;

‎src/Stryker.Core/Stryker.Core/Mutants/CsharpNodeOrchestrators/MemberDefinitionOrchestrator.cs

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
using Microsoft.CodeAnalysis;
2+
3+
namespace Stryker.Core.Mutants.CsharpNodeOrchestrators;
4+
5+
/// <summary>
6+
/// Base class for node types (and their children) that are member definitions
7+
/// </summary>
8+
/// <typeparam name="T">Syntax node type. (not restricted to MemberDefinitionSyntax)</typeparam>
9+
internal class MemberDefinitionOrchestrator<T>:NodeSpecificOrchestrator<T, T> where T : SyntaxNode
10+
{
11+
protected override MutationContext PrepareContext(T node, MutationContext context) => base.PrepareContext(node, context.Enter(MutationControl.Member));
12+
13+
protected override void RestoreContext(MutationContext context) => base.RestoreContext(context.Leave());
14+
}
There was a problem loading the remainder of the diff.

0 commit comments

Comments
 (0)
Please sign in to comment.