Test OpenAPI._check_enums

#3

Author: dbanty

openapi_python_client/openapi_parser/openapi.py

@@ -195,6 +195,12 @@ class OpenAPI:
 
     @staticmethod
     def _check_enums(schemas: Iterable[Schema], collections: Iterable[EndpointCollection]) -> Dict[str, EnumProperty]:
+        """
+        Create EnumProperties for every enum in any schema or collection.
+        Enums are deduplicated by class name.
+
+        :raises AssertionError: if two Enums with the same name but different values are detected
+        """
         enums: Dict[str, EnumProperty] = {}
 
         def _iterate_properties() -> Generator[Property, None, None]:

tests/test_openapi_parser/test_openapi.py

@@ -1,3 +1,5 @@
+import pytest
+
 MODULE_NAME = "openapi_python_client.openapi_parser.openapi"
 
 
@@ -32,3 +34,94 @@ def test_from_dict(self, mocker):
             schemas=schemas,
             enums=enums,
         )
+
+    def test__check_enums(self, mocker):
+        # Test that all required and optional properties of all schemas are checked
+        # Test that all path and query params of all endpoints of all collections are checked
+        # Test that non EnumProperties are skipped
+        from openapi_python_client.openapi_parser.openapi import EndpointCollection, OpenAPI
+        from openapi_python_client.openapi_parser.properties import EnumProperty, StringProperty
+
+        def _make_enum():
+            return EnumProperty(name=mocker.MagicMock(), required=True, default=None, values=mocker.MagicMock(),)
+
+        # Multiple schemas with both required and optional properties for making sure iteration works correctly
+        schema_1 = mocker.MagicMock()
+        schema_1_req_enum_1 = _make_enum()
+        schema_1_req_enum_2 = _make_enum()
+        schema_1.required_properties = [schema_1_req_enum_1, schema_1_req_enum_2]
+        schema_1_opt_enum_1 = _make_enum()
+        schema_1_opt_enum_2 = _make_enum()
+        non_enum = mocker.MagicMock(autospec=StringProperty)  # For checking non-enum properties
+        schema_1.optional_properties = [schema_1_opt_enum_1, schema_1_opt_enum_2, non_enum]
+        schema_2 = mocker.MagicMock()
+        schema_2_req_enum = _make_enum()
+        schema_2.required_properties = [schema_2_req_enum]
+        schema_2_opt_enum = _make_enum()
+        schema_2.optional_properties = [schema_2_opt_enum]
+        schemas = [schema_1, schema_2]
+
+        collection_1 = mocker.MagicMock(autospec=EndpointCollection)
+        collection_1_endpoint_1 = mocker.MagicMock()
+        collection_1_endpoint_1_path_enum_1 = _make_enum()
+        collection_1_endpoint_1_path_enum_2 = _make_enum()
+        collection_1_endpoint_1.path_parameters = [
+            collection_1_endpoint_1_path_enum_1,
+            collection_1_endpoint_1_path_enum_2,
+        ]
+        collection_1_endpoint_1_query_enum_1 = _make_enum()
+        collection_1_endpoint_1_query_enum_2 = _make_enum()
+        collection_1_endpoint_1.query_parameters = [
+            collection_1_endpoint_1_query_enum_1,
+            collection_1_endpoint_1_query_enum_2,
+        ]
+        collection_1_endpoint_2 = mocker.MagicMock()
+        collection_1_endpoint_2_path_enum = _make_enum()
+        collection_1_endpoint_2.path_parameters = [collection_1_endpoint_2_path_enum]
+        collection_1_endpoint_2_query_enum = _make_enum()
+        collection_1_endpoint_2.query_parameters = [collection_1_endpoint_2_query_enum]
+        collection_1.endpoints = [collection_1_endpoint_1, collection_1_endpoint_2]
+
+        collection_2 = mocker.MagicMock()
+        collection_2_endpoint = mocker.MagicMock()
+        collection_2_path_enum = _make_enum()
+        collection_2_endpoint.path_parameters = [collection_2_path_enum]
+        collection_2_query_enum = _make_enum()
+        collection_2_endpoint.query_parameters = [collection_2_query_enum]
+        collection_2.endpoints = [collection_2_endpoint]
+        collections = [collection_1, collection_2]
+
+        enums = {
+            schema_1_req_enum_1.reference.class_name: schema_1_req_enum_1,
+            schema_1_req_enum_2.reference.class_name: schema_1_req_enum_2,
+            schema_1_opt_enum_1.reference.class_name: schema_1_opt_enum_1,
+            schema_1_opt_enum_2.reference.class_name: schema_1_opt_enum_2,
+            schema_2_req_enum.reference.class_name: schema_2_req_enum,
+            schema_2_opt_enum.reference.class_name: schema_2_opt_enum,
+            collection_1_endpoint_1_path_enum_1.reference.class_name: collection_1_endpoint_1_path_enum_1,
+            collection_1_endpoint_1_path_enum_2.reference.class_name: collection_1_endpoint_1_path_enum_2,
+            collection_1_endpoint_1_query_enum_1.reference.class_name: collection_1_endpoint_1_query_enum_1,
+            collection_1_endpoint_1_query_enum_2.reference.class_name: collection_1_endpoint_1_query_enum_2,
+            collection_1_endpoint_2_path_enum.reference.class_name: collection_1_endpoint_2_path_enum,
+            collection_1_endpoint_2_query_enum.reference.class_name: collection_1_endpoint_2_query_enum,
+            collection_2_path_enum.reference.class_name: collection_2_path_enum,
+            collection_2_query_enum.reference.class_name: collection_2_query_enum,
+        }
+
+        result = OpenAPI._check_enums(schemas=schemas, collections=collections)
+
+        assert result == enums
+
+    def test__check_enums_bad_duplicate(self, mocker):
+        from dataclasses import replace
+        from openapi_python_client.openapi_parser.properties import EnumProperty
+        from openapi_python_client.openapi_parser.openapi import OpenAPI
+
+        schema = mocker.MagicMock()
+
+        enum_1 = EnumProperty(name=mocker.MagicMock(), required=True, default=None, values=mocker.MagicMock(),)
+        enum_2 = replace(enum_1, values=mocker.MagicMock())
+        schema.required_properties = [enum_1, enum_2]
+
+        with pytest.raises(AssertionError):
+            OpenAPI._check_enums([schema], [])