@typespec/http-client-python 0.1.0

package/generator/test/azure/mock_api_tests/test_azure_core_scalar.py

@@ -0,0 +1,35 @@
+# -------------------------------------------------------------------------
+# 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 specs.azure.core.scalar import ScalarClient, models
+
+
+@pytest.fixture
+def client():
+    with ScalarClient() as client:
+        yield client
+
+
+def test_azure_location_scalar_get(client: ScalarClient):
+    result = client.azure_location_scalar.get()
+    assert result == "eastus"
+
+
+def test_azure_location_scalar_put(client: ScalarClient):
+    client.azure_location_scalar.put("eastus")
+
+
+def test_azure_location_scalar_post(client: ScalarClient):
+    result = client.azure_location_scalar.post(models.AzureLocationModel(location="eastus"))
+    assert result == models.AzureLocationModel(location="eastus")
+
+
+def test_azure_location_scalar_header(client: ScalarClient):
+    client.azure_location_scalar.header(region="eastus")
+
+
+def test_azure_location_scalar_query(client: ScalarClient):
+    client.azure_location_scalar.query(region="eastus")

package/generator/test/azure/mock_api_tests/test_azure_core_traits.py

@@ -0,0 +1,85 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import functools
+from datetime import datetime
+
+import pytest
+from azure.core.exceptions import HttpResponseError
+from azure.core import MatchConditions
+from specs.azure.core.traits import TraitsClient
+from specs.azure.core.traits.models import UserActionParam
+
+
+@pytest.fixture
+def client():
+    with TraitsClient() as client:
+        yield client
+
+
+def test_get(client: TraitsClient, check_client_request_id_header):
+    def assert_test_get(**kwargs):
+        checked = {}
+        result, header = client.smoke_test(
+            id=1,
+            foo="123",
+            if_unmodified_since=datetime(year=2022, month=8, day=26, hour=14, minute=38, second=0),
+            if_modified_since=datetime(year=2021, month=8, day=26, hour=14, minute=38, second=0),
+            cls=lambda x, y, z: (y, z),
+            raw_request_hook=functools.partial(
+                check_client_request_id_header, header="x-ms-client-request-id", checked=checked
+            ),
+            **kwargs,
+        )
+        assert result.id == 1
+        assert result.name == "Madge"
+        assert header["ETag"] == "11bdc430-65e8-45ad-81d9-8ffa60d55b59"
+        assert header["bar"] == "456"
+        assert header["x-ms-client-request-id"] == checked["x-ms-client-request-id"]
+
+    assert_test_get(etag="valid", match_condition=MatchConditions.IfNotModified)
+    assert_test_get(etag="invalid", match_condition=MatchConditions.IfModified)
+    with pytest.raises(HttpResponseError):
+        assert_test_get()
+
+
+def test_repeatable_action(client: TraitsClient, check_repeatability_header):
+    result, header = client.repeatable_action(
+        id=1,
+        body=UserActionParam(user_action_value="test"),
+        cls=lambda x, y, z: (y, z),
+        raw_request_hook=check_repeatability_header,
+    )
+    assert result.user_action_result == "test"
+    assert header["Repeatability-Result"] == "accepted"
+
+    result, header = client.repeatable_action(
+        id=1,
+        body=UserActionParam(user_action_value="test"),
+        cls=lambda x, y, z: (y, z),
+        headers={
+            "Repeatability-Request-ID": "5942d803-e3fa-4f96-8f67-607d7bd607f5",
+            "Repeatability-First-Sent": "Sun, 06 Nov 1994 08:49:37 GMT",
+        },
+        raw_request_hook=check_repeatability_header,
+    )
+    assert result.user_action_result == "test"
+    assert header["Repeatability-Result"] == "accepted"
+
+    with pytest.raises(HttpResponseError):
+        client.repeatable_action(
+            id=1,
+            body=UserActionParam(user_action_value="test"),
+            cls=lambda x, y, z: (y, z),
+            headers={"Repeatability-Request-ID": "wrong-id"},
+        )
+
+    with pytest.raises(HttpResponseError):
+        client.repeatable_action(
+            id=1,
+            body=UserActionParam(user_action_value="test"),
+            cls=lambda x, y, z: (y, z),
+            headers={"Repeatability-First-Sent": "wrong-datetime"},
+        )

package/generator/test/azure/mock_api_tests/test_azure_example_basic.py

