tests: add test for excessive memory usage when copying model #617 objects

Author: jaredhendrickson13

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Core/Model.inc

@@ -357,6 +357,22 @@ class Model {
         });
     }
 
+    /**
+     * Creates an unlinked copy of this Model object.
+     * @return Model The cloned Model object.
+     */
+    public function copy(): Model {
+        # Create a copy of this object by serializing and unserializing it
+        $copy = unserialize(serialize($this));
+
+        # Reassign the parent Model object if it exists
+        if ($this->parent_model) {
+            $copy->parent_model = $this->parent_model;
+        }
+
+        return $copy;
+    }
+
     /**
      * Checks for options passed in during object construction and maps known options to Model properties. Any
      * options that are not known options to the core Model will be returned so they can be merged into
@@ -409,7 +425,7 @@ class Model {
             if ($this->config_path or $this->internal_callable) {
                 $this->id = $id;
                 $this->from_internal();
-                $this->initial_object = unserialize(serialize($this));
+                $this->initial_object = $this->copy();
             }
         }
     }
@@ -989,7 +1005,7 @@ class Model {
 
             # Obtain the object from its internal form
             $this->from_internal();
-            $this->initial_object = unserialize(serialize($this));
+            $this->initial_object = $this->copy();
         }
 
         # Loop through each field in this Model and assign their values using the `representation_data`.
@@ -2028,7 +2044,7 @@ class Model {
             }
 
             # Refresh the initial object
-            $this->initial_object = unserialize(serialize($this));
+            $this->initial_object = $this->copy();
         }
 
         # Return the current representation of this object
@@ -2118,7 +2134,7 @@ class Model {
             }
 
             # Refresh the initial object
-            $this->initial_object = unserialize(serialize($this));
+            $this->initial_object = $this->copy();
         }
 
         # Return the current representation of this object
@@ -2296,7 +2312,7 @@ class Model {
             }
 
             # Refresh the initial object
-            $this->initial_object = unserialize(serialize($this));
+            $this->initial_object = $this->copy();
         }
 
         # Return the current representation of this object

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Core/Tools.inc

@@ -168,3 +168,28 @@ function get_classes_from_namespace(string $namespace, bool $shortnames = false)
 
     return $classes;
 }
+
+/**
+ * Generates a random MAC address string.
+ * @returns string A random MAC address string.
+ */
+function generate_mac_address(): string {
+    # Generate the first three octets (OUI) with fixed bits for unicast and locally administered addresses
+    $first_octet = dechex((mt_rand(0x00, 0xff) & 0xfe) | 0x02); // Ensure it is locally administered
+    $mac = [
+        $first_octet,
+        dechex(mt_rand(0x00, 0xff)),
+        dechex(mt_rand(0x00, 0xff)),
+        dechex(mt_rand(0x00, 0xff)),
+        dechex(mt_rand(0x00, 0xff)),
+        dechex(mt_rand(0x00, 0xff)),
+    ];
+
+    # Zero-pad single-character hex values and return the MAC address
+    return implode(
+        ':',
+        array_map(function ($part) {
+            return str_pad($part, 2, '0', STR_PAD_LEFT);
+        }, $mac),
+    );
+}

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Tests/APICoreModelTestCase.inc

@@ -7,10 +7,13 @@ use RESTAPI;
 use RESTAPI\Caches\RESTAPIVersionReleasesCache;
 use RESTAPI\Core\Auth;
 use RESTAPI\Core\Model;
+use RESTAPI\Models\DHCPServer;
+use RESTAPI\Models\DHCPServerStaticMapping;
 use RESTAPI\Models\FirewallAlias;
 use RESTAPI\Models\InterfaceVLAN;
 use RESTAPI\Models\SystemStatus;
 use RESTAPI\Models\Test;
+use function RESTAPI\Models\DHCPServerStaticMapping;
 
 class APICoreModelTestCase extends RESTAPI\Core\TestCase {
     /**
@@ -1197,4 +1200,52 @@ class APICoreModelTestCase extends RESTAPI\Core\TestCase {
         # Remove the write lock
         unlink(Model::WRITE_LOCK_FILE);
     }
+
+    /**
+     * Ensure the copy() method creates an unlinked copy of the Model object.
+     */
+    public function test_copy(): void {
+        # Create a new FirewallAlias model to test with
+        $alias = new FirewallAlias(name: 'test_alias', type: 'host', address: ['1.2.3.4']);
+        $alias->id = 5;
+        $alias_copy = $alias->copy();
+
+        # Ensure the values are equal
+        $this->assert_equals($alias->to_internal(), $alias_copy->to_internal());
+        $this->assert_equals($alias_copy->id, 5);
+        $this->assert_equals($alias->to_representation(), $alias_copy->to_representation());
+
+        # Change the copy's values and ensure the original values are not changed
+        $alias_copy->name->value = 'new_name';
+        $this->assert_not_equals($alias->name->value, $alias_copy->name->value);
+    }
+
+    /**
+     * Ensure the copy() method does not use excessive memory in larger datasets. This is a regression test for #617.
+     */
+    public function test_copy_memory_usage(): void {
+        # Generate lots of DHCP Server Static Mappings
+        $static_mappings = [];
+        $used_macs = [];
+        while (count($static_mappings) < 450) {
+            # Generate a unique mac address for each static mapping
+            $mac = RESTAPI\Core\Tools\generate_mac_address();
+            if (in_array($mac, $used_macs)) {
+                continue;
+            }
+            $static_mappings[] = ['mac' => $mac];
+        }
+
+        # Update the DHCP server with our static mappings
+        $dhcp_server = new DHCPServer(id: 'lan', staticmap: $static_mappings);
+        $dhcp_server->update();
+
+        # Read a static mapping and copy it
+        $static_mapping = new DHCPServerStaticMapping(id: 50, parent_id: 'lan');
+        $static_mapping->copy();
+
+        # Remove the static mappings
+        $dhcp_server->staticmap->value = [];
+        $dhcp_server->update(apply: true);
+    }
 }

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Tests/APICoreToolsTestCase.inc

@@ -6,6 +6,7 @@ require_once 'RESTAPI/autoloader.inc';
 
 use RESTAPI\Core\TestCase;
 use function RESTAPI\Core\Tools\bandwidth_to_bits;
+use function RESTAPI\Core\Tools\generate_mac_address;
 use function RESTAPI\Core\Tools\is_assoc_array;
 use function RESTAPI\Core\Tools\to_upper_camel_case;
 
@@ -52,4 +53,13 @@ class APICoreToolsTestCase extends TestCase {
         $this->assert_equals(to_upper_camel_case('this is a test'), 'ThisIsATest');
         $this->assert_equals(to_upper_camel_case('_this is-a test'), 'ThisIsATest');
     }
+
+    /**
+     * Checks that the generate_mac_address() function correctly generates a random MAC address.
+     */
+    public function test_generate_mac_address(): void {
+        $mac_address = generate_mac_address();
+        $this->assert_equals(strlen($mac_address), 17);
+        $this->assert_is_true(preg_match('/^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/', $mac_address) === 1);
+    }
 }