Added endpoints and e2e tests for program parameters

Author: Robert Segal

e2e_config.test.json

@@ -73,6 +73,7 @@
   "program.document.file.id": "PDM-9643-3741-0001",
   "program.media.id": "PMD-9643-3741-0001",
   "program.parameter.group.id": "PPG-9643-3741-0002",
+  "program.parameter.id": "PPM-9643-3741-0001",
   "program.program.id": "PRG-9643-3741",
   "program.template.id": "PTM-9643-3741-0004"
 }

mpt_api_client/resources/program/programs.py

@@ -22,6 +22,10 @@
     AsyncParameterGroupsService,
     ParameterGroupsService,
 )
+from mpt_api_client.resources.program.programs_parameters import (
+    AsyncParametersService,
+    ParametersService,
+)
 from mpt_api_client.resources.program.programs_templates import (
     AsyncTemplatesService,
     TemplatesService,
@@ -105,6 +109,12 @@ def parameter_groups(self, program_id: str) -> ParameterGroupsService:
             http_client=self.http_client, endpoint_params={"program_id": program_id}
         )
 
+    def parameters(self, program_id: str) -> ParametersService:  # noqa: WPS110
+        """Return program parameters service."""
+        return ParametersService(
+            http_client=self.http_client, endpoint_params={"program_id": program_id}
+        )
+
     def templates(self, program_id: str) -> TemplatesService:
         """Return program templates service."""
         return TemplatesService(
@@ -151,6 +161,12 @@ def parameter_groups(self, program_id: str) -> AsyncParameterGroupsService:
             http_client=self.http_client, endpoint_params={"program_id": program_id}
         )
 
