Skip to content

Commit 9dda765

Browse files
radicalradical
authored
[release/7.0][wasm] Use the correct runtime pack version when the workload is not installed (#75028)
* Mono.ToolChain: WorkloadManifest.targets - Set runtime pack version even .. if no workload is installed. This ensures that the correct runtime pack version (intended by the installed manifest) is used even if the workload is not installed. * Improve incremental builds for workload installs used for testing * [wasm] Add a check for blazor projects, to confirm that the correct .. runtime pack version is being used. To use the locally built runtime pack without the workload, we need the nuget, so we use that from the artifacts. * [wasm] Add built nugets as payload for WBT * Fix built-nugets payload * [wasm] Allow setting browser path for use with xharness via envvar
1 parent 9b50564 commit 9dda765

File tree

12 files changed

+84
-14
lines changed

12 files changed

+84
-14
lines changed

‎eng/testing/workloads-testing.targets‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
<PropertyGroup Condition="'$(TestUsingWorkloads)' == 'true'">
44
<!-- for non-ci builds, we install the sdk when tests are run -->
55
<InstallWorkloadForTesting Condition="'$(ContinuousIntegrationBuild)' == 'true' and '$(ArchiveTests)' == 'true'">true</InstallWorkloadForTesting>
6+
</PropertyGroup>
67

8+
<PropertyGroup Condition="'$(InstallWorkloadForTesting)' == 'true'">
79
<_SdkForWorkloadTestingBasePath>$(ArtifactsBinDir)</_SdkForWorkloadTestingBasePath>
810
<_SdkWithNoWorkloadPath>$([MSBuild]::NormalizeDirectory($(_SdkForWorkloadTestingBasePath), 'dotnet-none'))</_SdkWithNoWorkloadPath>
911
<_SdkWithNoWorkloadStampPath>$([MSBuild]::NormalizePath($(_SdkWithNoWorkloadPath), '.version-$(SdkVersionForWorkloadTesting).stamp'))</_SdkWithNoWorkloadStampPath>
@@ -190,7 +192,7 @@
190192

191193
<Target Name="_InstallWorkloads"
192194
Inputs="@(AvailableNuGetsInArtifacts)"
193-
Outputs="@(_SdkWithWorkloadToInstall->'%(StampPath)')">
195+
Outputs="@(_SdkWithWorkloadToInstall->'%(StampPath)');$(_SdkWithNoWorkloadStampPath)">
194196
<ItemGroup>
195197
<_BuiltNuGets Include="$(LibrariesShippingPackagesDir)\*.nupkg" />
196198
</ItemGroup>
@@ -205,5 +207,7 @@
205207
TemplateNuGetConfigPath="$(RepoRoot)NuGet.config"
206208
SdkWithNoWorkloadInstalledPath="$(_SdkWithNoWorkloadPath)"
207209
/>
210+
211+
<WriteLinesToFile Lines="" File="$(_SdkWithNoWorkloadStampPath)" />
208212
</Target>
209213
</Project>

‎src/libraries/sendtohelix-wasm.targets‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
<WasmBuildTargetsDir>$([MSBuild]::NormalizeDirectory('$(RepoRoot)', 'src', 'mono', 'wasm', 'build'))</WasmBuildTargetsDir>
2727
<TestEchoMiddleware>$([MSBuild]::NormalizeDirectory('$(ArtifactsDir)', 'bin', 'NetCoreServer', '$(Configuration)', '$(AspNetCoreAppCurrent)'))</TestEchoMiddleware>
2828
<RemoteLoopMiddleware>$([MSBuild]::NormalizeDirectory('$(ArtifactsDir)', 'bin', 'RemoteLoopServer', '$(Configuration)', '$(AspNetCoreAppCurrent)'))</RemoteLoopMiddleware>
29+
<_ShippingPackagesPath>$([MSBuild]::NormalizeDirectory($(ArtifactsDir), 'packages', $(Configuration), 'Shipping'))</_ShippingPackagesPath>
2930
<WorkItemPrefix Condition="'$(IsWasmDebuggerTests)' == 'true'">$(DebuggerHost)-</WorkItemPrefix>
3031
<WorkItemPrefix Condition="'$(WorkItemPrefix)' == '' and '$(Scenario)' != ''">$(Scenario)-</WorkItemPrefix>
3132

@@ -56,6 +57,7 @@
5657
<NeedsEMSDKNode Condition="'$(Scenario)' == 'WasmTestOnNodeJs' or '$(Scenario)' == 'BuildWasmApps'">true</NeedsEMSDKNode>
5758
<NeedsToRunOnBrowser Condition="'$(Scenario)' == 'WasmTestOnBrowser' or '$(Scenario)' == 'BuildWasmApps'">true</NeedsToRunOnBrowser>
5859
<NeedsToRunOnBrowser Condition="'$(NeedsToRunOnBrowser)' == '' and '$(IsWasmDebuggerTests)' == 'true'">true</NeedsToRunOnBrowser>
60+
<NeedsBuiltNugets Condition="'$(Scenario)' == 'BuildWasmApps'">true</NeedsBuiltNugets>
5961

6062
<IncludeXHarnessCli>true</IncludeXHarnessCli>
6163
<EnableXHarnessTelemetry>false</EnableXHarnessTelemetry>
@@ -121,6 +123,9 @@
121123
<ItemGroup Condition="'$(Scenario)' == 'BuildWasmApps'">
122124
<HelixPreCommand Condition="'$(WindowsShell)' == 'true'" Include="set &quot;XUnitTraitArg=$(_XUnitTraitArg)&quot;" />
123125
<HelixPreCommand Condition="'$(WindowsShell)' != 'true'" Include="export &quot;XUnitTraitArg=$(_XUnitTraitArg)&quot;" />
126+
127+
<HelixPreCommand Condition="'$(WindowsShell)' == 'true'" Include="set &quot;BUILT_NUGETS_PATH=%HELIX_CORRELATION_PAYLOAD%/built-nugets&quot;" />
128+
<HelixPreCommand Condition="'$(WindowsShell)' != 'true'" Include="export &quot;BUILT_NUGETS_PATH=$HELIX_CORRELATION_PAYLOAD/built-nugets&quot;" />
124129
</ItemGroup>
125130

126131
<PropertyGroup>
@@ -187,6 +192,10 @@
187192
<HelixCorrelationPayload Include="$(TestEchoMiddleware)" Destination="xharness/TestEchoMiddleware" Condition="Exists('$(TestEchoMiddleware)')" />
188193
<HelixCorrelationPayload Include="$(RemoteLoopMiddleware)" Destination="xharness/RemoteLoopMiddleware" Condition="Exists('$(RemoteLoopMiddleware)')" />
189194
</ItemGroup>
195+
196+
<ItemGroup Condition="'$(NeedsBuiltNugets)' == 'true'">
197+
<HelixCorrelationPayload Include="$(_ShippingPackagesPath)" Destination="built-nugets" />
198+
</ItemGroup>
190199
</Target>
191200

192201
<Target Name="PrepareForBuildHelixWorkItems_Wasm"

‎src/mono/nuget/Microsoft.NET.Workload.Mono.Toolchain.net6.Manifest/WorkloadManifest.targets.in‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
<Import Project="Sdk.targets" Sdk="Microsoft.NET.Runtime.MonoTargets.Sdk.net6" />
9898
</ImportGroup>
9999

100-
<PropertyGroup Condition="'$(TargetsNet6)' == 'true' and ('$(TargetPlatformIdentifier)' == 'android' or '$(TargetPlatformIdentifier)' == 'macOS' or '$(TargetPlatformIdentifier)' == 'ios' or '$(TargetPlatformIdentifier)' == 'maccatalyst' or '$(TargetPlatformIdentifier)' == 'tvos' or ('$(RuntimeIdentifier)' == 'browser-wasm' and '$(UsingBrowserRuntimeWorkload)' == 'true'))">
100+
<PropertyGroup Condition="'$(TargetsNet6)' == 'true' and ('$(TargetPlatformIdentifier)' == 'android' or '$(TargetPlatformIdentifier)' == 'macOS' or '$(TargetPlatformIdentifier)' == 'ios' or '$(TargetPlatformIdentifier)' == 'maccatalyst' or '$(TargetPlatformIdentifier)' == 'tvos' or '$(RuntimeIdentifier)' == 'browser-wasm')">
101101
<_MonoWorkloadTargetsMobile>true</_MonoWorkloadTargetsMobile>
102102
<_MonoWorkloadRuntimePackPackageVersion>$(_RuntimePackInWorkloadVersion6)</_MonoWorkloadRuntimePackPackageVersion>
103103
</PropertyGroup>

‎src/mono/nuget/Microsoft.NET.Workload.Mono.Toolchain.net7.Manifest/WorkloadManifest.targets.in‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494
<Import Project="Sdk.targets" Sdk="Microsoft.NET.Runtime.MonoTargets.Sdk.net7" />
9595
</ImportGroup>
9696

97-
<PropertyGroup Condition="'$(TargetsNet7)' == 'true' and ('$(TargetPlatformIdentifier)' == 'android' or '$(TargetPlatformIdentifier)' == 'macOS' or '$(TargetPlatformIdentifier)' == 'ios' or '$(TargetPlatformIdentifier)' == 'maccatalyst' or '$(TargetPlatformIdentifier)' == 'tvos' or ('$(RuntimeIdentifier)' == 'browser-wasm' and '$(UsingBrowserRuntimeWorkload)' == 'true'))">
97+
<PropertyGroup Condition="'$(TargetsNet7)' == 'true' and ('$(TargetPlatformIdentifier)' == 'android' or '$(TargetPlatformIdentifier)' == 'macOS' or '$(TargetPlatformIdentifier)' == 'ios' or '$(TargetPlatformIdentifier)' == 'maccatalyst' or '$(TargetPlatformIdentifier)' == 'tvos' or '$(RuntimeIdentifier)' == 'browser-wasm')">
9898
<_MonoWorkloadTargetsMobile>true</_MonoWorkloadTargetsMobile>
9999
<_MonoWorkloadRuntimePackPackageVersion>$(_RuntimePackInWorkloadVersion7)</_MonoWorkloadRuntimePackPackageVersion>
100100
</PropertyGroup>

‎src/tasks/WorkloadBuildTasks/InstallWorkloadFromArtifacts.cs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,8 @@ public override bool Execute()
9797

9898
if (!ExecuteInternal(req) && !req.IgnoreErrors)
9999
return false;
100+
101+
File.WriteAllText(req.StampPath, string.Empty);
100102
}
101103

