Skip to content
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

Jump to bottom

Enable Aot, Trim and single file analyzers if PublishAot is set #25301

Merged
merged 3 commits into from
May 10, 2022
Merged

Enable Aot, Trim and single file analyzers if PublishAot is set #25301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0c67d6
Enable Aot, Trim and single file analyzers if PublishAot is set
tlakollo May 9, 2022
2ec157b
PR feedback
tlakollo May 9, 2022
bf3d2d1
PR feedback
tlakollo May 9, 2022
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
5 changes: 3 additions & 2 deletions src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Sdk.Analyzers.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,11 @@ Copyright (c) .NET Foundation. All rights reserved.

<!-- Intermediate step to enable ILLink.Analyzers so ILLink, Blazor, Xamarin, AOT, etc. can enable the same flags -->
<EnableSingleFileAnalyzer Condition="'$(EnableSingleFileAnalyzer)' == '' And
'$(PublishSingleFile)' == 'true'">true</EnableSingleFileAnalyzer>
('$(PublishSingleFile)' == 'true' Or '$(PublishAot)' == 'true')">true</EnableSingleFileAnalyzer>

<!-- Enable the trim analyzer when any trimming settings are enabled. Warnings may suppressed based on other settings. -->
<EnableTrimAnalyzer Condition="'$(EnableTrimAnalyzer)' == '' And ('$(PublishTrimmed)' == 'true' Or '$(IsTrimmable)' == 'true')">true</EnableTrimAnalyzer>
<EnableTrimAnalyzer Condition="'$(EnableTrimAnalyzer)' == '' And
('$(PublishTrimmed)' == 'true' Or '$(IsTrimmable)' == 'true' Or '$(PublishAot)' == 'true')">true</EnableTrimAnalyzer>

<!-- Enable the AOT analyzer when AOT is enabled. Warnings may suppressed based on other settings. -->
<EnableAotAnalyzer Condition="'$(EnableAotAnalyzer)' == '' And '$(PublishAot)' == 'true'">true</EnableAotAnalyzer>
Expand Down
123 changes: 95 additions & 28 deletions src/Tests/Microsoft.NET.Publish.Tests/GivenThatWeWantToPublishAnAotApp.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,60 +32,80 @@ public GivenThatWeWantToPublishAnAotApp(ITestOutputHelper log) : base(log)

[RequiresMSBuildVersionTheory("17.0.0.32901")]
[InlineData(LatestTfm)]
public void ILLink_aot_analyzer_warnings_are_produced(string targetFramework)
public void Only_Aot_warnings_are_produced_if_EnableAotAnalyzer_is_set(string targetFramework)
{
var projectName = "ILLinkAotAnalyzerWarningsApp";
var testProject = CreateTestProjectWithAotAnalyzerWarnings(targetFramework, projectName, true);
var projectName = "WarningAppWithAotAnalyzer";
var testProject = CreateTestProjectWithAnalysisWarnings(targetFramework, projectName, true);
// Inactive linker/single-file analyzers should have no effect on the aot analyzer,
// unless PublishAot is also set.
testProject.AdditionalProperties["EnableAotAnalyzer"] = "true";
testProject.AdditionalProperties["SuppressTrimAnalysisWarnings"] = "false";
var testAsset = _testAssetsManager.CreateTestProject(testProject);

var publishCommand = new PublishCommand(Log, Path.Combine(testAsset.TestRoot, testProject.Name));
publishCommand
.Execute(RuntimeIdentifier)
.Should().Pass()
.And.HaveStdOutContaining("(9,9): warning IL3050")
.And.HaveStdOutContaining("(20,12): warning IL3052");
.And.HaveStdOutContaining("warning IL3050")
.And.HaveStdOutContaining("warning IL3052")
.And.NotHaveStdOutContaining("warning IL2026")
.And.NotHaveStdOutContaining("warning IL3002");
}

[RequiresMSBuildVersionTheory("17.0.0.32901")]
[InlineData(LatestTfm)]
public void ILLink_linker_warnings_not_produced_if_not_set(string targetFramework)
public void Requires_analyzers_produce_warnings_without_PublishAot_being_set(string targetFramework)
{
var projectName = "ILLinkAotAnalyzerWarningsApp";
var testProject = CreateTestProjectWithAotAnalyzerWarnings(targetFramework, projectName, true);
// Inactive linker settings should have no effect on the aot analyzer,
// unless PublishTrimmed is also set.
testProject.AdditionalProperties["EnableAotAnalyzer"] = "true";
testProject.AdditionalProperties["SuppressTrimAnalysisWarnings"] = "false";
var testAsset = _testAssetsManager.CreateTestProject(testProject);
if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows) || RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
{
var projectName = "WarningAppWithRequiresAnalyzers";
var rid = EnvironmentInfo.GetCompatibleRid(targetFramework);

var publishCommand = new PublishCommand(Log, Path.Combine(testAsset.TestRoot, testProject.Name));
publishCommand
.Execute(RuntimeIdentifier)
.Should().Pass()
.And.NotHaveStdOutContaining("IL2026");
// Enable the different requires analyzers (EnableAotAnalyzer, EnableTrimAnalyzer
// and EnableSingleFileAnalyzer) without setting PublishAot
var testProject = CreateTestProjectWithAnalysisWarnings(targetFramework, projectName, true);
testProject.AdditionalProperties["EnableAotAnalyzer"] = "true";
testProject.AdditionalProperties["EnableTrimAnalyzer"] = "true";
testProject.AdditionalProperties["EnableSingleFileAnalyzer"] = "true";
testProject.AdditionalProperties["SuppressTrimAnalysisWarnings"] = "false";
testProject.AdditionalProperties["RuntimeIdentifier"] = rid;
var testAsset = _testAssetsManager.CreateTestProject(testProject);

var publishCommand = new PublishCommand(Log, Path.Combine(testAsset.TestRoot, testProject.Name));
publishCommand
.Execute()
.Should().Pass()
.And.HaveStdOutContaining("warning IL3050")
.And.HaveStdOutContaining("warning IL3052")
.And.HaveStdOutContaining("warning IL2026")
.And.HaveStdOutContaining("warning IL3002");
}
}

