File: cognitiveservices_testcase.py

package info (click to toggle)
python-azure 20230112%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 749,544 kB
  • sloc: python: 6,815,827; javascript: 287; makefile: 195; xml: 109; sh: 105
file content (127 lines) | stat: -rw-r--r-- 5,356 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
import time
from collections import namedtuple
from azure_devtools.scenario_tests import ReplayableTest
from devtools_testutils import AzureTestCase
from azure_devtools.scenario_tests.exceptions import AzureTestError
from . import AzureMgmtPreparer, ResourceGroupPreparer
from .resource_testcase import RESOURCE_GROUP_PARAM
from azure.mgmt.cognitiveservices import CognitiveServicesManagementClient
from msrest.authentication import CognitiveServicesCredentials

FakeCognitiveServicesAccount = namedtuple("FakeResource", ["endpoint"])


class CognitiveServiceTest(AzureTestCase):
    """Can be used for Track 1 tests"""

    FILTER_HEADERS = ReplayableTest.FILTER_HEADERS + ["Ocp-Apim-Subscription-Key"]

    def __init__(self, method_name):
        super(CognitiveServiceTest, self).__init__(method_name)


class CognitiveServicesAccountPreparer(AzureMgmtPreparer):
    def __init__(
        self,
        name_prefix="",
        sku="S0",
        location="westus2",
        kind="cognitiveservices",
        parameter_name="cognitiveservices_account",
        legacy=False,
        resource_group_parameter_name=RESOURCE_GROUP_PARAM,
        disable_recording=True,
        playback_fake_resource=None,
        client_kwargs=None,
        random_name_enabled=True,
        **kwargs
    ):
        super(CognitiveServicesAccountPreparer, self).__init__(
            name_prefix,
            24,
            disable_recording=disable_recording,
            playback_fake_resource=playback_fake_resource,
            client_kwargs=client_kwargs,
            random_name_enabled=random_name_enabled,
        )
        self.location = location
        self.sku = sku
        self.kind = kind
        self.resource_group_parameter_name = resource_group_parameter_name
        self.parameter_name = parameter_name
        self.cogsci_key = ""
        self.legacy = legacy
        self.custom_subdomain_name = kwargs.pop("custom_subdomain_name", None)

    def create_resource(self, name, **kwargs):
        if self.is_live:
            self.client = self.create_mgmt_client(CognitiveServicesManagementClient)
            group = self._get_resource_group(**kwargs)
            cogsci_account = self.client.accounts.begin_create(
                group.name,
                name,
                account={
                    "sku": {"name": self.sku},
                    "location": self.location,
                    "kind": self.kind,
                    "properties": {"custom_sub_domain_name": self.custom_subdomain_name},
                },
            ).result()
            time.sleep(10)  # it takes a few seconds to create a cognitive services account
            self.resource = cogsci_account
            self.cogsci_key = self.client.accounts.list_keys(group.name, name).key1
            # FIXME: LuisAuthoringClient and LuisRuntimeClient need authoring key from ARM API (coming soon-ish)
        else:
            if self.custom_subdomain_name:
                self.resource = FakeCognitiveServicesAccount(
                    "https://{}.cognitiveservices.azure.com".format(self.custom_subdomain_name)
                )
                self.cogsci_key = "ZmFrZV9hY29jdW50X2tleQ=="
            else:
                self.resource = FakeCognitiveServicesAccount(
                    "https://{}.api.cognitive.microsoft.com".format(self.location)
                )
                self.cogsci_key = "ZmFrZV9hY29jdW50X2tleQ=="

        if self.legacy:
            try:
                return {
                    self.parameter_name: self.resource.properties.endpoint,
                    "{}_key".format(self.parameter_name): CognitiveServicesCredentials(self.cogsci_key),
                }
            except AttributeError:
                return {
                    self.parameter_name: self.resource.endpoint,
                    "{}_key".format(self.parameter_name): CognitiveServicesCredentials(self.cogsci_key),
                }
        else:
            try:
                return {
                    self.parameter_name: self.resource.properties.endpoint,
                    "{}_key".format(self.parameter_name): self.cogsci_key,
                }
            except AttributeError:
                return {
                    self.parameter_name: self.resource.endpoint,
                    "{}_key".format(self.parameter_name): self.cogsci_key,
                }

    def remove_resource(self, name, **kwargs):
        if self.is_live:
            group = self._get_resource_group(**kwargs)
            self.client.accounts.begin_delete(group.name, name).wait()

    def _get_resource_group(self, **kwargs):
        try:
            return kwargs.get(self.resource_group_parameter_name)
        except KeyError:
            template = (
                "To create a cognitive services account a resource group is required. Please add "
                "decorator @{} in front of this cognitive services account preparer."
            )
            raise AzureTestError(template.format(ResourceGroupPreparer.__name__))