Added API models and endpoints to reboot and halt the system, updated documentation to include new endpoint instructions, added new unit tests to test new endpoints

Author: jaredhendrickson13

README.md

@@ -0,0 +1,26 @@
+<?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/APIEndpoint.inc");
+
+class APISystemHalt extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/system/halt";
+    }
+
+    protected function post() {
+        return (new APISystemHaltCreate())->call();
+    }
+}

docs/documentation.json

@@ -0,0 +1,26 @@
+<?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/APIEndpoint.inc");
+
+class APISystemReboot extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/system/reboot";
+    }
+
+    protected function post() {
+        return (new APISystemRebootCreate())->call();
+    }
+}

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

@@ -0,0 +1,41 @@
+<?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 APISystemHaltCreate extends APIModel {
+    # Create our method constructor
+    public function __construct() {
+        parent::__construct();
+        $this->privileges = ["page-all", "page-diagnostics-haltsystem"];
+    }
+
+    public function action() {
+        $this->__clean_system_halt();
+        return APIResponse\get(0, []);
+    }
+
+    private function __clean_system_halt() {
+        # Don't actually halt the system if we are just debugging. Required for unit testing.
+        if ($this->initial_data["debug"] !== true) {
+            # Use ob_start()/ob_end_clean() to prevent system_halt() from printing output to the JSON response
+            ob_start();
+            system_halt();
+            ob_end_clean();
+        }
+    }
+}

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

@@ -0,0 +1,42 @@
+<?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 APISystemRebootCreate extends APIModel {
+    # Create our method constructor
+    public function __construct() {
+        parent::__construct();
+        $this->privileges = ["page-all", "page-diagnostics-rebootsystem"];
+    }
+
+    public function action() {
+        # Use ob_start()/ob_end_clean() to prevent system_reboot() from printing output to the JSON response
+        $this->__clean_system_halt();
+        return APIResponse\get(0, []);
+    }
+
+    private function __clean_system_halt() {
+        # Don't actually reboot the system if we are just debugging. Required for unit testing.
+        if ($this->initial_data["debug"] !== true) {
+            # Use ob_start()/ob_end_clean() to prevent system_reboot() from printing output to the JSON response
+            ob_start();
+            system_reboot();
+            ob_end_clean();
+        }
+    }
+}

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

@@ -0,0 +1,9 @@
+import unit_test_framework
+
+class APIUnitTestSystemHalt(unit_test_framework.APIUnitTest):
+    url = "/api/v1/system/halt"
+    post_payloads = [
+        {"debug": True}
+    ]
+
+APIUnitTestSystemHalt()

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

@@ -0,0 +1,9 @@
+import unit_test_framework
+
+class APIUnitTestSystemReboot(unit_test_framework.APIUnitTest):
+    url = "/api/v1/system/reboot"
+    post_payloads = [
+        {"debug": True}
+    ]
+
+APIUnitTestSystemReboot()