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

Localize the text in the common target #10388

Merged
merged 15 commits into from
Dec 5, 2024
Merged

Localize the text in the common target #10388

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
4bebe67
Localize the text in the common target
JaynieBai Jul 17, 2024
1bdbe16
Merge branch 'main' of https://github.com/dotnet/msbuild into jennyba…
JaynieBai Jul 17, 2024
273d6fb
Merge branch 'main' of https://github.com/dotnet/msbuild into jennyba…
JaynieBai Aug 19, 2024
ba98677
Add missing resource name
JaynieBai Aug 19, 2024
c6fd669
Refactor the code
JaynieBai Aug 20, 2024
d8a3244
Fix the typo error
JaynieBai Aug 21, 2024
2ef73ef
Fix typo error
JaynieBai Aug 21, 2024
2908899
Fix wrong words
JaynieBai Aug 21, 2024
0dacce6
Add deleted line
JaynieBai Aug 21, 2024
cf422dd
Merge branch 'main' of https://github.com/dotnet/msbuild into jennyba…
JaynieBai Nov 12, 2024
fcdad1e
Add test cases
JaynieBai Nov 27, 2024
a1183e8
Merge branch 'main' into jennybai/issue#10171
JaynieBai Nov 27, 2024
e688ea6
lower the test case parameter name first letter
JaynieBai Nov 27, 2024
22e6459
Merge branch 'jennybai/issue#10171' of https://github.com/JaynieBai/m…
JaynieBai Nov 27, 2024
6c73528
Add code in the comments and fix style init
JaynieBai Dec 2, 2024
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
233 changes: 231 additions & 2 deletions src/Tasks.UnitTests/MSBuildInternalMessage_Tests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.IO;
using Microsoft.Build.Evaluation;
using Microsoft.Build.Shared;
using Microsoft.Build.UnitTests;
Expand All @@ -17,8 +18,8 @@ public class MSBuildInternalMessage_Tests
public MSBuildInternalMessage_Tests(ITestOutputHelper testOutput) => _testOutput = testOutput;

[Theory]
[InlineData(true, true, "CommonTarget.Prefer32BitAndPreferNativeArm64Enabled", false)]
[InlineData(false, false, "CommonTarget.PlatformIsAnyCPUAndPreferNativeArm64Enabled", true, new[] { "Release" })]
[InlineData(true, true, "CommonSdk.Prefer32BitAndPreferNativeArm64Enabled", false)]
[InlineData(false, false, "CommonSdk.PlatformIsAnyCPUAndPreferNativeArm64Enabled", true, new[] { "Release" })]
public void E2EScenarioTests(bool prefer32, bool isPlatformAnyCpu, string expectedResourceName, bool isNetWarningExpected, string[]? formatArgs = null)
{
using (TestEnvironment env = TestEnvironment.Create())
Expand Down Expand Up @@ -59,5 +60,233 @@ public void E2EScenarioTests(bool prefer32, bool isPlatformAnyCpu, string expect
}
}
}

[Theory]
[InlineData(true, "CommonSdk.BaseIntermediateOutputPathMismatchWarning")]
[InlineData(false, "CommonSdk.MSBuildProjectExtensionsPathModifiedAfterUse")]

public void BaseIntermediateOutputPathMisMatchWarning(bool IsInitialMSBuildProjectExtensionsPathEmpty, string expectedResourceName)
JaynieBai marked this conversation as resolved.
Show resolved Hide resolved
{
using (TestEnvironment env = TestEnvironment.Create())
{
var outputPath = env.CreateFolder().Path;
string projectContent = $"""
<Project>
<Import Project="$(MSBuildBinPath)\Microsoft.Common.props" />

<PropertyGroup>
<EnableBaseIntermediateOutputPathMismatchWarning>true</EnableBaseIntermediateOutputPathMismatchWarning>
<_InitialMSBuildProjectExtensionsPath>{(IsInitialMSBuildProjectExtensionsPathEmpty ? "" : "obj")}</_InitialMSBuildProjectExtensionsPath>
JaynieBai marked this conversation as resolved.
Show resolved Hide resolved
<MSBuildProjectExtensionsPath></MSBuildProjectExtensionsPath>
<BaseIntermediateOutputPath>obj\Debug\</BaseIntermediateOutputPath>
</PropertyGroup>

<Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
</Project>
""";

var projectFile = env.CreateFile(env.CreateFolder(), "test.csproj", projectContent).Path;
Project project = ObjectModelHelpers.LoadProjectFileInTempProjectDirectory(projectFile, touchProject: false);

string expectedBuildMessage = ResourceUtilities.FormatResourceStringStripCodeAndKeyword(expectedResourceName);
MockLogger logger = new MockLogger(_testOutput);

project.Build(logger);
if (!IsInitialMSBuildProjectExtensionsPathEmpty)
JaynieBai marked this conversation as resolved.
Show resolved Hide resolved
{
logger.Errors[0].RawMessage.ShouldBe(expectedBuildMessage);
}
else
{
logger.Warnings[0].RawMessage.ShouldBe(expectedBuildMessage);
}
}
}

