Iterable IPv4 & CI testing

Author: murrant

.github/workflows/ci.yaml

@@ -0,0 +1,28 @@
+name: CI
+
+on: [push, pull-request]
+
+permissions:
+    contents: read
+
+jobs:
+    test:
+        runs-on: ubuntu-latest
+
+        strategy:
+            matrix:
+                php-versions: [ '5.6', '7.4', '8.2' ]
+
+        steps:
+            - name: Code Checkout
+              uses: actions/checkout@v3
+              run: echo "The ${{ github.repository }} repository has been cloned to the runner."
+            - name: Install PHP
+              uses: shivammathur/setup-php@v2
+              with:
+                 php-version: ${{ matrix.php-versions }}
+            - name: Composer
+              uses: php-actions/composer@v6
+              run: echo "Composer dependencies have been installed"
+            - name: PHPUnit
+              run: vendor/bin/phpunit

LibreNMS/Util/IPv4.php

@@ -27,8 +27,11 @@
 
 use LibreNMS\Exceptions\InvalidIpException;
 
-class IPv4 extends IP
+class IPv4 extends IP implements \Iterator
 {
+    private $current;
+    private $networkLongIp;
+
     /**
      * IPv4 constructor.
      * @param $ipv4
@@ -42,6 +45,8 @@ public function __construct($ipv4)
         if (!self::isValid($this->ip)) {
             throw new InvalidIpException("$ipv4 is not a valid ipv4 address");
         }
+
+        $this->networkLongIp = $this->calculateNetworkAddress($this->ip, $this->cidr);
     }
 
     /**
@@ -113,11 +118,11 @@ public function inNetwork($network)
      */
     public function getNetworkAddress($cidr = null)
     {
-        if (is_null($cidr)) {
-            $cidr = $this->cidr;
+        if (is_null($cidr) || $cidr == $this->cidr) {
+            return long2ip($this->networkLongIp);
         }
 
-        return long2ip(ip2long($this->ip) & $this->cidr2long($cidr));
+        return long2ip($this->calculateNetworkAddress($this->ip, $cidr));
     }
 
     /**
@@ -130,6 +135,19 @@ public function toSnmpIndex()
         return (string)$this->ip;
     }
 
+
+    /**
+     * Get the long of the network address for the given IP and cidr.
+     *
+     * @param string $ip
+     * @param int $cidr
+     * @return int
+     */
+    protected function calculateNetworkAddress($ip, $cidr)
+    {
+        return ip2long($ip) & $this->cidr2long($cidr);
+    }
+
     /**
      * Extract an address from a cidr, assume a host is given if it does not contain /
      * Handle netmasks in addition to cidr
@@ -152,4 +170,44 @@ protected function extractCidr($ip)
 
         return $parts;
     }
+
+    // --- Iterable Methods ---
+    public function current()
+    {
+        return long2ip($this->current);
+    }
+
+    public function next()
+    {
+        $this->current++;
+    }
+
+    public function key()
+    {
+        return $this->current;
+    }
+
+    public function valid()
+    {
+        if ($this->cidr == 32) {
+            return $this->current === $this->networkLongIp;
+        }
+
+        if ($this->cidr == 31) {
+
+            return $this->current === $this->networkLongIp || $this->current === ($this->networkLongIp + 1);
+        }
+
+        $max = $this->networkLongIp - $this->cidr2long($this->cidr) - 1;
+
+        return $this->current > $this->networkLongIp && $this->current < $max;
+    }
+
+    public function rewind()
+    {
+        $this->current = $this->cidr > 30
+            ? $this->networkLongIp
+            : $this->networkLongIp + 1;
+
+    }
 }

composer.json

@@ -15,8 +15,8 @@
         "php": ">=5.6.4"
     },
     "require-dev": {
-        "phpunit/phpunit": "5.*",
-        "squizlabs/php_codesniffer": "^2.9.1"
+        "phpunit/phpunit": ">5.7",
+        "squizlabs/php_codesniffer": ">=2.9.1"
     },
     "autoload": {
         "psr-4": {