Document MSTest analyzers MSTEST0051-MSTEST0055

[Copilot]

Summary

This PR adds comprehensive documentation for five new MSTest analyzer rules (MSTEST0051 through MSTEST0055) that were introduced in MSTest 3.10.0.

Changes

New Documentation Files

Created documentation for the following analyzers:

1. MSTEST0051: Assert.Throws should contain a single statement

   • Ensures that Assert.Throws, Assert.ThrowsAsync, Assert.ThrowsExactly, and Assert.ThrowsExactlyAsync methods contain exactly one statement in the action delegate to avoid ambiguous test results
   • Severity: Info

2. MSTEST0052: Prefer DynamicDataSourceType.AutoDetect

   • Recommends using the default DynamicDataSourceType.AutoDetect (introduced in MSTest 3.8) instead of explicitly specifying Property or Method for better maintainability
   • Severity: Warning
   • Has code fix

3. MSTEST0053: Avoid Assert method format parameters

   • Encourages using string interpolation instead of the legacy message format parameters in assertion methods for better compile-time safety and readability
   • Severity: Warning
   • Has code fix

4. MSTEST0054: Use cancellation token from TestContext.CancellationToken

   • Promotes using the TestContext.CancellationToken property instead of creating separate cancellation tokens to ensure proper integration with test timeouts and cooperative cancellation
   • Severity: Info

5. MSTEST0055: String method return value should not be ignored

   • Detects when string manipulation methods like ToUpper(), ToLower(), Trim(), Replace(), or Substring() are called without using their return values, which is always a bug due to string immutability
   • Severity: Warning

Updated Files

• usage-rules.md: Added entries for all five new analyzers in the usage rules table
• Updated ms.date to reflect the latest changes
• docs/navigate/devops-testing/toc.yml: Added TOC entries for all five new analyzers in the Usage section

Documentation Standards

All documentation files follow the established patterns:

• Consistent YAML frontmatter with proper metadata and ai-usage: ai-generated disclosure
• Standard structure: Cause, Rule description, How to fix violations, When to suppress warnings
• Proper xref links to MSTest and .NET API documentation
• Clear before/after code examples in C#
• Compliance with Microsoft Writing Style Guide

References

The implementations for these analyzers were added in the following PRs:

• Add analyzer to flag Assert.Throws with multiple statements (MSTEST0051) microsoft/testfx#6190
• Add analyzer for DynamicDataSourceType usage (MSTEST0052) microsoft/testfx#6261
• Add analyzer for Assert APIs with format parameters (MSTEST0053) microsoft/testfx#6294
• Add analyzer and codefix to move from TestContext.CancellationTokenSource.Token to TestContext.CancellationToken microsoft/testfx#6429
• Add analyzer for ignoring string method return values (MSTEST0055) microsoft/testfx#6482

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Document MSTEST0051-MSTEST0055</issue_title>
<issue_description>### Describe the issue or suggestion

Rule ID	Category	Severity	Notes
MSTEST0051	Usage	Info	AssertThrowsShouldContainSingleStatementAnalyzer, Documentation
MSTEST0052	Usage	Warning	PreferDynamicDataSourceTypeAutoDetectAnalyzer, Documentation
MSTEST0053	Usage	Warning	AvoidAssertFormatParametersAnalyzer, Documentation
MSTEST0054	Usage	Info	UseCancellationTokenPropertyAnalyzer, Documentation
MSTEST0055	Usage	Warning	IgnoreStringMethodReturnValueAnalyzer, Documentation

These need to be documented.</issue_description>

Comments on the Issue (you are @copilot in this section)

@Youssef1313 PRs that implemented these analyzers:

microsoft/testfx#6190
microsoft/testfx#6261
microsoft/testfx#6294
microsoft/testfx#6429
microsoft/testfx#6482</comment_new>

Fixes #48811

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

---

Internal previews

📄 File	🔗 Preview link
docs/core/testing/mstest-analyzers/mstest0051.md	MSTEST0051: Assert.Throws should contain only a single statement
docs/core/testing/mstest-analyzers/mstest0052.md	"MSTEST0052: Avoid passing an explicit 'DynamicDataSourceType' and use the default auto detect behavior"
docs/core/testing/mstest-analyzers/mstest0053.md	MSTEST0053: Avoid using Assert methods with format parameters
docs/core/testing/mstest-analyzers/mstest0054.md	MSTEST0054: Use cancellation token from TestContext.CancellationToken
docs/core/testing/mstest-analyzers/mstest0055.md	docs/core/testing/mstest-analyzers/mstest0055
docs/core/testing/mstest-analyzers/usage-rules.md	MSTest usage rules
docs/navigate/devops-testing/toc.yml	docs/navigate/devops-testing/toc

[Youssef1313]

@copilot Please update docs/navigate/devops-testing/toc.yml

[Copilot]

@copilot Please update docs/navigate/devops-testing/toc.yml

Updated in commit e883950. Added TOC entries for MSTEST0051, MSTEST0052, MSTEST0053, MSTEST0054, and MSTEST0055 to the Usage section.