@typespec/http-client-python 0.1.0

package/generator/test/generic_mock_api_tests/conftest.py

@@ -0,0 +1,113 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import os
+import subprocess
+import signal
+import pytest
+import importlib
+from pathlib import Path
+from typing import List
+
+FILE_FOLDER = Path(__file__).parent
+
+
+def start_server_process():
+    path = Path(os.path.dirname(__file__)) / Path("../../../node_modules/@azure-tools/cadl-ranch-specs")
+    os.chdir(path.resolve())
+    cmd = "cadl-ranch serve ./http"
+    if os.name == "nt":
+        return subprocess.Popen(cmd, shell=True)
+    return subprocess.Popen(cmd, shell=True, preexec_fn=os.setsid)
+
+
+def terminate_server_process(process):
+    if os.name == "nt":
+        process.kill()
+    else:
+        os.killpg(os.getpgid(process.pid), signal.SIGTERM)  # Send the signal to all the process groups
+
+
+@pytest.fixture(scope="session", autouse=True)
+def testserver():
+    """Start cadl ranch mock api tests"""
+    server = start_server_process()
+    yield
+    terminate_server_process(server)
+
+
+"""
+Use to disambiguate the core library we use
+"""
+
+
+@pytest.fixture
+def core_library():
+    try:
+        return importlib.import_module("azure.core")
+    except ModuleNotFoundError:
+        return importlib.import_module("corehttp")
+
+
+@pytest.fixture
+def key_credential(core_library):
+    try:
+        return core_library.credentials.AzureKeyCredential
+    except AttributeError:
+        return core_library.credentials.ServiceKeyCredential
+
+
+SPECIAL_WORDS = [
+    "and",
+    "as",
+    "assert",
+    "async",
+    "await",
+    "break",
+    "class",
+    "constructor",
+    "continue",
+    "def",
+    "del",
+    "elif",
+    "else",
+    "except",
+    "exec",
+    "finally",
+    "for",
+    "from",
+    "global",
+    "if",
+    "import",
+    "in",
+    "is",
+    "lambda",
+    "not",
+    "or",
+    "pass",
+    "raise",
+    "return",
+    "try",
+    "while",
+    "with",
+    "yield",
+]
+
+
+@pytest.fixture
+def special_words() -> List[str]:
+    return SPECIAL_WORDS
+
+
+@pytest.fixture
+def png_data() -> bytes:
+    with open(str(FILE_FOLDER / "data/image.png"), "rb") as file_in:
+        return file_in.read()
+
+
+@pytest.fixture
+def jpg_data() -> bytes:
+    with open(str(FILE_FOLDER / "data/image.jpg"), "rb") as file_in:
+        return file_in.read()

package/generator/test/generic_mock_api_tests/test_authentication.py

@@ -0,0 +1,113 @@
+# -------------------------------------------------------------------------
+# 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 authentication.apikey import ApiKeyClient
+from authentication.oauth2 import OAuth2Client
+from authentication.union import UnionClient
+from authentication.http.custom import CustomClient
+
+
+# Utilities functions
+
+
+@pytest.fixture
+def api_key_client(key_credential):
+    client = None
+
+    def _build_client(client_type):
+        client = client_type(key_credential("valid-key"))
+        return client
+
+    yield _build_client
+    if client:
+        client.close()
+
+
+@pytest.fixture
+def token_credential(core_library):
+    class FakeCredential:
+        @staticmethod
+        def get_token(*scopes):
+            return core_library.credentials.AccessToken(token="".join(scopes), expires_on=1800)
+
+    return FakeCredential()
+
+
+@pytest.fixture
+def oauth2_client(token_credential):
+    client = None
+
+    def _build_client(client_type):
+        client = client_type(token_credential)
+        return client
+
+    yield _build_client
+    if client:
+        client.close()
+
+
+@pytest.fixture
+def http_custom_client(key_credential):
+    client = None
+
+    def _build_client():
+        client = CustomClient(key_credential("valid-key"))
+        return client
+
+    yield _build_client
+    if client:
+        client.close()
+
+
+# Tests
+
+
+def test_api_key_valid(api_key_client):
+    client = api_key_client(ApiKeyClient)
+    client.valid()
+
+
+def test_api_key_invalid(api_key_client, core_library):
+    client = api_key_client(ApiKeyClient)
+    with pytest.raises(core_library.exceptions.HttpResponseError) as ex:
+        client.invalid()
+    assert ex.value.status_code == 403
+    assert ex.value.reason == "Forbidden"
+
+
+def test_oauth2_valid(oauth2_client):
+    client = oauth2_client(OAuth2Client)
+    client.valid(enforce_https=False)
+
+
+def test_oauth2_invalid(oauth2_client, core_library):
+    client = oauth2_client(OAuth2Client)
+    with pytest.raises(core_library.exceptions.HttpResponseError) as ex:
+        client.invalid(enforce_https=False)
+    assert ex.value.status_code == 403
+
+
+def test_union_keyvalid(api_key_client):
+    client = api_key_client(UnionClient)
+    client.valid_key()
+
+
+def test_union_tokenvalid(oauth2_client):
+    client = oauth2_client(UnionClient)
+    client.valid_token(enforce_https=False)
+
+
+def test_http_custom_valid(http_custom_client):
+    client = http_custom_client()
+    client.valid()
+
+
+def test_http_custom_invalid(http_custom_client, core_library):
+    client = http_custom_client()
+    with pytest.raises(core_library.exceptions.HttpResponseError) as ex:
+        client.invalid()
+    assert ex.value.status_code == 403
+    assert ex.value.reason == "Forbidden"