[RequiresMSBuildVersionTheory("17.0.0.32901")]
[InlineData(LatestTfm)]
public void NativeAot_only_runs_when_switch_is_enabled(string targetFramework)
public void NativeAot_compiler_runs_when_PublishAot_is_enabled(string targetFramework)
{
if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows) || RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
{
var projectName = "AotPublishWithWarnings";
var projectName = "WarningAppWithPublishAot";
var rid = EnvironmentInfo.GetCompatibleRid(targetFramework);

// PublishAot should enable the EnableAotAnalyzer
var testProject = CreateTestProjectWithAotAnalyzerWarnings(targetFramework, projectName, true);
// PublishAot should enable the EnableAotAnalyzer, EnableTrimAnalyzer and EnableSingleFileAnalyzer
var testProject = CreateTestProjectWithAnalysisWarnings(targetFramework, projectName, true);
testProject.AdditionalProperties["PublishAot"] = "true";
testProject.AdditionalProperties["SuppressTrimAnalysisWarnings"] = "false";
testProject.AdditionalProperties["RuntimeIdentifier"] = rid;
var testAsset = _testAssetsManager.CreateTestProject(testProject);

var publishCommand = new PublishCommand(Log, Path.Combine(testAsset.TestRoot, testProject.Name));
publishCommand
.Execute()
.Should().Pass()
.And.HaveStdOutContaining("warning IL3050");
.And.HaveStdOutContaining("warning IL3050")
.And.HaveStdOutContaining("warning IL3052")
.And.HaveStdOutContaining("warning IL2026")
.And.HaveStdOutContaining("warning IL3002");

var publishDirectory = publishCommand.GetOutputDirectory(targetFramework: targetFramework, runtimeIdentifier: rid);

Expand All @@ -97,7 +117,48 @@ public void NativeAot_only_runs_when_switch_is_enabled(string targetFramework)

var command = new RunExeCommand(Log, publishedExe)
.Execute().Should().Pass()
.And.HaveStdOutContaining("Hello world");
.And.HaveStdOutContaining("Hello world");
}
}

[RequiresMSBuildVersionTheory("17.0.0.32901")]
[InlineData(LatestTfm)]
public void Warnings_are_generated_even_with_analyzers_disabled(string targetFramework)
{
if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows) || RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
{
var projectName = "WarningAppWithPublishAotAnalyzersDisabled";
var rid = EnvironmentInfo.GetCompatibleRid(targetFramework);

// PublishAot enables the EnableAotAnalyzer, EnableTrimAnalyzer and EnableSingleFileAnalyzer
// only if they don't have a predefined value
var testProject = CreateTestProjectWithAnalysisWarnings(targetFramework, projectName, true);
testProject.AdditionalProperties["PublishAot"] = "true";
testProject.AdditionalProperties["EnableAotAnalyzer"] = "false";
testProject.AdditionalProperties["EnableTrimAnalyzer"] = "false";
testProject.AdditionalProperties["EnableSingleFileAnalyzer"] = "false";
testProject.AdditionalProperties["SuppressTrimAnalysisWarnings"] = "false";
testProject.AdditionalProperties["RuntimeIdentifier"] = rid;
var testAsset = _testAssetsManager.CreateTestProject(testProject);

var publishCommand = new PublishCommand(Log, Path.Combine(testAsset.TestRoot, testProject.Name));
publishCommand
.Execute()
.Should().Pass()
.And.HaveStdOutContaining("warning IL3050")
.And.HaveStdOutContaining("warning IL2026");

var publishDirectory = publishCommand.GetOutputDirectory(targetFramework: targetFramework, runtimeIdentifier: rid);

var publishedExe = Path.Combine(publishDirectory.FullName, $"{testProject.Name}{Constants.ExeSuffix}");

// The exe exist and should be native
File.Exists(publishedExe).Should().BeTrue();
IsNativeImage(publishedExe).Should().BeTrue();

var command = new RunExeCommand(Log, publishedExe)
.Execute().Should().Pass()
.And.HaveStdOutContaining("Hello world");
}
}

Expand Down Expand Up @@ -163,7 +224,7 @@ public void NativeAotSharedLib_only_runs_when_switch_is_enabled(string targetFra
}
}

private TestProject CreateTestProjectWithAotAnalyzerWarnings(string targetFramework, string projectName, bool isExecutable)
private TestProject CreateTestProjectWithAnalysisWarnings(string targetFramework, string projectName, bool isExecutable)
{
var testProject = new TestProject()
{
Expand All @@ -181,7 +242,8 @@ class C
static void Main()
{
ProduceAotAnalysisWarning();
ProduceLinkerAnalysisWarning();
ProduceTrimAnalysisWarning();
ProduceSingleFileAnalysisWarning();
Console.WriteLine(""Hello world"");
}

Expand All @@ -195,8 +257,13 @@ static C()
{
}

[RequiresUnreferencedCode(""Linker analysis warning"")]
static void ProduceLinkerAnalysisWarning()
[RequiresUnreferencedCode(""Trim analysis warning"")]
static void ProduceTrimAnalysisWarning()
{
}

[RequiresAssemblyFiles(""Single File analysis warning"")]
static void ProduceSingleFileAnalysisWarning()
{
}
}";
Expand Down