feat: add model, endpoint and tests for REST API logs

Author: jaredhendrickson13

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Endpoints/StatusLogsPackagesRESTAPIEndpoint.inc

@@ -0,0 +1,23 @@
+<?php
+
+namespace RESTAPI\Endpoints;
+
+require_once 'RESTAPI/autoloader.inc';
+
+use RESTAPI\Core\Endpoint;
+
+/**
+ * Defines an Endpoint for interacting with many RESTAPILog Models at /api/v2/status/logs/packages/restapi.
+ */
+class StatusLogsPackagesRESTAPIEndpoint extends Endpoint {
+    public function __construct() {
+        # Set Endpoint attributes
+        $this->url = '/api/v2/status/logs/packages/restapi';
+        $this->model_name = 'RESTAPILog';
+        $this->many = true;
+        $this->request_method_options = ['GET'];
+
+        # Construct the parent Endpoint object
+        parent::__construct();
+    }
+}

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Models/RESTAPILog.inc

@@ -0,0 +1,39 @@
+<?php
+
+namespace RESTAPI\Models;
+
+use RESTAPI\Core\Model;
+use RESTAPI\Fields\StringField;
+use RESTAPI\ModelTraits\LogFileModelTraits;
+
+/**
+ * Defines a Model for interacting with the REST API log at /var/log/restapi.log.
+ */
+class RESTAPILog extends Model {
+    use LogFileModelTraits;
+
+    /**
+     * @var string $log_file The path to the base REST API log file this Model will read. Any log files that have
+     * been rotated will be read as well.
+     */
+    public string $log_file = '/var/log/restapi.log';
+    public StringField $text;
+
+    public function __construct(mixed $id = null, mixed $parent_id = null, mixed $data = [], ...$options) {
+        # Set model attributes
+        $this->internal_callable = 'get_restapi_log';
+        $this->many = true;
+
+        $this->text = new StringField(default: '', help_text: 'The raw text of the REST API log entry.');
+
+        parent::__construct($id, $parent_id, $data, ...$options);
+    }
+
+    /**
+     * Obtains the REST API log as an array. This method is the internal callable for this Model.
+     * @return array The REST API log as an array of objects.
+     */
+    protected function get_restapi_log(): array {
+        return $this->read_log($this->log_file);
+    }
+}

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

@@ -0,0 +1,18 @@
+<?php
+
+namespace RESTAPI\Tests;
+
+use RESTAPI\Core\TestCase;
+use RESTAPI\Models\RESTAPILog;
+
+class APIModelsRESTAPILogTestCase extends TestCase {
+    /**
+     * Checks if we can correctly read the restapi logs.
+     */
+    public function test_read(): void {
+        $dhcp_logs = RESTAPILog::read_all(limit: 10);
+        foreach ($dhcp_logs->model_objects as $dhcp_log) {
+            $this->assert_is_not_empty($dhcp_log->text->value);
+        }
+    }
+}