@typespec/http-client-python 0.1.0

package/generator/test/generic_mock_api_tests/test_headasboolean.py

@@ -0,0 +1,33 @@
+# -------------------------------------------------------------------------
+# 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 headasbooleantrue import VisibilityClient as HeadAsBooleanTrueClient
+from headasbooleantrue import models as models_true
+
+from headasbooleanfalse import VisibilityClient as HeadAsBooleanFalseClient
+from headasbooleanfalse import models as models_false
+
+
+@pytest.fixture
+def client_true():
+    with HeadAsBooleanTrueClient() as client:
+        yield client
+
+
+@pytest.fixture
+def client_false():
+    with HeadAsBooleanFalseClient() as client:
+        yield client
+
+
+def test_head_true(client_true):
+    body = models_true.VisibilityModel(query_prop=123)
+    assert client_true.head_model(body) == True
+
+
+def test_head_false(client_false):
+    body = models_false.VisibilityModel(query_prop=123)
+    assert client_false.head_model(body) is None

package/generator/test/generic_mock_api_tests/test_parameters_basic.py

@@ -0,0 +1,22 @@
+# -------------------------------------------------------------------------
+# 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 parameters.basic import BasicClient
+from parameters.basic.models import User
+
+
+@pytest.fixture
+def client():
+    with BasicClient() as client:
+        yield client
+
+
+def test_explicit_simple(client: BasicClient):
+    client.explicit_body.simple(User(name="foo"))
+
+
+def test_implicit_simple(client: BasicClient):
+    client.implicit_body.simple(name="foo")

package/generator/test/generic_mock_api_tests/test_parameters_body_optionality.py

@@ -0,0 +1,27 @@
+# -------------------------------------------------------------------------
+# 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 parameters.bodyoptionality import BodyOptionalityClient
+from parameters.bodyoptionality.models import BodyModel
+
+
+@pytest.fixture
+def client():
+    with BodyOptionalityClient() as client:
+        yield client
+
+
+def test_required_explicit(client: BodyOptionalityClient):
+    client.required_explicit(BodyModel(name="foo"))
+
+
+def test_required_implicit(client: BodyOptionalityClient):
+    client.required_implicit(name="foo")
+
+
+def test_optional_explicit(client: BodyOptionalityClient):
+    client.optional_explicit.set(BodyModel(name="foo"))
+    client.optional_explicit.omit()

package/generator/test/generic_mock_api_tests/test_parameters_collection_format.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 parameters.collectionformat import CollectionFormatClient
+
+
+@pytest.fixture
+def client():
+    with CollectionFormatClient() as client:
+        yield client
+
+
+def test_query_multi(client: CollectionFormatClient):
+    client.query.multi(colors=["blue", "red", "green"])
+
+
+def test_query_csv(client: CollectionFormatClient):
+    client.query.csv(colors=["blue", "red", "green"])
+
+
+def test_query_pipes(client: CollectionFormatClient):
+    client.query.pipes(colors=["blue", "red", "green"])
+
+
+def test_query_ssv(client: CollectionFormatClient):
+    client.query.ssv(colors=["blue", "red", "green"])
+
+
+def test_query_tsv(client: CollectionFormatClient):
+    client.query.tsv(colors=["blue", "red", "green"])
+
+
+def test_csv_header(client: CollectionFormatClient):
+    client.header.csv(colors=["blue", "red", "green"])

package/generator/test/generic_mock_api_tests/test_parameters_spread.py

@@ -0,0 +1,66 @@
+# -------------------------------------------------------------------------
+# 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 parameters.spread import SpreadClient
+from parameters.spread.models import BodyParameter
+
+
+@pytest.fixture
+def client():
+    with SpreadClient() as client:
+        yield client
+
+
+def test_model_body(client: SpreadClient):
+    client.model.spread_as_request_body(name="foo")
+
+
+def test_model_composite_request_only_with_body(client: SpreadClient):
+    client.model.spread_composite_request_only_with_body(BodyParameter(name="foo"))
+
+
+def test_model_composite_request_without_body(client: SpreadClient):
+    client.model.spread_composite_request_without_body(name="foo", test_header="bar")
+
+
+def test_model_composite_request(client: SpreadClient):
+    client.model.spread_composite_request(name="foo", body=BodyParameter(name="foo"), test_header="bar")
+
+
+def test_model_composite_request_mix(client: SpreadClient):
+    client.model.spread_composite_request_mix(name="foo", prop="foo", test_header="bar")
+
+
+def test_alias_body(client: SpreadClient):
+    client.alias.spread_as_request_body(name="foo")
+
+
+def test_alias_parameter(client: SpreadClient):
+    client.alias.spread_as_request_parameter("1", x_ms_test_header="bar", name="foo")
+
+
+def test_alias_multiple_parameter(client: SpreadClient):
+    client.alias.spread_with_multiple_parameters(
+        "1",
+        x_ms_test_header="bar",
+        required_string="foo",
+        required_int_list=[1, 2],
+        optional_string_list=["foo", "bar"],
+        optional_int=1,
+    )
+    client.alias.spread_with_multiple_parameters(
+        "1",
+        {"requiredString": "foo", "optionalInt": 1, "requiredIntList": [1, 2], "optionalStringList": ["foo", "bar"]},
+        x_ms_test_header="bar",
+    )
+
+
+def test_inner_model(client: SpreadClient):
+    client.alias.spread_parameter_with_inner_model(id="1", x_ms_test_header="bar", body={"name": "foo"})
+
+
+def test_inner_alias(client: SpreadClient):
+    client.alias.spread_parameter_with_inner_alias(id="1", x_ms_test_header="bar", body={"name": "foo", "age": 1})

