Merge pull request #107 from MarketSquare/95_better_name_for_dto

Dto renamed to RelationsMapping, constraint_mapping renamed to relati…

Author: robinmackaij

docs/releases.md

@@ -20,11 +20,15 @@
 - Fixed an exception during validation caused by `charset` being included in the `Content-Type` header for `application/json`.
 
 ### Breaking changes
-- `invalid_property_default_response` library parameter renamed to `invalid_data_default_response`.
+- Addressing [issue #95: Refactor: better name for Dto](https://github.com/MarketSquare/robotframework-openapitools/issues/95) introduces a number breaking renames:
+    - `Dto` has been renamed to `RelationsMapping`.
+    - `constraint_mapping` has been renamed to `relations_mapping` in a number of places.
+    - `DTO_MAPPING` has been renamed to `RELATIONS_MAPPING`.
 - The `RequestData` class that is returned by a number of keywords has been changed:
     - The `dto` property was removed.
     - The `valid_data` property was added.
-    - The `constrait_mapping` property was added.
+    - The `relations_mapping` property was added.
+- `invalid_property_default_response` library parameter renamed to `invalid_data_default_response`.
 
 ### Additional changes
 - Special handling of `"format": "byte"` for `"type": "string"` (OAS 3.0) was removed.

src/OpenApiDriver/__init__.py

@@ -6,16 +6,14 @@
 - IdDependency, IdReference, PathPropertiesConstraint, PropertyValueConstraint,
     UniquePropertyValueConstraint: Classes to be subclassed by the library user
     when implementing a custom mapping module (advanced use).
-- Dto, Relation: Base classes that can be used for type annotations.
+- RelationsMapping, Relation: Base classes that can be used for type annotations.
 - IGNORE: A special constant that can be used as a value in the PropertyValueConstraint.
 """
 
 from importlib.metadata import version
 
 from OpenApiDriver.openapidriver import OpenApiDriver
-from OpenApiLibCore.data_constraints.dto_base import (
-    Dto,
-)
+from OpenApiLibCore.data_relations.relations_base import RelationsMapping
 from OpenApiLibCore.keyword_logic.validation import ValidationLevel
 from OpenApiLibCore.models import IGNORE
 from OpenApiLibCore.models.resource_relations import (
@@ -35,12 +33,12 @@
 
 __all__ = [
     "IGNORE",
-    "Dto",
     "IdDependency",
     "IdReference",
     "OpenApiDriver",
     "PathPropertiesConstraint",
     "PropertyValueConstraint",
+    "RelationsMapping",
     "ResourceRelation",
     "UniquePropertyValueConstraint",
     "ValidationLevel",

src/OpenApiDriver/openapi_executors.py

@@ -250,11 +250,11 @@ def test_endpoint(self, path: str, method: str, status_code: int) -> None:
         if status_code >= int(HTTPStatus.BAD_REQUEST):
             invalidation_keywords: list[str] = []
 
-            if request_data.constraint_mapping.get_body_relations_for_error_code(
+            if request_data.relations_mapping.get_body_relations_for_error_code(
                 status_code
             ):
                 invalidation_keywords.append("get_invalid_body_data")
-            if request_data.constraint_mapping.get_parameter_relations_for_error_code(
+            if request_data.relations_mapping.get_parameter_relations_for_error_code(
                 status_code
             ):
                 invalidation_keywords.append("get_invalidated_parameters")
@@ -300,7 +300,7 @@ def test_endpoint(self, path: str, method: str, status_code: int) -> None:
                     )
             else:
                 raise AssertionError(
-                    f"No constraint mapping found to cause status_code {status_code}."
+                    f"No relation found to cause status_code {status_code}."
                 )
         _run_keyword(
             "perform_validated_request",

src/OpenApiLibCore/__init__.py

@@ -7,13 +7,13 @@
 - IdDependency, IdReference, PathPropertiesConstraint, PropertyValueConstraint,
     UniquePropertyValueConstraint: Classes to be subclassed by the library user
     when implementing a custom mapping module (advanced use).
-- Dto, Relation: Base classes that can be used for type annotations.
+- RelationsMapping, Relation: Base classes that can be used for type annotations.
 - IGNORE: A special constant that can be used as a value in the PropertyValueConstraint.
 """
 
 from importlib.metadata import version
 
-from OpenApiLibCore.data_constraints.dto_base import Dto
+from OpenApiLibCore.data_relations.relations_base import RelationsMapping
 from OpenApiLibCore.keyword_logic.validation import ValidationLevel
 from OpenApiLibCore.models import IGNORE, UNSET
 from OpenApiLibCore.models.request_data import RequestData, RequestValues
@@ -62,12 +62,12 @@
 __all__ = [
     "IGNORE",
     "UNSET",
-    "Dto",
     "IdDependency",
     "IdReference",
     "OpenApiLibCore",
     "PathPropertiesConstraint",
     "PropertyValueConstraint",
+    "RelationsMapping",
     "RequestData",
     "RequestValues",
     "ResourceRelation",

src/OpenApiLibCore/data_generation/data_generation_core.py

@@ -12,7 +12,7 @@
 
 import OpenApiLibCore.keyword_logic.path_functions as _path_functions
 from OpenApiLibCore.annotations import JSON
-from OpenApiLibCore.data_constraints.dto_base import Dto
+from OpenApiLibCore.data_relations.relations_base import RelationsMapping
 from OpenApiLibCore.models import IGNORE
 from OpenApiLibCore.models.oas_models import (
     ArraySchema,
@@ -28,7 +28,7 @@
     PropertyValueConstraint,
     ResourceRelation,
 )
-from OpenApiLibCore.protocols import ConstraintMappingType
+from OpenApiLibCore.protocols import RelationsMappingType
 from OpenApiLibCore.utils.parameter_utils import get_safe_name_for_oas_name
 
 
@@ -49,26 +49,26 @@ def get_request_data(
         operation_spec: OperationObject | None = getattr(path_item, method)
         if operation_spec is None:
             raise AttributeError
-        constraint_mapping = operation_spec.constraint_mapping
+        relations_mapping = operation_spec.relations_mapping
     except AttributeError:
         logger.info(
             f"method '{method}' not supported on '{spec_path}, using empty spec."
         )
         operation_spec = OperationObject(operationId="")
-        constraint_mapping = None
+        relations_mapping = None
 
     parameters, params, headers = get_request_parameters(
-        constraint_mapping=constraint_mapping, method_spec=operation_spec
+        relations_mapping=relations_mapping, method_spec=operation_spec
     )
     if operation_spec.requestBody is None:
-        constraint_mapping = _get_mapping_dataclass_for_empty_body(
-            constraint_mapping=constraint_mapping,
+        relations_mapping = _get_mapping_dataclass_for_empty_body(
+            relations_mapping=relations_mapping,
             mapping_cls_name=mapping_cls_name,
             method_spec=operation_spec,
         )
         return RequestData(
             valid_data=None,
-            constraint_mapping=constraint_mapping,
+            relations_mapping=relations_mapping,
             parameters=parameters,
             params=params,
             headers=headers,
@@ -93,16 +93,16 @@ def get_request_data(
         operation_id=operation_spec.operationId
     )
 
-    constraint_mapping = _get_mapping_dataclass_from_valid_data(
+    relations_mapping = _get_mapping_dataclass_from_valid_data(
         schema=schema_used_for_data_generation,
-        constraint_mapping=constraint_mapping,
+        relations_mapping=relations_mapping,
         valid_data=valid_data,
         method_spec=operation_spec,
         mapping_cls_name=mapping_cls_name,
     )
     return RequestData(
         valid_data=valid_data,
-        constraint_mapping=constraint_mapping,
+        relations_mapping=relations_mapping,
         body_schema=schema_used_for_data_generation,
         parameters=parameters,
         params=params,
@@ -111,12 +111,12 @@ def get_request_data(
 
 
 def _get_mapping_dataclass_for_empty_body(
-    constraint_mapping: ConstraintMappingType | None,
+    relations_mapping: RelationsMappingType | None,
     mapping_cls_name: str,
     method_spec: OperationObject,
-) -> ConstraintMappingType:
+) -> RelationsMappingType:
     cls_name = method_spec.operationId if method_spec.operationId else mapping_cls_name
-    base = constraint_mapping if constraint_mapping else Dto
+    base = relations_mapping if relations_mapping else RelationsMapping
     mapping_class = make_dataclass(
         cls_name=cls_name,
         fields=[],
@@ -127,22 +127,22 @@ def _get_mapping_dataclass_for_empty_body(
 
 def _get_mapping_dataclass_from_valid_data(
     schema: ResolvedSchemaObjectTypes,
-    constraint_mapping: ConstraintMappingType | None,
+    relations_mapping: RelationsMappingType | None,
     valid_data: JSON,
     method_spec: OperationObject,
     mapping_cls_name: str,
-) -> ConstraintMappingType:
+) -> RelationsMappingType:
     if not isinstance(schema, (ObjectSchema, ArraySchema)):
         return _get_mapping_dataclass_for_empty_body(
-            constraint_mapping=constraint_mapping,
+            relations_mapping=relations_mapping,
             mapping_cls_name=mapping_cls_name,
             method_spec=method_spec,
         )
 
     if isinstance(schema, ArraySchema):
         if not valid_data or not isinstance(valid_data, list):
             return _get_mapping_dataclass_for_empty_body(
-                constraint_mapping=constraint_mapping,
+                relations_mapping=relations_mapping,
                 mapping_cls_name=mapping_cls_name,
                 method_spec=method_spec,
             )
@@ -160,7 +160,7 @@ def _get_mapping_dataclass_from_valid_data(
 
         mapping_dataclass = _get_mapping_dataclass_from_valid_data(
             schema=matched_schema,
-            constraint_mapping=constraint_mapping,
+            relations_mapping=relations_mapping,
             valid_data=first_item_data,
             method_spec=method_spec,
             mapping_cls_name=mapping_cls_name,
@@ -172,7 +172,7 @@ def _get_mapping_dataclass_from_valid_data(
     )
     fields = get_dataclass_fields(object_schema=schema, valid_data=valid_data)
     cls_name = method_spec.operationId if method_spec.operationId else mapping_cls_name
-    base = constraint_mapping if constraint_mapping else Dto
+    base = relations_mapping if relations_mapping else RelationsMapping
     mapping_dataclass = make_dataclass(
         cls_name=cls_name,
         fields=fields,
@@ -210,12 +210,12 @@ def get_mapping_cls_name(path: str, method: str) -> str:
 
 
 def get_request_parameters(
-    constraint_mapping: ConstraintMappingType | None, method_spec: OperationObject
+    relations_mapping: RelationsMappingType | None, method_spec: OperationObject
 ) -> tuple[list[ParameterObject], dict[str, Any], dict[str, str]]:
     """Get the methods parameter spec and params and headers with valid data."""
     parameters = method_spec.parameters if method_spec.parameters else []
     parameter_relations = (
-        constraint_mapping.get_parameter_relations() if constraint_mapping else []
+        relations_mapping.get_parameter_relations() if relations_mapping else []
     )
     query_params = [p for p in parameters if p.in_ == "query"]
     header_params = [p for p in parameters if p.in_ == "header"]

src/OpenApiLibCore/data_generation/data_invalidation.py

@@ -12,9 +12,7 @@
 from robot.libraries.BuiltIn import BuiltIn
 
 from OpenApiLibCore.annotations import JSON
-from OpenApiLibCore.data_constraints.dto_base import (
-    Dto,
-)
+from OpenApiLibCore.data_relations.relations_base import RelationsMapping
 from OpenApiLibCore.models import IGNORE
 from OpenApiLibCore.models.oas_models import (
     ArraySchema,
@@ -69,7 +67,7 @@ def get_invalid_body_data(
     invalid_data_default_response: int,
 ) -> JSON:
     method = method.lower()
-    data_relations = request_data.constraint_mapping.get_body_relations_for_error_code(
+    data_relations = request_data.relations_mapping.get_body_relations_for_error_code(
         status_code
     )
     if not data_relations:
@@ -107,7 +105,7 @@ def get_invalid_body_data(
             url,
             method,
             request_data.valid_data,
-            request_data.constraint_mapping,
+            request_data.relations_mapping,
             status_code,
         )
     if isinstance(resource_relation, IdReference):
@@ -147,7 +145,7 @@ def get_invalidated_parameters(
         raise ValueError("No params or headers to invalidate.")
 
     # ensure the status_code can be triggered
-    relations = request_data.constraint_mapping.get_parameter_relations_for_error_code(
+    relations = request_data.relations_mapping.get_parameter_relations_for_error_code(
         status_code
     )
     relations_for_status_code = [
@@ -185,7 +183,7 @@ def get_invalidated_parameters(
         # non-default status_codes can only be the result of a Relation
         parameter_names = relation_property_names
 
-    # Constraint mappings may contain generic mappings for properties that are
+    # Relation mappings may contain generic mappings for properties that are
     # not present in this specific schema
     request_data_parameter_names = [p.name for p in request_data.parameters]
     additional_relation_property_names = {
@@ -235,7 +233,7 @@ def get_invalidated_parameters(
     except ValueError:
         invalid_value_for_error_code = NOT_SET
 
-    # get the constraint values if available for the chosen parameter
+    # get the constrained values if available for the chosen parameter
     try:
         [values_from_constraint] = [
             r.values
@@ -327,13 +325,13 @@ def get_json_data_with_conflict(
     base_url: str,
     method: str,
     json_data: dict[str, JSON],
-    constraint_mapping: type[Dto],
+    relations_mapping: type[RelationsMapping],
     conflict_status_code: int,
 ) -> dict[str, Any]:
     method = method.lower()
     unique_property_value_constraints = [
         r
-        for r in constraint_mapping.get_relations()
+        for r in relations_mapping.get_relations()
         if isinstance(r, UniquePropertyValueConstraint)
     ]
     for relation in unique_property_value_constraints:
@@ -342,7 +340,7 @@ def get_json_data_with_conflict(
         if method in ["patch", "put"]:
             post_url_parts = url.split("/")[:-1]
             post_url = "/".join(post_url_parts)
-            # the PATCH or PUT may use a different constraint_mapping than required for
+            # the PATCH or PUT may use a different relations_mapping than required for
             # POST so valid POST data must be constructed
             path = post_url.replace(base_url, "")
             request_data = _run_keyword("get_request_data", path, "post")
@@ -372,5 +370,5 @@ def get_json_data_with_conflict(
         return json_data
     raise ValueError(
         f"No UniquePropertyValueConstraint in the get_relations list on "
-        f"constraint_mapping {constraint_mapping}."
+        f"relations_mapping {relations_mapping}."
     )

…nApiLibCore/data_constraints/__init__.py …penApiLibCore/data_relations/__init__.pysrc/OpenApiLibCore/data_constraints/__init__.py renamed to src/OpenApiLibCore/data_relations/__init__.py src/OpenApiLibCore/data_constraints/__init__.py renamed to src/OpenApiLibCore/data_relations/__init__.py

@@ -17,15 +17,15 @@
     ResourceRelation,
 )
 from OpenApiLibCore.protocols import (
-    ConstraintMappingType,
     IGetIdPropertyName,
+    RelationsMappingType,
 )
 from OpenApiLibCore.utils.id_mapping import dummy_transformer
 
 
 @dataclass
-class Dto(ABC):
-    """Base class for the Dto class."""
+class RelationsMapping(ABC):
+    """Base class for the RelationsMapping classes."""
 
     @staticmethod
     def get_path_relations() -> list[PathPropertiesConstraint]:
@@ -78,21 +78,21 @@ def get_body_relations_for_error_code(
         return relations
 
 
-def get_constraint_mapping_dict(
+def get_relations_mapping_dict(
     mappings_module_name: str,
-) -> dict[tuple[str, str], ConstraintMappingType]:
+) -> dict[tuple[str, str], RelationsMappingType]:
     try:
         mappings_module = import_module(mappings_module_name)
-        return mappings_module.DTO_MAPPING  # type: ignore[no-any-return]
+        return mappings_module.RELATIONS_MAPPING  # type: ignore[no-any-return]
     except (ImportError, AttributeError, ValueError) as exception:
         if mappings_module_name != "no mapping":
-            logger.error(f"DTO_MAPPING was not imported: {exception}")
+            logger.error(f"RELATIONS_MAPPING was not imported: {exception}")
         return {}
 
 
 def get_path_mapping_dict(
     mappings_module_name: str,
-) -> dict[str, ConstraintMappingType]:
+) -> dict[str, RelationsMappingType]:
     try:
         mappings_module = import_module(mappings_module_name)
         return mappings_module.PATH_MAPPING  # type: ignore[no-any-return]

…nApiLibCore/data_constraints/dto_base.py …LibCore/data_relations/relations_base.pysrc/OpenApiLibCore/data_constraints/dto_base.py renamed to src/OpenApiLibCore/data_relations/relations_base.py src/OpenApiLibCore/data_constraints/dto_base.py renamed to src/OpenApiLibCore/data_relations/relations_base.py

@@ -113,8 +113,8 @@ def get_valid_url(
             f"{path} not found in paths section of the OpenAPI document."
         ) from None
 
-    constraint_mapping = path_item.constraint_mapping
-    relations = constraint_mapping.get_path_relations() if constraint_mapping else []
+    relations_mapping = path_item.relations_mapping
+    relations = relations_mapping.get_path_relations() if relations_mapping else []
     paths = [p.path for p in relations]
     if paths:
         url = f"{base_url}{choice(paths)}"