Skip to content
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

Jump to bottom

Add entry describing how to add 'global using' in a Directory.Build.props file #885

Merged
merged 3 commits into from
Jan 22, 2024
Merged

Add entry describing how to add 'global using' in a Directory.Build.props file #885

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4ebc96c
Add entry describing how to add 'global using' in a Directory.Build.p…
manfred-brands Jan 22, 2024
030a3f7
Apply suggestions from code review
manfred-brands Jan 22, 2024
c3e2358
Clean up sentence
manfred-brands Jan 22, 2024
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
23 changes: 22 additions & 1 deletion docs/articles/nunit/release-notes/Nunit4.0-MigrationGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ There are different ways to migrate these to NUnit 4.0
* Convert Classic Assert to the [Constraint model](../writing-tests/assertions/assertion-models/constraint.md)
* Update source code to new namespace and class name
* Using `global using` aliases
* In own source file
* In project file or `Directory.Build.props`

In the sections below we use the following simple test as an example:

Expand Down Expand Up @@ -128,7 +130,7 @@ substitute to do only the asserts that need converting, but there are quite a lo
1. Convert `Assert.True` into `ClassicAssert.True`.
1. Similar for `IsTrue`, `False`, `IsFalse`, `Greater`, `Less`, ...

Depending on what is less work, alternatively you can reverse the substitution of those that shouldn't be have been
Depending on what is less work, alternatively you can reverse the substitution of those that shouldn't have been
changed:
1. Convert `ClassicAssert.That` into `Assert.That`.
1. Convert `ClassicAssert.Fail` into `Assert.Fail`.
Expand Down Expand Up @@ -157,6 +159,25 @@ global using FileAssert = NUnit.Framework.Legacy.FileAssert;
Note that this doesn't mean you have to target .NET 6.0. This also works if targeting .NET Framework as it is purely
done on the source code level.

If you have to do this for multiple projects in a repository, this is not handy.
It seems [somebody else thought of that](https://github.com/dotnet/msbuild/issues/6745) and
it is now possible to add global usings in a
[`Directory.Build.props`](https://learn.microsoft.com/en-us/visualstudio/msbuild/customize-by-directory?view=vs-2022#directorybuildprops-and-directorybuildtargets)
file which will be used by all projects in a repository:

```xml
<ItemGroup>
<Using Include="NUnit.Framework.Legacy.ClassicAssert" Alias="Assert" />
<Using Include="NUnit.Framework.Legacy.CollectionAssert" Alias="CollectionAssert" />
<Using Include="NUnit.Framework.Legacy.StringAssert" Alias="StringAssert" />
<Using Include="NUnit.Framework.Legacy.DirectoryAssert" Alias="DirectoryAssert" />
<Using Include="NUnit.Framework.Legacy.FileAssert" Alias="FileAssert" />
</ItemGroup>
```

The build process now automatically creates a `${Project}.GlobalUsings.g.cs` file
for each project with a contents similar to the one shown above.

### Assert.That with _format_ specification and `params` overload conversion

These overloads were removed to allow for better messages in case of failure. See [The "Towards NUnit 4"
Expand Down