@@ -0,0 +1,29 @@
+# -------------------------------------------------------------------------
+# 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 specs.azure.example.basic import AzureExampleClient
+from specs.azure.example.basic.models import ActionRequest, Model
+
+
+@pytest.fixture
+def client():
+    with AzureExampleClient() as client:
+        yield client
+
+
+def test_basic_action(client: AzureExampleClient):
+    body = ActionRequest(
+        string_property="text",
+        model_property=Model(int32_property=1, float32_property=1.5, enum_property="EnumValue1"),
+        array_property=["item"],
+        record_property={"record": "value"},
+    )
+    result = client.basic_action(
+        body=body,
+        query_param="query",
+        header_param="header",
+    )
+    assert result.string_property == body.string_property

package/generator/test/azure/mock_api_tests/test_azure_special_headers_client_request_id.py

@@ -0,0 +1,29 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import functools
+
+import pytest
+
+from azure.specialheaders.xmsclientrequestid import XmsClientRequestIdClient
+
+
+@pytest.fixture
+def client():
+    with XmsClientRequestIdClient() as client:
+        yield client
+
+
+def test_get(client: XmsClientRequestIdClient, check_client_request_id_header):
+    checked = {}
+    result, resp = client.get(
+        cls=lambda x, y, z: (y, x),
+        raw_request_hook=functools.partial(
+            check_client_request_id_header, header="x-ms-client-request-id", checked=checked
+        ),
+    )
+    assert result is None
+    assert resp.http_response.headers["x-ms-client-request-id"] == checked["x-ms-client-request-id"]
+    pass

package/generator/test/azure/requirements.txt

@@ -0,0 +1,89 @@
+aiohttp;python_full_version>="3.5.2"
+requests==2.32.2
+pytest
+pytest-asyncio==0.14.0;python_full_version>="3.5.2"
+azure-core==1.30.0
+azure-mgmt-core==1.3.2
+pyright==1.1.379
+pylint==3.2.7
+tox==4.18.1
+mypy==1.10.1
+
+# only for azure
+-e ./generated/azure-client-generator-core-access
+-e ./generated/azure-client-generator-core-usage
+-e ./generated/azure-client-generator-core-flatten-property
+-e ./generated/azure-core-basic
+-e ./generated/azure-core-scalar
+-e ./generated/azurecore-lro-rpc
+-e ./generated/azure-core-lro-standard
+-e ./generated/azure-core-model
+-e ./generated/azure-core-traits
+-e ./generated/azure-core-page
+-e ./generated/azure-special-headers-client-request-id/
+-e ./generated/azure-example-basic
+-e ./generated/azure-resource-manager-models-common-types-managed-identity
+-e ./generated/azure-resource-manager-models-resources
+
+# common test case
+-e ./generated/authentication-api-key
+-e ./generated/authentication-http-custom
+-e ./generated/authentication-oauth2
+-e ./generated/authentication-union
+-e ./generated/client-naming
+-e ./generated/encode-duration
+-e ./generated/encode-numeric
+-e ./generated/parameters-basic
+-e ./generated/parameters-collection-format
+-e ./generated/parameters-spread
+-e ./generated/resiliency-srv-driven1
+-e ./generated/resiliency-srv-driven2
+-e ./generated/serialization-encoded-name-json
+-e ./generated/server-endpoint-not-defined
+-e ./generated/server-path-multiple
+-e ./generated/server-path-single
+-e ./generated/server-versions-versioned
+-e ./generated/server-versions-not-versioned
+-e ./generated/special-words
+-e ./generated/typetest-array
+-e ./generated/typetest-dictionary
+-e ./generated/typetest-enum-extensible
+-e ./generated/typetest-enum-fixed
+-e ./generated/typetest-model-enumdiscriminator
+-e ./generated/typetest-model-nesteddiscriminator
+-e ./generated/typetest-model-notdiscriminated
+-e ./generated/typetest-model-singlediscriminator
+-e ./generated/typetest-model-recursive
+-e ./generated/typetest-model-usage
+-e ./generated/typetest-model-visibility
+-e ./generated/typetest-property-nullable
+-e ./generated/typetest-property-optional
+-e ./generated/typetest-property-valuetypes
+-e ./generated/typetest-property-additionalproperties
+-e ./generated/typetest-scalar
+-e ./generated/typetest-union
+-e ./generated/typetest-model-empty
+-e ./generated/headasbooleantrue
+-e ./generated/headasbooleanfalse
+-e ./generated/parameters-body-optionality
+-e ./generated/special-headers-repeatability
+-e ./generated/special-headers-conditional-request
+-e ./generated/encode-datetime
+-e ./generated/encode-bytes
+-e ./generated/client-structure-default
+-e ./generated/client-structure-multiclient
+-e ./generated/client-structure-renamedoperation
+-e ./generated/client-structure-twooperationgroup
+-e ./generated/payload-content-negotiation
+-e ./generated/payload-json-merge-patch
+-e ./generated/payload-pageable
+-e ./generated/payload-multipart
+-e ./generated/payload-media-type
+-e ./generated/payload-xml
+-e ./generated/routes
+-e ./generated/versioning-added
+-e ./generated/versioning-madeoptional
+-e ./generated/versioning-removed
+-e ./generated/versioning-renamedfrom
+-e ./generated/versioning-returntypechangedfrom
+-e ./generated/versioning-typechangedfrom

