Plus or minus for instant draft (#7) (#3784)

#3747 - support `Instant` Co-authored-by: Sam <sam@sksamuel.com>
kotest · Nov 18, 2023 · bdbabd2 · bdbabd2
1 parent 99061c1
commit bdbabd2
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 3 deletions.
diff --git a/kotest-assertions/kotest-assertions-core/api/kotest-assertions-core.api b/kotest-assertions/kotest-assertions-core/api/kotest-assertions-core.api
@@ -899,6 +899,7 @@ public final class io/kotest/matchers/date/InstantKt {
 	public static final fun before (Ljava/time/Instant;)Lio/kotest/matchers/Matcher;
 	public static final fun between (Ljava/time/Instant;Ljava/time/Instant;)Lio/kotest/matchers/Matcher;
 	public static final fun closeTo-HG0u8IE (Ljava/time/Instant;J)Lio/kotest/matchers/Matcher;
+	public static final fun plusOrMinus-HG0u8IE (Ljava/time/Instant;J)Lio/kotest/matchers/Matcher;
 	public static final fun shouldBeAfter (Ljava/time/Instant;Ljava/time/Instant;)Ljava/lang/Object;
 	public static final fun shouldBeBefore (Ljava/time/Instant;Ljava/time/Instant;)Ljava/lang/Object;
 	public static final fun shouldBeBetween (Ljava/time/Instant;Ljava/time/Instant;Ljava/time/Instant;)Ljava/lang/Object;

diff --git a/...t-assertions/kotest-assertions-core/src/jvmMain/kotlin/io/kotest/matchers/date/instant.kt b/...t-assertions/kotest-assertions-core/src/jvmMain/kotlin/io/kotest/matchers/date/instant.kt
@@ -6,6 +6,7 @@ import io.kotest.matchers.shouldBe
 import io.kotest.matchers.shouldNot
 import io.kotest.matchers.shouldNotBe
 import java.time.Instant
+import java.time.LocalDateTime
 import kotlin.time.Duration
 import kotlin.time.toKotlinDuration
 
@@ -100,3 +101,5 @@ fun Instant.shouldBeCloseTo(anotherInstant: Instant, duration: Duration) =
  * */
 fun Instant.shouldNotBeCloseTo(anotherInstant: Instant, duration: Duration) =
    this shouldNotBe closeTo(anotherInstant, duration)
+
+infix fun Instant.plusOrMinus(tolerance: Duration) = closeTo(this, tolerance)
diff --git a/...ssertions-core/src/jvmTest/kotlin/com/sksamuel/kotest/matchers/date/instantMatcherTest.kt b/...ssertions-core/src/jvmTest/kotlin/com/sksamuel/kotest/matchers/date/instantMatcherTest.kt
@@ -1,6 +1,7 @@
 package com.sksamuel.kotest.matchers.date
 
 import io.kotest.core.spec.style.FreeSpec
+import io.kotest.matchers.date.plusOrMinus
 import io.kotest.matchers.date.shouldBeAfter
 import io.kotest.matchers.date.shouldBeBefore
 import io.kotest.matchers.date.shouldBeBetween
@@ -94,10 +95,12 @@ class InstantMatcherTest : FreeSpec() {
 
       "current instant and 5 nanos ago instant should be close to 5 nanoseconds each other" {
          val currentInstant = Instant.now()
-         val hundredNanosAgoInstant = currentInstant.minusNanos(5L)
+         val fiveNanosAgoInstant = currentInstant.minusNanos(5L)
 
-         currentInstant.shouldBeCloseTo(hundredNanosAgoInstant, 5L.nanoseconds)
-         hundredNanosAgoInstant.shouldBeCloseTo(currentInstant, 5L.nanoseconds)
+         currentInstant.shouldBeCloseTo(fiveNanosAgoInstant, 5L.nanoseconds)
+         fiveNanosAgoInstant.shouldBeCloseTo(currentInstant, 5L.nanoseconds)
+         currentInstant shouldBe (fiveNanosAgoInstant plusOrMinus 5L.nanoseconds)
+         fiveNanosAgoInstant shouldBe (currentInstant plusOrMinus 5L.nanoseconds)
       }
 
       "current instant and 1500 millis ago instant should not be close to 1000 millis each other" {
@@ -106,6 +109,8 @@ class InstantMatcherTest : FreeSpec() {
 
          currentInstant.shouldNotBeCloseTo(someMillisAgoInstant, 1000L.milliseconds)
          someMillisAgoInstant.shouldNotBeCloseTo(currentInstant, 1000L.milliseconds)
+         currentInstant shouldNotBe (someMillisAgoInstant plusOrMinus 1000L.nanoseconds)
+         someMillisAgoInstant shouldNotBe (currentInstant plusOrMinus 1000L.nanoseconds)
       }
 
    }