test: reduce flakiness of time sensitive tests (#1460)

Author: innocenzi

packages/cryptography/tests/Encryption/EncryptionTest.php

@@ -13,11 +13,13 @@
 use Tempest\Cryptography\Signing\SigningAlgorithm;
 use Tempest\Cryptography\Signing\SigningConfig;
 use Tempest\Cryptography\Tests\CreatesSigner;
+use Tempest\Cryptography\Tests\HasMoreIntegerAssertions;
 use Tempest\DateTime\Duration;
 
 final class EncryptionTest extends TestCase
 {
     use CreatesSigner;
+    use HasMoreIntegerAssertions;
 
     private function createEncrypter(?string $key = null, false|Duration $minimumExecutionDuration = false): GenericEncrypter
     {
@@ -60,8 +62,7 @@ public function test_time_protection(): void
         $this->assertSame('important data', $encrypter->decrypt($encrypted));
         $elapsed = microtime(true) - $start;
 
-        $this->assertGreaterThanOrEqual(0.29, $elapsed);
-        $this->assertLessThanOrEqual(0.311, $elapsed);
+        $this->assertEqualsToMoreOrLess(0.3, $elapsed, margin: 0.015);
     }
 
     public function test_wrong_key(): void

packages/cryptography/tests/HasMoreIntegerAssertions.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Tempest\Cryptography\Tests;
+
+use PHPUnit\Framework\ExpectationFailedException;
+
+trait HasMoreIntegerAssertions
+{
+    private function assertEqualsToMoreOrLess(int|float $expected, int|float $actual, int|float $margin): void
+    {
+        try {
+            $this->assertGreaterThanOrEqual($expected - $margin, $actual);
+            $this->assertLessThanOrEqual($expected + $margin, $actual);
+        } catch (ExpectationFailedException $e) {
+            throw new ExpectationFailedException(
+                message: sprintf('Expected value to be within %s of %s, but got %s', $margin, $expected, $actual),
+                comparisonFailure: $e->getComparisonFailure(),
+            );
+        }
+    }
+}

packages/cryptography/tests/Signing/SignerTest.php

@@ -2,17 +2,20 @@
 
 namespace Tempest\Cryptography\Tests\Signing;
 
+use PHPUnit\Framework\ExpectationFailedException;
 use PHPUnit\Framework\TestCase;
 use Tempest\Clock\MockClock;
 use Tempest\Cryptography\Signing\Exceptions\SigningKeyWasInvalid;
 use Tempest\Cryptography\Signing\SigningAlgorithm;
 use Tempest\Cryptography\Signing\SigningConfig;
 use Tempest\Cryptography\Tests\CreatesSigner;
+use Tempest\Cryptography\Tests\HasMoreIntegerAssertions;
 use Tempest\DateTime\Duration;
 
 final class SignerTest extends TestCase
 {
     use CreatesSigner;
+    use HasMoreIntegerAssertions;
 
     public function test_good_signature(): void
     {
@@ -163,8 +166,7 @@ public function test_time_protection(): void
         $this->assertTrue($signer->verify($data, $signature));
         $elapsed = microtime(true) - $start;
 
-        $this->assertGreaterThanOrEqual(0.29, $elapsed);
-        $this->assertLessThanOrEqual(0.311, $elapsed);
+        $this->assertEqualsToMoreOrLess(0.3, $elapsed, margin: 0.015);
     }
 
     public function test_time_protection_with_mock_clock(): void
@@ -182,7 +184,6 @@ public function test_time_protection_with_mock_clock(): void
         $this->assertTrue($signer->verify($data, $signature));
         $elapsed = $clock->timestamp()->getMilliseconds() - $ms;
 
-        $this->assertLessThanOrEqual(1_001, $elapsed);
-        $this->assertGreaterThanOrEqual(999, $elapsed);
+        $this->assertEqualsToMoreOrLess(1000, $elapsed, margin: 10);
     }
 }

packages/cryptography/tests/TimelockTest.php

@@ -11,6 +11,8 @@
 
 final class TimelockTest extends TestCase
 {
+    use HasMoreIntegerAssertions;
+
     public function test_callback_is_executed(): void
     {
         $clock = new GenericClock();
@@ -29,8 +31,7 @@ public function test_locks_for_duration(): void
 
         $elapsed = microtime(true) - $start;
 
-        $this->assertGreaterThanOrEqual(0.1, $elapsed, 'The timelock did not wait for the specified duration.');
-        $this->assertLessThan(0.2, $elapsed, 'The timelock waited for too long.');
+        $this->assertEqualsToMoreOrLess(0.1, $elapsed, margin: 0.015);
     }
 
     public function test_return_early(): void
@@ -62,7 +63,7 @@ public function test_throws_exception_after_delay(): void
             );
         } catch (\RuntimeException) {
             $elapsed = microtime(true) - $start;
-            $this->assertGreaterThanOrEqual(0.1, $elapsed, 'The exception was thrown before the timelock duration elapsed.');
+            $this->assertEqualsToMoreOrLess(0.1, $elapsed, margin: 0.015);
         }
     }
 

packages/datetime/tests/TimestampTest.php

@@ -571,8 +571,8 @@ public function test_nano_precision_temporal_comparisons(): void
     public function test_future_past_comprehensive(): void
     {
         $now = Timestamp::monotonic();
-        $future = $now->plusMilliseconds(1);
-        $past = $now->minusMilliseconds(1);
+        $future = $now->plusMilliseconds(15);
+        $past = $now->minusMilliseconds(15);
 
         $this->assertTrue($future->isFuture());
         $this->assertFalse($future->isPast());

tests/Integration/Console/Components/TaskComponentTest.php

@@ -62,7 +62,7 @@ public function test_process_task(): void
                 $frames = iterator_to_array($component->render($terminal));
 
                 $this->assertStringContainsString('Task in progress', $frames[0]);
-                $this->assertStringContainsString('Done in', $frames[1]);
+                $this->assertStringContainsString('Done in', $frames[array_key_last($frames)]);
             });
     }