From 4069a46dfb70ca98d8b2dfb671673c41b0f7c2e5 Mon Sep 17 00:00:00 2001 From: Alex Schofield Date: Mon, 17 Feb 2025 15:58:14 +0000 Subject: add comments for description of obfuscator.py tests --- test/test_obfuscator.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) (limited to 'test/test_obfuscator.py') diff --git a/test/test_obfuscator.py b/test/test_obfuscator.py index c77b6b4..0245a26 100644 --- a/test/test_obfuscator.py +++ b/test/test_obfuscator.py @@ -1,6 +1,7 @@ from obfuscator.obfuscate import obfuscate - +# Check if the function can obfuscate valid PII fields in a list +# of dictionaries def test_obfuscate_data_with_valid_pii_fields(): data = [ { @@ -35,7 +36,8 @@ def test_obfuscate_data_with_valid_pii_fields(): result = obfuscate(data, pii_fields) assert result == expected - +# Check if the function can obfuscate data even when some PII +# fields are missing from some of the data def test_obfuscate_data_with_missing_pii_field(): data = [ {"student_id": "1234", "name": "John Smith", "course": "Software"}, @@ -60,7 +62,7 @@ def test_obfuscate_data_with_missing_pii_field(): result = obfuscate(data, pii_fields) assert result == expected - +# Check if the function can handle an empty list of data def test_obfuscate_data_with_no_data(): data = [] pii_fields = ["name", "email_address"] @@ -69,7 +71,7 @@ def test_obfuscate_data_with_no_data(): result = obfuscate(data, pii_fields) assert result == expected - +# Check if the function can handle an empty list of PII fields def test_obfuscate_data_with_empty_pii_fields(): data = [ { -- cgit v1.2.3 From 227b6a86d3658845441d13779d147d8892216618 Mon Sep 17 00:00:00 2001 From: Alex Schofield Date: Mon, 17 Feb 2025 16:01:46 +0000 Subject: add expected outputs and more detail to test descriptions in test_obfuscator --- test/test_obfuscator.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) (limited to 'test/test_obfuscator.py') diff --git a/test/test_obfuscator.py b/test/test_obfuscator.py index 0245a26..cc7d2c1 100644 --- a/test/test_obfuscator.py +++ b/test/test_obfuscator.py @@ -1,7 +1,7 @@ from obfuscator.obfuscate import obfuscate -# Check if the function can obfuscate valid PII fields in a list -# of dictionaries +# Check if the function does what its supposed to and can obfuscate +# valid PII fields in a list of dictionaries def test_obfuscate_data_with_valid_pii_fields(): data = [ { @@ -37,7 +37,8 @@ def test_obfuscate_data_with_valid_pii_fields(): assert result == expected # Check if the function can obfuscate data even when some PII -# fields are missing from some of the data +# fields are missing from some of the data, returning a list of dictionaries +# but with the missing PII fields obfuscated and the rest of the data intact def test_obfuscate_data_with_missing_pii_field(): data = [ {"student_id": "1234", "name": "John Smith", "course": "Software"}, @@ -62,7 +63,7 @@ def test_obfuscate_data_with_missing_pii_field(): result = obfuscate(data, pii_fields) assert result == expected -# Check if the function can handle an empty list of data +# Check if the function can handle an empty list of data, returning an empty list def test_obfuscate_data_with_no_data(): data = [] pii_fields = ["name", "email_address"] @@ -71,7 +72,8 @@ def test_obfuscate_data_with_no_data(): result = obfuscate(data, pii_fields) assert result == expected -# Check if the function can handle an empty list of PII fields +# Check if the function can handle an empty list of PII fields, returning the data as is +# without mutating it def test_obfuscate_data_with_empty_pii_fields(): data = [ { -- cgit v1.2.3