-
Notifications
You must be signed in to change notification settings - Fork 315
/
AssemblyResolver.cs
281 lines (233 loc) · 11.1 KB
/
AssemblyResolver.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
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Reflection;
using Microsoft.VisualStudio.TestPlatform.ObjectModel;
using Microsoft.VisualStudio.TestPlatform.PlatformAbstractions;
using Microsoft.VisualStudio.TestPlatform.PlatformAbstractions.Interfaces;
namespace Microsoft.VisualStudio.TestPlatform.Common.Utilities;
internal class AssemblyResolver : IDisposable
{
/// <summary>
/// The directories to look for assemblies to resolve.
/// </summary>
private readonly HashSet<string> _searchDirectories;
/// <summary>
/// Dictionary of Assemblies discovered to date. Must be locked as it may
/// be accessed in a multi-threaded context.
/// </summary>
private readonly Dictionary<string, Assembly?> _resolvedAssemblies = new();
/// <summary>
/// Specifies whether the resolver is disposed or not
/// </summary>
private bool _isDisposed;
private Stack<string>? _currentlyResolvingResources;
/// <summary>
/// Assembly resolver for platform
/// </summary>
private readonly IAssemblyResolver _platformAssemblyResolver;
private readonly IAssemblyLoadContext _platformAssemblyLoadContext;
private static readonly string[] SupportedFileExtensions = { ".dll", ".exe" };
/// <summary>
/// Initializes a new instance of the <see cref="AssemblyResolver"/> class.
/// </summary>
/// <param name="directories"> The search directories. </param>
[System.Security.SecurityCritical]
public AssemblyResolver(IEnumerable<string> directories)
{
EqtTrace.Info($"AssemblyResolver.ctor: Creating AssemblyResolver with searchDirectories {string.Join(",", directories)}");
_searchDirectories = directories == null || !directories.Any() ? new HashSet<string>() : new HashSet<string>(directories);
_platformAssemblyResolver = new PlatformAssemblyResolver();
_platformAssemblyLoadContext = new PlatformAssemblyLoadContext();
_platformAssemblyResolver.AssemblyResolve += OnResolve;
}
/// <summary>
/// Set the directories from which assemblies should be searched
/// </summary>
/// <param name="directories"> The search directories. </param>
[System.Security.SecurityCritical]
internal void AddSearchDirectories(IEnumerable<string> directories)
{
EqtTrace.Info($"AssemblyResolver.AddSearchDirectories: Adding more searchDirectories {string.Join(",", directories)}");
foreach (var directory in directories)
{
_searchDirectories.Add(directory);
}
}
/// <summary>
/// Assembly Resolve event handler for App Domain - called when CLR loader cannot resolve assembly.
/// </summary>
/// <returns>
/// The <see cref="Assembly"/>.
/// </returns>
private Assembly? OnResolve(object? sender, AssemblyResolveEventArgs? args)
{
if (StringUtils.IsNullOrEmpty(args?.Name))
{
Debug.Fail("AssemblyResolver.OnResolve: args.Name is null or empty.");
return null;
}
if (_searchDirectories == null || _searchDirectories.Count == 0)
{
EqtTrace.Info("AssemblyResolver.OnResolve: {0}: There are no search directories, returning.", args.Name);
return null;
}
EqtTrace.Info("AssemblyResolver.OnResolve: {0}: Resolving assembly.", args.Name);
// args.Name is like: "Microsoft.VisualStudio.TestTools.Common, Version=[VersionMajor].0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a".
lock (_resolvedAssemblies)
{
if (_resolvedAssemblies.TryGetValue(args.Name, out var assembly))
{
EqtTrace.Info("AssemblyResolver.OnResolve: {0}: Resolved from cache.", args.Name);
return assembly;
}
AssemblyName? requestedName = null;
try
{
// Can throw ArgumentException, FileLoadException if arg is empty/wrong format, etc. Should not return null.
requestedName = new AssemblyName(args.Name);
}
catch (Exception ex)
{
EqtTrace.Info("AssemblyResolver.OnResolve: {0}: Failed to create assemblyName. Reason:{1} ", args.Name, ex);
_resolvedAssemblies[args.Name] = null;
return null;
}
TPDebug.Assert(requestedName != null && !requestedName.Name.IsNullOrEmpty(), "AssemblyResolver.OnResolve: requested is null or name is empty!");
var isResource = requestedName.Name.EndsWith(".resources");
foreach (var dir in _searchDirectories)
{
if (dir.IsNullOrEmpty())
{
continue;
}
EqtTrace.Info("AssemblyResolver.OnResolve: {0}: Searching in: '{1}'.", args.Name, dir);
foreach (var extension in SupportedFileExtensions)
{
var assemblyPath = Path.Combine(dir, requestedName.Name + extension);
try
{
bool pushed = false;
try
{
if (isResource)
{
// Check for recursive resource lookup.
// This can happen when we are on non-english locale, and we try to load mscorlib.resources
// (or potentially some other resources). This will trigger a new Resolve and call the method
// we are currently in. If then some code in this Resolve method (like File.Exists) will again
// try to access mscorlib.resources it will end up recursing forever.
if (_currentlyResolvingResources != null && _currentlyResolvingResources.Count > 0 && _currentlyResolvingResources.Contains(assemblyPath))
{
EqtTrace.Info("AssemblyResolver.OnResolve: {0}: Assembly is searching for itself recursively: '{1}', returning as not found.", args.Name, assemblyPath);
_resolvedAssemblies[args.Name] = null;
return null;
}
_currentlyResolvingResources ??= new Stack<string>(4);
_currentlyResolvingResources.Push(assemblyPath);
pushed = true;
}
if (!File.Exists(assemblyPath))
{
EqtTrace.Info("AssemblyResolver.OnResolve: {0}: Assembly path does not exist: '{1}', returning.", args.Name, assemblyPath);
continue;
}
AssemblyName foundName = _platformAssemblyLoadContext.GetAssemblyNameFromPath(assemblyPath);
if (!RequestedAssemblyNameMatchesFound(requestedName, foundName))
{
EqtTrace.Info("AssemblyResolver.OnResolve: {0}: File exists but version/public key is wrong. Try next extension.", args.Name);
continue; // File exists but version/public key is wrong. Try next extension.
}
EqtTrace.Info("AssemblyResolver.OnResolve: {0}: Loading assembly '{1}'.", args.Name, assemblyPath);
assembly = _platformAssemblyLoadContext.LoadAssemblyFromPath(assemblyPath);
_resolvedAssemblies[args.Name] = assembly;
EqtTrace.Info("AssemblyResolver.OnResolve: Resolved assembly: {0}, from path: {1}", args.Name, assemblyPath);
return assembly;
}
finally
{
if (isResource && pushed)
{
_currentlyResolvingResources?.Pop();
}
}
}
catch (FileLoadException ex)
{
EqtTrace.Error("AssemblyResolver.OnResolve: {0}: Failed to load assembly. Reason:{1} ", args.Name, ex);
// Re-throw FileLoadException, because this exception means that the assembly
// was found, but could not be loaded. This will allow us to report a more
// specific error message to the user for things like access denied.
throw;
}
catch (Exception ex)
{
// For all other exceptions, try the next extension.
EqtTrace.Info("AssemblyResolver.OnResolve: {0}: Failed to load assembly. Reason:{1} ", args.Name, ex);
}
}
}
EqtTrace.Info("AssemblyResolver.OnResolve: {0}: Failed to load assembly.", args.Name);
_resolvedAssemblies[args.Name] = null;
return null;
}
}
/// <summary>
/// Verifies that found assembly name matches requested to avoid security issues.
/// Looks only at PublicKeyToken and Version, empty matches anything.
/// VSWhidbey 415774.
/// </summary>
/// <returns>
/// The <see cref="bool"/>.
/// </returns>
private static bool RequestedAssemblyNameMatchesFound(AssemblyName requestedName, AssemblyName foundName)
{
TPDebug.Assert(requestedName != null);
TPDebug.Assert(foundName != null);
var requestedPublicKey = requestedName.GetPublicKeyToken();
if (requestedPublicKey != null)
{
var foundPublicKey = foundName.GetPublicKeyToken();
if (foundPublicKey == null)
{
return false;
}
for (var index = 0; index < requestedPublicKey.Length; ++index)
{
if (requestedPublicKey[index] != foundPublicKey[index])
{
return false;
}
}
}
return requestedName.Version == null || requestedName.Version.Equals(foundName.Version);
}
~AssemblyResolver()
{
Dispose(false);
}
public void Dispose()
{
Dispose(true);
// Use SupressFinalize in case a subclass
// of this type implements a finalizer.
GC.SuppressFinalize(this);
}
[System.Security.SecurityCritical]
protected virtual void Dispose(bool disposing)
{
if (!_isDisposed)
{
if (disposing)
{
_platformAssemblyResolver.AssemblyResolve -= OnResolve;
_platformAssemblyResolver.Dispose();
}
_isDisposed = true;
}
}
}