Added APIFirewallTrafficShaperQueueDelete model to delete existing queues, updated unit test to test queue deletions

Author: jaredhendrickson13

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallTrafficShaperQueue.inc

@@ -23,4 +23,8 @@ class APIFirewallTrafficShaperQueue extends APIEndpoint {
     protected function post() {
         return (new APIFirewallTrafficShaperQueueCreate())->call();
     }
+
+    protected function delete() {
+        return (new APIFirewallTrafficShaperQueueDelete())->call();
+    }
 }

pfSense-pkg-API/files/etc/inc/api/framework/APIResponse.inc

@@ -1850,6 +1850,12 @@ function get($id, $data=[], $all=false) {
             "return" => $id,
             "message" => "Firewall traffic shaper queue realtime3 value must be a bandwidth formatted string"
         ],
+        4145 => [
+            "status" => "bad request",
+            "code" => 400,
+            "return" => $id,
+            "message" => "Firewall traffic shaper queue name does not exist"
+        ],
 
         //5000-5999 reserved for /users API calls
         5000 => [

pfSense-pkg-API/files/etc/inc/api/models/APIFirewallTrafficShaperQueueDelete.inc

@@ -0,0 +1,103 @@
+<?php
+//   Copyright 2021 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
+require_once("api/framework/APIModel.inc");
+require_once("api/framework/APIResponse.inc");
+
+class APIFirewallTrafficShaperQueueDelete extends APIModel {
+    public $parent_id;
+
+    # Create our method constructor
+    public function __construct() {
+        parent::__construct();
+        $this->privileges = ["page-all", "page-firewall-trafficshaper-queues"];
+        $this->change_note = "Deleted firewall traffic shaper queue via API";
+    }
+
+    public function action() {
+        unset($this->config["shaper"]["queue"][$this->parent_id]["queue"][$this->id]);
+        $this->write_config();
+        mark_subsystem_dirty('shaper');
+
+        # Only reload the filter immediately if it was requested by the client
+        if ($this->initial_data["apply"] === true) {
+            # Reload the filter, reset RRD logs and mark the subsystem as applied
+            filter_configure();
+            system("rm -f /var/db/rrd/*queuedrops.rrd");
+            system("rm -f /var/db/rrd/*queues.rrd");
+            enable_rrd_graphing();
+            clear_subsystem_dirty('shaper');
+        }
+        return APIResponse\get(0, $this->validated_data);
+    }
+
+    public function validate_payload() {
+        $this->__validate_interface();
+        $this->__validate_name();
+    }
+
+    private function __validate_interface() {
+        # Check for our required `interface` payload value
+        if (isset($this->initial_data["interface"])) {
+            $this->initial_data["interface"] = APITools\get_pfsense_if_id($this->initial_data["interface"]);
+
+            # Check that the requested interface exists
+            if ($this->initial_data["interface"]) {
+                # Check that a traffic shaper is configured for this interface
+                if ($this->get_shaper_id_by_interface($this->initial_data["interface"], true)) {
+                    # Set the interface this queue will be applied to
+                    $this->parent_id = $this->get_shaper_id_by_interface($this->initial_data["interface"]);
+                } else {
+                    $this->errors[] = APIResponse\get(4122);
+                }
+            } else {
+                $this->errors[] = APIResponse\get(4111);
+            }
+        } else {
+            $this->errors[] = APIResponse\get(4110);
+        }
+    }
+
+    private function __validate_name() {
+        # Check for our required `name` payload value
+        if (isset($this->initial_data["name"])) {
+            # Loop through each queue within the interface's shaper and search for a match
+            foreach ($this->config["shaper"]["queue"][$this->parent_id]["queue"] as $id=>$queue) {
+                # Check if this queue matches the requested queue to delete
+                if ($this->initial_data["name"] === $queue["name"]) {
+                    $this->id = intval($id);
+                    $this->validated_data = $this->config["shaper"]["queue"][$this->parent_id]["queue"][$this->id];
+                }
+            }
+            # If no ID was found set does not exist error
+            if (!isset($this->id)) {
+                $this->errors[] = APIResponse\get(4145);
+            }
+        } else {
+            $this->errors[] = APIResponse\get(4123);
+        }
+    }
+
+    public function get_shaper_id_by_interface($interface, $as_bool=false) {
+        # Loop through each configured shaper
+        foreach ($this->config["shaper"]["queue"] as $id=>$shaper) {
+            # Check if this is the shaper for our interface, if so return it's ID
+            if ($interface === $shaper["interface"]) {
+                return ($as_bool) ? true : intval($id);
+            }
+        }
+        return ($as_bool) ? false : null;
+    }
+}

tests/test_api_v1_firewall_traffic_shaper_queue.py

@@ -415,18 +415,61 @@ class APIUnitTestFirewallTrafficShaperQueue(unit_test_framework.APIUnitTest):
                 "realtime3": "1Mb"
             }
         },
+    ]
+    delete_tests = [
+        {
+            "name": "Delete Test_Queue",
+            "payload": {
+                "interface": "lan",
+                "name": "Test_Queue"
+            }
+        },
+        {
+            "name": "Check interface requirement",
+            "status": 400,
+            "return": 4110
+        },
+        {
+            "name": "Check interface validation",
+            "status": 400,
+            "return": 4111,
+            "payload": {
+                "interface": "INVALID"
+            }
+        },
+        {
+            "name": "Check interface with no traffic shaper",
+            "status": 400,
+            "return": 4122,
+            "payload": {
+                "interface": "wan",
+            }
+        },
+        {
+            "name": "Check name requirement",
+            "status": 400,
+            "return": 4123,
+            "payload": {
+                "interface": "lan"
+            }
+        },
+        {
+            "name": "Check name validation",
+            "status": 400,
+            "return": 4145,
+            "payload": {
+                "interface": "lan",
+                "name": "INVALID"
+            }
+        },
         {
             "name": "Delete parent traffic shaper",
             "uri": "/api/v1/firewall/traffic_shaper",
-            "method": "DELETE",
             "payload": {
                 "interface": "lan",
                 "apply": True
             }
         },
-
     ]
 
-
-
-APIUnitTestFirewallTrafficShaperQueue()
+APIUnitTestFirewallTrafficShaperQueue()