102104
return !Log.HasLoggedErrors;
@@ -399,6 +401,7 @@ internal sealed record InstallWorkloadRequest(
399401
public string ManifestName => Workload.GetMetadata("ManifestName");
400402
public string Version => Workload.GetMetadata("Version");
401403
public string TargetPath => Target.GetMetadata("InstallPath");
404+
public string StampPath => Target.GetMetadata("StampPath");
402405
public bool IgnoreErrors => Workload.GetMetadata("IgnoreErrors").ToLowerInvariant() == "true";
403406
public string WorkloadId => Workload.ItemSpec;
404407

‎src/tests/BuildWasmApps/Wasm.Build.Tests/BlazorWasmBuildPublishTests.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public BlazorWasmBuildPublishTests(ITestOutputHelper output, SharedBuildPerTestC
2121
_enablePerTestCleanup = true;
2222
}
2323

24-
[Theory]
24+
[Theory, TestCategory("no-workload")]
2525
[InlineData("Debug")]
2626
[InlineData("Release")]
2727
public void DefaultTemplate_WithoutWorkload(string config)

‎src/tests/BuildWasmApps/Wasm.Build.Tests/BuildEnvironment.cs‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
using System;
55
using System.Collections.Generic;
66
using System.IO;
7-
using System.Reflection;
87
using System.Runtime.InteropServices;
98

109
#nullable enable
@@ -25,6 +24,7 @@ public class BuildEnvironment
2524
public string LogRootPath { get; init; }
2625

2726
public string WorkloadPacksDir { get; init; }
27+
public string BuiltNuGetsPath { get; init; }
2828

2929
public static readonly string RelativeTestAssetsPath = @"..\testassets\";
3030
public static readonly string TestAssetsPath = Path.Combine(AppContext.BaseDirectory, "testassets");
@@ -99,6 +99,11 @@ public BuildEnvironment()
9999
DirectoryBuildTargetsContents = s_directoryBuildTargetsForLocal;
100100
}
101101

