-
Notifications
You must be signed in to change notification settings - Fork 1k
/
GivenAResolvePackageAssetsTask.cs
220 lines (186 loc) · 7.69 KB
/
GivenAResolvePackageAssetsTask.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
// 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 Microsoft.Build.Framework;
using System.Reflection;
using Xunit;
using static Microsoft.NET.Build.Tasks.ResolvePackageAssets;
namespace Microsoft.NET.Build.Tasks.UnitTests
{
public class GivenAResolvePackageAssetsTask
{
[Fact]
public void ItHashesAllParameters()
{
IEnumerable<PropertyInfo> inputProperties;
var task = InitializeTask(out inputProperties);
byte[] oldHash;
try
{
oldHash = task.HashSettings();
}
catch (ArgumentNullException)
{
Assert.True(
false,
"HashSettings is likely not correctly handling null value of one or more optional task parameters");
throw; // unreachable
}
foreach (var property in inputProperties)
{
switch (property.PropertyType)
{
case var t when t == typeof(bool):
property.SetValue(task, true);
break;
case var t when t == typeof(string):
property.SetValue(task, property.Name);
break;
case var t when t == typeof(ITaskItem[]):
property.SetValue(task, new[] { new MockTaskItem() { ItemSpec = property.Name } });
break;
default:
Assert.True(false, $"{property.Name} is not a bool or string or ITaskItem[]. Update the test code to handle that.");
throw null; // unreachable
}
byte[] newHash = task.HashSettings();
newHash.Should().NotBeEquivalentTo(
oldHash,
because: $"{property.Name} should be included in hash.");
oldHash = newHash;
}
}
[Fact]
public void ItDoesNotHashDesignTimeBuild()
{
var task = InitializeTask(out _);
task.DesignTimeBuild = false;
byte[] oldHash = task.HashSettings();
task.DesignTimeBuild = true;
byte[] newHash = task.HashSettings();
newHash.Should().BeEquivalentTo(oldHash,
because: $"{nameof(task.DesignTimeBuild)} should not be included in hash.");
}
[Fact]
public void It_does_not_error_on_duplicate_package_names()
{
string projectAssetsJsonPath = Path.GetTempFileName();
var assetsContent = @"{
`version`: 3,
`targets`: {
`net5.0`: {
`Humanizer.Core/2.8.25`: {
`type`: `package`
},
`Humanizer.Core/2.8.26`: {
`type`: `package`
}
}
},
`project`: {
`version`: `1.0.0`,
`frameworks`: {
`net5.0`: {
`targetAlias`: `net5.0`
}
}
}
}".Replace('`', '"');
File.WriteAllText(projectAssetsJsonPath, assetsContent);
var task = InitializeTask(out _);
task.ProjectAssetsFile = projectAssetsJsonPath;
task.TargetFramework = "net5.0";
new CacheWriter(task); // Should not error
}
private static string AssetsFileWithInvalidLocale(string tfm, string locale) => @"
{
`version`: 3,
`targets`: {
`{tfm}`: {
`JavaScriptEngineSwitcher.Core/3.3.0`: {
`type`: `package`,
`compile`: {
`lib/netstandard2.0/JavaScriptEngineSwitcher.Core.dll`: {}
},
`runtime`: {
`lib/netstandard2.0/JavaScriptEngineSwitcher.Core.dll`: {}
},
`resource`: {
`lib/netstandard2.0/ru-ru/JavaScriptEngineSwitcher.Core.resources.dll`: {
`locale`: `{locale}`
}
}
}
}
},
`project`: {
`version`: `1.0.0`,
`frameworks`: {
`{tfm}`: {
`targetAlias`: `{tfm}`
}
}
}
}".Replace("`", "\"").Replace("{tfm}", tfm).Replace("{locale}", locale);
[InlineData("net7.0", true)]
[InlineData("net6.0", false)]
[Theory]
public void It_warns_on_invalid_culture_codes_of_resources(string tfm, bool shouldHaveWarnings)
{
string projectAssetsJsonPath = Path.GetTempFileName();
var assetsContent = AssetsFileWithInvalidLocale(tfm, "what is this even");
File.WriteAllText(projectAssetsJsonPath, assetsContent);
var task = InitializeTask(out _);
task.ProjectAssetsFile = projectAssetsJsonPath;
task.TargetFramework = tfm;
var writer = new CacheWriter(task, new MockPackageResolver());
writer.WriteToMemoryStream();
var engine = task.BuildEngine as MockBuildEngine;
var invalidContextWarnings = engine.Warnings.Where(msg => msg.Code == "NETSDK1188");
invalidContextWarnings.Should().HaveCount(shouldHaveWarnings ? 1 : 0);
var invalidContextMessages = engine.Messages.Where(msg => msg.Code == "NETSDK1188" && msg.Importance == MessageImportance.Low);
invalidContextMessages.Should().HaveCount(shouldHaveWarnings ? 0 : 1);
}
[InlineData("net7.0", true)]
[InlineData("net6.0", false)]
[Theory]
public void It_warns_on_incorrectly_cased_culture_codes_of_resources(string tfm, bool shouldHaveWarnings)
{
string projectAssetsJsonPath = Path.GetTempFileName();
var assetsContent = AssetsFileWithInvalidLocale(tfm, "ru-ru");
File.WriteAllText(projectAssetsJsonPath, assetsContent);
var task = InitializeTask(out _);
task.ProjectAssetsFile = projectAssetsJsonPath;
task.TargetFramework = tfm;
var writer = new CacheWriter(task, new MockPackageResolver());
writer.WriteToMemoryStream();
var engine = task.BuildEngine as MockBuildEngine;
var invalidContextWarnings = engine.Warnings.Where(msg => msg.Code == "NETSDK1187");
invalidContextWarnings.Should().HaveCount(shouldHaveWarnings ? 1 : 0);
var invalidContextMessages = engine.Messages.Where(msg => msg.Code == "NETSDK1187" && msg.Importance == MessageImportance.Low);
invalidContextMessages.Should().HaveCount(shouldHaveWarnings ? 0 : 1);
}
private ResolvePackageAssets InitializeTask(out IEnumerable<PropertyInfo> inputProperties)
{
inputProperties = typeof(ResolvePackageAssets)
.GetProperties(BindingFlags.DeclaredOnly | BindingFlags.Instance | BindingFlags.Public)
.Where(p => !p.IsDefined(typeof(OutputAttribute)) &&
p.Name != nameof(ResolvePackageAssets.DesignTimeBuild))
.OrderBy(p => p.Name, StringComparer.Ordinal);
var requiredProperties = inputProperties
.Where(p => p.IsDefined(typeof(RequiredAttribute)));
var task = new ResolvePackageAssets();
// Initialize all required properties as a genuine task invocation would. We do this
// because HashSettings need not defend against required parameters being null.
foreach (var property in requiredProperties)
{
property.PropertyType.Should().Be(
typeof(string),
because: $"this test hasn't been updated to handle non-string required task parameters like {property.Name}");
property.SetValue(task, "_");
}
task.BuildEngine = new MockBuildEngine();
return task;
}
}
}