dotnet
/
msbuild
зеркало из https://github.com/dotnet/msbuild.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Fix bug: No visible message when replaying analyzed build (#10265) 

* add BuildCheck.UnitTests to slnf

* add test for replaying binlog of analyzed build

* fixed buf for BuildCheckResultWarning

* changed the test for error case

* fixed bug for BuildCheckResultError

* set RawMessage for BuilCheck results instead of speacial casing in BuildEventArgsWriter

* remove using

* add skip back to the flaky test;
add skip to the new test
This commit is contained in:
Surayya Huseyn Zada 2024-06-20 14:28:24 +02:00 коммит произвёл GitHub
Родитель e1ff6dcf62
Коммит 856f50eee0
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: B5690EEEBB952194
3 изменённых файлов: 84 добавлений и 36 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

3
MSBuild.Dev.slnf
Просмотреть файл

@ -4,6 +4,7 @@
"projects": [
"src\\Build.OM.UnitTests\\Microsoft.Build.Engine.OM.UnitTests.csproj",
"src\\Build.UnitTests\\Microsoft.Build.Engine.UnitTests.csproj",
"src\\BuildCheck.UnitTests\\Microsoft.Build.BuildCheck.UnitTests.csproj",
"src\\Build\\Microsoft.Build.csproj",
"src\\Framework.UnitTests\\Microsoft.Build.Framework.UnitTests.csproj",
"src\\Framework\\Microsoft.Build.Framework.csproj",
@ -18,4 +19,4 @@
"src\\Xunit.NetCore.Extensions\\Xunit.NetCore.Extensions.csproj"
]
}
}
}

93
src/BuildCheck.UnitTests/EndToEndTests.cs
Просмотреть файл