package/generator/test/generic_mock_api_tests/test_client_naming.py

@@ -0,0 +1,57 @@
+# -------------------------------------------------------------------------
+# 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 client.naming import NamingClient, models
+
+
+@pytest.fixture
+def client():
+    with NamingClient() as client:
+        yield client
+
+
+def test_client(client: NamingClient):
+    client.client(models.ClientNameModel(client_name=True))
+
+
+def test_language(client: NamingClient):
+    client.language(models.LanguageClientNameModel(python_name=True))
+
+
+def test_compatible_with_encoded_name(client: NamingClient):
+    client.compatible_with_encoded_name(models.ClientNameAndJsonEncodedNameModel(client_name=True))
+
+
+def test_operation(client: NamingClient):
+    client.client_name()
+
+
+def test_parameter(client: NamingClient):
+    client.parameter(client_name="true")
+
+
+def test_header_request(client: NamingClient):
+    client.request(client_name="true")
+
+
+def test_header_response(client: NamingClient):
+    assert client.response(cls=lambda x, y, z: z)["default-name"] == "true"
+
+
+def test_model_client(client: NamingClient):
+    client.client_model.client(models.ClientModel(default_name=True))
+
+
+def test_model_language(client: NamingClient):
+    client.client_model.language(models.PythonModel(default_name=True))
+
+
+def test_union_enum_member_name(client: NamingClient):
+    client.union_enum.union_enum_member_name(models.ExtensibleEnum.CLIENT_ENUM_VALUE1)
+
+
+def test_union_enum_name(client: NamingClient):
+    client.union_enum.union_enum_name(models.ClientExtensibleEnum.ENUM_VALUE1)

package/generator/test/generic_mock_api_tests/test_client_structure.py

@@ -0,0 +1,57 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+from client.structure.service.models import ClientType
+from client.structure.service import ServiceClient
+from client.structure.multiclient import ClientAClient, ClientBClient
+from client.structure.renamedoperation import RenamedOperationClient
+from client.structure.twooperationgroup import TwoOperationGroupClient
+
+
+def test_structure_default():
+    client = ServiceClient(endpoint="http://localhost:3000", client=ClientType.DEFAULT)
+    client.one()
+    client.two()
+    client.foo.three()
+    client.foo.four()
+    client.bar.five()
+    client.bar.six()
+    client.baz.foo.seven()
+    client.qux.eight()
+    client.qux.bar.nine()
+
+
+def test_structure_multiclient():
+    client_a = ClientAClient(endpoint="http://localhost:3000", client=ClientType.MULTI_CLIENT)
+    client_a.renamed_one()
+    client_a.renamed_three()
+    client_a.renamed_five()
+
+    client_b = ClientBClient(endpoint="http://localhost:3000", client=ClientType.MULTI_CLIENT)
+    client_b.renamed_two()
+    client_b.renamed_four()
+    client_b.renamed_six()
+
+
+def test_structure_renamed_operation():
+    client = RenamedOperationClient(endpoint="http://localhost:3000", client=ClientType.RENAMED_OPERATION)
+    client.renamed_one()
+    client.renamed_three()
+    client.renamed_five()
+
+    client.group.renamed_two()
+    client.group.renamed_four()
+    client.group.renamed_six()
+
+
+def test_structure_two_operation_group():
+    client = TwoOperationGroupClient(endpoint="http://localhost:3000", client=ClientType.TWO_OPERATION_GROUP)
+    client.group1.one()
+    client.group1.three()
+    client.group1.four()
+
+    client.group2.two()
+    client.group2.five()
+    client.group2.six()

