adding tests and github action

clegginabox · clegginabox · commit f3a8725da9bb · 2026-01-13T17:04:31.000Z
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -0,0 +1,34 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php: ['8.3', '8.4', '8.5']
+
+    name: PHP ${{ matrix.php }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: redis
+          coverage: none
+
+      - name: Install dependencies
+        run: composer install --no-interaction --prefer-dist
+
+      - name: Run tests
+        run: vendor/bin/phpunit
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@
 /.phpunit.cache/
 .idea/
 .DS_Store
+.phpcs-cache
diff --git a/.phpcs-cache b/.phpcs-cache
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,8 @@
+FROM php:8.5-cli
+
+WORKDIR /app
+
+COPY --from=mlocati/php-extension-installer /usr/bin/install-php-extensions /usr/local/bin/
+
+# Install PHP extensions
+RUN install-php-extensions redis
diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
 # airlock-php
+![Tests](https://github.com/clegginabox/airlock-php/actions/workflows/tests.yaml/badge.svg)
 
 A distributed mutex with civilized waiting
 
diff --git a/Taskfile.yaml b/Taskfile.yaml
@@ -1,6 +1,11 @@
 version: '3'
 
 tasks:
+    test:
+        desc: Runs all tests
+        cmds:
+            - docker run --rm -v $(pwd):/app -v /var/run/docker.sock:/var/run/docker.sock airlock php vendor/bin/phpunit
+
     phpstan:
         desc: Runs PHPStan
         cmds:
diff --git a/composer.json b/composer.json
@@ -37,15 +37,17 @@
         "slevomat/coding-standard": "^8.26",
         "squizlabs/php_codesniffer": "^4.0",
         "symfony/framework-bundle": "^8.0",
-        "symfony/mercure": "^0.7.2"
+        "symfony/mercure": "^0.7.2",
+        "testcontainers/testcontainers": "^1.0"
     },
     "suggest": {
         "symfony/mercure": "Required to use the MercureAirlockNotifier."
     },
     "config": {
         "sort-packages": true,
         "allow-plugins": {
-            "dealerdirect/phpcodesniffer-composer-installer": true
+            "dealerdirect/phpcodesniffer-composer-installer": true,
+            "php-http/discovery": true
         }
     },
     "minimum-stability": "stable"
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
-         bootstrap="vendor/autoload.php"
+         bootstrap="tests/bootstrap.php"
          colors="true"
          cacheDirectory=".phpunit.cache">
     <testsuites>
@@ -14,4 +14,4 @@
             <directory>src</directory>
         </include>
     </source>
-</phpunit>
+</phpunit>
diff --git a/src/Bridge/Amphp/Seal/AmpMutexSeal.php b/src/Bridge/Amphp/Seal/AmpMutexSeal.php
@@ -28,7 +28,8 @@ public function __construct(
         private readonly Mutex $mutex,
         private readonly string $resource = 'airlock',
         private readonly ?float $ttlInSeconds = null, // optional "soft TTL" you enforce yourself
-    ) {}
+    ) {
+    }
 
     public function tryAcquire(): ?string
     {
diff --git a/src/Bridge/Laravel/Seal/LaravelAtomicLockSeal.php b/src/Bridge/Laravel/Seal/LaravelAtomicLockSeal.php
@@ -2,7 +2,8 @@
 
 declare(strict_types=1);
 
-
 namespace Clegginabox\Airlock\Bridge\Laravel\Seal;
 
-class LaravelAtomicLockSeal {}
+class LaravelAtomicLockSeal
+{
+}
diff --git a/src/Bridge/ReactPhp/AsyncAirlock.php b/src/Bridge/ReactPhp/AsyncAirlock.php
@@ -5,7 +5,6 @@
 namespace Clegginabox\Airlock\Bridge\ReactPhp;
 
 use Clegginabox\Airlock\AirlockInterface;
-use React\EventLoop\Loop;
 use React\Promise\PromiseInterface;
 use RuntimeException;
 
@@ -14,7 +13,9 @@
 
 final readonly class AsyncAirlock
 {
-    public function __construct(private AirlockInterface $airlock) {}
+    public function __construct(private AirlockInterface $airlock)
+    {
+    }
 
     /**
      * Wait until admitted, then resolve with the seal token.
diff --git a/src/Factory/AirlockFactory.php b/src/Factory/AirlockFactory.php
@@ -15,8 +15,8 @@
 use Clegginabox\Airlock\Seal\SemaphoreSeal;
 use Redis;
 use Symfony\Component\Lock\LockFactory;
-use Symfony\Component\Semaphore\SemaphoreFactory;
 use Symfony\Component\Lock\Store\RedisStore as LockRedisStore;
+use Symfony\Component\Semaphore\SemaphoreFactory;
 use Symfony\Component\Semaphore\Store\RedisStore as SemaphoreRedisStore;
 
 final readonly class AirlockFactory
diff --git a/src/Queue/RedisAgingLotteryQueue.php b/src/Queue/RedisAgingLotteryQueue.php
@@ -2,7 +2,8 @@
 
 declare(strict_types=1);
 
-
 namespace Clegginabox\Airlock\Queue;
 
-class RedisAgingLotteryQueue {}
+class RedisAgingLotteryQueue
+{
+}
diff --git a/src/Queue/RedisMaxWaitQueue.php b/src/Queue/RedisMaxWaitQueue.php
@@ -2,7 +2,8 @@
 
 declare(strict_types=1);
 
-
 namespace Clegginabox\Airlock\Queue;
 
-class RedisMaxWaitQueue {}
+class RedisMaxWaitQueue
+{
+}
diff --git a/src/Queue/RedisPriorityQueue.php b/src/Queue/RedisPriorityQueue.php
@@ -2,7 +2,8 @@
 
 declare(strict_types=1);
 
-
 namespace Clegginabox\Airlock\Queue;
 
-class RedisPriorityQueue {}
+class RedisPriorityQueue
+{
+}
diff --git a/src/Queue/RedisRetryPenaltyQueue.php b/src/Queue/RedisRetryPenaltyQueue.php
@@ -2,7 +2,8 @@
 
 declare(strict_types=1);
 
-
 namespace Clegginabox\Airlock\Queue;
 
-class RedisRetryPenaltyQueue {}
+class RedisRetryPenaltyQueue
+{
+}
diff --git a/src/Seal/CooldownSeal.php b/src/Seal/CooldownSeal.php
@@ -2,7 +2,8 @@
 
 declare(strict_types=1);
 
-
 namespace Clegginabox\Airlock\Seal;
 
-class CooldownSeal {}
+class CooldownSeal
+{
+}
diff --git a/src/Seal/LockSeal.php b/src/Seal/LockSeal.php
@@ -70,7 +70,6 @@ public function refresh(string $token, ?float $ttlInSeconds = null): ?string
             $lock->refresh($effectiveTtl);
 
             return serialize($key);
-
         } catch (LockExpiredException | LockConflictedException $e) {
             throw new LeaseExpiredException($token, $e->getMessage());
         } catch (Throwable $e) {
diff --git a/tests/Integration/Queue/RedisFifoQueueTest.php b/tests/Integration/Queue/RedisFifoQueueTest.php
@@ -0,0 +1,146 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Clegginabox\Airlock\Tests\Integration\Queue;
+
+use Clegginabox\Airlock\Queue\RedisFifoQueue;
+use PHPUnit\Framework\TestCase;
+use Redis;
+
+class RedisFifoQueueTest extends TestCase
+{
+    private Redis $redis;
+    private RedisFifoQueue $queue;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->redis = $this->createRedisConnection();
+        $this->redis->flushAll();
+
+        $this->queue = new RedisFifoQueue(
+            $this->redis,
+            'test:queue:list',
+            'test:queue:set'
+        );
+    }
+
+    public function testItPreservesFifoOrder(): void
+    {
+        // Add 3 users
+        $this->queue->add('user_A');
+        $this->queue->add('user_B');
+        $this->queue->add('user_C');
+
+        // Pop them one by one
+        $this->assertSame('user_A', $this->queue->pop());
+        $this->assertSame('user_B', $this->queue->pop());
+        $this->assertSame('user_C', $this->queue->pop());
+
+        // Queue should be empty now
+        $this->assertNull($this->queue->pop());
+    }
+
+    public function testAddIsIdempotent(): void
+    {
+        // Add User A twice
+        $pos1 = $this->queue->add('user_A');
+        $pos2 = $this->queue->add('user_A'); // Should detect duplicate
+
+        // The list length should still be 1
+        $this->assertSame(1, $pos1);
+        $this->assertSame(1, $pos2); // The position is the same
+
+        // Pop should only return it once
+        $this->assertSame('user_A', $this->queue->pop());
+        $this->assertNull($this->queue->pop());
+    }
+
+    public function testGetPosition(): void
+    {
+        $this->queue->add('user_A');
+        $this->queue->add('user_B');
+        $this->queue->add('user_C');
+
+        $this->assertSame(1, $this->queue->getPosition('user_A'));
+        $this->assertSame(2, $this->queue->getPosition('user_B'));
+        $this->assertSame(3, $this->queue->getPosition('user_C'));
+
+        // Non-existent user
+        $this->assertNull($this->queue->getPosition('user_ghost'));
+    }
+
+    public function testRemove(): void
+    {
+        $this->queue->add('user_A');
+        $this->queue->add('user_B'); // The one we will remove
+        $this->queue->add('user_C');
+
+        $this->queue->remove('user_B');
+
+        // Check positions: User C should shift up?
+        // Note: Redis Lists shift automatically when an item is removed.
+        $this->assertSame(1, $this->queue->getPosition('user_A'));
+        $this->assertSame(2, $this->queue->getPosition('user_C'));
+
+        // Verify pop order
+        $this->assertSame('user_A', $this->queue->pop());
+        $this->assertSame('user_C', $this->queue->pop());
+    }
+
+    public function testConcurrencyIntegrity(): void
+    {
+        // This simulates the "Race Condition" fix.
+        // We manually inject a state where a user is in the SET but not the LIST
+        // to verify the Lua script handles it or returns errors gracefully.
+
+        $this->redis->sAdd('test:queue:set', 'zombie_user');
+
+        // If we try to add them properly now, the Lua script sees them in the SET
+        // and tries to find them in the LIST.
+        // Since they aren't in the LIST, your Lua script returns -1.
+
+        $result = $this->queue->add('zombie_user');
+        $this->assertSame(1, $result);
+    }
+
+    public function testAddHealsCorruptionInsteadOfReturningNegativeOne(): void
+    {
+        $queueKey = 'test_corruption_queue';
+        $setKey = 'test_corruption_set';
+
+        // 1. Setup: Manually corrupt the state
+        // Add user to the SET, but NOT the LIST
+        $this->redis->sAdd($setKey, 'ghost_user');
+        // Ensure list is empty so we know their "real" position should be 1
+        $this->redis->del($queueKey);
+
+        $queue = new RedisFifoQueue($this->redis, $queueKey, $setKey);
+
+        // 2. Action: The ghost user tries to "add" themselves again
+        $position = $queue->add('ghost_user');
+
+        // 3. Expectation: The queue should detect the corruption, re-add them to the list,
+        // and return a valid position (1).
+        // THIS WILL FAIL: currently it returns -1
+        $this->assertGreaterThan(0, $position, 'Queue returned invalid position -1, allowing user to skip line.');
+        $this->assertEquals(1, $position, 'Queue did not heal the list state.');
+    }
+
+    private function createRedisConnection(): Redis
+    {
+        $url = $_ENV['REDIS_URL'] ?? throw new \RuntimeException('REDIS_URL not set in bootstrap');
+
+        $parsed = parse_url($url);
+
+        $redis = new Redis();
+        $redis->connect(
+            $parsed['host'] ?? '127.0.0.1',
+            $parsed['port'] ?? 6379,
+        );
+
+        return $redis;
+    }
+}
diff --git a/tests/Integration/Seal/SemaphoreSealTest.php b/tests/Integration/Seal/SemaphoreSealTest.php
diff --git a/tests/Unit/Seal/SemaphoreSealTest.php b/tests/Unit/Seal/SemaphoreSealTest.php
diff --git a/tests/bootstrap.php b/tests/bootstrap.php

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`# airlock-php`
	`2`	`+![Tests](https://github.com/clegginabox/airlock-php/actions/workflows/tests.yaml/badge.svg)`
`2`	`3`
`3`	`4`	`A distributed mutex with civilized waiting`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,8 @@ public function __construct(`
`28`	`28`	`private readonly Mutex $mutex,`
`29`	`29`	`private readonly string $resource = 'airlock',`
`30`	`30`	`private readonly ?float $ttlInSeconds = null, // optional "soft TTL" you enforce yourself`
`31`		`- ) {}`
	`31`	`+ ) {`
	`32`	`+ }`
`32`	`33`
`33`	`34`	`public function tryAcquire(): ?string`
`34`	`35`	`{`