@typespec/http-client-python 0.1.0

package/generator/test/azure/mock_api_tests/asynctests/test_azure_core_page_async.py

@@ -0,0 +1,58 @@
+# -------------------------------------------------------------------------
+# 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 typing import AsyncIterable
+from specs.azure.core.page import models, aio
+
+VALID_USER = models.User(id=1, name="Madge", etag="11bdc430-65e8-45ad-81d9-8ffa60d55b59")
+
+
+@pytest.fixture
+async def client():
+    async with aio.PageClient() as client:
+        yield client
+
+
+async def _list_with_page_tests(pager: AsyncIterable[models.User]):
+    result = [p async for p in pager]
+    assert len(result) == 1
+    assert result[0].id == 1
+    assert result[0].name == "Madge"
+    assert result[0].etag == "11bdc430-65e8-45ad-81d9-8ffa60d55b59"
+    assert result[0].orders is None
+
+
+@pytest.mark.asyncio
+async def test_list_with_page(client: aio.PageClient):
+    await _list_with_page_tests(client.list_with_page())
+
+
+@pytest.mark.asyncio
+async def test_list_with_custom_page_model(client: aio.PageClient):
+    await _list_with_page_tests(client.list_with_custom_page_model())
+    with pytest.raises(AttributeError):
+        models.CustomPageModel
+
+
+@pytest.mark.asyncio
+async def test_list_with_parameters(client: aio.PageClient):
+    result = [
+        item
+        async for item in client.list_with_parameters(models.ListItemInputBody(input_name="Madge"), another="Second")
+    ]
+    assert len(result) == 1
+    assert result[0] == VALID_USER
+
+
+@pytest.mark.asyncio
+async def test_two_models_as_page_item(client: aio.PageClient):
+    result = [item async for item in client.two_models_as_page_item.list_first_item()]
+    assert len(result) == 1
+    assert result[0].id == 1
+
+    result = [item async for item in client.two_models_as_page_item.list_second_item()]
+    assert len(result) == 1
+    assert result[0].name == "Madge"

package/generator/test/azure/mock_api_tests/asynctests/test_azure_core_scalar_async.py

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

package/generator/test/azure/mock_api_tests/asynctests/test_azure_core_traits_async.py

@@ -0,0 +1,87 @@
+# -------------------------------------------------------------------------
+# 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.aio import TraitsClient
+from specs.azure.core.traits.models import UserActionParam
+
+
+@pytest.fixture
+async def client():
+    async with TraitsClient() as client:
+        yield client
+
+
+@pytest.mark.asyncio
+async def test_get(client: TraitsClient, check_client_request_id_header):
+    async def assert_test_get(**kwargs):
+        checked = {}
+        result, header = await 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"]
+
+    await assert_test_get(etag="valid", match_condition=MatchConditions.IfNotModified)
+    await assert_test_get(etag="invalid", match_condition=MatchConditions.IfModified)
+    with pytest.raises(HttpResponseError):
+        await assert_test_get()
+
+
+@pytest.mark.asyncio
+async def test_repeatable_action(client: TraitsClient, check_repeatability_header):
+    result, header = await 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 = await 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):
+        await 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):
+        await 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/asynctests/test_azure_example_basic_async.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 specs.azure.example.basic.aio import AzureExampleClient
+from specs.azure.example.basic.models import ActionRequest, Model
+
+
+@pytest.fixture
+async def client():
+    async with AzureExampleClient() as client:
+        yield client
+
+
+@pytest.mark.asyncio
+async 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 = await 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/asynctests/test_azure_special_headers_client_request_id_async.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 functools
+
+import pytest
+
+from azure.specialheaders.xmsclientrequestid.aio import XmsClientRequestIdClient
+
+
+@pytest.fixture
+async def client():
+    async with XmsClientRequestIdClient() as client:
+        yield client
+
+
+@pytest.mark.asyncio
+async def test_get(client: XmsClientRequestIdClient, check_client_request_id_header):
+    checked = {}
+    result, resp = await 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/mock_api_tests/conftest.py

