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
|
// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
namespace WixToolsetTest.Sdk
{
using System;
using System.IO;
using System.Linq;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using WixInternal.MSTestSupport;
using WixInternal.Core.MSTestPackage;
using WixToolset.Data;
using WixToolset.Data.Symbols;
[TestClass]
public class MsbuildHeatFixture
{
public static readonly string HeatTargetsPath = Path.Combine(Path.GetDirectoryName(new Uri(typeof(MsbuildHeatFixture).Assembly.CodeBase).LocalPath), "..", "..", "..", "publish", "WixToolset.Heat", "build", "WixToolset.Heat.targets");
public MsbuildHeatFixture()
{
EnsureWixSdkCached();
}
[TestMethod]
[DataRow(BuildSystem.DotNetCoreSdk)]
[DataRow(BuildSystem.MSBuild)]
[DataRow(BuildSystem.MSBuild64)]
public void CanBuildHeatFilePackage(BuildSystem buildSystem)
{
var sourceFolder = TestData.Get("TestData", "HeatFilePackage");
using (var fs = new DisposableFileSystem())
{
var baseFolder = fs.GetFolder();
var binFolder = Path.Combine(baseFolder, @"bin");
var intermediateFolder = Path.Combine(baseFolder, @"obj\");
var projectPath = Path.Combine(sourceFolder, "HeatFilePackage.wixproj");
var result = MsbuildUtilities.BuildProject(buildSystem, projectPath, new[] {
"-Restore",
MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "HeatTargetsPath", MsbuildHeatFixture.HeatTargetsPath),
MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "BaseIntermediateOutputPath", intermediateFolder),
MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "OutputPath", binFolder),
});
result.AssertSuccess();
var heatCommandLines = MsbuildUtilities.GetToolCommandLines(result, "heat", "file", buildSystem);
WixAssert.Single(heatCommandLines);
var warnings = result.Output.Where(line => line.Contains(": warning")).ToArray();
WixAssert.All(warnings, warning => warning.Contains("warning HEAT5149"));
var generatedFilePath = Path.Combine(intermediateFolder, "Release", "_ProductComponents_INSTALLFOLDER_HeatFilePackage.wixproj_file.wxs");
var generatedContents = File.ReadAllText(generatedFilePath);
var testXml = generatedContents.GetTestXml();
WixAssert.StringEqual(@"<Wix>" +
"<Fragment>" +
"<DirectoryRef Id='INSTALLFOLDER'>" +
"<Component Id='HeatFilePackage.wixproj' Guid='*'>" +
"<File Id='HeatFilePackage.wixproj' KeyPath='yes' Source='SourceDir\\HeatFilePackage.wixproj' />" +
"</Component>" +
"</DirectoryRef>" +
"</Fragment>" +
"<Fragment>" +
"<ComponentGroup Id='ProductComponents'>" +
"<ComponentRef Id='HeatFilePackage.wixproj' />" +
"</ComponentGroup>" +
"</Fragment>" +
"</Wix>", testXml);
var pdbPath = Path.Combine(binFolder, "HeatFilePackage.wixpdb");
var intermediate = Intermediate.Load(pdbPath);
var section = intermediate.Sections.Single();
var fileSymbol = section.Symbols.OfType<FileSymbol>().Single();
WixAssert.StringEqual(@"SourceDir\HeatFilePackage.wixproj", fileSymbol[FileSymbolFields.Source].PreviousValue.AsPath()?.Path);
}
}
[TestMethod]
[DataRow(BuildSystem.DotNetCoreSdk)]
[DataRow(BuildSystem.MSBuild)]
[DataRow(BuildSystem.MSBuild64)]
public void CanBuildHeatFileWithMultipleFilesPackage(BuildSystem buildSystem)
{
var sourceFolder = TestData.Get(@"TestData", "HeatFileMultipleFilesSameFileName");
using (var fs = new DisposableFileSystem())
{
var baseFolder = fs.GetFolder();
var binFolder = Path.Combine(baseFolder, @"bin\");
var intermediateFolder = Path.Combine(baseFolder, @"obj\");
var projectPath = Path.Combine(sourceFolder, "HeatFileMultipleFilesSameFileName.wixproj");
var result = MsbuildUtilities.BuildProject(buildSystem, projectPath, new[] {
"-Restore",
MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "HeatTargetsPath", MsbuildHeatFixture.HeatTargetsPath),
MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "BaseIntermediateOutputPath", intermediateFolder),
MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "OutputPath", binFolder),
});
result.AssertSuccess();
var heatCommandLines = MsbuildUtilities.GetToolCommandLines(result, "heat", "file", buildSystem);
Assert.AreEqual(2, heatCommandLines.Count());
var warnings = result.Output.Where(line => line.Contains(": warning")).ToArray();
WixAssert.All(warnings, warning => warning.Contains("warning HEAT5149"));
var generatedFilePath = Path.Combine(intermediateFolder, "Release", "_TxtProductComponents_INSTALLFOLDER_MyProgram.txt_file.wxs");
Assert.IsTrue(File.Exists(generatedFilePath));
var generatedContents = File.ReadAllText(generatedFilePath);
var testXml = generatedContents.GetTestXml();
WixAssert.StringEqual("<Wix>" +
"<Fragment>" +
"<DirectoryRef Id='INSTALLFOLDER'>" +
"<Component Id='MyProgram.txt' Guid='*'>" +
@"<File Id='MyProgram.txt' KeyPath='yes' Source='SourceDir\MyProgram.txt' />" +
"</Component>" +
"</DirectoryRef>" +
"</Fragment>" +
"<Fragment>" +
"<ComponentGroup Id='TxtProductComponents'>" +
"<ComponentRef Id='MyProgram.txt' />" +
"</ComponentGroup>" +
"</Fragment>" +
"</Wix>", testXml);
generatedFilePath = Path.Combine(intermediateFolder, "Release", "_JsonProductComponents_INSTALLFOLDER_MyProgram.json_file.wxs");
Assert.IsTrue(File.Exists(generatedFilePath));
generatedContents = File.ReadAllText(generatedFilePath);
testXml = generatedContents.GetTestXml();
WixAssert.StringEqual("<Wix>" +
"<Fragment>" +
"<DirectoryRef Id='INSTALLFOLDER'>" +
"<Component Id='MyProgram.json' Guid='*'>" +
@"<File Id='MyProgram.json' KeyPath='yes' Source='SourceDir\MyProgram.json' />" +
"</Component>" +
"</DirectoryRef>" +
"</Fragment>" +
"<Fragment>" +
"<ComponentGroup Id='JsonProductComponents'>" +
"<ComponentRef Id='MyProgram.json' />" +
"</ComponentGroup>" +
"</Fragment>" +
"</Wix>", testXml);
var pdbPath = Path.Combine(binFolder, "HeatFileMultipleFilesSameFileName.wixpdb");
Assert.IsTrue(File.Exists(pdbPath));
var intermediate = Intermediate.Load(pdbPath);
var section = intermediate.Sections.Single();
var fileSymbols = section.Symbols.OfType<FileSymbol>().ToArray();
WixAssert.StringEqual(@"SourceDir\MyProgram.txt", fileSymbols[0][FileSymbolFields.Source].PreviousValue.AsPath()?.Path);
WixAssert.StringEqual(@"SourceDir\MyProgram.json", fileSymbols[1][FileSymbolFields.Source].PreviousValue.AsPath()?.Path);
}
}
[TestMethod]
[DataRow(BuildSystem.DotNetCoreSdk, true)]
[DataRow(BuildSystem.DotNetCoreSdk, false)]
[DataRow(BuildSystem.MSBuild, true)]
[DataRow(BuildSystem.MSBuild, false)]
[DataRow(BuildSystem.MSBuild64, true)]
[DataRow(BuildSystem.MSBuild64, false)]
public void CanBuildHeatProjectPreSdkStyle(BuildSystem buildSystem, bool useToolsVersion)
{
var sourceFolder = TestData.Get(@"TestData", "HeatProject");
using (var fs = new TestDataFolderFileSystem())
{
fs.Initialize(sourceFolder);
File.Copy("global.json", Path.Combine(fs.BaseFolder, "global.json"));
var baseFolder = Path.Combine(fs.BaseFolder, "HeatProjectPreSdkStyle");
var binFolder = Path.Combine(baseFolder, @"bin\");
var intermediateFolder = Path.Combine(baseFolder, @"obj\");
var projectPath = Path.Combine(baseFolder, "HeatProjectPreSdkStyle.wixproj");
var result = MsbuildUtilities.BuildProject(buildSystem, projectPath, new[]
{
MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "HeatTargetsPath", MsbuildHeatFixture.HeatTargetsPath),
useToolsVersion ? $"-p:HarvestProjectsUseToolsVersion=true" : String.Empty,
});
result.AssertSuccess();
var heatCommandLines = MsbuildUtilities.GetToolCommandLines(result, "heat", "project", buildSystem);
var heatCommandLine = WixAssert.Single(heatCommandLines);
if (useToolsVersion && buildSystem != BuildSystem.DotNetCoreSdk)
{
Assert.IsTrue(heatCommandLine.Contains("-usetoolsversion"));
}
else
{
Assert.IsFalse(heatCommandLine.Contains("-usetoolsversion"));
}
var warnings = result.Output.Where(line => line.Contains(": warning")).ToArray();
WixAssert.All(warnings, warning => warning.Contains("warning HEAT5149"));
var generatedFilePath = Path.Combine(intermediateFolder, "Release", "_Tools Version 4Cs.wxs");
Assert.IsTrue(File.Exists(generatedFilePath));
var generatedContents = File.ReadAllText(generatedFilePath);
var testXml = generatedContents.GetTestXml();
WixAssert.StringEqual(@"<Wix>" +
"<Fragment>" +
"<DirectoryRef Id='Tools_Version_4Cs.Binaries'>" +
"<Component Id='Tools_Version_4Cs.Binaries.Tools_Version_4Cs.dll' Guid='*'>" +
"<File Id='Tools_Version_4Cs.Binaries.Tools_Version_4Cs.dll' Source='$(var.Tools_Version_4Cs.TargetDir)\\Tools Version 4Cs.dll' />" +
"</Component>" +
"</DirectoryRef>" +
"</Fragment>" +
"<Fragment>" +
"<ComponentGroup Id='Tools_Version_4Cs.Binaries'>" +
"<ComponentRef Id='Tools_Version_4Cs.Binaries.Tools_Version_4Cs.dll' />" +
"</ComponentGroup>" +
"</Fragment>" +
"<Fragment>" +
"<DirectoryRef Id='Tools_Version_4Cs.Symbols'>" +
"<Component Id='Tools_Version_4Cs.Symbols.Tools_Version_4Cs.pdb' Guid='*'>" +
"<File Id='Tools_Version_4Cs.Symbols.Tools_Version_4Cs.pdb' Source='$(var.Tools_Version_4Cs.TargetDir)\\Tools Version 4Cs.pdb' />" +
"</Component>" +
"</DirectoryRef>" +
"</Fragment>" +
"<Fragment>" +
"<ComponentGroup Id='Tools_Version_4Cs.Symbols'>" +
"<ComponentRef Id='Tools_Version_4Cs.Symbols.Tools_Version_4Cs.pdb' />" +
"</ComponentGroup>" +
"</Fragment>" +
"<Fragment>" +
"<DirectoryRef Id='Tools_Version_4Cs.Sources'>" +
"<Component Id='Tools_Version_4Cs.Sources.Tools_Version_4Cs.csproj' Guid='*'>" +
"<File Id='Tools_Version_4Cs.Sources.Tools_Version_4Cs.csproj' Source='$(var.Tools_Version_4Cs.ProjectDir)\\Tools Version 4Cs.csproj' />" +
"</Component>" +
"<Directory Id='Tools_Version_4Cs.Sources.Properties' Name='Properties'>" +
"<Component Id='Tools_Version_4Cs.Sources.AssemblyInfo.cs' Guid='*'>" +
"<File Id='Tools_Version_4Cs.Sources.AssemblyInfo.cs' Source='$(var.Tools_Version_4Cs.ProjectDir)\\Properties\\AssemblyInfo.cs' />" +
"</Component>" +
"</Directory>" +
"</DirectoryRef>" +
"</Fragment>" +
"<Fragment>" +
"<ComponentGroup Id='Tools_Version_4Cs.Sources'>" +
"<ComponentRef Id='Tools_Version_4Cs.Sources.Tools_Version_4Cs.csproj' />" +
"<ComponentRef Id='Tools_Version_4Cs.Sources.AssemblyInfo.cs' />" +
"</ComponentGroup>" +
"</Fragment>" +
"<Fragment>" +
"<ComponentGroup Id='Tools_Version_4Cs.Content' />" +
"</Fragment>" +
"<Fragment>" +
"<ComponentGroup Id='Tools_Version_4Cs.Satellites' />" +
"</Fragment>" +
"<Fragment>" +
"<ComponentGroup Id='Tools_Version_4Cs.Documents' />" +
"</Fragment>" +
"</Wix>", testXml);
var pdbPath = Path.Combine(binFolder, "Release", "HeatProjectPreSdkStyle.wixpdb");
Assert.IsTrue(File.Exists(pdbPath));
var intermediate = Intermediate.Load(pdbPath);
var section = intermediate.Sections.Single();
var fileSymbol = section.Symbols.OfType<FileSymbol>().Single();
WixAssert.StringEqual(Path.Combine(fs.BaseFolder, "Tools Version 4Cs", "bin", "Release\\\\Tools Version 4Cs.dll"), fileSymbol[FileSymbolFields.Source].AsPath()?.Path);
}
}
[TestMethod]
[DataRow(BuildSystem.DotNetCoreSdk, true)]
[DataRow(BuildSystem.DotNetCoreSdk, false)]
[DataRow(BuildSystem.MSBuild, true)]
[DataRow(BuildSystem.MSBuild, false)]
[DataRow(BuildSystem.MSBuild64, true)]
[DataRow(BuildSystem.MSBuild64, false)]
public void CanBuildHeatProjectSdkStyle(BuildSystem buildSystem, bool useToolsVersion)
{
var sourceFolder = TestData.Get(@"TestData\HeatProject");
using (var fs = new TestDataFolderFileSystem())
{
fs.Initialize(sourceFolder);
File.Copy("global.json", Path.Combine(fs.BaseFolder, "global.json"));
var baseFolder = Path.Combine(fs.BaseFolder, "HeatProjectSdkStyle");
var binFolder = Path.Combine(baseFolder, @"bin\");
var intermediateFolder = Path.Combine(baseFolder, @"obj\");
var projectPath = Path.Combine(fs.BaseFolder, "HeatProjectSdkStyle", "HeatProjectSdkStyle.wixproj");
var referencedProjectPath = Path.Combine(fs.BaseFolder, "SdkStyleCs", "SdkStyleCs.csproj");
var result = MsbuildUtilities.BuildProject(buildSystem, referencedProjectPath, new[]
{
"-t:restore",
MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "HeatTargetsPath", MsbuildHeatFixture.HeatTargetsPath),
});
result.AssertSuccess();
result = MsbuildUtilities.BuildProject(buildSystem, projectPath, new[]
{
MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "HeatTargetsPath", MsbuildHeatFixture.HeatTargetsPath),
useToolsVersion ? $"-p:HarvestProjectsUseToolsVersion=true" : String.Empty,
});
result.AssertSuccess();
var heatCommandLines = MsbuildUtilities.GetToolCommandLines(result, "heat", "project", buildSystem);
var heatCommandLine = WixAssert.Single(heatCommandLines);
if (useToolsVersion && buildSystem != BuildSystem.DotNetCoreSdk)
{
Assert.IsTrue(heatCommandLine.Contains("-usetoolsversion"));
}
else
{
Assert.IsFalse(heatCommandLine.Contains("-usetoolsversion"));
}
var warnings = result.Output.Where(line => line.Contains(": warning")).ToArray();
WixAssert.All(warnings, warning => warning.Contains("warning HEAT5149"));
var generatedFilePath = Path.Combine(intermediateFolder, "Release", "_SdkStyleCs.wxs");
Assert.IsTrue(File.Exists(generatedFilePath));
var generatedContents = File.ReadAllText(generatedFilePath);
var testXml = generatedContents.GetTestXml();
WixAssert.StringEqual(@"<Wix>" +
"<Fragment>" +
"<DirectoryRef Id='SdkStyleCs.Binaries'>" +
"<Component Id='SdkStyleCs.Binaries.SdkStyleCs.dll' Guid='*'>" +
"<File Id='SdkStyleCs.Binaries.SdkStyleCs.dll' Source='$(var.SdkStyleCs.TargetDir)\\SdkStyleCs.dll' />" +
"</Component>" +
"</DirectoryRef>" +
"</Fragment>" +
"<Fragment>" +
"<ComponentGroup Id='SdkStyleCs.Binaries'>" +
"<ComponentRef Id='SdkStyleCs.Binaries.SdkStyleCs.dll' />" +
"</ComponentGroup>" +
"</Fragment>" +
"<Fragment>" +
"<DirectoryRef Id='SdkStyleCs.Symbols'>" +
"<Component Id='SdkStyleCs.Symbols.SdkStyleCs.pdb' Guid='*'>" +
"<File Id='SdkStyleCs.Symbols.SdkStyleCs.pdb' Source='$(var.SdkStyleCs.TargetDir)\\SdkStyleCs.pdb' />" +
"</Component>" +
"</DirectoryRef>" +
"</Fragment>" +
"<Fragment>" +
"<ComponentGroup Id='SdkStyleCs.Symbols'>" +
"<ComponentRef Id='SdkStyleCs.Symbols.SdkStyleCs.pdb' />" +
"</ComponentGroup>" +
"</Fragment>" +
"<Fragment>" +
"<DirectoryRef Id='SdkStyleCs.Sources'>" +
"<Component Id='SdkStyleCs.Sources.SdkStyleCs.cs' Guid='*'>" +
"<File Id='SdkStyleCs.Sources.SdkStyleCs.cs' Source='$(var.SdkStyleCs.ProjectDir)\\SdkStyleCs.cs' />" +
"</Component>" +
"<Component Id='SdkStyleCs.Sources.SdkStyleCs.csproj' Guid='*'>" +
"<File Id='SdkStyleCs.Sources.SdkStyleCs.csproj' Source='$(var.SdkStyleCs.ProjectDir)\\SdkStyleCs.csproj' />" +
"</Component>" +
"</DirectoryRef>" +
"</Fragment>" +
"<Fragment>" +
"<ComponentGroup Id='SdkStyleCs.Sources'>" +
"<ComponentRef Id='SdkStyleCs.Sources.SdkStyleCs.cs' />" +
"<ComponentRef Id='SdkStyleCs.Sources.SdkStyleCs.csproj' />" +
"</ComponentGroup>" +
"</Fragment>" +
"<Fragment>" +
"<ComponentGroup Id='SdkStyleCs.Content' />" +
"</Fragment>" +
"<Fragment>" +
"<ComponentGroup Id='SdkStyleCs.Satellites' />" +
"</Fragment>" +
"<Fragment>" +
"<ComponentGroup Id='SdkStyleCs.Documents' />" +
"</Fragment>" +
"</Wix>", testXml);
var pdbPath = Path.Combine(binFolder, "Release", "HeatProjectSdkStyle.wixpdb");
Assert.IsTrue(File.Exists(pdbPath));
var intermediate = Intermediate.Load(pdbPath);
var section = intermediate.Sections.Single();
var fileSymbol = section.Symbols.OfType<FileSymbol>().Single();
WixAssert.StringEqual(Path.Combine(fs.BaseFolder, "SdkStyleCs", "bin", "Release", "netstandard2.0\\\\SdkStyleCs.dll"), fileSymbol[FileSymbolFields.Source].AsPath()?.Path);
}
}
/// <summary>
/// This method exists to get the WixToolset.Sdk.nupkg into the NuGet package cache using the global.json
/// and nuget.config in the root of the repository. By pre-caching the WiX SDK, the rest of the tests will
/// pull the binaries out of the cache instead of needing to find the original .nupkg in the build artifacts
/// folder (which requires use of nuget.config found in the root of the repo)
/// </summary>
private static void EnsureWixSdkCached()
{
// This EnsureWixSdkCached project exists only to pre-cache the WixToolset.Sdk for use by later projects.
var sourceFolder = TestData.Get("TestData", "EnsureWixSdkCached");
var result = MsbuildUtilities.BuildProject(BuildSystem.DotNetCoreSdk, Path.Combine(sourceFolder, "EnsureWixSdkCached.wixproj"), new[]
{
"-t:restore",
});
result.AssertSuccess();
}
}
}
|
