配置 MSTest

MSTest 又称 Microsoft Testing Framework，是适用于 .NET 应用程序的测试框架。 该测试框架允许编写和执行测试，并提供与 Visual Studio 和 Visual Studio Code 测试资源管理器、.NET CLI 和许多 CI 管道集成的测试套件。

MSTest 是一个完全受支持的开放源代码和跨平台测试框架，适用于 GitHub 上托管的所有支持的 .NET 目标（.NET Framework、.NET Core、.NET、UWP、WinUI 等）。

Runsettings（运行设置）

.runsettings 文件可用于配置单元测试的运行方式。 若要详细了解与平台相关的 runsettings 和配置，可以查看 VSTest runsettings 文档 或 MSTest 运行程序 runsettings 文档。

MSTest 元素

以下 runsettings 条目允许您配置 MSTest 的行为方式。

TestRunParameter 元素

<TestRunParameters>
    <Parameter name="webAppUrl" value="http://localhost" />
</TestRunParameters>

测试运行参数提供了一种方法来定义运行时测试可用的变量和值。 使用 MSTest TestContext.Properties 属性访问参数：

private string _appUrl;
public TestContext TestContext { get; set; }

[TestMethod]
public void HomePageTest()
{
    string _appUrl = TestContext.Properties["webAppUrl"];
}

若要使用测试运行参数，请将公共 TestContext 属性添加到测试类。

.runsettings 文件示例

以下 XML 显示典型 .runsettings 文件的内容。 复制此代码并对其进行编辑以满足需求。

文件的每个元素都是可选的，因为它有默认值。

<?xml version="1.0" encoding="utf-8"?>
<RunSettings>

  <!-- Parameters used by tests at runtime -->
  <TestRunParameters>
    <Parameter name="webAppUrl" value="http://localhost" />
    <Parameter name="webAppUserName" value="Admin" />
    <Parameter name="webAppPassword" value="Password" />
  </TestRunParameters>

  <!-- MSTest -->
  <MSTest>
    <MapInconclusiveToFailed>True</MapInconclusiveToFailed>
    <CaptureTraceOutput>false</CaptureTraceOutput>
    <DeleteDeploymentDirectoryAfterTestRunIsComplete>False</DeleteDeploymentDirectoryAfterTestRunIsComplete>
    <DeploymentEnabled>False</DeploymentEnabled>
    <ConsiderFixturesAsSpecialTests>False</ConsiderFixturesAsSpecialTests>
    <AssemblyResolution>
      <Directory path="D:\myfolder\bin\" includeSubDirectories="false"/>
    </AssemblyResolution>
  </MSTest>

</RunSettings>

testconfig.json

使用 MSTest 运行测试时，可以使用 testconfig.json 文件来配置测试运行程序的行为。 testconfig.json 文件是一个 JSON 文件，其中包含测试运行程序的配置设置。 该文件用于配置测试运行程序和测试执行环境。 有关详细信息，请参阅 MTP testconfig.json 文档。

从 MSTest 3.7 开始，还可以在同一配置文件中配置 MSTest 运行。 以下部分介绍可在 testconfig.json 文件中使用的设置。

MSTest 元素

MSTest 设置按以下各节中所述的功能进行分组。

assemblyResolution 设置

本节中的所有设置都属于 assemblyResolution 元素。

示例：

{
  "mstest": {
    "assemblyResolution": {
        { "path": "...", "includeSubDirectories": "true/false" }
    }
  }
}

deployment 设置

本节中的所有设置都属于 deployment 元素。

示例：

{
  "mstest": {
    "deployment": {
        "deleteDeploymentDirectoryAfterTestRunIsComplete": true,
        "deployTestSourceDependencies": true,
        "enabled": true
    }
  }
}

output 设置

本节中的所有设置都属于 output 元素。

示例：

{
  "mstest": {
    "output": {
        "captureTrace": false
    }
  }
}

parallelism 设置

本节中的所有设置都属于 parallelism 元素。

示例：

{
  "mstest": {
    "parallelism": {
        "enabled": true,
        "scope": "method",
        "workers": 32
    }
  }
}

execution 设置

本节中的所有设置都属于 execution 元素。

示例：

{
  "mstest": {
    "execution": {
        "considerEmptyDataSourceAsInconclusive": false,
        "considerFixturesAsSpecialTests": false,
        "mapInconclusiveToFailed": true,
        "mapNotRunnableToFailed": true,
        "treatClassAndAssemblyCleanupWarningsAsErrors": false,
        "treatDiscoveryWarningsAsErrors": false
    }
  }
}

timeout 设置

本节中的所有设置都属于 timeout 元素。

示例：

{
  "mstest": {
    "timeout": {
        "assemblyCleanup": 0,
        "assemblyInitialize": 0,
        "classCleanup": 0,
        "classInitialize": 0,
        "test": 0,
        "testCleanup": 0,
        "testInitialize": 0,
        "useCooperativeCancellation": false
    }
  }
}

示例 testconfig.json 文件

以下 JSON 显示了典型 .testconfig.json 文件的内容。 复制此代码并对其进行编辑以满足需求。

文件的每个元素都是可选的，因为它有默认值。

{
  "platformOptions": {
    "resultDirectory": "./TestResults"
  },
  "mstest": {
    "execution": {
        "mapInconclusiveToFailed": true,
        "disableAppDomain": true,
        "considerFixturesAsSpecialTests": false
    },
    "parallelism": {
        "enabled": true,
        "scope": "method"
    },
    "output": {
        "captureTrace": false
    }
  }
}

MSBuild 属性

从 MSTest 4.3 开始，无需编写 [assembly: Parallelize] 特性，即可通过项目文件或 Directory.Build.props 选择启用程序集级并行执行。 这些属性在生成过程中发出相应的程序集属性，因此它们必须是 GenerateAssemblyInfotrue （SDK 样式项目的默认值）。

以下示例为每个导入 Directory.Build.props 文件的测试项目启用方法级并行化，并设置四个工作线程：

<Project>
  <PropertyGroup>
    <MSTestParallelizeScope>MethodLevel</MSTestParallelizeScope>
    <MSTestParallelizeWorkers>4</MSTestParallelizeWorkers>
  </PropertyGroup>
</Project>