package/generator/test/generic_mock_api_tests/test_encode_bytes.py

@@ -0,0 +1,128 @@
+# -------------------------------------------------------------------------
+# 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 encode.bytes import BytesClient
+from encode.bytes.models import (
+    DefaultBytesProperty,
+    Base64urlBytesProperty,
+    Base64BytesProperty,
+    Base64urlArrayBytesProperty,
+)
+
+FILE_FOLDER = Path(__file__).parent
+
+
+@pytest.fixture
+def client():
+    with BytesClient() as client:
+        yield client
+
+
+def test_query(client: BytesClient):
+    client.query.default(
+        value=bytes("test", "utf-8"),
+    )
+    client.query.base64(
+        value=bytes("test", "utf-8"),
+    )
+    client.query.base64_url(
+        value=bytes("test", "utf-8"),
+    )
+    client.query.base64_url_array(
+        value=[
+            bytes("test", "utf-8"),
+            bytes("test", "utf-8"),
+        ],
+    )
+
+
+def test_property(client: BytesClient):
+    result = client.property.default(
+        DefaultBytesProperty(
+            value=bytes("test", "utf-8"),
+        )
+    )
+    assert result.value == bytes("test", "utf-8")
+
+    result = client.property.base64(
+        Base64BytesProperty(
+            value=bytes("test", "utf-8"),
+        )
+    )
+    assert result.value == bytes("test", "utf-8")
+
+    result = client.property.base64_url(
+        Base64urlBytesProperty(
+            value=bytes("test", "utf-8"),
+        )
+    )
+    assert result.value == bytes("test", "utf-8")
+
+    result = client.property.base64_url_array(
+        Base64urlArrayBytesProperty(
+            value=[
+                bytes("test", "utf-8"),
+                bytes("test", "utf-8"),
+            ],
+        )
+    )
+    assert result.value == [
+        bytes("test", "utf-8"),
+        bytes("test", "utf-8"),
+    ]
+
+
+def test_header(client: BytesClient):
+    client.header.default(
+        value=bytes("test", "utf-8"),
+    )
+    client.header.base64(
+        value=bytes("test", "utf-8"),
+    )
+    client.header.base64_url(
+        value=bytes("test", "utf-8"),
+    )
+    client.header.base64_url_array(
+        value=[
+            bytes("test", "utf-8"),
+            bytes("test", "utf-8"),
+        ],
+    )
+
+
+@pytest.fixture
+def png_data() -> bytes:
+    with open(str(FILE_FOLDER / "data/image.png"), "rb") as file_in:
+        return file_in.read()
+
+
+def test_request_body(client: BytesClient, png_data: bytes):
+    client.request_body.default(
+        value=bytes("test", "utf-8"),
+    )
+    client.request_body.octet_stream(
+        value=png_data,
+    )
+    client.request_body.custom_content_type(
+        value=png_data,
+    )
+    client.request_body.base64(
+        value=bytes("test", "utf-8"),
+    )
+    client.request_body.base64_url(
+        value=bytes("test", "utf-8"),
+    )
+
+
+def test_response_body(client: BytesClient, png_data: bytes):
+    expected = b"test"
+    assert expected == client.response_body.default()
+    assert expected == client.response_body.base64()
+    assert expected == client.response_body.base64_url()
+    assert b"".join(client.response_body.octet_stream()) == png_data
+    assert b"".join(client.response_body.custom_content_type()) == png_data

package/generator/test/generic_mock_api_tests/test_encode_datetime.py

