forked from dotnet/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
24009e4
commit 86dd781
Showing
6 changed files
with
529 additions
and
367 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
title: Getting started with MSTest | ||
description: Learn about how to install MSTest. | ||
author: Evangelink | ||
ms.author: amauryleve | ||
ms.date: 07/24/2024 | ||
--- | ||
|
||
# Getting started | ||
|
||
MSTest functionality is split into multiple NuGet packages: | ||
|
||
- [MSTest.TestFramework](https://www.nuget.org/packages/MSTest.TestFramework): Contains the attributes and classes that are used to define MSTest tests. | ||
- [MSTest.TestAdapter](https://www.nuget.org/packages/MSTest.TestAdapter): Contains the test adapter that discovers and runs MSTest tests. | ||
- [MSTest.Analyzer](https://www.nuget.org/packages/MSTest.Analyzer): Contains the analyzer that helps you write high-quality tests. | ||
|
||
We recommend that you don't install these packages directly into your test projects. Instead, you should install either: | ||
|
||
- [MSTest.Sdk](https://www.nuget.org/packages/MSTest.Sdk): A [MSBuild project SDK](/visualstudio/msbuild/how-to-use-project-sdk) that includes all the recommended packages and greatly simplifies all the boilerplate configuration. For more information, please refer to [MSTest SDK overview](./unit-testing-mstest-sdk.md). | ||
|
||
- the [MSTest](https://www.nuget.org/packages/MSTest) metapackage, which includes all recommended packages: `MSTest.TestFramework`, `MSTest.TestAdapter`, `MSTest.Analyzer` and `Microsoft.NET.Test.Sdk`. | ||
|
||
If you are creating a test infrastructure project that is intended to be used as an helper by multiple test projects, you should install the `MSTest.TestFramework` and `MSTest.Analyzers` packages directly into that project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: Running MSTest tests | ||
description: Learn about how to run MSTest tests. | ||
author: Evangelink | ||
ms.author: amauryleve | ||
ms.date: 07/24/2024 | ||
--- | ||
|
||
# Running tests | ||
|
||
There are several ways to run MSTest tests depending on your needs. You can run tests from an IDE (e.g. Visual Studio, Visual Studio Code, Rider...), from the command line, or from a CI service (e.g. Azure DevOps). | ||
|
||
Historically, MSTest relies on [VSTest](https://github.com/microsoft/vstest) for running tests in all contexts but starting with version 3.2.0, MSTest has its own [test runner](./unit-testing-mstest-runner-intro.md). This new runner is more lightweight and faster than VSTest, and it is the recommended way to run MSTest tests. |
31 changes: 31 additions & 0 deletions
31
docs/core/testing/unit-testing-mstest-writing-tests-assertions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
title: MSTest assertions | ||
description: Learn about MSTest assertions. | ||
author: Evangelink | ||
ms.author: amauryleve | ||
ms.date: 07/24/2024 | ||
--- | ||
|
||
# Assertions | ||
|
||
Use the Assert classes of the <xref:Microsoft.VisualStudio.TestTools.UnitTesting> namespace to verify specific functionality. A test method exercises the code of a method in your application's code, but it reports the correctness of the code's behavior only if you include Assert statements. | ||
|
||
## Assertions exceptions | ||
|
||
The <xref:Microsoft.VisualStudio.TestTools.UnitTesting.UnitTestAssertException> is the base of all assertion exceptions thrown by MSTest. If you write a new assert exception class, inherit from this base class to make it easier to identify the exception as an assertion failure instead of an unexpected exception thrown from your test or production code. | ||
|
||
The <xref:Microsoft.VisualStudio.TestTools.UnitTesting.AssertFailedException> exception is thrown whenever a test fails. A test fails if it times out, throws an unexpected exception, or contains an assert statement that produces a **Failed** result. | ||
|
||
The <xref:Microsoft.VisualStudio.TestTools.UnitTesting.AssertInconclusiveException> is thrown whenever a test produces an **Inconclusive** result. Typically, you add an <xref:Microsoft.VisualStudio.TestTools.UnitTesting.Assert.Inconclusive%2A?displayProperty=nameWithType> statement to a test that you are still working on, to indicate it's not yet ready to be run. This is also useful when you want to skip a test based on certain runtime conditions. | ||
|
||
## The `Assert` class | ||
|
||
In your test method, you can call any methods of the <xref:Microsoft.VisualStudio.TestTools.UnitTesting.Assert?displayProperty=fullName> class, such as <xref:Microsoft.VisualStudio.TestTools.UnitTesting.Assert.AreEqual%2A?displayProperty=nameWithType>. The <xref:Microsoft.VisualStudio.TestTools.UnitTesting.Assert> class has many methods to choose from, and many of the methods have several overloads. | ||
|
||
## The `StringAssert` class | ||
|
||
Use the <xref:Microsoft.VisualStudio.TestTools.UnitTesting.StringAssert> class to compare and examine strings. This class contains a variety of useful methods, such as <xref:Microsoft.VisualStudio.TestTools.UnitTesting.StringAssert.Contains%2A?displayProperty=nameWithType>, <xref:Microsoft.VisualStudio.TestTools.UnitTesting.StringAssert.Matches%2A?displayProperty=nameWithType>, and <xref:Microsoft.VisualStudio.TestTools.UnitTesting.StringAssert.StartsWith%2A?displayProperty=nameWithType>. | ||
|
||
## The `CollectionAssert` class | ||
|
||
Use the <xref:Microsoft.VisualStudio.TestTools.UnitTesting.CollectionAssert> class to compare collections of objects, or to verify the state of a collection. |
Oops, something went wrong.