Add tests for oval generation (#1100)

Also, updated preflight and run-tests pipeline.

Resolves: AlmaLinux/build-system#413

---------
Co-authored-by: Serhii Betin <[email protected]>

Author: gost-serb

.github/workflows/preflight.yml

@@ -48,6 +48,13 @@ jobs:
           repository: AlmaLinux/albs-sign-file
           path: albs-sign-file
 
+      - name: Checkout oval-processor
+        uses: actions/checkout@v4
+        with:
+          repository: AlmaLinux/oval-processor
+          path: oval-processor
+          ssh-key: ${{ secrets.OVAL_PROCESSOR_PRIVKEY }}
+
       - name: Set up Docker Buildx
         # https://github.com/marketplace/actions/docker-setup-buildx
         uses: docker/setup-buildx-action@v3
@@ -85,6 +92,7 @@ jobs:
           mkdir -p $REPORTS_DIR
           mkdir -p ../{alts,albs-frontend,albs-node,albs-sign-node,alma-tests-cacher}
           ln -sf tests/test-vars.env vars.env
+          ln -sf oval-processor/almalinux almalinux
 
       - name: Start services
         run: docker compose up -d test_db sign_file

.github/workflows/run-tests.yml

@@ -25,6 +25,13 @@ jobs:
           repository: AlmaLinux/albs-sign-file
           path: albs-sign-file
 
+      - name: Checkout oval-processor
+        uses: actions/checkout@v4
+        with:
+          repository: AlmaLinux/oval-processor
+          path: oval-processor
+          ssh-key: ${{ secrets.OVAL_PROCESSOR_PRIVKEY }}
+
       - name: Set up Docker Buildx
         # https://github.com/marketplace/actions/docker-setup-buildx
         uses: docker/setup-buildx-action@v3
@@ -49,6 +56,7 @@ jobs:
           mkdir -p $REPORTS_DIR
           mkdir -p ../{alts,albs-frontend,albs-node,albs-sign-node,alma-tests-cacher}
           ln -sf tests/test-vars.env vars.env
+          ln -sf oval-processor/almalinux almalinux
 
       - name: Start services
         run: docker compose up -d test_db sign_file

scripts/serialize_new_errata_rec.py

@@ -0,0 +1,158 @@
+import datetime
+import json
+import logging
+import os
+import sys
+from enum import Enum
+from pathlib import Path
+
+import sqlalchemy
+from dotenv import load_dotenv
+from sqlalchemy import create_engine, select
+from sqlalchemy.dialects.postgresql import JSONB
+from sqlalchemy.inspection import inspect
+from sqlalchemy.orm import Session
+
+sys.path.append(str(Path(__file__).parents[1]))
+load_dotenv('vars.env')
+
+
+from alws.models import NewErrataRecord, NewErrataPackage, Platform
+
+
+def serialize_model(
+    instance, seen=None, exclude_models=None, exclude_columns=None
+):
+    seen = set() if seen is None else seen
+    exclude_models = [] if exclude_models is None else exclude_models
+    exclude_columns = [] if exclude_columns is None else exclude_columns
+
+    if type(instance) in exclude_models:
+        return None
+
+    if instance in seen:
+        return {"id": getattr(instance, "id", None)}
+
+    seen.add(instance)
+
+    logging.info('Serializing %s', instance.__class__.__name__)
+
+    data = {}
+    for column in inspect(instance).mapper.column_attrs:
+        if column.key in exclude_columns:
+            data[column.key] = None
+            continue
+
+        value = getattr(instance, column.key)
+
+        if isinstance(value, Enum):
+            data[column.key] = value.name
+        elif isinstance(value, datetime.datetime):
+            data[column.key] = value.isoformat()
+        elif isinstance(column.expression.type, JSONB):
+            data[column.key] = json.dumps(value)
+        else:
+            data[column.key] = value
+
+    for relationship in inspect(instance).mapper.relationships:
+        related_value = getattr(instance, relationship.key)
+        if related_value is None:
+            data[relationship.key] = None
+        elif relationship.uselist:
+            if type(related_value[0]) in exclude_models:
+                data[relationship.key] = []
+                continue
+            data[relationship.key] = [
+                serialize_model(item, seen, exclude_models)
+                for item in related_value
+            ]
+        else:
+            data[relationship.key] = serialize_model(
+                related_value, seen, exclude_models
+            )
+
+    return data
+
+
+def deserialize_model(cls, data):
+    instance = cls()
+
+    if data is None:
+        return instance
+
+    for column in inspect(cls).columns:
+        value = data.get(column.key)
+
+        if value is None:
+            continue
+
+        if isinstance(column.type, sqlalchemy.Enum):
+            enum_class = column.type.python_type
+            value = enum_class[value]
+
+        elif isinstance(column.type, sqlalchemy.DateTime):
+            value = datetime.datetime.fromisoformat(value)
+
+        elif isinstance(column.type, JSONB):
+            value = json.loads(value) if isinstance(value, str) else value
+
+        setattr(instance, column.key, value)
+
+    for relationship in inspect(cls).relationships:
+        related_data = data.get(relationship.key)
+        if related_data is not None:
+            if isinstance(related_data, dict):
+                related_instance = deserialize_model(
+                    relationship.mapper.class_, related_data
+                )
+                setattr(instance, relationship.key, related_instance)
+
+            elif isinstance(related_data, list):
+                related_instances = [
+                    deserialize_model(relationship.mapper.class_, item)
+                    for item in related_data
+                ]
+                setattr(instance, relationship.key, related_instances)
+
+    return instance
+
+
+if __name__ == '__main__':
+    logging.basicConfig(level=logging.INFO, handlers=[logging.StreamHandler()])
+
+    sqlalchemy_url = os.getenv('SQLALCHEMY_URL')
+
+    engine = create_engine(sqlalchemy_url, echo=False)
+    session = Session(engine)
+    stmt = select(NewErrataRecord).where(
+        NewErrataRecord.id.in_((
+            'ALSA-2025:0281',
+            'ALSA-2025:0325',
+            'ALSA-2024:9644',
+            'ALSA-2024:6964',
+        ))
+    )
+    errata_records = session.execute(stmt).scalars().fetchall()
+
+    serialized_records = [
+        serialize_model(
+            rec,
+            exclude_models=[NewErrataPackage, Platform],
+            exclude_columns=[
+                'last_release_log',
+                'original_title',
+                'original_criteria',
+                'original_tests',
+                'original_objects',
+                'original_states',
+                'original_variables',
+            ],
+        )
+        for rec in errata_records
+    ]
+
+    dst_path = (
+        Path(__file__).parents[1] / 'tests/samples/new_errata_records.json'
+    )
+    with dst_path.open('w', encoding='utf-8') as f:
+        json.dump(serialized_records, f, indent=4)

tests/README.md

@@ -5,6 +5,9 @@
 `fixtures/` - a directory with pytest fixtures, new module should be also added in `conftest.pytest_plugins`
 
 `mock_classes.py` - a module which contain base class with `httpx` request method, setup logic for each test suite and HTTP status codes
+
+`../scripts/serialize_new_errata_rec.py` - a helper module for exporting/importing NewErrataRecords from a DB to json file.
+
 ## How to run tests locally
 1. Adjust variables in `vars.env`
     ```
@@ -29,7 +32,20 @@
     docker compose up -d sign_file
     ```
 
-4. Run `pytest` within `web_server_tests` container
+4. Update `tests/samples/new_errata_records.json`:
+    Needed only on major changes in `NewErrataRecord` model that affect OVAL generation.
+
+    Note: In order to export data you'll need DB with some data,\
+    ideally the data must be as similar to production as possible
+    ```bash
+    # set SQLALCHEMY_URL is it was not done on step 1
+    # export SQLALCHEMY_URL="postgresql+psycopg2://<your-db-address>"
+    python3 scripts/serialize_new_errata_rec.py
+    ```
+    Also, you'll need to update `tests/samples/test_oval.xml`.\
+    For that uncomment block inside the test case in `tests/test_oval/test_oval_generation.py` file
+
+5. Run `pytest` within `web_server_tests` container
     ```bash
     docker compose run --rm web_server_tests pytest -v
     ```

tests/fixtures/errata.py

@@ -1,12 +1,15 @@
 import datetime
+from pathlib import Path
 import typing
+import json
 
 import pytest
 from sqlalchemy.ext.asyncio import AsyncSession
 
 from alws.crud.errata import create_errata_record, create_new_errata_record
 from alws.dramatiq.errata import create_new_errata
-from alws.schemas.errata_schema import BaseErrataRecord
+from alws.models import NewErrataRecord
+from scripts.serialize_new_errata_rec import deserialize_model
 
 
 @pytest.fixture(
@@ -128,6 +131,7 @@ async def func(*args, **kwargs):
     await async_session.commit()
     yield
 
+
 @pytest.fixture
 def pulp_updateinfos():
     return [
@@ -1222,3 +1226,25 @@ def pulp_updateinfos():
             "reboot_suggested": False,
         },
     ]
+
+
+@pytest.fixture
+def new_errata_records_samples():
+    with (Path(__file__).parents[1] / 'samples/new_errata_records.json').open(
+        encoding='utf-8'
+    ) as f:
+        json_data = json.load(f)
+
+    records = [deserialize_model(NewErrataRecord, el) for el in json_data]
+
+    return records
+
+
+@pytest.fixture
+def oval_sample():
+    with (Path(__file__).parents[1] / 'samples/test_oval.xml').open(
+        encoding='utf-8'
+    ) as f:
+        oval = f.read().encode()
+
+    return oval