package/generator/test/generic_mock_api_tests/test_payload_content_negotiation.py

@@ -0,0 +1,33 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import base64
+import pytest
+from payload.contentnegotiation import ContentNegotiationClient
+from payload.contentnegotiation.models import PngImageAsJson
+
+
+@pytest.fixture
+def client():
+    with ContentNegotiationClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+def test_get_avatar_as_png(client: ContentNegotiationClient, png_data: bytes):
+    assert b"".join(client.same_body.get_avatar_as_png()) == png_data
+
+
+def test_get_avatar_as_jpeg(client: ContentNegotiationClient, jpg_data: bytes):
+    assert b"".join(client.same_body.get_avatar_as_jpeg()) == jpg_data
+
+
+def test_different_body_get_avatar_as_png(client: ContentNegotiationClient, png_data: bytes):
+    assert b"".join(client.different_body.get_avatar_as_png()) == png_data
+
+
+def test_different_body_get_avatar_as_json(client: ContentNegotiationClient, png_data: bytes):
+    result = client.different_body.get_avatar_as_json()
+    expected = PngImageAsJson(content=base64.b64encode(png_data).decode())
+    assert result == expected

package/generator/test/generic_mock_api_tests/test_payload_json_merge_patch.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.
+# --------------------------------------------------------------------------
+import pytest
+from payload.jsonmergepatch import JsonMergePatchClient
+from payload.jsonmergepatch.models import InnerModel, Resource, ResourcePatch
+
+try:
+    from azure.core.serialization import NULL
+except ImportError:
+    from corehttp.serialization import NULL
+
+
+@pytest.fixture
+def client():
+    with JsonMergePatchClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+def test_create_resource(client: JsonMergePatchClient):
+    inner_madge = InnerModel(name="InnerMadge", description="innerDesc")
+    create_resource = Resource(
+        name="Madge",
+        description="desc",
+        map={"key": inner_madge},
+        array=[inner_madge],
+        int_value=1,
+        float_value=1.1,
+        inner_model=inner_madge,
+        int_array=[1, 2, 3],
+    )
+    response = client.create_resource(create_resource)
+    assert response == create_resource
+
+
+def test_update_resource_model_input(client: JsonMergePatchClient):
+    update_resource = ResourcePatch(
+        description=NULL,
+        map={"key": InnerModel(description=NULL), "key2": NULL},
+        array=NULL,
+        int_value=NULL,
+        float_value=NULL,
+        inner_model=NULL,
+        int_array=NULL,
+    )
+    response = client.update_resource(update_resource)
+    assert response == Resource(name="Madge", map={"key": InnerModel(name="InnerMadge")})
+
+
+def test_update_resource_raw_input(client: JsonMergePatchClient):
+    response = client.update_resource(
+        {
+            "description": None,
+            "map": {"key": {"description": None}, "key2": None},
+            "array": None,
+            "intValue": None,
+            "floatValue": None,
+            "innerModel": None,
+            "intArray": None,
+        }
+    )
+    assert response == Resource(name="Madge", map={"key": InnerModel(name="InnerMadge")})
+
+
+def test_update_optional_resource_model_input(client: JsonMergePatchClient):
+    update_resource = ResourcePatch(
+        description=NULL,
+        map={"key": InnerModel(description=NULL), "key2": NULL},
+        array=NULL,
+        int_value=NULL,
+        float_value=NULL,
+        inner_model=NULL,
+        int_array=NULL,
+    )
+    response = client.update_optional_resource(update_resource)
+    assert response == Resource(name="Madge", map={"key": InnerModel(name="InnerMadge")})
+
+
+def test_update_optional_resource_raw_input(client: JsonMergePatchClient):
+    response = client.update_optional_resource(
+        {
+            "description": None,
+            "map": {"key": {"description": None}, "key2": None},
+            "array": None,
+            "intValue": None,
+            "floatValue": None,
+            "innerModel": None,
+            "intArray": None,
+        }
+    )
+    assert response == Resource(name="Madge", map={"key": InnerModel(name="InnerMadge")})

