Merge ~lloydwaltersj/maas:machine-get into maas:master

[Jack Lloyd-Walters]

MAASENG-2951: Add v3 api /machines GET

9cad4f4... by Jack Lloyd-Walters on 2024-04-05

join with other tables

[MAAS Lander (maas-lander)]

UNIT TESTS
-b machine-get lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/5205/console
COMMIT: 8e84d91472ad2109f4e2b42dd9f6e3639476e794

review: Needs Fixing

b31ceb6... by Jack Lloyd-Walters on 2024-04-05

fix fixtures

0cd96ca... by Jack Lloyd-Walters on 2024-04-05

linting

[MAAS Lander (maas-lander)]

UNIT TESTS
-b machine-get lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/5217/console
COMMIT: 0cd96ca0d0e6daa2c5697834085ce02e98a2190e

review: Needs Fixing

b016757... by Jack Lloyd-Walters on 2024-04-06

linting

[MAAS Lander (maas-lander)]

UNIT TESTS
-b machine-get lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/5229/console
COMMIT: b016757ec7e47734dd4b3b89c41bb19e2be07d03

review: Needs Fixing

9f56aee... by Jack Lloyd-Walters on 2024-04-06

ensure fixtures have data

[MAAS Lander (maas-lander)]

UNIT TESTS
-b machine-get lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: 9f56aee146f0ae0abd60920c224a451aa11d9520

review: Approve

[Jacopo Rota (r00ta)]

It looks good to me, I have just a small question

review: Needs Information

e9658ae... by Jack Lloyd-Walters on 2024-04-15

fix according to feedback

[MAAS Lander (maas-lander)]

UNIT TESTS
-b machine-get lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: e9658ae891d0e3ad8ee318a95530eecf1969d1ec

review: Approve

[Jacopo Rota (r00ta)]

lgtm

review: Approve

diff --git a/src/maasapiserver/v3/api/handlers/__init__.py b/src/maasapiserver/v3/api/handlers/__init__.py
index e28615e..865492c 100644
--- a/src/maasapiserver/v3/api/handlers/__init__.py
+++ b/src/maasapiserver/v3/api/handlers/__init__.py
@@ -1,5 +1,6 @@
 from maasapiserver.common.api.base import API
 from maasapiserver.v3.api.handlers.auth import AuthHandler
+from maasapiserver.v3.api.handlers.machines import MachinesHandler
 from maasapiserver.v3.api.handlers.resource_pools import ResourcePoolHandler
 from maasapiserver.v3.api.handlers.root import RootHandler
 from maasapiserver.v3.api.handlers.zones import ZonesHandler
@@ -12,5 +13,6 @@ APIv3 = API(
         ZonesHandler(),
         ResourcePoolHandler(),
         AuthHandler(),
+        MachinesHandler(),
     ],
 )