102+
if (EnvironmentVariables.BuiltNuGetsPath is null || !Directory.Exists(EnvironmentVariables.BuiltNuGetsPath))
103+
throw new Exception($"Cannot find 'BUILT_NUGETS_PATH={EnvironmentVariables.BuiltNuGetsPath}'");
104+
105+
BuiltNuGetsPath = EnvironmentVariables.BuiltNuGetsPath;
106+
102107
// `runtime` repo's build environment sets these, and they
103108
// mess up the build for the test project, which is using a different
104109
// dotnet

‎src/tests/BuildWasmApps/Wasm.Build.Tests/BuildTestBase.cs‎

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ public abstract class BuildTestBase : IClassFixture<SharedBuildPerTestClassFixtu
4141
protected static int s_defaultPerTestTimeoutMs = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? 30*60*1000 : 15*60*1000;
4242
protected static BuildEnvironment s_buildEnv;
4343
private const string s_runtimePackPathPattern = "\\*\\* MicrosoftNetCoreAppRuntimePackDir : ([^ ]*)";
44+
private const string s_nugetInsertionTag = "<!-- TEST_RESTORE_SOURCES_INSERTION_LINE -->";
4445
private static Regex s_runtimePackPathRegex;
4546
private static int s_testCounter;
4647
private readonly int _testIdx;
@@ -213,6 +214,16 @@ protected static string RunWithXHarness(string testCommand, string testLogPath,
213214
args.Append($" --expected-exit-code={expectedAppExitCode}");
214215
args.Append($" {extraXHarnessArgs ?? string.Empty}");
215216

217+
if (File.Exists("/.dockerenv"))
218+
args.Append(" --browser-arg=--no-sandbox");
219+
220+
if (!string.IsNullOrEmpty(EnvironmentVariables.BrowserPathForTests))
221+
{
222+
if (!File.Exists(EnvironmentVariables.BrowserPathForTests))
223+
throw new Exception($"Cannot find BROWSER_PATH_FOR_TESTS={EnvironmentVariables.BrowserPathForTests}");
224+
args.Append($" --browser-path=\"{EnvironmentVariables.BrowserPathForTests}\"");
225+
}
226+
216227
args.Append(" -- ");
217228
if (extraXHarnessMonoArgs != null)
218229
{
@@ -325,7 +336,8 @@ protected static BuildArgs ExpandBuildArgs(BuildArgs buildArgs, string extraProp
325336
{
326337
_testOutput.WriteLine ($"Using existing build found at {product.ProjectDir}, with build log at {product.LogFile}");
327338

328-
Assert.True(product.Result, $"Found existing build at {product.ProjectDir}, but it had failed. Check build log at {product.LogFile}");
339+
if (!product.Result)
340+
throw new XunitException($"Found existing build at {product.ProjectDir}, but it had failed. Check build log at {product.LogFile}");
329341
_projectDir = product.ProjectDir;
330342

331343
// use this test's id for the run logs
@@ -359,7 +371,6 @@ protected static BuildArgs ExpandBuildArgs(BuildArgs buildArgs, string extraProp
359371
string logFilePath = Path.Combine(_logPath, $"{buildArgs.ProjectName}{logFileSuffix}.binlog");
360372
_testOutput.WriteLine($"-------- Building ---------");
361373
_testOutput.WriteLine($"Binlog path: {logFilePath}");
362-
_testOutput.WriteLine($"Binlog path: {logFilePath}");
363374
sb.Append($" /bl:\"{logFilePath}\" /nologo");
364375
sb.Append($" /v:{options.Verbosity ?? "minimal"}");
365376
if (buildArgs.ExtraBuildArgs != null)
@@ -410,11 +421,24 @@ public void InitBlazorWasmProjectDir(string id)
410421
Directory.CreateDirectory(_projectDir);
411422
Directory.CreateDirectory(Path.Combine(_projectDir, ".nuget"));
412423

413-
File.Copy(Path.Combine(BuildEnvironment.TestDataPath, NuGetConfigFileNameForDefaultFramework), Path.Combine(_projectDir, "nuget.config"));
424+
File.WriteAllText(Path.Combine(_projectDir, "nuget.config"),
425+
GetNuGetConfigWithLocalPackagesPath(
426+
Path.Combine(BuildEnvironment.TestDataPath, NuGetConfigFileNameForDefaultFramework),
427+
s_buildEnv.BuiltNuGetsPath));
428+
414429
File.Copy(Path.Combine(BuildEnvironment.TestDataPath, "Blazor.Directory.Build.props"), Path.Combine(_projectDir, "Directory.Build.props"));
415430
File.Copy(Path.Combine(BuildEnvironment.TestDataPath, "Blazor.Directory.Build.targets"), Path.Combine(_projectDir, "Directory.Build.targets"));
416431
}
417432

433+
private static string GetNuGetConfigWithLocalPackagesPath(string templatePath, string localNuGetsPath)
434+
{
435+
string contents = File.ReadAllText(templatePath);
436+
if (contents.IndexOf(s_nugetInsertionTag, StringComparison.InvariantCultureIgnoreCase) < 0)
437+
throw new Exception($"Could not find {s_nugetInsertionTag} in {templatePath}");
438+
439+
return contents.Replace(s_nugetInsertionTag, $@"<add key=""nuget-local"" value=""{localNuGetsPath}"" />");
440+
}
441+
418442
public string CreateWasmTemplateProject(string id, string template = "wasmbrowser")
419443
{
420444
InitPaths(id);
@@ -636,10 +660,10 @@ protected static void AssertFile(string file0, string file1, string? label=null,
636660
protected (int exitCode, string buildOutput) AssertBuild(string args, string label="build", bool expectSuccess=true, IDictionary<string, string>? envVars=null, int? timeoutMs=null)
637661
{
638662
var result = RunProcess(s_buildEnv.DotNet, _testOutput, args, workingDir: _projectDir, label: label, envVars: envVars, timeoutMs: timeoutMs ?? s_defaultPerTestTimeoutMs);
639-
if (expectSuccess)
640-
Assert.True(0 == result.exitCode, $"Build process exited with non-zero exit code: {result.exitCode}");
641-
else
642-
Assert.True(0 != result.exitCode, $"Build should have failed, but it didn't. Process exited with exitCode : {result.exitCode}");
663+
if (expectSuccess && result.exitCode != 0)
664+
throw new XunitException($"Build process exited with non-zero exit code: {result.exitCode}");
665+
if (!expectSuccess && result.exitCode == 0)
666+
throw new XunitException($"Build should have failed, but it didn't. Process exited with exitCode : {result.exitCode}");
643667

644668
return result;
645669
}

‎src/tests/BuildWasmApps/Wasm.Build.Tests/EnvironmentVariables.cs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,7 @@ internal static class EnvironmentVariables
1616
internal static readonly string? TestLogPath = Environment.GetEnvironmentVariable("TEST_LOG_PATH");
1717
internal static readonly string? SkipProjectCleanup = Environment.GetEnvironmentVariable("SKIP_PROJECT_CLEANUP");
1818
internal static readonly string? XHarnessCliPath = Environment.GetEnvironmentVariable("XHARNESS_CLI_PATH");
19+
internal static readonly string? BuiltNuGetsPath = Environment.GetEnvironmentVariable("BUILT_NUGETS_PATH");
20+
internal static readonly string? BrowserPathForTests = Environment.GetEnvironmentVariable("BROWSER_PATH_FOR_TESTS");
1921
}
2022
}

‎src/tests/BuildWasmApps/Wasm.Build.Tests/Wasm.Build.Tests.csproj‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
<RunScriptCommands Condition="'$(OS)' != 'Windows_NT'" Include="chmod +x $HELIX_WORKITEM_ROOT/.playwright/node/linux/node" />
5757
</ItemGroup>
5858

59-
<PropertyGroup Condition="'$(Scenario)' == 'BuildWasmApps'">
59+
<PropertyGroup>
6060
<_XUnitTraitArg Condition="'$(TestUsingWorkloads)' == 'true'">-notrait category=no-workload</_XUnitTraitArg>
6161
<_XUnitTraitArg Condition="'$(TestUsingWorkloads)' != 'true'">-trait category=no-workload</_XUnitTraitArg>
6262
</PropertyGroup>
@@ -69,6 +69,9 @@
6969

7070
<RunScriptCommands Condition="'$(OS)' != 'Windows_NT'" Include="export BASE_DIR=$(ArtifactsBinDir)" />
7171
<RunScriptCommands Condition="'$(OS)' == 'Windows_NT'" Include="set BASE_DIR=$(ArtifactsBinDir)" />
72+
73+
<RunScriptCommands Condition="'$(OS)' != 'Windows_NT'" Include="export BUILT_NUGETS_PATH=$(LibrariesShippingPackagesDir)/" />
74+
<RunScriptCommands Condition="'$(OS)' == 'Windows_NT'" Include="set BUILT_NUGETS_PATH=$(LibrariesShippingPackagesDir)" />
7275
</ItemGroup>
7376

7477
<ItemGroup>

0 commit comments

Comments
 (0)