@typespec/http-client-python 0.1.0

package/generator/test/generic_mock_api_tests/test_resiliency_srv_driven.py

@@ -0,0 +1,122 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import pytest
+from resiliency.srv.driven1 import ResiliencyServiceDrivenClient as V1Client
+from resiliency.srv.driven2 import ResiliencyServiceDrivenClient as V2Client
+
+
+def get_v1_client(service_deployment_version: str, api_version: str = "v1") -> V1Client:
+    return V1Client(
+        endpoint="http://localhost:3000",
+        service_deployment_version=service_deployment_version,
+        api_version=api_version,
+    )
+
+
+def get_v2_client(service_deployment_version: str, api_version: str = "v2") -> V2Client:
+    return V2Client(
+        endpoint="http://localhost:3000",
+        service_deployment_version=service_deployment_version,
+        api_version=api_version,
+    )
+
+
+def test_add_optional_param_from_none():
+    # old client to old service with api version v1
+    with V1Client(endpoint="http://localhost:3000", service_deployment_version="v1") as client:
+        client.from_none()
+
+    # old client to new service with api version v1
+    with V1Client(endpoint="http://localhost:3000", service_deployment_version="v2") as client:
+        client.from_none()
+
+    # new client to new service with api version v1
+    with V2Client(
+        endpoint="http://localhost:3000",
+        service_deployment_version="v2",
+        api_version="v1",
+    ) as client:
+        client.from_none()
+
+    # new client to new service with api version v2
+    with V2Client(endpoint="http://localhost:3000", service_deployment_version="v2") as client:
+        client.from_none(new_parameter="new")
+
+
+def test_add_optional_param_from_one_required():
+    # old client to old service with api version v1
+    with V1Client(endpoint="http://localhost:3000", service_deployment_version="v1") as client:
+        client.from_one_required(parameter="required")
+
+    # old client to new service with api version v1
+    with V1Client(endpoint="http://localhost:3000", service_deployment_version="v2") as client:
+        client.from_one_required(parameter="required")
+
+    # new client to new service with api version v1
+    with V2Client(
+        endpoint="http://localhost:3000",
+        service_deployment_version="v2",
+        api_version="v1",
+    ) as client:
+        client.from_one_required(parameter="required")
+
+    # new client to new service with api version v2
+    with V2Client(endpoint="http://localhost:3000", service_deployment_version="v2") as client:
+        client.from_one_required(parameter="required", new_parameter="new")
+
+
+def test_add_optional_param_from_one_optional():
+    # old client to old service with api version v1
+    with V1Client(endpoint="http://localhost:3000", service_deployment_version="v1") as client:
+        client.from_one_optional(parameter="optional")
+
+    # old client to new service with api version v1
+    with V1Client(endpoint="http://localhost:3000", service_deployment_version="v2") as client:
+        client.from_one_optional(parameter="optional")
+
+    # new client to new service with api version v1
+    with V2Client(
+        endpoint="http://localhost:3000",
+        service_deployment_version="v2",
+        api_version="v1",
+    ) as client:
+        client.from_one_optional(parameter="optional")
+
+    # new client to new service with api version v2
+    with V2Client(endpoint="http://localhost:3000", service_deployment_version="v2") as client:
+        client.from_one_optional(parameter="optional", new_parameter="new")
+
+
+def test_break_the_glass(core_library):
+    request = core_library.rest.HttpRequest(method="DELETE", url="/add-operation")
+    with V1Client(
+        endpoint="http://localhost:3000",
+        service_deployment_version="v2",
+        api_version="v2",
+    ) as client:
+        response = client.send_request(request)
+        response.raise_for_status()
+
+
+def test_add_operation():
+    with V2Client(endpoint="http://localhost:3000", service_deployment_version="v2") as client:
+        client.add_operation()
+
+
+@pytest.mark.parametrize(
+    "func_name, params",
+    [
+        ("from_none", {"new_parameter": "new"}),
+        ("from_one_optional", {"parameter": "optional", "new_parameter": "new"}),
+        ("from_one_required", {"parameter": "required", "new_parameter": "new"}),
+        ("add_operation", {}),
+    ],
+)
+def test_new_client_with_old_apiversion_call_new_parameter(func_name, params):
+    client = get_v2_client(service_deployment_version="v2", api_version="v1")
+    with pytest.raises(ValueError) as ex:
+        getattr(client, func_name)(**params)
+    assert "is not available in API version" in str(ex.value)

package/generator/test/generic_mock_api_tests/test_routes.py