diff --git a/src/maasapiserver/v3/api/handlers/machines.py b/src/maasapiserver/v3/api/handlers/machines.py
new file mode 100644
index 0000000..13a2761
--- /dev/null
+++ b/src/maasapiserver/v3/api/handlers/machines.py
@@ -0,0 +1,44 @@
+from fastapi import Depends, Response
+
+from maasapiserver.common.api.base import Handler, handler
+from maasapiserver.common.api.models.responses.errors import (
+    ValidationErrorBodyResponse,
+)
+from maasapiserver.v3.api import services
+from maasapiserver.v3.api.models.requests.query import PaginationParams
+from maasapiserver.v3.api.models.responses.machines import MachinesListResponse
+from maasapiserver.v3.constants import EXTERNAL_V3_API_PREFIX
+from maasapiserver.v3.services import ServiceCollectionV3
+
+
+class MachinesHandler(Handler):
+    """Machines API handler."""
+
+    TAGS = ["Machines"]
+
+    @handler(
+        path="/machines",
+        methods=["GET"],
+        tags=TAGS,
+        responses={
+            200: {
+                "model": MachinesListResponse,
+            },
+            422: {"model": ValidationErrorBodyResponse},
+        },
+        response_model_exclude_none=True,
+        status_code=200,
+    )
+    async def list_machines(
+        self,
+        pagination_params: PaginationParams = Depends(),
+        services: ServiceCollectionV3 = Depends(services),
+    ) -> Response:
+        machines = await services.machines.list(pagination_params)
+        return MachinesListResponse(
+            items=[
+                machine.to_response(f"{EXTERNAL_V3_API_PREFIX}/machines")
+                for machine in machines.items
+            ],
+            total=machines.total,
+        )
diff --git a/src/maasapiserver/v3/api/models/requests/machines.py b/src/maasapiserver/v3/api/models/requests/machines.py
new file mode 100644
index 0000000..54aac9d
--- /dev/null
+++ b/src/maasapiserver/v3/api/models/requests/machines.py
@@ -0,0 +1,6 @@
+from maasapiserver.v3.api.models.requests.base import NamedBaseModel
+
+
+class MachineRequest(NamedBaseModel):
+    # TODO
+    pass
diff --git a/src/maasapiserver/v3/api/models/responses/machines.py b/src/maasapiserver/v3/api/models/responses/machines.py
new file mode 100644
index 0000000..038b133
--- /dev/null
+++ b/src/maasapiserver/v3/api/models/responses/machines.py
@@ -0,0 +1,48 @@
+from enum import Enum
+
+from maasapiserver.v3.api.models.responses.base import (
+    BaseHal,
+    HalResponse,
+    PaginatedResponse,
+)
+from maasserver.enum import NODE_STATUS_CHOICES
+from provisioningserver.drivers.pod.lxd import LXDPodDriver
+from provisioningserver.drivers.pod.virsh import VirshPodDriver
+from provisioningserver.drivers.power.registry import power_drivers
+
+MachineStatusEnum = Enum(
+    "MachineStatus",
+    dict({str(name).lower(): int(code) for code, name in NODE_STATUS_CHOICES}),
+)
+PowerTypeEnum = Enum(
+    "PowerType",
+    dict(
+        {
+            str(driver.name).lower(): str(driver.name).lower()
+            for driver in power_drivers + [LXDPodDriver(), VirshPodDriver()]
+        }
+    ),
+)
+
+
+class MachineResponse(HalResponse[BaseHal]):
+    kind = "Machine"
+    id: int
+    system_id: str
+    description: str
+    owner: str
+    cpu_speed_MHz: int
+    memory_MiB: int
+    osystem: str
+    architecture: str
+    distro_series: str
+    hwe_kernel: str
+    locked: bool
+    cpu_count: int
+    status: MachineStatusEnum
+    power_type: PowerTypeEnum
+    fqdn: str
+
+
+class MachinesListResponse(PaginatedResponse[MachineResponse]):
+    kind = "MachinesList"
diff --git a/src/maasapiserver/v3/db/machines.py b/src/maasapiserver/v3/db/machines.py
new file mode 100644
index 0000000..f17ddad
--- /dev/null
+++ b/src/maasapiserver/v3/db/machines.py
@@ -0,0 +1,90 @@
+from typing import Any
+
+from sqlalchemy import desc, select, Select
+from sqlalchemy.sql.expression import func
+from sqlalchemy.sql.functions import count
+from sqlalchemy.sql.operators import eq
+
+from maasapiserver.common.db.tables import (
+    BMCTable,
+    DomainTable,
+    NodeTable,
+    UserTable,
+)
+from maasapiserver.v3.api.models.requests.machines import MachineRequest
+from maasapiserver.v3.api.models.requests.query import PaginationParams
+from maasapiserver.v3.db.base import BaseRepository
+from maasapiserver.v3.models.base import ListResult
+from maasapiserver.v3.models.machines import Machine
+
+
+class MachinesRepository(BaseRepository[Machine, MachineRequest]):
+    async def create(self, request: MachineRequest) -> Machine:
+        raise Exception("Not implemented yet.")
+
+    async def find_by_id(self, id: int) -> Machine | None:
+        raise Exception("Not implemented yet.")
+
+    async def list(
+        self, pagination_params: PaginationParams
+    ) -> ListResult[Machine]:
+        total_stmt = select(count()).select_from(NodeTable)
+        total = (await self.connection.execute(total_stmt)).scalar()
+
+        stmt = (
+            self._select_all_statement()
+            .order_by(desc(NodeTable.c.id))
+            .offset((pagination_params.page - 1) * pagination_params.size)
+            .limit(pagination_params.size)
+        )
+
+        result = await self.connection.execute(stmt)
+        return ListResult[Machine](
+            items=[Machine(**row._asdict()) for row in result.all()],
+            total=total,
+        )
+
+    async def update(self, resource: Machine) -> Machine:
+        raise Exception("Not implemented yet.")
+
+    async def delete(self, id: int) -> None:
+        raise Exception("Not implemented yet.")
+
+    def _select_all_statement(self) -> Select[Any]:
+        return (
+            select(
+                NodeTable.c.id,
+                NodeTable.c.system_id,
+                NodeTable.c.created,
+                NodeTable.c.updated,
+                func.coalesce(UserTable.c.username, "").label("owner"),
+                NodeTable.c.description,
+                NodeTable.c.cpu_speed,
+                NodeTable.c.memory,
+                NodeTable.c.osystem,
+                NodeTable.c.architecture,
+                NodeTable.c.distro_series,
+                NodeTable.c.hwe_kernel,
+                NodeTable.c.locked,
+                NodeTable.c.cpu_count,
+                NodeTable.c.status,
+                BMCTable.c.power_type,
+                func.concat(
+                    NodeTable.c.hostname, ".", DomainTable.c.name
+                ).label("fqdn"),
+            )
+            .select_from(NodeTable)
+            .join(
+                DomainTable,
+                eq(DomainTable.c.id, NodeTable.c.domain_id),
+                isouter=True,
+            )
+            .join(
+                UserTable,
+                eq(UserTable.c.id, NodeTable.c.owner_id),
+                isouter=True,
+            )
+            .join(
+                BMCTable, eq(BMCTable.c.id, NodeTable.c.bmc_id), isouter=True
+            )
+        )
diff --git a/src/maasapiserver/v3/models/machines.py b/src/maasapiserver/v3/models/machines.py
new file mode 100644
index 0000000..8b89862
--- /dev/null
+++ b/src/maasapiserver/v3/models/machines.py
@@ -0,0 +1,48 @@
+from maasapiserver.v3.api.models.responses.base import BaseHal, BaseHref
+from maasapiserver.v3.api.models.responses.machines import (
+    MachineResponse,
+    MachineStatusEnum,
+    PowerTypeEnum,
+)
+from maasapiserver.v3.models.base import MaasTimestampedBaseModel
+
+
+class Machine(MaasTimestampedBaseModel):
+    system_id: str
+    description: str
+    owner: str
+    cpu_speed: int
+    memory: int
+    osystem: str
+    architecture: str
+    distro_series: str
+    hwe_kernel: str
+    locked: bool
+    cpu_count: int
+    status: MachineStatusEnum
+    power_type: PowerTypeEnum
+    fqdn: str
+
+    def to_response(self, self_base_hyperlink: str) -> MachineResponse:
+        return MachineResponse(
+            id=self.id,
+            system_id=self.system_id,
+            description=self.description,
+            owner=self.owner,
+            cpu_speed_MHz=self.cpu_speed,
+            memory_MiB=self.memory,
+            osystem=self.osystem,
+            architecture=self.architecture,
+            distro_series=self.distro_series,
+            hwe_kernel=self.hwe_kernel,
+            locked=self.locked,
+            cpu_count=self.cpu_count,
+            status=self.status,
+            power_type=self.power_type,
+            fqdn=self.fqdn,
+            hal_links=BaseHal(
+                self=BaseHref(
+                    href=f"{self_base_hyperlink.rstrip('/')}/{self.id}"
+                )
+            ),
+        )
diff --git a/src/maasapiserver/v3/services/__init__.py b/src/maasapiserver/v3/services/__init__.py
index 2eac400..51628e0 100644
--- a/src/maasapiserver/v3/services/__init__.py
+++ b/src/maasapiserver/v3/services/__init__.py
@@ -3,6 +3,7 @@ from sqlalchemy.ext.asyncio import AsyncConnection
 from maasapiserver.v3.services.auth import AuthService
 from maasapiserver.v3.services.bmc import BmcService
 from maasapiserver.v3.services.configurations import ConfigurationsService