@@ -0,0 +1,123 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import datetime
+
+import pytest
+from encode.datetime import DatetimeClient
+from encode.datetime.models import (
+    DefaultDatetimeProperty,
+    Rfc3339DatetimeProperty,
+    Rfc7231DatetimeProperty,
+    UnixTimestampDatetimeProperty,
+    UnixTimestampArrayDatetimeProperty,
+)
+
+
+@pytest.fixture
+def client():
+    with DatetimeClient() as client:
+        yield client
+
+
+def test_query(client: DatetimeClient):
+    client.query.default(
+        value=datetime.datetime(2022, 8, 26, 18, 38, 0, tzinfo=datetime.timezone.utc),
+    )
+    client.query.rfc3339(
+        value=datetime.datetime(2022, 8, 26, 18, 38, 0, tzinfo=datetime.timezone.utc),
+    )
+    client.query.rfc7231(
+        value=datetime.datetime(2022, 8, 26, 14, 38, 0, tzinfo=datetime.timezone.utc),
+    )
+    client.query.unix_timestamp(
+        value=datetime.datetime(2023, 6, 12, 10, 47, 44, tzinfo=datetime.timezone.utc),
+    )
+    client.query.unix_timestamp_array(
+        value=[
+            datetime.datetime(2023, 6, 12, 10, 47, 44, tzinfo=datetime.timezone.utc),
+            datetime.datetime(2023, 6, 14, 9, 17, 36, tzinfo=datetime.timezone.utc),
+        ],
+    )
+
+
+def test_property(client: DatetimeClient):
+    result = client.property.default(
+        DefaultDatetimeProperty(
+            value=datetime.datetime(2022, 8, 26, 18, 38, 0, tzinfo=datetime.timezone.utc),
+        )
+    )
+    assert result.value == datetime.datetime(2022, 8, 26, 18, 38, 0, tzinfo=datetime.timezone.utc)
+
+    result = client.property.rfc3339(
+        Rfc3339DatetimeProperty(
+            value=datetime.datetime(2022, 8, 26, 18, 38, 0, tzinfo=datetime.timezone.utc),
+        )
+    )
+    assert result.value == datetime.datetime(2022, 8, 26, 18, 38, 0, tzinfo=datetime.timezone.utc)
+
+    result = client.property.rfc7231(
+        Rfc7231DatetimeProperty(
+            value=datetime.datetime(2022, 8, 26, 14, 38, 0, tzinfo=datetime.timezone.utc),
+        )
+    )
+    assert result.value == datetime.datetime(2022, 8, 26, 14, 38, 0, tzinfo=datetime.timezone.utc)
+
+    result = client.property.unix_timestamp(
+        UnixTimestampDatetimeProperty(
+            value=datetime.datetime(2023, 6, 12, 10, 47, 44, tzinfo=datetime.timezone.utc),
+        )
+    )
+    assert result.value == datetime.datetime(2023, 6, 12, 10, 47, 44, tzinfo=datetime.timezone.utc)
+
+    result = client.property.unix_timestamp_array(
+        UnixTimestampArrayDatetimeProperty(
+            value=[
+                datetime.datetime(2023, 6, 12, 10, 47, 44, tzinfo=datetime.timezone.utc),
+                datetime.datetime(2023, 6, 14, 9, 17, 36, tzinfo=datetime.timezone.utc),
+            ],
+        )
+    )
+    assert result.value == [
+        datetime.datetime(2023, 6, 12, 10, 47, 44, tzinfo=datetime.timezone.utc),
+        datetime.datetime(2023, 6, 14, 9, 17, 36, tzinfo=datetime.timezone.utc),
+    ]
+
+
+def test_header(client: DatetimeClient):
+    client.header.default(
+        value=datetime.datetime(2022, 8, 26, 14, 38, 0, tzinfo=datetime.timezone.utc),
+    )
+    client.header.rfc3339(
+        value=datetime.datetime(2022, 8, 26, 18, 38, 0, tzinfo=datetime.timezone.utc),
+    )
+    client.header.rfc7231(
+        value=datetime.datetime(2022, 8, 26, 14, 38, 0, tzinfo=datetime.timezone.utc),
+    )
+    client.header.unix_timestamp(
+        value=datetime.datetime(2023, 6, 12, 10, 47, 44, tzinfo=datetime.timezone.utc),
+    )
+    client.header.unix_timestamp_array(
+        value=[
+            datetime.datetime(2023, 6, 12, 10, 47, 44, tzinfo=datetime.timezone.utc),
+            datetime.datetime(2023, 6, 14, 9, 17, 36, tzinfo=datetime.timezone.utc),
+        ]
+    )
+
+
+def test_response_header(client: DatetimeClient):
+    cls = lambda x, y, z: z
+    assert client.response_header.default(cls=cls)["value"] == datetime.datetime(
+        2022, 8, 26, 14, 38, 0, tzinfo=datetime.timezone.utc
+    )
+    assert client.response_header.rfc3339(cls=cls)["value"] == datetime.datetime(
+        2022, 8, 26, 18, 38, 0, tzinfo=datetime.timezone.utc
+    )
+    assert client.response_header.rfc7231(cls=cls)["value"] == datetime.datetime(
+        2022, 8, 26, 14, 38, 0, tzinfo=datetime.timezone.utc
+    )
+    assert client.response_header.unix_timestamp(cls=cls)["value"] == datetime.datetime(
+        2023, 6, 12, 10, 47, 44, tzinfo=datetime.timezone.utc
+    )