@@ -0,0 +1,285 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import pytest
+from routes import RoutesClient
+
+
+@pytest.fixture
+def client():
+    with RoutesClient() as client:
+        yield client
+
+
+def test_fixed(client: RoutesClient):
+    client.fixed()
+
+
+def test_in_interface_fixed(client: RoutesClient):
+    client.in_interface.fixed()
+
+
+def test_path_parameters_template_only(client: RoutesClient):
+    client.path_parameters.template_only(
+        param="a",
+    )
+
+
+def test_path_parameters_explicit(client: RoutesClient):
+    client.path_parameters.explicit(
+        param="a",
+    )
+
+
+def test_path_parameters_annotation_only(client: RoutesClient):
+    client.path_parameters.annotation_only(
+        param="a",
+    )
+
+
+def test_path_parameters_reserved_expansion_template(client: RoutesClient):
+    client.path_parameters.reserved_expansion.template(
+        param="foo/bar baz",
+    )
+
+
+def test_path_parameters_reserved_expansion_annotation(client: RoutesClient):
+    client.path_parameters.reserved_expansion.annotation(
+        param="foo/bar baz",
+    )
+
+
+# def test_path_parameters_simple_expansion_standard_primitive(client: RoutesClient):
+#     client.path_parameters.simple_expansion.standard.primitive(
+#         param="a",
+#     )
+
+
+# def test_path_parameters_simple_expansion_standard_array(client: RoutesClient):
+#     client.path_parameters.simple_expansion.standard.array(
+#         param=["a", "b"],
+#     )
+
+
+# def test_path_parameters_simple_expansion_standard_record(client: RoutesClient):
+#     client.path_parameters.simple_expansion.standard.record(
+#         param={"a": 1, "b": 2},
+#     )
+
+
+# def test_path_parameters_simple_expansion_explode_primitive(client: RoutesClient):
+#     client.path_parameters.simple_expansion.explode.primitive(
+#         param="a",
+#     )
+
+
+# def test_path_parameters_simple_expansion_explode_array(client: RoutesClient):
+#     client.path_parameters.simple_expansion.explode.array(
+#         param=["a", "b"],
+#     )
+
+
+# def test_path_parameters_simple_expansion_explode_record(client: RoutesClient):
+#     client.path_parameters.simple_expansion.explode.record(
+#         param={"a": 1, "b": 2},
+#     )
+
+
+# def test_path_parameters_path_expansion_standard_primitive(client: RoutesClient):
+#     client.path_parameters.path_expansion.standard.primitive(
+#         param="a",
+#     )
+
+
+# def test_path_parameters_path_expansion_standard_array(client: RoutesClient):
+#     client.path_parameters.path_expansion.standard.array(
+#         param=["a", "b"],
+#     )
+
+
+# def test_path_parameters_path_expansion_standard_record(client: RoutesClient):
+#     client.path_parameters.path_expansion.standard.record(
+#         param={"a": 1, "b": 2},
+#     )
+
+
+# def test_path_parameters_path_expansion_explode_primitive(client: RoutesClient):
+#     client.path_parameters.path_expansion.explode.primitive(
+#         param="a",
+#     )
+
+
+# def test_path_parameters_path_expansion_explode_array(client: RoutesClient):
+#     client.path_parameters.path_expansion.explode.array(
+#         param=["a", "b"],
+#     )
+
+
+# def test_path_parameters_path_expansion_explode_record(client: RoutesClient):
+#     client.path_parameters.path_expansion.explode.record(
+#         param={"a": 1, "b": 2},
+#     )
+
+
+# def test_path_parameters_label_expansion_standard_primitive(client: RoutesClient):
+#     client.path_parameters.label_expansion.standard.primitive(
+#         param="a",
+#     )
+
+
+# def test_path_parameters_label_expansion_standard_array(client: RoutesClient):
+#     client.path_parameters.label_expansion.standard.array(
+#         param=["a", "b"],
+#     )
+
+
+# def test_path_parameters_label_expansion_standard_record(client: RoutesClient):
+#     client.path_parameters.label_expansion.standard.record(
+#         param={"a": 1, "b": 2},
+#     )
+
+
+# def test_path_parameters_label_expansion_explode_primitive(client: RoutesClient):
+#     client.path_parameters.label_expansion.explode.primitive(
+#         param="a",
+#     )
+
+
+# def test_path_parameters_label_expansion_explode_array(client: RoutesClient):
+#     client.path_parameters.label_expansion.explode.array(
+#         param=["a", "b"],
+#     )
+
+
+# def test_path_parameters_label_expansion_explode_record(client: RoutesClient):
+#     client.path_parameters.label_expansion.explode.record(
+#         param={"a": 1, "b": 2},
+#     )
+
+
+# def test_path_parameters_matrix_expansion_standard_primitive(client: RoutesClient):
+#     client.path_parameters.matrix_expansion.standard.primitive(
+#         param="a",
+#     )
+
+
+# def test_path_parameters_matrix_expansion_standard_array(client: RoutesClient):
+#     client.path_parameters.matrix_expansion.standard.array(
+#         param=["a", "b"],
+#     )
+
+
+# def test_path_parameters_matrix_expansion_standard_record(client: RoutesClient):
+#     client.path_parameters.matrix_expansion.standard.record(
+#         param={"a": 1, "b": 2},
+#     )
+
+
+# def test_path_parameters_matrix_expansion_explode_primitive(client: RoutesClient):
+#     client.path_parameters.matrix_expansion.explode.primitive(
+#         param="a",
+#     )
+
+
+# def test_path_parameters_matrix_expansion_explode_array(client: RoutesClient):
+#     client.path_parameters.matrix_expansion.explode.array(
+#         param=["a", "b"],
+#     )
+
+
+# def test_path_parameters_matrix_expansion_explode_record(client: RoutesClient):
+#     client.path_parameters.matrix_expansion.explode.record(
+#         param={"a": 1, "b": 2},
+#     )
+
+
+def test_query_parameters_template_only(client: RoutesClient):
+    client.query_parameters.template_only(
+        param="a",
+    )
+
+
+def test_query_parameters_explicit(client: RoutesClient):
+    client.query_parameters.explicit(
+        param="a",
+    )
+
+
+def test_query_parameters_annotation_only(client: RoutesClient):
+    client.query_parameters.annotation_only(
+        param="a",
+    )
+
+
+def test_query_parameters_query_expansion_standard_primitive(client: RoutesClient):
+    client.query_parameters.query_expansion.standard.primitive(
+        param="a",
+    )
+
+
+# def test_query_parameters_query_expansion_standard_array(client: RoutesClient):
+#     client.query_parameters.query_expansion.standard.array(
+#         param=["a", "b"],
+#     )
+
+
+# def test_query_parameters_query_expansion_standard_record(client: RoutesClient):
+#     client.query_parameters.query_expansion.standard.record(
+#         param={"a": 1, "b": 2},
+#     )
+
+
+def test_query_parameters_query_expansion_explode_primitive(client: RoutesClient):
+    client.query_parameters.query_expansion.explode.primitive(
+        param="a",
+    )
+
+
+# def test_query_parameters_query_expansion_explode_array(client: RoutesClient):
+#     client.query_parameters.query_expansion.explode.array(
+#         param=["a", "b"],
+#     )
+
+
+# def test_query_parameters_query_expansion_explode_record(client: RoutesClient):
+#     client.query_parameters.query_expansion.explode.record(
+#         param={"a": 1, "b": 2},
+#     )
+
+
+def test_query_parameters_query_continuation_standard_primitive(client: RoutesClient):
+    client.query_parameters.query_continuation.standard.primitive(
+        param="a",
+    )
+
+
+# def test_query_parameters_query_continuation_standard_array(client: RoutesClient):
+#     client.query_parameters.query_continuation.standard.array(
+#         param=["a", "b"],
+#     )
+
+
+# def test_query_parameters_query_continuation_standard_record(client: RoutesClient):
+#     client.query_parameters.query_continuation.standard.record(
+#         param={"a": 1, "b": 2},
+#     )
+
+
+def test_query_parameters_query_continuation_explode_primitive(client: RoutesClient):
+    client.query_parameters.query_continuation.explode.primitive(
+        param="a",
+    )
+
+
+# def test_query_parameters_query_continuation_explode_array(client: RoutesClient):
+#     client.query_parameters.query_continuation.explode.array(
+#         param=["a", "b"],
+#     )
+
+
+# def test_query_parameters_query_continuation_explode_record(client: RoutesClient):
+#     client.query_parameters.query_continuation.explode.record(
+#         param={"a": 1, "b": 2},
+#     )

