Updated misc articles to fix up version numbers, and update text to …#849

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

Merged
SeanKilleen merged 10 commits into from
Dec 4, 2023
Merged

Updated misc articles to fix up version numbers, and update text to … #849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
923105c
Updated misc articles to fix up version numbers, and update text to m…
OsirisTerje Dec 3, 2023
e2476a1
fixing line length issues
OsirisTerje Dec 3, 2023
47fa065
fixing more line length issues
OsirisTerje Dec 3, 2023
33d99a3
Update docs/articles/nunit/getting-started/dotnet-core-and-dotnet-sta…
OsirisTerje Dec 3, 2023
0b18499
Update docs/articles/nunit/getting-started/upgrading.md
OsirisTerje Dec 3, 2023
1d7674c
update
OsirisTerje Dec 3, 2023
b05ac79
Merge branch 'nunitupdate' of https://github.com/nunit/docs into nuni…
OsirisTerje Dec 3, 2023
1042cf4
update
OsirisTerje Dec 3, 2023
3d94e6c
Remove lint ignore
SeanKilleen Dec 3, 2023
80ad1b3
Run re-wrap command to fix linting
SeanKilleen Dec 3, 2023
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
34 changes: 21 additions & 13 deletions docs/articles/nunit/getting-started/dotnet-core-and-dotnet-standard.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
# .NET Core and .NET Standard
# .NET Core

More information and getting started tutorials are available for NUnit and .NET Core targeting
[C#](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-with-nunit),
[F#](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-fsharp-with-nunit) and [Visual
Basic](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-visual-basic-with-nunit) in the .NET Core
documentation's [Unit Testing in .NET Core and .NET Standard](https://docs.microsoft.com/en-us/dotnet/core/testing/)
documentation's [Unit Testing in .NET Core](https://docs.microsoft.com/en-us/dotnet/core/testing/)
page.

The other information on this page is older documentation. If you follow the instructions in the [Installation
section](xref:installation) your project will work with .NET Core and .NET Standard.
section](xref:installation) your project will work with .NET Core.

The test projects have to be .NET (Core) or .NET Framework; .NET Standard can't be used as a test project, since it
can't be run on its own, but any code in a .NET Standard library can be tested from a .NET (Core) or .NET Framework test
project.

## TL;DR

Adding the adapter and `Microsoft.NET.Test.Sdk` version `17.0.0` or greater to your NUnit test projects will also enable
Adding the adapter and `Microsoft.NET.Test.Sdk` version `17.8.0` or greater to your NUnit test projects will also enable
the `dotnet test` command for .NET Core projects.

Any tests using the new style CSPROJ format, either .NET Core or .NET 4.x, need to add a `PackageReference` to the NuGet
Expand All@@ -27,10 +27,10 @@ the necessary references.

```xml
<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.0" />
Comment thread
SeanKilleen marked this conversation as resolved.
<PackageReference Include="NUnit" Version="3.13.3" />
<PackageReference Include="NUnit3TestAdapter" Version="4.2.1" />
<PackageReference Include="NUnit.Analyzers" Version="3.6.1" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
<PackageReference Include="NUnit" Version="4.0.1" />
<PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
<PackageReference Include="NUnit.Analyzers" Version="3.10.0" />
<PackageReference Include="coverlet.collector" Version="6.0.0" />
</ItemGroup>
```
Expand DownExpand Up@@ -80,20 +80,28 @@ Framework.

This limitation is the same for all test adapters including xUnit and MSTest2.

#### My tests aren't showing up in Visual Studio 2017 or later
#### My tests aren't showing up in Visual Studio 2022 or later
Comment thread
SeanKilleen marked this conversation as resolved.

* Are you using the NuGet adapter package?
* Are you using version 4.1.0 or newer of the NuGet package?
* Are you using version 4.5.0 or newer of the NuGet package?
* Do your tests target .NET Core or the full .NET Framework? (see above)
* Have you added a Package Reference to `Microsoft.NET.Test.Sdk`?
* Have you restarted Visual Studio? It is still a bit temperamental.
* Are you doing integration testing with Asp.Net Core `WebApplicationFactory` and using minimal API, and it complains
about missing `testhost.deps.json`? Then you're accessing the wrong Program class in your WebApplicationFactory. Fix
it by adding a code line at the end of the `Program.cs` file, and verify that your WebApplicationFactory is actually
using this Program class:

```csharp
public partial class Program { }
```

#### My tests multi-target .NET Core and .NET Framework, why can't I run both in Visual Studio

This is a limitation of Visual Studio, hopefully it will be fixed in a future release.
This was a limitation in earlier versions of Visual Studio, but is fixed in Visual Studio 2022.

