-
Notifications
You must be signed in to change notification settings - Fork 65
/
AllureMessageSink.cs
229 lines (200 loc) · 7.5 KB
/
AllureMessageSink.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Linq;
using Allure.Net.Commons;
using Allure.Net.Commons.TestPlan;
using Xunit;
using Xunit.Abstractions;
using Xunit.Sdk;
#nullable enable
namespace Allure.Xunit
{
class AllureMessageSink :
DefaultRunnerReporterWithTypesMessageHandler
{
static AllureTestPlan TestPlan
{
get => AllureLifecycle.Instance.TestPlan;
}
static AllureContext AllureContext
{
get => AllureLifecycle.Instance.Context;
}
readonly ConcurrentDictionary<ITest, AllureXunitTestData>
allureTestData = new();
public AllureMessageSink(IRunnerLogger logger) : base(logger)
{
this.Runner.TestAssemblyExecutionStartingEvent +=
this.OnTestAssemblyExecutionStarting;
this.Execution.TestStartingEvent += this.OnTestStarting;
this.Execution.TestClassConstructionFinishedEvent +=
this.OnTestClassConstructionFinished;
this.Execution.TestFailedEvent += this.OnTestFailed;
this.Execution.TestPassedEvent += this.OnTestPassed;
this.Execution.TestSkippedEvent += this.OnTestSkipped;
this.Execution.TestFinishedEvent += this.OnTestFinished;
CurrentSink ??= this;
}
void OnTestAssemblyExecutionStarting(
MessageHandlerArgs<ITestAssemblyExecutionStarting> args
)
{
args.Message.ExecutionOptions.SetSynchronousMessageReporting(true);
AllureLifecycle.Instance.AllureConfiguration.FailExceptions ??= new()
{
typeof(XunitException).FullName, // v2.4.1 and earlier
"Xunit.Sdk.IAssertionException" // v2.4.2 and onward
};
}
internal bool SelectByTestPlan(ITest test)
{
var associatedData = this.GetOrCreateTestData(test);
var testResult = AllureXunitHelper.CreateTestResultByTest(test);
var isSelected = TestPlan.IsSelected(testResult);
associatedData.TestResult = testResult;
associatedData.IsSelected = isSelected;
return isSelected;
}
internal void OnTestArgumentsCreated(ITest test, object[] arguments) =>
this.GetOrCreateTestData(test).Arguments = arguments;
void OnTestStarting(MessageHandlerArgs<ITestStarting> args)
{
var message = args.Message;
var test = message.Test;
var testData = this.GetOrCreateTestData(test);
if (testData.IsSelected)
{
if (IsStaticTestMethod(message))
{
AllureXunitHelper.StartAllureTestCase(
test,
testData.TestResult
);
this.CaptureTestContext(test);
}
else
{
AllureXunitHelper.StartNewAllureContainer(
message.TestClass.Class.Name
);
}
}
}
void OnTestClassConstructionFinished(
MessageHandlerArgs<ITestClassConstructionFinished> args
)
{
var message = args.Message;
var test = message.Test;
if (!IsStaticTestMethod(message))
{
var testResult = this.GetOrCreateTestData(test).TestResult;
AllureXunitHelper.StartAllureTestCase(test, testResult);
this.CaptureTestContext(test);
}
}
void OnTestFailed(MessageHandlerArgs<ITestFailed> args) =>
this.RunInTestContext(
args.Message.Test,
() => AllureXunitHelper.ApplyTestFailure(args.Message)
);
void OnTestPassed(MessageHandlerArgs<ITestPassed> args) =>
this.RunInTestContext(
args.Message.Test,
() => AllureXunitHelper.ApplyTestSuccess(args.Message)
);
void OnTestSkipped(MessageHandlerArgs<ITestSkipped> args)
{
var message = args.Message;
var test = message.Test;
var testData = this.GetOrCreateTestData(test);
if (testData.IsSelected)
{
this.UpdateTestContext(test, () =>
{
if (!AllureContext.HasTest)
{
AllureXunitHelper.StartAllureTestCase(
test,
testData.TestResult
);
}
AllureXunitHelper.ApplyTestSkip(message);
});
}
}
void OnTestFinished(MessageHandlerArgs<ITestFinished> args)
{
var message = args.Message;
var test = args.Message.Test;
var testData = this.GetOrCreateTestData(test);
if (testData.IsSelected)
{
this.RunInTestContext(test, () =>
{
this.AddAllureParameters(test, testData.Arguments);
AllureXunitHelper.ReportCurrentTestCase();
if (!IsStaticTestMethod(message))
{
AllureXunitHelper.ReportCurrentTestContainer();
}
});
}
this.allureTestData.TryRemove(test, out _);
}
AllureXunitTestData GetOrCreateTestData(ITest test)
{
if (!this.allureTestData.TryGetValue(test, out var data))
{
data = new AllureXunitTestData();
this.allureTestData[test] = data;
}
return data;
}
void AddAllureParameters(ITest test, object[]? arguments)
{
var testCase = test.TestCase;
var parameters = testCase.TestMethod.Method.GetParameters();
arguments ??= testCase.TestMethodArguments
?? Array.Empty<object>();
if (parameters.Any() && !arguments.Any())
{
if (string.IsNullOrEmpty(test.TestCase.SkipReason))
{
this.LogUnreportedTheoryArgs(test.DisplayName);
}
}
else
{
AllureXunitHelper.ApplyTestParameters(parameters, arguments);
}
}
void CaptureTestContext(ITest test) =>
this.GetOrCreateTestData(test).Context =
AllureContext;
AllureContext RunInTestContext(ITest test, Action action) =>
AllureLifecycle.Instance.RunInContext(
this.GetOrCreateTestData(test).Context,
action
);
void UpdateTestContext(ITest test, Action action) =>
this.GetOrCreateTestData(test).Context = this.RunInTestContext(
test,
action
);
void LogUnreportedTheoryArgs(string testName)
{
var message = $"Unable to attach arguments of {testName} to " +
"allure report";
#if !DEBUG
message += ". Try to compile the project in debug mode as a " +
"workaround";
#endif
this.Logger.LogWarning(message);
}
static bool IsStaticTestMethod(ITestMethodMessage message) =>
message.TestMethod.Method.IsStatic;
internal static AllureMessageSink? CurrentSink { get; private set; }
}
}