通过

教程：测试自定义任务

  • 项目

可以使用 Visual Studio 中的单元测试功能以在分发之前测试 MSBuild 自定义任务，从而确保代码的正确性。 有关执行测试和基本测试工具的好处的信息，请参阅有关单元测试的基础知识。 在本教程中，你将使用其他 MSBuild 自定义任务教程中使用的代码示例。 这些教程中使用的以下项目位于 GitHub 上，其中包括 MSBuild 自定义任务的单元测试和集成测试：

单元测试

MSBuild 自定义任务是继承自 Task 的类（直接或间接，因为 ToolTask 继承自 Task）。 执行与任务关联的操作的方法为 Execute()。 此方法采用一些输入值（参数），并且具有可使用断言测试有效性的输出参数。 在这种情况下，一些输入参数是文件的路径，因此此示例在名为 Resources 的文件夹中具有测试输入文件。 此 MSBuild 任务也会生成文件，因此测试断言生成的文件。

需要生成引擎，它是实现 IBuildEngine 的类。 在本示例中，使用 Moq 进行模拟，但可以使用其他模拟工具。 该示例收集错误，但你可以收集其他信息，然后对其进行断言。

所有测试都需要 Engine 模拟，因此它作为 TestInitialize 包括在内（在每个测试之前执行，并且每个测试都有自己的生成引擎）。

有关完整代码，请参阅 GitHub 上的 .NET 示例存储库中的 AppSettingStronglyTypedTest.cs。

  1. 创建任务并将参数作为测试安排的一部分进行设置：

        private Mock<IBuildEngine> buildEngine;
    private List<BuildErrorEventArgs> errors;

     [TestInitialize()]
     public void Startup()
     {
         buildEngine = new Mock<IBuildEngine>();
         errors = new List<BuildErrorEventArgs>();
         buildEngine.Setup(x => x.LogErrorEvent(It.IsAny<BuildErrorEventArgs>())).Callback<BuildErrorEventArgs>(e => errors.Add(e));
     }

  2. 创建 ITaskItem 参数模拟（使用 Moq），并指向要分析的文件。 然后，使用它的参数创建 AppSettingStronglyTyped 自定义任务。 最后，将生成引擎设置为 MSBuild 自定义任务：

    //Arrange
var item = new Mock<ITaskItem>();
item.Setup(x => x.GetMetadata("Identity")).Returns($".\\Resources\\complete-prop.setting");

var appSettingStronglyTyped = new AppSettingStronglyTyped { SettingClassName = "MyCompletePropSetting", SettingNamespaceName = "MyNamespace", SettingFiles = new[] { item.Object } };

appSettingStronglyTyped.BuildEngine = buildEngine.Object;

    然后，执行任务代码以执行实际任务操作：

     //Act
 var success = appSettingStronglyTyped.Execute();

  3. 最后，断言测试的预期结果：

    //Assert
Assert.IsTrue(success); // The execution was success
Assert.AreEqual(errors.Count, 0); //Not error were found
Assert.AreEqual($"MyCompletePropSetting.generated.cs", appSettingStronglyTyped.ClassNameFile); // The Task expected output
Assert.AreEqual(true, File.Exists(appSettingStronglyTyped.ClassNameFile)); // The file was generated
Assert.IsTrue(File.ReadLines(appSettingStronglyTyped.ClassNameFile).SequenceEqual(File.ReadLines(".\\Resources\\complete-prop-class.txt"))); // Assenting the file content

  4. 其他测试遵循此模式并扩大所有可能性。

注意

生成文件时，需要针对每个测试使用不同的文件名以避免冲突。 请记得删除生成的文件作为测试清理。

集成测试

单元测试很重要，但还需要在真实的生成上下文中测试自定义 MSBuild 任务。

System.Diagnostics.Process 类提供对本地和远程进程的访问权限并使你能够启动和停止本地系统进程。 此示例使用测试 MSBuild 文件对单元测试运行生成。

  1. 测试代码需要初始化每个测试的执行上下文。 请注意确保 dotnet 命令的路径对于你的环境是准确的。 此处是完整示例。

         public const string MSBUILD = "C:\\Program Files\\dotnet\\dotnet.exe";

     private Process buildProcess;
     private List<string> output;

     [TestInitialize()]
     public void Startup()
     {
         output = new List<string>();
         buildProcess = new Process();
         buildProcess.StartInfo.FileName = MSBUILD;
         buildProcess.StartInfo.WindowStyle = ProcessWindowStyle.Hidden;
         buildProcess.StartInfo.CreateNoWindow = true;
         buildProcess.StartInfo.RedirectStandardOutput = true;
     }

  2. 清理时，测试需要完成该过程：

        [TestCleanup()]
     public void Cleanup()
     {
         buildProcess.Close();
     }

  3. 现在，创建每个测试。 每个测试都需要执行自己的 MSBuild 文件定义。 例如 testscript-success.msbuild。 若要了解该文件，请参阅教程：创建自定义任务。

    <Project Sdk="Microsoft.NET.Sdk">
    <UsingTask TaskName="AppSettingStronglyTyped.AppSettingStronglyTyped" AssemblyFile="..\AppSettingStronglyTyped.dll" />
    <PropertyGroup>
        <TargetFramework>netstandard2.1</TargetFramework>
    </PropertyGroup>

    <PropertyGroup>
        <SettingClass>MySettingSuccess</SettingClass>
        <SettingNamespace>example</SettingNamespace>
    </PropertyGroup>

    <ItemGroup>
        <SettingFiles Include="complete-prop.setting" />
    </ItemGroup>

    <Target Name="generateSettingClass">
        <AppSettingStronglyTyped SettingClassName="$(SettingClass)" SettingNamespaceName="$(SettingNamespace)" SettingFiles="@(SettingFiles)">
            <Output TaskParameter="ClassNameFile" PropertyName="SettingClassFileName" />
        </AppSettingStronglyTyped>
    </Target>
</Project>

  4. 测试参数提供生成此 MSBuild 文件的说明：

     //Arrange
 buildProcess.StartInfo.Arguments = "build .\\Resources\\testscript-success.msbuild /t:generateSettingClass";

  5. 执行并获取输出：

    //Act
ExecuteCommandAndCollectResults();

    其中 ExecuteCommandAndCollectResults() 定义为：

    private void ExecuteCommandAndCollectResults()
{
     buildProcess.Start();
     while (!buildProcess.StandardOutput.EndOfStream)
     {
         output.Add(buildProcess.StandardOutput.ReadLine() ?? string.Empty);
     }
     buildProcess.WaitForExit();
}

  6. 最后，评估预期结果：

    //Assert
Assert.AreEqual(0, buildProcess.ExitCode); //Finished success
Assert.IsTrue(File.Exists(".\\Resources\\MySettingSuccess.generated.cs")); // the expected resource was generated
Assert.IsTrue(File.ReadLines(".\\Resources\\MySettingSuccess.generated.cs").SequenceEqual(File.ReadLines(".\\Resources\\testscript-success-class.txt"))); // asserting the file content

结论

单元测试很有用，因为你可以测试和调试代码以确保每个特定代码段的正确性，但集成测试对于确保任务在真实的生成上下文中执行非常重要。 在本教程中，你了解了如何测试 MSBuild 自定义任务。

后续步骤

创建用于执行 REST API 代码生成的更为复杂的自定义任务。

使用 MSBuild 生成 REST API 客户端