Add agents controller

Author: santiagolizardo

composer.lock

@@ -561,5 +561,24 @@ CREATE TABLE notification
 ) ENGINE = InnoDB
   CHARSET = utf8mb4;
 
+DROP TABLE IF EXISTS agent;
+
+CREATE TABLE agent
+(
+    id           INT UNSIGNED NOT NULL AUTO_INCREMENT,
+    client_id    VARCHAR(100) NOT NULL,
+    last_boot_at TIMESTAMP    NULL,
+    last_ping_at TIMESTAMP    NULL,
+    active       BOOLEAN      NOT NULL DEFAULT FALSE,
+    version      VARCHAR(100) NULL,
+    hostname     VARCHAR(100) NULL,
+    arch         VARCHAR(100) NULL,
+    cpu          VARCHAR(100) NULL,
+    memory       VARCHAR(100) NULL,
+    os           VARCHAR(100) NULL,
+    PRIMARY KEY (id)
+) ENGINE = InnoDB,
+  CHARSET = utf8mb4;
+
 SET
     FOREIGN_KEY_CHECKS = 1;

database/01-schema.sql

@@ -2,9 +2,7 @@
 set -e
 
 export XDEBUG_MODE=coverage
-export XDEBUG_MODE=off
-export PHPUNIT_ARGS="--coverage-clover=\"/var/www/webapp/tests/clover.xml\""
-export PHPUNIT_ARGS="--no-coverage --display-warnings"
+export PHPUNIT_ARGS=" --display-warnings --coverage-clover=\"/var/www/webapp/tests/clover.xml\""
 
 pushd /var/www/webapp
 ./vendor/bin/phpunit $PHPUNIT_ARGS

run-tests.sh

@@ -11,7 +11,8 @@
 use OpenApi\Attributes\Server;
 use Psr\Container\ContainerInterface;
 use Psr\Log\LoggerInterface;