package/generator/test/generic_mock_api_tests/test_encode_duration.py

@@ -0,0 +1,60 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import datetime
+
+import pytest
+from encode.duration import DurationClient
+from encode.duration.models import (
+    Int32SecondsDurationProperty,
+    ISO8601DurationProperty,
+    FloatSecondsDurationProperty,
+    DefaultDurationProperty,
+    FloatSecondsDurationArrayProperty,
+)
+
+
+@pytest.fixture
+def client():
+    with DurationClient() as client:
+        yield client
+
+
+def test_query(client: DurationClient):
+    client.query.default(input=datetime.timedelta(days=40))
+    client.query.iso8601(input=datetime.timedelta(days=40))
+    client.query.int32_seconds(input=36)
+    client.query.int32_seconds_array(input=[36, 47])
+    client.query.float_seconds(input=35.625)
+    client.query.float64_seconds(input=35.625)
+
+
+def test_property(client: DurationClient):
+    result = client.property.default(DefaultDurationProperty(value=datetime.timedelta(days=40)))
+    assert result.value == datetime.timedelta(days=40)
+    result = client.property.default(DefaultDurationProperty(value="P40D"))
+    assert result.value == datetime.timedelta(days=40)
+    result = client.property.iso8601(ISO8601DurationProperty(value=datetime.timedelta(days=40)))
+    assert result.value == datetime.timedelta(days=40)
+    result = client.property.iso8601(ISO8601DurationProperty(value="P40D"))
+    assert result.value == datetime.timedelta(days=40)
+    result = client.property.int32_seconds(Int32SecondsDurationProperty(value=36))
+    assert result.value == 36
+    result = client.property.float_seconds(FloatSecondsDurationProperty(value=35.625))
+    assert abs(result.value - 35.625) < 0.0001
+    result = client.property.float64_seconds(FloatSecondsDurationProperty(value=35.625))
+    assert abs(result.value - 35.625) < 0.0001
+    result = client.property.float_seconds_array(FloatSecondsDurationArrayProperty(value=[35.625, 46.75]))
+    assert abs(result.value[0] - 35.625) < 0.0001
+    assert abs(result.value[1] - 46.75) < 0.0001
+
+
+def test_header(client: DurationClient):
+    client.header.default(duration=datetime.timedelta(days=40))
+    client.header.iso8601(duration=datetime.timedelta(days=40))
+    client.header.iso8601_array(duration=[datetime.timedelta(days=40), datetime.timedelta(days=50)])
+    client.header.int32_seconds(duration=36)
+    client.header.float_seconds(duration=35.625)
+    client.header.float64_seconds(duration=35.625)

package/generator/test/generic_mock_api_tests/test_encode_numeric.py

@@ -0,0 +1,31 @@
+# -------------------------------------------------------------------------
+# 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 encode.numeric import NumericClient, models
+
+
+@pytest.fixture
+def client():
+    with NumericClient() as client:
+        yield client
+
+
+def test_safeint_as_string(client: NumericClient):
+    result = client.property.safeint_as_string(models.SafeintAsStringProperty(value=10000000000))
+    assert result.value == 10000000000
+    assert result["value"] == "10000000000"
+
+
+def test_uint32_as_string_optional(client: NumericClient):
+    result = client.property.uint32_as_string_optional(models.Uint32AsStringProperty(value=1))
+    assert result.value == 1
+    assert result["value"] == "1"
+
+
+def test_uint8_as_string_optional(client: NumericClient):
+    result = client.property.uint8_as_string(models.Uint32AsStringProperty(value=255))
+    assert result.value == 255
+    assert result["value"] == "255"