@@ -0,0 +1,150 @@
+# -------------------------------------------------------------------------
+# 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 re
+from typing import Literal
+from pathlib import Path
+
+
+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  --coverageFile ./cadl-ranch-coverage-python-standard.json"
+    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)
+
+
+_VALID_UUID = re.compile(r"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$")
+_VALID_RFC7231 = re.compile(
+    r"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s"
+    r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT$"
+)
+
+
+def validate_format(value: str, format: Literal["uuid", "rfc7231"]):
+    if format == "uuid":
+        assert _VALID_UUID.match(value)
+    elif format == "rfc7231":
+        assert _VALID_RFC7231.match(value)
+    else:
+        raise ValueError("Unknown format")
+
+
+@pytest.fixture
+def check_repeatability_header():
+    def func(request):
+        validate_format(request.http_request.headers["Repeatability-Request-ID"], "uuid")
+        validate_format(request.http_request.headers["Repeatability-First-Sent"], "rfc7231")
+
+    return func
+
+
+@pytest.fixture
+def check_client_request_id_header():
+    def func(request, header: str, checked: dict):
+        validate_format(request.http_request.headers[header], "uuid")
+        checked[header] = request.http_request.headers[header]
+
+    return func
+
+
+# ================== after azure-core fix, the following code can be removed (begin) ==================
+import urllib.parse
+from azure.core.rest import HttpRequest
+
+
+def update_api_version_of_status_link(status_link: str):
+    request_params = {}
+    parsed_status_link = urllib.parse.urlparse(status_link)
+    request_params = {
+        key.lower(): [urllib.parse.quote(v) for v in value]
+        for key, value in urllib.parse.parse_qs(parsed_status_link.query).items()
+    }
+    request_params["api-version"] = "2022-12-01-preview"
+    status_link = urllib.parse.urljoin(status_link, parsed_status_link.path)
+    return status_link, request_params
+
+
+@pytest.fixture
+def polling_method():
+    from azure.core.polling.base_polling import LROBasePolling
+
+    class TempLroBasePolling(LROBasePolling):
+
+        def request_status(self, status_link: str):
+            if self._path_format_arguments:
+                status_link = self._client.format_url(status_link, **self._path_format_arguments)
+            status_link, request_params = update_api_version_of_status_link(status_link)
+            if "request_id" not in self._operation_config:
+                self._operation_config["request_id"] = self._get_request_id()
+
+            rest_request = HttpRequest("GET", status_link, params=request_params)
+            return self._client.send_request(rest_request, _return_pipeline_response=True, **self._operation_config)
+
+    return TempLroBasePolling(0)
+
+
+@pytest.fixture
+def async_polling_method():
+    from azure.core.polling.async_base_polling import AsyncLROBasePolling
+
+    class AsyncTempLroBasePolling(AsyncLROBasePolling):
+
+        async def request_status(self, status_link: str):
+            if self._path_format_arguments:
+                status_link = self._client.format_url(status_link, **self._path_format_arguments)
+            status_link, request_params = update_api_version_of_status_link(status_link)
+            # Re-inject 'x-ms-client-request-id' while polling
+            if "request_id" not in self._operation_config:
+                self._operation_config["request_id"] = self._get_request_id()
+
+            rest_request = HttpRequest("GET", status_link, params=request_params)
+            return await self._client.send_request(
+                rest_request, _return_pipeline_response=True, **self._operation_config
+            )
+
+    return AsyncTempLroBasePolling(0)
+
+
+# ================== after azure-core fix, the up code can be removed (end) ==================
+
+
+@pytest.fixture()
+def credential():
+    """I actually don't need anything, since the authentication policy
+    will bypass it.
+    """
+
+    class FakeCredential:
+        pass
+
+    return FakeCredential()
+
+
+@pytest.fixture()
+def authentication_policy():
+    from azure.core.pipeline.policies import SansIOHTTPPolicy
+
+    return SansIOHTTPPolicy()

package/generator/test/azure/mock_api_tests/test_azure_arm_models_common_types_managed_identity.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 pytest
+from azure.resourcemanager.models.commontypes.managedidentity import ManagedIdentityClient
+from azure.resourcemanager.models.commontypes.managedidentity import models
+
+SUBSCRIPTION_ID = "00000000-0000-0000-0000-000000000000"
+RESOURCE_GROUP_NAME = "test-rg"
+
+
+@pytest.fixture
+def client(credential, authentication_policy):
+    with ManagedIdentityClient(
+        credential, SUBSCRIPTION_ID, "http://localhost:3000", authentication_policy=authentication_policy
+    ) as client:
+        yield client
+
+
+def test_managed_identity_tracked_resources_get(client):
+    result = client.managed_identity_tracked_resources.get(
+        resource_group_name=RESOURCE_GROUP_NAME, managed_identity_tracked_resource_name="identity"
+    )
+    assert result.location == "eastus"
+    assert result.identity.type == "SystemAssigned"
+    assert result.properties.provisioning_state == "Succeeded"
+
+
+def test_managed_identity_tracked_resources_create_with_system_assigned(client):
+    result = client.managed_identity_tracked_resources.create_with_system_assigned(
+        resource_group_name=RESOURCE_GROUP_NAME,
+        managed_identity_tracked_resource_name="identity",
+        resource=models.ManagedIdentityTrackedResource(
+            location="eastus", identity=models.ManagedServiceIdentity(type="SystemAssigned")
+        ),
+    )
+    assert result.location == "eastus"
+    assert result.identity.type == "SystemAssigned"
+    assert result.properties.provisioning_state == "Succeeded"
+
+
+def test_managed_identity_tracked_resources_update_with_user_assigned_and_system_assigned(client):
+    result = client.managed_identity_tracked_resources.update_with_user_assigned_and_system_assigned(
+        resource_group_name=RESOURCE_GROUP_NAME,
+        managed_identity_tracked_resource_name="identity",
+        properties=models.ManagedIdentityTrackedResource(
+            location="eastus",
+            identity=models.ManagedServiceIdentity(
+                type="SystemAssigned,UserAssigned",
+                user_assigned_identities={
+                    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": models.UserAssignedIdentity()
+                },
+            ),
+        ),
+    )
+    assert result.location == "eastus"
+    assert result.identity.type == "SystemAssigned,UserAssigned"
+    assert result.properties.provisioning_state == "Succeeded"