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 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
|
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
import os
import time
import datetime
import uuid
from azure.ai.translation.document.models import DocumentBatch, SourceInput, StartTranslationDetails
from devtools_testutils import AzureRecordedTestCase, set_custom_default_matcher
from azure.storage.blob import generate_container_sas, ContainerClient
from azure.ai.translation.document import DocumentTranslationInput, TranslationTarget
class Document:
"""Represents a document to be uploaded to source/target container"""
def __init__(self, **kwargs):
self.name = kwargs.get("name", str(uuid.uuid4()))
self.suffix = kwargs.get("suffix", ".txt")
self.prefix = kwargs.get("prefix", "")
self.data = kwargs.get("data", b"This is written in english.")
@classmethod
def create_dummy_docs(cls, docs_count):
result = []
for i in range(docs_count):
result.append(cls())
return result
class DocumentTranslationTest(AzureRecordedTestCase):
@property
def storage_name(self):
return os.getenv("DOCUMENT_TRANSLATION_STORAGE_NAME", "redacted")
@property
def storage_endpoint(self):
return "https://" + self.storage_name + ".blob.core.windows.net/"
@property
def storage_key(self):
return os.getenv("DOCUMENT_TRANSLATION_STORAGE_KEY", "fakeZmFrZV9hY29jdW50X2tleQ==")
def upload_documents(self, data, container_client):
if isinstance(data, list):
for blob in data:
container_client.upload_blob(name=blob.prefix + blob.name + blob.suffix, data=blob.data)
else:
container_client.upload_blob(name=data.prefix + data.name + data.suffix, data=data.data)
def create_source_container(self, data, variables={}, **kwargs):
container_suffix = kwargs.get("container_suffix", "")
var_key = "source_container_name" + container_suffix
if self.is_live:
self.source_container_name = variables[var_key] = "src" + str(uuid.uuid4())
container_client = ContainerClient(self.storage_endpoint, variables[var_key], self.storage_key)
container_client.create_container()
self.upload_documents(data, container_client)
return self.generate_sas_url(variables[var_key], "rl")
def create_target_container(self, data=None, variables={}, **kwargs):
container_suffix = kwargs.get("container_suffix", "")
var_key = "target_container_name" + container_suffix
if self.is_live:
self.target_container_name = variables[var_key] = "target" + str(uuid.uuid4())
container_client = ContainerClient(self.storage_endpoint, variables[var_key], self.storage_key)
container_client.create_container()
if data:
self.upload_documents(data, container_client)
return self.generate_sas_url(variables[var_key], "wl")
def generate_sas_url(self, container_name, permission):
# this can be reverted to set_bodiless_matcher() after tests are re-recorded and don't contain these headers
set_custom_default_matcher(
compare_bodies=False, excluded_headers="Authorization,Content-Length,x-ms-client-request-id,x-ms-request-id"
)
sas_token = self.generate_sas(
generate_container_sas,
account_name=self.storage_name,
container_name=container_name,
account_key=self.storage_key,
permission=permission,
expiry=datetime.datetime.utcnow() + datetime.timedelta(hours=2),
)
container_sas_url = self.storage_endpoint + container_name + "?" + sas_token
return container_sas_url
def wait(self, duration=30):
if self.is_live:
time.sleep(duration)
# model helpers
def _validate_doc_status(self, doc_details, target_language=None, **kwargs):
status = kwargs.pop("statuses", ["Succeeded"])
ids = kwargs.pop("ids", None)
# specific assertions
assert doc_details.status in status
if self.is_live and target_language:
assert doc_details.translated_to == target_language
# generic assertions
if ids:
assert doc_details.id in ids
else:
assert doc_details.id is not None
assert doc_details.id is not None
assert doc_details.source_document_url is not None
assert doc_details.translated_document_url is not None
assert doc_details.translation_progress is not None
assert doc_details.characters_charged is not None
assert doc_details.created_on is not None
assert doc_details.last_updated_on is not None
def _validate_translation_metadata(self, poller, **kwargs):
status = kwargs.pop("status", None)
total = kwargs.pop("total", None)
failed = kwargs.pop("failed", None)
succeeded = kwargs.pop("succeeded", None)
inprogress = kwargs.pop("inprogress", None)
notstarted = kwargs.pop("notstarted", None)
canceled = kwargs.pop("canceled", None)
# status
p = poller.status()
if status:
assert poller.status() == status
# docs count
if poller.done():
if total:
assert poller.details.documents_total_count == total
else:
assert poller.details.documents_total_count is not None
if failed:
assert poller.details.documents_failed_count == failed
else:
assert poller.details.documents_failed_count is not None
if succeeded:
assert poller.details.documents_succeeded_count == succeeded
else:
assert poller.details.documents_succeeded_count is not None
if inprogress:
assert poller.details.documents_in_progress_count == inprogress
else:
assert poller.details.documents_in_progress_count is not None
if notstarted:
assert poller.details.documents_not_started_count == notstarted
else:
assert poller.details.documents_not_started_count is not None
if canceled:
assert poller.details.documents_canceled_count == canceled
else:
assert poller.details.documents_canceled_count is not None
# generic assertions
assert poller.details.id is not None
assert poller.details.created_on is not None
assert poller.details.last_updated_on is not None
assert poller.details.total_characters_charged is not None
def _validate_translations(self, job_details, **kwargs):
status = kwargs.pop("status", None)
total = kwargs.pop("total", None)
failed = kwargs.pop("failed", None)
succeeded = kwargs.pop("succeeded", None)
inprogress = kwargs.pop("inprogress", None)
notstarted = kwargs.pop("notstarted", None)
canceled = kwargs.pop("canceled", None)
# status
if status:
assert job_details.status == status
else:
assert job_details.status is not None
# docs count
if total:
assert job_details.documents_total_count == total
else:
assert job_details.documents_total_count is not None
if failed:
assert job_details.documents_failed_count == failed
else:
assert job_details.documents_failed_count is not None
if succeeded:
assert job_details.documents_succeeded_count == succeeded
else:
assert job_details.documents_succeeded_count is not None
if inprogress:
assert job_details.documents_in_progress_count == inprogress
else:
assert job_details.documents_in_progress_count is not None
if notstarted:
assert job_details.documents_not_started_count == notstarted
else:
assert job_details.documents_not_started_count is not None
if canceled:
assert job_details.documents_canceled_count == canceled
else:
assert job_details.documents_canceled_count is not None
# generic assertions
assert job_details.id is not None
assert job_details.created_on is not None
assert job_details.last_updated_on is not None
assert job_details.total_characters_charged is not None
def _validate_format(self, format):
assert format.file_format is not None
assert format.file_extensions is not None
assert format.content_types is not None
# client helpers
def _begin_and_validate_translation(self, client, translation_inputs, total_docs_count, language=None, **kwargs):
wait_for_operation = kwargs.pop("wait", True)
# submit job
poller = client.begin_translation(translation_inputs)
assert poller.id is not None
# wait for result
if wait_for_operation:
result = poller.result()
for doc in result:
self._validate_doc_status(doc, language)
assert poller.details.id is not None
# validate
self._validate_translation_metadata(
poller=poller, status="Succeeded", total=total_docs_count, succeeded=total_docs_count
)
return poller.id
def _begin_multiple_translations(self, client, operations_count, **kwargs):
container_suffix = kwargs.pop("container_suffix", "")
variables = kwargs.pop("variables", {})
wait_for_operation = kwargs.pop("wait", True)
language = kwargs.pop("language", "es")
docs_per_operation = kwargs.pop("docs_per_operation", 2)
result_job_ids = []
for i in range(operations_count):
# prepare containers and test data
blob_data = Document.create_dummy_docs(docs_per_operation)
source_container_sas_url = self.create_source_container(
data=blob_data, variables=variables, container_suffix=str(i) + container_suffix
)
target_container_sas_url = self.create_target_container(
variables=variables, container_suffix=str(i) + container_suffix
)
# prepare translation inputs
translation_inputs = [
DocumentTranslationInput(
source_url=source_container_sas_url,
targets=[TranslationTarget(target_url=target_container_sas_url, language=language)],
)
]
# submit multiple jobs
poller = client.begin_translation(translation_inputs)
assert poller.id is not None
if wait_for_operation:
result = poller.result()
else:
poller.wait()
result_job_ids.append(poller.id)
return result_job_ids
def _begin_and_validate_translation_with_multiple_docs(self, client, docs_count, **kwargs):
# get input params
wait_for_operation = kwargs.pop("wait", False)
variables = kwargs.get("variables", {})
language = kwargs.pop("language", "es")
# prepare containers and test data
blob_data = Document.create_dummy_docs(docs_count=docs_count)
source_container_sas_url = self.create_source_container(data=blob_data, variables=variables)
target_container_sas_url = self.create_target_container(variables=variables)
# prepare translation inputs
translation_inputs = [
DocumentTranslationInput(
source_url=source_container_sas_url,
targets=[TranslationTarget(target_url=target_container_sas_url, language=language)],
)
]
# submit job
poller = client.begin_translation(translation_inputs)
assert poller.id is not None
# wait for result
if wait_for_operation:
result = poller.result()
for doc in result:
self._validate_doc_status(doc, "es")
# validate
self._validate_translation_metadata(poller=poller)
return poller
def _prepare_and_validate_start_translation_details(self, client, docs_count, **kwargs):
# get input params
wait_for_operation = kwargs.pop("wait", False)
variables = kwargs.get("variables", {})
language = kwargs.pop("language", "es")
# prepare test data
blob_data = Document.create_dummy_docs(docs_count=docs_count)
source_input = SourceInput(source_url=self.create_source_container(data=blob_data, variables=variables))
target = TranslationTarget(target_url=self.create_target_container(variables=variables), language=language)
batch_request = DocumentBatch(source=source_input, targets=[target])
start_translation_details = StartTranslationDetails(inputs=[batch_request])
# submit job
poller = client.begin_translation(start_translation_details)
assert poller.id is not None
# wait for result
if wait_for_operation:
result = poller.result()
for doc in result:
self._validate_doc_status(doc, "es")
# validate
self._validate_translation_metadata(poller=poller)
return poller
|