feat: initial application release

tests/alerts_test.py

@@ -0,0 +1,155 @@
+# type: ignore
+"""Test alerts and logging."""
+import re
+
+import pytest
+
+from obsidian_metadata._utils import alerts
+from obsidian_metadata._utils.alerts import logger as log
+from tests.helpers import Regex
+
+
+def test_dryrun(capsys):
+    """Test dry run."""
+    alerts.dryrun("This prints in dry run")
+    captured = capsys.readouterr()
+    assert captured.out == "DRYRUN   | This prints in dry run\n"
+
+
+def test_success(capsys):
+    """Test success."""
+    alerts.success("This prints in success")
+    captured = capsys.readouterr()
+    assert captured.out == "SUCCESS  | This prints in success\n"
+
+
+def test_error(capsys):
+    """Test success."""
+    alerts.error("This prints in error")
+    captured = capsys.readouterr()
+    assert captured.out == "ERROR    | This prints in error\n"
+
+
+def test_warning(capsys):
+    """Test warning."""
+    alerts.warning("This prints in warning")
+    captured = capsys.readouterr()
+    assert captured.out == "WARNING  | This prints in warning\n"
+
+
+def test_notice(capsys):
+    """Test notice."""
+    alerts.notice("This prints in notice")
+    captured = capsys.readouterr()
+    assert captured.out == "NOTICE   | This prints in notice\n"
+
+
+def test_info(capsys):
+    """Test info."""
+    alerts.info("This prints in info")
+    captured = capsys.readouterr()
+    assert captured.out == "INFO     | This prints in info\n"
+
+
+def test_dim(capsys):
+    """Test info."""
+    alerts.dim("This prints in dim")
+    captured = capsys.readouterr()
+    assert captured.out == "This prints in dim\n"
+
+
+@pytest.mark.parametrize(
+    ("verbosity", "log_to_file"),
+    [(0, False), (1, False), (2, True), (3, True)],
+)
+def test_logging(capsys, tmp_path, verbosity, log_to_file) -> None:
+    """Test logging."""
+    tmp_log = tmp_path / "tmp.log"
+    logging = alerts.LoggerManager(
+        log_file=tmp_log,
+        verbosity=verbosity,
+        log_to_file=log_to_file,
+    )
+
+    assert logging.verbosity == verbosity
+
+    if verbosity >= 3:
+        assert logging.is_trace() is True
+        captured = capsys.readouterr()
+        assert captured.out == ""
+
+        assert logging.is_trace("trace text") is True
+        captured = capsys.readouterr()
+        assert captured.out == "trace text\n"
+
+        log.trace("This is Trace logging")
+        captured = capsys.readouterr()
+        assert captured.err == Regex(r"^TRACE    \| This is Trace logging \([\w\._:]+:\d+\)$")
+    else:
+        assert logging.is_trace("trace text") is False
+        captured = capsys.readouterr()
+        assert captured.out != "trace text\n"
+
+        log.trace("This is Trace logging")
+        captured = capsys.readouterr()
+        assert captured.err != Regex(r"^TRACE    \| This is Trace logging \([\w\._:]+:\d+\)$")
+
+    if verbosity >= 2:
+        assert logging.is_debug() is True
+        captured = capsys.readouterr()
+        assert captured.out == ""
+
+        assert logging.is_debug("debug text") is True
+        captured = capsys.readouterr()
+        assert captured.out == "debug text\n"
+
+        log.debug("This is Debug logging")
+        captured = capsys.readouterr()
+        assert captured.err == Regex(r"^DEBUG    \| This is Debug logging \([\w\._:]+:\d+\)$")
+    else:
+        assert logging.is_debug("debug text") is False
+        captured = capsys.readouterr()
+        assert captured.out != "debug text\n"
+
+        log.debug("This is Debug logging")
+        captured = capsys.readouterr()
+        assert captured.err != Regex(r"^DEBUG    \| This is Debug logging \([\w\._:]+:\d+\)$")
+
+    if verbosity >= 1:
+        assert logging.is_info() is True
+        captured = capsys.readouterr()
+        assert captured.out == ""
+
+        assert logging.is_info("info text") is True
+        captured = capsys.readouterr()
+        assert captured.out == "info text\n"
+
+        log.info("This is Info logging")
+        captured = capsys.readouterr()
+        assert captured.err == "INFO     | This is Info logging\n"
+    else:
+        assert logging.is_info("info text") is False
+        captured = capsys.readouterr()
+        assert captured.out != "info text\n"
+
+        log.info("This is Info logging")
+        captured = capsys.readouterr()
+        assert captured.out == ""
+
+    assert logging.is_default() is True
+    captured = capsys.readouterr()
+    assert captured.out == ""
+
+    assert logging.is_default("default text") is True
+    captured = capsys.readouterr()
+    assert captured.out == "default text\n"
+
+    if log_to_file:
+        assert tmp_log.exists() is True
+        log_file_content = tmp_log.read_text()
+        assert log_file_content == Regex(
+            r"^\d{4}-\d{2}-\d{2} \d+:\d+:\d+\.\d+ \| DEBUG    \| [\w\.:]+:\d+ \- Logging to file:",
+            re.MULTILINE,
+        )
+    else:
+        assert tmp_log.exists() is False