Skip to content

Commit 4786890

Browse files
authored
[KV] Update logging tests (Azure#21454)
1 parent ab34056 commit 4786890

File tree

6 files changed

+112
-52
lines changed

6 files changed

+112
-52
lines changed

sdk/keyvault/azure-keyvault-certificates/tests/test_certificates_client.py

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -596,16 +596,20 @@ def test_logging_enabled(self, client, **kwargs):
596596

597597
for message in mock_handler.messages:
598598
if message.levelname == "DEBUG" and message.funcName == "on_request":
599-
messages_request = message.message.split("/n")
600-
for m in messages_request:
599+
# parts of the request are logged on new lines in a single message
600+
request_sections = message.message.split("/n")
601+
for section in request_sections:
601602
try:
602-
body = json.loads(m)
603+
# the body of the request should be JSON
604+
body = json.loads(section)
603605
if body["provider"] == "Test":
606+
mock_handler.close()
604607
return
605608
except (ValueError, KeyError):
606-
# this means the message is not JSON or has no kty property
609+
# this means the request section is not JSON
607610
pass
608611

612+
mock_handler.close()
609613
assert False, "Expected request body wasn't logged"
610614

611615
@logging_disabled()
@@ -622,15 +626,21 @@ def test_logging_disabled(self, client, **kwargs):
622626

623627
for message in mock_handler.messages:
624628
if message.levelname == "DEBUG" and message.funcName == "on_request":
625-
messages_request = message.message.split("/n")
626-
for m in messages_request:
629+
# parts of the request are logged on new lines in a single message
630+
request_sections = message.message.split("/n")
631+
for section in request_sections:
627632
try:
628-
body = json.loads(m)
629-
assert body["provider"] != "Test", "Client request body was logged"
633+
# the body of the request should be JSON
634+
body = json.loads(section)
635+
if body["provider"] == "Test":
636+
mock_handler.close()
637+
assert False, "Client request body was logged"
630638
except (ValueError, KeyError):
631-
# this means the message is not JSON or has no kty property
639+
# this means the request section is not JSON
632640
pass
633641

642+
mock_handler.close()
643+
634644
@only_2016_10_01()
635645
@client_setup
636646
def test_models(self, client, **kwargs):

sdk/keyvault/azure-keyvault-certificates/tests/test_certificates_client_async.py

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -602,16 +602,20 @@ async def test_logging_enabled(self, client, **kwargs):
602602

603603
for message in mock_handler.messages:
604604
if message.levelname == "DEBUG" and message.funcName == "on_request":
605-
messages_request = message.message.split("/n")
606-
for m in messages_request:
605+
# parts of the request are logged on new lines in a single message
606+
request_sections = message.message.split("/n")
607+
for section in request_sections:
607608
try:
608-
body = json.loads(m)
609+
# the body of the request should be JSON
610+
body = json.loads(section)
609611
if body["provider"] == "Test":
612+
mock_handler.close()
610613
return
611614
except (ValueError, KeyError):
612-
# this means the message is not JSON or has no kty property
615+
# this means the request section is not JSON
613616
pass
614617

618+
mock_handler.close()
615619
assert False, "Expected request body wasn't logged"
616620

617621
@logging_disabled()
@@ -628,15 +632,21 @@ async def test_logging_disabled(self, client, **kwargs):
628632

629633
for message in mock_handler.messages:
630634
if message.levelname == "DEBUG" and message.funcName == "on_request":
631-
messages_request = message.message.split("/n")
632-
for m in messages_request:
635+
# parts of the request are logged on new lines in a single message
636+
request_sections = message.message.split("/n")
637+
for section in request_sections:
633638
try:
634-
body = json.loads(m)
635-
assert body["provider"] != "Test", "Client request body was logged"
639+
# the body of the request should be JSON
640+
body = json.loads(section)
641+
if body["provider"] == "Test":
642+
mock_handler.close()
643+
assert False, "Client request body was logged"
636644
except (ValueError, KeyError):
637-
# this means the message is not JSON or has no kty property
645+
# this means the request section is not JSON
638646
pass
639647

648+
mock_handler.close()
649+
640650
@all_api_versions()
641651
@client_setup
642652
async def test_get_certificate_version(self, client, **kwargs):

sdk/keyvault/azure-keyvault-keys/tests/test_key_client.py

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -426,17 +426,21 @@ def test_logging_enabled(self, client, is_hsm, **kwargs):
426426

427427
for message in mock_handler.messages:
428428
if message.levelname == "DEBUG" and message.funcName == "on_request":
429-
messages_request = message.message.split("/n")
430-
for m in messages_request:
429+
# parts of the request are logged on new lines in a single message
430+
request_sections = message.message.split("/n")
431+
for section in request_sections:
431432
try:
432-
body = json.loads(m)
433+
# the body of the request should be JSON
434+
body = json.loads(section)
433435
expected_kty = "RSA-HSM" if is_hsm else "RSA"
434436
if body["kty"] == expected_kty:
437+
mock_handler.close()
435438
return
436439
except (ValueError, KeyError):
437-
# this means the message is not JSON or has no kty property
440+
# this means the request section is not JSON or has no kty property
438441
pass
439442

443+
mock_handler.close()
440444
assert False, "Expected request body wasn't logged"
441445

442446
@logging_disabled()
@@ -453,16 +457,22 @@ def test_logging_disabled(self, client, is_hsm, **kwargs):
453457

454458
for message in mock_handler.messages:
455459
if message.levelname == "DEBUG" and message.funcName == "on_request":
456-
messages_request = message.message.split("/n")
457-
for m in messages_request:
460+
# parts of the request are logged on new lines in a single message
461+
request_sections = message.message.split("/n")
462+
for section in request_sections:
458463
try:
459-
body = json.loads(m)
464+
# the body of the request should be JSON
465+
body = json.loads(section)
460466
expected_kty = "RSA-HSM" if is_hsm else "RSA"
461-
assert body["kty"] != expected_kty, "Client request body was logged"
467+
if body["kty"] == expected_kty:
468+
mock_handler.close()
469+
assert False, "Client request body was logged"
462470
except (ValueError, KeyError):
463-
# this means the message is not JSON or has no kty property
471+
# this means the request section is not JSON or has no kty property
464472
pass
465473

474+
mock_handler.close()
475+
466476
@only_hsm_7_3_preview()
467477
@client_setup
468478
def test_get_random_bytes(self, client, **kwargs):

sdk/keyvault/azure-keyvault-keys/tests/test_keys_async.py

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -423,17 +423,21 @@ async def test_logging_enabled(self, client, is_hsm, **kwargs):
423423

424424
for message in mock_handler.messages:
425425
if message.levelname == "DEBUG" and message.funcName == "on_request":
426-
messages_request = message.message.split("/n")
427-
for m in messages_request:
426+
# parts of the request are logged on new lines in a single message
427+
request_sections = message.message.split("/n")
428+
for section in request_sections:
428429
try:
429-
body = json.loads(m)
430+
# the body of the request should be JSON
431+
body = json.loads(section)
430432
expected_kty = "RSA-HSM" if is_hsm else "RSA"
431433
if body["kty"] == expected_kty:
434+
mock_handler.close()
432435
return
433436
except (ValueError, KeyError):
434-
# this means the message is not JSON or has no kty property
437+
# this means the request section is not JSON or has no kty property
435438
pass
436439

440+
mock_handler.close()
437441
assert False, "Expected request body wasn't logged"
438442

439443
@logging_disabled()
@@ -450,16 +454,22 @@ async def test_logging_disabled(self, client, is_hsm, **kwargs):
450454

451455
for message in mock_handler.messages:
452456
if message.levelname == "DEBUG" and message.funcName == "on_request":
453-
messages_request = message.message.split("/n")
454-
for m in messages_request:
457+
# parts of the request are logged on new lines in a single message
458+
request_sections = message.message.split("/n")
459+
for section in request_sections:
455460
try:
456-
body = json.loads(m)
461+
# the body of the request should be JSON
462+
body = json.loads(section)
457463
expected_kty = "RSA-HSM" if is_hsm else "RSA"
458-
assert body["kty"] != expected_kty, "Client request body was logged"
464+
if body["kty"] == expected_kty:
465+
mock_handler.close()
466+
assert False, "Client request body was logged"
459467
except (ValueError, KeyError):
460-
# this means the message is not JSON or has no kty property
468+
# this means the request section is not JSON or has no kty property
461469
pass
462470

471+
mock_handler.close()
472+
463473
@only_hsm_7_3_preview()
464474
@client_setup
465475
async def test_get_random_bytes(self, client, **kwargs):

sdk/keyvault/azure-keyvault-secrets/tests/test_secrets_async.py

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -291,16 +291,20 @@ async def test_logging_enabled(self, client, **kwargs):
291291

292292
for message in mock_handler.messages:
293293
if message.levelname == "DEBUG" and message.funcName == "on_request":
294-
messages_request = message.message.split("/n")
295-
for m in messages_request:
294+
# parts of the request are logged on new lines in a single message
295+
request_sections = message.message.split("/n")
296+
for section in request_sections:
296297
try:
297-
body = json.loads(m)
298+
# the body of the request should be JSON
299+
body = json.loads(section)
298300
if body["value"] == "secret-value":
301+
mock_handler.close()
299302
return
300303
except (ValueError, KeyError):
301-
# this means the message is not JSON or has no kty property
304+
# this means the request section is not JSON
302305
pass
303306

307+
mock_handler.close()
304308
assert False, "Expected request body wasn't logged"
305309

306310
@logging_disabled()
@@ -317,15 +321,21 @@ async def test_logging_disabled(self, client, **kwargs):
317321

318322
for message in mock_handler.messages:
319323
if message.levelname == "DEBUG" and message.funcName == "on_request":
320-
messages_request = message.message.split("/n")
321-
for m in messages_request:
324+
# parts of the request are logged on new lines in a single message
325+
request_sections = message.message.split("/n")
326+
for section in request_sections:
322327
try:
323-
body = json.loads(m)
324-
assert body["value"] != "secret-value", "Client request body was logged"
328+
# the body of the request should be JSON
329+
body = json.loads(section)
330+
if body["value"] == "secret-value":
331+
mock_handler.close()
332+
assert False, "Client request body was logged"
325333
except (ValueError, KeyError):
326334
# this means the message is not JSON or has no kty property
327335
pass
328336

337+
mock_handler.close()
338+
329339

330340
def test_service_headers_allowed_in_logs():
331341
service_headers = {"x-ms-keyvault-network-info", "x-ms-keyvault-region", "x-ms-keyvault-service-version"}

sdk/keyvault/azure-keyvault-secrets/tests/test_secrets_client.py

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -297,16 +297,20 @@ def test_logging_enabled(self, client, **kwargs):
297297

298298
for message in mock_handler.messages:
299299
if message.levelname == "DEBUG" and message.funcName == "on_request":
300-
messages_request = message.message.split("/n")
301-
for m in messages_request:
300+
# parts of the request are logged on new lines in a single message
301+
request_sections = message.message.split("/n")
302+
for section in request_sections:
302303
try:
303-
body = json.loads(m)
304+
# the body of the request should be JSON
305+
body = json.loads(section)
304306
if body["value"] == "secret-value":
307+
mock_handler.close()
305308
return
306309
except (ValueError, KeyError):
307-
# this means the message is not JSON or has no kty property
310+
# this means the request section is not JSON
308311
pass
309312

313+
mock_handler.close()
310314
assert False, "Expected request body wasn't logged"
311315

312316
@logging_disabled()
@@ -323,15 +327,21 @@ def test_logging_disabled(self, client, **kwargs):
323327

324328
for message in mock_handler.messages:
325329
if message.levelname == "DEBUG" and message.funcName == "on_request":
326-
messages_request = message.message.split("/n")
327-
for m in messages_request:
330+
# parts of the request are logged on new lines in a single message
331+
request_sections = message.message.split("/n")
332+
for section in request_sections:
328333
try:
329-
body = json.loads(m)
330-
assert body["value"] != "secret-value", "Client request body was logged"
334+
# the body of the request should be JSON
335+
body = json.loads(section)
336+
if body["value"] == "secret-value":
337+
mock_handler.close()
338+
assert False, "Client request body was logged"
331339
except (ValueError, KeyError):
332340
# this means the message is not JSON or has no kty property
333341
pass
334342

343+
mock_handler.close()
344+
335345

336346
def test_service_headers_allowed_in_logs():
337347
service_headers = {"x-ms-keyvault-network-info", "x-ms-keyvault-region", "x-ms-keyvault-service-version"}

0 commit comments

Comments
 (0)