package/generator/test/generic_mock_api_tests/test_serialization_encoded_name_json.py

@@ -0,0 +1,21 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import pytest
+from serialization.encodedname.json import JsonClient, models
+
+
+@pytest.fixture
+def client():
+    with JsonClient() as client:
+        yield client
+
+
+def test_property_send(client: JsonClient):
+    client.property.send(models.JsonEncodedNameModel(default_name=True))
+
+
+def test_property_get(client: JsonClient):
+    assert client.property.get().default_name

package/generator/test/generic_mock_api_tests/test_server_endpoint_not_defined.py

@@ -0,0 +1,17 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import pytest
+from server.endpoint.notdefined import NotDefinedClient
+
+
+@pytest.fixture
+def client():
+    with NotDefinedClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+def test_valid(client: NotDefinedClient):
+    assert client.valid() is True

package/generator/test/generic_mock_api_tests/test_server_path_multiple.py

@@ -0,0 +1,21 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import pytest
+from server.path.multiple import MultipleClient
+
+
+@pytest.fixture
+def client():
+    with MultipleClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+def test_no_operation_params(client: MultipleClient):
+    client.no_operation_params()
+
+
+def test_with_operation_path_param(client: MultipleClient):
+    client.with_operation_path_param(keyword="test")

package/generator/test/generic_mock_api_tests/test_server_path_single.py