package/generator/test/azure/tox.ini

@@ -0,0 +1,56 @@
+[tox]
+envlist=base, lint, mypy, pyright, apiview
+skipsdist=True
+
+[testenv:ci]
+deps=
+    -r requirements.txt
+commands =
+    # pytest
+    pytest mock_api_tests ../generic_mock_api_tests
+
+    # pylint
+    pip install azure-pylint-guidelines-checker==0.4.1 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
+    python ../../../eng/scripts/ci/run_pylint.py -t azure -s "generated" {posargs}
+
+    # mypy
+    python ../../../eng/scripts/ci/run_mypy.py -t azure -s "generated" {posargs}
+
+    # pyright
+    python ../../../eng/scripts/ci/run_pyright.py -t azure -s "generated" {posargs}
+
+    # apiview
+    ; pip install apiview-stub-generator==0.3.12 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
+    ; python ../../../eng/scripts/ci/run_apiview.py -t azure -s "generated" {posargs}
+
+[testenv:test]
+deps=
+    -r requirements.txt
+commands =
+    pytest mock_api_tests ../generic_mock_api_tests
+
+[testenv:lint]
+deps=
+    -r requirements.txt
+commands =
+    pip install azure-pylint-guidelines-checker==0.4.1 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
+    python ../../../eng/scripts/ci/run_pylint.py -t azure -s "generated" {posargs}
+
+[testenv:mypy]
+deps=
+    -r requirements.txt
+commands =
+    python ../../../eng/scripts/ci/run_mypy.py -t azure -s "generated" {posargs}
+
+[testenv:pyright]
+deps=
+    -r requirements.txt
+commands =
+    python ../../../eng/scripts/ci/run_pyright.py -t azure -s "generated" {posargs}
+
+[testenv:apiview]
+deps=
+    -r requirements.txt
+commands =
+    pip install apiview-stub-generator==0.3.12 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
+    python ../../../eng/scripts/ci/run_apiview.py -t azure -s "generated" {posargs}

package/generator/test/generic_mock_api_tests/asynctests/test_authentication_async.py

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

package/generator/test/generic_mock_api_tests/asynctests/test_client_naming_async.py

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

package/generator/test/generic_mock_api_tests/asynctests/test_client_structure_async.py

@@ -0,0 +1,62 @@
+# -------------------------------------------------------------------------
+# 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.structure.service.models import ClientType
+from client.structure.service.aio import ServiceClient
+from client.structure.multiclient.aio import ClientAClient, ClientBClient
+from client.structure.renamedoperation.aio import RenamedOperationClient
+from client.structure.twooperationgroup.aio import TwoOperationGroupClient
+
+
+@pytest.mark.asyncio
+async def test_structure_default():
+    client = ServiceClient(endpoint="http://localhost:3000", client=ClientType.DEFAULT)
+    await client.one()
+    await client.two()
+    await client.foo.three()
+    await client.foo.four()
+    await client.bar.five()
+    await client.bar.six()
+    await client.baz.foo.seven()
+    await client.qux.eight()
+    await client.qux.bar.nine()
+
+
+@pytest.mark.asyncio
+async def test_structure_multiclient():
+    client_a = ClientAClient(endpoint="http://localhost:3000", client=ClientType.MULTI_CLIENT)
+    await client_a.renamed_one()
+    await client_a.renamed_three()
+    await client_a.renamed_five()
+
+    client_b = ClientBClient(endpoint="http://localhost:3000", client=ClientType.MULTI_CLIENT)
+    await client_b.renamed_two()
+    await client_b.renamed_four()
+    await client_b.renamed_six()
+
+
+@pytest.mark.asyncio
+async def test_structure_renamed_operation():
+    client = RenamedOperationClient(endpoint="http://localhost:3000", client=ClientType.RENAMED_OPERATION)
+    await client.renamed_one()
+    await client.renamed_three()
+    await client.renamed_five()
+
+    await client.group.renamed_two()
+    await client.group.renamed_four()
+    await client.group.renamed_six()
+
+
+@pytest.mark.asyncio
+async def test_structure_two_operation_group():
+    client = TwoOperationGroupClient(endpoint="http://localhost:3000", client=ClientType.RENAMED_OPERATION)
+    await client.group1.one()
+    await client.group1.three()
+    await client.group1.four()
+
+    await client.group2.two()
+    await client.group2.five()
+    await client.group2.six()