Skip to content

[release/6.0-rc1][wasm] Require workloads if using @(NativeFileReference) #58148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
radical wants to merge 2 commits into from
Closed

[release/6.0-rc1][wasm] Require workloads if using @(NativeFileReference) #58148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64b447b
[wasm] Require workloads, if a project is using native references
radical Aug 26, 2021
cdeff4d
Bump sdk for workload testing to 6.0.100-rc.1.21425.15
radical Aug 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion eng/Versions.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@
<SQLitePCLRawbundle_greenVersion>2.0.4</SQLitePCLRawbundle_greenVersion>
<MoqVersion>4.12.0</MoqVersion>
<FsCheckVersion>2.14.3</FsCheckVersion>
<SdkVersionForWorkloadTesting>6.0.100-rc.1.21412.8</SdkVersionForWorkloadTesting>
<SdkVersionForWorkloadTesting>6.0.100-rc.1.21425.15</SdkVersionForWorkloadTesting>
<!-- Docs -->
<MicrosoftPrivateIntellisenseVersion>5.0.0-preview-20201009.2</MicrosoftPrivateIntellisenseVersion>
<!-- ILLink -->
Expand Down
30 changes: 26 additions & 4 deletions src/mono/nuget/Microsoft.NET.Workload.Mono.Toolchain.Manifest/WorkloadManifest.targets.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@
</PropertyGroup>

<PropertyGroup Condition="'$(RuntimeIdentifier)' == 'browser-wasm' and '$(BrowserWorkloadDisabled)' == 'true'">
<_NativeBuildNeeded Condition="'$(RunAOTCompilation)' == 'true'">true</_NativeBuildNeeded>
<WorkloadDisabledWithReason Condition="'$(_NativeBuildNeeded)' == 'true'">WebAssembly workloads (required for AOT) are only supported for projects targeting net6.0+</WorkloadDisabledWithReason>
<_MissingNativeBuildNeededFor Condition="'$(RunAOTCompilation)' == 'true'">required for AOT</_MissingNativeBuildNeededFor>
</PropertyGroup>

<PropertyGroup Condition="'$(RuntimeIdentifier)' == 'browser-wasm' AND '$(UsingBrowserRuntimeWorkload)' == ''">
Expand Down Expand Up @@ -128,7 +127,30 @@
/>
</ItemGroup>

<Target Name="ErrorDisabledWorkload" Condition="'$(WorkloadDisabledWithReason)' != ''" BeforeTargets="Publish">
<Error Text="$(WorkloadDisabledWithReason)" />
<Target Name="_CheckNativeBuildNeededButMissingWorkload"
Condition="'$(RuntimeIdentifier)' == 'browser-wasm' and '$(_MissingNativeBuildNeededFor)' == '' and '$(WasmNativeWorkload)' != 'true'"
BeforeTargets="Build">

<PropertyGroup Condition="@(NativeFileReference->Count()) > 0">
<_MissingNativeBuildNeededFor>(required for linking native libraries)</_MissingNativeBuildNeededFor>

<!-- fail with missing workload, only if it isn't *disabled* (eg. for net5.0 projects) -->
<_WorkloadNeeded Condition="'$(_MissingNativeBuildNeededFor)' != '' and '$(BrowserWorkloadDisabled)' != 'true'">true</_WorkloadNeeded>
</PropertyGroup>

<ItemGroup Condition="'$(_WorkloadNeeded)' == 'true'">
<MissingWorkloadPack Include="Microsoft.NET.Runtime.WebAssembly.Sdk" Version="$(RuntimePackInWorkloadVersion)" />
</ItemGroup>

<!-- based on Microsoft.NET.Sdk/targets/Microsoft.NET.Sdk.ImportWorkloads.targets -->
<ShowMissingWorkloads MissingWorkloadPacks="@(MissingWorkloadPack)"
NetCoreRoot="$(NetCoreRoot)"
NETCoreSdkVersion="$(NETCoreSdkVersion)"
GenerateErrorsForMissingWorkloads="true"
Condition="'$(_WorkloadNeeded)' == 'true'" />
</Target>

