ehrql / Git / Diff of /tests/unit/test

Models:

philipB/

ehrql

Downloads: 1

Diff of /tests/unit/test_assurance.py [000000] .. [e988c2]

Switch to unified view

 b/tests/unit/test_assurance.py
+from datetime import date
+from ehrql import Dataset
+from ehrql.assurance import (
+    UNEXPECTED_IN_POPULATION,
+    UNEXPECTED_NOT_IN_POPULATION,
+    UNEXPECTED_OUTPUT_VALUE,
+    UNEXPECTED_TEST_VALUE,
+    present,
+    validate,
+)
+from ehrql.codes import SNOMEDCTCode
+from ehrql.tables import Constraint, EventFrame, PatientFrame, Series, table
+@table
+class patients(PatientFrame):
+    date_of_birth = Series(
+        date,
+        constraints=[Constraint.FirstOfMonth(), Constraint.NotNull()],
+    )
+    sex = Series(
+        str,
+        constraints=[
+            Constraint.Categorical(["female", "male", "intersex", "unknown"]),
+            Constraint.NotNull(),
+        ],
+    )
+@table
+class events(EventFrame):
+    date = Series(date)
+    code = Series(SNOMEDCTCode)
+dataset = Dataset()
+dataset.define_population(patients.date_of_birth.is_on_or_after("2000-01-01"))
+dataset.has_matching_event = events.where(
+    events.code == SNOMEDCTCode("11111111")
+).exists_for_patient()
+valid_test_data = {
+    # Correctly not expected in population
+: {
+        "patients": {"date_of_birth": date(1999, 12, 1)},
+        "events": [],
+        "expected_in_population": False,
+    },
+    # Incorrectly not expected in population
+: {
+        "patients": {"date_of_birth": date(2000, 1, 1)},
+        "events": [],
+        "expected_in_population": False,
+    },
+    # Incorrectly expected in population
+: {
+        "patients": {"date_of_birth": date(1999, 12, 1)},
+        "events": [{"date": date(2020, 1, 1), "code": "11111111"}],
+        "expected_columns": {
+            "has_matching_event": True,
+        },
+    },
+    # Has correct expected_columns
+: {
+        "patients": {"date_of_birth": date(2010, 1, 1)},
+        "events": [{"date": date(2020, 1, 1), "code": "11111111"}],
+        "expected_columns": {
+            "has_matching_event": True,
+        },
+    },
+    # Has incorrect expected_columns
+: {
+        "patients": {"date_of_birth": date(2010, 1, 1)},
+        "events": [{"date": date(2020, 1, 1), "code": "22222222"}],
+        "expected_columns": {
+            "has_matching_event": True,
+        },
+    },
+}
+invalid_test_data = {
+    # Has date_of_birth value that does not meet NotNull constraint
+: {
+        "patients": {"date_of_birth": None, "sex": "not-known"},
+        "events": [],
+        "expected_in_population": False,
+    },
+    # Has date_of_birth value that does not meet FirstOfMonth constraint
+: {
+        "patients": {"date_of_birth": date(1990, 1, 2)},
+        "events": [],
+        "expected_in_population": False,
+    },
+}
+valid_and_invalid_test_data = {
+    # Incorrectly not expected in population
+: {
+        "patients": {"date_of_birth": date(2000, 1, 1)},
+        "events": [],
+        "expected_in_population": False,
+    },
+    # Has date_of_birth value that does not meet FirstOfMonth constraint
+: {
+        "patients": {"date_of_birth": date(1990, 1, 2)},
+        "events": [],
+        "expected_in_population": False,
+    },
+}
+expected_valid_data_validation_results = {
+    "constraint_validation_errors": {},
+    "test_validation_errors": {
+: {"type": UNEXPECTED_IN_POPULATION},
+: {"type": UNEXPECTED_NOT_IN_POPULATION},
+: {
+            "type": UNEXPECTED_OUTPUT_VALUE,
+            "details": [
+                {
+                    "column": "has_matching_event",
+                    "expected": True,
+                    "actual": False,
+                }
+            ],
+        },
+    },
+}
+expected_invalid_data_validation_results = {
+    "constraint_validation_errors": {
+: {
+            "type": UNEXPECTED_TEST_VALUE,
+            "details": [
+                {
+                    "column": "date_of_birth",
+                    "constraint": "Constraint.NotNull()",
+                    "value": "None",
+                },
+                {
+                    "column": "sex",
+                    "constraint": "Constraint.Categorical(values=('female', 'male', 'intersex', 'unknown'))",
+                    "value": "not-known",
+                },
+            ],
+        },
+: {
+            "type": UNEXPECTED_TEST_VALUE,
+            "details": [
+                {
+                    "column": "date_of_birth",
+                    "constraint": "Constraint.FirstOfMonth()",
+                    "value": "1990-01-02",
+                }
+            ],
+        },
+    },
+    "test_validation_errors": {},
+}
+expected_valid_and_invalid_data_validation_results = {
+    "constraint_validation_errors": {
+: {
+            "type": UNEXPECTED_TEST_VALUE,
+            "details": [
+                {
+                    "column": "date_of_birth",
+                    "constraint": "Constraint.FirstOfMonth()",
+                    "value": "1990-01-02",
+                }
+            ],
+        },
+    },
+    "test_validation_errors": {
+: {"type": UNEXPECTED_IN_POPULATION},
+    },
+}
+def test_valid_data_validate():
+    assert (
+        validate(dataset._compile(), valid_test_data)
+        == expected_valid_data_validation_results
+    )
+def test_valid_data_present_with_errors():
+    assert (
+        present(expected_valid_data_validation_results).strip()
+        == """
+Validate test data: All OK!
+Validate results: Found errors with 3 patient(s)
+ * Patient 2 was unexpectedly in the population
+ * Patient 3 was unexpectedly not in the population
+ * Patient 5 had unexpected output value(s)
+   * for column 'has_matching_event', expected 'True', got 'False'
+    """.strip()
+    )
+def test_invalid_data_validate():
+    assert (
+        validate(dataset._compile(), invalid_test_data)
+        == expected_invalid_data_validation_results
+    )
+def test_invalid_data_present_with_errors():
+    assert (
+        present(expected_invalid_data_validation_results).strip()
+        == """
+Validate test data: Found errors with 2 patient(s)
+ * Patient 1 had 2 test data value(s) that did not meet the constraint(s)
+   * for column 'date_of_birth' with 'Constraint.NotNull()', got 'None'
+   * for column 'sex' with 'Constraint.Categorical(values=('female', 'male', 'intersex', 'unknown'))', got 'not-known'
+ * Patient 2 had 1 test data value(s) that did not meet the constraint(s)
+   * for column 'date_of_birth' with 'Constraint.FirstOfMonth()', got '1990-01-02'
+Validate results: All OK!
+    """.strip()
+    )
+def test_valid_and_invalid_data_validate():
+    assert (
+        validate(dataset._compile(), valid_and_invalid_test_data)
+        == expected_valid_and_invalid_data_validation_results
+    )
+def test_valid_and_invalid_data_present_with_errors():
+    assert (
+        present(expected_valid_and_invalid_data_validation_results).strip()
+        == """
+Validate test data: Found errors with 1 patient(s)
+ * Patient 2 had 1 test data value(s) that did not meet the constraint(s)
+   * for column 'date_of_birth' with 'Constraint.FirstOfMonth()', got '1990-01-02'
+Validate results: Found errors with 1 patient(s)
+ * Patient 1 was unexpectedly in the population
+    """.strip()
+    )
+def test_present_with_no_errors():
+    validation_results_with_no_errors = {
+        "constraint_validation_errors": {},
+        "test_validation_errors": {},
+    }
+    assert (
+        present(validation_results_with_no_errors).strip()
+        == """
+Validate test data: All OK!
+Validate results: All OK!""".strip()
+    )