-
Notifications
You must be signed in to change notification settings - Fork 1k
/
GivenADependencyContextBuilder.cs
345 lines (302 loc) · 14.5 KB
/
GivenADependencyContextBuilder.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
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using FluentAssertions;
using FluentAssertions.Json;
using Microsoft.Build.Framework;
using Microsoft.Extensions.DependencyModel;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using NuGet.Frameworks;
using NuGet.Packaging.Core;
using NuGet.ProjectModel;
using NuGet.Versioning;
using NuGet.RuntimeModel;
using Xunit;
namespace Microsoft.NET.Build.Tasks.UnitTests
{
public class GivenADependencyContextBuilder
{
/// <summary>
/// Tests that DependencyContextBuilder generates DependencyContexts correctly.
/// </summary>
[Theory]
[MemberData(nameof(ProjectData))]
public void ItBuildsDependencyContextsFromProjectLockFiles(
string mainProjectName,
string mainProjectVersion,
CompilationOptions compilationOptions,
string baselineFileName,
string runtime,
ITaskItem[] assemblySatelliteAssemblies,
ITaskItem[] referencePaths,
ITaskItem[] referenceSatellitePaths,
object[] resolvedNuGetFiles)
{
LockFile lockFile = TestLockFiles.GetLockFile(mainProjectName);
LockFileLookup lockFileLookup = new LockFileLookup(lockFile);
SingleProjectInfo mainProject = SingleProjectInfo.Create(
"/usr/Path",
mainProjectName,
".dll",
mainProjectVersion,
assemblySatelliteAssemblies ?? new ITaskItem[] { });
IEnumerable<ReferenceInfo> directReferences =
ReferenceInfo.CreateDirectReferenceInfos(
referencePaths ?? new ITaskItem[] { },
referenceSatellitePaths ?? new ITaskItem[] { },
lockFileLookup: lockFileLookup,
i => true,
true);
ProjectContext projectContext = lockFile.CreateProjectContext(
FrameworkConstants.CommonFrameworks.NetCoreApp10.GetShortFolderName(),
runtime,
Constants.DefaultPlatformLibrary,
runtimeFrameworks: null,
isSelfContained: !string.IsNullOrEmpty(runtime));
if (resolvedNuGetFiles == null)
{
resolvedNuGetFiles = Array.Empty<ResolvedFile>();
}
DependencyContext dependencyContext = new DependencyContextBuilder(mainProject, includeRuntimeFileVersions: false, runtimeGraph: null, projectContext: projectContext, libraryLookup: lockFileLookup)
.WithDirectReferences(directReferences)
.WithCompilationOptions(compilationOptions)
.WithResolvedNuGetFiles((ResolvedFile[]) resolvedNuGetFiles)
.Build();
JObject result = Save(dependencyContext);
JObject baseline = ReadJson($"{baselineFileName}.deps.json");
try
{
baseline
.Should()
.BeEquivalentTo(result);
}
catch
{
// write the result file out on failure for easy comparison
using (JsonTextWriter writer = new JsonTextWriter(File.CreateText($"result-{baselineFileName}.deps.json")))
{
JsonSerializer serializer = new JsonSerializer();
serializer.Formatting = Formatting.Indented;
serializer.Serialize(writer, result);
}
throw;
}
}
public static IEnumerable<object[]> ProjectData
{
get
{
ITaskItem[] dotnetNewSatelliteAssemblies = new ITaskItem[]
{
new MockTaskItem(
@"de\dotnet.new.resources.dll",
new Dictionary<string, string>
{
{ "Culture", "de" },
{ "TargetPath", @"de\dotnet.new.resources.dll" },
}),
new MockTaskItem(
@"fr\dotnet.new.resources.dll",
new Dictionary<string, string>
{
{ "Culture", "fr" },
{ "TargetPath", @"fr\dotnet.new.resources.dll" },
}),
};
var resolvedNuGetFiles = new[]
{
new ResolvedFile("Newtonsoft.Json.dll", "",
new PackageIdentity("Newtonsoft.Json", new NuGetVersion("9.0.1")),
AssetType.Runtime,
"lib/netstandard1.0/Newtonsoft.Json.dll"),
new ResolvedFile("System.Collections.NonGeneric.dll", "",
new PackageIdentity("System.Collections.NonGeneric", new NuGetVersion("4.0.1")),
AssetType.Runtime,
"lib/netstandard1.3/System.Collections.NonGeneric.dll"),
new ResolvedFile("System.Runtime.Serialization.Primitives.dll", "",
new PackageIdentity("System.Runtime.Serialization.Primitives", new NuGetVersion("4.1.1")),
AssetType.Runtime,
"lib/netstandard1.3/System.Runtime.Serialization.Primitives.dll")
};
return new[]
{
new object[] { "dotnet.new", "1.0.0", null, "dotnet.new", null, null, null, null, null},
new object[] { "dotnet.new", "1.0.0", null, "dotnet.new.resources", null, dotnetNewSatelliteAssemblies, null, null, null },
new object[] { "simple.dependencies", "1.0.0", null, "simple.dependencies", null, null, null, null, resolvedNuGetFiles },
};
}
}
private static JObject ReadJson(string path)
{
using (JsonTextReader jsonReader = new JsonTextReader(File.OpenText(path)))
{
return JObject.Load(jsonReader);
}
}
private JObject Save(DependencyContext dependencyContext)
{
using (var memoryStream = new MemoryStream())
{
new DependencyContextWriter().Write(dependencyContext, memoryStream);
using (var readStream = new MemoryStream(memoryStream.ToArray()))
{
using (var textReader = new StreamReader(readStream))
{
using (var reader = new JsonTextReader(textReader))
{
return JObject.Load(reader);
}
}
}
}
}
[Fact]
public void ItDoesntCreateReferenceAssembliesWhenNoCompilationOptions()
{
DependencyContext dependencyContext = BuildDependencyContextWithReferenceAssemblies(useCompilationOptions: false);
dependencyContext.CompileLibraries.Should().BeEmpty();
dependencyContext
.RuntimeLibraries
.Should()
.NotContain(l => l.Type == "referenceassembly");
dependencyContext
.RuntimeLibraries
.SelectMany(l => l.Dependencies)
.Should()
.NotBeEmpty()
.And
.NotContain(d => d.Name == "System.NotConflicting")
.And
.NotContain(d => d.Name == "System.Collections.NonGeneric.Reference");
}
[Fact]
public void ItHandlesReferenceAndPackageReferenceNameCollisions()
{
DependencyContext dependencyContext = BuildDependencyContextWithReferenceAssemblies(useCompilationOptions: true);
dependencyContext.CompileLibraries.Should()
.Contain(c => c.Name == "System.NotConflicting" && c.Type == "referenceassembly");
// Note: System.Collections.NonGeneric is referenced in the lockfile, so DependencyContextBuilder
// appends ".Reference" to make it unique
dependencyContext.CompileLibraries.Should()
.Contain(c => c.Name == "System.Collections.NonGeneric.Reference" && c.Type == "referenceassembly");
dependencyContext.CompileLibraries.Should()
.Contain(c => c.Name == "System.Collections.NonGeneric.Reference.Reference" && c.Type == "referenceassembly");
}
private DependencyContext BuildDependencyContextWithReferenceAssemblies(bool useCompilationOptions)
{
string mainProjectName = "simple.dependencies";
LockFile lockFile = TestLockFiles.GetLockFile(mainProjectName);
SingleProjectInfo mainProject = SingleProjectInfo.Create(
"/usr/Path",
mainProjectName,
".dll",
"1.0.0",
new ITaskItem[] { });
ITaskItem[] referencePaths = new ITaskItem[]
{
new MockTaskItem(
"/usr/Path/System.NotConflicting.dll",
new Dictionary<string, string>
{
{ "CopyLocal", "false" },
{ "FusionName", "System.NotConflicting, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null" },
{ "Version", "" },
}),
new MockTaskItem(
"/usr/Path/System.Collections.NonGeneric.dll",
new Dictionary<string, string>
{
{ "CopyLocal", "false" },
{ "FusionName", "System.Collections.NonGeneric, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null" },
{ "Version", "" },
}),
new MockTaskItem(
"/usr/Path/System.Collections.NonGeneric.Reference.dll",
new Dictionary<string, string>
{
{ "CopyLocal", "false" },
{ "FusionName", "System.Collections.NonGeneric.Reference, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null" },
{ "Version", "" },
}),
};
ProjectContext projectContext = lockFile.CreateProjectContext(
FrameworkConstants.CommonFrameworks.NetCoreApp10.GetShortFolderName(),
runtime: null,
platformLibraryName: Constants.DefaultPlatformLibrary,
runtimeFrameworks: null,
isSelfContained: false);
CompilationOptions compilationOptions =
useCompilationOptions ? CreateCompilationOptions() :
null;
DependencyContext dependencyContext = new DependencyContextBuilder(mainProject, includeRuntimeFileVersions: false, runtimeGraph: null, projectContext: projectContext, libraryLookup: new LockFileLookup(lockFile))
.WithReferenceAssemblies(ReferenceInfo.CreateReferenceInfos(referencePaths))
.WithCompilationOptions(compilationOptions)
.Build();
// ensure the DependencyContext can be written out successfully - it has no duplicate dependency names
Save(dependencyContext);
return dependencyContext;
}
private static CompilationOptions CreateCompilationOptions()
{
return new CompilationOptions(
defines: new[] { "DEBUG", "TRACE" },
languageVersion: "6",
platform: "x64",
allowUnsafe: true,
warningsAsErrors: false,
optimize: null,
keyFile: "../keyfile.snk",
delaySign: null,
publicSign: null,
debugType: "portable",
emitEntryPoint: true,
generateXmlDocumentation: true);
}
[Fact]
public void ItCanGenerateTheRuntimeFallbackGraph()
{
string mainProjectName = "simple.dependencies";
LockFile lockFile = TestLockFiles.GetLockFile(mainProjectName);
SingleProjectInfo mainProject = SingleProjectInfo.Create(
"/usr/Path",
mainProjectName,
".dll",
"1.0.0",
new ITaskItem[] { });
ProjectContext projectContext = lockFile.CreateProjectContext(
FrameworkConstants.CommonFrameworks.NetCoreApp10.GetShortFolderName(),
runtime: null,
platformLibraryName: Constants.DefaultPlatformLibrary,
runtimeFrameworks: null,
isSelfContained: true);
var runtimeGraph = new RuntimeGraph(
new RuntimeDescription []
{
new RuntimeDescription("os-arch", new string [] { "os", "base" }),
new RuntimeDescription("new_os-arch", new string [] { "os-arch", "os", "base" }),
new RuntimeDescription("os-new_arch", new string [] { "os-arch", "os", "base" }),
new RuntimeDescription("new_os-new_arch", new string [] { "new_os-arch", "os-new_arch", "os-arch", "os", "base" }),
new RuntimeDescription("os-another_arch", new string [] { "os", "base" })
});
void CheckRuntimeFallbacks(string runtimeIdentifier, int fallbackCount)
{
projectContext.LockFileTarget.RuntimeIdentifier = runtimeIdentifier;
var dependencyContextBuilder = new DependencyContextBuilder(mainProject, includeRuntimeFileVersions: false, runtimeGraph, projectContext, libraryLookup: new LockFileLookup(lockFile));
var runtimeFallbacks = dependencyContextBuilder.Build().RuntimeGraph;
runtimeFallbacks
.Count()
.Should()
.Be(fallbackCount);
runtimeFallbacks
.Any(runtimeFallback => !runtimeFallback.Runtime.Equals(runtimeIdentifier) && !runtimeFallback.Fallbacks.Contains(runtimeIdentifier))
.Should()
.BeFalse();
}
CheckRuntimeFallbacks("os-arch", 4);
CheckRuntimeFallbacks("new_os-arch", 2);
CheckRuntimeFallbacks("os-new_arch", 2);
CheckRuntimeFallbacks("new_os-new_arch", 1);
CheckRuntimeFallbacks("unrelated_os-unknown_arch", 0);
}
}
}