<Target Name="_ErrorDisabledWorkload" Condition="'$(_MissingNativeBuildNeededFor)' != ''" BeforeTargets="Build">
<Error Text="WebAssembly workloads, $(_MissingNativeBuildNeededFor), are only supported for projects targeting net6.0+" />
</Target>
</Project>
113 changes: 77 additions & 36 deletions src/tests/BuildWasmApps/Wasm.Build.Tests/BlazorWasmTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,27 +26,17 @@ public BlazorWasmTests(ITestOutputHelper output, SharedBuildPerTestClassFixture
[InlineData("Release", true)]
public void PublishTemplateProject(string config, bool aot)
{
string id = $"blazorwasm_{config}_aot_{aot}";
InitPaths(id);
if (Directory.Exists(_projectDir))
Directory.Delete(_projectDir, recursive: true);
Directory.CreateDirectory(_projectDir);
Directory.CreateDirectory(Path.Combine(_projectDir, ".nuget"));

File.Copy(Path.Combine(BuildEnvironment.TestDataPath, "nuget6.config"), Path.Combine(_projectDir, "nuget.config"));
File.Copy(Path.Combine(BuildEnvironment.TestDataPath, "Blazor.Directory.Build.props"), Path.Combine(_projectDir, "Directory.Build.props"));
File.Copy(Path.Combine(BuildEnvironment.TestDataPath, "Blazor.Directory.Build.targets"), Path.Combine(_projectDir, "Directory.Build.targets"));

string logPath = Path.Combine(s_buildEnv.LogRootPath, id);
string id = $"blazorwasm_{config}_aot_{aot}_{Path.GetRandomFileName()}";
InitBlazorWasmProjectDir(id);

new DotNetCommand(s_buildEnv, useDefaultArgs: false)
.WithWorkingDirectory(_projectDir)
.WithWorkingDirectory(_projectDir!)
.ExecuteWithCapturedOutput("new blazorwasm")
.EnsureSuccessful();

string publishLogPath = Path.Combine(logPath, $"{id}.binlog");
string publishLogPath = Path.Combine(s_buildEnv.LogRootPath, id, $"{id}.binlog");
new DotNetCommand(s_buildEnv)
.WithWorkingDirectory(_projectDir)
.WithWorkingDirectory(_projectDir!)
.ExecuteWithCapturedOutput("publish", $"-bl:{publishLogPath}", aot ? "-p:RunAOTCompilation=true" : "", $"-p:Configuration={config}")
.EnsureSuccessful();

Expand All @@ -57,6 +47,65 @@ public void PublishTemplateProject(string config, bool aot)
// playwright?
}

[ConditionalTheory(typeof(BuildTestBase), nameof(IsNotUsingWorkloads))]
[InlineData("Debug")]
[InlineData("Release")]
public void NativeRef_RequiresWorkload(string config)
=> RequiresWorkloadTest(config, extraItems: "<NativeFileReference Include=\"native-lib.o\" />");

[ConditionalTheory(typeof(BuildTestBase), nameof(IsNotUsingWorkloads))]
[InlineData("Debug")]
[InlineData("Release")]
public void AOT_RequiresWorkload(string config)
=> RequiresWorkloadTest(config, extraProperties: "<RunAOTCompilation>true</RunAOTCompilation>");

[ConditionalTheory(typeof(BuildTestBase), nameof(IsNotUsingWorkloads))]
[InlineData("Debug")]
[InlineData("Release")]
public void AOT_And_NativeRef_RequireWorkload(string config)
=> RequiresWorkloadTest(config,
extraProperties: "<RunAOTCompilation>true</RunAOTCompilation>",
extraItems: "<NativeFileReference Include=\"native-lib.o\" />");

private void RequiresWorkloadTest(string config, string extraItems="", string extraProperties="")
{
string id = $"needs_workload_{config}_{Path.GetRandomFileName()}";
InitBlazorWasmProjectDir(id);

new DotNetCommand(s_buildEnv, useDefaultArgs: false)
.WithWorkingDirectory(_projectDir!)
.ExecuteWithCapturedOutput("new blazorwasm")
.EnsureSuccessful();

if (IsNotUsingWorkloads)
{
// no packs installed, so no need to update the paths for runtime pack etc
File.WriteAllText(Path.Combine(_projectDir!, "Directory.Build.props"), "<Project />");
File.WriteAllText(Path.Combine(_projectDir!, "Directory.Build.targets"), "<Project />");
}

AddItemsPropertiesToProject(Path.Combine(_projectDir!, $"{id}.csproj"),
extraProperties: extraProperties,
extraItems: extraItems);

string publishLogPath = Path.Combine(s_buildEnv.LogRootPath, id, $"{id}.binlog");
CommandResult res = new DotNetCommand(s_buildEnv)
.WithWorkingDirectory(_projectDir!)
.ExecuteWithCapturedOutput("publish",
$"-bl:{publishLogPath}",
$"-p:Configuration={config}",
"-p:MSBuildEnableWorkloadResolver=true"); // WasmApp.LocalBuild.* disables this, but it is needed for this test

Assert.NotEqual(0, res.ExitCode);
Assert.Contains("following workloads must be installed: wasm-tools", res.Output);
}

[Theory]
[InlineData("Debug")]
[InlineData("Release")]
public void Net50Projects_NativeReference(string config)
=> BuildNet50Project(config, aot: false, expectError: true, @"<NativeFileReference Include=""native-lib.o"" />");

public static TheoryData<string, bool, bool> Net50TestData = new()
{
{ "Debug", /*aot*/ true, /*expectError*/ true },
Expand All @@ -65,51 +114,43 @@ public void PublishTemplateProject(string config, bool aot)
{ "Release", /*aot*/ false, /*expectError*/ false }
};

[ConditionalTheory(typeof(BuildTestBase), nameof(IsNotUsingWorkloads))]
[Theory]
[MemberData(nameof(Net50TestData))]
public void Net50ProjectsWithNoPacksInstalled(string config, bool aot, bool expectError)
public void Net50Projects_AOT(string config, bool aot, bool expectError)
=> BuildNet50Project(config, aot, expectError);

[ConditionalTheory(typeof(BuildTestBase), nameof(IsUsingWorkloads))]
[MemberData(nameof(Net50TestData))]
public void Net50ProjectsWithPacksInstalled(string config, bool aot, bool expectError)
=> BuildNet50Project(config, aot, expectError);

private void BuildNet50Project(string config, bool aot, bool errorExpected)
private void BuildNet50Project(string config, bool aot, bool expectError, string? extraItems=null)
{
string id = $"Blazor_net50_{config}_{aot}";
InitPaths(id);
if (Directory.Exists(_projectDir))
Directory.Delete(_projectDir, recursive: true);
Directory.CreateDirectory(_projectDir);
Directory.CreateDirectory(Path.Combine(_projectDir, ".nuget"));
string id = $"Blazor_net50_{config}_{aot}_{Path.GetRandomFileName()}";
InitBlazorWasmProjectDir(id);

string directoryBuildTargets = @"<Project>
<Target Name=""PrintAllProjects"" BeforeTargets=""Build"">
<Message Text=""** UsingBrowserRuntimeWorkload: '$(UsingBrowserRuntimeWorkload)'"" Importance=""High"" />
</Target>
</Project>";

File.Copy(Path.Combine(BuildEnvironment.TestDataPath, "nuget6.config"), Path.Combine(_projectDir, "nuget.config"));
File.WriteAllText(Path.Combine(_projectDir, "Directory.Build.props"), "<Project />");
File.WriteAllText(Path.Combine(_projectDir, "Directory.Build.targets"), directoryBuildTargets);
File.WriteAllText(Path.Combine(_projectDir!, "Directory.Build.props"), "<Project />");
File.WriteAllText(Path.Combine(_projectDir!, "Directory.Build.targets"), directoryBuildTargets);

string logPath = Path.Combine(s_buildEnv.LogRootPath, id);
Utils.DirectoryCopy(Path.Combine(BuildEnvironment.TestAssetsPath, "Blazor_net50"), Path.Combine(_projectDir!));

string projectFile = Path.Combine(_projectDir!, "Blazor_net50.csproj");
AddItemsPropertiesToProject(projectFile, extraItems: extraItems);

string publishLogPath = Path.Combine(logPath, $"{id}.binlog");
CommandResult result = new DotNetCommand(s_buildEnv)
.WithWorkingDirectory(_projectDir)
.WithWorkingDirectory(_projectDir!)
.ExecuteWithCapturedOutput("publish",
$"-bl:{publishLogPath}",
(aot ? "-p:RunAOTCompilation=true" : ""),
$"-p:Configuration={config}");

if (errorExpected)
if (expectError)
{
result.EnsureExitCode(1);
Assert.Contains("** UsingBrowserRuntimeWorkload: 'false'", result.Output);
Assert.Contains("error : WebAssembly workloads (required for AOT) are only supported for projects targeting net6.0+", result.Output);
Assert.Contains("are only supported for projects targeting net6.0+", result.Output);
}
else
{
Expand Down
41 changes: 41 additions & 0 deletions src/tests/BuildWasmApps/Wasm.Build.Tests/BuildTestBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
using System.Runtime.InteropServices;
using System.Text;
using System.Text.RegularExpressions;
using System.Xml;
using Xunit;
using Xunit.Abstractions;
using Xunit.Sdk;
Expand Down Expand Up @@ -357,6 +358,19 @@ protected static BuildArgs ExpandBuildArgs(BuildArgs buildArgs, string extraProp
}
}

public void InitBlazorWasmProjectDir(string id)
{
InitPaths(id);
if (Directory.Exists(_projectDir))
Directory.Delete(_projectDir, recursive: true);
Directory.CreateDirectory(_projectDir);
Directory.CreateDirectory(Path.Combine(_projectDir, ".nuget"));

File.Copy(Path.Combine(BuildEnvironment.TestDataPath, "nuget6.config"), Path.Combine(_projectDir, "nuget.config"));
File.Copy(Path.Combine(BuildEnvironment.TestDataPath, "Blazor.Directory.Build.props"), Path.Combine(_projectDir, "Directory.Build.props"));
File.Copy(Path.Combine(BuildEnvironment.TestDataPath, "Blazor.Directory.Build.targets"), Path.Combine(_projectDir, "Directory.Build.targets"));
}

static void AssertRuntimePackPath(string buildOutput)
{
var match = s_runtimePackPathRegex.Match(buildOutput);
Expand Down Expand Up @@ -601,6 +615,33 @@ void LogData(string label, string? message)
}
}

public static string AddItemsPropertiesToProject(string projectFile, string? extraProperties=null, string? extraItems=null)
{
if (extraProperties == null && extraItems == null)
return projectFile;

XmlDocument doc = new();
doc.Load(projectFile);

if (extraItems != null)
{
XmlNode node = doc.CreateNode(XmlNodeType.Element, "ItemGroup", null);
node.InnerXml = extraItems;
doc.DocumentElement!.AppendChild(node);
}

if (extraProperties != null)
{
XmlNode node = doc.CreateNode(XmlNodeType.Element, "PropertyGroup", null);
node.InnerXml = extraProperties;
doc.DocumentElement!.AppendChild(node);
}

doc.Save(projectFile);

return projectFile;
}

public void Dispose()
{
if (_projectDir != null && _enablePerTestCleanup)
Expand Down
4 changes: 2 additions & 2 deletions src/tests/BuildWasmApps/Wasm.Build.Tests/NativeLibraryTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public NativeLibraryTests(ITestOutputHelper output, SharedBuildPerTestClassFixtu
{
}

[Theory]
[ConditionalTheory(typeof(BuildTestBase), nameof(IsUsingWorkloads))]
[BuildAndRun(aot: false)]
[BuildAndRun(aot: true)]
public void ProjectWithNativeReference(BuildArgs buildArgs, RunHost host, string id)
Expand Down Expand Up @@ -48,7 +48,7 @@ public void ProjectWithNativeReference(BuildArgs buildArgs, RunHost host, string
Assert.Contains("from pinvoke: 142", output);
}

[Theory]
[ConditionalTheory(typeof(BuildTestBase), nameof(IsUsingWorkloads))]
[BuildAndRun(aot: false)]
[BuildAndRun(aot: true)]
public void ProjectUsingSkiaSharp(BuildArgs buildArgs, RunHost host, string id)
Expand Down