feat: ✨ add env variable to help debug issues (#223)

# Description

I think we need to go through many types of error messages manually and
see if the way the error is presented via `explain` is helpful. This
debug option helps with that by always printing the properties dict, its
issues, and the output from `explain`. It also enables us to easily do
this on all test messages.

This is now easy to detect by running the test suite with the debug
option enabled, but we still need to make decision about what to do with
these errors by opening a new issue for each one of them and discuss the
best solutions.

Needs an in-depth review.

---------

Co-authored-by: Luke W. Johnston <lwjohnst86@users.noreply.github.com>

Author: joelostblom

justfile

@@ -42,6 +42,12 @@ test-python:
     -i coverage.xml \
     -o htmlcov/coverage.svg
 
+# View debug information for all tests
+# Used to e.g. view output of explain() rather than seeing which tests failed
+test-python-debug:
+  CDP_DEBUG=true uv run pytest -sv
+
+
 # Check Python code for any errors that need manual attention
 check-python:
   # Check formatting

src/check_datapackage/check.py

@@ -1,3 +1,4 @@
+import os
 import re
 import sys
 from dataclasses import dataclass, field
@@ -181,6 +182,13 @@ class for more details, especially about the default values.
     issues = exclude(issues, config.exclusions)
     issues = sorted(set(issues))
 
+    # Use by doing `CDP_DEBUG=true uv run ...`
+    if os.getenv("CDP_DEBUG"):
+        rprint("", properties)
+        for issue in issues:
+            rprint(issue)
+            rprint(explain([issue]))
+
     if error and issues:
         raise DataPackageError(issues)
 

tests/conftest.py

@@ -0,0 +1,15 @@
+import os
+
+
+# Can get debug output by using `CDP_DEBUG=true uv run pytest -sv`
+def pytest_report_teststatus(report, config):
+    if os.getenv("CDP_DEBUG"):
+        if report.when == "call":
+            # Add newlines to separate test results
+            category = report.outcome
+            shortletter = "\n\n"  # dot / F / X / etc.
+            verbose = "\n\n"  # ("PASSED", "FAILED", ...)
+
+            return category, shortletter, verbose
+
+    return None

tools/vulture-allowlist.py

@@ -4,3 +4,4 @@
 _check_not_required  # unused method (src/check_datapackage/extensions.py:59)
 _check_field_name_in_jsonpath  # unused method (src/check_datapackage/extensions.py:117)
 cls  # unused variable (src/check_datapackage/extensions.py:61)
+pytest_report_teststatus  # unused function (tests/conftest.py:4)