Skip to content

Commit 6a295a5

Browse files
milangdependabot[bot]
milang
and
dependabot[bot]
authored
Safer formatting of assertion messages (#159)
* Bump NUnit.Analyzers from 4.4.0 to 4.5.0 Bumps [NUnit.Analyzers](https://github.com/nunit/nunit.analyzers) from 4.4.0 to 4.5.0. - [Release notes](https://github.com/nunit/nunit.analyzers/releases) - [Changelog](https://github.com/nunit/nunit.analyzers/blob/master/CHANGES.md) - [Commits](nunit/nunit.analyzers@4.4.0...4.5.0) --- updated-dependencies: - dependency-name: NUnit.Analyzers dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * Bump Akka.TestKit from 1.5.32 to 1.5.33 Bumps [Akka.TestKit](https://github.com/akkadotnet/akka.net) from 1.5.32 to 1.5.33. - [Release notes](https://github.com/akkadotnet/akka.net/releases) - [Changelog](https://github.com/akkadotnet/akka.net/blob/dev/RELEASE_NOTES.md) - [Commits](akkadotnet/akka.net@1.5.32...1.5.33) --- updated-dependencies: - dependency-name: Akka.TestKit dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> * Bump NUnit from 4.2.2 to 4.3.2 Bumps [NUnit](https://github.com/nunit/nunit) from 4.2.2 to 4.3.2. - [Release notes](https://github.com/nunit/nunit/releases) - [Changelog](https://github.com/nunit/nunit/blob/main/CHANGES.md) - [Commits](nunit/nunit@4.2.2...4.3.2) --- updated-dependencies: - dependency-name: NUnit dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * Switch to .NET SDK 9 and C# 13 * Use "AssertBase.ConvertMessageWithArgs" to format assertion messages * Test that assertion messages are used as-is when no arguments are specified * Run tests using .NET 8 (.NET 6 runtime is no longer available on Linux) * Add release notes entry for 1.5.33 --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
1 parent 30a266e commit 6a295a5

File tree

7 files changed

+65
-35
lines changed

7 files changed

+65
-35
lines changed

‎.github/workflows/pr_validation.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
windows-latest:
3131
name: windows-latest
3232
runs-on: windows-latest
33-
33+
3434
steps:
3535
- name: "Checkout"
3636
uses: actions/[email protected]
@@ -57,11 +57,11 @@ jobs:
5757

5858
- name: "dotnet pack"
5959
run: dotnet pack -c Release -o ./bin/nuget
60-
60+
6161
ubuntu-latest:
6262
name: ubuntu-latest
6363
runs-on: ubuntu-latest
64-
64+
6565
steps:
6666
- name: "Checkout"
6767
uses: actions/[email protected]
@@ -81,11 +81,11 @@ jobs:
8181
8282
- name: "dotnet build"
8383
run: dotnet build -c Release
84-
84+
8585
# .NET Framework tests can't run reliably on Linux, so we only do .NET Core
8686
- name: "dotnet test"
8787
shell: bash
88-
run: dotnet test -c Release -f net6.0
88+
run: dotnet test -c Release -f net8.0
8989

9090
- name: "dotnet pack"
9191
run: dotnet pack -c Release -o ./bin/nuget

‎Directory.Build.props

+10-16
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,23 @@
66
<Description>TestKit for writing tests for Akka.NET using NUnit.</Description>
77
<PackageTags>akka;actors;actor model;Akka;concurrency;testkit;nunit</PackageTags>
88
<GenerateDocumentationFile>true</GenerateDocumentationFile>
9-
<PackageIcon>akka.png</PackageIcon>
10-
<!-- https://github.com/NuGet/Home/wiki/Packaging-Icon-within-the-nupkg -->
9+
<PackageIcon>akka.png</PackageIcon><!-- https://github.com/NuGet/Home/wiki/Packaging-Icon-within-the-nupkg -->
1110
<PackageProjectUrl>https://github.com/AkkaNetContrib/Akka.TestKit.Nunit</PackageProjectUrl>
1211
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
13-
<PackageReadmeFile>README.md</PackageReadmeFile>
14-
<!-- https://devblogs.microsoft.com/nuget/add-a-readme-to-your-nuget-package/ -->
12+
<PackageReadmeFile>README.md</PackageReadmeFile><!-- https://devblogs.microsoft.com/nuget/add-a-readme-to-your-nuget-package/ -->
1513
<NoWarn>$(NoWarn);CS1591</NoWarn>
16-
<LangVersion>10.0</LangVersion>
17-
<ContinuousIntegrationBuild Condition=" '$(Configuration)' == 'Release' ">true</ContinuousIntegrationBuild>
18-
<!-- https://learn.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#continuousintegrationbuild -->
19-
<AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
20-
<!-- https://learn.microsoft.com/en-us/dotnet/standard/library-guidance/nuget#symbol-packages -->
21-
<EmbedUntrackedSources>true</EmbedUntrackedSources>
22-
<!-- https://github.com/dotnet/sourcelink/blob/main/docs/README.md#embeduntrackedsources -->
23-
<PublishRepositoryUrl>true</PublishRepositoryUrl>
24-
<!-- https://github.com/dotnet/sourcelink/blob/main/docs/README.md#publishrepositoryurl -->
14+
<LangVersion>13.0</LangVersion>
15+
<ContinuousIntegrationBuild Condition=" '$(Configuration)' == 'Release' ">true</ContinuousIntegrationBuild><!-- https://learn.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#continuousintegrationbuild -->
16+
<AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder><!-- https://learn.microsoft.com/en-us/dotnet/standard/library-guidance/nuget#symbol-packages -->
17+
<EmbedUntrackedSources>true</EmbedUntrackedSources><!-- https://github.com/dotnet/sourcelink/blob/main/docs/README.md#embeduntrackedsources -->
18+
<PublishRepositoryUrl>true</PublishRepositoryUrl><!-- https://github.com/dotnet/sourcelink/blob/main/docs/README.md#publishrepositoryurl -->
2519
</PropertyGroup>
2620
<PropertyGroup>
27-
<AkkaTestKitVersion>1.5.32</AkkaTestKitVersion>
21+
<AkkaTestKitVersion>1.5.33</AkkaTestKitVersion>
2822
<MicrosoftNetTestSdkVersion>17.12.0</MicrosoftNetTestSdkVersion>
2923
<NUnit3Version>3.14.0</NUnit3Version>
30-
<NUnit4Version>4.2.2</NUnit4Version>
31-
<NUnitAnalyzersVersion>4.4.0</NUnitAnalyzersVersion>
24+
<NUnit4Version>4.3.2</NUnit4Version>
25+
<NUnitAnalyzersVersion>4.5.0</NUnitAnalyzersVersion>
3226
<NUnitTestAdapterVersion>4.6.0</NUnitTestAdapterVersion>
3327
</PropertyGroup>
3428
<PropertyGroup Condition=" '$(Configuration)' == 'Release' ">

‎RELEASE_NOTES.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
#### 1.5.33 January 4th 2025 ####
2+
- Safer formatting of assertion messages
3+
- Bump `NUnit` to [4.3.2](https://github.com/nunit/nunit/releases/tag/4.3.2)
4+
- Bump `NUnit.Analyzers` to [4.5.0](https://github.com/nunit/nunit.analyzers/releases/tag/4.5.0)
5+
- Bump `Akka.TestKit` to [1.5.33](https://github.com/akkadotnet/akka.net/releases/tag/1.5.33)
6+
17
#### 1.5.32 December 20th 2024 ####
28
- Bump `Akka.TestKit` to [1.5.32](https://github.com/akkadotnet/akka.net/releases/tag/1.5.32)
39
- Bump `NUnit3TestAdapter` to [4.6.0](https://github.com/nunit/nunit3-vs-adapter/releases/tag/V4.6.0)

‎global.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"sdk": {
33
"rollForward": "latestFeature",
4-
"version": "6.0.428"
4+
"version": "9.0.101"
55
}
66
}

‎src/Akka.TestKit.NUnit.Tests/Akka.TestKit.NUnit.Tests.csproj

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Project Sdk="Microsoft.NET.Sdk">
22
<PropertyGroup>
3-
<TargetFrameworks>net6.0;net462</TargetFrameworks>
3+
<TargetFrameworks>net8.0;net462</TargetFrameworks>
44
</PropertyGroup>
55

66
<ItemGroup>

‎src/Akka.TestKit.NUnit.Tests/AssertionsTests.cs

+26-6
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,7 @@ namespace Akka.TestKit.NUnit.Tests
1212
[Parallelizable(ParallelScope.All)]
1313
public class AssertionsTests : TestKit
1414
{
15-
private readonly NUnitAssertions _assertions;
16-
17-
public AssertionsTests()
18-
{
19-
_assertions = new NUnitAssertions();
20-
}
15+
private readonly NUnitAssertions _assertions = new();
2116

2217
[Test]
2318
public void Fail_should_throw()
@@ -72,5 +67,30 @@ public void AssertEqualWithComparer_should_succeed_on_equal()
7267
{
7368
_assertions.AssertEqual(42, 4711, (x, y) => true);
7469
}
70+
71+
[Test]
72+
public void Assert_should_not_format_message_when_no_arguments_are_specified()
73+
{
74+
const string testMessage = "{Value} with different format placeholders {0}";
75+
76+
Assert.Multiple(() =>
77+
{
78+
Assert.That(
79+
code: () => _assertions.Fail(testMessage),
80+
constraint: Throws.Exception.TypeOf<AssertionException>().And.Message.Contains(testMessage));
81+
Assert.That(
82+
code: () => _assertions.AssertTrue(false, testMessage),
83+
constraint: Throws.Exception.TypeOf<AssertionException>().And.Message.Contains(testMessage));
84+
Assert.That(
85+
code: () => _assertions.AssertFalse(true, testMessage),
86+
constraint: Throws.Exception.TypeOf<AssertionException>().And.Message.Contains(testMessage));
87+
Assert.That(
88+
code: () => _assertions.AssertEqual(4, 2, testMessage),
89+
constraint: Throws.Exception.TypeOf<AssertionException>().And.Message.Contains(testMessage));
90+
Assert.That(
91+
code: () => _assertions.AssertEqual(4, 2, (_, _) => false, testMessage),
92+
constraint: Throws.Exception.TypeOf<AssertionException>().And.Message.Contains(testMessage));
93+
});
94+
}
7595
}
7696
}

‎src/Akka.TestKit.NUnit/NUnitAssertions.cs

+16-6
Original file line numberDiff line numberDiff line change
@@ -15,30 +15,40 @@ namespace Akka.TestKit.NUnit
1515
/// </summary>
1616
public class NUnitAssertions : ITestKitAssertions
1717
{
18-
1918
public void Fail(string format = "", params object[] args)
2019
{
21-
Assert.Fail(string.Format(format, args));
20+
Assert.Fail(NUnitAssertBase.ConvertMessageWithArgs(format, args));
2221
}
2322

2423
public void AssertTrue(bool condition, string format = "", params object[] args)
2524
{
26-
Assert.That(condition, Is.True, string.Format(format, args));
25+
Assert.That(condition, Is.True, NUnitAssertBase.ConvertMessageWithArgs(format, args));
2726
}
2827

2928
public void AssertFalse(bool condition, string format = "", params object[] args)
3029
{
31-
Assert.That(condition, Is.False, string.Format(format, args));
30+
Assert.That(condition, Is.False, NUnitAssertBase.ConvertMessageWithArgs(format, args));
3231
}
3332

3433
public void AssertEqual<T>(T expected, T actual, string format = "", params object[] args)
3534
{
36-
Assert.That(actual, Is.EqualTo(expected), string.Format(format, args));
35+
Assert.That(actual, Is.EqualTo(expected), NUnitAssertBase.ConvertMessageWithArgs(format, args));
3736
}
3837

3938
public void AssertEqual<T>(T expected, T actual, Func<T, T, bool> comparer, string format = "", params object[] args)
4039
{
41-
Assert.That(actual, Is.EqualTo(expected).Using<T>(comparer), string.Format(format, args));
40+
Assert.That(actual, Is.EqualTo(expected).Using<T>(comparer), NUnitAssertBase.ConvertMessageWithArgs(format, args));
41+
}
42+
43+
/// <remarks>
44+
/// This class only exists to allow us to call <c>NUnit.Framework.AssertBase.ConvertMessageWithArgs</c>.
45+
/// As of NUnit 4.3.1, this method is declared <c>protected</c> and thus cannot be called directly.
46+
/// See https://github.com/nunit/nunit/blob/4.3.1/src/NUnitFramework/framework/AssertBase.cs#L10-L14.
47+
/// </remarks>
48+
private sealed class NUnitAssertBase : AssertBase
49+
{
50+
public new static string ConvertMessageWithArgs(string message, object[] args) =>
51+
AssertBase.ConvertMessageWithArgs(message, args);
4252
}
4353
}
4454
}

0 commit comments

Comments
 (0)