[Theory]
[InlineData("SetGenerateManifests", "CommonSdk.GenerateManifestsOnlyForExe", false)]
[InlineData("SetGenerateManifests", "CommonSdk.SigningKeyRequired", true)]
[InlineData("_DeploymentUnpublishable", "CommonSdk.DeploymentUnpublishable")]
[InlineData("Run", "CommonSdk.RunTargetDependsOnMessage")]
[InlineData("GetTargetFrameworks", "CommonSdk.CrossTargetingGetTargetFrameworks")]
[InlineData("ResolveProjectReferences", "CommonSdk.NonExistentProjectReference")]
[InlineData("ResolveProjectReferences", "CommonSdk.NonExistentProjectReference", true, false)]
public void RunTargetExtError(string targetName, string expectedResourceName, bool outputTypeIsExe = true, bool errorOnMissingProjectReference = true)
{
using (TestEnvironment env = TestEnvironment.Create())
{
var outputPath = env.CreateFolder().Path;
string projectContent = $"""
<Project DefaultTargets="{targetName}">
<Import Project="$(MSBuildBinPath)\Microsoft.Common.props" />

<PropertyGroup>
<TargetExt>.txt</TargetExt>
<OutputPath>bin</OutputPath>
<OutputType>{(outputTypeIsExe ? "" : "txt")}</OutputType>
<_DeploymentSignClickOnceManifests>true</_DeploymentSignClickOnceManifests>
<ManifestCertificateThumbprint></ManifestCertificateThumbprint>
<ManifestKeyFile></ManifestKeyFile>
<TargetFrameworks>netcoreapp3.1;net6.0;net7.0</TargetFrameworks>
<ErrorOnMissingProjectReference>{errorOnMissingProjectReference}</ErrorOnMissingProjectReference>
</PropertyGroup>

<ItemGroup>
<ProjectReference Include="NonExistent.csproj" />
</ItemGroup>

<Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets"/>

</Project>
""";

var projectFile = env.CreateFile(env.CreateFolder(), "test.csproj", projectContent).Path;
Project project = ObjectModelHelpers.LoadProjectFileInTempProjectDirectory(projectFile, touchProject: false);

MockLogger logger = new MockLogger(_testOutput);

string expectedBuildMessage = ResourceUtilities.FormatResourceStringStripCodeAndKeyword(expectedResourceName);

project.Build(logger);
if (expectedResourceName == "CommonSdk.DeploymentUnpublishable")
{
logger.FullLog.Contains(expectedBuildMessage);
}
else if (expectedResourceName == "CommonSdk.RunTargetDependsOnMessage")
{
var targetPathParameter = expectedResourceName == "CommonSdk.DeploymentUnpublishable" ? "" : Path.Combine(project.DirectoryPath, "bin", "test.txt");
expectedBuildMessage = ResourceUtilities.FormatResourceStringStripCodeAndKeyword(expectedResourceName, targetPathParameter);
logger.Errors[0].RawMessage.ShouldBe(expectedBuildMessage);
}
else if (expectedResourceName == "CommonSdk.NonExistentProjectReference")
{
expectedBuildMessage = ResourceUtilities.FormatResourceStringStripCodeAndKeyword(expectedResourceName, "NonExistent.csproj");
if (errorOnMissingProjectReference)
{
logger.Errors[0].RawMessage.ShouldBe(expectedBuildMessage);
}
else
{
logger.Warnings[0].RawMessage.ShouldBe(expectedBuildMessage);
}
}
else
{
logger.Errors[0].RawMessage.ShouldBe(expectedBuildMessage);
}
}
}

