Skip tests if git crypt is locked

.gitattributes

@@ -1 +1,2 @@
 tests/integration/banks/**/input.pdf filter=git-crypt diff=git-crypt
+tests/integration/banks/.gc_check filter=git-crypt diff=git-crypt

pyproject.toml

@@ -6,6 +6,7 @@ repository = "https://github.com/benjamin-awd/monopoly"
 authors = ["benjamin-awd <[email protected]>"]
 packages = [
     { include = "monopoly", from = "src" },
+    { include = "test_utils", from = "tests" }
 ]
 license = "MIT"
 readme = "README.md"

tests/integration/banks/test_banks.py

@@ -4,6 +4,7 @@
 import pandas as pd
 import pytest
 from pandas.testing import assert_frame_equal
+from test_utils.skip import skip_if_encrypted
 
 from monopoly.banks import Citibank, Dbs, Hsbc, Ocbc, StandardChartered
 from monopoly.banks.base import BankBase
@@ -12,6 +13,7 @@
 from monopoly.statement import Statement
 
 
+@skip_if_encrypted
 @pytest.mark.parametrize(
     "bank_class, total_amount, statement_date",
     [

tests/test_utils/__init__.py

@@ -0,0 +1,3 @@
+from .skip import skip_if_encrypted
+
+__all__ = ["skip_if_encrypted"]

tests/test_utils/skip.py

@@ -0,0 +1,27 @@
+import logging
+from functools import wraps
+
+import pytest
+
+logger = logging.getLogger(__name__)
+
+
+def skip_if_encrypted(func=None):
+    """Helper function to skip tests if files are not unlocked with `git-crypt`"""
+
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        try:
+            with open("tests/integration/banks/.gc_check") as f:
+                contents = f.read()
+                if contents != "unlocked":
+                    raise ValueError("Invalid contents")
+        except UnicodeDecodeError as err:
+            logger.warning(err)
+            pytest.skip(
+                "Test requires decrypted files. "
+                "Please run 'git-crypt unlock <KEYFILE>'"
+            )
+        return func(*args, **kwargs)
+
+    return wrapper if func else skip_if_encrypted

tests/unit/test_auto_detect_bank.py

@@ -1,4 +1,5 @@
 from pytest import raises
+from test_utils.skip import skip_if_encrypted
 
 from monopoly.banks import auto_detect_bank
 from monopoly.banks.base import BankBase
@@ -30,6 +31,7 @@ class MockBankTwo(BankBase):
 encrypted_file_path = "tests/integration/fixtures/protected.pdf"
 
 
+@skip_if_encrypted
 def test_auto_detect_unencrypted_bank_identified(
     monkeypatch, file_path: str = unencrypted_file_path
 ):
@@ -52,6 +54,7 @@ def test_auto_detect_encrypted_bank_identified(
     assert isinstance(bank_instance, MockBankOne)
 
 
+@skip_if_encrypted
 def test_auto_detect_bank_not_identified(
     monkeypatch, file_path: str = unencrypted_file_path
 ):