Improve record testing and fix errors found

Include missing fields in CloudRecord when being rendered (i.e. remove
the `exlude_unset` argument when exporting, and remove versions from
rendering.

Fixes: #118
SemVer: bufgix

Author: alvarolopez

caso/messenger/ssm.py

@@ -183,7 +183,6 @@ def push(self, records):
         entries_storage = []
         opts = {
             "by_alias": True,
-            "exclude_unset": True,
             "exclude_none": True,
         }
         for record in records:

caso/record.py

@@ -16,8 +16,8 @@
 
 """Module containing all the cloud accounting records."""
 
-import abc
 import datetime
+import enum
 import typing
 import uuid as m_uuid
 
@@ -29,23 +29,33 @@
 LOG = log.getLogger(__name__)
 
 
-class _BaseRecord(pydantic.BaseModel, abc.ABC):
+class _BaseRecord(pydantic.BaseModel):
     """This is the base cASO record object."""
 
-    version: str
+    version: str = pydantic.Field(..., exclude=True)
 
     site_name: str
-    cloud_type = caso.user_agent
+    cloud_type: str = caso.user_agent
     compute_service: str
 
 
+class _ValidCloudStatus(str, enum.Enum):
+    started = "started"
+    completed = "completed"
+    error = "error"
+    paused = "paused"
+    suspended = "suspended"
+    stopped = "stopped"
+    unknown = "unknown"
+
+
 class CloudRecord(_BaseRecord):
     """The CloudRecord class holds information for each of the records.
 
     This class is versioned, following the Cloud Accounting Record versions.
     """
 
-    version: str = "0.4"
+    version: str = pydantic.Field("0.4", exclude=True)
 
     uuid: m_uuid.UUID
     name: str
@@ -55,7 +65,7 @@ class CloudRecord(_BaseRecord):
     group_id: str
     fqan: str
 
-    status: str
+    status: _ValidCloudStatus
 
     image_id: typing.Optional[str]
 
@@ -156,7 +166,7 @@ class IPRecord(_BaseRecord):
     This class is versioned, following the Public IP Usage Record versions.
     """
 
-    version = "0.2"
+    version: str = pydantic.Field("0.2", exclude=True)
 
     uuid: m_uuid.UUID
 

caso/tests/conftest.py

@@ -20,11 +20,13 @@
 
 import pytest
 
+import caso
 import caso.record
 
 now = datetime.datetime(2023, 5, 25, 21, 59, 6, 0)
+cloud_type = caso.user_agent
 
-valid_records_fields = [
+valid_cloud_records_fields = [
     dict(
         uuid="721cf1db-0e0f-4c24-a5ea-cd75e0f303e8",
         site_name="TEST-Site",
@@ -35,7 +37,7 @@
         start_time=now - datetime.timedelta(days=5),
         end_time=now,
         compute_service="Fake Cloud Service",
-        status="ACTIVE",
+        status="started",
         image_id="b39a8ed9-e15d-4b71-ada2-daf88efbac0a",
         user_dn="User DN",
         benchmark_type=None,
@@ -55,7 +57,7 @@
         start_time=now - datetime.timedelta(days=6),
         end_time=now,
         compute_service="Fake Cloud Service",
-        status="ACTIVE",
+        status="completed",
         image_id="b39a8ed9-e15d-4b71-ada2-daf88efbac0a",
         user_dn="User DN",
         benchmark_type=None,
@@ -67,11 +69,12 @@
     ),
 ]
 
-valid_records_dict = [
+valid_cloud_records_dict = [
     {
         "CloudComputeService": "Fake Cloud Service",
         "CpuCount": 8,
         "CpuDuration": 3456000,
+        "CloudType": cloud_type,
         "Disk": 250,
         "StartTime": 1684612746,
         "EndTime": 1685044746,
@@ -84,14 +87,15 @@
         "Memory": 16,
         "PublicIPCount": 7,
         "SiteName": "TEST-Site",
-        "Status": "ACTIVE",
+        "Status": "started",
         "VMUUID": "721cf1db-0e0f-4c24-a5ea-cd75e0f303e8",
         "WallDuration": 432000,
     },
     {
         "CloudComputeService": "Fake Cloud Service",
         "CpuCount": 8,
         "CpuDuration": 3456000,
+        "CloudType": cloud_type,
         "Disk": 250,
         "StartTime": 1684526346,
         "EndTime": 1685044746,
@@ -104,7 +108,7 @@
         "Memory": 16,
         "PublicIPCount": 7,
         "SiteName": "TEST-Site",
-        "Status": "ACTIVE",
+        "Status": "completed",
         "VMUUID": "a53738e1-13eb-4047-800c-067d14ce3d22",
         "WallDuration": 432000,
     },
@@ -116,7 +120,7 @@
 @pytest.fixture(scope="module")
 def cloud_record():
     """Get a fixture for the CloudRecord."""
-    record = caso.record.CloudRecord(**valid_records_fields[0])
+    record = caso.record.CloudRecord(**valid_cloud_records_fields[0])
     # Remove this when moving to Pydantic 2
     record.wall_duration = 432000
     record.cpu_duration = 3456000
@@ -126,28 +130,28 @@ def cloud_record():
 @pytest.fixture(scope="module")
 def another_cloud_record():
     """Get another fixture for the CloudRecord."""
-    record = caso.record.CloudRecord(**valid_records_fields[1])
+    record = caso.record.CloudRecord(**valid_cloud_records_fields[1])
     record.wall_duration = 432000
     record.cpu_duration = 3456000
     return record
 
 
 @pytest.fixture(scope="module")
-def valid_record():
+def valid_cloud_record():
     """Get a fixture for a valid record."""
-    return valid_records_dict[0]
+    return valid_cloud_records_dict[0]
 
 
 @pytest.fixture(scope="module")
-def valid_records():
+def valid_cloud_records():
     """Get a fixture for valid records as a dict."""
-    return valid_records_dict
+    return valid_cloud_records_dict
 
 
 @pytest.fixture(scope="module")
-def another_valid_record():
+def another_valid_cloud_record():
     """Get another fixture for a valid record as a dict."""
-    return valid_records_dict[0]
+    return valid_cloud_records_dict[0]
 
 
 @pytest.fixture(scope="module")
@@ -164,6 +168,7 @@ def expected_entries_cloud():
     """Get a fixture for all cloud entries."""
     ssm_entries = [
         "CloudComputeService: Fake Cloud Service\n"
+        f"CloudType: {cloud_type}\n"
         "CpuCount: 8\n"
         "CpuDuration: 3456000\n"
         "Disk: 250\n"
@@ -178,10 +183,11 @@ def expected_entries_cloud():
         "PublicIPCount: 7\n"
         "SiteName: TEST-Site\n"
         "StartTime: 1684612746\n"
-        "Status: ACTIVE\n"
+        "Status: started\n"
         "VMUUID: 721cf1db-0e0f-4c24-a5ea-cd75e0f303e8\n"
         "WallDuration: 432000",
         "CloudComputeService: Fake Cloud Service\n"
+        f"CloudType: {cloud_type}\n"
         "CpuCount: 8\n"
         "CpuDuration: 3456000\n"
         "Disk: 250\n"
@@ -196,7 +202,7 @@ def expected_entries_cloud():
         "PublicIPCount: 7\n"
         "SiteName: TEST-Site\n"
         "StartTime: 1684526346\n"
-        "Status: ACTIVE\n"
+        "Status: completed\n"
         "VMUUID: a53738e1-13eb-4047-800c-067d14ce3d22\n"
         "WallDuration: 432000",
     ]

caso/tests/test_record.py

@@ -36,18 +36,17 @@ def test_cloud_record(cloud_record):
 
 
 @pytest.mark.skip(reason="Pydantic 1 does not support computed fields")
-def test_cloud_record_map_opts(cloud_record, valid_record):
+def test_cloud_record_map_opts(cloud_record, valid_cloud_record):
     """Test a cloud record is correctly rendered."""
     opts = {
         "by_alias": True,
-        "exclude_unset": True,
         "exclude_none": True,
     }
 
-    assert json.loads(cloud_record.json(**opts)) == valid_record
+    assert json.loads(cloud_record.json(**opts)) == valid_cloud_record
 
 
-def test_cloud_record_map_opts_custom_wall_cpu(cloud_record, valid_record):
+def test_cloud_record_map_opts_custom_wall_cpu(cloud_record, valid_cloud_record):
     """Test a cloud record is correctly rendered with custom wall and cpu times."""
     wall = datetime.timedelta(days=5).total_seconds()
     cpu = wall * cloud_record.cpu_count
@@ -56,11 +55,10 @@ def test_cloud_record_map_opts_custom_wall_cpu(cloud_record, valid_record):
 
     opts = {
         "by_alias": True,
-        "exclude_unset": True,
         "exclude_none": True,
     }
 
-    assert json.loads(cloud_record.json(**opts)) == valid_record
+    assert json.loads(cloud_record.json(**opts)) == valid_cloud_record
 
 
 @pytest.mark.skip(reason="Pydantic 1 does not support computed fields")