aboutsummaryrefslogtreecommitdiffstats
path: root/test
diff options
context:
space:
mode:
Diffstat (limited to 'test')
-rw-r--r--test/test_csv_reader.py20
-rw-r--r--test/test_obfuscator.py12
2 files changed, 16 insertions, 16 deletions
diff --git a/test/test_csv_reader.py b/test/test_csv_reader.py
index e62c093..1b3d071 100644
--- a/test/test_csv_reader.py
+++ b/test/test_csv_reader.py
@@ -2,25 +2,27 @@
# Author: Alex Schofield
from obfuscator.csv_reader import CSVReader
-import pytest
reader = CSVReader()
-
+# Check if the function can read a CSV string with no content and return
+# an empty list
def test_empty_csv_should_return_no_content():
content = ""
result = reader.read_string(content)
expected = []
assert result == expected
-
+# Check if the function can read a CSV string with only a header and return
+# an empty list
def test_csv_with_header_only_should_return_no_content():
content = "student_id,name,course\n"
result = reader.read_string(content)
expected = []
assert result == expected
-
+# Check if the function can read a CSV string with valid data and return
+# a list of dictionaries
def test_csv_with_valid_data():
content = (
"student_id,name,course\n"
@@ -34,7 +36,8 @@ def test_csv_with_valid_data():
]
assert result == expected
-
+# Check if the function can read a CSV string with quoted fields and return
+# a list of dictionaries with the quoted fields intact
def test_csv_with_quoted_fields_should_run_as_expected():
content = (
"student_id,name,course\n"
@@ -47,10 +50,3 @@ def test_csv_with_quoted_fields_should_run_as_expected():
{"student_id": "5678", "name": "Student 2", "course": "Course 2"},
]
assert result == expected
-
-
-def test_non_csv_file_should_return_no_content():
- content = ""
- result = reader.read_string(content)
- expected = []
- assert result == expected
diff --git a/test/test_obfuscator.py b/test/test_obfuscator.py
index c77b6b4..cc7d2c1 100644
--- a/test/test_obfuscator.py
+++ b/test/test_obfuscator.py
@@ -1,6 +1,7 @@
from obfuscator.obfuscate import obfuscate
-
+# 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 = [
{
@@ -35,7 +36,9 @@ 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, 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"},
@@ -60,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, returning an empty list
def test_obfuscate_data_with_no_data():
data = []
pii_fields = ["name", "email_address"]
@@ -69,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, returning the data as is
+# without mutating it
def test_obfuscate_data_with_empty_pii_fields():
data = [
{
git.ajschof.me — hosted by ajschofield — powered by cgit