feat: Some tests would fail on older versions of the json-rpc api, allow tests to only run on specific versions through an attribute

Author: refring

tests/Attribute/RequiresMoneroVersion.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RefRing\MoneroRpcPhp\Tests\Attribute;
+
+use Attribute;
+
+/**
+ * Mark a test method as requiring a specific Monero daemon version.
+ *
+ * The test will be skipped if the daemon version is below the minimum
+ * or above the maximum (if specified).
+ *
+ * Version format: "0.18.4.0" (as returned by getInfo()->version)
+ */
+#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS)]
+final class RequiresMoneroVersion
+{
+    public function __construct(
+        public readonly string $minVersion,
+        public readonly ?string $maxVersion = null,
+    ) {
+    }
+}

tests/Trait/RequiresMoneroVersionTrait.php

@@ -0,0 +1,70 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RefRing\MoneroRpcPhp\Tests\Trait;
+
+use ReflectionMethod;
+use RefRing\MoneroRpcPhp\DaemonRpcClient;
+use RefRing\MoneroRpcPhp\Tests\Attribute\RequiresMoneroVersion;
+
+/**
+ * Trait to add version requirement checking to integration tests.
+ *
+ * Classes using this trait must implement getDaemonRpcClient() to provide
+ * the client instance for version checking.
+ */
+trait RequiresMoneroVersionTrait
+{
+    private static ?string $cachedDaemonVersion = null;
+
+    abstract protected static function getDaemonRpcClient(): DaemonRpcClient;
+
+    protected function checkMoneroVersionRequirements(): void
+    {
+        $reflection = new ReflectionMethod($this, $this->name());
+
+        // Check method-level attribute first, then class-level
+        $attributes = $reflection->getAttributes(RequiresMoneroVersion::class);
+
+        if (empty($attributes)) {
+            $classReflection = $reflection->getDeclaringClass();
+            $attributes = $classReflection->getAttributes(RequiresMoneroVersion::class);
+        }
+
+        if (empty($attributes)) {
+            return;
+        }
+
+        $requirement = $attributes[0]->newInstance();
+        $currentVersion = $this->getDaemonVersion();
+        $currentVersion = preg_replace('/[^0-9.]/', '', $currentVersion);
+
+        if (version_compare($currentVersion, $requirement->minVersion, '<')) {
+            $this->markTestSkipped(sprintf(
+                'Test requires Monero >= %s (current: %s)',
+                $requirement->minVersion,
+                $currentVersion
+            ));
+        }
+
+        if ($requirement->maxVersion !== null) {
+            if (version_compare($currentVersion, $requirement->maxVersion, '>')) {
+                $this->markTestSkipped(sprintf(
+                    'Test requires Monero <= %s (current: %s)',
+                    $requirement->maxVersion,
+                    $currentVersion
+                ));
+            }
+        }
+    }
+
+    private function getDaemonVersion(): string
+    {
+        if (self::$cachedDaemonVersion === null) {
+            self::$cachedDaemonVersion = static::getDaemonRpcClient()->getInfo()->version;
+        }
+
+        return self::$cachedDaemonVersion;
+    }
+}

tests/integration/DaemonTest.php

@@ -11,9 +11,13 @@
 use RefRing\MoneroRpcPhp\Enum\ResponseStatus;
 use RefRing\MoneroRpcPhp\Exception\InvalidHostOrSubnetException;
 use RefRing\MoneroRpcPhp\Exception\NoIpOrHostSuppliedException;
+use RefRing\MoneroRpcPhp\Tests\Attribute\RequiresMoneroVersion;
+use RefRing\MoneroRpcPhp\Tests\Trait\RequiresMoneroVersionTrait;
 
 final class DaemonTest extends TestCase
 {
+    use RequiresMoneroVersionTrait;
+
     private static DaemonRpcClient $rpcClient;
 
     public static function setUpBeforeClass(): void
@@ -22,6 +26,16 @@ public static function setUpBeforeClass(): void
         self::$rpcClient = new DaemonRpcClient($httpClient, getenv('DAEMON_RPC_URL'));
     }
 
+    protected function setUp(): void
+    {
+        $this->checkMoneroVersionRequirements();
+    }
+
+    protected static function getDaemonRpcClient(): DaemonRpcClient
+    {
+        return self::$rpcClient;
+    }
+
     public function testSetBansOk(): void
     {
         $node = new Node('127.0.0.1', null, true, 60);
@@ -37,12 +51,12 @@ public function testSetBansInvalidHost(): void
         $result = self::$rpcClient->setBans([$node]);
     }
 
-    // @TODO This will fail on versions before v0.18.4.0, find a way to only run tests against certain versions
-    //    public function testSetBansMissingIp(): void
-    //    {
-    //        $this->expectException(NoIpOrHostSuppliedException::class);
-    //
-    //        $node = new Node(null, null, true, 60);
-    //        $result = self::$rpcClient->setBans([$node]);
-    //    }
+    #[RequiresMoneroVersion('0.18.4.0')]
+    public function testSetBansMissingIp(): void
+    {
+        $this->expectException(NoIpOrHostSuppliedException::class);
+
+        $node = new Node(null, null, true, 60);
+        $result = self::$rpcClient->setBans([$node]);
+    }
 }

tests/unit/RequiresMoneroVersionTest.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RefRing\MoneroRpcPhp\Tests\unit;
+
+use PHPUnit\Framework\TestCase;
+use RefRing\MoneroRpcPhp\Tests\Attribute\RequiresMoneroVersion;
+
+final class RequiresMoneroVersionTest extends TestCase
+{
+    public function testAttributeInstantiation(): void
+    {
+        $attr = new RequiresMoneroVersion('0.18.4.0');
+        $this->assertSame('0.18.4.0', $attr->minVersion);
+        $this->assertNull($attr->maxVersion);
+    }
+
+    public function testAttributeInstantiationWithMax(): void
+    {
+        $attr = new RequiresMoneroVersion('0.18.0.0', '0.19.0.0');
+        $this->assertSame('0.18.0.0', $attr->minVersion);
+        $this->assertSame('0.19.0.0', $attr->maxVersion);
+    }
+
+    public function testVersionCompareWorks(): void
+    {
+        // Verify PHP's version_compare works correctly with Monero version strings
+        $this->assertSame(-1, version_compare('0.18.3.0', '0.18.4.0'));
+        $this->assertSame(0, version_compare('0.18.4.0', '0.18.4.0'));
+        $this->assertSame(1, version_compare('0.18.5.0', '0.18.4.0'));
+        $this->assertSame(-1, version_compare('0.17.3.2', '0.18.4.0'));
+        $this->assertSame(1, version_compare('0.19.0.0', '0.18.4.0'));
+    }
+}