@@ -0,0 +1,17 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import pytest
+from server.path.single import SingleClient
+
+
+@pytest.fixture
+def client():
+    with SingleClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+def test_my_op(client):
+    assert client.my_op() is True

package/generator/test/generic_mock_api_tests/test_server_versions_not_versioned.py

@@ -0,0 +1,25 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import pytest
+from server.versions.notversioned import NotVersionedClient
+
+
+@pytest.fixture
+def client():
+    with NotVersionedClient(endpoint="http://localhost:3000", api_version="v1.0") as client:
+        yield client
+
+
+def test_without_api_version(client: NotVersionedClient):
+    client.without_api_version()
+
+
+def test_with_query_api_version(client: NotVersionedClient):
+    client.with_query_api_version()
+
+
+def test_with_path_api_version(client: NotVersionedClient):
+    client.with_path_api_version()

package/generator/test/generic_mock_api_tests/test_server_versions_versioned.py

@@ -0,0 +1,30 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import pytest
+from server.versions.versioned import VersionedClient
+
+
+@pytest.fixture
+def client():
+    with VersionedClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+def test_without_api_version(client: VersionedClient):
+    client.without_api_version()
+
+
+def test_with_query_api_version(client: VersionedClient):
+    client.with_query_api_version()
+
+
+def test_with_path_api_version(client: VersionedClient):
+    client.with_path_api_version()
+
+
+def test_with_query_old_api_version():
+    with VersionedClient(endpoint="http://localhost:3000", api_version="2021-01-01-preview") as client:
+        client.with_query_old_api_version()

package/generator/test/generic_mock_api_tests/test_special_headers_conditional_request.py

@@ -0,0 +1,34 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import pytest
+import datetime
+from specialheaders.conditionalrequest import ConditionalRequestClient
+
+
+@pytest.fixture
+def client():
+    with ConditionalRequestClient() as client:
+        yield client
+
+
+def test_post_if_match(core_library, client: ConditionalRequestClient):
+    client.post_if_match(etag="valid", match_condition=core_library.MatchConditions.IfNotModified)
+
+
+def test_post_if_none_match(core_library, client: ConditionalRequestClient):
+    client.post_if_none_match(etag="invalid", match_condition=core_library.MatchConditions.IfModified)
+
+
+def test_head_if_modified_since(client: ConditionalRequestClient):
+    client.head_if_modified_since(
+        if_modified_since=datetime.datetime(2022, 8, 26, 14, 38, 0, tzinfo=datetime.timezone.utc)
+    )
+
+
+def test_post_if_unmodified_since(client: ConditionalRequestClient):
+    client.post_if_unmodified_since(
+        if_unmodified_since=datetime.datetime(2022, 8, 26, 14, 38, 0, tzinfo=datetime.timezone.utc)
+    )

package/generator/test/generic_mock_api_tests/test_special_headers_repeatability.py

@@ -0,0 +1,18 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import pytest
+from specialheaders.repeatability import RepeatabilityClient
+
+
+@pytest.fixture
+def client():
+    with RepeatabilityClient() as client:
+        yield client
+
+
+def test_immediate_success(client: RepeatabilityClient):
+    cls = lambda x, y, z: z
+    assert client.immediate_success(cls=cls)["Repeatability-Result"] == "accepted"

package/generator/test/generic_mock_api_tests/test_special_words.py

@@ -0,0 +1,37 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import pytest
+from specialwords import SpecialWordsClient, models
+
+
+@pytest.fixture
+def client():
+    with SpecialWordsClient() as client:
+        yield client
+
+
+def test_operations(client: SpecialWordsClient, special_words):
+    for sw in special_words:
+        suffix = "" if sw == "constructor" else "_method"
+        getattr(client.operations, sw + suffix)()
+
+
+def test_parameter(client: SpecialWordsClient, special_words):
+    for sw in special_words:
+        suffix = "" if sw == "constructor" else "_parameter"
+        getattr(client.parameters, "with_" + sw)(**{sw + suffix: "ok"})
+    client.parameters.with_cancellation_token(cancellation_token="ok")
+
+
+def test_model(client: SpecialWordsClient, special_words):
+    for sw in special_words:
+        suffix = "" if sw == "constructor" else "Model"
+        model = getattr(models, sw.capitalize() + suffix)
+        getattr(client.models, "with_" + sw)(model(name="ok"))
+
+
+def test_model_properties(client: SpecialWordsClient):
+    client.model_properties.same_as_model(models.SameAsModel(same_as_model="ok"))