Skip to content

R
roslyn

lwm1986 / roslyn
与 Fork 源项目一致

从无法访问的项目Fork

通知 1
Star 0
Fork 0
R
roslyn

体验新版 GitCode，发现更多精彩内容 >>

提交 a2df6504 编写于 作者: J Julien Couvreur 提交者： GitHub
浏览文件
操作

Allowing readable verification of instrumentation results (#15819)

上级 c99a7a5f
隐藏空白更改
内联 并排
Showing with 461 addition and 174 deletion
src/Compilers/CSharp/Test/Emit/Emit/DynamicAnalysis/DynamicInstrumentationTests.cs
浏览文件 @ a2df6504
......@@ -4,66 +4,14 @@
using System.Collections.Immutable;
using Microsoft.CodeAnalysis.CSharp.Test.Utilities;
using Microsoft.CodeAnalysis.Emit;
using Microsoft.CodeAnalysis.Test.Utilities;
using Xunit;
using static Microsoft.CodeAnalysis.Test.Utilities.CSharpInstrumentationChecker;
namespace Microsoft.CodeAnalysis.CSharp.DynamicAnalysis.UnitTests
{
public class DynamicInstrumentationTests : CSharpTestBase
{
const string InstrumentationHelperSource = @"
namespace Microsoft.CodeAnalysis.Runtime
{
public static class Instrumentation
{
private static bool[][] _payloads;
private static int[] _fileIndices;
private static System.Guid _mvid;
public static bool[] CreatePayload(System.Guid mvid, int methodIndex, int fileIndex, ref bool[] payload, int payloadLength)
{
if (_mvid != mvid)
{
_payloads = new bool[100][];
_fileIndices = new int[100];
_mvid = mvid;
}
if (System.Threading.Interlocked.CompareExchange(ref payload, new bool[payloadLength], null) == null)
{
_payloads[methodIndex] = payload;
_fileIndices[methodIndex] = fileIndex;
return payload;
}
return _payloads[methodIndex];
}
public static void FlushPayload()
{
Console.WriteLine(""Flushing"");
if (_payloads == null)
{
return;
}
for (int i = 0; i < _payloads.Length; i++)
{
bool[] payload = _payloads[i];
if (payload != null)
{
Console.WriteLine(""Method "" + i.ToString());
Console.WriteLine(""File "" + _fileIndices[i].ToString());
for (int j = 0; j < payload.Length; j++)
{
Console.WriteLine(payload[j]);
payload[j] = false;
}
}
}
}
}
}
";
[Fact]
public void HelpersInstrumentation()
{
......@@ -708,50 +656,43 @@ public class Program
Microsoft.CodeAnalysis.Runtime.Instrumentation.FlushPayload();
}
}
";
string expectedOutput = @"Flushing
Method 3
File 1
True
True
Method 4
File 1
True
True
Method 5
File 1
True
True
True
True
True
Method 6
File 1
True
True
True
Method 8
File 1
True
True
False
True
True
True
True
True
True
True
True
True
True
True
";
CompilationVerifier verifier = CompileAndVerify(source + InstrumentationHelperSource, expectedOutput: expectedOutput, options: TestOptions.ReleaseExe);
" + InstrumentationHelperSource;
var checker = new CSharpInstrumentationChecker();
checker.Method(3, 1, "public int Prop3")
.True("get");
checker.Method(4, 1, "public int Prop3")
.True("set");
checker.Method(5, 1, "public Program()")
.True("25")
.True("Prop = 12;")
.True("Prop3 = 12;")
.True("Prop2 = Prop3;");
checker.Method(6, 1, "public static void Main")
.True("new Program();")
.True("Microsoft.CodeAnalysis.Runtime.Instrumentation.FlushPayload();");
checker.Method(8, 1)
.True()
.False()
.True()
.True()
.True()
.True()
.True()
.True()
.True()
.True()
.True()
.True()
.True();
CompilationVerifier verifier = CompileAndVerify(source, expectedOutput: checker.ExpectedOutput, options: TestOptions.ReleaseExe);
verifier.VerifyDiagnostics();
verifier = CompileAndVerify(source + InstrumentationHelperSource, expectedOutput: expectedOutput, options: TestOptions.DebugExe);
checker.CompleteCheck(verifier.Compilation, source);
verifier = CompileAndVerify(source, expectedOutput: checker.ExpectedOutput, options: TestOptions.DebugExe);
verifier.VerifyDiagnostics();
checker.CompleteCheck(verifier.Compilation, source);
}
[Fact]
......@@ -852,7 +793,6 @@ File 1
True
True
";
CompilationVerifier verifier = CompileAndVerify(source + InstrumentationHelperSource, expectedOutput: expectedOutput, options: TestOptions.ReleaseExe);
verifier.VerifyDiagnostics();
verifier = CompileAndVerify(source + InstrumentationHelperSource, expectedOutput: expectedOutput, options: TestOptions.DebugExe);
......@@ -1123,7 +1063,7 @@ File 1
True
True
";
CompilationVerifier verifier = CompileAndVerify(source + InstrumentationHelperSource, options: TestOptions.UnsafeDebugExe, expectedOutput: expectedOutput);
verifier.VerifyDiagnostics();
}
......
src/Compilers/VisualBasic/Test/Emit/Emit/DynamicAnalysis/DynamicInstrumentationTests.vb
浏览文件 @ a2df6504
......@@ -3,63 +3,18 @@
Imports System.Collections.Immutable
Imports System.Xml.Linq
Imports Microsoft.CodeAnalysis.Emit
Imports Microsoft.CodeAnalysis.Test.Utilities
Imports Microsoft.CodeAnalysis.Test.Utilities.VBInstrumentationChecker
Imports Microsoft.CodeAnalysis.VisualBasic
Imports Microsoft.CodeAnalysis.VisualBasic.UnitTests
Imports Roslyn.Test.Utilities
Imports Xunit
Namespace Microsoft.CodeAnalysis.VisualBasic.DynamicAnalysis.UnitTests
Public Class DynamicInstrumentationTests
Inherits BasicTestBase
Const InstrumentationHelperSourceStr As String = "
Namespace Microsoft.CodeAnalysis.Runtime
Public Class Instrumentation
Private Shared _payloads As Boolean()()
Private Shared _fileIndices As Integer()
Private Shared _mvid As System.Guid
Public Shared Function CreatePayload(mvid As System.Guid, methodIndex As Integer, fileIndex As Integer, ByRef payload As Boolean(), payloadLength As Integer) As Boolean()
If _mvid <> mvid Then
_payloads = New Boolean(100)() {}
_fileIndices = New Integer(100) {}
_mvid = mvid
End If
If System.Threading.Interlocked.CompareExchange(payload, new Boolean(payloadLength - 1) {}, Nothing) Is Nothing Then
_payloads(methodIndex) = payload
_fileIndices(methodIndex) = fileIndex
Return payload
End If
Return _payloads(methodIndex)
End Function
Public Shared Sub FlushPayload()
System.Console.WriteLine(""Flushing"")
If _payloads Is Nothing Then
Return
End If
For i As Integer = 0 To _payloads.Length - 1
Dim payload As Boolean() = _payloads(i)
if payload IsNot Nothing
System.Console.WriteLine(""Method "" & i.ToString())
System.Console.WriteLine(""File "" & _fileIndices(i).ToString())
For j As Integer = 0 To payload.Length - 1
System.Console.WriteLine(payload(j))
payload(j) = False
Next
End If
Next
End Sub
End Class
End Namespace
"
ReadOnly InstrumentationHelperSource As XElement = <file name="c.vb">
<%= InstrumentationHelperSourceStr %>
</file>
<Fact>
Public Sub SimpleCoverage()
Dim testSource As XElement = <file name="c.vb">
......@@ -80,33 +35,26 @@ End Module
source.Add(testSource)
source.Add(InstrumentationHelperSource)
Dim expectedOutput As XCData = <![CDATA[
Flushing
Method 1
File 1
True
True
True
Method 2
File 1
True
Method 5
File 1
True
True
False
True
True
True
True
True
True
True
True
True
]]>
Dim verifier As CompilationVerifier = CompileAndVerify(source, expectedOutput)
Dim checker = New VBInstrumentationChecker()
checker.Method(1, 1, "Public Sub Main").
True("TestMain()").
True("Microsoft.CodeAnalysis.Runtime.Instrumentation.FlushPayload()")
checker.Method(2, 1, "Sub TestMain()")
checker.Method(5, 1).
True().
False().
True().
True().
True().
True().
True().
True().
True().
True().
True()
Dim verifier As CompilationVerifier = CompileAndVerify(source, checker.ExpectedOutput)
checker.CompleteCheck(verifier.Compilation, testSource)
verifier.VerifyIL(
"Program.TestMain",
......
src/Test/Utilities/Desktop/InstrumentationChecker.cs 0 → 100755
浏览文件 @ a2df6504
// Copyright (c) Microsoft. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Reflection.PortableExecutable;
using System.Text;
using System.Xml.Linq;
using Microsoft.CodeAnalysis.Collections;
using Microsoft.CodeAnalysis.Emit;
using Roslyn.Test.Utilities;
using Xunit;
namespace Microsoft.CodeAnalysis.Test.Utilities
{
/// <summary>
/// Helper to check compilations with test instrumentation.
///
/// Use in three steps:
/// 1. Initialize with expectations about methods, what spans they include and which spans were covered.
/// This is done with calls to Method followed by a call to True or False for each span within a method.
/// 2. Use the ExpectedOutput to check that executing the compilation produces the expected instrumentation data.
/// 3. Use CompleteCheck to check that your expectations about spans were correct.
///
/// If you only do the third step, the test output will provide you with a template of code for the first step.
/// </summary>
internal sealed class CSharpInstrumentationChecker : BaseInstrumentationChecker
{
public string ExpectedOutput { get { return _consoleExpectations.ToString(); } }
internal override void AddConsoleExpectation(string text)
{
_consoleExpectations.AppendLine(text);
}
internal override void Dump(DynamicAnalysisDataReader reader, string[] sourceLines)
{
var output = PooledStringBuilder.GetInstance();
output.Builder.AppendLine("Template code for checking instrumentation results:");
for (int method = 1; method <= reader.Methods.Length; method++)
{
var snippets = GetActualSnippets(method, reader, sourceLines);
if (snippets.Length == 0)
{
continue;
}
string methodTermination = GetTermination(0, snippets.Length);
if (snippets[0] == null)
{
output.Builder.AppendLine($"checker.Method({method}, 1){methodTermination}");
}
else
{
output.Builder.AppendLine($"checker.Method({method}, 1, \"{snippets[0]}\"){methodTermination}");
}
for (int index = 1; index < snippets.Length; index++)
{
string termination = GetTermination(index, snippets.Length);
if (snippets[index] == null)
{
output.Builder.AppendLine($" .True(){termination}");
}
else
{
output.Builder.AppendLine($" .True(\"{snippets[index]}\"){termination}");
}
}
}
AssertEx.Fail(output.ToStringAndFree());
}
private static string GetTermination(int index, int length)
{
return (index == length - 1) ? ";" : "";
}
public const string InstrumentationHelperSource = @"
namespace Microsoft.CodeAnalysis.Runtime
{
public static class Instrumentation
{
private static bool[][] _payloads;
private static int[] _fileIndices;
private static System.Guid _mvid;
public static bool[] CreatePayload(System.Guid mvid, int methodIndex, int fileIndex, ref bool[] payload, int payloadLength)
{
if (_mvid != mvid)
{
_payloads = new bool[100][];
_fileIndices = new int[100];
_mvid = mvid;
}
if (System.Threading.Interlocked.CompareExchange(ref payload, new bool[payloadLength], null) == null)
{
_payloads[methodIndex] = payload;
_fileIndices[methodIndex] = fileIndex;
return payload;
}
return _payloads[methodIndex];
}
public static void FlushPayload()
{
Console.WriteLine(""Flushing"");
if (_payloads == null)
{
return;
}
for (int i = 0; i < _payloads.Length; i++)
{
bool[] payload = _payloads[i];
if (payload != null)
{
Console.WriteLine(""Method "" + i.ToString());
Console.WriteLine(""File "" + _fileIndices[i].ToString());
for (int j = 0; j < payload.Length; j++)
{
Console.WriteLine(payload[j]);
payload[j] = false;
}
}
}
}
}
}
";
}
/// <summary>
/// Helper to check compilations with test instrumentation.
///
/// Use in three steps:
/// 1. Initialize with expectations about methods, what spans they include and which spans were covered.
/// This is done with calls to Method followed by a call to True or False for each span within a method.
/// 2. Use the ExpectedOutput to check that executing the compilation produces the expected instrumentation data.
/// 3. Use CompleteCheck to check that your expectations about spans were correct.
///
/// If you only do the third step, the test output will provide you with a template of code for the first step.
/// </summary>
public sealed class VBInstrumentationChecker : BaseInstrumentationChecker
{
private string tab = " ";
public XCData ExpectedOutput { get { return new XCData(_consoleExpectations.ToString()); } }
internal override void AddConsoleExpectation(string text)
{
_consoleExpectations.Append(text);
_consoleExpectations.Append('\n');
}
public void CompleteCheck(Compilation compilation, XElement source)
{
CompleteCheck(compilation, (source.FirstNode as XText).Value.Trim());
}
internal override void Dump(DynamicAnalysisDataReader reader, string[] sourceLines)
{
var output = PooledStringBuilder.GetInstance();
output.Builder.AppendLine("Template code for checking instrumentation results:");
for (int method = 1; method <= reader.Methods.Length; method++)
{
var snippets = GetActualSnippets(method, reader, sourceLines);
if (snippets.Length == 0)
{
continue;
}
var methodTermination = GetTermination(0, snippets.Length);
if (snippets[0] == null)
{
output.Builder.AppendLine($"{tab}{tab}{tab}checker.Method({method}, 1){methodTermination}");
}
else
{
output.Builder.AppendLine($"{tab}{tab}{tab}checker.Method({method}, 1, \"{snippets[0]}\"){methodTermination}");
}
for (int index = 1; index < snippets.Length; index++)
{
string termination = GetTermination(index, snippets.Length);
if (snippets[index] == null)
{
output.Builder.AppendLine($"{tab}{tab}{tab}{tab}True(){termination}");
}
else
{
output.Builder.AppendLine($"{tab}{tab}{tab}{tab}True(\"{snippets[index]}\"){termination}");
}
}
}
AssertEx.Fail(output.ToStringAndFree());
}
private static string GetTermination(int index, int length)
{
return (index == length - 1) ? "" : ".";
}
public static readonly XElement InstrumentationHelperSource = new XElement("file", new XAttribute("name", "c.vb"), InstrumentationHelperSourceStr);
public const string InstrumentationHelperSourceStr = @"
Namespace Microsoft.CodeAnalysis.Runtime
Public Class Instrumentation
Private Shared _payloads As Boolean()()
Private Shared _fileIndices As Integer()
Private Shared _mvid As System.Guid
Public Shared Function CreatePayload(mvid As System.Guid, methodIndex As Integer, fileIndex As Integer, ByRef payload As Boolean(), payloadLength As Integer) As Boolean()
If _mvid <> mvid Then
_payloads = New Boolean(100)() {}
_fileIndices = New Integer(100) {}
_mvid = mvid
End If
If System.Threading.Interlocked.CompareExchange(payload, new Boolean(payloadLength - 1) {}, Nothing) Is Nothing Then
_payloads(methodIndex) = payload
_fileIndices(methodIndex) = fileIndex
Return payload
End If
Return _payloads(methodIndex)
End Function
Public Shared Sub FlushPayload()
System.Console.WriteLine(""Flushing"")
If _payloads Is Nothing Then
Return
End If
For i As Integer = 0 To _payloads.Length - 1
Dim payload As Boolean() = _payloads(i)
if payload IsNot Nothing
System.Console.WriteLine(""Method "" & i.ToString())
System.Console.WriteLine(""File "" & _fileIndices(i).ToString())
For j As Integer = 0 To payload.Length - 1
System.Console.WriteLine(payload(j))
payload(j) = False
Next
End If
Next
End Sub
End Class
End Namespace
";
}
public abstract class BaseInstrumentationChecker
{
protected StringBuilder _consoleExpectations = new StringBuilder();
private Dictionary<int /*method*/, MethodChecker> _spanExpectations = new Dictionary<int, MethodChecker>();
protected BaseInstrumentationChecker()
{
AddConsoleExpectation($"Flushing");
}
/// <summary>
/// Start recording expectations for a method.
/// They need to be recorded in order, from method with smallest identifier to largest.
/// </summary>
/// <param name="method">The 1-based cardinal for referring to methods in data emitted and instrumentation data collected.</param>
/// <param name="file">The 1-based cardinal identifying a source file, as collected by the instrumentation.</param>
/// <param name="snippet">
/// A short snippet of code capturing the what you expect the span for this method to look like.
/// It will be verified against the start of the actual method source span.
/// If no snippet is passed in, then snippet validation will be disabled for the whole method (subsequent calls to `True` or `False`).
/// </param>
public MethodChecker Method(int method, int file, string snippet = null)
{
AddConsoleExpectation($"Method {method}");
AddConsoleExpectation($"File {file}");
if (snippet == null)
{
return new MethodChecker(this, noSnippets: true).True();
}
var result = new MethodChecker(this).True(snippet);
_spanExpectations.Add(method, result);
return result;
}
/// <summary>
/// Verify the recorded expectations.
/// </summary>
public void CompleteCheck(Compilation compilation, string source)
{
var peImage = compilation.EmitToArray(EmitOptions.Default.WithInstrumentationKinds(ImmutableArray.Create(InstrumentationKind.TestCoverage)));
var peReader = new PEReader(peImage);
var reader = DynamicAnalysisDataReader.TryCreateFromPE(peReader, "<DynamicAnalysisData>");
string[] sourceLines = source.Split('\n');
if (_spanExpectations.Count == 0)
{
Dump(reader, sourceLines);
return;
}
foreach (int method in _spanExpectations.Keys)
{
var actualSnippets = GetActualSnippets(method, reader, sourceLines);
var expectedSnippets = _spanExpectations[method].SnippetExpectations;
AssertEx.Equal(expectedSnippets, actualSnippets, new SnippetComparer(), $"Validation of method {method} failed.");
}
}
// Fails the test and outputs a template for updating the test code with appropriate expectations.
internal abstract void Dump(DynamicAnalysisDataReader reader, string[] sourceLines);
internal abstract void AddConsoleExpectation(string text);
internal static ImmutableArray<string> GetActualSnippets(int method, DynamicAnalysisDataReader reader, string[] sourceLines)
{
var actualSpans = reader.GetSpans(reader.Methods[method - 1].Blob);
return actualSpans.SelectAsArray((span, lines) =>
{
if (span.StartLine >= lines.Length) { return null; }
return lines[span.StartLine].Substring(span.StartColumn).TrimEnd(new[] { '\r', '\n', ' ' });
}, sourceLines);
}
public class MethodChecker
{
private List<string> _snippetExpectations;
private BaseInstrumentationChecker _checker;
public MethodChecker(BaseInstrumentationChecker checker, bool noSnippets = false)
{
_checker = checker;
if (!noSnippets)
{
_snippetExpectations = new List<string>();
}
}
public string[] SnippetExpectations { get { return _snippetExpectations.ToArray(); } }
/// <summary>
/// Records the expectation that the following span will be covered and resembles the provided snippet.
/// </summary>
public MethodChecker True(string expectedSourceSnippet = null)
{
return Expect("True", expectedSourceSnippet);
}
/// <summary>
/// Records the expectation that the following span will *not* be covered and resembles the provided snippet.
/// </summary>
public MethodChecker False(string expectedSourceSnippet = null)
{
return Expect("False", expectedSourceSnippet);
}
private MethodChecker Expect(string text, string expectedSourceSnippet)
{
_checker.AddConsoleExpectation(text);
if (_snippetExpectations != null)
{
_snippetExpectations.Add(expectedSourceSnippet);
}
else
{
Assert.True(expectedSourceSnippet == null,
"You must pass a snippet when checking the method with M if you intend to verify snippets within the method.");
}
return this;
}
}
private class SnippetComparer : IEqualityComparer<string>
{
public bool Equals(string expected, string actual)
{
if (string.IsNullOrWhiteSpace(expected))
{
return false;
}
return actual.StartsWith(expected);
}
public int GetHashCode(string obj)
{
return obj.GetHashCode();
}
}
}
}
src/Test/Utilities/Desktop/TestUtilities.Desktop.csproj
浏览文件 @ a2df6504
......@@ -83,6 +83,7 @@
</Compile>
<Compile Include="AppDomainUtils.cs" />
<Compile Include="CLRHelpers.cs" />
<Compile Include="InstrumentationChecker.cs" />
<Compile Include="CompilerTraitAttribute.cs" />
<Compile Include="ConditionalFactAttribute.cs" />
<Compile Include="ObjectReference.cs" />
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或