File: test_list_translations.py

package info (click to toggle)
python-azure 20250603%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 851,724 kB
  • sloc: python: 7,362,925; ansic: 804; javascript: 287; makefile: 195; sh: 145; xml: 109
file content (273 lines) | stat: -rw-r--r-- 10,572 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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------

import pytest
import pytz
from datetime import datetime
import functools
from testcase import DocumentTranslationTest
from preparer import (
    DocumentTranslationPreparer,
    DocumentTranslationClientPreparer as _DocumentTranslationClientPreparer,
)
from devtools_testutils import recorded_by_proxy
from azure.ai.translation.document import DocumentTranslationClient

DocumentTranslationClientPreparer = functools.partial(_DocumentTranslationClientPreparer, DocumentTranslationClient)


class TestListTranslations(DocumentTranslationTest):
    @DocumentTranslationPreparer()
    @DocumentTranslationClientPreparer()
    @recorded_by_proxy
    def test_list_translations(self, **kwargs):
        client = kwargs.pop("client")
        variables = kwargs.pop("variables", {})
        # create some translations
        operations_count = 5
        docs_per_operation = 5
        self._begin_multiple_translations(
            client, operations_count, docs_per_operation=docs_per_operation, wait=False, variables=variables
        )

        # list translations
        submitted_translations = list(client.list_translation_statuses())
        assert submitted_translations is not None

        # check statuses
        for translation in submitted_translations:
            self._validate_translations(translation)
        return variables

    @pytest.mark.skip(
        reason="The max number of batch requests returned is limited to 50 and hence this test is no longer valid"
    )
    @DocumentTranslationPreparer()
    @DocumentTranslationClientPreparer()
    @recorded_by_proxy
    def test_list_translations_with_skip(self, **kwargs):
        client = kwargs.pop("client")
        variables = kwargs.pop("variables", {})
        # prepare data
        operations_count = 10
        docs_per_operation = 2
        skip = 5

        # create some translations
        self._begin_multiple_translations(
            client, operations_count, wait=False, docs_per_operation=docs_per_operation, variables=variables
        )

        # assert
        all_translations = list(client.list_translation_statuses())
        translations_with_skip = list(client.list_translation_statuses(skip=skip))
        assert len(all_translations) - len(translations_with_skip) == skip
        return variables

    @DocumentTranslationPreparer()
    @DocumentTranslationClientPreparer()
    @recorded_by_proxy
    def test_list_translations_filter_by_status(self, **kwargs):
        client = kwargs.pop("client")
        variables = kwargs.pop("variables", {})
        operations_count = 5
        docs_per_operation = 1

        # create some translations with the status 'Succeeded'
        completed_translation_ids = self._begin_multiple_translations(
            client, operations_count, wait=True, docs_per_operation=docs_per_operation, variables=variables
        )

        # create some translations with the status 'Canceled'
        translation_ids = self._begin_multiple_translations(
            client,
            operations_count,
            wait=False,
            docs_per_operation=docs_per_operation,
            variables=variables,
            container_suffix="cancel",
        )
        for id in translation_ids:
            client.cancel_translation(id)
        self.wait(10)  # wait for canceled to propagate

        # list translations with status filter
        statuses = ["Canceled"]
        submitted_translations = list(client.list_translation_statuses(statuses=statuses))

        # check statuses
        for translation in submitted_translations:
            assert translation.status in statuses
            assert translation.id not in completed_translation_ids
        return variables

    @DocumentTranslationPreparer()
    @DocumentTranslationClientPreparer()
    @recorded_by_proxy
    def test_list_translations_filter_by_ids(self, **kwargs):
        client = kwargs.pop("client")
        variables = kwargs.pop("variables", {})
        operations_count = 3
        docs_per_operation = 2

        # create some translations
        translation_ids = self._begin_multiple_translations(
            client, operations_count, wait=False, docs_per_operation=docs_per_operation, variables=variables
        )

        # list translations
        submitted_translations = list(client.list_translation_statuses(translation_ids=translation_ids))
        assert submitted_translations is not None

        # check statuses
        for translation in submitted_translations:
            assert translation.id in translation_ids
        return variables

    @pytest.mark.live_test_only
    @DocumentTranslationPreparer()
    @DocumentTranslationClientPreparer()
    def test_list_translations_filter_by_created_after(self, **kwargs):
        client = kwargs.pop("client")
        # create some translations
        operations_count = 3
        docs_per_operation = 2

        # create some translations
        start = datetime.utcnow()
        translation_ids = self._begin_multiple_translations(
            client, operations_count, wait=False, docs_per_operation=docs_per_operation
        )

        # list translations
        submitted_translations = list(client.list_translation_statuses(created_after=start))
        assert submitted_translations is not None

        # check statuses
        for translation in submitted_translations:
            assert translation.id in translation_ids
            assert translation.created_on.replace(tzinfo=None) >= start.replace(tzinfo=None)

    @pytest.mark.live_test_only
    @DocumentTranslationPreparer()
    @DocumentTranslationClientPreparer()
    def test_list_translations_filter_by_created_before(self, **kwargs):
        """
        NOTE: test is dependent on 'end' to be specific/same as time zone of the service!
            'end' must be timezone-aware!
        """
        client = kwargs.pop("client")
        operations_count = 5
        docs_per_operation = 1

        # create some translations
        self._begin_multiple_translations(client, operations_count, wait=True, docs_per_operation=docs_per_operation)
        end = datetime.utcnow().replace(tzinfo=pytz.utc)
        translation_ids = self._begin_multiple_translations(
            client, operations_count, wait=True, docs_per_operation=docs_per_operation
        )

        # list translations
        submitted_translations = list(client.list_translation_statuses(created_before=end))
        assert submitted_translations is not None

        # check statuses
        for translation in submitted_translations:
            assert translation.created_on.replace(tzinfo=None) <= end.replace(tzinfo=None)
            assert translation.id not in translation_ids

    @DocumentTranslationPreparer()
    @DocumentTranslationClientPreparer()
    @recorded_by_proxy
    def test_list_translations_order_by_creation_time_asc(self, **kwargs):
        client = kwargs.pop("client")
        variables = kwargs.pop("variables", {})
        operations_count = 3
        docs_per_operation = 2

        # create some translations
        self._begin_multiple_translations(
            client, operations_count, wait=False, docs_per_operation=docs_per_operation, variables=variables
        )

        # list translations
        submitted_translations = list(client.list_translation_statuses(order_by=["created_on asc"]))
        assert submitted_translations is not None

        # check statuses
        current = datetime.min
        for translation in submitted_translations:
            assert translation.created_on.replace(tzinfo=None) >= current.replace(tzinfo=None)
            current = translation.created_on
        return variables

    @DocumentTranslationPreparer()
    @DocumentTranslationClientPreparer()
    @recorded_by_proxy
    def test_list_translations_order_by_creation_time_desc(self, **kwargs):
        client = kwargs.pop("client")
        variables = kwargs.pop("variables", {})
        operations_count = 3
        docs_per_operation = 2

        # create some translations
        self._begin_multiple_translations(
            client, operations_count, wait=False, docs_per_operation=docs_per_operation, variables=variables
        )

        # list translations
        submitted_translations = list(client.list_translation_statuses(order_by=["created_on desc"]))
        assert submitted_translations is not None

        # check statuses
        current = datetime.max
        for translation in submitted_translations:
            assert translation.created_on.replace(tzinfo=None) <= current.replace(tzinfo=None)
            current = translation.created_on
        return variables

    @pytest.mark.live_test_only()
    @DocumentTranslationPreparer()
    @DocumentTranslationClientPreparer()
    def test_list_translations_mixed_filters(self, **kwargs):
        client = kwargs.pop("client")
        # create some translations
        operations_count = 4
        docs_per_operation = 1
        statuses = ["Succeeded"]
        skip = 1

        # create some translations
        start = datetime.utcnow().replace(tzinfo=pytz.utc)
        successful_translation_ids = self._begin_multiple_translations(
            client, operations_count, wait=True, docs_per_operation=docs_per_operation
        )
        end = datetime.utcnow().replace(tzinfo=pytz.utc)

        # list translations
        submitted_translations = client.list_translation_statuses(
            # filters
            statuses=statuses,
            created_after=start,
            created_before=end,
            # ordering
            order_by=["created_on asc"],
            # paging
            skip=skip,
        ).by_page()

        # check statuses
        current_time = datetime.min
        for page in submitted_translations:
            page_translations = list(page)
            for translation in page_translations:
                assert translation.id in successful_translation_ids
                # assert ordering
                assert translation.created_on.replace(tzinfo=None) >= current_time.replace(tzinfo=None)
                current_time = translation.created_on
                # assert filters
                assert translation.created_on.replace(tzinfo=None) <= end.replace(tzinfo=None)
                assert translation.created_on.replace(tzinfo=None) >= start.replace(tzinfo=None)
                assert translation.status in statuses