package/generator/test/generic_mock_api_tests/test_payload_media_type.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 payload.mediatype import MediaTypeClient
+
+
+@pytest.fixture
+def client():
+    with MediaTypeClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+def test_json(client: MediaTypeClient):
+    data = "foo"
+    client.string_body.send_as_json(data)
+    assert client.string_body.get_as_json() == data
+
+
+def test_text(client: MediaTypeClient):
+    data = "{cat}"
+    client.string_body.send_as_text(data)
+    assert client.string_body.get_as_text() == data

package/generator/test/generic_mock_api_tests/test_payload_multipart.py

@@ -0,0 +1,140 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+from pathlib import Path
+import pytest
+from payload.multipart import MultiPartClient, models
+
+JPG = Path(__file__).parent / "data/image.jpg"
+PNG = Path(__file__).parent / "data/image.png"
+
+
+@pytest.fixture
+def client():
+    with MultiPartClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+def test_anonymous_model(client: MultiPartClient):
+    client.form_data.anonymous_model({"profileImage": open(str(JPG), "rb")})
+
+
+def test_basic(client: MultiPartClient):
+    client.form_data.basic(
+        models.MultiPartRequest(
+            id="123",
+            profile_image=open(str(JPG), "rb"),
+        )
+    )
+
+
+def test_binary_array_parts(client: MultiPartClient):
+    client.form_data.binary_array_parts(
+        models.BinaryArrayPartsRequest(
+            id="123",
+            pictures=[
+                open(str(PNG), "rb"),
+                open(str(PNG), "rb"),
+            ],
+        )
+    )
+
+
+def test_check_file_name_and_content_type(client: MultiPartClient):
+    client.form_data.check_file_name_and_content_type(
+        models.MultiPartRequest(
+            id="123",
+            profile_image=("hello.jpg", open(str(JPG), "rb"), "image/jpg"),
+        )
+    )
+
+
+def test_complex(client: MultiPartClient):
+    client.form_data.file_array_and_basic(
+        models.ComplexPartsRequest(
+            id="123",
+            address=models.Address(city="X"),
+            pictures=[
+                open(str(PNG), "rb"),
+                open(str(PNG), "rb"),
+            ],
+            profile_image=open(str(JPG), "rb"),
+        )
+    )
+
+
+def test_json_part(client: MultiPartClient):
+    client.form_data.json_part(
+        models.JsonPartRequest(
+            address=models.Address(city="X"),
+            profile_image=open(str(JPG), "rb"),
+        )
+    )
+
+
+def test_multi_binary_parts(client: MultiPartClient):
+    client.form_data.multi_binary_parts(
+        models.MultiBinaryPartsRequest(
+            profile_image=open(str(JPG), "rb"),
+            picture=open(str(PNG), "rb"),
+        )
+    )
+    client.form_data.multi_binary_parts(
+        models.MultiBinaryPartsRequest(
+            profile_image=open(str(JPG), "rb"),
+        )
+    )
+
+
+def test_file_with_http_part_specific_content_type(client: MultiPartClient):
+    client.form_data.http_parts.content_type.image_jpeg_content_type(
+        models.FileWithHttpPartSpecificContentTypeRequest(
+            profile_image=("hello.jpg", open(str(JPG), "rb"), "image/jpg"),
+        )
+    )
+
+
+def test_file_with_http_part_required_content_type(client: MultiPartClient):
+    client.form_data.http_parts.content_type.required_content_type(
+        models.FileWithHttpPartRequiredContentTypeRequest(
+            profile_image=open(str(JPG), "rb"),
+        )
+    )
+
+
+def test_file_with_http_part_optional_content_type(client: MultiPartClient):
+    # call twice: one with content type, one without
+    client.form_data.http_parts.content_type.optional_content_type(
+        models.FileWithHttpPartOptionalContentTypeRequest(
+            profile_image=("hello.jpg", open(str(JPG), "rb").read()),
+        )
+    )
+    client.form_data.http_parts.content_type.optional_content_type(
+        models.FileWithHttpPartOptionalContentTypeRequest(
+            profile_image=("hello.jpg", open(str(JPG), "rb").read(), "application/octet-stream"),
+        )
+    )
+
+
+def test_complex_with_http_part(client: MultiPartClient):
+    client.form_data.http_parts.json_array_and_file_array(
+        models.ComplexHttpPartsModelRequest(
+            id="123",
+            previous_addresses=[
+                models.Address(city="Y"),
+                models.Address(city="Z"),
+            ],
+            address=models.Address(city="X"),
+            pictures=[
+                open(str(PNG), "rb"),
+                open(str(PNG), "rb"),
+            ],
+            profile_image=open(str(JPG), "rb"),
+        )
+    )
+
+
+def test_http_parts_non_string_float(client: MultiPartClient):
+    client.form_data.http_parts.non_string.float(models.FloatRequest(temperature=0.5))