+    def parameters(self, program_id: str) -> AsyncParametersService:  # noqa: WPS110
+        """Return async program parameters service."""
+        return AsyncParametersService(
+            http_client=self.http_client, endpoint_params={"program_id": program_id}
+        )
+
     def templates(self, program_id: str) -> AsyncTemplatesService:
         """Return async program templates service."""
         return AsyncTemplatesService(

mpt_api_client/resources/program/programs_parameters.py

@@ -0,0 +1,69 @@
+from mpt_api_client.http import AsyncService, Service
+from mpt_api_client.http.mixins import (
+    AsyncCollectionMixin,
+    AsyncManagedResourceMixin,
+    CollectionMixin,
+    ManagedResourceMixin,
+)
+from mpt_api_client.models import Model
+from mpt_api_client.models.model import BaseModel
+
+
+class Parameter(Model):
+    """Parameter resource.
+
+    Attributes:
+        name: Parameter name.
+        scope: Parameter scope.
+        phase: Parameter phase (e.g. Order, Fulfillment).
+        program: Reference to the program this parameter belongs to.
+        description: Parameter description.
+        multiple: Whether multiple values are allowed for this parameter.
+        external_id: External identifier for the parameter.
+        display_order: Display order of the parameter.
+        constraints: Parameter constraints (required, hidden, readonly).
+        options: Type-specific parameter options.
+        type: Parameter type (e.g. SingleLineText, MultiLineText, Address, etc.).
+        status: Parameter status.
+        audit: Audit information (created, updated events).
+    """
+
+    name: str | None
+    scope: str | None
+    phase: str | None
+    program: BaseModel | None
+    description: str | None
+    multiple: bool | None
+    external_id: str | None
+    display_order: int | None
+    constraints: BaseModel | None
+    options: BaseModel | None
+    type: str | None
+    status: str | None
+    audit: BaseModel | None
+
+
+class ParametersServiceConfig:
+    """Parameters service configuration."""
+
+    _endpoint = "/public/v1/program/programs/{program_id}/parameters"
+    _model_class = Parameter
+    _collection_key = "data"
+
+
+class ParametersService(
+    ManagedResourceMixin[Parameter],
+    CollectionMixin[Parameter],
+    Service[Parameter],
+    ParametersServiceConfig,
+):
+    """Parameters service."""
+
+
+class AsyncParametersService(
+    AsyncManagedResourceMixin[Parameter],
+    AsyncCollectionMixin[Parameter],
+    AsyncService[Parameter],
+    ParametersServiceConfig,
+):
+    """Parameters service."""

tests/e2e/program/program/parameter/conftest.py

@@ -0,0 +1,32 @@
+import pytest
+
+
+@pytest.fixture
+def parameter_id(e2e_config):
+    return e2e_config["program.parameter.id"]
+
+
+@pytest.fixture
+def invalid_parameter_id():
+    return "PPM-0000-0000-0000"
+
+
+@pytest.fixture
+def parameter_data():
+    return {
+        "externalId": "e2eCreatedProgramParameter",
+        "displayOrder": 100,
+        "scope": "Enrollment",
+        "phase": "Fulfillment",
+        "multiple": False,
+        "description": "E2E Created Program Parameter",
+        "type": "SingleLineText",
+        "constraints": {"hidden": False, "required": False, "readonly": False},
+        "name": "E2E Created Program Parameter",
+        "options": {
+            "type": "SingleLineText",
+            "placeholderText": "E2E Created Program Parameter",
+            "name": "E2E Created Program Parameter",
+            "hintText": "E2E Created Program Parameter",
+        },
+    }

tests/e2e/program/program/parameter/test_async_parameter.py

@@ -0,0 +1,68 @@
+import pytest
+
+from mpt_api_client.exceptions import MPTAPIError
+from mpt_api_client.rql.query_builder import RQLQuery
+
+pytestmark = [pytest.mark.flaky]
+
+
+@pytest.fixture
+async def created_parameter(async_mpt_vendor, program_id, parameter_data):
+    service = async_mpt_vendor.program.programs.parameters(program_id)
+    parameter = await service.create(parameter_data)
+    yield parameter
+    try:
+        await service.delete(parameter.id)
+    except MPTAPIError as error:
+        print(f"TEARDOWN - Unable to delete parameter {parameter.id}: {error.title}")  # noqa: WPS421
+
+
+def test_create_parameter(created_parameter):
+    result = created_parameter.name == "E2E Created Program Parameter"
+
+    assert result is True
+
+
+async def test_update_parameter(async_mpt_vendor, program_id, created_parameter):
+    service = async_mpt_vendor.program.programs.parameters(program_id)
+    update_data = {"name": "E2E Updated Program Parameter"}
+
+    result = await service.update(created_parameter.id, update_data)
+
+    assert result.name == update_data["name"]
+
+
+async def test_get_parameter(async_mpt_vendor, program_id, parameter_id):
+    service = async_mpt_vendor.program.programs.parameters(program_id)
+
+    result = await service.get(parameter_id)
+
+    assert result.id == parameter_id
+
+
+async def test_get_invalid_parameter(async_mpt_vendor, program_id, invalid_parameter_id):
+    with pytest.raises(MPTAPIError):
+        await async_mpt_vendor.program.programs.parameters(program_id).get(invalid_parameter_id)
+
+
+async def test_delete_parameter(async_mpt_vendor, program_id, created_parameter):
+    parameter_data = created_parameter
+
+    result = async_mpt_vendor.program.programs.parameters(program_id)
+
+    await result.delete(parameter_data.id)
+
+
+async def test_filter_and_select_parameters(async_mpt_vendor, program_id, parameter_id):
+    select_fields = ["-description", "-audit"]
+    filtered_parameters = (
+        async_mpt_vendor.program.programs
+        .parameters(program_id)
+        .filter(RQLQuery(id=parameter_id))
+        .filter(RQLQuery(name="E2E Seeded Program Parameter"))
+        .select(*select_fields)
+    )
+
+    result = [parameter async for parameter in filtered_parameters.iterate()]
+
+    assert len(result) == 1

tests/e2e/program/program/parameter/test_sync_parameter.py

@@ -0,0 +1,68 @@
+import pytest
+
+from mpt_api_client.exceptions import MPTAPIError
+from mpt_api_client.rql.query_builder import RQLQuery
+
+pytestmark = [pytest.mark.flaky]
+
+
+@pytest.fixture
+def created_parameter(mpt_vendor, program_id, parameter_data):
+    service = mpt_vendor.program.programs.parameters(program_id)
+    parameter = service.create(parameter_data)
+    yield parameter
+    try:
+        service.delete(parameter.id)
+    except MPTAPIError as error:
+        print(f"TEARDOWN - Unable to delete parameter {parameter.id}: {error.title}")  # noqa: WPS421
+
+
+def test_create_parameter(created_parameter):
+    result = created_parameter.name == "E2E Created Program Parameter"
+
+    assert result is True
+
+
+def test_update_parameter(mpt_vendor, program_id, created_parameter):
+    service = mpt_vendor.program.programs.parameters(program_id)
+    update_data = {"name": "E2E Updated Program Parameter"}
+
+    result = service.update(created_parameter.id, update_data)
+
+    assert result.name == update_data["name"]
+
+
+def test_get_parameter(mpt_vendor, program_id, parameter_id):
+    service = mpt_vendor.program.programs.parameters(program_id)
+
+    result = service.get(parameter_id)
+
+    assert result.id == parameter_id
+
+
+def test_get_invalid_parameter(mpt_vendor, program_id, invalid_parameter_id):
+    with pytest.raises(MPTAPIError):
+        mpt_vendor.program.programs.parameters(program_id).get(invalid_parameter_id)
+
+
+def test_delete_parameter(mpt_vendor, program_id, created_parameter):
+    parameter_data = created_parameter
+
+    result = mpt_vendor.program.programs.parameters(program_id)
+
+    result.delete(parameter_data.id)
+
+
+def test_filter_and_select_parameters(mpt_vendor, program_id, parameter_id):
+    select_fields = ["-description", "-audit"]
+    filtered_parameters = (
+        mpt_vendor.program.programs
+        .parameters(program_id)
+        .filter(RQLQuery(id=parameter_id))
+        .filter(RQLQuery(name="E2E Seeded Program Parameter"))
+        .select(*select_fields)
+    )
+
+    result = list(filtered_parameters.iterate())
+
+    assert len(result) == 1

tests/e2e/program/program/template/test_async_template.py

@@ -40,6 +40,11 @@ async def test_get_template(async_mpt_vendor, program_id, template_id):
     assert result.id == template_id
 
 
+async def test_get_template_invalid_id(async_mpt_vendor, program_id, invalid_template_id):
+    with pytest.raises(MPTAPIError):
+        await async_mpt_vendor.program.programs.templates(program_id).get(invalid_template_id)
+
+
 async def test_delete_template(async_mpt_vendor, program_id, created_template):
     template_data = created_template
 

tests/e2e/program/program/template/test_sync_template.py

@@ -40,6 +40,11 @@ def test_get_template(mpt_vendor, program_id, template_id):
     assert result.id == template_id
 
 
+def test_get_template_invalid_id(mpt_vendor, program_id, invalid_template_id):
+    with pytest.raises(MPTAPIError):
+        mpt_vendor.program.programs.templates(program_id).get(invalid_template_id)
+
+
 def test_delete_template(mpt_vendor, program_id, created_template):
     template_data = created_template
 

tests/unit/resources/program/test_programs.py

@@ -16,6 +16,10 @@
     AsyncParameterGroupsService,
     ParameterGroupsService,
 )
+from mpt_api_client.resources.program.programs_parameters import (
+    AsyncParametersService,
+    ParametersService,
+)
 from mpt_api_client.resources.program.programs_templates import (
     AsyncTemplatesService,
     TemplatesService,
@@ -98,6 +102,7 @@ def test_async_mixins_present(async_programs_service, method):
         ("documents", DocumentService),
         ("media", MediaService),
         ("parameter_groups", ParameterGroupsService),
+        ("parameters", ParametersService),
         ("templates", TemplatesService),
     ],
 )
@@ -114,6 +119,7 @@ def test_property_services(programs_service, service_method, expected_service_cl
         ("documents", AsyncDocumentService),
         ("media", AsyncMediaService),
         ("parameter_groups", AsyncParameterGroupsService),
+        ("parameters", AsyncParametersService),
         ("templates", AsyncTemplatesService),
     ],
 )