-use Reconmap\{Controllers\Attachments\ServeAttachmentController,
+use Reconmap\{Controllers\Agents\AgentsRouter,
+    Controllers\Attachments\ServeAttachmentController,
     Controllers\AuditLog\AuditLogRouter,
     Controllers\Auth\AuthRouter,
     Controllers\Clients\ClientsRouter,
@@ -49,6 +50,7 @@ class ApiRouter extends Router
 {
     private const array ROUTER_CLASSES = [
         AuthRouter::class,
+        AgentsRouter::class,
         AttachmentsRouter::class,
         AuditLogRouter::class,
         CommandsRouter::class,

src/ApiRouter.php

@@ -0,0 +1,15 @@
+<?php declare(strict_types=1);
+
+namespace Reconmap\Controllers\Agents;
+
+use League\Route\RouteCollectionInterface;
+
+class AgentsRouter
+{
+    public function mapRoutes(RouteCollectionInterface $router): void
+    {
+        $router->map('GET', '/agents', GetAgentsController::class);
+        $router->map('GET', '/agents/ping', PingAgentController::class);
+        $router->map('POST', '/agents/boot', BootAgentController::class);
+    }
+}

src/Controllers/Agents/AgentsRouter.php

@@ -0,0 +1,28 @@
+<?php declare(strict_types=1);
+
+namespace Reconmap\Controllers\Agents;
+
+use OpenApi\Attributes as OpenApi;
+use Psr\Http\Message\ServerRequestInterface;
+use Reconmap\Controllers\Controller;
+use Reconmap\Http\Docs\Default200OkResponse;
+use Reconmap\Http\Docs\Default403UnauthorisedResponse;
+use Reconmap\Repositories\AgentRepository;
+
+#[OpenApi\Get(path: "/agents/boot", description: "Returns information about all agents", security: ["bearerAuth"], tags: ["Agents"])]
+#[Default200OkResponse]
+#[Default403UnauthorisedResponse]
+class BootAgentController extends Controller
+{
+
+    public function __construct(private readonly AgentRepository $repository)
+    {
+    }
+
+    public function __invoke(ServerRequestInterface $request): array
+    {
+        $info = $this->getJsonBodyDecoded($request);
+
+        return $this->repository->updateLastBootAt($info);
+    }
+}

src/Controllers/Agents/BootAgentController.php

@@ -0,0 +1,26 @@
+<?php declare(strict_types=1);
+
+namespace Reconmap\Controllers\Agents;
+
+use OpenApi\Attributes as OpenApi;
+use Psr\Http\Message\ServerRequestInterface;
+use Reconmap\Controllers\Controller;
+use Reconmap\Http\Docs\Default200OkResponse;
+use Reconmap\Http\Docs\Default403UnauthorisedResponse;
+use Reconmap\Repositories\AgentRepository;
+
+#[OpenApi\Get(path: "/agents", description: "Returns information about all agents", security: ["bearerAuth"], tags: ["Agents"])]
+#[Default200OkResponse]
+#[Default403UnauthorisedResponse]
+class GetAgentsController extends Controller
+{
+
+    public function __construct(private readonly AgentRepository $repository)
+    {
+    }
+
+    public function __invoke(ServerRequestInterface $request): array
+    {
+        return $this->repository->findAll();
+    }
+}

src/Controllers/Agents/GetAgentsController.php

@@ -0,0 +1,26 @@
+<?php declare(strict_types=1);
+
+namespace Reconmap\Controllers\Agents;
+
+use OpenApi\Attributes as OpenApi;
+use Psr\Http\Message\ServerRequestInterface;
+use Reconmap\Controllers\Controller;
+use Reconmap\Http\Docs\Default200OkResponse;
+use Reconmap\Http\Docs\Default403UnauthorisedResponse;
+use Reconmap\Repositories\AgentRepository;
+
+#[OpenApi\Get(path: "/agents/ping", description: "Returns information about all agents", security: ["bearerAuth"], tags: ["Agents"])]
+#[Default200OkResponse]
+#[Default403UnauthorisedResponse]
+class PingAgentController extends Controller
+{
+
+    public function __construct(private readonly AgentRepository $repository)
+    {
+    }
+
+    public function __invoke(ServerRequestInterface $request): array
+    {
+        return $this->repository->updateLastPingAt();
+    }
+}

src/Controllers/Agents/PingAgentController.php

@@ -65,7 +65,8 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
 
                 $tokenRole = $this->extractRoleFromToken($token);
                 $request = $request->withAttribute('userId', $dbUser['id'])
-                    ->withAttribute('role', $tokenRole);
+                    ->withAttribute('role', $tokenRole)
+                    ->withAttribute('token', $jwt);
             }
             return $handler->handle($request);
         } catch (ForbiddenException|ExpiredException $e) {

src/Http/AuthMiddleware.php

@@ -0,0 +1,58 @@
+<?php declare(strict_types=1);
+
+namespace Reconmap\Repositories;
+
+use Ponup\SqlBuilders\SelectQueryBuilder;
+
+class AgentRepository extends MysqlRepository
+{
+    public const array UPDATABLE_COLUMNS_TYPES = [
+        'version' => 's',
+        'hostname' => 's',
+        'arch' => 's',
+        'cpu' => 's',
+        'memory' => 's',
+        'os' => 's',
+        'active' => 'i',
+        'last_boot_at' => 's',
+        'last_ping_at' => 's',
+    ];
+
+    public function findAll(): array
+    {
+        $queryBuilder = $this->getBaseSelectQueryBuilder();
+        $result = $this->mysqlServer->query($queryBuilder->toSql());
+        return $result->fetch_all(MYSQLI_ASSOC);
+    }
+
+    public function updateLastPingAt(): bool
+    {
+        return $this->updateByTableId('agent', 1, ['last_ping_at' => date('Y-m-d H:i:s')]);
+    }
+
+    public function updateLastBootAt(object $info): bool
+    {
+        $currentDateTime = date('Y-m-d H:i:s');
+
+        return $this->updateByTableId('agent', 1, [
+            'version' => $info->version,
+            'hostname' => $info->hostname,
+            'arch' => $info->arch,
+            'cpu' => $info->cpu,
+            'memory' => $info->memory,
+            'os' => $info->os,
+            'last_boot_at' => $currentDateTime,
+            'last_ping_at' => $currentDateTime
+        ]);
+    }
+
+    protected function getBaseSelectQueryBuilder(): SelectQueryBuilder
+    {
+        $queryBuilder = new SelectQueryBuilder('agent a');
+        $queryBuilder->setColumns('
+            a.*
+        ');
+        $queryBuilder->setOrderBy('a.client_id ASC, a.last_ping_at DESC');
+        return $queryBuilder;
+    }
+}