package/generator/test/generic_mock_api_tests/test_payload_pageable.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 payload.pageable import PageableClient
+
+
+@pytest.fixture
+def client():
+    with PageableClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+def test_list(client: PageableClient):
+    result = list(client.list(maxpagesize=3))
+    assert len(result) == 4

package/generator/test/generic_mock_api_tests/test_payload_xml.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.
+# --------------------------------------------------------------------------
+import pytest
+from payload.xml import XmlClient
+from payload.xml.models import (
+    SimpleModel,
+    ModelWithSimpleArrays,
+    ModelWithArrayOfModel,
+    ModelWithAttributes,
+    ModelWithUnwrappedArray,
+    ModelWithRenamedFields,
+    ModelWithEmptyArray,
+    ModelWithText,
+    ModelWithDictionary,
+    ModelWithEncodedNames,
+)
+
+
+@pytest.fixture
+def client():
+    with XmlClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+def test_simple_model(client: XmlClient):
+    model = SimpleModel(name="foo", age=123)
+    assert client.simple_model_value.get() == model
+    client.simple_model_value.put(model)
+
+
+def test_model_with_simple_arrays(client: XmlClient):
+    model = ModelWithSimpleArrays(colors=["red", "green", "blue"], counts=[1, 2])
+    assert client.model_with_simple_arrays_value.get() == model
+    client.model_with_simple_arrays_value.put(model)
+
+
+def test_model_with_array_of_model(client: XmlClient):
+    model = ModelWithArrayOfModel(
+        items_property=[
+            SimpleModel(name="foo", age=123),
+            SimpleModel(name="bar", age=456),
+        ]
+    )
+    assert client.model_with_array_of_model_value.get() == model
+    client.model_with_array_of_model_value.put(model)
+
+
+def test_model_with_attributes(client: XmlClient):
+    model = ModelWithAttributes(id1=123, id2="foo", enabled=True)
+    assert client.model_with_attributes_value.get() == model
+    client.model_with_attributes_value.put(model)
+
+
+def test_model_with_unwrapped_array(client: XmlClient):
+    model = ModelWithUnwrappedArray(colors=["red", "green", "blue"], counts=[1, 2])
+    assert client.model_with_unwrapped_array_value.get() == model
+    client.model_with_unwrapped_array_value.put(model)
+
+
+def test_model_with_renamed_fields(client: XmlClient):
+    model = ModelWithRenamedFields(
+        input_data=SimpleModel(name="foo", age=123),
+        output_data=SimpleModel(name="bar", age=456),
+    )
+    assert client.model_with_renamed_fields_value.get() == model
+    client.model_with_renamed_fields_value.put(model)
+
+
+def test_model_with_empty_array(client: XmlClient):
+    model = ModelWithEmptyArray(items_property=[])
+    assert client.model_with_empty_array_value.get() == model
+    client.model_with_empty_array_value.put(model)
+
+
+def test_model_with_text(client: XmlClient):
+    model = ModelWithText(language="foo", content="\n  This is some text.\n")
+    assert client.model_with_text_value.get() == model
+    client.model_with_text_value.put(model)
+
+
+def test_model_with_dictionary(client: XmlClient):
+    model = ModelWithDictionary(metadata={"Color": "blue", "Count": "123", "Enabled": "false"})
+    assert client.model_with_dictionary_value.get() == model
+    client.model_with_dictionary_value.put(model)
+
+
+def test_model_with_encoded_names(client: XmlClient):
+    model = ModelWithEncodedNames(model_data=SimpleModel(name="foo", age=123), colors=["red", "green", "blue"])
+    assert client.model_with_encoded_names_value.get() == model
+    client.model_with_encoded_names_value.put(model)