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
|
#!/usr/bin/env python
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
import argparse
import sys
import os
import logging
from fnmatch import fnmatch
try:
from subprocess import TimeoutExpired, check_call, CalledProcessError
except ImportError:
from subprocess32 import TimeoutExpired, check_call, CalledProcessError
from ci_tools.functions import compare_python_version
from common_tasks import run_check_call
logging.getLogger().setLevel(logging.INFO)
root_dir = os.path.abspath(os.path.join(os.path.abspath(__file__), "..", "..", ".."))
MINIMUM_TESTED_PYTHON_VERSION = ">=3.8.0"
"""
Some samples may "run forever" or need to be timed out after a period of time. Add them here in the following format:
TIMEOUT_SAMPLES = {
"<package-name>": {
"<sample_file_name.py>": (<timeout (seconds)>, <pass if timeout? (bool, default: True)>)
}
}
"""
TIMEOUT_SAMPLES = {
"azure-eventgrid": {
"consume_cloud_events_from_storage_queue.py": (10),
},
"azure-eventhub": {
"receive_batch_with_checkpoint.py": (10),
"recv.py": (10),
"recv_track_last_enqueued_event_prop.py": (10),
"recv_with_checkpoint_by_event_count.py": (10),
"recv_with_checkpoint_by_time_interval.py": (10),
"recv_with_checkpoint_store.py": (10),
"recv_with_custom_starting_position.py": (10),
"sample_code_eventhub.py": (10),
"receive_batch_with_checkpoint_async.py": (10),
"recv_async.py": (10),
"recv_track_last_enqueued_event_prop_async.py": (10),
"recv_with_checkpoint_by_event_count_async.py": (10),
"recv_with_checkpoint_by_time_interval_async.py": (10),
"recv_with_checkpoint_store_async.py": (10),
"recv_with_custom_starting_position_async.py": (10),
"sample_code_eventhub_async.py": (10),
"send_and_receive_amqp_annotated_message.py": (10),
"send_and_receive_amqp_annotated_message_async.py": (10),
},
"azure-eventhub-checkpointstoreblob": {
"receive_events_using_checkpoint_store.py": (10),
"receive_events_using_checkpoint_store_storage_api_version.py": (10),
},
"azure-eventhub-checkpointstoreblob-aio": {
"receive_events_using_checkpoint_store_async.py": (10),
"receive_events_using_checkpoint_store_storage_api_version_async.py": (10),
},
"azure-servicebus": {
"failure_and_recovery.py": (10),
"receive_iterator_queue.py": (10),
"sample_code_servicebus.py": (30),
"session_pool_receive.py": (20),
"receive_iterator_queue_async.py": (10),
"sample_code_servicebus_async.py": (30),
"session_pool_receive_async.py": (20),
},
}
# Add your library + sample file if you do not want a particular sample to be run
IGNORED_SAMPLES = {
"azure-appconfiguration-provider": [
"key_vault_reference_customized_clients_sample.py",
"aad_sample.py",
"key_vault_reference_sample.py"
],
"azure-ai-ml": [
"ml_samples_authentication_sovereign_cloud.py"
],
"azure-eventgrid": [
"__init__.py",
"consume_cloud_events_from_eventhub.py",
"consume_eventgrid_events_from_service_bus_queue.py",
"sample_publish_events_to_a_topic_using_sas_credential.py",
"sample_publish_events_to_a_topic_using_sas_credential_async.py"
],
"azure-eventhub": [
"client_identity_authentication.py", # TODO: remove after fixing issue #29177
"client_identity_authentication_async.py", # TODO: remove after fixing issue #29177
"connection_to_custom_endpoint_address.py",
"proxy.py",
"connection_to_custom_endpoint_address_async.py",
"iot_hub_connection_string_receive_async.py",
"proxy_async.py",
"send_stream.py", # TODO: remove after fixing issue #29177
],
"azure-eventhub-checkpointstoretable": ["receive_events_using_checkpoint_store.py"],
"azure-servicebus": [
"connection_to_custom_endpoint_address.py",
"mgmt_queue.py",
"mgmt_rule.py",
"mgmt_subscription.py",
"mgmt_topic.py",
"proxy.py",
"receive_deferred_message_queue.py",
"connection_to_custom_endpoint_address_async.py",
"mgmt_queue_async.py",
"mgmt_rule_async.py",
"mgmt_subscription_async.py",
"mgmt_topic_async.py",
"proxy_async.py",
"receive_deferred_message_queue_async.py",
],
"azure-communication-chat": [
"chat_client_sample_async.py",
"chat_client_sample.py",
"chat_thread_client_sample_async.py",
"chat_thread_client_sample.py",
],
"azure-communication-phonenumbers": [
"purchase_phone_number_sample_async.py",
"purchase_phone_number_sample.py",
"release_phone_number_sample_async.py",
"release_phone_number_sample.py",
],
"azure-ai-translation-document": [
"sample_list_document_statuses_with_filters_async.py",
"sample_list_translations_with_filters_async.py",
"sample_list_document_statuses_with_filters.py",
"sample_list_translations_with_filters.py",
"sample_translation_with_custom_model.py",
"sample_translation_with_custom_model_async.py",
"sample_begin_translation_with_filters.py",
"sample_begin_translation_with_filters_async.py"
],
"azure-ai-language-questionanswering": [
"sample_export_import_project.py",
"sample_export_import_project_async.py"
],
"azure-ai-textanalytics": [
"sample_analyze_healthcare_entities_with_cancellation.py",
"sample_analyze_healthcare_entities_with_cancellation_async.py",
"sample_abstract_summary.py",
"sample_abstract_summary_async.py",
],
"azure-storage-blob": [
"blob_samples_proxy_configuration.py",
"blob_samples_container_access_policy.py",
"blob_samples_container_access_policy_async.py",
"blob_samples_client_side_encryption_keyvault.py"
],
}
def run_check_call_with_timeout(
command_array,
working_directory,
timeout,
pass_if_timeout,
acceptable_return_codes=[],
always_exit=False,
):
"""This is copied from common_tasks.py with some additions.
Don't want to break anyone that's using the original code.
"""
try:
logging.info(
"Command Array: {0}, Target Working Directory: {1}".format(
command_array, working_directory
)
)
check_call(command_array, cwd=working_directory, timeout=timeout)
except CalledProcessError as err:
if err.returncode not in acceptable_return_codes:
logging.error(err) # , file = sys.stderr
if always_exit:
exit(1)
else:
return err
except TimeoutExpired as err:
if pass_if_timeout:
logging.info("Sample timed out successfully")
else:
logging.info("Fail: Sample timed out")
return err
def execute_sample(sample, samples_errors, timed):
if isinstance(sample, tuple):
sample, timeout, pass_if_timeout = sample
if sys.version_info < (3, 5) and sample.endswith("_async.py"):
return
logging.info("Testing {}".format(sample))
command_array = [sys.executable, sample]
if not timed:
errors = run_check_call(command_array, root_dir, always_exit=False)
else:
errors = run_check_call_with_timeout(
command_array, root_dir, timeout, pass_if_timeout
)
sample_name = os.path.basename(sample)
if errors:
samples_errors.append(sample_name)
logging.info("ERROR: {}".format(sample_name))
else:
logging.info("SUCCESS: {}.".format(sample_name))
def resolve_sample_ignore(sample_file, package_name):
ignored_files = [
(f, ">=2.7") if not isinstance(f, tuple) else f
for f in IGNORED_SAMPLES.get(package_name, [])
]
ignored_files_dict = {key: value for (key, value) in ignored_files}
if sample_file in ignored_files_dict and compare_python_version(
ignored_files_dict[sample_file]
):
return False
else:
return True
def run_samples(targeted_package):
logging.info("running samples for {}".format(targeted_package))
samples_errors = []
sample_paths = []
timed_sample_paths = []
samples_dir_path = os.path.abspath(os.path.join(targeted_package, "samples"))
package_name = os.path.basename(targeted_package)
samples_need_timeout = TIMEOUT_SAMPLES.get(package_name, {})
# install extra dependencies for samples if needed
try:
with open(samples_dir_path + "/sample_dev_requirements.txt") as sample_dev_reqs:
for dep in sample_dev_reqs.readlines():
check_call([sys.executable, "-m", "pip", "install", dep])
except IOError:
pass
for path, subdirs, files in os.walk(samples_dir_path):
for name in files:
if fnmatch(name, "*.py") and name in samples_need_timeout:
timeout = samples_need_timeout[name]
# timeout, pass_if_timeout is True by default if nothing passed in
if isinstance(timeout, tuple):
timeout, pass_if_timeout = timeout
else:
pass_if_timeout = True
timed_sample_paths.append(
(
os.path.abspath(os.path.join(path, name)),
timeout,
pass_if_timeout,
)
)
elif fnmatch(name, "*.py") and resolve_sample_ignore(name, package_name):
sample_paths.append(os.path.abspath(os.path.join(path, name)))
if not sample_paths and not timed_sample_paths:
logging.info("No samples found in {}".format(targeted_package))
exit(0)
for sample in sample_paths:
execute_sample(sample, samples_errors, timed=False)
for sample in timed_sample_paths:
execute_sample(sample, samples_errors, timed=True)
if samples_errors:
logging.error("Sample(s) that ran with errors: {}".format(samples_errors))
exit(1)
logging.info("All samples ran successfully in {}".format(targeted_package))
if __name__ == "__main__":
parser = argparse.ArgumentParser(
description="Install Dependencies, Install Packages, Test Azure Packages' Samples, Called from DevOps YAML Pipeline"
)
parser.add_argument(
"-t",
"--target",
dest="target_package",
help="The target package directory on disk. The target module passed to run mypy will be <target_package>/azure.",
required=True,
)
args = parser.parse_args()
service_dir = os.path.join("sdk", args.target_package)
target_dir = os.path.join(root_dir, service_dir)
if compare_python_version(MINIMUM_TESTED_PYTHON_VERSION):
logging.info(
"User opted to run samples, and python version is greater than minimum supported."
)
run_samples(target_dir)
|