@ -35,7 +35,76 @@ public class EndToEndTests : IDisposable
[InlineData(true, true)]
[InlineData(false, true)]
[InlineData(false, false)]
public void SampleAnalyzerIntegrationTest(bool buildInOutOfProcessNode, bool analysisRequested)
public void SampleAnalyzerIntegrationTest_AnalyzeOnBuild(bool buildInOutOfProcessNode, bool analysisRequested)
{
PrepareSampleProjectsAndConfig(buildInOutOfProcessNode, out TransientTestFile projectFile);
string output = RunnerUtilities.ExecBootstrapedMSBuild(
$"{Path.GetFileName(projectFile.Path)} /m:1 -nr:False -restore" +
(analysisRequested ? " -analyze" : string.Empty), out bool success, false, _env.Output, timeoutMilliseconds: 120_000);
_env.Output.WriteLine(output);
success.ShouldBeTrue();
// The analyzer warnings should appear - but only if analysis was requested.
if (analysisRequested)
{
output.ShouldContain("BC0101");
output.ShouldContain("BC0102");
}
else
{
output.ShouldNotContain("BC0101");
output.ShouldNotContain("BC0102");
}
}
[Theory(Skip = "https://github.com/dotnet/msbuild/issues/10036")]
[InlineData(true, true, "warning")]
[InlineData(true, true, "error")]
[InlineData(true, true, "info")]
[InlineData(false, true, "warning")]
[InlineData(false, true, "error")]
[InlineData(false, true, "info")]
[InlineData(false, false, "warning")]
public void SampleAnalyzerIntegrationTest_ReplayBinaryLogOfAnalyzedBuild(bool buildInOutOfProcessNode, bool analysisRequested, string BC0101Severity)
{
PrepareSampleProjectsAndConfig(buildInOutOfProcessNode, out TransientTestFile projectFile, BC0101Severity);
var projectDirectory = Path.GetDirectoryName(projectFile.Path);
string logFile = _env.ExpectFile(".binlog").Path;
RunnerUtilities.ExecBootstrapedMSBuild(
$"{Path.GetFileName(projectFile.Path)} /m:1 -nr:False -restore {(analysisRequested ? "-analyze" : string.Empty)} -bl:{logFile}",
out bool success, false, _env.Output, timeoutMilliseconds: 120_000);
success.ShouldBeTrue();
string output = RunnerUtilities.ExecBootstrapedMSBuild(
$"{logFile} -flp:logfile={Path.Combine(projectDirectory!, "logFile.log")};verbosity=diagnostic",
out success, false, _env.Output, timeoutMilliseconds: 120_000);
_env.Output.WriteLine(output);
success.ShouldBeTrue();
// The conflicting outputs warning appears - but only if analysis was requested
if (analysisRequested)
{
output.ShouldContain("BC0101");
output.ShouldContain("BC0102");
}
else
{
output.ShouldNotContain("BC0101");
output.ShouldNotContain("BC0102");
}
}
private void PrepareSampleProjectsAndConfig(
bool buildInOutOfProcessNode,
out TransientTestFile projectFile,
string BC0101Severity = "warning")
{
TransientTestFolder workFolder = _env.CreateFolder(createFolder: true);
TransientTestFile testFile = _env.CreateFile(workFolder, "somefile");
@ -87,16 +156,16 @@ public class EndToEndTests : IDisposable
</Project>
""";
TransientTestFile projectFile = _env.CreateFile(workFolder, "FooBar.csproj", contents);
projectFile = _env.CreateFile(workFolder, "FooBar.csproj", contents);
TransientTestFile projectFile2 = _env.CreateFile(workFolder, "FooBar-Copy.csproj", contents2);
TransientTestFile config = _env.CreateFile(workFolder, ".editorconfig",
"""
$"""
root=true
[*.csproj]
build_check.BC0101.IsEnabled=true
build_check.BC0101.Severity=warning
build_check.BC0101.Severity={BC0101Severity}
build_check.BC0102.IsEnabled=true
build_check.BC0102.Severity=warning
@ -116,22 +185,6 @@ public class EndToEndTests : IDisposable
_env.SetEnvironmentVariable("MSBUILDNOINPROCNODE", buildInOutOfProcessNode ? "1" : "0");
_env.SetEnvironmentVariable("MSBUILDLOGPROPERTIESANDITEMSAFTEREVALUATION", "1");
string output = RunnerUtilities.ExecBootstrapedMSBuild(
$"{Path.GetFileName(projectFile.Path)} /m:1 -nr:False -restore" +
(analysisRequested ? " -analyze" : string.Empty), out bool success, false, _env.Output, timeoutMilliseconds: 120_000);
_env.Output.WriteLine(output);
success.ShouldBeTrue();
// The analyzer warnings should appear - but only if analysis was requested.
if (analysisRequested)
{
output.ShouldContain("BC0101");
output.ShouldContain("BC0102");
}
else
{
output.ShouldNotContain("BC0101");
output.ShouldNotContain("BC0102");
}
}
[Theory]

24
src/Framework/BuildCheck/BuildCheckEventArgs.cs
Просмотреть файл

@ -109,7 +109,7 @@ internal sealed class BuildCheckResultWarning : BuildWarningEventArgs
{
public BuildCheckResultWarning(IBuildCheckResult result)
{
this.Message = result.FormatMessage();
RawMessage = result.FormatMessage();
}
internal BuildCheckResultWarning() { }
@ -118,24 +118,22 @@ internal sealed class BuildCheckResultWarning : BuildWarningEventArgs
{
base.WriteToStream(writer);
writer.Write(Message!);
writer.Write(RawMessage!);
}
internal override void CreateFromStream(BinaryReader reader, int version)
{
base.CreateFromStream(reader, version);
Message = reader.ReadString();
RawMessage = reader.ReadString();
}
public override string? Message { get; protected set; }
}
internal sealed class BuildCheckResultError : BuildErrorEventArgs
{
public BuildCheckResultError(IBuildCheckResult result)
{
this.Message = result.FormatMessage();
RawMessage = result.FormatMessage();
}
internal BuildCheckResultError() { }
@ -144,24 +142,22 @@ internal sealed class BuildCheckResultError : BuildErrorEventArgs
{
base.WriteToStream(writer);
writer.Write(Message!);
writer.Write(RawMessage!);
}
internal override void CreateFromStream(BinaryReader reader, int version)
{
base.CreateFromStream(reader, version);
Message = reader.ReadString();
RawMessage = reader.ReadString();
}
public override string? Message { get; protected set; }
}
internal sealed class BuildCheckResultMessage : BuildMessageEventArgs
{
public BuildCheckResultMessage(IBuildCheckResult result)
{
this.Message = result.FormatMessage();
RawMessage = result.FormatMessage();
}
internal BuildCheckResultMessage() { }
@ -170,15 +166,13 @@ internal sealed class BuildCheckResultMessage : BuildMessageEventArgs
{
base.WriteToStream(writer);
writer.Write(Message!);
writer.Write(RawMessage!);
}
internal override void CreateFromStream(BinaryReader reader, int version)
{
base.CreateFromStream(reader, version);
Message = reader.ReadString();
RawMessage = reader.ReadString();
}
public override string? Message { get; protected set; }
}