#28: Synergy.Contracts: Added sth.OrFail() extension method

synergy-software · Feb 3, 2024 · 9524ef5 · 9524ef5
1 parent 2bfb424
commit 9524ef5
Show file tree

Hide file tree

Showing 10 changed files with 32 additions and 15 deletions.
diff --git a/Architecture/Synergy.Convention.Testing/Rules/Deficit.cs b/Architecture/Synergy.Convention.Testing/Rules/Deficit.cs
@@ -11,14 +11,14 @@ public struct Deficit
         public MemberInfo Member { get; }
         public string Description { get; }
 
-        private Type DeclaringType => Member.DeclaringType.OrFail(nameof(Member.DeclaringType))!;
+        private Type DeclaringType => Member.DeclaringType.OrFail();
         public Assembly Assembly => DeclaringType.Assembly;
         public string MemberName => FullNameOfMember();
 
         public Deficit(MemberInfo member, string description)
         {
-            this.Member = member.OrFail(nameof(member));
-            this.Description = description.OrFail(nameof(description));
+            this.Member = member.OrFail();
+            this.Description = description.OrFail();
         }
 
         public override string ToString()

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
@@ -231,7 +231,7 @@
    ) : T? [Extension, NotNull, AssertionMethod, ContractAnnotation]
  - Fail.OrFail<T>(
      value: T? [CanBeNull, AssertionCondition, NoEnumeration],
-     name: string [NotNull, NotNull]
+     name: string? [Nullable, CallerArgumentExpression, Optional]
    ) : T? [Extension, NotNull, AssertionMethod, ContractAnnotation]
  - Fail.OrFail<T>(
      value: T?,

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
@@ -231,7 +231,7 @@
    ) : T? [Extension, NotNull, AssertionMethod, ContractAnnotation]
  - Fail.OrFail<T>(
      value: T? [CanBeNull, AssertionCondition, NoEnumeration],
-     name: string [NotNull, NotNull]
+     name: string? [Nullable, CallerArgumentExpression, Optional]
    ) : T? [Extension, NotNull, AssertionMethod, ContractAnnotation]
  - Fail.OrFail<T>(
      value: T?,

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
@@ -231,7 +231,7 @@
    ) : T? [Extension, NotNull, AssertionMethod, ContractAnnotation]
  - Fail.OrFail<T>(
      value: T? [CanBeNull, AssertionCondition, NoEnumeration],
-     name: string [NotNull, NotNull]
+     name: string? [Nullable, CallerArgumentExpression, Optional]
    ) : T? [Extension, NotNull, AssertionMethod, ContractAnnotation]
  - Fail.OrFail<T>(
      value: T?,

diff --git a/Contracts/Synergy.Contracts.Test/Failures/Doubles/ContractorRepository.cs b/Contracts/Synergy.Contracts.Test/Failures/Doubles/ContractorRepository.cs
@@ -27,7 +27,7 @@ public List<Contractor> GetContractorsAged(DateTime minDate, DateTime? maxDate)
 
         public List<Contractor> FilterContractors(ContractorFilterParameters paramaters)
         {
-            paramaters.OrFail(nameof(paramaters));
+            paramaters.OrFail();
             paramaters.EstablishedBetween.FailIfNull(Violation.Of("'{0}' is null and it shouldn't be", nameof(paramaters.EstablishedBetween)));
             paramaters.EstablishedBetween.Max.OrFail(nameof(paramaters.EstablishedBetween.Max));
 

diff --git a/Contracts/Synergy.Contracts.Test/Failures/FailNullabilityTest.cs b/Contracts/Synergy.Contracts.Test/Failures/FailNullabilityTest.cs
@@ -84,20 +84,32 @@ public void OrFail(object thisMustBeNull)
         {
             // ACT
             var exception = Assert.Throws<DesignByContractViolationException>(
-                // ReSharper disable once ExpressionIsAlwaysNull
                 () => thisMustBeNull.OrFail(nameof(thisMustBeNull)));
 
             // ASSERT
             Assert.That(exception.Message, Is.EqualTo("'thisMustBeNull' is null; and it shouldn't be;"));
         }
 
+        [Test]
+        [TestCaseSource(nameof(FailNullabilityTest.GetNulls))]
+        public void OrFailNetCore(object thisMustBeNull)
+        {
+            // ACT
+            var exception = Assert.Throws<DesignByContractViolationException>(
+                () => thisMustBeNull.OrFail());
+
+            // ASSERT
+            Assert.That(exception.Message, Is.EqualTo("'thisMustBeNull' is null; and it shouldn't be;"));
+        }
+
         [Test]
         [TestCaseSource(nameof(FailNullabilityTest.GetNotNulls))]
         [SuppressMessage("ReSharper", "UnusedVariable")]
         public void OrFailSuccess(object thisCannotBeNull)
         {
             // ACT
-            Type type = thisCannotBeNull.OrFail(nameof(thisCannotBeNull)).GetType();
+            thisCannotBeNull.OrFail(nameof(thisCannotBeNull));
+            thisCannotBeNull.OrFail();
         }
 
         #endregion

diff --git a/Contracts/Synergy.Contracts/Failures/FailNullability.cs b/Contracts/Synergy.Contracts/Failures/FailNullability.cs
@@ -61,7 +61,12 @@ [CanBeNull] [AssertionCondition(AssertionConditionType.IS_NOT_NULL)] [NoEnumerat
         public static T OrFail<T>(
             [CanBeNull] [AssertionCondition(AssertionConditionType.IS_NOT_NULL)] [NoEnumeration]
             this T value,
-            [NotNull] [System.Diagnostics.CodeAnalysis.NotNull] string name)
+#if NET6_0_OR_GREATER
+            [System.Runtime.CompilerServices.CallerArgumentExpression("value")] string? name = null
+#else
+            string name
+#endif
+            )
         {
             Fail.RequiresArgumentName(name);
 

diff --git a/Web/Synergy.Web.Api.Testing/Assertions/CompareResponseWithPattern.cs b/Web/Synergy.Web.Api.Testing/Assertions/CompareResponseWithPattern.cs
@@ -28,7 +28,7 @@ public CompareResponseWithPattern(string patternFilePath, Ignore? ignore = null,
         public override Result Assert(HttpOperation operation)
         {
             // TODO: Add non-nullable annotations to OrFail() - and other contract methods
-            var current = operation.Response.Content.ReadJson().OrFail("response")!;
+            var current = operation.Response.Content.ReadJson().OrFail("response");
             if (_savedPattern == null)
             {
                 SaveNewPattern(current);

diff --git a/Web/Synergy.Web.Api.Testing/Assertions/VerifyRequestMethod.cs b/Web/Synergy.Web.Api.Testing/Assertions/VerifyRequestMethod.cs
@@ -11,7 +11,7 @@ public class VerifyRequestMethod : Assertion
 
         public VerifyRequestMethod(params HttpMethod[] expectedMethod)
         {
-            _expectedMethod = expectedMethod.OrFail(nameof(expectedMethod));
+            _expectedMethod = expectedMethod.OrFail();
             ExpectedResult = $"HTTP request method is {_expectedMethod}";
         }
 

diff --git a/Web/Synergy.Web.Api.Testing/HttpOperation.cs b/Web/Synergy.Web.Api.Testing/HttpOperation.cs
@@ -21,9 +21,9 @@ public class HttpOperation
         internal void Init(TestServer testServer, HttpRequestMessage request, HttpResponseMessage response, Stopwatch timer)
         {
             Duration = timer.Elapsed;
-            TestServer = testServer.OrFail(nameof(testServer));
-            Request = request.OrFail(nameof(request));
-            Response = response.OrFail(nameof(response));
+            TestServer = testServer.OrFail();
+            Request = request.OrFail();
+            Response = response.OrFail();
         }
 
         internal void Assert(IEnumerable<IAssertion> assertions)