-
-
Notifications
You must be signed in to change notification settings - Fork 110
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Service Watchdog endpoint (#273)
* feat: added APIServicesServiceWatchdogRead model * feat: added APIServicesServiceWatchdogUpdate model * feat: added /api/v1/services/service_watchdog endpoint * test: added tests for /api/v1/services/service_watchdog * docs: added documentation for /api/v1/service/service_watchdog
- Loading branch information
1 parent
5578989
commit 535d442
Showing
6 changed files
with
317 additions
and
0 deletions.
There are no files selected for viewing
30 changes: 30 additions & 0 deletions
30
pfSense-pkg-API/files/etc/inc/api/endpoints/APIServicesServiceWatchdog.inc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <?php | ||
| // Copyright 2022 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 APIServicesServiceWatchdog extends APIEndpoint { | ||
| public function __construct() { | ||
| $this->url = "/api/v1/services/service_watchdog"; | ||
| } | ||
|
|
||
| protected function get() { | ||
| return (new APIServicesServiceWatchdogRead())->call(); | ||
| } | ||
|
|
||
| protected function put() { | ||
| return (new APIServicesServiceWatchdogUpdate())->call(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
46 changes: 46 additions & 0 deletions
46
pfSense-pkg-API/files/etc/inc/api/models/APIServicesServiceWatchdogRead.inc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| <?php | ||
| // Copyright 2022 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 APIServicesServiceWatchdogRead extends APIModel { | ||
|
|
||
| public function __construct() { | ||
| parent::__construct(); | ||
| $this->privileges = ["page-all", "page-services-servicewatchdog"]; | ||
| $this->packages = ["pfSense-pkg-Service_Watchdog"]; | ||
| $this->package_includes = ["servicewatchdog.inc"]; | ||
| } | ||
|
|
||
| public function action() { | ||
| return APIResponse\get(0, $this->get_watched_services()); | ||
| } | ||
|
|
||
| public static function get_watched_services() { | ||
| global $config; | ||
| $services = ($config["installedpackages"]["servicewatchdog"]["item"]) ?: []; | ||
|
|
||
| # Loop through each configured service and ensure data is formatted correctly | ||
| foreach ($services as &$service) { | ||
| $service["enabled"] = isset($service["enabled"]); | ||
| $service["status"] = isset($service["status"]); | ||
| $service["notify"] = isset($service["notify"]); | ||
| } | ||
|
|
||
| return $services; | ||
| } | ||
| } |
99 changes: 99 additions & 0 deletions
99
pfSense-pkg-API/files/etc/inc/api/models/APIServicesServiceWatchdogUpdate.inc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| <?php | ||
| // Copyright 2022 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 APIServicesServiceWatchdogUpdate extends APIModel { | ||
| public function __construct() { | ||
| parent::__construct(); | ||
| $this->privileges = ["page-all", "page-services-servicewatchdog"]; | ||
| $this->packages = ["pfSense-pkg-Service_Watchdog"]; | ||
| $this->package_includes = ["servicewatchdog.inc"]; | ||
| $this->change_note = "Modified Service Watchdog configuration via API"; | ||
| } | ||
|
|
||
| public function action() { | ||
| # Write the updated configuration and reload service watchdog if changes were made | ||
| if ($this->validated_data) { | ||
| $this->config["installedpackages"]["servicewatchdog"]["item"] = $this->validated_data; | ||
| $this->write_config(); | ||
| servicewatchdog_cron_job(); | ||
| } | ||
|
|
||
| return APIResponse\get(0, APIServicesServiceWatchdogRead::get_watched_services()); | ||
| } | ||
|
|
||
| public function validate_payload() { | ||
| $this->__validate_services(); | ||
| } | ||
|
|
||
| private function __validate_services() { | ||
| # Validate the optional 'services' field | ||
| if (isset($this->initial_data["services"])) { | ||
| # Variables | ||
| $watched_services = []; | ||
|
|
||
| # Revert validated data so it can be repopulated with the updated values | ||
| $this->validated_data = []; | ||
|
|
||
| # Loop through each requested service and configure it accordingly | ||
| foreach ($this->initial_data["services"] as $service) { | ||
| # Ensure this item is an array | ||
| $service = (is_array($service)) ? $service : []; | ||
|
|
||
| # Require the 'name' subfield | ||
| if (!isset($service["name"])) { | ||
| $this->errors[] = APIResponse\get(2259); | ||
| } | ||
| # Require this service to be watchable | ||
| elseif (!$this->is_service_watchable($service["name"])) { | ||
| $this->errors[] = APIResponse\get(2260); | ||
| } | ||
| # Do not allow duplicates of the same service | ||
| elseif (in_array($service["name"], $watched_services)) { | ||
| $this->errors[] = APIResponse\get(2261); | ||
| } | ||
| # Otherwise, this service is valid. | ||
| else { | ||
| # Mark this service as watched so duplicates will not be allowed | ||
| $watched_services[] = $service["name"]; | ||
|
|
||
| # Get the configuration for this service | ||
| $serv_conf = $this->is_service_watchable($service["name"]); | ||
|
|
||
| # Allow clients to set the notify field | ||
| if ($service["notify"] === true) { | ||
| $serv_conf["notify"] = true; | ||
| } | ||
|
|
||
| # Add this service to our validated configuration | ||
| $this->validated_data[] = $serv_conf; | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public function is_service_watchable($name) { | ||
| # Loop through compatible services and check if this service is found | ||
| foreach (get_services() as $service) { | ||
| if ($service["name"] === $name) { | ||
| return $service; | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| # Copyright 2022 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. | ||
| """Class used to test the /api/v1/services/service_watchdog endpoint.""" | ||
| import e2e_test_framework | ||
|
|
||
|
|
||
| class APIE2ETestServicesServiceWatchdog(e2e_test_framework.APIE2ETest): | ||
| """Class used to test the /api/v1/services/service_watchdog endpoint.""" | ||
| uri = "/api/v1/services/service_watchdog" | ||
| put_tests = [ | ||
| { | ||
| "name": "Check pfSense-pkg-Service_Watchdog installed constraint", | ||
| "status": 500, | ||
| "return": 12 | ||
| }, | ||
| { | ||
| "name": "Install pfSense-pkg-Service_Watchdog so we can test further", | ||
| "method": "POST", | ||
| "uri": "/api/v1/system/package", | ||
| "resp_time": 30, | ||
| "payload": { | ||
| "name": "pfSense-pkg-Service_Watchdog" | ||
| } | ||
| }, | ||
| { | ||
| "name": "Check service 'name' required constraint", | ||
| "status": 400, | ||
| "return": 2259, | ||
| "payload": {"services": [{}]} | ||
| }, | ||
| { | ||
| "name": "Check service 'name' options constraint", | ||
| "status": 400, | ||
| "return": 2260, | ||
| "payload": {"services": [{"name": "INVALID"}]} | ||
| }, | ||
| { | ||
| "name": "Check service 'name' no duplicates constraint", | ||
| "status": 400, | ||
| "return": 2261, | ||
| "payload": {"services": [{"name": "unbound"}, {"name": "unbound"}]} | ||
| }, | ||
| { | ||
| "name": "Update watched services", | ||
| "payload": {"services": [{"name": "unbound", "notify": True}]} | ||
| }, | ||
| { | ||
| "name": "Read the Service Watchdog configuration", | ||
| "method": "GET" | ||
| }, | ||
| { | ||
| "name": "Uninstall pfSense-pkg-Service_Watchdog", | ||
| "method": "DELETE", | ||
| "uri": "/api/v1/system/package", | ||
| "resp_time": 30, | ||
| "payload": { | ||
| "name": "pfSense-pkg-Service_Watchdog" | ||
| } | ||
| }, | ||
| ] | ||
|
|
||
|
|
||
| APIE2ETestServicesServiceWatchdog() |