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
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
|
# coding: utf-8
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
import unittest
from azure.common import AzureHttpError
from azure.storage.blob import BlockBlobService
from azure.storage.common import (
Logging,
Metrics,
CorsRule,
RetentionPolicy,
DeleteRetentionPolicy,
StaticWebsite,
)
from azure.storage.file import FileService
from azure.storage.queue import QueueService
from tests.testcase import (
StorageTestCase,
record,
not_for_emulator,
)
# ------------------------------------------------------------------------------
class ServicePropertiesTest(StorageTestCase):
def setUp(self):
super(ServicePropertiesTest, self).setUp()
self.bs = self._create_storage_service(BlockBlobService, self.settings)
self.qs = self._create_storage_service(QueueService, self.settings)
# file service is not supported on the emulator
if not self.settings.IS_EMULATED:
self.fs = self._create_storage_service(FileService, self.settings)
# --Helpers-----------------------------------------------------------------
def _assert_properties_default(self, prop):
self.assertIsNotNone(prop)
self._assert_logging_equal(prop.logging, Logging())
self._assert_metrics_equal(prop.hour_metrics, Metrics())
self._assert_metrics_equal(prop.minute_metrics, Metrics())
self._assert_cors_equal(prop.cors, list())
def _assert_logging_equal(self, log1, log2):
if log1 is None or log2 is None:
self.assertEqual(log1, log2)
return
self.assertEqual(log1.version, log2.version)
self.assertEqual(log1.read, log2.read)
self.assertEqual(log1.write, log2.write)
self.assertEqual(log1.delete, log2.delete)
self._assert_retention_equal(log1.retention_policy, log2.retention_policy)
def _assert_delete_retention_policy_equal(self, policy1, policy2):
if policy1 is None or policy2 is None:
self.assertEqual(policy1, policy2)
return
self.assertEqual(policy1.enabled, policy2.enabled)
self.assertEqual(policy1.days, policy2.days)
def _assert_static_website_equal(self, prop1, prop2):
if prop1 is None or prop2 is None:
self.assertEqual(prop1, prop2)
return
self.assertEqual(prop1.enabled, prop2.enabled)
self.assertEqual(prop1.index_document, prop2.index_document)
self.assertEqual(prop1.error_document_404_path, prop2.error_document_404_path)
def _assert_delete_retention_policy_not_equal(self, policy1, policy2):
if policy1 is None or policy2 is None:
self.assertNotEqual(policy1, policy2)
return
self.assertFalse(policy1.enabled == policy2.enabled
and policy1.days == policy2.days)
def _assert_metrics_equal(self, metrics1, metrics2):
if metrics1 is None or metrics2 is None:
self.assertEqual(metrics1, metrics2)
return
self.assertEqual(metrics1.version, metrics2.version)
self.assertEqual(metrics1.enabled, metrics2.enabled)
self.assertEqual(metrics1.include_apis, metrics2.include_apis)
self._assert_retention_equal(metrics1.retention_policy, metrics2.retention_policy)
def _assert_cors_equal(self, cors1, cors2):
if cors1 is None or cors2 is None:
self.assertEqual(cors1, cors2)
return
self.assertEqual(len(cors1), len(cors2))
for i in range(0, len(cors1)):
rule1 = cors1[i]
rule2 = cors2[i]
self.assertEqual(len(rule1.allowed_origins), len(rule2.allowed_origins))
self.assertEqual(len(rule1.allowed_methods), len(rule2.allowed_methods))
self.assertEqual(rule1.max_age_in_seconds, rule2.max_age_in_seconds)
self.assertEqual(len(rule1.exposed_headers), len(rule2.exposed_headers))
self.assertEqual(len(rule1.allowed_headers), len(rule2.allowed_headers))
def _assert_retention_equal(self, ret1, ret2):
self.assertEqual(ret1.enabled, ret2.enabled)
self.assertEqual(ret1.days, ret2.days)
# --Test cases per service ---------------------------------------
@record
def test_blob_service_properties(self):
# Arrange
# Act
resp = self.bs.set_blob_service_properties(logging=Logging(), hour_metrics=Metrics(),
minute_metrics=Metrics(), cors=list(), target_version='2014-02-14')
# Assert
self.assertIsNone(resp)
props = self.bs.get_blob_service_properties()
self._assert_properties_default(props)
self.assertEqual('2014-02-14', props.target_version)
@record
def test_queue_service_properties(self):
# Arrange
# Act
resp = self.qs.set_queue_service_properties(logging=Logging(), hour_metrics=Metrics(),
minute_metrics=Metrics(), cors=list())
# Assert
self.assertIsNone(resp)
self._assert_properties_default(self.qs.get_queue_service_properties())
@not_for_emulator
@record
def test_file_service_properties(self):
# Arrange
# Act
resp = self.fs.set_file_service_properties(hour_metrics=Metrics(),
minute_metrics=Metrics(), cors=list())
# Assert
self.assertIsNone(resp)
props = self.fs.get_file_service_properties()
self._assert_metrics_equal(props.hour_metrics, Metrics())
self._assert_metrics_equal(props.minute_metrics, Metrics())
self._assert_cors_equal(props.cors, list())
# --Test cases per feature ---------------------------------------
@record
def test_set_default_service_version(self):
# Arrange
# Act
self.bs.set_blob_service_properties(target_version='2014-02-14')
# Assert
received_props = self.bs.get_blob_service_properties()
self.assertEqual(received_props.target_version, '2014-02-14')
@record
def test_set_delete_retention_policy(self):
# Arrange
delete_retention_policy = DeleteRetentionPolicy(enabled=True, days=2)
# Act
self.bs.set_blob_service_properties(delete_retention_policy=delete_retention_policy)
# Assert
received_props = self.bs.get_blob_service_properties()
self._assert_delete_retention_policy_equal(received_props.delete_retention_policy, delete_retention_policy)
@record
def test_set_delete_retention_policy_edge_cases(self):
# Should work with minimum settings
delete_retention_policy = DeleteRetentionPolicy(enabled=True, days=1)
self.bs.set_blob_service_properties(delete_retention_policy=delete_retention_policy)
# Assert
received_props = self.bs.get_blob_service_properties()
self._assert_delete_retention_policy_equal(received_props.delete_retention_policy, delete_retention_policy)
# Should work with maximum settings
delete_retention_policy = DeleteRetentionPolicy(enabled=True, days=365)
self.bs.set_blob_service_properties(delete_retention_policy=delete_retention_policy)
# Assert
received_props = self.bs.get_blob_service_properties()
self._assert_delete_retention_policy_equal(received_props.delete_retention_policy, delete_retention_policy)
# Should not work with 0 days
delete_retention_policy = DeleteRetentionPolicy(enabled=True, days=0)
with self.assertRaises(AzureHttpError):
self.bs.set_blob_service_properties(delete_retention_policy=delete_retention_policy)
# Assert
received_props = self.bs.get_blob_service_properties()
self._assert_delete_retention_policy_not_equal(received_props.delete_retention_policy, delete_retention_policy)
# Should not work with 366 days
delete_retention_policy = DeleteRetentionPolicy(enabled=True, days=366)
with self.assertRaises(AzureHttpError):
self.bs.set_blob_service_properties(delete_retention_policy=delete_retention_policy)
# Assert
received_props = self.bs.get_blob_service_properties()
self._assert_delete_retention_policy_not_equal(received_props.delete_retention_policy, delete_retention_policy)
@record
def test_set_disabled_delete_retention_policy(self):
# Arrange
delete_retention_policy = DeleteRetentionPolicy(enabled=False)
# Act
self.bs.set_blob_service_properties(delete_retention_policy=delete_retention_policy)
# Assert
received_props = self.bs.get_blob_service_properties()
self._assert_delete_retention_policy_equal(received_props.delete_retention_policy, delete_retention_policy)
@record
def test_set_static_website_properties(self):
# Arrange
static_website = StaticWebsite(enabled=True, index_document="index.html",
error_document_404_path="errors/error/404error.html")
# Act
self.bs.set_blob_service_properties(static_website=static_website)
# Assert
received_props = self.bs.get_blob_service_properties()
self._assert_static_website_equal(received_props.static_website, static_website)
@record
def test_set_static_website_properties_missing_field(self):
# Case1: Arrange both missing
static_website = StaticWebsite(enabled=True)
# Act
self.bs.set_blob_service_properties(static_website=static_website)
# Assert
received_props = self.bs.get_blob_service_properties()
self._assert_static_website_equal(received_props.static_website, static_website)
# Case2: Arrange index document missing
static_website = StaticWebsite(enabled=True, error_document_404_path="errors/error/404error.html")
# Act
self.bs.set_blob_service_properties(static_website=static_website)
# Assert
received_props = self.bs.get_blob_service_properties()
self._assert_static_website_equal(received_props.static_website, static_website)
# Case3: Arrange error document missing
static_website = StaticWebsite(enabled=True, index_document="index.html")
# Act
self.bs.set_blob_service_properties(static_website=static_website)
# Assert
received_props = self.bs.get_blob_service_properties()
self._assert_static_website_equal(received_props.static_website, static_website)
@record
def test_disabled_static_website_properties(self):
# Arrange
static_website = StaticWebsite(enabled=False, index_document="index.html",
error_document_404_path="errors/error/404error.html")
# Act
self.bs.set_blob_service_properties(static_website=static_website)
# Assert
received_props = self.bs.get_blob_service_properties()
self._assert_static_website_equal(received_props.static_website, StaticWebsite(enabled=False))
@record
def test_set_static_website_properties_does_not_impact_other_properties(self):
# Arrange to set cors
cors_rule1 = CorsRule(['www.xyz.com'], ['GET'])
allowed_origins = ['www.xyz.com', "www.ab.com", "www.bc.com"]
allowed_methods = ['GET', 'PUT']
max_age_in_seconds = 500
exposed_headers = ["x-ms-meta-data*", "x-ms-meta-source*", "x-ms-meta-abc", "x-ms-meta-bcd"]
allowed_headers = ["x-ms-meta-data*", "x-ms-meta-target*", "x-ms-meta-xyz", "x-ms-meta-foo"]
cors_rule2 = CorsRule(allowed_origins, allowed_methods, max_age_in_seconds,
exposed_headers, allowed_headers)
cors = [cors_rule1, cors_rule2]
# Act to set cors
self.bs.set_blob_service_properties(cors=cors)
# Assert cors is updated
received_props = self.bs.get_blob_service_properties()
self._assert_cors_equal(received_props.cors, cors)
# Arrange to set static website properties
static_website = StaticWebsite(enabled=True, index_document="index.html",
error_document_404_path="errors/error/404error.html")
# Act to set static website
self.bs.set_blob_service_properties(static_website=static_website)
# Assert static website was updated was cors was unchanged
received_props = self.bs.get_blob_service_properties()
self._assert_static_website_equal(received_props.static_website, static_website)
self._assert_cors_equal(received_props.cors, cors)
@record
def test_set_logging(self):
# Arrange
logging = Logging(read=True, write=True, delete=True, retention_policy=RetentionPolicy(enabled=True, days=5))
# Act
self.bs.set_blob_service_properties(logging=logging)
# Assert
received_props = self.bs.get_blob_service_properties()
self._assert_logging_equal(received_props.logging, logging)
@record
def test_set_hour_metrics(self):
# Arrange
hour_metrics = Metrics(enabled=True, include_apis=True, retention_policy=RetentionPolicy(enabled=True, days=5))
# Act
self.bs.set_blob_service_properties(hour_metrics=hour_metrics)
# Assert
received_props = self.bs.get_blob_service_properties()
self._assert_metrics_equal(received_props.hour_metrics, hour_metrics)
@record
def test_set_minute_metrics(self):
# Arrange
minute_metrics = Metrics(enabled=True, include_apis=True,
retention_policy=RetentionPolicy(enabled=True, days=5))
# Act
self.bs.set_blob_service_properties(minute_metrics=minute_metrics)
# Assert
received_props = self.bs.get_blob_service_properties()
self._assert_metrics_equal(received_props.minute_metrics, minute_metrics)
@record
def test_set_cors(self):
# Arrange
cors_rule1 = CorsRule(['www.xyz.com'], ['GET'])
allowed_origins = ['www.xyz.com', "www.ab.com", "www.bc.com"]
allowed_methods = ['GET', 'PUT']
max_age_in_seconds = 500
exposed_headers = ["x-ms-meta-data*", "x-ms-meta-source*", "x-ms-meta-abc", "x-ms-meta-bcd"]
allowed_headers = ["x-ms-meta-data*", "x-ms-meta-target*", "x-ms-meta-xyz", "x-ms-meta-foo"]
cors_rule2 = CorsRule(allowed_origins, allowed_methods, max_age_in_seconds,
exposed_headers, allowed_headers)
cors = [cors_rule1, cors_rule2]
# Act
self.bs.set_blob_service_properties(cors=cors)
# Assert
received_props = self.bs.get_blob_service_properties()
self._assert_cors_equal(received_props.cors, cors)
# --Test cases for errors ---------------------------------------
@record
def test_retention_no_days(self):
# Assert
self.assertRaises(ValueError,
RetentionPolicy,
True, None)
@record
def test_too_many_cors_rules(self):
# Arrange
cors = []
for i in range(0, 6):
cors.append(CorsRule(['www.xyz.com'], ['GET']))
# Assert
self.assertRaises(AzureHttpError,
self.bs.set_blob_service_properties,
None, None, None, cors)
@record
def test_retention_too_long(self):
# Arrange
minute_metrics = Metrics(enabled=True, include_apis=True,
retention_policy=RetentionPolicy(enabled=True, days=366))
# Assert
self.assertRaises(AzureHttpError,
self.bs.set_blob_service_properties,
None, None, minute_metrics)
# ------------------------------------------------------------------------------
if __name__ == '__main__':
unittest.main()
|