+from maasapiserver.v3.services.machines import MachinesService
 from maasapiserver.v3.services.nodes import NodesService
 from maasapiserver.v3.services.resource_pools import ResourcePoolsService
 from maasapiserver.v3.services.secrets import (
@@ -25,6 +26,7 @@ class ServiceCollectionV3:
     configurations: ConfigurationsService
     resource_pools: ResourcePoolsService
     auth: AuthService
+    machines: MachinesService
 
     @classmethod
     async def produce(
@@ -51,4 +53,5 @@ class ServiceCollectionV3:
             bmc_service=services.bmc,
         )
         services.resource_pools = ResourcePoolsService(connection=connection)
+        services.machines = MachinesService(connection=connection)
         return services
diff --git a/src/maasapiserver/v3/services/machines.py b/src/maasapiserver/v3/services/machines.py
new file mode 100644
index 0000000..171ec23
--- /dev/null
+++ b/src/maasapiserver/v3/services/machines.py
@@ -0,0 +1,26 @@
+from sqlalchemy.ext.asyncio import AsyncConnection
+
+from maasapiserver.common.services._base import Service
+from maasapiserver.v3.api.models.requests.query import PaginationParams
+from maasapiserver.v3.db.machines import MachinesRepository
+from maasapiserver.v3.models.base import ListResult
+from maasapiserver.v3.models.machines import Machine
+
+
+class MachinesService(Service):
+    def __init__(
+        self,
+        connection: AsyncConnection,
+        machines_repository: MachinesRepository | None = None,
+    ):
+        super().__init__(connection)
+        self.machines_repository = (
+            machines_repository
+            if machines_repository
+            else MachinesRepository(connection)
+        )
+
+    async def list(
+        self, pagination_params: PaginationParams
+    ) -> ListResult[Machine]:
+        return await self.machines_repository.list(pagination_params)
diff --git a/src/tests/fixtures/factories/machines.py b/src/tests/fixtures/factories/machines.py
new file mode 100644
index 0000000..235dba6
--- /dev/null
+++ b/src/tests/fixtures/factories/machines.py
@@ -0,0 +1,29 @@
+from typing import Any
+
+from maasapiserver.v3.api.models.responses.machines import PowerTypeEnum
+from maasapiserver.v3.models.bmc import Bmc
+from maasapiserver.v3.models.machines import Machine
+from maasapiserver.v3.models.users import User
+from tests.fixtures.factories.node import create_test_machine_entry
+from tests.maasapiserver.fixtures.db import Fixture
+
+
+async def create_test_machine(
+    fixture: Fixture, bmc: Bmc, user: User, **extra_details: Any
+) -> Machine:
+    created_machine = await create_test_machine_entry(
+        fixture,
+        bmc_id=bmc.id,
+        owner_id=user.id,
+        osystem="ubuntu",
+        distro_series="jammy",
+        archtecture="amd64",
+        hwe_kernel="hwe-22.04",
+        **extra_details,
+    )
+    created_machine["owner"] = user.username
+    created_machine["power_type"] = PowerTypeEnum.virsh.name
+    created_machine["fqdn"] = f"{created_machine['hostname']}."
+    return Machine(
+        **created_machine,
+    )
diff --git a/src/tests/fixtures/factories/node.py b/src/tests/fixtures/factories/node.py
index 6798f13..7cfeaff 100644
--- a/src/tests/fixtures/factories/node.py
+++ b/src/tests/fixtures/factories/node.py
@@ -74,6 +74,8 @@ async def _create_test_node_entry(
         "last_applied_storage_layout": "flat",
         "enable_hw_sync": False,
         "node_type": node_type,
+        "architecture": "",
+        "hwe_kernel": "",
     }
     node.update(extra_details)
     [created_node] = await fixture.create(
diff --git a/src/tests/maasapiserver/v3/api/test_machines.py b/src/tests/maasapiserver/v3/api/test_machines.py
new file mode 100644
index 0000000..d40da3d
--- /dev/null
+++ b/src/tests/maasapiserver/v3/api/test_machines.py
@@ -0,0 +1,87 @@
+from httpx import AsyncClient
+import pytest
+
+from maasapiserver.common.api.models.responses.errors import ErrorBodyResponse
+from maasapiserver.v3.api.models.responses.machines import MachinesListResponse
+from maasapiserver.v3.constants import EXTERNAL_V3_API_PREFIX
+from maasapiserver.v3.models.machines import Machine
+from tests.fixtures.factories.bmc import create_test_bmc
+from tests.fixtures.factories.machines import create_test_machine
+from tests.fixtures.factories.user import create_test_user
+from tests.maasapiserver.fixtures.db import Fixture
+
+
[e-mail]("ensuremaasdb")
[e-mail]
+class TestMachinesApi:
+    def _assert_machine_in_list(
+        self, machine: Machine, machines_response: MachinesListResponse
+    ) -> None:
+        machine_response = next(
+            filter(
+                lambda machine_response: machine.id == machine_response.id,
+                machines_response.items,
+            )
+        )
+        assert machine.id == machine_response.id
+        assert (
+            machine.to_response(f"{EXTERNAL_V3_API_PREFIX}/machines")
+            == machine_response
+        )
+
+    @pytest.mark.parametrize("machines_size", range(0, 10))
+    async def test_list_parameters_200(
+        self,
+        api_client: AsyncClient,
+        fixture: Fixture,
+        machines_size: int,
+    ) -> None:
+        bmc = await create_test_bmc(fixture)
+        user = await create_test_user(fixture)
+        created_machines = [
+            (
+                await create_test_machine(
+                    fixture, description=str(i), bmc=bmc, user=user
+                )
+            )
+            for i in range(0, machines_size)
+        ]
+
+        response = await api_client.get("/api/v3/machines")
+        assert response.status_code == 200
+
+        machines_response = MachinesListResponse(**response.json())
+        assert machines_response.kind == "MachinesList"
+        assert machines_response.total == machines_size
+        assert len(machines_response.items) == machines_size
+        for machine in created_machines:
+            self._assert_machine_in_list(machine, machines_response)
+
+        for page in range(1, machines_size // 2):
+            response = await api_client.get(
+                f"/api/v3/machines?page={page}&size=2"
+            )
+            assert response.status_code == 200
+            machines_response = MachinesListResponse(**response.json())
+            assert machines_response.kind == "MachinesList"
+            assert machines_response.total == machines_size
+            assert (
+                len(machines_response.items) == 2
+                if page != machines_size // 2
+                else (machines_size % 2 or 2)
+            )
+
+    @pytest.mark.parametrize(
+        "page,size", [(1, 0), (0, 1), (-1, -1), (1, 1001)]
+    )
+    async def test_list_422(
+        self, page: int, size: int, api_client: AsyncClient
+    ) -> None:
+        response = await api_client.get(
+            f"/api/v3/machines?page={page}&size={size}"
+        )
+        assert response.status_code == 422
+
+        error_response = ErrorBodyResponse(**response.json())
+        assert error_response.kind == "Error"
+        assert error_response.code == 422
diff --git a/src/tests/maasapiserver/v3/db/test_machines.py b/src/tests/maasapiserver/v3/db/test_machines.py
new file mode 100644
index 0000000..b079c63
--- /dev/null
+++ b/src/tests/maasapiserver/v3/db/test_machines.py
@@ -0,0 +1,51 @@
+from math import ceil
+
+import pytest
+from sqlalchemy.ext.asyncio import AsyncConnection
+
+from maasapiserver.v3.api.models.requests.query import PaginationParams
+from maasapiserver.v3.db.machines import MachinesRepository
+from tests.fixtures.factories.bmc import create_test_bmc
+from tests.fixtures.factories.machines import create_test_machine
+from tests.fixtures.factories.user import create_test_user
+from tests.maasapiserver.fixtures.db import Fixture
+
+
[e-mail]("ensuremaasdb")
[e-mail]
+class TestMachinesRepository:
+    @pytest.mark.parametrize("page_size", range(1, 12))
+    async def test_list(
+        self, page_size: int, db_connection: AsyncConnection, fixture: Fixture
+    ) -> None:
+        bmc = await create_test_bmc(fixture)
+        user = await create_test_user(fixture)
+
+        machine_count = 10
+        machines_repository = MachinesRepository(db_connection)
+        created_machines = [
+            (
+                await create_test_machine(
+                    fixture, description=str(i), bmc=bmc, user=user
+                )
+            )
+            for i in range(0, machine_count)
+        ][::-1]
+        total_pages = ceil(machine_count / page_size)
+        for page in range(1, total_pages + 1):
+            machines_result = await machines_repository.list(
+                PaginationParams(size=page_size, page=page)
+            )
+            assert machines_result.total == machine_count
+            assert total_pages == ceil(machines_result.total / page_size)
+            if page == total_pages:  # last page may have fewer elements
+                assert len(machines_result.items) == (
+                    page_size
+                    - ((total_pages * page_size) % machines_result.total)
+                )
+            else:
+                assert len(machines_result.items) == page_size
+            for machine in created_machines[
+                ((page - 1) * page_size) : ((page * page_size))
+            ]:
+                assert machine in machines_result.items