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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
|
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Mono.Cecil;
using Mono.Linker.Tests.Cases.Expectations.Assertions;
using Mono.Linker.Tests.Cases.Expectations.Metadata;
using Mono.Linker.Tests.Extensions;
using Mono.Linker.Tests.TestCases;
namespace Mono.Linker.Tests.TestCasesRunner {
public class TestCaseMetadaProvider {
protected readonly TestCase _testCase;
protected readonly AssemblyDefinition _fullTestCaseAssemblyDefinition;
protected readonly TypeDefinition _testCaseTypeDefinition;
public TestCaseMetadaProvider (TestCase testCase, AssemblyDefinition fullTestCaseAssemblyDefinition)
{
_testCase = testCase;
_fullTestCaseAssemblyDefinition = fullTestCaseAssemblyDefinition;
// The test case types are never nested so we don't need to worry about that
_testCaseTypeDefinition = fullTestCaseAssemblyDefinition.MainModule.GetType (_testCase.ReconstructedFullTypeName);
if (_testCaseTypeDefinition == null)
throw new InvalidOperationException ($"Could not find the type definition for {_testCase.Name} in {_testCase.SourceFile}");
}
public virtual TestCaseLinkerOptions GetLinkerOptions (NPath inputPath)
{
var tclo = new TestCaseLinkerOptions {
Il8n = GetOptionAttributeValue (nameof (Il8nAttribute), "none"),
IncludeBlacklistStep = GetOptionAttributeValue (nameof (IncludeBlacklistStepAttribute), false),
KeepTypeForwarderOnlyAssemblies = GetOptionAttributeValue (nameof (KeepTypeForwarderOnlyAssembliesAttribute), string.Empty),
KeepDebugMembers = GetOptionAttributeValue (nameof (SetupLinkerKeepDebugMembersAttribute), string.Empty),
LinkSymbols = GetOptionAttributeValue (nameof (SetupLinkerLinkSymbolsAttribute), string.Empty),
CoreAssembliesAction = GetOptionAttributeValue<string> (nameof (SetupLinkerCoreActionAttribute), null),
UserAssembliesAction = GetOptionAttributeValue<string> (nameof (SetupLinkerUserActionAttribute), null),
SkipUnresolved = GetOptionAttributeValue (nameof (SkipUnresolvedAttribute), false),
StripResources = GetOptionAttributeValue (nameof (StripResourcesAttribute), true),
};
foreach (var assemblyAction in _testCaseTypeDefinition.CustomAttributes.Where (attr => attr.AttributeType.Name == nameof (SetupLinkerActionAttribute)))
{
var ca = assemblyAction.ConstructorArguments;
tclo.AssembliesAction.Add (new KeyValuePair<string, string> ((string)ca [0].Value, (string)ca [1].Value));
}
foreach (var subsFile in _testCaseTypeDefinition.CustomAttributes.Where (attr => attr.AttributeType.Name == nameof (SetupLinkerSubstitutionFileAttribute))) {
var ca = subsFile.ConstructorArguments;
var file = (string)ca [0].Value;
tclo.Substitutions.Add (Path.Combine (inputPath, file));
}
foreach (var additionalArgumentAttr in _testCaseTypeDefinition.CustomAttributes.Where (attr => attr.AttributeType.Name == nameof (SetupLinkerArgumentAttribute)))
{
var ca = additionalArgumentAttr.ConstructorArguments;
var values = ((CustomAttributeArgument [])ca [1].Value)?.Select (arg => arg.Value.ToString ()).ToArray ();
// Since custom attribute arguments need to be constant expressions, we need to add
// the path to the temp directory (where the custom assembly is located) here.
if ((string)ca [0].Value == "--custom-step") {
int pos = values [0].IndexOf (",");
if (pos != -1) {
string custom_assembly_path = values [0].Substring (pos + 1);
if (!Path.IsPathRooted (custom_assembly_path))
values [0] = values [0].Substring (0, pos + 1) + Path.Combine (inputPath, custom_assembly_path);
}
}
tclo.AdditionalArguments.Add (new KeyValuePair<string, string []> ((string)ca [0].Value, values));
}
if (_testCaseTypeDefinition.CustomAttributes.Any (attr =>
attr.AttributeType.Name == nameof (LogContainsAttribute) || attr.AttributeType.Name == nameof (LogDoesNotContainAttribute))) {
tclo.AdditionalArguments.Add (new KeyValuePair<string, string []> ("--verbose", new string [] { }));
}
return tclo;
}
public virtual void CustomizeLinker (LinkerDriver linker, LinkerCustomizations customizations)
{
if (_testCaseTypeDefinition.CustomAttributes.Any (attr =>
attr.AttributeType.Name == nameof (DependencyRecordedAttribute))) {
customizations.DependencyRecorder = new TestDependencyRecorder ();
customizations.CustomizeContext += context => {
context.Tracer.AddRecorder (customizations.DependencyRecorder);
};
}
if (_testCaseTypeDefinition.CustomAttributes.Any (attr =>
attr.AttributeType.Name == nameof (VerifyAllReflectionAccessPatternsAreValidatedAttribute))
|| _testCaseTypeDefinition.AllMethods ().Any (method => method.CustomAttributes.Any (attr =>
attr.AttributeType.Name == nameof (RecognizedReflectionAccessPatternAttribute) ||
attr.AttributeType.Name == nameof (UnrecognizedReflectionAccessPatternAttribute)))) {
customizations.ReflectionPatternRecorder = new TestReflectionPatternRecorder ();
customizations.CustomizeContext += context => {
context.ReflectionPatternRecorder = customizations.ReflectionPatternRecorder;
};
} else if (_testCaseTypeDefinition.HasNestedTypes
&& _testCaseTypeDefinition.NestedTypes.Any (nestedType =>
nestedType.CustomAttributes.Any (attr =>
attr.AttributeType.Name == nameof (VerifyAllReflectionAccessPatternsAreValidatedAttribute)
|| nestedType.AllMethods ().Any (method => method.CustomAttributes.Any (attr =>
attr.AttributeType.Name == nameof (RecognizedReflectionAccessPatternAttribute) ||
attr.AttributeType.Name == nameof (UnrecognizedReflectionAccessPatternAttribute)))))) {
customizations.ReflectionPatternRecorder = new TestReflectionPatternRecorder ();
customizations.CustomizeContext += context => {
context.ReflectionPatternRecorder = customizations.ReflectionPatternRecorder;
};
}
}
#if NETCOREAPP
public static IEnumerable<string> GetTrustedPlatformAssemblies ()
{
if (AppContext.GetData ("TRUSTED_PLATFORM_ASSEMBLIES") is string tpaPaths) {
foreach (var path in tpaPaths.Split(Path.PathSeparator)) {
if (Path.GetExtension (path) == ".dll")
yield return path;
}
}
}
#endif
public virtual IEnumerable<string> GetCommonReferencedAssemblies (NPath workingDirectory)
{
yield return workingDirectory.Combine ("Mono.Linker.Tests.Cases.Expectations.dll").ToString ();
#if NETCOREAPP
foreach (var path in GetTrustedPlatformAssemblies ()) {
// Don't reference testcases dll, as these will be compiled dynamically.
if (Path.GetFileName (path) != "Mono.Linker.Tests.Cases.dll")
yield return path;
}
#else
yield return "mscorlib.dll";
#endif
}
public virtual IEnumerable<string> GetReferencedAssemblies (NPath workingDirectory)
{
foreach (var fileName in GetReferenceValues ()) {
if (fileName.StartsWith ("System.", StringComparison.Ordinal) || fileName.StartsWith ("Mono.", StringComparison.Ordinal) || fileName.StartsWith ("Microsoft.", StringComparison.Ordinal)) {
#if NETCOREAPP
// Try to find the assembly alongside the host's framework dependencies
var frameworkDir = Path.GetDirectoryName (typeof (object).Assembly.Location);
var filePath = Path.Combine (frameworkDir, fileName);
if (File.Exists (filePath)) {
yield return filePath;
} else {
yield return fileName;
}
#else
yield return fileName;
#endif
} else {
// Drop any relative path information. Sandboxing will have taken care of copying the reference to the directory
yield return workingDirectory.Combine (Path.GetFileName (fileName));
}
}
}
public virtual IEnumerable<string> GetReferenceDependencies ()
{
return _testCaseTypeDefinition.CustomAttributes
.Where (attr => attr.AttributeType.Name == nameof (ReferenceDependencyAttribute))
.Select (attr => (string) attr.ConstructorArguments [0].Value);
}
public virtual IEnumerable<string> GetReferenceValues ()
{
foreach (var referenceAttr in _testCaseTypeDefinition.CustomAttributes.Where (attr => attr.AttributeType.Name == nameof (ReferenceAttribute)))
yield return (string) referenceAttr.ConstructorArguments.First ().Value;
}
public virtual IEnumerable<SourceAndDestinationPair> GetResources ()
{
return _testCaseTypeDefinition.CustomAttributes
.Where (attr => attr.AttributeType.Name == nameof (SetupCompileResourceAttribute))
.Select (GetSourceAndRelativeDestinationValue);
}
public virtual IEnumerable<SourceAndDestinationPair> GetResponseFiles ()
{
return _testCaseTypeDefinition.CustomAttributes
.Where (attr => attr.AttributeType.Name == nameof (SetupLinkerResponseFileAttribute))
.Select (GetSourceAndRelativeDestinationValue);
}
public virtual IEnumerable<SourceAndDestinationPair> GetSubstitutionFiles ()
{
return _testCaseTypeDefinition.CustomAttributes
.Where (attr => attr.AttributeType.Name == nameof (SetupLinkerSubstitutionFileAttribute))
.Select (GetSourceAndRelativeDestinationValue);
}
public virtual IEnumerable<NPath> GetExtraLinkerSearchDirectories ()
{
#if NETCOREAPP
var tpaDirs = GetTrustedPlatformAssemblies ().Select (p => Path.GetDirectoryName (p)).Distinct ();
foreach (var dir in tpaDirs)
yield return dir.ToNPath ();
#else
yield break;
#endif
}
public virtual bool IsIgnored (out string reason)
{
var ignoreAttribute = _testCaseTypeDefinition.CustomAttributes.FirstOrDefault (attr => attr.AttributeType.Name == nameof (IgnoreTestCaseAttribute));
if (ignoreAttribute != null) {
reason = (string)ignoreAttribute.ConstructorArguments.First ().Value;
return true;
}
reason = null;
return false;
}
public virtual IEnumerable<SourceAndDestinationPair> AdditionalFilesToSandbox ()
{
return _testCaseTypeDefinition.CustomAttributes
.Where (attr => attr.AttributeType.Name == nameof (SandboxDependencyAttribute))
.Select (GetSourceAndRelativeDestinationValue);
}
public virtual IEnumerable<SetupCompileInfo> GetSetupCompileAssembliesBefore ()
{
return _testCaseTypeDefinition.CustomAttributes
.Where (attr => attr.AttributeType.Name == nameof (SetupCompileBeforeAttribute))
.Select (CreateSetupCompileAssemblyInfo);
}
public virtual IEnumerable<SetupCompileInfo> GetSetupCompileAssembliesAfter ()
{
return _testCaseTypeDefinition.CustomAttributes
.Where (attr => attr.AttributeType.Name == nameof (SetupCompileAfterAttribute))
.Select (CreateSetupCompileAssemblyInfo);
}
public virtual IEnumerable<string> GetDefines ()
{
// There are a few tests related to native pdbs where the assertions are different between windows and non-windows
// To enable test cases to define different expected behavior we set this special define
if (Environment.OSVersion.Platform == PlatformID.Win32NT)
yield return "WIN32";
#if NETCOREAPP
yield return "NETCOREAPP";
#endif
foreach (var attr in _testCaseTypeDefinition.CustomAttributes.Where (attr => attr.AttributeType.Name == nameof (DefineAttribute)))
yield return (string) attr.ConstructorArguments.First ().Value;
}
public virtual bool LinkPublicAndFamily()
{
return _testCaseTypeDefinition.CustomAttributes
.FirstOrDefault (attr => attr.AttributeType.Name == nameof (SetupLinkerLinkPublicAndFamilyAttribute)) != null;
}
public virtual string GetAssemblyName ()
{
var asLibraryAttribute = _testCaseTypeDefinition.CustomAttributes
.FirstOrDefault (attr => attr.AttributeType.Name == nameof (SetupCompileAsLibraryAttribute));
var defaultName = asLibraryAttribute == null ? "test.exe" : "test.dll";
return GetOptionAttributeValue (nameof (SetupCompileAssemblyNameAttribute), defaultName);
}
public virtual string GetCSharpCompilerToUse ()
{
return GetOptionAttributeValue (nameof (SetupCSharpCompilerToUseAttribute), string.Empty).ToLower ();
}
public virtual IEnumerable<string> GetSetupCompilerArguments ()
{
return _testCaseTypeDefinition.CustomAttributes
.Where (attr => attr.AttributeType.Name == nameof (SetupCompileArgumentAttribute))
.Select (attr => (string) attr.ConstructorArguments.First ().Value);
}
T GetOptionAttributeValue<T> (string attributeName, T defaultValue)
{
var attribute = _testCaseTypeDefinition.CustomAttributes.FirstOrDefault (attr => attr.AttributeType.Name == attributeName);
if (attribute != null)
return (T) attribute.ConstructorArguments.First ().Value;
return defaultValue;
}
SourceAndDestinationPair GetSourceAndRelativeDestinationValue (CustomAttribute attribute)
{
var fullSource = SourceFileForAttributeArgumentValue (attribute.ConstructorArguments.First ().Value);
var destinationFileName = (string) attribute.ConstructorArguments [1].Value;
return new SourceAndDestinationPair
{
Source = fullSource,
DestinationFileName = string.IsNullOrEmpty (destinationFileName) ? fullSource.FileName : destinationFileName
};
}
private SetupCompileInfo CreateSetupCompileAssemblyInfo (CustomAttribute attribute)
{
var ctorArguments = attribute.ConstructorArguments;
return new SetupCompileInfo
{
OutputName = (string) ctorArguments [0].Value,
SourceFiles = SourceFilesForAttributeArgument (ctorArguments [1]),
References = ((CustomAttributeArgument []) ctorArguments [2].Value)?.Select (arg => arg.Value.ToString ()).ToArray (),
Defines = ((CustomAttributeArgument []) ctorArguments [3].Value)?.Select (arg => arg.Value.ToString ()).ToArray (),
Resources = ((CustomAttributeArgument []) ctorArguments [4].Value)?.Select (arg => MakeSourceTreeFilePathAbsolute (arg.Value.ToString ())).ToArray (),
AdditionalArguments = (string) ctorArguments [5].Value,
CompilerToUse = (string) ctorArguments [6].Value,
AddAsReference = ctorArguments.Count >= 8 ? (bool) ctorArguments [7].Value : true
};
}
protected NPath MakeSourceTreeFilePathAbsolute (string value)
{
return _testCase.SourceFile.Parent.Combine (value);
}
protected NPath[] SourceFilesForAttributeArgument (CustomAttributeArgument attributeArgument)
{
return ((CustomAttributeArgument []) attributeArgument.Value)
.Select (attributeArg => SourceFileForAttributeArgumentValue (attributeArg.Value))
.Distinct ()
.ToArray ();
}
protected virtual NPath SourceFileForAttributeArgumentValue (object value)
{
if (value is TypeReference valueAsTypeRef) {
// Use the parent type for locating the source file
var parentType = ParentMostType (valueAsTypeRef);
var pathRelativeToAssembly = $"{parentType.FullName.Substring (parentType.Module.Name.Length - 3).Replace ('.', '/')}.cs".ToNPath ();
var pathElements = pathRelativeToAssembly.Elements.ToArray ();
var topMostDirectoryName = pathElements [0];
var topMostDirectory = _testCase.SourceFile.RecursiveParents.Reverse ().FirstOrDefault (d => !d.IsRoot && d.FileName == topMostDirectoryName);
if (topMostDirectory == null) {
// Before giving up, try and detect the naming scheme for tests that use a dot in the top level directory name.
// Ex:
// Attributes.Debugger
// + 1 because the file name is one of the elements
if (pathElements.Length >= 3) {
topMostDirectoryName = $"{pathElements[0]}.{pathElements[1]}";
topMostDirectory = _testCase.SourceFile.RecursiveParents.Reverse ().FirstOrDefault (d => !d.IsRoot && d.FileName == topMostDirectoryName);
pathRelativeToAssembly = topMostDirectoryName.ToNPath ().Combine (pathElements.Skip (2).Aggregate (new NPath (string.Empty), (path, s) => path.Combine (s)));
}
if (topMostDirectory == null)
throw new ArgumentException ($"Unable to locate the source file for type {valueAsTypeRef}. Could not locate directory {topMostDirectoryName}. Ensure the type name matches the file name. And the namespace match the directory structure on disk");
}
var fullPath = topMostDirectory.Parent.Combine (pathRelativeToAssembly);
if (!fullPath.Exists ())
throw new ArgumentException ($"Unable to locate the source file for type {valueAsTypeRef}. Expected {fullPath}. Ensure the type name matches the file name. And the namespace match the directory structure on disk");
return fullPath;
}
return MakeSourceTreeFilePathAbsolute (value.ToString ());
}
static TypeReference ParentMostType (TypeReference type)
{
if (!type.IsNested)
return type;
return ParentMostType (type.DeclaringType);
}
}
}
|