/
AssemblyScannerTests.cs
432 lines (358 loc) · 16.8 KB
/
AssemblyScannerTests.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
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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
#if NET452
namespace NServiceBus.Core.Tests.AssemblyScanner
{
using System;
using System.CodeDom.Compiler;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Text;
using System.Threading;
using Hosting.Helpers;
using Microsoft.CSharp;
using Mono.Cecil;
using NUnit.Framework;
[TestFixture]
public class AssemblyScannerTests
{
[SetUp]
public void SetUp()
{
if (!AppDomainRunner.IsInTestAppDomain)
{
AppDomainRunner.DataStore.Set("TestDirectory", TestContext.CurrentContext.TestDirectory);
if (Directory.Exists(DynamicAssembly.TestAssemblyDirectory))
{
Directory.Delete(DynamicAssembly.TestAssemblyDirectory, true);
}
Directory.CreateDirectory(DynamicAssembly.TestAssemblyDirectory);
}
}
[TearDown]
public void TearDown()
{
if (!AppDomainRunner.IsInTestAppDomain)
{
Directory.Delete(DynamicAssembly.TestAssemblyDirectory, true);
}
}
[Test, RunInApplicationDomain]
public void Assemblies_with_direct_reference_are_included()
{
var busAssembly = new DynamicAssembly("Fake.NServiceBus.Core.dll");
var assemblyWithReference = new DynamicAssembly("AssemblyWithReference.dll", new[]
{
busAssembly
});
var scanner = new AssemblyScanner(DynamicAssembly.TestAssemblyDirectory);
scanner.ScanAppDomainAssemblies = false;
scanner.CoreAssemblyName = busAssembly.DynamicName;
var result = scanner.GetScannableAssemblies();
Assert.IsTrue(result.Assemblies.Contains(assemblyWithReference));
Assert.IsTrue(result.Assemblies.Contains(busAssembly));
Assert.AreEqual(2, result.Assemblies.Count);
}
[Test, RunInApplicationDomain]
public void Assemblies_with_no_reference_are_excluded()
{
var busAssembly = new DynamicAssembly("Fake.NServiceBus.Core");
var assemblyWithReference = new DynamicAssembly("AssemblyWithReference", new[]
{
busAssembly
});
var assemblyWithoutReference = new DynamicAssembly("AssemblyWithoutReference");
var scanner = new AssemblyScanner(DynamicAssembly.TestAssemblyDirectory);
scanner.ScanAppDomainAssemblies = false;
scanner.CoreAssemblyName = busAssembly.DynamicName;
var result = scanner.GetScannableAssemblies();
Assert.IsTrue(result.Assemblies.Contains(assemblyWithReference));
Assert.IsTrue(result.Assemblies.Contains(busAssembly));
Assert.IsFalse(result.Assemblies.Contains(assemblyWithoutReference));
Assert.AreEqual(2, result.Assemblies.Count);
}
[Test, RunInApplicationDomain]
public void Assemblies_which_reference_older_nsb_version_are_included()
{
var busAssemblyV2 = new DynamicAssembly("Fake.NServiceBus.Core", version: new Version(2, 0, 0), fakeIdentity: true);
var assemblyReferencesV2 = new DynamicAssembly("AssemblyWithReference2", new[]
{
busAssemblyV2
});
var busAssemblyV1 = new DynamicAssembly("Fake.NServiceBus.Core", version: new Version(1, 0, 0), fakeIdentity: true);
var assemblyReferencesV1 = new DynamicAssembly("AssemblyWithReference1", new[]
{
busAssemblyV1
});
var scanner = new AssemblyScanner(DynamicAssembly.TestAssemblyDirectory);
scanner.ThrowExceptions = false;
scanner.ScanAppDomainAssemblies = false;
scanner.CoreAssemblyName = busAssemblyV2.Name;
var result = scanner.GetScannableAssemblies();
Assert.IsTrue(result.Assemblies.Contains(busAssemblyV2));
Assert.IsTrue(result.Assemblies.Contains(assemblyReferencesV1));
Assert.IsTrue(result.Assemblies.Contains(assemblyReferencesV2));
Assert.AreEqual(3, result.Assemblies.Count);
}
[Test, RunInApplicationDomain]
public void Assemblies_with_transitive_reference_are_include()
{
var busAssembly = new DynamicAssembly("Fake.NServiceBus.Core");
var assemblyC = new DynamicAssembly("C", new[]
{
busAssembly
});
var assemblyB = new DynamicAssembly("B", new[]
{
assemblyC
});
var assemblyA = new DynamicAssembly("A", new[]
{
assemblyB
});
var assemblyD = new DynamicAssembly("D", new[]
{
assemblyB
});
var scanner = new AssemblyScanner(DynamicAssembly.TestAssemblyDirectory);
scanner.ScanAppDomainAssemblies = false;
scanner.CoreAssemblyName = busAssembly.DynamicName;
var result = scanner.GetScannableAssemblies();
Assert.IsTrue(result.Assemblies.Contains(assemblyA));
Assert.IsTrue(result.Assemblies.Contains(assemblyB));
Assert.IsTrue(result.Assemblies.Contains(assemblyC));
Assert.IsTrue(result.Assemblies.Contains(assemblyD));
Assert.IsTrue(result.Assemblies.Contains(busAssembly));
Assert.AreEqual(5, result.Assemblies.Count);
}
[Test, RunInApplicationDomain]
public void AppDomainAssemblies_are_included_when_enabling_ScanAppDomainAssemblies()
{
var busAssembly = new DynamicAssembly("Fake.NServiceBus.Core");
Assembly.LoadFrom(busAssembly.FilePath);
var scanner = new AssemblyScanner(); // don't scan the dynamic assembly folder
scanner.CoreAssemblyName = busAssembly.DynamicName;
scanner.ScanAppDomainAssemblies = true;
var result = scanner.GetScannableAssemblies();
Assert.IsTrue(result.Assemblies.Contains(busAssembly));
}
[Test, RunInApplicationDomain]
public void Does_not_throw_exception_when_scanning_duplicate_assemblies()
{
var busAssembly = new DynamicAssembly("Fake.NServiceBus.Core");
Directory.CreateDirectory(Path.Combine(DynamicAssembly.TestAssemblyDirectory, "subdir"));
var destFileName = Path.Combine(DynamicAssembly.TestAssemblyDirectory, "subdir", busAssembly.FileName);
// create a duplicate of the scanned assembly in a subfolder:
File.Copy(busAssembly.FilePath, destFileName);
var scanner = new AssemblyScanner(DynamicAssembly.TestAssemblyDirectory);
scanner.ScanNestedDirectories = true;
scanner.CoreAssemblyName = busAssembly.DynamicName;
Assert.DoesNotThrow(() => scanner.GetScannableAssemblies());
}
[Test, RunInApplicationDomain]
public void Ignore_assembly_loading_errors_when_disabling_ThrowExceptions()
{
var busAssembly = new DynamicAssembly("Fake.NServiceBus.Core");
Directory.CreateDirectory(Path.Combine(DynamicAssembly.TestAssemblyDirectory, "subdir"));
var destFileName = Path.Combine(DynamicAssembly.TestAssemblyDirectory, "subdir", busAssembly.FileName);
File.Copy(busAssembly.FilePath, destFileName);
Assembly.LoadFrom(destFileName);
var scanner = new AssemblyScanner(DynamicAssembly.TestAssemblyDirectory);
scanner.ScanAppDomainAssemblies = true;
scanner.CoreAssemblyName = busAssembly.DynamicName;
scanner.ThrowExceptions = false;
var result = scanner.GetScannableAssemblies();
Assert.IsTrue(result.Assemblies.Contains(busAssembly));
}
[Test, RunInApplicationDomain]
public void Skipped_dlls_should_be_excluded()
{
var busAssembly = new DynamicAssembly("Fake.NServiceBus.Core");
var excludedAssembly1 = new DynamicAssembly("A", new[]
{
busAssembly
});
var excludedAssembly2 = new DynamicAssembly("A", new[]
{
busAssembly
});
var includedAssembly = new DynamicAssembly("B", new[]
{
busAssembly
});
var scanner = new AssemblyScanner(DynamicAssembly.TestAssemblyDirectory);
scanner.CoreAssemblyName = busAssembly.DynamicName;
scanner.AssembliesToSkip.Add(excludedAssembly1.DynamicName); // without file extension
scanner.AssembliesToSkip.Add(excludedAssembly2.FileName); // with file extension
var result = scanner.GetScannableAssemblies();
Assert.That(result.SkippedFiles.Any(s => s.FilePath == excludedAssembly1.FilePath));
Assert.That(result.SkippedFiles.Any(s => s.FilePath == excludedAssembly2.FilePath));
Assert.That(result.Assemblies.Contains(includedAssembly.Assembly));
}
[Test, RunInApplicationDomain]
public void Skipped_exes_should_be_excluded()
{
var busAssembly = new DynamicAssembly("Fake.NServiceBus.Core");
var excludedAssembly1 = new DynamicAssembly("A", new[]
{
busAssembly
}, executable: true);
var excludedAssembly2 = new DynamicAssembly("A", new[]
{
busAssembly
}, executable: true);
var includedAssembly = new DynamicAssembly("B", new[]
{
busAssembly
}, executable: true);
var scanner = new AssemblyScanner(DynamicAssembly.TestAssemblyDirectory);
scanner.CoreAssemblyName = busAssembly.DynamicName;
scanner.AssembliesToSkip.Add(excludedAssembly1.DynamicName); // without file extension
scanner.AssembliesToSkip.Add(excludedAssembly2.FileName); // with file extension
var result = scanner.GetScannableAssemblies();
Assert.That(result.SkippedFiles.Any(s => s.FilePath == excludedAssembly1.FilePath));
Assert.That(result.SkippedFiles.Any(s => s.FilePath == excludedAssembly2.FilePath));
Assert.That(result.Assemblies.Contains(includedAssembly.Assembly));
}
[Test, RunInApplicationDomain]
public void Should_not_include_child_type_if_only_handler_for_base_exists()
{
var messages =
@"
public interface IBaseEvent
{
}
public interface IInheritedEvent : IBaseEvent
{
}
";
var handler =
@"
using NServiceBus;
using System.Threading.Tasks;
class InterfaceMessageHandler : IHandleMessages<IBaseEvent>
{
public Task Handle(IBaseEvent message, IMessageHandlerContext context)
{
return Task.FromResult(0);
}
}
";
var messagesAsm = new DynamicAssembly("Fake.Messages", content: messages);
Assembly.LoadFrom(messagesAsm.FilePath);
var handlerAsm = new DynamicAssembly("Fake.Handler", new[]
{
messagesAsm
}, content: handler, referenceTheCore: true);
Assembly.LoadFrom(handlerAsm.FilePath);
var scanner = new AssemblyScanner(DynamicAssembly.TestAssemblyDirectory);
scanner.ScanAppDomainAssemblies = false;
var result = scanner.GetScannableAssemblies();
//Note this this is not the expected behavior. The assert will be changed to Assert.True and the test renamed as part of https://github.com/Particular/NServiceBus/issues/4634
Assert.False(result.Types.Any(t => t.Name == "IInheritedEvent"));
}
[DebuggerDisplay("Name = {Name}, DynamicName = {DynamicName}, Namespace = {Namespace}, FileName = {FileName}")]
class DynamicAssembly
{
public DynamicAssembly(string nameWithoutExtension, DynamicAssembly[] references = null, Version version = null, bool fakeIdentity = false, string content = null, bool referenceTheCore = false, bool executable = false)
{
if (version == null)
{
version = new Version(1, 0, 0, 0);
}
if (references == null)
{
references = new DynamicAssembly[0];
}
Name = nameWithoutExtension;
Namespace = nameWithoutExtension;
var fileExtension = executable ? "exe" : "dll";
FileName = $"{Namespace}{Path.GetFileNameWithoutExtension(Path.GetRandomFileName())}{Interlocked.Increment(ref dynamicAssemblyId)}.{fileExtension}";
DynamicName = Path.GetFileNameWithoutExtension(FileName);
var builder = new StringBuilder();
builder.AppendLine("using System.Reflection;");
builder.AppendLine($"[assembly: AssemblyVersion(\"{version}\")]");
builder.AppendLine($"[assembly: AssemblyFileVersion(\"{version}\")]");
builder.AppendFormat("namespace {0} {{ ", Namespace);
var provider = new CSharpCodeProvider();
var param = new CompilerParameters(new string[]
{
}, FileName);
param.GenerateExecutable = false;
param.GenerateInMemory = false;
param.OutputAssembly = FilePath = Path.Combine(TestAssemblyDirectory, FileName);
param.TempFiles = new TempFileCollection(TestAssemblyDirectory, false);
foreach (var reference in references)
{
builder.AppendLine($"using {reference.Namespace};");
param.ReferencedAssemblies.Add(reference.FilePath);
}
if (referenceTheCore)
{
var targetCorePath = Path.Combine(TestAssemblyDirectory, "NServiceBus.Core.dll");
File.Copy(Path.Combine(TestDirectory, "NServiceBus.Core.dll"), Path.Combine(TestAssemblyDirectory, "NServiceBus.Core.dll"));
param.ReferencedAssemblies.Add(targetCorePath);
}
if (executable)
{
param.GenerateExecutable = true;
builder.AppendLine("public static class Program { public static void Main(string[] args){} }");
}
if (content == null)
{
builder.AppendLine("public class Foo { public Foo() {");
foreach (var reference in references)
{
builder.AppendLine($"new {reference.Namespace}.Foo();");
}
builder.AppendLine("} }");
}
else
{
builder.AppendLine(content);
}
builder.AppendLine(" }");
var result = provider.CompileAssemblyFromSource(param, builder.ToString());
ThrowIfCompilationWasNotSuccessful(result);
provider.Dispose();
if (fakeIdentity)
{
using (var assemblyDefinition = AssemblyDefinition.ReadAssembly(FilePath, new ReaderParameters
{
ReadWrite = true
}))
{
assemblyDefinition.Name.Name = nameWithoutExtension;
assemblyDefinition.MainModule.Name = nameWithoutExtension;
assemblyDefinition.Write();
}
}
Assembly = result.CompiledAssembly;
}
public string Namespace { get; }
public string Name { get; }
public string DynamicName { get; }
public string FileName { get; }
public string FilePath { get; }
public Assembly Assembly { get; }
public static string TestDirectory { get; } = AppDomainRunner.DataStore.Get<string>("TestDirectory");
public static string TestAssemblyDirectory { get; } = Path.Combine(TestDirectory, "assemblyscannerfiles");
static void ThrowIfCompilationWasNotSuccessful(CompilerResults results)
{
if (results.Errors.HasErrors)
{
var errors = new StringBuilder($"Compiler Errors :{Environment.NewLine}");
foreach (CompilerError error in results.Errors)
{
errors.Append($"Line {error.Line},{error.Column}\t: {error.ErrorText}{Environment.NewLine}");
}
throw new Exception(errors.ToString());
}
}
public static implicit operator Assembly(DynamicAssembly dynamicAssembly) => dynamicAssembly.Assembly;
static long dynamicAssemblyId;
}
}
}
#endif