@typespec/http-client-python 0.9.1 → 0.9.2

package/generator/test/unittests/test_parameter_ordering.py

@@ -0,0 +1,104 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+from pygen.codegen.models import Parameter, AnyType, CodeModel, StringType
+from pygen.codegen.models.parameter_list import ParameterList
+
+
+def get_code_model():
+    return CodeModel(
+        {
+            "clients": [
+                {
+                    "name": "client",
+                    "namespace": "blah",
+                    "moduleName": "blah",
+                    "parameters": [],
+                    "url": "",
+                    "operationGroups": [],
+                }
+            ],
+            "namespace": "namespace",
+        },
+        options={
+            "show_send_request": True,
+            "builders_visibility": "public",
+            "show_operations": True,
+            "models_mode": "dpg",
+            "only_path_and_body_params_positional": True,
+        },
+    )
+
+
+def get_parameter(name, required, default_value=None, type=None):
+    if not type:
+        type = AnyType(
+            yaml_data={"type": "any"},
+            code_model=get_code_model(),
+        )
+
+    return Parameter(
+        yaml_data={
+            "wireName": name,
+            "clientName": name,
+            "location": "path",
+            "clientDefaultValue": default_value,
+            "optional": not required,
+            "implementation": "Method",
+            "inOverload": False,
+            "inOverloaded": False,
+        },
+        code_model=get_code_model(),
+        type=type,
+    )
+
+
+def test_sort_parameters_with_default_value_from_schema():
+    type = StringType(
+        yaml_data={"clientDefaultValue": "this_is_the_default", "type": "str"},
+        code_model=get_code_model(),
+    )
+    parameter_with_default_schema_value_required = get_parameter(
+        name="required_param_with_schema_default", required=True, type=type
+    )
+    required_parameter = get_parameter(name="required_parameter", required=True)
+
+    parameter_list = [parameter_with_default_schema_value_required, required_parameter]
+
+    assert [
+        required_parameter,
+        parameter_with_default_schema_value_required,
+    ] == ParameterList({}, get_code_model(), parameter_list).method
+
+
+def test_sort_required_parameters():
+    required_default_value_parameter = get_parameter(
+        name="required_default_value_parameter", required=True, default_value="hello"
+    )
+    required_parameter = get_parameter(name="required_parameter", required=True)
+
+    parameter_list = [required_parameter, required_default_value_parameter]
+
+    assert [required_parameter, required_default_value_parameter] == ParameterList(
+        {}, get_code_model(), parameter_list
+    ).method
+
+    # switch around ordering to confirm
+
+    parameter_list = [required_default_value_parameter, required_parameter]
+
+    assert [required_parameter, required_default_value_parameter] == ParameterList(
+        {}, get_code_model(), parameter_list
+    ).method
+
+
+def test_sort_required_and_non_required_parameters():
+    required_parameter = get_parameter(name="required_parameter", required=True)
+
+    optional_parameter = get_parameter(name="optional_parameter", required=False)
+
+    parameter_list = [optional_parameter, required_parameter]
+
+    assert [required_parameter, optional_parameter] == ParameterList({}, get_code_model(), parameter_list).method

package/generator/test/unittests/test_sort_schema.py

@@ -0,0 +1,93 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
+from pygen.codegen.models import CodeModel, DPGModelType
+
+
+def get_code_model():
+    return CodeModel(
+        {
+            "clients": [
+                {
+                    "name": "client",
+                    "namespace": "blah",
+                    "moduleName": "blah",
+                    "parameters": [],
+                    "url": "",
+                    "operationGroups": [],
+                }
+            ],
+            "namespace": "namespace",
+        },
+        options={
+            "show_send_request": True,
+            "builders_visibility": "public",
+            "show_operations": True,
+            "models_mode": "dpg",
+        },
+    )
+
+
+def get_object_schema(name, base_models):
+    return DPGModelType(
+        yaml_data={"name": name, "type": "model", "snakeCaseName": name},
+        code_model=get_code_model(),
+        parents=base_models,
+    )
+
+
+def test_pet_cat_kitten_horse_wood():
+    """Horse -> Pet <- Cat <- Kitten, Wood"""
+    code_model = get_code_model()
+    pet = get_object_schema("Pet", None)
+    horse = get_object_schema("Horse", [pet])
+    cat = get_object_schema("Cat", [pet])
+    kitten = get_object_schema("Kitten", [cat])
+    wood = get_object_schema("Wood", None)
+    code_model.model_types = [wood, horse, cat, pet, kitten]
+    code_model.sort_model_types()
+    sorted_model_types = code_model.model_types
+    # assert pet is before cat
+    assert sorted_model_types.index(pet) < sorted_model_types.index(cat)
+    # assert pet is before horse
+    assert sorted_model_types.index(pet) < sorted_model_types.index(horse)
+    # assert cat is before kitten
+    assert sorted_model_types.index(cat) < sorted_model_types.index(kitten)
+    # assert wood in list
+    assert wood in sorted_model_types
+
+
+def test_multiple_inheritance():
+    """CarbonObject <- Person <- Teacher -> Employee, Person <- Kid
+    |
+    ObjectOnEarth
+    """
+    code_model = get_code_model()
+    carbon_object = get_object_schema("CarbonObject", [])
+    object_on_earth = get_object_schema("ObjectOnEarth", [])
+    person = get_object_schema("Person", [carbon_object, object_on_earth])
+    employee = get_object_schema("Employee", [])
+    teacher = get_object_schema("Teacher", [person, employee])
+    kid = get_object_schema("Kid", [person])
+
+    code_model.model_types = [
+        kid,
+        person,
+        teacher,
+        carbon_object,
+        employee,
+        object_on_earth,
+    ]
+    code_model.sort_model_types()
+    sorted_model_types = code_model.model_types
+    # assert carbon object and object on earth is in front of person
+    assert sorted_model_types.index(carbon_object) < sorted_model_types.index(person)
+    assert sorted_model_types.index(object_on_earth) < sorted_model_types.index(person)
+    # assert person and employee are in front of teacher
+    assert sorted_model_types.index(person) < sorted_model_types.index(teacher)
+    assert sorted_model_types.index(employee) < sorted_model_types.index(teacher)
+    # assert person is before kid
+    assert sorted_model_types.index(person) < sorted_model_types.index(kid)

package/generator/test/unittests/tox.ini

@@ -0,0 +1,5 @@
+[testenv:ci]
+deps=
+    -r requirements.txt
+commands =
+    pytest

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/http-client-python",
-  "version": "0.9.1",
+  "version": "0.9.2",
   "author": "Microsoft Corporation",
   "description": "TypeSpec emitter for Python SDKs",
   "homepage": "https://typespec.io",