Meanwhile, you can run specific tests using the `--framework` command line option of [dotnet
test](https://docs.microsoft.com/en-ca/dotnet/core/tools/dotnet-test?tabs=netcore2x)
_If_ you must run an earlier version and have this issue, you can run specific tests using the `--framework` command
line option of [dotnet test](https://docs.microsoft.com/en-ca/dotnet/core/tools/dotnet-test?tabs=netcore2x)

## How do I produce a test results file

Expand Down
21 changes: 16 additions & 5 deletions docs/articles/nunit/getting-started/upgrading.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
# Upgrading

This document assumes you are upgrading to NUnit 3.0 from NUnit 2.6 or later. While it's possible to upgrade from an
## Upgrading from NUnit 3.X to NUnit 4.X

See the [Migration Guide](xref:migrationguidance) for information on upgrading from NUnit 3.x to NUnit 4.x.

Also see the [Release Notes for version 4.0.0][def] for information on breaking and other changes to see if any of these
may affect your tests.

## Upgrading from NUnit 2.6.4 to NUnit 3.0

This section assumes you are upgrading to NUnit 3.0 from NUnit 2.6 or later. While it's possible to upgrade from an
earlier version, you will need to take into account many additional changes in NUnit, which are not described here. If
this is your situation, be sure to check the release notes for earlier versions of NUnit as well.

## Review Breaking Changes
### Review Breaking Changes

The [Breaking Changes](xref:breakingchanges) page lists missing and changed functionality in NUnit 3.0. You should
review this page to see which items are likely to affect your own tests.

## Update Your Code
### Update Your Code

In many cases, the items being removed have been deprecated for some time and an alternate approach may already be
available in your current release of NUnit. If that is the case, it will probably save you time and effort if you modify
Expand All@@ -20,15 +29,17 @@ For example, NUnit 3.0 no longer supports **ExpectedExceptionAttribute**. Howeve
your tests and use one of the alternatives instead, you can verify that they work in your present environment and they
will continue to work after conversion.**

## Switch to NUnit 3.0
### Switch to NUnit 3.0

Remove references to your old version of NUnit and replace them with references to NUnit 3.0. In the case of NUnitLite
executable tests, you will need to reference both the nunit.framework and NUnitLite assemblies. Compile your code. It's
possible that you will find compiler errors due to breaking changes in NUnit 3.0, which you missed in the prior step.
Make the necessary changes until it all works.

## Make the Tests Pass
### Make the Tests Pass

Hopefully, you aren't converting tests that were not passing when you started! If all goes well, they will continue to
pass under NUnit 3.0. If not, investigate each case and make necessary changes. If something isn't working as
advertised, please let us know.

[def]: https://docs.nunit.org/articles/nunit/release-notes/framework.html#nunit-400---november-26-2023
7 changes: 6 additions & 1 deletion docs/articles/nunit/release-notes/breaking-changes.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,10 @@ uid: breakingchanges

## NUnit 4.0

* The [Classic Asserts](../writing-tests/assertions/assertion-models/classic.md) have been moved to a separate library
See the [Migration Guide](xref:migrationguidance) for moving your tests from NUnit 3.x to NUnit 4.0 if you are using any
of the following features:

* The [Classic Asserts][def] have been moved to a separate library
and their namespace and their class name were renamed to: `NUnit.Framework.Legacy.ClassicAssert`.
* The standalone assert classes have also been moved to the `NUnit.Framework.Legacy` namespace. These classes are:
* [CollectionAssert](../writing-tests/assertions/classic-assertions/Collection-Assert.md)
Expand DownExpand Up@@ -154,3 +157,5 @@ runner supports.
| `--noshadow` | Disable shadow copy | No longer supported. The console runner now disables shadow copy by default. use `--shadowcopy` on the command-line to turn it on. |
| `--nothread` | Disable use of a separate thread for tests | No longer supported. |
| `--nodots` | Do not display dots as a progress indicator | No longer supported. |

[def]: ../writing-tests/assertions/assertion-models/classic.md
14 changes: 6 additions & 8 deletions docs/articles/nunit/writing-tests/assertions/assertion-models/constraint.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,28 +25,26 @@ overloads...

```csharp
Assert.That(bool condition);
Assert.That(bool condition, string message, params object[] params);
Assert.That(bool condition, string message);
Assert.That(bool condition, Func<string> getExceptionMessage);

Assert.That(Func<bool> condition);
Assert.That(Func<bool> condition, string message, params object[] params);
Assert.That(Func<bool> condition, string message);
Assert.That(Func<bool> condition, Func<string> getExceptionMessage);

Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint constraint)
Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint constraint,
string message, object[] params)
string message)
Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint expr,
Func<string> getExceptionMessage)

Assert.That<TActual>(TActual actual, IResolveConstraint constraint)
Assert.That<TActual>(TActual actual, IResolveConstraint constraint, string message,
params object[] params)
Assert.That<TActual>(TActual actual, IResolveConstraint constraint, string message)
Assert.That<TActual>(TActual actual, IResolveConstraint expression,
Func<string> getExceptionMessage)

Assert.That(TestDelegate del, IResolveConstraint constraint)
Assert.That(TestDelegate code, IResolveConstraint constraint, string message,
params object[] args)
Assert.That(TestDelegate code, IResolveConstraint constraint, string message)
Assert.That(TestDelegate code, IResolveConstraint constraint,
Func<string> getExceptionMessage)
```
Expand All@@ -58,7 +56,7 @@ For overloads taking a constraint, the argument must be an object implementing t
which supports performing a test on an actual value and generating appropriate messages. This interface is described in
more detail under [Custom Constraints](xref:customconstraints).

NUnit provides a number of constraint classes similar to the **EqualConstraint** used in the example above. Generally,
NUnit provides a number of constraint classes similar to the **EqualConstraint** used in the examples above. Generally,
these classes may be used directly or through a syntax helper. The valid forms are described on the pages related to
each constraint.

Expand Down
5 changes: 2 additions & 3 deletions docs/articles/nunit/writing-tests/assertions/assertions.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,14 +35,13 @@ approach have all been implemented internally using constraints. For example...
### Some notes on the Classic/Legacy asserts

The classic/legacy asserts, like `ClassicAssert.AreEqual`, have now been moved into its own project (namespace), and
will later be released as a separate package. They are now in the namespace `NUnit.Framework.Legacy`, and the `Assert`
may later be released as a separate package. They are now in the namespace `NUnit.Framework.Legacy`, and the `Assert`
have been renamed to `ClassicAssert`.

If you're upgrading from NUnit 3.X to NUnit 4, you need to add a using for `NUnit.Framework.Legacy` to your test
classes, and rename all classic asserts from `Assert` to `ClassicAssert`.

You *can* freely mix the constraint model assertions and the classic asserts in the same test class, but we don't
recommend it.
You *can* freely mix the constraint model assertions and the classic asserts in the same test class.

All assertions in the `ClassicAssert` class are rerouting to use the constraint model.

Expand Down
2 changes: 1 addition & 1 deletion docs/articles/nunit/writing-tests/assertions/multiple-asserts.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,7 @@ end of the block if any failures were encountered, but would continue otherwise.
Multiple assertion failures per test are stored in the representation of the test result using new XML elements, which
are not recognized by older runners. The following runners are known to support display of the new elements:

* NUnit 3 Visual Studio Adapter 3.7++ (Used by Visual Studio and `dotnet test`)
* NUnit3 Visual Studio Adapter 3.7++ (Used by Visual Studio and `dotnet test`)
* NUnit Console Runner 3.6++

#### Compatibility
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Updated misc articles to fix up version numbers, and update text to …#849

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

 Merged

SeanKilleen
merged 10 commits into

from

Dec 4, 2023
 Merged


Updated misc articles to fix up version numbers, and update text to …
#849
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
923105c

Updated misc articles to fix up version numbers, and update text to m…


OsirisTerje Dec 3, 2023
e2476a1

fixing line length issues


OsirisTerje Dec 3, 2023
47fa065

fixing more line length issues


OsirisTerje Dec 3, 2023
33d99a3

Update docs/articles/nunit/getting-started/dotnet-core-and-dotnet-sta…


OsirisTerje Dec 3, 2023
0b18499

Update docs/articles/nunit/getting-started/upgrading.md


OsirisTerje Dec 3, 2023
1d7674c

update


OsirisTerje Dec 3, 2023
b05ac79

Merge branch 'nunitupdate' of https://github.com/nunit/docs into nuni…


OsirisTerje Dec 3, 2023
1042cf4

update


OsirisTerje Dec 3, 2023
3d94e6c

Remove lint ignore


SeanKilleen Dec 3, 2023
80ad1b3

Run re-wrap command to fix linting


SeanKilleen Dec 3, 2023

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


34 changes: 21 additions & 13 deletions
docs/articles/nunit/getting-started/dotnet-core-and-dotnet-standard.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
# .NET Core and .NET Standard
# .NET Core

More information and getting started tutorials are available for NUnit and .NET Core targeting
[C#](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-with-nunit),
[F#](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-fsharp-with-nunit) and [Visual
Basic](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-visual-basic-with-nunit) in the .NET Core
documentation's [Unit Testing in .NET Core and .NET Standard](https://docs.microsoft.com/en-us/dotnet/core/testing/)
documentation's [Unit Testing in .NET Core](https://docs.microsoft.com/en-us/dotnet/core/testing/)
page.

The other information on this page is older documentation. If you follow the instructions in the [Installation
section](xref:installation) your project will work with .NET Core and .NET Standard.
section](xref:installation) your project will work with .NET Core.

The test projects have to be .NET (Core) or .NET Framework; .NET Standard can't be used as a test project, since it
can't be run on its own, but any code in a .NET Standard library can be tested from a .NET (Core) or .NET Framework test
project.

## TL;DR

Adding the adapter and `Microsoft.NET.Test.Sdk` version `17.0.0` or greater to your NUnit test projects will also enable
Adding the adapter and `Microsoft.NET.Test.Sdk` version `17.8.0` or greater to your NUnit test projects will also enable
the `dotnet test` command for .NET Core projects.

Any tests using the new style CSPROJ format, either .NET Core or .NET 4.x, need to add a `PackageReference` to the NuGet
Expand All@@ -27,10 +27,10 @@ the necessary references.

```xml
 <ItemGroup>
 <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.0" />
Comment thread
SeanKilleen marked this conversation as resolved.

 <PackageReference Include="NUnit" Version="3.13.3" />
 <PackageReference Include="NUnit3TestAdapter" Version="4.2.1" />
 <PackageReference Include="NUnit.Analyzers" Version="3.6.1" />
 <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
 <PackageReference Include="NUnit" Version="4.0.1" />
 <PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
 <PackageReference Include="NUnit.Analyzers" Version="3.10.0" />
 <PackageReference Include="coverlet.collector" Version="6.0.0" />
 </ItemGroup>
```
Expand DownExpand Up@@ -80,20 +80,28 @@ Framework.

This limitation is the same for all test adapters including xUnit and MSTest2.

#### My tests aren't showing up in Visual Studio 2017 or later
#### My tests aren't showing up in Visual Studio 2022 or later
Comment thread
SeanKilleen marked this conversation as resolved.


* Are you using the NuGet adapter package?
* Are you using version 4.1.0 or newer of the NuGet package?
* Are you using version 4.5.0 or newer of the NuGet package?
* Do your tests target .NET Core or the full .NET Framework? (see above)
* Have you added a Package Reference to `Microsoft.NET.Test.Sdk`?
* Have you restarted Visual Studio? It is still a bit temperamental.
* Are you doing integration testing with Asp.Net Core `WebApplicationFactory` and using minimal API, and it complains
 about missing `testhost.deps.json`? Then you're accessing the wrong Program class in your WebApplicationFactory. Fix
 it by adding a code line at the end of the `Program.cs` file, and verify that your WebApplicationFactory is actually
 using this Program class:

```csharp
 public partial class Program { }
```

#### My tests multi-target .NET Core and .NET Framework, why can't I run both in Visual Studio

This is a limitation of Visual Studio, hopefully it will be fixed in a future release.
This was a limitation in earlier versions of Visual Studio, but is fixed in Visual Studio 2022.

Meanwhile, you can run specific tests using the `--framework` command line option of [dotnet
test](https://docs.microsoft.com/en-ca/dotnet/core/tools/dotnet-test?tabs=netcore2x)
_If_ you must run an earlier version and have this issue, you can run specific tests using the `--framework` command
line option of [dotnet test](https://docs.microsoft.com/en-ca/dotnet/core/tools/dotnet-test?tabs=netcore2x)

## How do I produce a test results file

Expand Down

21 changes: 16 additions & 5 deletions
docs/articles/nunit/getting-started/upgrading.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
# Upgrading

This document assumes you are upgrading to NUnit 3.0 from NUnit 2.6 or later. While it's possible to upgrade from an
## Upgrading from NUnit 3.X to NUnit 4.X

See the [Migration Guide](xref:migrationguidance) for information on upgrading from NUnit 3.x to NUnit 4.x.

Also see the [Release Notes for version 4.0.0][def] for information on breaking and other changes to see if any of these
may affect your tests.

## Upgrading from NUnit 2.6.4 to NUnit 3.0

This section assumes you are upgrading to NUnit 3.0 from NUnit 2.6 or later. While it's possible to upgrade from an
earlier version, you will need to take into account many additional changes in NUnit, which are not described here. If
this is your situation, be sure to check the release notes for earlier versions of NUnit as well.

## Review Breaking Changes
### Review Breaking Changes

The [Breaking Changes](xref:breakingchanges) page lists missing and changed functionality in NUnit 3.0. You should
review this page to see which items are likely to affect your own tests.

## Update Your Code
### Update Your Code

In many cases, the items being removed have been deprecated for some time and an alternate approach may already be
available in your current release of NUnit. If that is the case, it will probably save you time and effort if you modify
Expand All@@ -20,15 +29,17 @@ For example, NUnit 3.0 no longer supports **ExpectedExceptionAttribute**. Howeve
your tests and use one of the alternatives instead, you can verify that they work in your present environment and they
will continue to work after conversion.**

## Switch to NUnit 3.0
### Switch to NUnit 3.0

Remove references to your old version of NUnit and replace them with references to NUnit 3.0. In the case of NUnitLite
executable tests, you will need to reference both the nunit.framework and NUnitLite assemblies. Compile your code. It's
possible that you will find compiler errors due to breaking changes in NUnit 3.0, which you missed in the prior step.
Make the necessary changes until it all works.

## Make the Tests Pass
### Make the Tests Pass

Hopefully, you aren't converting tests that were not passing when you started! If all goes well, they will continue to
pass under NUnit 3.0. If not, investigate each case and make necessary changes. If something isn't working as
advertised, please let us know.

[def]: https://docs.nunit.org/articles/nunit/release-notes/framework.html#nunit-400---november-26-2023

7 changes: 6 additions & 1 deletion
docs/articles/nunit/release-notes/breaking-changes.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,10 @@ uid: breakingchanges

## NUnit 4.0

* The [Classic Asserts](../writing-tests/assertions/assertion-models/classic.md) have been moved to a separate library
See the [Migration Guide](xref:migrationguidance) for moving your tests from NUnit 3.x to NUnit 4.0 if you are using any
of the following features:

* The [Classic Asserts][def] have been moved to a separate library
 and their namespace and their class name were renamed to: `NUnit.Framework.Legacy.ClassicAssert`.
* The standalone assert classes have also been moved to the `NUnit.Framework.Legacy` namespace. These classes are:
 * [CollectionAssert](../writing-tests/assertions/classic-assertions/Collection-Assert.md)
Expand DownExpand Up@@ -154,3 +157,5 @@ runner supports.
| `--noshadow` | Disable shadow copy | No longer supported. The console runner now disables shadow copy by default. use `--shadowcopy` on the command-line to turn it on. |
| `--nothread` | Disable use of a separate thread for tests | No longer supported. |
| `--nodots` | Do not display dots as a progress indicator | No longer supported. |

[def]: ../writing-tests/assertions/assertion-models/classic.md

14 changes: 6 additions & 8 deletions
docs/articles/nunit/writing-tests/assertions/assertion-models/constraint.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,28 +25,26 @@ overloads...

```csharp
Assert.That(bool condition);
Assert.That(bool condition, string message, params object[] params);
Assert.That(bool condition, string message);
Assert.That(bool condition, Func<string> getExceptionMessage);

Assert.That(Func<bool> condition);
Assert.That(Func<bool> condition, string message, params object[] params);
Assert.That(Func<bool> condition, string message);
Assert.That(Func<bool> condition, Func<string> getExceptionMessage);

Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint constraint)
Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint constraint,
 string message, object[] params)
 string message)
Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint expr,
 Func<string> getExceptionMessage)

Assert.That<TActual>(TActual actual, IResolveConstraint constraint)
Assert.That<TActual>(TActual actual, IResolveConstraint constraint, string message,
 params object[] params)
Assert.That<TActual>(TActual actual, IResolveConstraint constraint, string message)
Assert.That<TActual>(TActual actual, IResolveConstraint expression,
 Func<string> getExceptionMessage)

Assert.That(TestDelegate del, IResolveConstraint constraint)
Assert.That(TestDelegate code, IResolveConstraint constraint, string message,
 params object[] args)
Assert.That(TestDelegate code, IResolveConstraint constraint, string message)
Assert.That(TestDelegate code, IResolveConstraint constraint,
 Func<string> getExceptionMessage)
```
Expand All@@ -58,7 +56,7 @@ For overloads taking a constraint, the argument must be an object implementing t
which supports performing a test on an actual value and generating appropriate messages. This interface is described in
more detail under [Custom Constraints](xref:customconstraints).

NUnit provides a number of constraint classes similar to the **EqualConstraint** used in the example above. Generally,
NUnit provides a number of constraint classes similar to the **EqualConstraint** used in the examples above. Generally,
these classes may be used directly or through a syntax helper. The valid forms are described on the pages related to
each constraint.

Expand Down

5 changes: 2 additions & 3 deletions
docs/articles/nunit/writing-tests/assertions/assertions.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,14 +35,13 @@ approach have all been implemented internally using constraints. For example...
### Some notes on the Classic/Legacy asserts

The classic/legacy asserts, like `ClassicAssert.AreEqual`, have now been moved into its own project (namespace), and
will later be released as a separate package. They are now in the namespace `NUnit.Framework.Legacy`, and the `Assert`
may later be released as a separate package. They are now in the namespace `NUnit.Framework.Legacy`, and the `Assert`
have been renamed to `ClassicAssert`.

If you're upgrading from NUnit 3.X to NUnit 4, you need to add a using for `NUnit.Framework.Legacy` to your test
classes, and rename all classic asserts from `Assert` to `ClassicAssert`.

You *can* freely mix the constraint model assertions and the classic asserts in the same test class, but we don't
recommend it.
You *can* freely mix the constraint model assertions and the classic asserts in the same test class.

All assertions in the `ClassicAssert` class are rerouting to use the constraint model.

Expand Down

2 changes: 1 addition & 1 deletion
docs/articles/nunit/writing-tests/assertions/multiple-asserts.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,7 @@ end of the block if any failures were encountered, but would continue otherwise.
Multiple assertion failures per test are stored in the representation of the test result using new XML elements, which
are not recognized by older runners. The following runners are known to support display of the new elements:

* NUnit 3 Visual Studio Adapter 3.7++ (Used by Visual Studio and `dotnet test`)
* NUnit3 Visual Studio Adapter 3.7++ (Used by Visual Studio and `dotnet test`)
* NUnit Console Runner 3.6++

#### Compatibility
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Updated misc articles to fix up version numbers, and update text to …#849

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

 Merged

SeanKilleen
merged 10 commits into

from

Dec 4, 2023
 Merged


Updated misc articles to fix up version numbers, and update text to …
#849
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
923105c

Updated misc articles to fix up version numbers, and update text to m…


OsirisTerje Dec 3, 2023
e2476a1

fixing line length issues


OsirisTerje Dec 3, 2023
47fa065

fixing more line length issues


OsirisTerje Dec 3, 2023
33d99a3

Update docs/articles/nunit/getting-started/dotnet-core-and-dotnet-sta…


OsirisTerje Dec 3, 2023
0b18499

Update docs/articles/nunit/getting-started/upgrading.md


OsirisTerje Dec 3, 2023
1d7674c

update


OsirisTerje Dec 3, 2023
b05ac79

Merge branch 'nunitupdate' of https://github.com/nunit/docs into nuni…


OsirisTerje Dec 3, 2023
1042cf4

update


OsirisTerje Dec 3, 2023
3d94e6c

Remove lint ignore


SeanKilleen Dec 3, 2023
80ad1b3

Run re-wrap command to fix linting


SeanKilleen Dec 3, 2023

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


34 changes: 21 additions & 13 deletions
docs/articles/nunit/getting-started/dotnet-core-and-dotnet-standard.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
# .NET Core and .NET Standard
# .NET Core

More information and getting started tutorials are available for NUnit and .NET Core targeting
[C#](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-with-nunit),
[F#](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-fsharp-with-nunit) and [Visual
Basic](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-visual-basic-with-nunit) in the .NET Core
documentation's [Unit Testing in .NET Core and .NET Standard](https://docs.microsoft.com/en-us/dotnet/core/testing/)
documentation's [Unit Testing in .NET Core](https://docs.microsoft.com/en-us/dotnet/core/testing/)
page.

The other information on this page is older documentation. If you follow the instructions in the [Installation
section](xref:installation) your project will work with .NET Core and .NET Standard.
section](xref:installation) your project will work with .NET Core.

The test projects have to be .NET (Core) or .NET Framework; .NET Standard can't be used as a test project, since it
can't be run on its own, but any code in a .NET Standard library can be tested from a .NET (Core) or .NET Framework test
project.

## TL;DR

Adding the adapter and `Microsoft.NET.Test.Sdk` version `17.0.0` or greater to your NUnit test projects will also enable
Adding the adapter and `Microsoft.NET.Test.Sdk` version `17.8.0` or greater to your NUnit test projects will also enable
the `dotnet test` command for .NET Core projects.

Any tests using the new style CSPROJ format, either .NET Core or .NET 4.x, need to add a `PackageReference` to the NuGet
Expand All@@ -27,10 +27,10 @@ the necessary references.

```xml
 <ItemGroup>
 <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.0" />
Comment thread
SeanKilleen marked this conversation as resolved.

 <PackageReference Include="NUnit" Version="3.13.3" />
 <PackageReference Include="NUnit3TestAdapter" Version="4.2.1" />
 <PackageReference Include="NUnit.Analyzers" Version="3.6.1" />
 <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
 <PackageReference Include="NUnit" Version="4.0.1" />
 <PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
 <PackageReference Include="NUnit.Analyzers" Version="3.10.0" />
 <PackageReference Include="coverlet.collector" Version="6.0.0" />
 </ItemGroup>
```
Expand DownExpand Up@@ -80,20 +80,28 @@ Framework.

This limitation is the same for all test adapters including xUnit and MSTest2.

#### My tests aren't showing up in Visual Studio 2017 or later
#### My tests aren't showing up in Visual Studio 2022 or later
Comment thread
SeanKilleen marked this conversation as resolved.


* Are you using the NuGet adapter package?
* Are you using version 4.1.0 or newer of the NuGet package?
* Are you using version 4.5.0 or newer of the NuGet package?
* Do your tests target .NET Core or the full .NET Framework? (see above)
* Have you added a Package Reference to `Microsoft.NET.Test.Sdk`?
* Have you restarted Visual Studio? It is still a bit temperamental.
* Are you doing integration testing with Asp.Net Core `WebApplicationFactory` and using minimal API, and it complains
 about missing `testhost.deps.json`? Then you're accessing the wrong Program class in your WebApplicationFactory. Fix
 it by adding a code line at the end of the `Program.cs` file, and verify that your WebApplicationFactory is actually
 using this Program class:

```csharp
 public partial class Program { }
```

#### My tests multi-target .NET Core and .NET Framework, why can't I run both in Visual Studio

This is a limitation of Visual Studio, hopefully it will be fixed in a future release.
This was a limitation in earlier versions of Visual Studio, but is fixed in Visual Studio 2022.

Meanwhile, you can run specific tests using the `--framework` command line option of [dotnet
test](https://docs.microsoft.com/en-ca/dotnet/core/tools/dotnet-test?tabs=netcore2x)
_If_ you must run an earlier version and have this issue, you can run specific tests using the `--framework` command
line option of [dotnet test](https://docs.microsoft.com/en-ca/dotnet/core/tools/dotnet-test?tabs=netcore2x)

## How do I produce a test results file

Expand Down

21 changes: 16 additions & 5 deletions
docs/articles/nunit/getting-started/upgrading.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
# Upgrading

This document assumes you are upgrading to NUnit 3.0 from NUnit 2.6 or later. While it's possible to upgrade from an
## Upgrading from NUnit 3.X to NUnit 4.X

See the [Migration Guide](xref:migrationguidance) for information on upgrading from NUnit 3.x to NUnit 4.x.

Also see the [Release Notes for version 4.0.0][def] for information on breaking and other changes to see if any of these
may affect your tests.

## Upgrading from NUnit 2.6.4 to NUnit 3.0

This section assumes you are upgrading to NUnit 3.0 from NUnit 2.6 or later. While it's possible to upgrade from an
earlier version, you will need to take into account many additional changes in NUnit, which are not described here. If
this is your situation, be sure to check the release notes for earlier versions of NUnit as well.

## Review Breaking Changes
### Review Breaking Changes

The [Breaking Changes](xref:breakingchanges) page lists missing and changed functionality in NUnit 3.0. You should
review this page to see which items are likely to affect your own tests.

## Update Your Code
### Update Your Code

In many cases, the items being removed have been deprecated for some time and an alternate approach may already be
available in your current release of NUnit. If that is the case, it will probably save you time and effort if you modify
Expand All@@ -20,15 +29,17 @@ For example, NUnit 3.0 no longer supports **ExpectedExceptionAttribute**. Howeve
your tests and use one of the alternatives instead, you can verify that they work in your present environment and they
will continue to work after conversion.**

## Switch to NUnit 3.0
### Switch to NUnit 3.0

Remove references to your old version of NUnit and replace them with references to NUnit 3.0. In the case of NUnitLite
executable tests, you will need to reference both the nunit.framework and NUnitLite assemblies. Compile your code. It's
possible that you will find compiler errors due to breaking changes in NUnit 3.0, which you missed in the prior step.
Make the necessary changes until it all works.

## Make the Tests Pass
### Make the Tests Pass

Hopefully, you aren't converting tests that were not passing when you started! If all goes well, they will continue to
pass under NUnit 3.0. If not, investigate each case and make necessary changes. If something isn't working as
advertised, please let us know.

[def]: https://docs.nunit.org/articles/nunit/release-notes/framework.html#nunit-400---november-26-2023

7 changes: 6 additions & 1 deletion
docs/articles/nunit/release-notes/breaking-changes.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,10 @@ uid: breakingchanges

## NUnit 4.0

* The [Classic Asserts](../writing-tests/assertions/assertion-models/classic.md) have been moved to a separate library
See the [Migration Guide](xref:migrationguidance) for moving your tests from NUnit 3.x to NUnit 4.0 if you are using any
of the following features:

* The [Classic Asserts][def] have been moved to a separate library
 and their namespace and their class name were renamed to: `NUnit.Framework.Legacy.ClassicAssert`.
* The standalone assert classes have also been moved to the `NUnit.Framework.Legacy` namespace. These classes are:
 * [CollectionAssert](../writing-tests/assertions/classic-assertions/Collection-Assert.md)
Expand DownExpand Up@@ -154,3 +157,5 @@ runner supports.
| `--noshadow` | Disable shadow copy | No longer supported. The console runner now disables shadow copy by default. use `--shadowcopy` on the command-line to turn it on. |
| `--nothread` | Disable use of a separate thread for tests | No longer supported. |
| `--nodots` | Do not display dots as a progress indicator | No longer supported. |

[def]: ../writing-tests/assertions/assertion-models/classic.md

14 changes: 6 additions & 8 deletions
docs/articles/nunit/writing-tests/assertions/assertion-models/constraint.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,28 +25,26 @@ overloads...

```csharp
Assert.That(bool condition);
Assert.That(bool condition, string message, params object[] params);
Assert.That(bool condition, string message);
Assert.That(bool condition, Func<string> getExceptionMessage);

Assert.That(Func<bool> condition);
Assert.That(Func<bool> condition, string message, params object[] params);
Assert.That(Func<bool> condition, string message);
Assert.That(Func<bool> condition, Func<string> getExceptionMessage);

Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint constraint)
Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint constraint,
 string message, object[] params)
 string message)
Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint expr,
 Func<string> getExceptionMessage)

Assert.That<TActual>(TActual actual, IResolveConstraint constraint)
Assert.That<TActual>(TActual actual, IResolveConstraint constraint, string message,
 params object[] params)
Assert.That<TActual>(TActual actual, IResolveConstraint constraint, string message)
Assert.That<TActual>(TActual actual, IResolveConstraint expression,
 Func<string> getExceptionMessage)

Assert.That(TestDelegate del, IResolveConstraint constraint)
Assert.That(TestDelegate code, IResolveConstraint constraint, string message,
 params object[] args)
Assert.That(TestDelegate code, IResolveConstraint constraint, string message)
Assert.That(TestDelegate code, IResolveConstraint constraint,
 Func<string> getExceptionMessage)
```
Expand All@@ -58,7 +56,7 @@ For overloads taking a constraint, the argument must be an object implementing t
which supports performing a test on an actual value and generating appropriate messages. This interface is described in
more detail under [Custom Constraints](xref:customconstraints).

NUnit provides a number of constraint classes similar to the **EqualConstraint** used in the example above. Generally,
NUnit provides a number of constraint classes similar to the **EqualConstraint** used in the examples above. Generally,
these classes may be used directly or through a syntax helper. The valid forms are described on the pages related to
each constraint.

Expand Down

5 changes: 2 additions & 3 deletions
docs/articles/nunit/writing-tests/assertions/assertions.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,14 +35,13 @@ approach have all been implemented internally using constraints. For example...
### Some notes on the Classic/Legacy asserts

The classic/legacy asserts, like `ClassicAssert.AreEqual`, have now been moved into its own project (namespace), and
will later be released as a separate package. They are now in the namespace `NUnit.Framework.Legacy`, and the `Assert`
may later be released as a separate package. They are now in the namespace `NUnit.Framework.Legacy`, and the `Assert`
have been renamed to `ClassicAssert`.

If you're upgrading from NUnit 3.X to NUnit 4, you need to add a using for `NUnit.Framework.Legacy` to your test
classes, and rename all classic asserts from `Assert` to `ClassicAssert`.

You *can* freely mix the constraint model assertions and the classic asserts in the same test class, but we don't
recommend it.
You *can* freely mix the constraint model assertions and the classic asserts in the same test class.

All assertions in the `ClassicAssert` class are rerouting to use the constraint model.

Expand Down

2 changes: 1 addition & 1 deletion
docs/articles/nunit/writing-tests/assertions/multiple-asserts.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,7 @@ end of the block if any failures were encountered, but would continue otherwise.
Multiple assertion failures per test are stored in the representation of the test result using new XML elements, which
are not recognized by older runners. The following runners are known to support display of the new elements:

* NUnit 3 Visual Studio Adapter 3.7++ (Used by Visual Studio and `dotnet test`)
* NUnit3 Visual Studio Adapter 3.7++ (Used by Visual Studio and `dotnet test`)
* NUnit Console Runner 3.6++

#### Compatibility
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Updated misc articles to fix up version numbers, and update text to …#849

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

 Merged

SeanKilleen
merged 10 commits into

from

Dec 4, 2023
 Merged


Updated misc articles to fix up version numbers, and update text to …
#849
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
923105c

Updated misc articles to fix up version numbers, and update text to m…


OsirisTerje Dec 3, 2023
e2476a1

fixing line length issues


OsirisTerje Dec 3, 2023
47fa065

fixing more line length issues


OsirisTerje Dec 3, 2023
33d99a3

Update docs/articles/nunit/getting-started/dotnet-core-and-dotnet-sta…


OsirisTerje Dec 3, 2023
0b18499

Update docs/articles/nunit/getting-started/upgrading.md


OsirisTerje Dec 3, 2023
1d7674c

update


OsirisTerje Dec 3, 2023
b05ac79

Merge branch 'nunitupdate' of https://github.com/nunit/docs into nuni…


OsirisTerje Dec 3, 2023
1042cf4

update


OsirisTerje Dec 3, 2023
3d94e6c

Remove lint ignore


SeanKilleen Dec 3, 2023
80ad1b3

Run re-wrap command to fix linting


SeanKilleen Dec 3, 2023

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


34 changes: 21 additions & 13 deletions
docs/articles/nunit/getting-started/dotnet-core-and-dotnet-standard.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
# .NET Core and .NET Standard
# .NET Core

More information and getting started tutorials are available for NUnit and .NET Core targeting
[C#](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-with-nunit),
[F#](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-fsharp-with-nunit) and [Visual
Basic](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-visual-basic-with-nunit) in the .NET Core
documentation's [Unit Testing in .NET Core and .NET Standard](https://docs.microsoft.com/en-us/dotnet/core/testing/)
documentation's [Unit Testing in .NET Core](https://docs.microsoft.com/en-us/dotnet/core/testing/)
page.

The other information on this page is older documentation. If you follow the instructions in the [Installation
section](xref:installation) your project will work with .NET Core and .NET Standard.
section](xref:installation) your project will work with .NET Core.

The test projects have to be .NET (Core) or .NET Framework; .NET Standard can't be used as a test project, since it
can't be run on its own, but any code in a .NET Standard library can be tested from a .NET (Core) or .NET Framework test
project.

## TL;DR

Adding the adapter and `Microsoft.NET.Test.Sdk` version `17.0.0` or greater to your NUnit test projects will also enable
Adding the adapter and `Microsoft.NET.Test.Sdk` version `17.8.0` or greater to your NUnit test projects will also enable
the `dotnet test` command for .NET Core projects.

Any tests using the new style CSPROJ format, either .NET Core or .NET 4.x, need to add a `PackageReference` to the NuGet
Expand All@@ -27,10 +27,10 @@ the necessary references.

```xml
 <ItemGroup>
 <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.0" />
Comment thread
SeanKilleen marked this conversation as resolved.

 <PackageReference Include="NUnit" Version="3.13.3" />
 <PackageReference Include="NUnit3TestAdapter" Version="4.2.1" />
 <PackageReference Include="NUnit.Analyzers" Version="3.6.1" />
 <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
 <PackageReference Include="NUnit" Version="4.0.1" />
 <PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
 <PackageReference Include="NUnit.Analyzers" Version="3.10.0" />
 <PackageReference Include="coverlet.collector" Version="6.0.0" />
 </ItemGroup>
```
Expand DownExpand Up@@ -80,20 +80,28 @@ Framework.

This limitation is the same for all test adapters including xUnit and MSTest2.

#### My tests aren't showing up in Visual Studio 2017 or later
#### My tests aren't showing up in Visual Studio 2022 or later
Comment thread
SeanKilleen marked this conversation as resolved.


* Are you using the NuGet adapter package?
* Are you using version 4.1.0 or newer of the NuGet package?
* Are you using version 4.5.0 or newer of the NuGet package?
* Do your tests target .NET Core or the full .NET Framework? (see above)
* Have you added a Package Reference to `Microsoft.NET.Test.Sdk`?
* Have you restarted Visual Studio? It is still a bit temperamental.
* Are you doing integration testing with Asp.Net Core `WebApplicationFactory` and using minimal API, and it complains
 about missing `testhost.deps.json`? Then you're accessing the wrong Program class in your WebApplicationFactory. Fix
 it by adding a code line at the end of the `Program.cs` file, and verify that your WebApplicationFactory is actually
 using this Program class:

```csharp
 public partial class Program { }
```

#### My tests multi-target .NET Core and .NET Framework, why can't I run both in Visual Studio

This is a limitation of Visual Studio, hopefully it will be fixed in a future release.
This was a limitation in earlier versions of Visual Studio, but is fixed in Visual Studio 2022.

Meanwhile, you can run specific tests using the `--framework` command line option of [dotnet
test](https://docs.microsoft.com/en-ca/dotnet/core/tools/dotnet-test?tabs=netcore2x)
_If_ you must run an earlier version and have this issue, you can run specific tests using the `--framework` command
line option of [dotnet test](https://docs.microsoft.com/en-ca/dotnet/core/tools/dotnet-test?tabs=netcore2x)

## How do I produce a test results file

Expand Down

21 changes: 16 additions & 5 deletions
docs/articles/nunit/getting-started/upgrading.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
# Upgrading

This document assumes you are upgrading to NUnit 3.0 from NUnit 2.6 or later. While it's possible to upgrade from an
## Upgrading from NUnit 3.X to NUnit 4.X

See the [Migration Guide](xref:migrationguidance) for information on upgrading from NUnit 3.x to NUnit 4.x.

Also see the [Release Notes for version 4.0.0][def] for information on breaking and other changes to see if any of these
may affect your tests.

## Upgrading from NUnit 2.6.4 to NUnit 3.0

This section assumes you are upgrading to NUnit 3.0 from NUnit 2.6 or later. While it's possible to upgrade from an
earlier version, you will need to take into account many additional changes in NUnit, which are not described here. If
this is your situation, be sure to check the release notes for earlier versions of NUnit as well.

## Review Breaking Changes
### Review Breaking Changes

The [Breaking Changes](xref:breakingchanges) page lists missing and changed functionality in NUnit 3.0. You should
review this page to see which items are likely to affect your own tests.

## Update Your Code
### Update Your Code

In many cases, the items being removed have been deprecated for some time and an alternate approach may already be
available in your current release of NUnit. If that is the case, it will probably save you time and effort if you modify
Expand All@@ -20,15 +29,17 @@ For example, NUnit 3.0 no longer supports **ExpectedExceptionAttribute**. Howeve
your tests and use one of the alternatives instead, you can verify that they work in your present environment and they
will continue to work after conversion.**

## Switch to NUnit 3.0
### Switch to NUnit 3.0

Remove references to your old version of NUnit and replace them with references to NUnit 3.0. In the case of NUnitLite
executable tests, you will need to reference both the nunit.framework and NUnitLite assemblies. Compile your code. It's
possible that you will find compiler errors due to breaking changes in NUnit 3.0, which you missed in the prior step.
Make the necessary changes until it all works.

## Make the Tests Pass
### Make the Tests Pass

Hopefully, you aren't converting tests that were not passing when you started! If all goes well, they will continue to
pass under NUnit 3.0. If not, investigate each case and make necessary changes. If something isn't working as
advertised, please let us know.

[def]: https://docs.nunit.org/articles/nunit/release-notes/framework.html#nunit-400---november-26-2023

7 changes: 6 additions & 1 deletion
docs/articles/nunit/release-notes/breaking-changes.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,10 @@ uid: breakingchanges

## NUnit 4.0

* The [Classic Asserts](../writing-tests/assertions/assertion-models/classic.md) have been moved to a separate library
See the [Migration Guide](xref:migrationguidance) for moving your tests from NUnit 3.x to NUnit 4.0 if you are using any
of the following features:

* The [Classic Asserts][def] have been moved to a separate library
 and their namespace and their class name were renamed to: `NUnit.Framework.Legacy.ClassicAssert`.
* The standalone assert classes have also been moved to the `NUnit.Framework.Legacy` namespace. These classes are:
 * [CollectionAssert](../writing-tests/assertions/classic-assertions/Collection-Assert.md)
Expand DownExpand Up@@ -154,3 +157,5 @@ runner supports.
| `--noshadow` | Disable shadow copy | No longer supported. The console runner now disables shadow copy by default. use `--shadowcopy` on the command-line to turn it on. |
| `--nothread` | Disable use of a separate thread for tests | No longer supported. |
| `--nodots` | Do not display dots as a progress indicator | No longer supported. |

[def]: ../writing-tests/assertions/assertion-models/classic.md

14 changes: 6 additions & 8 deletions
docs/articles/nunit/writing-tests/assertions/assertion-models/constraint.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,28 +25,26 @@ overloads...

```csharp
Assert.That(bool condition);
Assert.That(bool condition, string message, params object[] params);
Assert.That(bool condition, string message);
Assert.That(bool condition, Func<string> getExceptionMessage);

Assert.That(Func<bool> condition);
Assert.That(Func<bool> condition, string message, params object[] params);
Assert.That(Func<bool> condition, string message);
Assert.That(Func<bool> condition, Func<string> getExceptionMessage);

Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint constraint)
Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint constraint,
 string message, object[] params)
 string message)
Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint expr,
 Func<string> getExceptionMessage)

Assert.That<TActual>(TActual actual, IResolveConstraint constraint)
Assert.That<TActual>(TActual actual, IResolveConstraint constraint, string message,
 params object[] params)
Assert.That<TActual>(TActual actual, IResolveConstraint constraint, string message)
Assert.That<TActual>(TActual actual, IResolveConstraint expression,
 Func<string> getExceptionMessage)

Assert.That(TestDelegate del, IResolveConstraint constraint)
Assert.That(TestDelegate code, IResolveConstraint constraint, string message,
 params object[] args)
Assert.That(TestDelegate code, IResolveConstraint constraint, string message)
Assert.That(TestDelegate code, IResolveConstraint constraint,
 Func<string> getExceptionMessage)
```
Expand All@@ -58,7 +56,7 @@ For overloads taking a constraint, the argument must be an object implementing t
which supports performing a test on an actual value and generating appropriate messages. This interface is described in
more detail under [Custom Constraints](xref:customconstraints).

NUnit provides a number of constraint classes similar to the **EqualConstraint** used in the example above. Generally,
NUnit provides a number of constraint classes similar to the **EqualConstraint** used in the examples above. Generally,
these classes may be used directly or through a syntax helper. The valid forms are described on the pages related to
each constraint.

Expand Down

5 changes: 2 additions & 3 deletions
docs/articles/nunit/writing-tests/assertions/assertions.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,14 +35,13 @@ approach have all been implemented internally using constraints. For example...
### Some notes on the Classic/Legacy asserts

The classic/legacy asserts, like `ClassicAssert.AreEqual`, have now been moved into its own project (namespace), and
will later be released as a separate package. They are now in the namespace `NUnit.Framework.Legacy`, and the `Assert`
may later be released as a separate package. They are now in the namespace `NUnit.Framework.Legacy`, and the `Assert`
have been renamed to `ClassicAssert`.

If you're upgrading from NUnit 3.X to NUnit 4, you need to add a using for `NUnit.Framework.Legacy` to your test
classes, and rename all classic asserts from `Assert` to `ClassicAssert`.

You *can* freely mix the constraint model assertions and the classic asserts in the same test class, but we don't
recommend it.
You *can* freely mix the constraint model assertions and the classic asserts in the same test class.

All assertions in the `ClassicAssert` class are rerouting to use the constraint model.

Expand Down

2 changes: 1 addition & 1 deletion
docs/articles/nunit/writing-tests/assertions/multiple-asserts.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,7 @@ end of the block if any failures were encountered, but would continue otherwise.
Multiple assertion failures per test are stored in the representation of the test result using new XML elements, which
are not recognized by older runners. The following runners are known to support display of the new elements:

* NUnit 3 Visual Studio Adapter 3.7++ (Used by Visual Studio and `dotnet test`)
* NUnit3 Visual Studio Adapter 3.7++ (Used by Visual Studio and `dotnet test`)
* NUnit Console Runner 3.6++

#### Compatibility
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Updated misc articles to fix up version numbers, and update text to …#849

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

 Merged

SeanKilleen
merged 10 commits into

from

Dec 4, 2023
 Merged


Updated misc articles to fix up version numbers, and update text to …
#849
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
923105c

Updated misc articles to fix up version numbers, and update text to m…


OsirisTerje Dec 3, 2023
e2476a1

fixing line length issues


OsirisTerje Dec 3, 2023
47fa065

fixing more line length issues


OsirisTerje Dec 3, 2023
33d99a3

Update docs/articles/nunit/getting-started/dotnet-core-and-dotnet-sta…


OsirisTerje Dec 3, 2023
0b18499

Update docs/articles/nunit/getting-started/upgrading.md


OsirisTerje Dec 3, 2023
1d7674c

update


OsirisTerje Dec 3, 2023
b05ac79

Merge branch 'nunitupdate' of https://github.com/nunit/docs into nuni…


OsirisTerje Dec 3, 2023
1042cf4

update


OsirisTerje Dec 3, 2023
3d94e6c

Remove lint ignore


SeanKilleen Dec 3, 2023
80ad1b3

Run re-wrap command to fix linting


SeanKilleen Dec 3, 2023

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


34 changes: 21 additions & 13 deletions
docs/articles/nunit/getting-started/dotnet-core-and-dotnet-standard.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
# .NET Core and .NET Standard
# .NET Core

More information and getting started tutorials are available for NUnit and .NET Core targeting
[C#](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-with-nunit),
[F#](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-fsharp-with-nunit) and [Visual
Basic](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-visual-basic-with-nunit) in the .NET Core
documentation's [Unit Testing in .NET Core and .NET Standard](https://docs.microsoft.com/en-us/dotnet/core/testing/)
documentation's [Unit Testing in .NET Core](https://docs.microsoft.com/en-us/dotnet/core/testing/)
page.

The other information on this page is older documentation. If you follow the instructions in the [Installation
section](xref:installation) your project will work with .NET Core and .NET Standard.
section](xref:installation) your project will work with .NET Core.

The test projects have to be .NET (Core) or .NET Framework; .NET Standard can't be used as a test project, since it
can't be run on its own, but any code in a .NET Standard library can be tested from a .NET (Core) or .NET Framework test
project.

## TL;DR

Adding the adapter and `Microsoft.NET.Test.Sdk` version `17.0.0` or greater to your NUnit test projects will also enable
Adding the adapter and `Microsoft.NET.Test.Sdk` version `17.8.0` or greater to your NUnit test projects will also enable
the `dotnet test` command for .NET Core projects.

Any tests using the new style CSPROJ format, either .NET Core or .NET 4.x, need to add a `PackageReference` to the NuGet
Expand All@@ -27,10 +27,10 @@ the necessary references.

```xml
 <ItemGroup>
 <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.0" />
Comment thread
SeanKilleen marked this conversation as resolved.

 <PackageReference Include="NUnit" Version="3.13.3" />
 <PackageReference Include="NUnit3TestAdapter" Version="4.2.1" />
 <PackageReference Include="NUnit.Analyzers" Version="3.6.1" />
 <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
 <PackageReference Include="NUnit" Version="4.0.1" />
 <PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
 <PackageReference Include="NUnit.Analyzers" Version="3.10.0" />
 <PackageReference Include="coverlet.collector" Version="6.0.0" />
 </ItemGroup>
```
Expand DownExpand Up@@ -80,20 +80,28 @@ Framework.

This limitation is the same for all test adapters including xUnit and MSTest2.

#### My tests aren't showing up in Visual Studio 2017 or later
#### My tests aren't showing up in Visual Studio 2022 or later
Comment thread
SeanKilleen marked this conversation as resolved.


* Are you using the NuGet adapter package?
* Are you using version 4.1.0 or newer of the NuGet package?
* Are you using version 4.5.0 or newer of the NuGet package?
* Do your tests target .NET Core or the full .NET Framework? (see above)
* Have you added a Package Reference to `Microsoft.NET.Test.Sdk`?
* Have you restarted Visual Studio? It is still a bit temperamental.
* Are you doing integration testing with Asp.Net Core `WebApplicationFactory` and using minimal API, and it complains
 about missing `testhost.deps.json`? Then you're accessing the wrong Program class in your WebApplicationFactory. Fix
 it by adding a code line at the end of the `Program.cs` file, and verify that your WebApplicationFactory is actually
 using this Program class:

```csharp
 public partial class Program { }
```

#### My tests multi-target .NET Core and .NET Framework, why can't I run both in Visual Studio

This is a limitation of Visual Studio, hopefully it will be fixed in a future release.
This was a limitation in earlier versions of Visual Studio, but is fixed in Visual Studio 2022.

Meanwhile, you can run specific tests using the `--framework` command line option of [dotnet
test](https://docs.microsoft.com/en-ca/dotnet/core/tools/dotnet-test?tabs=netcore2x)
_If_ you must run an earlier version and have this issue, you can run specific tests using the `--framework` command
line option of [dotnet test](https://docs.microsoft.com/en-ca/dotnet/core/tools/dotnet-test?tabs=netcore2x)

## How do I produce a test results file

Expand Down

21 changes: 16 additions & 5 deletions
docs/articles/nunit/getting-started/upgrading.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
# Upgrading

This document assumes you are upgrading to NUnit 3.0 from NUnit 2.6 or later. While it's possible to upgrade from an
## Upgrading from NUnit 3.X to NUnit 4.X

See the [Migration Guide](xref:migrationguidance) for information on upgrading from NUnit 3.x to NUnit 4.x.

Also see the [Release Notes for version 4.0.0][def] for information on breaking and other changes to see if any of these
may affect your tests.

## Upgrading from NUnit 2.6.4 to NUnit 3.0

This section assumes you are upgrading to NUnit 3.0 from NUnit 2.6 or later. While it's possible to upgrade from an
earlier version, you will need to take into account many additional changes in NUnit, which are not described here. If
this is your situation, be sure to check the release notes for earlier versions of NUnit as well.

## Review Breaking Changes
### Review Breaking Changes

The [Breaking Changes](xref:breakingchanges) page lists missing and changed functionality in NUnit 3.0. You should
review this page to see which items are likely to affect your own tests.

## Update Your Code
### Update Your Code

In many cases, the items being removed have been deprecated for some time and an alternate approach may already be
available in your current release of NUnit. If that is the case, it will probably save you time and effort if you modify
Expand All@@ -20,15 +29,17 @@ For example, NUnit 3.0 no longer supports **ExpectedExceptionAttribute**. Howeve
your tests and use one of the alternatives instead, you can verify that they work in your present environment and they
will continue to work after conversion.**

## Switch to NUnit 3.0
### Switch to NUnit 3.0

Remove references to your old version of NUnit and replace them with references to NUnit 3.0. In the case of NUnitLite
executable tests, you will need to reference both the nunit.framework and NUnitLite assemblies. Compile your code. It's
possible that you will find compiler errors due to breaking changes in NUnit 3.0, which you missed in the prior step.
Make the necessary changes until it all works.

## Make the Tests Pass
### Make the Tests Pass

Hopefully, you aren't converting tests that were not passing when you started! If all goes well, they will continue to
pass under NUnit 3.0. If not, investigate each case and make necessary changes. If something isn't working as
advertised, please let us know.

[def]: https://docs.nunit.org/articles/nunit/release-notes/framework.html#nunit-400---november-26-2023

7 changes: 6 additions & 1 deletion
docs/articles/nunit/release-notes/breaking-changes.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,10 @@ uid: breakingchanges

## NUnit 4.0

* The [Classic Asserts](../writing-tests/assertions/assertion-models/classic.md) have been moved to a separate library
See the [Migration Guide](xref:migrationguidance) for moving your tests from NUnit 3.x to NUnit 4.0 if you are using any
of the following features:

* The [Classic Asserts][def] have been moved to a separate library
 and their namespace and their class name were renamed to: `NUnit.Framework.Legacy.ClassicAssert`.
* The standalone assert classes have also been moved to the `NUnit.Framework.Legacy` namespace. These classes are:
 * [CollectionAssert](../writing-tests/assertions/classic-assertions/Collection-Assert.md)
Expand DownExpand Up@@ -154,3 +157,5 @@ runner supports.
| `--noshadow` | Disable shadow copy | No longer supported. The console runner now disables shadow copy by default. use `--shadowcopy` on the command-line to turn it on. |
| `--nothread` | Disable use of a separate thread for tests | No longer supported. |
| `--nodots` | Do not display dots as a progress indicator | No longer supported. |

[def]: ../writing-tests/assertions/assertion-models/classic.md

14 changes: 6 additions & 8 deletions
docs/articles/nunit/writing-tests/assertions/assertion-models/constraint.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,28 +25,26 @@ overloads...

```csharp
Assert.That(bool condition);
Assert.That(bool condition, string message, params object[] params);
Assert.That(bool condition, string message);
Assert.That(bool condition, Func<string> getExceptionMessage);

Assert.That(Func<bool> condition);
Assert.That(Func<bool> condition, string message, params object[] params);
Assert.That(Func<bool> condition, string message);
Assert.That(Func<bool> condition, Func<string> getExceptionMessage);

Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint constraint)
Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint constraint,
 string message, object[] params)
 string message)
Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint expr,
 Func<string> getExceptionMessage)

Assert.That<TActual>(TActual actual, IResolveConstraint constraint)
Assert.That<TActual>(TActual actual, IResolveConstraint constraint, string message,
 params object[] params)
Assert.That<TActual>(TActual actual, IResolveConstraint constraint, string message)
Assert.That<TActual>(TActual actual, IResolveConstraint expression,
 Func<string> getExceptionMessage)

Assert.That(TestDelegate del, IResolveConstraint constraint)
Assert.That(TestDelegate code, IResolveConstraint constraint, string message,
 params object[] args)
Assert.That(TestDelegate code, IResolveConstraint constraint, string message)
Assert.That(TestDelegate code, IResolveConstraint constraint,
 Func<string> getExceptionMessage)
```
Expand All@@ -58,7 +56,7 @@ For overloads taking a constraint, the argument must be an object implementing t
which supports performing a test on an actual value and generating appropriate messages. This interface is described in
more detail under [Custom Constraints](xref:customconstraints).

NUnit provides a number of constraint classes similar to the **EqualConstraint** used in the example above. Generally,
NUnit provides a number of constraint classes similar to the **EqualConstraint** used in the examples above. Generally,
these classes may be used directly or through a syntax helper. The valid forms are described on the pages related to
each constraint.

Expand Down

5 changes: 2 additions & 3 deletions
docs/articles/nunit/writing-tests/assertions/assertions.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,14 +35,13 @@ approach have all been implemented internally using constraints. For example...
### Some notes on the Classic/Legacy asserts

The classic/legacy asserts, like `ClassicAssert.AreEqual`, have now been moved into its own project (namespace), and
will later be released as a separate package. They are now in the namespace `NUnit.Framework.Legacy`, and the `Assert`
may later be released as a separate package. They are now in the namespace `NUnit.Framework.Legacy`, and the `Assert`
have been renamed to `ClassicAssert`.

If you're upgrading from NUnit 3.X to NUnit 4, you need to add a using for `NUnit.Framework.Legacy` to your test
classes, and rename all classic asserts from `Assert` to `ClassicAssert`.

You *can* freely mix the constraint model assertions and the classic asserts in the same test class, but we don't
recommend it.
You *can* freely mix the constraint model assertions and the classic asserts in the same test class.

All assertions in the `ClassicAssert` class are rerouting to use the constraint model.

Expand Down

2 changes: 1 addition & 1 deletion
docs/articles/nunit/writing-tests/assertions/multiple-asserts.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,7 @@ end of the block if any failures were encountered, but would continue otherwise.
Multiple assertion failures per test are stored in the representation of the test result using new XML elements, which
are not recognized by older runners. The following runners are known to support display of the new elements:

* NUnit 3 Visual Studio Adapter 3.7++ (Used by Visual Studio and `dotnet test`)
* NUnit3 Visual Studio Adapter 3.7++ (Used by Visual Studio and `dotnet test`)
* NUnit Console Runner 3.6++

#### Compatibility
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Updated misc articles to fix up version numbers, and update text to …#849

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

 Merged

SeanKilleen
merged 10 commits into

from

Dec 4, 2023
 Merged


Updated misc articles to fix up version numbers, and update text to …
#849
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
923105c

Updated misc articles to fix up version numbers, and update text to m…


OsirisTerje Dec 3, 2023
e2476a1

fixing line length issues


OsirisTerje Dec 3, 2023
47fa065

fixing more line length issues


OsirisTerje Dec 3, 2023
33d99a3

Update docs/articles/nunit/getting-started/dotnet-core-and-dotnet-sta…


OsirisTerje Dec 3, 2023
0b18499

Update docs/articles/nunit/getting-started/upgrading.md


OsirisTerje Dec 3, 2023
1d7674c

update


OsirisTerje Dec 3, 2023
b05ac79

Merge branch 'nunitupdate' of https://github.com/nunit/docs into nuni…


OsirisTerje Dec 3, 2023
1042cf4

update


OsirisTerje Dec 3, 2023
3d94e6c

Remove lint ignore


SeanKilleen Dec 3, 2023
80ad1b3

Run re-wrap command to fix linting


SeanKilleen Dec 3, 2023

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


34 changes: 21 additions & 13 deletions
docs/articles/nunit/getting-started/dotnet-core-and-dotnet-standard.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
# .NET Core and .NET Standard
# .NET Core

More information and getting started tutorials are available for NUnit and .NET Core targeting
[C#](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-with-nunit),
[F#](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-fsharp-with-nunit) and [Visual
Basic](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-visual-basic-with-nunit) in the .NET Core
documentation's [Unit Testing in .NET Core and .NET Standard](https://docs.microsoft.com/en-us/dotnet/core/testing/)
documentation's [Unit Testing in .NET Core](https://docs.microsoft.com/en-us/dotnet/core/testing/)
page.

The other information on this page is older documentation. If you follow the instructions in the [Installation
section](xref:installation) your project will work with .NET Core and .NET Standard.
section](xref:installation) your project will work with .NET Core.

The test projects have to be .NET (Core) or .NET Framework; .NET Standard can't be used as a test project, since it
can't be run on its own, but any code in a .NET Standard library can be tested from a .NET (Core) or .NET Framework test
project.

## TL;DR

Adding the adapter and `Microsoft.NET.Test.Sdk` version `17.0.0` or greater to your NUnit test projects will also enable
Adding the adapter and `Microsoft.NET.Test.Sdk` version `17.8.0` or greater to your NUnit test projects will also enable
the `dotnet test` command for .NET Core projects.

Any tests using the new style CSPROJ format, either .NET Core or .NET 4.x, need to add a `PackageReference` to the NuGet
Expand All@@ -27,10 +27,10 @@ the necessary references.

```xml
 <ItemGroup>
 <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.0" />
Comment thread
SeanKilleen marked this conversation as resolved.

 <PackageReference Include="NUnit" Version="3.13.3" />
 <PackageReference Include="NUnit3TestAdapter" Version="4.2.1" />
 <PackageReference Include="NUnit.Analyzers" Version="3.6.1" />
 <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
 <PackageReference Include="NUnit" Version="4.0.1" />
 <PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
 <PackageReference Include="NUnit.Analyzers" Version="3.10.0" />
 <PackageReference Include="coverlet.collector" Version="6.0.0" />
 </ItemGroup>
```
Expand DownExpand Up@@ -80,20 +80,28 @@ Framework.

This limitation is the same for all test adapters including xUnit and MSTest2.

#### My tests aren't showing up in Visual Studio 2017 or later
#### My tests aren't showing up in Visual Studio 2022 or later
Comment thread
SeanKilleen marked this conversation as resolved.


* Are you using the NuGet adapter package?
* Are you using version 4.1.0 or newer of the NuGet package?
* Are you using version 4.5.0 or newer of the NuGet package?
* Do your tests target .NET Core or the full .NET Framework? (see above)
* Have you added a Package Reference to `Microsoft.NET.Test.Sdk`?
* Have you restarted Visual Studio? It is still a bit temperamental.
* Are you doing integration testing with Asp.Net Core `WebApplicationFactory` and using minimal API, and it complains
 about missing `testhost.deps.json`? Then you're accessing the wrong Program class in your WebApplicationFactory. Fix
 it by adding a code line at the end of the `Program.cs` file, and verify that your WebApplicationFactory is actually
 using this Program class:

```csharp
 public partial class Program { }
```

#### My tests multi-target .NET Core and .NET Framework, why can't I run both in Visual Studio

This is a limitation of Visual Studio, hopefully it will be fixed in a future release.
This was a limitation in earlier versions of Visual Studio, but is fixed in Visual Studio 2022.

Meanwhile, you can run specific tests using the `--framework` command line option of [dotnet
test](https://docs.microsoft.com/en-ca/dotnet/core/tools/dotnet-test?tabs=netcore2x)
_If_ you must run an earlier version and have this issue, you can run specific tests using the `--framework` command
line option of [dotnet test](https://docs.microsoft.com/en-ca/dotnet/core/tools/dotnet-test?tabs=netcore2x)

## How do I produce a test results file

Expand Down

21 changes: 16 additions & 5 deletions
docs/articles/nunit/getting-started/upgrading.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
# Upgrading

This document assumes you are upgrading to NUnit 3.0 from NUnit 2.6 or later. While it's possible to upgrade from an
## Upgrading from NUnit 3.X to NUnit 4.X

See the [Migration Guide](xref:migrationguidance) for information on upgrading from NUnit 3.x to NUnit 4.x.

Also see the [Release Notes for version 4.0.0][def] for information on breaking and other changes to see if any of these
may affect your tests.

## Upgrading from NUnit 2.6.4 to NUnit 3.0

This section assumes you are upgrading to NUnit 3.0 from NUnit 2.6 or later. While it's possible to upgrade from an
earlier version, you will need to take into account many additional changes in NUnit, which are not described here. If
this is your situation, be sure to check the release notes for earlier versions of NUnit as well.

## Review Breaking Changes
### Review Breaking Changes

The [Breaking Changes](xref:breakingchanges) page lists missing and changed functionality in NUnit 3.0. You should
review this page to see which items are likely to affect your own tests.

## Update Your Code
### Update Your Code

In many cases, the items being removed have been deprecated for some time and an alternate approach may already be
available in your current release of NUnit. If that is the case, it will probably save you time and effort if you modify
Expand All@@ -20,15 +29,17 @@ For example, NUnit 3.0 no longer supports **ExpectedExceptionAttribute**. Howeve
your tests and use one of the alternatives instead, you can verify that they work in your present environment and they
will continue to work after conversion.**

## Switch to NUnit 3.0
### Switch to NUnit 3.0

Remove references to your old version of NUnit and replace them with references to NUnit 3.0. In the case of NUnitLite
executable tests, you will need to reference both the nunit.framework and NUnitLite assemblies. Compile your code. It's
possible that you will find compiler errors due to breaking changes in NUnit 3.0, which you missed in the prior step.
Make the necessary changes until it all works.

## Make the Tests Pass
### Make the Tests Pass

Hopefully, you aren't converting tests that were not passing when you started! If all goes well, they will continue to
pass under NUnit 3.0. If not, investigate each case and make necessary changes. If something isn't working as
advertised, please let us know.

[def]: https://docs.nunit.org/articles/nunit/release-notes/framework.html#nunit-400---november-26-2023

7 changes: 6 additions & 1 deletion
docs/articles/nunit/release-notes/breaking-changes.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,10 @@ uid: breakingchanges

## NUnit 4.0

* The [Classic Asserts](../writing-tests/assertions/assertion-models/classic.md) have been moved to a separate library
See the [Migration Guide](xref:migrationguidance) for moving your tests from NUnit 3.x to NUnit 4.0 if you are using any
of the following features:

* The [Classic Asserts][def] have been moved to a separate library
 and their namespace and their class name were renamed to: `NUnit.Framework.Legacy.ClassicAssert`.
* The standalone assert classes have also been moved to the `NUnit.Framework.Legacy` namespace. These classes are:
 * [CollectionAssert](../writing-tests/assertions/classic-assertions/Collection-Assert.md)
Expand DownExpand Up@@ -154,3 +157,5 @@ runner supports.
| `--noshadow` | Disable shadow copy | No longer supported. The console runner now disables shadow copy by default. use `--shadowcopy` on the command-line to turn it on. |
| `--nothread` | Disable use of a separate thread for tests | No longer supported. |
| `--nodots` | Do not display dots as a progress indicator | No longer supported. |

[def]: ../writing-tests/assertions/assertion-models/classic.md

14 changes: 6 additions & 8 deletions
docs/articles/nunit/writing-tests/assertions/assertion-models/constraint.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,28 +25,26 @@ overloads...

```csharp
Assert.That(bool condition);
Assert.That(bool condition, string message, params object[] params);
Assert.That(bool condition, string message);
Assert.That(bool condition, Func<string> getExceptionMessage);

Assert.That(Func<bool> condition);
Assert.That(Func<bool> condition, string message, params object[] params);
Assert.That(Func<bool> condition, string message);
Assert.That(Func<bool> condition, Func<string> getExceptionMessage);

Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint constraint)
Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint constraint,
 string message, object[] params)
 string message)
Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint expr,
 Func<string> getExceptionMessage)

Assert.That<TActual>(TActual actual, IResolveConstraint constraint)
Assert.That<TActual>(TActual actual, IResolveConstraint constraint, string message,
 params object[] params)
Assert.That<TActual>(TActual actual, IResolveConstraint constraint, string message)
Assert.That<TActual>(TActual actual, IResolveConstraint expression,
 Func<string> getExceptionMessage)

Assert.That(TestDelegate del, IResolveConstraint constraint)
Assert.That(TestDelegate code, IResolveConstraint constraint, string message,
 params object[] args)
Assert.That(TestDelegate code, IResolveConstraint constraint, string message)
Assert.That(TestDelegate code, IResolveConstraint constraint,
 Func<string> getExceptionMessage)
```
Expand All@@ -58,7 +56,7 @@ For overloads taking a constraint, the argument must be an object implementing t
which supports performing a test on an actual value and generating appropriate messages. This interface is described in
more detail under [Custom Constraints](xref:customconstraints).

NUnit provides a number of constraint classes similar to the **EqualConstraint** used in the example above. Generally,
NUnit provides a number of constraint classes similar to the **EqualConstraint** used in the examples above. Generally,
these classes may be used directly or through a syntax helper. The valid forms are described on the pages related to
each constraint.

Expand Down

5 changes: 2 additions & 3 deletions
docs/articles/nunit/writing-tests/assertions/assertions.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,14 +35,13 @@ approach have all been implemented internally using constraints. For example...
### Some notes on the Classic/Legacy asserts

The classic/legacy asserts, like `ClassicAssert.AreEqual`, have now been moved into its own project (namespace), and
will later be released as a separate package. They are now in the namespace `NUnit.Framework.Legacy`, and the `Assert`
may later be released as a separate package. They are now in the namespace `NUnit.Framework.Legacy`, and the `Assert`
have been renamed to `ClassicAssert`.

If you're upgrading from NUnit 3.X to NUnit 4, you need to add a using for `NUnit.Framework.Legacy` to your test
classes, and rename all classic asserts from `Assert` to `ClassicAssert`.

You *can* freely mix the constraint model assertions and the classic asserts in the same test class, but we don't
recommend it.
You *can* freely mix the constraint model assertions and the classic asserts in the same test class.

All assertions in the `ClassicAssert` class are rerouting to use the constraint model.

Expand Down

2 changes: 1 addition & 1 deletion
docs/articles/nunit/writing-tests/assertions/multiple-asserts.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,7 @@ end of the block if any failures were encountered, but would continue otherwise.
Multiple assertion failures per test are stored in the representation of the test result using new XML elements, which
are not recognized by older runners. The following runners are known to support display of the new elements:

* NUnit 3 Visual Studio Adapter 3.7++ (Used by Visual Studio and `dotnet test`)
* NUnit3 Visual Studio Adapter 3.7++ (Used by Visual Studio and `dotnet test`)
* NUnit Console Runner 3.6++

#### Compatibility
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Updated misc articles to fix up version numbers, and update text to …#849

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

 Merged

SeanKilleen
merged 10 commits into

from

Dec 4, 2023
 Merged


Updated misc articles to fix up version numbers, and update text to …
#849
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
923105c

Updated misc articles to fix up version numbers, and update text to m…


OsirisTerje Dec 3, 2023
e2476a1

fixing line length issues


OsirisTerje Dec 3, 2023
47fa065

fixing more line length issues


OsirisTerje Dec 3, 2023
33d99a3

Update docs/articles/nunit/getting-started/dotnet-core-and-dotnet-sta…


OsirisTerje Dec 3, 2023
0b18499

Update docs/articles/nunit/getting-started/upgrading.md


OsirisTerje Dec 3, 2023
1d7674c

update


OsirisTerje Dec 3, 2023
b05ac79

Merge branch 'nunitupdate' of https://github.com/nunit/docs into nuni…


OsirisTerje Dec 3, 2023
1042cf4

update


OsirisTerje Dec 3, 2023
3d94e6c

Remove lint ignore


SeanKilleen Dec 3, 2023
80ad1b3

Run re-wrap command to fix linting


SeanKilleen Dec 3, 2023

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


34 changes: 21 additions & 13 deletions
docs/articles/nunit/getting-started/dotnet-core-and-dotnet-standard.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
# .NET Core and .NET Standard
# .NET Core

More information and getting started tutorials are available for NUnit and .NET Core targeting
[C#](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-with-nunit),
[F#](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-fsharp-with-nunit) and [Visual
Basic](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-visual-basic-with-nunit) in the .NET Core
documentation's [Unit Testing in .NET Core and .NET Standard](https://docs.microsoft.com/en-us/dotnet/core/testing/)
documentation's [Unit Testing in .NET Core](https://docs.microsoft.com/en-us/dotnet/core/testing/)
page.

The other information on this page is older documentation. If you follow the instructions in the [Installation
section](xref:installation) your project will work with .NET Core and .NET Standard.
section](xref:installation) your project will work with .NET Core.

The test projects have to be .NET (Core) or .NET Framework; .NET Standard can't be used as a test project, since it
can't be run on its own, but any code in a .NET Standard library can be tested from a .NET (Core) or .NET Framework test
project.

## TL;DR

Adding the adapter and `Microsoft.NET.Test.Sdk` version `17.0.0` or greater to your NUnit test projects will also enable
Adding the adapter and `Microsoft.NET.Test.Sdk` version `17.8.0` or greater to your NUnit test projects will also enable
the `dotnet test` command for .NET Core projects.

Any tests using the new style CSPROJ format, either .NET Core or .NET 4.x, need to add a `PackageReference` to the NuGet
Expand All@@ -27,10 +27,10 @@ the necessary references.

```xml
 <ItemGroup>
 <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.0" />
Comment thread
SeanKilleen marked this conversation as resolved.

 <PackageReference Include="NUnit" Version="3.13.3" />
 <PackageReference Include="NUnit3TestAdapter" Version="4.2.1" />
 <PackageReference Include="NUnit.Analyzers" Version="3.6.1" />
 <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
 <PackageReference Include="NUnit" Version="4.0.1" />
 <PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
 <PackageReference Include="NUnit.Analyzers" Version="3.10.0" />
 <PackageReference Include="coverlet.collector" Version="6.0.0" />
 </ItemGroup>
```
Expand DownExpand Up@@ -80,20 +80,28 @@ Framework.

This limitation is the same for all test adapters including xUnit and MSTest2.

#### My tests aren't showing up in Visual Studio 2017 or later
#### My tests aren't showing up in Visual Studio 2022 or later
Comment thread
SeanKilleen marked this conversation as resolved.


* Are you using the NuGet adapter package?
* Are you using version 4.1.0 or newer of the NuGet package?
* Are you using version 4.5.0 or newer of the NuGet package?
* Do your tests target .NET Core or the full .NET Framework? (see above)
* Have you added a Package Reference to `Microsoft.NET.Test.Sdk`?
* Have you restarted Visual Studio? It is still a bit temperamental.
* Are you doing integration testing with Asp.Net Core `WebApplicationFactory` and using minimal API, and it complains
 about missing `testhost.deps.json`? Then you're accessing the wrong Program class in your WebApplicationFactory. Fix
 it by adding a code line at the end of the `Program.cs` file, and verify that your WebApplicationFactory is actually
 using this Program class:

```csharp
 public partial class Program { }
```

#### My tests multi-target .NET Core and .NET Framework, why can't I run both in Visual Studio

This is a limitation of Visual Studio, hopefully it will be fixed in a future release.
This was a limitation in earlier versions of Visual Studio, but is fixed in Visual Studio 2022.

Meanwhile, you can run specific tests using the `--framework` command line option of [dotnet
test](https://docs.microsoft.com/en-ca/dotnet/core/tools/dotnet-test?tabs=netcore2x)
_If_ you must run an earlier version and have this issue, you can run specific tests using the `--framework` command
line option of [dotnet test](https://docs.microsoft.com/en-ca/dotnet/core/tools/dotnet-test?tabs=netcore2x)

## How do I produce a test results file

Expand Down

21 changes: 16 additions & 5 deletions
docs/articles/nunit/getting-started/upgrading.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
# Upgrading

This document assumes you are upgrading to NUnit 3.0 from NUnit 2.6 or later. While it's possible to upgrade from an
## Upgrading from NUnit 3.X to NUnit 4.X

See the [Migration Guide](xref:migrationguidance) for information on upgrading from NUnit 3.x to NUnit 4.x.

Also see the [Release Notes for version 4.0.0][def] for information on breaking and other changes to see if any of these
may affect your tests.

## Upgrading from NUnit 2.6.4 to NUnit 3.0

This section assumes you are upgrading to NUnit 3.0 from NUnit 2.6 or later. While it's possible to upgrade from an
earlier version, you will need to take into account many additional changes in NUnit, which are not described here. If
this is your situation, be sure to check the release notes for earlier versions of NUnit as well.

## Review Breaking Changes
### Review Breaking Changes

The [Breaking Changes](xref:breakingchanges) page lists missing and changed functionality in NUnit 3.0. You should
review this page to see which items are likely to affect your own tests.

## Update Your Code
### Update Your Code

In many cases, the items being removed have been deprecated for some time and an alternate approach may already be
available in your current release of NUnit. If that is the case, it will probably save you time and effort if you modify
Expand All@@ -20,15 +29,17 @@ For example, NUnit 3.0 no longer supports **ExpectedExceptionAttribute**. Howeve
your tests and use one of the alternatives instead, you can verify that they work in your present environment and they
will continue to work after conversion.**

## Switch to NUnit 3.0
### Switch to NUnit 3.0

Remove references to your old version of NUnit and replace them with references to NUnit 3.0. In the case of NUnitLite
executable tests, you will need to reference both the nunit.framework and NUnitLite assemblies. Compile your code. It's
possible that you will find compiler errors due to breaking changes in NUnit 3.0, which you missed in the prior step.
Make the necessary changes until it all works.

## Make the Tests Pass
### Make the Tests Pass

Hopefully, you aren't converting tests that were not passing when you started! If all goes well, they will continue to
pass under NUnit 3.0. If not, investigate each case and make necessary changes. If something isn't working as
advertised, please let us know.

[def]: https://docs.nunit.org/articles/nunit/release-notes/framework.html#nunit-400---november-26-2023

7 changes: 6 additions & 1 deletion
docs/articles/nunit/release-notes/breaking-changes.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,10 @@ uid: breakingchanges

## NUnit 4.0

* The [Classic Asserts](../writing-tests/assertions/assertion-models/classic.md) have been moved to a separate library
See the [Migration Guide](xref:migrationguidance) for moving your tests from NUnit 3.x to NUnit 4.0 if you are using any
of the following features:

* The [Classic Asserts][def] have been moved to a separate library
 and their namespace and their class name were renamed to: `NUnit.Framework.Legacy.ClassicAssert`.
* The standalone assert classes have also been moved to the `NUnit.Framework.Legacy` namespace. These classes are:
 * [CollectionAssert](../writing-tests/assertions/classic-assertions/Collection-Assert.md)
Expand DownExpand Up@@ -154,3 +157,5 @@ runner supports.
| `--noshadow` | Disable shadow copy | No longer supported. The console runner now disables shadow copy by default. use `--shadowcopy` on the command-line to turn it on. |
| `--nothread` | Disable use of a separate thread for tests | No longer supported. |
| `--nodots` | Do not display dots as a progress indicator | No longer supported. |

[def]: ../writing-tests/assertions/assertion-models/classic.md

14 changes: 6 additions & 8 deletions
docs/articles/nunit/writing-tests/assertions/assertion-models/constraint.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,28 +25,26 @@ overloads...

```csharp
Assert.That(bool condition);
Assert.That(bool condition, string message, params object[] params);
Assert.That(bool condition, string message);
Assert.That(bool condition, Func<string> getExceptionMessage);

Assert.That(Func<bool> condition);
Assert.That(Func<bool> condition, string message, params object[] params);
Assert.That(Func<bool> condition, string message);
Assert.That(Func<bool> condition, Func<string> getExceptionMessage);

Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint constraint)
Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint constraint,
 string message, object[] params)
 string message)
Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint expr,
 Func<string> getExceptionMessage)

Assert.That<TActual>(TActual actual, IResolveConstraint constraint)
Assert.That<TActual>(TActual actual, IResolveConstraint constraint, string message,
 params object[] params)
Assert.That<TActual>(TActual actual, IResolveConstraint constraint, string message)
Assert.That<TActual>(TActual actual, IResolveConstraint expression,
 Func<string> getExceptionMessage)

Assert.That(TestDelegate del, IResolveConstraint constraint)
Assert.That(TestDelegate code, IResolveConstraint constraint, string message,
 params object[] args)
Assert.That(TestDelegate code, IResolveConstraint constraint, string message)
Assert.That(TestDelegate code, IResolveConstraint constraint,
 Func<string> getExceptionMessage)
```
Expand All@@ -58,7 +56,7 @@ For overloads taking a constraint, the argument must be an object implementing t
which supports performing a test on an actual value and generating appropriate messages. This interface is described in
more detail under [Custom Constraints](xref:customconstraints).

NUnit provides a number of constraint classes similar to the **EqualConstraint** used in the example above. Generally,
NUnit provides a number of constraint classes similar to the **EqualConstraint** used in the examples above. Generally,
these classes may be used directly or through a syntax helper. The valid forms are described on the pages related to
each constraint.

Expand Down

5 changes: 2 additions & 3 deletions
docs/articles/nunit/writing-tests/assertions/assertions.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,14 +35,13 @@ approach have all been implemented internally using constraints. For example...
### Some notes on the Classic/Legacy asserts

The classic/legacy asserts, like `ClassicAssert.AreEqual`, have now been moved into its own project (namespace), and
will later be released as a separate package. They are now in the namespace `NUnit.Framework.Legacy`, and the `Assert`
may later be released as a separate package. They are now in the namespace `NUnit.Framework.Legacy`, and the `Assert`
have been renamed to `ClassicAssert`.

If you're upgrading from NUnit 3.X to NUnit 4, you need to add a using for `NUnit.Framework.Legacy` to your test
classes, and rename all classic asserts from `Assert` to `ClassicAssert`.

You *can* freely mix the constraint model assertions and the classic asserts in the same test class, but we don't
recommend it.
You *can* freely mix the constraint model assertions and the classic asserts in the same test class.

All assertions in the `ClassicAssert` class are rerouting to use the constraint model.

Expand Down

2 changes: 1 addition & 1 deletion
docs/articles/nunit/writing-tests/assertions/multiple-asserts.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,7 @@ end of the block if any failures were encountered, but would continue otherwise.
Multiple assertion failures per test are stored in the representation of the test result using new XML elements, which
are not recognized by older runners. The following runners are known to support display of the new elements:

* NUnit 3 Visual Studio Adapter 3.7++ (Used by Visual Studio and `dotnet test`)
* NUnit3 Visual Studio Adapter 3.7++ (Used by Visual Studio and `dotnet test`)
* NUnit Console Runner 3.6++

#### Compatibility
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Updated misc articles to fix up version numbers, and update text to …#849

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

 Merged

SeanKilleen
merged 10 commits into

from

Dec 4, 2023
 Merged


Updated misc articles to fix up version numbers, and update text to …
#849
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
923105c

Updated misc articles to fix up version numbers, and update text to m…


OsirisTerje Dec 3, 2023
e2476a1

fixing line length issues


OsirisTerje Dec 3, 2023
47fa065

fixing more line length issues


OsirisTerje Dec 3, 2023
33d99a3

Update docs/articles/nunit/getting-started/dotnet-core-and-dotnet-sta…


OsirisTerje Dec 3, 2023
0b18499

Update docs/articles/nunit/getting-started/upgrading.md


OsirisTerje Dec 3, 2023
1d7674c

update


OsirisTerje Dec 3, 2023
b05ac79

Merge branch 'nunitupdate' of https://github.com/nunit/docs into nuni…


OsirisTerje Dec 3, 2023
1042cf4

update


OsirisTerje Dec 3, 2023
3d94e6c

Remove lint ignore


SeanKilleen Dec 3, 2023
80ad1b3

Run re-wrap command to fix linting


SeanKilleen Dec 3, 2023

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


34 changes: 21 additions & 13 deletions
docs/articles/nunit/getting-started/dotnet-core-and-dotnet-standard.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
# .NET Core and .NET Standard
# .NET Core

More information and getting started tutorials are available for NUnit and .NET Core targeting
[C#](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-with-nunit),
[F#](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-fsharp-with-nunit) and [Visual
Basic](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-visual-basic-with-nunit) in the .NET Core
documentation's [Unit Testing in .NET Core and .NET Standard](https://docs.microsoft.com/en-us/dotnet/core/testing/)
documentation's [Unit Testing in .NET Core](https://docs.microsoft.com/en-us/dotnet/core/testing/)
page.

The other information on this page is older documentation. If you follow the instructions in the [Installation
section](xref:installation) your project will work with .NET Core and .NET Standard.
section](xref:installation) your project will work with .NET Core.

The test projects have to be .NET (Core) or .NET Framework; .NET Standard can't be used as a test project, since it
can't be run on its own, but any code in a .NET Standard library can be tested from a .NET (Core) or .NET Framework test
project.

## TL;DR

Adding the adapter and `Microsoft.NET.Test.Sdk` version `17.0.0` or greater to your NUnit test projects will also enable
Adding the adapter and `Microsoft.NET.Test.Sdk` version `17.8.0` or greater to your NUnit test projects will also enable
the `dotnet test` command for .NET Core projects.

Any tests using the new style CSPROJ format, either .NET Core or .NET 4.x, need to add a `PackageReference` to the NuGet
Expand All@@ -27,10 +27,10 @@ the necessary references.

```xml
 <ItemGroup>
 <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.0" />
Comment thread
SeanKilleen marked this conversation as resolved.

 <PackageReference Include="NUnit" Version="3.13.3" />
 <PackageReference Include="NUnit3TestAdapter" Version="4.2.1" />
 <PackageReference Include="NUnit.Analyzers" Version="3.6.1" />
 <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
 <PackageReference Include="NUnit" Version="4.0.1" />
 <PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
 <PackageReference Include="NUnit.Analyzers" Version="3.10.0" />
 <PackageReference Include="coverlet.collector" Version="6.0.0" />
 </ItemGroup>
```
Expand DownExpand Up@@ -80,20 +80,28 @@ Framework.

This limitation is the same for all test adapters including xUnit and MSTest2.

#### My tests aren't showing up in Visual Studio 2017 or later
#### My tests aren't showing up in Visual Studio 2022 or later
Comment thread
SeanKilleen marked this conversation as resolved.


* Are you using the NuGet adapter package?
* Are you using version 4.1.0 or newer of the NuGet package?
* Are you using version 4.5.0 or newer of the NuGet package?
* Do your tests target .NET Core or the full .NET Framework? (see above)
* Have you added a Package Reference to `Microsoft.NET.Test.Sdk`?
* Have you restarted Visual Studio? It is still a bit temperamental.
* Are you doing integration testing with Asp.Net Core `WebApplicationFactory` and using minimal API, and it complains
 about missing `testhost.deps.json`? Then you're accessing the wrong Program class in your WebApplicationFactory. Fix
 it by adding a code line at the end of the `Program.cs` file, and verify that your WebApplicationFactory is actually
 using this Program class:

```csharp
 public partial class Program { }
```

#### My tests multi-target .NET Core and .NET Framework, why can't I run both in Visual Studio

This is a limitation of Visual Studio, hopefully it will be fixed in a future release.
This was a limitation in earlier versions of Visual Studio, but is fixed in Visual Studio 2022.

Meanwhile, you can run specific tests using the `--framework` command line option of [dotnet
test](https://docs.microsoft.com/en-ca/dotnet/core/tools/dotnet-test?tabs=netcore2x)
_If_ you must run an earlier version and have this issue, you can run specific tests using the `--framework` command
line option of [dotnet test](https://docs.microsoft.com/en-ca/dotnet/core/tools/dotnet-test?tabs=netcore2x)

## How do I produce a test results file

Expand Down

21 changes: 16 additions & 5 deletions
docs/articles/nunit/getting-started/upgrading.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
# Upgrading

This document assumes you are upgrading to NUnit 3.0 from NUnit 2.6 or later. While it's possible to upgrade from an
## Upgrading from NUnit 3.X to NUnit 4.X

See the [Migration Guide](xref:migrationguidance) for information on upgrading from NUnit 3.x to NUnit 4.x.

Also see the [Release Notes for version 4.0.0][def] for information on breaking and other changes to see if any of these
may affect your tests.

## Upgrading from NUnit 2.6.4 to NUnit 3.0

This section assumes you are upgrading to NUnit 3.0 from NUnit 2.6 or later. While it's possible to upgrade from an
earlier version, you will need to take into account many additional changes in NUnit, which are not described here. If
this is your situation, be sure to check the release notes for earlier versions of NUnit as well.

## Review Breaking Changes
### Review Breaking Changes

The [Breaking Changes](xref:breakingchanges) page lists missing and changed functionality in NUnit 3.0. You should
review this page to see which items are likely to affect your own tests.

## Update Your Code
### Update Your Code

In many cases, the items being removed have been deprecated for some time and an alternate approach may already be
available in your current release of NUnit. If that is the case, it will probably save you time and effort if you modify
Expand All@@ -20,15 +29,17 @@ For example, NUnit 3.0 no longer supports **ExpectedExceptionAttribute**. Howeve
your tests and use one of the alternatives instead, you can verify that they work in your present environment and they
will continue to work after conversion.**

## Switch to NUnit 3.0
### Switch to NUnit 3.0

Remove references to your old version of NUnit and replace them with references to NUnit 3.0. In the case of NUnitLite
executable tests, you will need to reference both the nunit.framework and NUnitLite assemblies. Compile your code. It's
possible that you will find compiler errors due to breaking changes in NUnit 3.0, which you missed in the prior step.
Make the necessary changes until it all works.

## Make the Tests Pass
### Make the Tests Pass

Hopefully, you aren't converting tests that were not passing when you started! If all goes well, they will continue to
pass under NUnit 3.0. If not, investigate each case and make necessary changes. If something isn't working as
advertised, please let us know.

[def]: https://docs.nunit.org/articles/nunit/release-notes/framework.html#nunit-400---november-26-2023

7 changes: 6 additions & 1 deletion
docs/articles/nunit/release-notes/breaking-changes.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,10 @@ uid: breakingchanges

## NUnit 4.0

* The [Classic Asserts](../writing-tests/assertions/assertion-models/classic.md) have been moved to a separate library
See the [Migration Guide](xref:migrationguidance) for moving your tests from NUnit 3.x to NUnit 4.0 if you are using any
of the following features:

* The [Classic Asserts][def] have been moved to a separate library
 and their namespace and their class name were renamed to: `NUnit.Framework.Legacy.ClassicAssert`.
* The standalone assert classes have also been moved to the `NUnit.Framework.Legacy` namespace. These classes are:
 * [CollectionAssert](../writing-tests/assertions/classic-assertions/Collection-Assert.md)
Expand DownExpand Up@@ -154,3 +157,5 @@ runner supports.
| `--noshadow` | Disable shadow copy | No longer supported. The console runner now disables shadow copy by default. use `--shadowcopy` on the command-line to turn it on. |
| `--nothread` | Disable use of a separate thread for tests | No longer supported. |
| `--nodots` | Do not display dots as a progress indicator | No longer supported. |

[def]: ../writing-tests/assertions/assertion-models/classic.md

14 changes: 6 additions & 8 deletions
docs/articles/nunit/writing-tests/assertions/assertion-models/constraint.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,28 +25,26 @@ overloads...

```csharp
Assert.That(bool condition);
Assert.That(bool condition, string message, params object[] params);
Assert.That(bool condition, string message);
Assert.That(bool condition, Func<string> getExceptionMessage);

Assert.That(Func<bool> condition);
Assert.That(Func<bool> condition, string message, params object[] params);
Assert.That(Func<bool> condition, string message);
Assert.That(Func<bool> condition, Func<string> getExceptionMessage);

Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint constraint)
Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint constraint,
 string message, object[] params)
 string message)
Assert.That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint expr,
 Func<string> getExceptionMessage)

Assert.That<TActual>(TActual actual, IResolveConstraint constraint)
Assert.That<TActual>(TActual actual, IResolveConstraint constraint, string message,
 params object[] params)
Assert.That<TActual>(TActual actual, IResolveConstraint constraint, string message)
Assert.That<TActual>(TActual actual, IResolveConstraint expression,
 Func<string> getExceptionMessage)

Assert.That(TestDelegate del, IResolveConstraint constraint)
Assert.That(TestDelegate code, IResolveConstraint constraint, string message,
 params object[] args)
Assert.That(TestDelegate code, IResolveConstraint constraint, string message)
Assert.That(TestDelegate code, IResolveConstraint constraint,
 Func<string> getExceptionMessage)
```
Expand All@@ -58,7 +56,7 @@ For overloads taking a constraint, the argument must be an object implementing t
which supports performing a test on an actual value and generating appropriate messages. This interface is described in
more detail under [Custom Constraints](xref:customconstraints).

NUnit provides a number of constraint classes similar to the **EqualConstraint** used in the example above. Generally,
NUnit provides a number of constraint classes similar to the **EqualConstraint** used in the examples above. Generally,
these classes may be used directly or through a syntax helper. The valid forms are described on the pages related to
each constraint.

Expand Down

5 changes: 2 additions & 3 deletions
docs/articles/nunit/writing-tests/assertions/assertions.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,14 +35,13 @@ approach have all been implemented internally using constraints. For example...
### Some notes on the Classic/Legacy asserts

The classic/legacy asserts, like `ClassicAssert.AreEqual`, have now been moved into its own project (namespace), and
will later be released as a separate package. They are now in the namespace `NUnit.Framework.Legacy`, and the `Assert`
may later be released as a separate package. They are now in the namespace `NUnit.Framework.Legacy`, and the `Assert`
have been renamed to `ClassicAssert`.

If you're upgrading from NUnit 3.X to NUnit 4, you need to add a using for `NUnit.Framework.Legacy` to your test
classes, and rename all classic asserts from `Assert` to `ClassicAssert`.

You *can* freely mix the constraint model assertions and the classic asserts in the same test class, but we don't
recommend it.
You *can* freely mix the constraint model assertions and the classic asserts in the same test class.

All assertions in the `ClassicAssert` class are rerouting to use the constraint model.

Expand Down

2 changes: 1 addition & 1 deletion
docs/articles/nunit/writing-tests/assertions/multiple-asserts.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,7 @@ end of the block if any failures were encountered, but would continue otherwise.
Multiple assertion failures per test are stored in the representation of the test result using new XML elements, which
are not recognized by older runners. The following runners are known to support display of the new elements:

* NUnit 3 Visual Studio Adapter 3.7++ (Used by Visual Studio and `dotnet test`)
* NUnit3 Visual Studio Adapter 3.7++ (Used by Visual Studio and `dotnet test`)
* NUnit Console Runner 3.6++

#### Compatibility
Expand Down