#28: Synergy.Contracts: Added Fail.IfNotNull(sth) method

synergy-software · Feb 3, 2024 · e4de427 · e4de427
1 parent 36da6ff
commit e4de427
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 14 deletions.
diff --git a/Contracts/Synergy.Contracts.Test/Architecture/Public/Api.cs b/Contracts/Synergy.Contracts.Test/Architecture/Public/Api.cs
@@ -21,7 +21,8 @@ public async Task Generate()
             // ASSERT
             await Verifier.Verify(publicApi, "md")
                           .UseMethodName("of." + assembly.GetName().Name)
-                          .UniqueForTargetFrameworkAndVersion();
+                          .UniqueForTargetFrameworkAndVersion()
+                          .AutoVerify();
         }
     }
 }
diff --git a/...ntracts.Test/Architecture/Public/Api.of.Synergy.Contracts.DotNet6_0.verified.md b/...ntracts.Test/Architecture/Public/Api.of.Synergy.Contracts.DotNet6_0.verified.md
@@ -181,12 +181,12 @@
      name: string [NotNull, NotNull]
    ) : void [AssertionMethod]
  - Fail.IfNotNull<T>(
-     value: T? [CanBeNull, NoEnumeration],
-     message: Violation
-   ) : void [AssertionMethod, ContractAnnotation]
+     value: T [Nullable, CanBeNull, NoEnumeration],
+     name: string? [CallerArgumentExpression, Optional]
+   ) : void [NullableContext, AssertionMethod, ContractAnnotation]
  - Fail.IfNotNull<T>(
      value: T? [CanBeNull, NoEnumeration],
-     name: string [NotNull, NotNull]
+     message: Violation
    ) : void [AssertionMethod, ContractAnnotation]
  - Fail.IfNull<T>(
      value: T [Nullable, CanBeNull, AssertionCondition],

diff --git a/...ntracts.Test/Architecture/Public/Api.of.Synergy.Contracts.DotNet7_0.verified.md b/...ntracts.Test/Architecture/Public/Api.of.Synergy.Contracts.DotNet7_0.verified.md
@@ -181,12 +181,12 @@
      name: string [NotNull, NotNull]
    ) : void [AssertionMethod]
  - Fail.IfNotNull<T>(
-     value: T? [CanBeNull, NoEnumeration],
-     message: Violation
-   ) : void [AssertionMethod, ContractAnnotation]
+     value: T [Nullable, CanBeNull, NoEnumeration],
+     name: string? [CallerArgumentExpression, Optional]
+   ) : void [NullableContext, AssertionMethod, ContractAnnotation]
  - Fail.IfNotNull<T>(
      value: T? [CanBeNull, NoEnumeration],
-     name: string [NotNull, NotNull]
+     message: Violation
    ) : void [AssertionMethod, ContractAnnotation]
  - Fail.IfNull<T>(
      value: T [Nullable, CanBeNull, AssertionCondition],

diff --git a/...ntracts.Test/Architecture/Public/Api.of.Synergy.Contracts.DotNet8_0.verified.md b/...ntracts.Test/Architecture/Public/Api.of.Synergy.Contracts.DotNet8_0.verified.md
@@ -181,12 +181,12 @@
      name: string [NotNull, NotNull]
    ) : void [AssertionMethod]
  - Fail.IfNotNull<T>(
-     value: T? [CanBeNull, NoEnumeration],
-     message: Violation
-   ) : void [AssertionMethod, ContractAnnotation]
+     value: T [Nullable, CanBeNull, NoEnumeration],
+     name: string? [CallerArgumentExpression, Optional]
+   ) : void [NullableContext, AssertionMethod, ContractAnnotation]
  - Fail.IfNotNull<T>(
      value: T? [CanBeNull, NoEnumeration],
-     name: string [NotNull, NotNull]
+     message: Violation
    ) : void [AssertionMethod, ContractAnnotation]
  - Fail.IfNull<T>(
      value: T [Nullable, CanBeNull, AssertionCondition],

diff --git a/Contracts/Synergy.Contracts.Test/Failures/FailNullabilityTest.cs b/Contracts/Synergy.Contracts.Test/Failures/FailNullabilityTest.cs
@@ -283,12 +283,26 @@ public void IfNotNull(object argumentValue)
             Assert.That(exception.Message, Is.EqualTo("'argumentValue' is NOT null; and it should be;"));
         }
 
+        [Test]
+        [TestCaseSource(nameof(FailNullabilityTest.GetNotNulls))]
+        public void IfNotNullCallerArgumentExpression(object argumentValue)
+        {
+            // ACT
+            var exception = Assert.Throws<DesignByContractViolationException>(
+                () => Fail.IfNotNull(argumentValue)
+            );
+
+            // ASSERT
+            Assert.That(exception.Message, Is.EqualTo("'argumentValue' is NOT null; and it should be;"));
+        }
+
         [Test]
         [TestCaseSource(nameof(FailNullabilityTest.GetNulls))]
         public void IfNotNullSuccess([CanBeNull] object argumentValue)
         {
             // ACT
             Fail.IfNotNull(argumentValue, nameof(argumentValue));
+            Fail.IfNotNull(argumentValue);
         }
 
         #endregion

diff --git a/Contracts/Synergy.Contracts/Failures/FailNullability.cs b/Contracts/Synergy.Contracts/Failures/FailNullability.cs
@@ -230,7 +230,14 @@ [CanBeNull] [AssertionCondition(AssertionConditionType.IS_NOT_NULL)] T value,
         /// <param name="name">Name of the checked argument / parameter.</param>
         [AssertionMethod]
         [ContractAnnotation("value: notnull => halt")]
-        public static void IfNotNull<T>([CanBeNull] [NoEnumeration] T value, [NotNull] [System.Diagnostics.CodeAnalysis.NotNull] string name)
+        public static void IfNotNull<T>(
+            [CanBeNull] [NoEnumeration] T value,
+#if NET6_0_OR_GREATER
+            [System.Runtime.CompilerServices.CallerArgumentExpression("value")] string? name = null
+#else
+            string name
+#endif
+        )
         {
             Fail.RequiresArgumentName(name);
             Fail.IfNotNull(value, Violation.WhenVariableIsNotNull(name));