/// <summary>
/// SkipInvalidConfigurations is true, the output is warning, otherwise is error.
/// BuildingInsideVisualStudio is true, the resourceName is CommonSdk.InvalidConfigurationTextWhenBuildingInsideVisualStudio, otherwise is CommonSdk.InvalidConfigurationTextWhenBuildingOutsideVisualStudio
/// </summary>
/// <param name="expectedResourceName"></param>
/// <param name="skipInvalidConfigurations"></param>
/// <param name="buildingInsideVisualStudio"></param>
[Theory]
[InlineData("CommonSdk.InvalidConfigurationTextWhenBuildingInsideVisualStudio", false, true)]
[InlineData("CommonSdk.InvalidConfigurationTextWhenBuildingOutsideVisualStudio", true, false)]
[InlineData("CommonSdk.InvalidConfigurationTextWhenBuildingOutsideVisualStudio", false, false)]
[InlineData("CommonSdk.InvalidConfigurationTextWhenBuildingInsideVisualStudio", true, true)]
public void CheckForInvalidConfigurationAndPlatformTargetMessage(string expectedResourceName, bool skipInvalidConfigurations, bool buildingInsideVisualStudio)
{
using (TestEnvironment env = TestEnvironment.Create())
{
var outputPath = env.CreateFolder().Path;
var fileName = "test.csproj";
var configuration = "Release";
var platform = "Release";
string projectContent = $"""
<Project DefaultTargets="Build">
<Import Project="$(MSBuildBinPath)\Microsoft.Common.props" />

<PropertyGroup>
<SkipInvalidConfigurations>{skipInvalidConfigurations}</SkipInvalidConfigurations>
<BuildingInsideVisualStudio>{buildingInsideVisualStudio}</BuildingInsideVisualStudio>
<BaseOutputPathWasSpecified>false</BaseOutputPathWasSpecified>
<_OutputPathWasMissing>true</_OutputPathWasMissing>
<Configuration>{configuration}</Configuration>
<Platform>{platform}</Platform>
</PropertyGroup>

<Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets"/>

</Project>
""";

var projectFile = env.CreateFile(env.CreateFolder(), fileName, projectContent).Path;
Project project = ObjectModelHelpers.LoadProjectFileInTempProjectDirectory(projectFile, touchProject: false);

MockLogger logger = new MockLogger(_testOutput);

string expectedBuildMessage = ResourceUtilities.FormatResourceStringStripCodeAndKeyword(expectedResourceName, fileName, configuration, platform);

project.Build(logger);
if (skipInvalidConfigurations)
{
logger.Warnings[0].RawMessage.ShouldBe(expectedBuildMessage);
}
else
{
logger.Errors[0].RawMessage.ShouldBe(expectedBuildMessage);
}
}
}

[Theory]
[InlineData("MSB9000", "ResxWithNoCulture", "SplitResourcesByCulture", "CommonSdk.SplitResourcesByCultureEmbeddedResourceMessage"),]
[InlineData("MSB9001", "ResxWithCulture", "SplitResourcesByCulture", "CommonSdk.SplitResourcesByCultureEmbeddedResourceMessage")]
[InlineData("MSB9002", "NonResxWithCulture", "SplitResourcesByCulture", "CommonSdk.SplitResourcesByCultureEmbeddedResourceMessage")]
[InlineData("MSB9003", "NonResxWithNoCulture", "SplitResourcesByCulture", "CommonSdk.SplitResourcesByCultureEmbeddedResourceMessage")]
[InlineData("MSB9004", "ManifestResourceWithNoCulture", "_GenerateCompileInputs", "CommonSdk.ManifestResourceWithNoCultureWarning")]
[InlineData("MSB9005", "ManifestNonResxWithNoCultureOnDisk", "_GenerateCompileInputs", "CommonSdk.ManifestResourceWithNoCultureWarning")]
[InlineData("MSB9006", "ManifestResourceWithCulture", "_GenerateSatelliteAssemblyInputs", "CommonSdk.ManifestResourceWithNoCultureWarning")]
[InlineData("MSB9007", "ManifestNonResxWithCultureOnDisk", "_GenerateSatelliteAssemblyInputs", "CommonSdk.ManifestResourceWithNoCultureWarning")]
public void ResourcesByCultureWarningMessage(string warningNumber, string itemName, string targetName, string resourceName)
{
using (TestEnvironment env = TestEnvironment.Create())
{
var outputPath = env.CreateFolder().Path;
string projectContent = $"""
<Project DefaultTargets="{targetName}">
<Import Project="$(MSBuildBinPath)\Microsoft.Common.props" />

<ItemGroup>
<{itemName} Include="Value1" />
</ItemGroup>

<Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets"/>
</Project>
""";

var projectFile = env.CreateFile(env.CreateFolder(), "test.csproj", projectContent).Path;
Project project = ObjectModelHelpers.LoadProjectFileInTempProjectDirectory(projectFile, touchProject: false);

MockLogger logger = new MockLogger(_testOutput);
object[] args = [warningNumber, itemName];
if (warningNumber == "MSB9004")
{
args = [warningNumber, itemName, "false", "Resx"];
}
else if (warningNumber == "MSB9005")
{
args = [warningNumber, itemName, "false", "Non-Resx"];
}
else if (warningNumber == "MSB9006")
{
args = [warningNumber, itemName, "true", "Resx"];
}
else if (warningNumber == "MSB9007")
{
args = [warningNumber, itemName, "true", "Non-Resx"];
}

string expectedBuildMessage = ResourceUtilities.FormatResourceStringStripCodeAndKeyword(resourceName, args);

project.Build(logger);
logger.Warnings[0].RawMessage.ShouldBe(expectedBuildMessage);
}
}
}
}
2 changes: 1 addition & 1 deletion src/Tasks/MSBuildInternalMessage.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public override bool Execute()
}
}

Log.LogErrorFromResources("CommonTarget.SpecifiedSeverityDoesNotExist", Severity);
Log.LogErrorFromResources("CommonSdk.SpecifiedSeverityDoesNotExist", Severity);

return !Log.HasLoggedErrors;
}
Expand Down
Loading