Files
parsedmarc/tests/test_cli.py
T
35e51218b9 Don't archive/delete mailbox messages until output destinations confirm the save (#863)
* Don't archive/delete mailbox messages until output destinations confirm the save (#242)

get_dmarc_reports_from_mailbox() gains a keyword-only save_callback,
invoked once per fetched batch before any message is deleted or moved.
A False return (or an exception) marks the batch unsaved: its messages
stay in the reports folder for retry, and the aggregate-report dedup
keys staged for that batch are dropped so the retry reparses instead of
skipping. watch_inbox() passes its callback through as save_callback,
so watch mode gets the same protection.

To bound duplicate delivery to destinations that don't deduplicate, a
new [mailbox] max_unsaved_retries option (default 2) caps retries: a
message whose batch has failed the initial attempt plus that many
retries moves to {archive_folder}/Unsaved -- never deleted, whatever
the delete options say. Counts are process-local, so the cap applies
across watch-mode checks; one-shot runs retry indefinitely, which is
the safe direction. A raising callback (the CLI's, under
fail_on_output_error) is counted against the cap the same way before
the exception is re-raised, since mailsuite's IMAP and Maildir watch
loops swallow exceptions and keep checking.

CLI: process_reports() now returns its output-error list and the
mailbox_save_callback adapter feeds that verdict to the library;
save_output() failures (the one uncaught destination) are recorded like
every other sink's; file/mbox-derived reports are saved in a separate
pass from mailbox batches so nothing is saved twice; the combined
results fed to email_results() are filtered by index_prefix_domain_map
explicitly, restoring the SMTP TLS filtering the emailed summary lost
when saving moved into per-batch callbacks.

Credit to @mkilijanek for the original approach in #823.

Fixes #242

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* Address automated review feedback on #863

- Keep a message's failure counter until its move to Unsaved actually
  succeeds. The counter was popped when the message was classified
  over-cap, before the move was attempted, so a failed move handed the
  still-in-place message a fresh set of under-cap retries and duplicate
  deliveries; now the next failed save classifies it over-cap again and
  re-attempts the move. Regression-tested at cap 1, where the reset
  would observably leave the message in the INBOX instead of moving it.
- Use sys.exit(1) instead of the site-dependent exit() built-in in the
  two new ParserError handlers.
- Close the sample files opened by the new Maildir tests via context
  managers.
- Keep the docs' section-link text on one line and fix the adjacent
  pre-existing "a IMAP" typo.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* Address Copilot re-review feedback on #863

- Document mailbox_save_callback's raise path: with fail_on_output_error
  it raises ParserError via process_reports() instead of returning
  False, and the library counts that as an unsaved batch too.
- Use str(error_) instead of error_.__str__() in the new File output
  handler.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* Reject negative max_unsaved_retries with a ValueError

The option is user-configurable (INI/env/kwarg); a negative value
silently behaved like 0. Both get_dmarc_reports_from_mailbox() and
watch_inbox() now validate it at the door alongside the existing
test/delete guard. watch_inbox() validates before entering the watch
loop, because a ValueError raised inside a check would be swallowed
and endlessly retried by the IMAP and Maildir backends' per-check
exception handling instead of surfacing.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* Fix two pre-existing bugs surfaced by review of #863

- MAGIC_JSON was b"\7b" -- the octal escape \7 (BEL) plus a literal
  "b", not 0x7B, the "{" every RFC 8259 JSON object begins with -- so
  extract_report() rejected plain uncompressed JSON. Every in-tree
  caller pre-guarded with its own zip/gzip or "{" check, masking the
  dead branch; the practical impact was extract_report() as a public
  API and application/tlsrpt+gzip attachments whose payload is really
  uncompressed JSON. Now b"\x7b".

- get_index_prefix() unconditionally indexed policies[0], while
  parse_smtp_tls_report_json() accepts a report whose policies list is
  empty -- an IndexError crash whenever index_prefix_domain_map was
  configured. An empty-policies report has no domain to map, so it is
  now treated as unmappable and excluded from prefix-mapped output.
  This code was moved into filter_smtp_tls_reports_for_index_prefix()
  by this PR, which widened its exposure to the email_results() path.

Both regression tests were verified to fail against the unfixed code.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* Rewrap the max_unsaved_retries docstring paragraph

The ValueError sentence was inserted without reflowing, leaving a
112-character line in a docstring wrapped at ~76; ruff formats code,
not docstring prose, so it slipped through lint.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-26 17:07:03 -04:00

6365 lines
240 KiB
Python

"""Tests for parsedmarc.cli — CLI entry point, config parsing,
env-var overrides, mailbox watch wiring, and SIGHUP reload."""
import io
import json
import logging
import os
import signal
import stat
import sys
import tempfile
import unittest
import zipfile
from configparser import ConfigParser
from tempfile import NamedTemporaryFile
from types import SimpleNamespace
from typing import cast
from unittest.mock import MagicMock, patch
import httpx
from azure.core.exceptions import ClientAuthenticationError
from msgraph.generated.models.o_data_errors.inner_error import InnerError
from msgraph.generated.models.o_data_errors.main_error import MainError
from msgraph.generated.models.o_data_errors.o_data_error import ODataError
import parsedmarc
import parsedmarc.cli
import parsedmarc.elastic
import parsedmarc.opensearch as opensearch_module
from parsedmarc.types import AggregateReport, ParsedReport
SAMPLE_AGGREGATE_REPORT_PATH = (
"samples/aggregate/!example.com!1538204542!1538463818.xml"
)
def _sample_aggregate_reports() -> list[AggregateReport]:
"""Parses a real sample aggregate report so tests that exercise the
real zip/CSV-building code path (email_results / email_results_via_msgraph)
have a fully valid AggregateReport rather than a hand-built partial
dict that would fail in parsed_aggregate_reports_to_csv_rows()."""
result = parsedmarc.parse_report_file(SAMPLE_AGGREGATE_REPORT_PATH, offline=True)
assert result["report_type"] == "aggregate"
return [cast(AggregateReport, result["report"])]
def _fetch_invoking_save_callback(reports, *, batch=None):
"""Build a ``get_dmarc_reports_from_mailbox`` mock side effect that
honors the real contract: every fetched batch is handed to
``save_callback`` *before* the function returns, and the accumulated
results are returned afterward.
A plain ``return_value`` mock would leave ``save_callback`` uncalled, so
nothing would ever be written to any output destination -- which is not
how the CLI behaves against a real mailbox since #242.
``batch`` overrides what the callback receives, for tests that need the
batch dict to be a distinct object from the returned results (the real
function builds its return value from its own accumulated lists, not
from the dict it passed to the callback).
"""
def _fetch_and_save(**kwargs):
kwargs["save_callback"](reports if batch is None else batch)
return reports
return _fetch_and_save
class _BreakLoop(BaseException):
pass
class _DummyMailboxConnection(parsedmarc.MailboxConnection):
def __init__(self):
self.fetch_calls: list[dict[str, object]] = []
def create_folder(self, folder_name: str):
return None
def fetch_messages(self, reports_folder: str, **kwargs):
self.fetch_calls.append({"reports_folder": reports_folder, **kwargs})
return []
def fetch_message(self, message_id, **kwargs) -> str:
return ""
def delete_message(self, message_id):
return None
def move_message(self, message_id, folder_name: str):
return None
def keepalive(self):
return None
def watch(self, check_callback, check_timeout, config_reloading=None):
return None
class Test(unittest.TestCase):
"""Kitchen-sink tests redistributed from the original
tests.py monolith. Future PRs should split these further
into purpose-specific TestCase subclasses as natural
groupings emerge."""
def testOpenSearchSigV4RequiresRegion(self):
with self.assertRaises(opensearch_module.OpenSearchError):
opensearch_module.set_hosts(
"https://example.org:9200",
auth_type="awssigv4",
)
def testOpenSearchSigV4ConfiguresConnectionClass(self):
fake_credentials = object()
with patch.object(opensearch_module.boto3, "Session") as session_cls:
session_cls.return_value.get_credentials.return_value = fake_credentials
with patch.object(
opensearch_module, "AWSV4SignerAuth", return_value="auth"
) as signer:
with patch.object(
opensearch_module.connections, "create_connection"
) as create_connection:
opensearch_module.set_hosts(
"https://example.org:9200",
use_ssl=True,
auth_type="awssigv4",
aws_region="eu-west-1",
)
signer.assert_called_once_with(fake_credentials, "eu-west-1", "es")
create_connection.assert_called_once()
self.assertEqual(
create_connection.call_args.kwargs.get("connection_class"),
opensearch_module.RequestsHttpConnection,
)
self.assertEqual(create_connection.call_args.kwargs.get("http_auth"), "auth")
def testOpenSearchSigV4RejectsUnknownAuthType(self):
with self.assertRaises(opensearch_module.OpenSearchError):
opensearch_module.set_hosts(
"https://example.org:9200",
auth_type="kerberos",
)
def testOpenSearchSigV4RequiresAwsCredentials(self):
with patch.object(opensearch_module.boto3, "Session") as session_cls:
session_cls.return_value.get_credentials.return_value = None
with self.assertRaises(opensearch_module.OpenSearchError):
opensearch_module.set_hosts(
"https://example.org:9200",
auth_type="awssigv4",
aws_region="eu-west-1",
)
@patch("parsedmarc.cli.opensearch.migrate_indexes")
@patch("parsedmarc.cli.opensearch.set_hosts")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.IMAPConnection")
def testCliPassesOpenSearchSigV4Settings(
self,
mock_imap_connection,
mock_get_reports,
mock_set_hosts,
_mock_migrate_indexes,
):
mock_imap_connection.return_value = object()
mock_get_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
config = """[general]
save_aggregate = true
silent = true
[imap]
host = imap.example.com
user = test-user
password = test-password
[opensearch]
hosts = localhost
authentication_type = awssigv4
aws_region = eu-west-1
aws_service = aoss
"""
with tempfile.NamedTemporaryFile(
"w", suffix=".ini", delete=False
) as config_file:
config_file.write(config)
config_path = config_file.name
self.addCleanup(lambda: os.path.exists(config_path) and os.remove(config_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", config_path]):
parsedmarc.cli._main()
self.assertEqual(mock_set_hosts.call_args.kwargs.get("auth_type"), "awssigv4")
self.assertEqual(mock_set_hosts.call_args.kwargs.get("aws_region"), "eu-west-1")
self.assertEqual(mock_set_hosts.call_args.kwargs.get("aws_service"), "aoss")
@patch("parsedmarc.cli.elastic.save_aggregate_report_to_elasticsearch")
@patch("parsedmarc.cli.elastic.migrate_indexes")
@patch("parsedmarc.cli.elastic.set_hosts")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.IMAPConnection")
def testFailOnOutputErrorExits(
self,
mock_imap_connection,
mock_get_reports,
_mock_set_hosts,
_mock_migrate_indexes,
mock_save_aggregate,
):
"""CLI should exit with code 1 when fail_on_output_error is enabled"""
mock_imap_connection.return_value = object()
mock_get_reports.side_effect = _fetch_invoking_save_callback(
{
"aggregate_reports": [{"policy_published": {"domain": "example.com"}}],
"failure_reports": [],
"smtp_tls_reports": [],
}
)
mock_save_aggregate.side_effect = parsedmarc.elastic.ElasticsearchError(
"simulated output failure"
)
config = """[general]
save_aggregate = true
fail_on_output_error = true
silent = true
[imap]
host = imap.example.com
user = test-user
password = test-password
[elasticsearch]
hosts = localhost
"""
with tempfile.NamedTemporaryFile(
"w", suffix=".ini", delete=False
) as config_file:
config_file.write(config)
config_path = config_file.name
self.addCleanup(lambda: os.path.exists(config_path) and os.remove(config_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", config_path]):
with self.assertRaises(SystemExit) as ctx:
parsedmarc.cli._main()
self.assertEqual(ctx.exception.code, 1)
mock_save_aggregate.assert_called_once()
@patch("parsedmarc.cli.elastic.save_aggregate_report_to_elasticsearch")
@patch("parsedmarc.cli.elastic.migrate_indexes")
@patch("parsedmarc.cli.elastic.set_hosts")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.IMAPConnection")
def testOutputErrorDoesNotExitWhenDisabled(
self,
mock_imap_connection,
mock_get_reports,
_mock_set_hosts,
_mock_migrate_indexes,
mock_save_aggregate,
):
mock_imap_connection.return_value = object()
mock_get_reports.side_effect = _fetch_invoking_save_callback(
{
"aggregate_reports": [{"policy_published": {"domain": "example.com"}}],
"failure_reports": [],
"smtp_tls_reports": [],
}
)
mock_save_aggregate.side_effect = parsedmarc.elastic.ElasticsearchError(
"simulated output failure"
)
config = """[general]
save_aggregate = true
fail_on_output_error = false
silent = true
[imap]
host = imap.example.com
user = test-user
password = test-password
[elasticsearch]
hosts = localhost
"""
with tempfile.NamedTemporaryFile(
"w", suffix=".ini", delete=False
) as config_file:
config_file.write(config)
config_path = config_file.name
self.addCleanup(lambda: os.path.exists(config_path) and os.remove(config_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", config_path]):
parsedmarc.cli._main()
mock_save_aggregate.assert_called_once()
@patch("parsedmarc.cli.opensearch.save_failure_report_to_opensearch")
@patch("parsedmarc.cli.opensearch.migrate_indexes")
@patch("parsedmarc.cli.opensearch.set_hosts")
@patch("parsedmarc.cli.elastic.save_failure_report_to_elasticsearch")
@patch("parsedmarc.cli.elastic.save_aggregate_report_to_elasticsearch")
@patch("parsedmarc.cli.elastic.migrate_indexes")
@patch("parsedmarc.cli.elastic.set_hosts")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.IMAPConnection")
def testFailOnOutputErrorExitsWithMultipleSinkErrors(
self,
mock_imap_connection,
mock_get_reports,
_mock_es_set_hosts,
_mock_es_migrate,
mock_save_aggregate,
_mock_save_failure_elastic,
_mock_os_set_hosts,
_mock_os_migrate,
mock_save_failure_opensearch,
):
mock_imap_connection.return_value = object()
mock_get_reports.side_effect = _fetch_invoking_save_callback(
{
"aggregate_reports": [{"policy_published": {"domain": "example.com"}}],
"failure_reports": [{"reported_domain": "example.com"}],
"smtp_tls_reports": [],
}
)
mock_save_aggregate.side_effect = parsedmarc.elastic.ElasticsearchError(
"aggregate sink failed"
)
mock_save_failure_opensearch.side_effect = (
parsedmarc.cli.opensearch.OpenSearchError("failure sink failed")
)
config = """[general]
save_aggregate = true
save_failure = true
fail_on_output_error = true
silent = true
[imap]
host = imap.example.com
user = test-user
password = test-password
[elasticsearch]
hosts = localhost
[opensearch]
hosts = localhost
"""
with tempfile.NamedTemporaryFile(
"w", suffix=".ini", delete=False
) as config_file:
config_file.write(config)
config_path = config_file.name
self.addCleanup(lambda: os.path.exists(config_path) and os.remove(config_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", config_path]):
with self.assertRaises(SystemExit) as ctx:
parsedmarc.cli._main()
self.assertEqual(ctx.exception.code, 1)
mock_save_aggregate.assert_called_once()
mock_save_failure_opensearch.assert_called_once()
def test_resolve_section_key_simple(self):
"""Simple section names resolve correctly."""
from parsedmarc.cli import _resolve_section_key
self.assertEqual(_resolve_section_key("IMAP_PASSWORD"), ("imap", "password"))
self.assertEqual(_resolve_section_key("GENERAL_DEBUG"), ("general", "debug"))
self.assertEqual(_resolve_section_key("S3_BUCKET"), ("s3", "bucket"))
self.assertEqual(_resolve_section_key("GELF_HOST"), ("gelf", "host"))
def test_resolve_section_key_underscore_sections(self):
"""Multi-word section names (splunk_hec, gmail_api, etc.) resolve correctly."""
from parsedmarc.cli import _resolve_section_key
self.assertEqual(
_resolve_section_key("SPLUNK_HEC_TOKEN"), ("splunk_hec", "token")
)
self.assertEqual(
_resolve_section_key("GMAIL_API_CREDENTIALS_FILE"),
("gmail_api", "credentials_file"),
)
self.assertEqual(
_resolve_section_key("LOG_ANALYTICS_CLIENT_ID"),
("log_analytics", "client_id"),
)
def test_resolve_section_key_unknown(self):
"""Unknown prefixes return (None, None)."""
from parsedmarc.cli import _resolve_section_key
self.assertEqual(_resolve_section_key("UNKNOWN_FOO"), (None, None))
# Just a section name with no key should not match
self.assertEqual(_resolve_section_key("IMAP"), (None, None))
def test_expand_file_path_args_keeps_bracketed_filenames(self):
"""Literal report filenames containing glob metacharacters must not
be dropped.
Regression test: ``_main`` expanded every file argument with
``glob()``, which treats ``[...]`` as a character class. A real
file named ``[Provider DMARC Failure Report] Subject.eml`` (the
shape Netease and others use) matched nothing and was silently
skipped, so the report never reached the parser.
See https://docs.python.org/3/library/glob.html.
"""
from glob import glob
from parsedmarc.cli import _expand_file_path_args
with tempfile.TemporaryDirectory() as d:
bracket = os.path.join(d, "[Netease DMARC Failure Report] Rent.eml")
plain = os.path.join(d, "report.eml")
for p in (bracket, plain):
with open(p, "w") as f:
f.write("x")
# Sanity: raw glob drops the bracketed path (documents the bug).
self.assertEqual(glob(bracket), [])
# The literal bracketed path is preserved as-is.
self.assertEqual(_expand_file_path_args([bracket]), [bracket])
# Wildcards (non-existent as literal paths) still expand.
wildcard = os.path.join(d, "*.eml")
self.assertEqual(
sorted(_expand_file_path_args([wildcard])),
sorted([bracket, plain]),
)
def test_expand_file_path_args_directory(self):
"""A directory argument expands to the files directly inside it,
matching shell ``<dir>/*`` glob semantics: dotfile entries are
excluded and subdirectories are skipped (not descended into).
See https://docs.python.org/3/library/glob.html.
"""
from parsedmarc.cli import _expand_file_path_args
with tempfile.TemporaryDirectory() as d:
os.makedirs(os.path.join(d, "sub"))
a_xml = os.path.join(d, "a.xml")
b_eml = os.path.join(d, "b.eml")
c_xml = os.path.join(d, "sub", "c.xml")
hidden = os.path.join(d, ".hidden")
for p in (a_xml, b_eml, c_xml, hidden):
with open(p, "w") as f:
f.write("x")
result = _expand_file_path_args([d])
self.assertEqual(sorted(result), sorted([a_xml, b_eml]))
self.assertNotIn(os.path.join(d, "sub"), result)
self.assertNotIn(c_xml, result)
self.assertNotIn(hidden, result)
# A trailing separator on the directory argument behaves the same.
result_trailing = _expand_file_path_args([d + os.sep])
self.assertEqual(
sorted(os.path.basename(p) for p in result_trailing),
sorted(os.path.basename(p) for p in result),
)
def test_expand_file_path_args_directory_recursive(self):
"""With recursive=True, a directory expands via ``<dir>/**``,
descending into subdirectories but still excluding dotfiles and
dot-directories (glob's ``**`` does not descend into hidden
directories unless explicitly matched).
See https://docs.python.org/3/library/glob.html.
"""
from parsedmarc.cli import _expand_file_path_args
with tempfile.TemporaryDirectory() as d:
os.makedirs(os.path.join(d, "sub"))
os.makedirs(os.path.join(d, ".hiddendir"))
a_xml = os.path.join(d, "a.xml")
b_eml = os.path.join(d, "b.eml")
c_xml = os.path.join(d, "sub", "c.xml")
hidden = os.path.join(d, ".hidden")
hidden_dir_file = os.path.join(d, ".hiddendir", "d.xml")
for p in (a_xml, b_eml, c_xml, hidden, hidden_dir_file):
with open(p, "w") as f:
f.write("x")
result = _expand_file_path_args([d], recursive=True)
self.assertEqual(sorted(result), sorted([a_xml, b_eml, c_xml]))
self.assertNotIn(d, result)
self.assertNotIn(os.path.join(d, "sub"), result)
self.assertNotIn(hidden, result)
self.assertNotIn(hidden_dir_file, result)
def test_expand_file_path_args_directory_with_glob_metacharacters(self):
"""A directory name containing glob metacharacters must still be
expanded correctly, not treated as a character class.
Without escaping the directory component with ``glob.escape``,
a directory named ``reports [2024]`` would have ``[2024]``
interpreted as a character class matching a single '2', '0', or
'4' character, matching nothing and silently dropping every file
inside it. See https://docs.python.org/3/library/glob.html.
"""
from parsedmarc.cli import _expand_file_path_args
with tempfile.TemporaryDirectory() as d:
bracket_dir = os.path.join(d, "reports [2024]")
os.makedirs(bracket_dir)
report = os.path.join(bracket_dir, "report.xml")
with open(report, "w") as f:
f.write("x")
self.assertEqual(_expand_file_path_args([bracket_dir]), [report])
self.assertEqual(
_expand_file_path_args([bracket_dir], recursive=True), [report]
)
def test_expand_file_path_args_recursive_glob_pattern(self):
"""``recursive`` also governs whether ``**`` in an explicit glob
pattern recurses into subdirectories, matching stdlib ``glob()``
semantics exactly.
Per https://docs.python.org/3/library/glob.html: "If recursive is
true, the pattern '**' will match any files and zero or more
directories... If recursive is false (the default), the pattern
'**' will match the same files and directories described for the
pattern '*'" (i.e. exactly one path segment). For a pattern like
``d/**/*.xml`` that means the non-recursive default only matches
files exactly one directory level below ``d`` (here, only the
nested file); this is unchanged from today's behavior since
``_expand_file_path_args`` previously always called ``glob()``
without ``recursive=True``.
"""
from parsedmarc.cli import _expand_file_path_args
with tempfile.TemporaryDirectory() as d:
os.makedirs(os.path.join(d, "sub"))
top_xml = os.path.join(d, "x.xml")
nested_xml = os.path.join(d, "sub", "y.xml")
for p in (top_xml, nested_xml):
with open(p, "w") as f:
f.write("x")
pattern = os.path.join(d, "**", "*.xml")
self.assertEqual(
sorted(_expand_file_path_args([pattern], recursive=True)),
sorted([top_xml, nested_xml]),
)
# Default (no recursive kwarg): '**' degrades to matching a
# single path component, so only the one-level-nested file
# is found; the top-level file is not matched by this pattern.
self.assertEqual(
_expand_file_path_args([pattern]),
[nested_xml],
)
def test_apply_env_overrides_injects_values(self):
"""Env vars are injected into an existing ConfigParser."""
from configparser import ConfigParser
from parsedmarc.cli import _apply_env_overrides
config = ConfigParser()
config.add_section("imap")
config.set("imap", "host", "original.example.com")
env = {
"PARSEDMARC_IMAP_HOST": "new.example.com",
"PARSEDMARC_IMAP_PASSWORD": "secret123",
}
with patch.dict(os.environ, env, clear=False):
_apply_env_overrides(config)
self.assertEqual(config.get("imap", "host"), "new.example.com")
self.assertEqual(config.get("imap", "password"), "secret123")
def test_apply_env_overrides_creates_sections(self):
"""Env vars create new sections when they don't exist."""
from configparser import ConfigParser
from parsedmarc.cli import _apply_env_overrides
config = ConfigParser()
env = {"PARSEDMARC_ELASTICSEARCH_HOSTS": "http://localhost:9200"}
with patch.dict(os.environ, env, clear=False):
_apply_env_overrides(config)
self.assertTrue(config.has_section("elasticsearch"))
self.assertEqual(config.get("elasticsearch", "hosts"), "http://localhost:9200")
def test_apply_env_overrides_postgresql_section(self):
"""PARSEDMARC_POSTGRESQL_* env vars must resolve to the [postgresql]
section.
Regression test: ``postgresql`` was missing from ``_KNOWN_SECTIONS``,
so ``_resolve_section_key`` returned ``(None, None)`` for every
``PARSEDMARC_POSTGRESQL_*`` var and the override was silently dropped.
The PostgreSQL backend is only initialized when ``"postgresql" in
config.sections()`` (cli.py), so the section must exist for env-var /
Docker-secret configuration of the backend to work at all.
"""
from configparser import ConfigParser
from parsedmarc.cli import _apply_env_overrides
config = ConfigParser()
env = {
"PARSEDMARC_POSTGRESQL_HOST": "db.example.com",
"PARSEDMARC_POSTGRESQL_PORT": "5432",
"PARSEDMARC_POSTGRESQL_USER": "parsedmarc",
"PARSEDMARC_POSTGRESQL_DATABASE": "parsedmarc",
}
with patch.dict(os.environ, env, clear=False):
_apply_env_overrides(config)
self.assertIn("postgresql", config.sections())
self.assertEqual(config.get("postgresql", "host"), "db.example.com")
self.assertEqual(config.get("postgresql", "port"), "5432")
self.assertEqual(config.get("postgresql", "database"), "parsedmarc")
def test_apply_env_overrides_ignores_config_file_var(self):
"""PARSEDMARC_CONFIG_FILE is not injected as a config key."""
from configparser import ConfigParser
from parsedmarc.cli import _apply_env_overrides
config = ConfigParser()
env = {"PARSEDMARC_CONFIG_FILE": "/some/path.ini"}
with patch.dict(os.environ, env, clear=False):
_apply_env_overrides(config)
self.assertEqual(config.sections(), [])
def test_load_config_with_file_and_env_override(self):
"""Env vars override values from an INI file."""
from parsedmarc.cli import _load_config
with NamedTemporaryFile(mode="w", suffix=".ini", delete=False) as f:
f.write(
"[imap]\nhost = file.example.com\nuser = alice\npassword = fromfile\n"
)
f.flush()
config_path = f.name
try:
env = {"PARSEDMARC_IMAP_PASSWORD": "fromenv"}
with patch.dict(os.environ, env, clear=False):
config = _load_config(config_path)
self.assertEqual(config.get("imap", "host"), "file.example.com")
self.assertEqual(config.get("imap", "user"), "alice")
self.assertEqual(config.get("imap", "password"), "fromenv")
finally:
os.unlink(config_path)
def test_load_config_env_only(self):
"""Config can be loaded purely from env vars with no file."""
from parsedmarc.cli import _load_config
env = {
"PARSEDMARC_GENERAL_DEBUG": "true",
"PARSEDMARC_ELASTICSEARCH_HOSTS": "http://localhost:9200",
}
with patch.dict(os.environ, env, clear=False):
config = _load_config(None)
self.assertEqual(config.get("general", "debug"), "true")
self.assertEqual(config.get("elasticsearch", "hosts"), "http://localhost:9200")
def test_parse_config_from_env(self):
"""Full round-trip: env vars -> ConfigParser -> opts."""
from argparse import Namespace
from parsedmarc.cli import _load_config, _parse_config
env = {
"PARSEDMARC_GENERAL_DEBUG": "true",
"PARSEDMARC_GENERAL_SAVE_AGGREGATE": "true",
"PARSEDMARC_GENERAL_OFFLINE": "true",
}
with patch.dict(os.environ, env, clear=False):
config = _load_config(None)
opts = Namespace()
_parse_config(config, opts)
self.assertTrue(opts.debug)
self.assertTrue(opts.save_aggregate)
self.assertTrue(opts.offline)
def test_config_file_env_var(self):
"""PARSEDMARC_CONFIG_FILE env var specifies the config file path."""
from argparse import Namespace
from parsedmarc.cli import _load_config, _parse_config
with NamedTemporaryFile(mode="w", suffix=".ini", delete=False) as f:
f.write("[general]\ndebug = true\noffline = true\n")
f.flush()
config_path = f.name
try:
env = {"PARSEDMARC_CONFIG_FILE": config_path}
with patch.dict(os.environ, env, clear=False):
config = _load_config(os.environ.get("PARSEDMARC_CONFIG_FILE"))
opts = Namespace()
_parse_config(config, opts)
self.assertTrue(opts.debug)
self.assertTrue(opts.offline)
finally:
os.unlink(config_path)
def test_boolean_values_from_env(self):
"""Various boolean string representations work through ConfigParser."""
from configparser import ConfigParser
from parsedmarc.cli import _apply_env_overrides
for true_val in ("true", "yes", "1", "on", "True", "YES"):
config = ConfigParser()
env = {"PARSEDMARC_GENERAL_DEBUG": true_val}
with patch.dict(os.environ, env, clear=False):
_apply_env_overrides(config)
self.assertTrue(
config.getboolean("general", "debug"),
f"Expected truthy for {true_val!r}",
)
for false_val in ("false", "no", "0", "off", "False", "NO"):
config = ConfigParser()
env = {"PARSEDMARC_GENERAL_DEBUG": false_val}
with patch.dict(os.environ, env, clear=False):
_apply_env_overrides(config)
self.assertFalse(
config.getboolean("general", "debug"),
f"Expected falsy for {false_val!r}",
)
def test_short_alias_debug(self):
"""The bare DEBUG alias maps to [general] debug."""
from parsedmarc.cli import _apply_env_overrides
config = ConfigParser()
with patch.dict(os.environ, {"DEBUG": "true"}, clear=False):
_apply_env_overrides(config)
self.assertEqual(config.get("general", "debug"), "true")
def test_short_alias_parsedmarc_debug(self):
"""The PARSEDMARC_DEBUG alias maps to [general] debug."""
from parsedmarc.cli import _apply_env_overrides
config = ConfigParser()
with patch.dict(os.environ, {"PARSEDMARC_DEBUG": "true"}, clear=False):
_apply_env_overrides(config)
self.assertEqual(config.get("general", "debug"), "true")
def test_file_env_var_reads_secret(self):
"""*_FILE env vars are loaded from a file (Docker secret style)."""
from parsedmarc.cli import _apply_env_overrides
with NamedTemporaryFile(
mode="w", suffix=".secret", delete=False, encoding="utf-8"
) as f:
f.write("sekret-123\n")
secret_path = f.name
try:
config = ConfigParser()
env = {"PARSEDMARC_IMAP_PASSWORD_FILE": secret_path}
with patch.dict(os.environ, env, clear=False):
_apply_env_overrides(config)
self.assertEqual(config.get("imap", "password"), "sekret-123")
finally:
os.unlink(secret_path)
def test_file_env_var_strips_trailing_crlf(self):
"""Leading and internal whitespace is preserved; trailing CR/LF is stripped."""
from parsedmarc.cli import _apply_env_overrides
with NamedTemporaryFile(
mode="w", suffix=".secret", delete=False, encoding="utf-8"
) as f:
f.write(" pre inside\r\n")
secret_path = f.name
try:
config = ConfigParser()
env = {"PARSEDMARC_IMAP_PASSWORD_FILE": secret_path}
with patch.dict(os.environ, env, clear=False):
_apply_env_overrides(config)
self.assertEqual(config.get("imap", "password"), " pre inside")
finally:
os.unlink(secret_path)
def test_file_env_var_supersedes_direct_env(self):
"""*_FILE wins when both the direct env var and _FILE are set."""
from parsedmarc.cli import _apply_env_overrides
with NamedTemporaryFile(
mode="w", suffix=".secret", delete=False, encoding="utf-8"
) as f:
f.write("from-file")
secret_path = f.name
try:
config = ConfigParser()
env = {
"PARSEDMARC_IMAP_PASSWORD": "from-env",
"PARSEDMARC_IMAP_PASSWORD_FILE": secret_path,
}
with patch.dict(os.environ, env, clear=False):
_apply_env_overrides(config)
self.assertEqual(config.get("imap", "password"), "from-file")
finally:
os.unlink(secret_path)
def test_file_env_var_missing_file_raises(self):
"""A missing secret file aborts with ConfigurationError."""
from parsedmarc.cli import ConfigurationError, _apply_env_overrides
config = ConfigParser()
env = {"PARSEDMARC_IMAP_PASSWORD_FILE": "/tmp/parsedmarc-nonexistent-secret"}
with patch.dict(os.environ, env, clear=False):
with self.assertRaises(ConfigurationError) as ctx:
_apply_env_overrides(config)
self.assertIn("PARSEDMARC_IMAP_PASSWORD_FILE", str(ctx.exception))
def test_file_env_var_unreadable_file_raises(self):
"""A secret file we can't read aborts with ConfigurationError."""
import platform
# ``os.geteuid`` is POSIX-only; the ``platform.system() == "Windows"``
# check short-circuits on Windows so the second clause never runs.
if platform.system() == "Windows" or os.geteuid() == 0:
self.skipTest("chmod 000 doesn't restrict the running user")
from parsedmarc.cli import ConfigurationError, _apply_env_overrides
with NamedTemporaryFile(
mode="w", suffix=".secret", delete=False, encoding="utf-8"
) as f:
f.write("data")
secret_path = f.name
try:
os.chmod(secret_path, 0o000)
config = ConfigParser()
env = {"PARSEDMARC_IMAP_PASSWORD_FILE": secret_path}
with patch.dict(os.environ, env, clear=False):
with self.assertRaises(ConfigurationError):
_apply_env_overrides(config)
finally:
os.chmod(secret_path, 0o600)
os.unlink(secret_path)
def test_file_env_var_path_expansion(self):
"""~ and $VAR references in the path are expanded."""
from parsedmarc.cli import _apply_env_overrides
with tempfile.TemporaryDirectory() as tmpdir:
secret_path = os.path.join(tmpdir, "secret")
with open(secret_path, "w", encoding="utf-8") as f:
f.write("expanded-value")
config = ConfigParser()
env = {
"PARSEDMARC_TEST_SECRET_DIR": tmpdir,
"PARSEDMARC_IMAP_PASSWORD_FILE": "$PARSEDMARC_TEST_SECRET_DIR/secret",
}
with patch.dict(os.environ, env, clear=False):
_apply_env_overrides(config)
self.assertEqual(config.get("imap", "password"), "expanded-value")
def test_file_env_var_unknown_section_ignored(self):
"""_FILE vars whose base name doesn't resolve to a section are ignored.
Uses ``clear=True`` so the assertion isn't perturbed by ambient
``PARSEDMARC_*`` vars set in the dev shell or CI runner.
"""
from parsedmarc.cli import _apply_env_overrides
config = ConfigParser()
env = {"PARSEDMARC_UNKNOWN_FOO_FILE": "/tmp/should-not-be-read"}
with patch.dict(os.environ, env, clear=True):
_apply_env_overrides(config)
self.assertEqual(config.sections(), [])
def test_file_env_var_direct_file_keys_keep_direct_semantics(self):
"""Config keys ending in _file (log_file, token_file, ...) stay direct."""
from parsedmarc.cli import _apply_env_overrides
config = ConfigParser()
env = {
"PARSEDMARC_GENERAL_LOG_FILE": "/var/log/parsedmarc.log",
"PARSEDMARC_GMAIL_API_CREDENTIALS_FILE": "/etc/parsedmarc/gmail.json",
"PARSEDMARC_GMAIL_API_TOKEN_FILE": "/etc/parsedmarc/gmail.token",
"PARSEDMARC_MSGRAPH_TOKEN_FILE": "/etc/parsedmarc/msgraph.token",
}
with patch.dict(os.environ, env, clear=False):
_apply_env_overrides(config)
self.assertEqual(config.get("general", "log_file"), "/var/log/parsedmarc.log")
self.assertEqual(
config.get("gmail_api", "credentials_file"),
"/etc/parsedmarc/gmail.json",
)
self.assertEqual(
config.get("gmail_api", "token_file"), "/etc/parsedmarc/gmail.token"
)
self.assertEqual(
config.get("msgraph", "token_file"), "/etc/parsedmarc/msgraph.token"
)
def test_file_env_var_double_suffix_wraps_direct_file_key(self):
"""GMAIL_API_CREDENTIALS_FILE_FILE provides the file path via a secret."""
from parsedmarc.cli import _apply_env_overrides
with NamedTemporaryFile(
mode="w", suffix=".secret", delete=False, encoding="utf-8"
) as f:
f.write("/run/secrets/real-gmail-credentials.json\n")
secret_path = f.name
try:
config = ConfigParser()
env = {"PARSEDMARC_GMAIL_API_CREDENTIALS_FILE_FILE": secret_path}
with patch.dict(os.environ, env, clear=False):
_apply_env_overrides(config)
self.assertEqual(
config.get("gmail_api", "credentials_file"),
"/run/secrets/real-gmail-credentials.json",
)
finally:
os.unlink(secret_path)
def test_direct_file_keys_matches_parse_config_source(self):
"""``_DIRECT_FILE_KEYS`` must cover every ``*_file`` key in ``_parse_config``.
Regression guard for the keep-in-sync comment: when someone adds a new
``[section] some_file`` config option in ``_parse_config`` without
also extending ``_DIRECT_FILE_KEYS``, ``PARSEDMARC_SECTION_SOME_FILE``
would silently be treated as a Docker-secret wrapper (and try to read
a file at the supplied path) instead of as the direct value.
"""
import re
import inspect
import parsedmarc.cli as cli_module
# Scan the cli source for every ``<section>_config[...]("<key>_file")``
# / ``["<key>_file"]`` access and rebuild the expected upper-case set.
# Skip ``_filename`` keys (e.g. ``aggregate_json_filename``).
src = inspect.getsource(cli_module)
pattern = re.compile(
r'(\w+?)_config(?:\.get|\[)\(?["\'](\w+_file)["\']',
)
seen: set[str] = set()
for sect_var, key in pattern.findall(src):
if key.endswith("_filename"):
continue
# Map the local variable name (graph_config / general_config /
# gmail_api_config / ...) to its config-section name. The
# convention is "<section>_config", but ``msgraph`` is bound to
# ``graph_config`` — handle that one alias.
section = "msgraph" if sect_var == "graph" else sect_var
seen.add(f"{section.upper()}_{key.upper()}")
self.assertEqual(
seen,
set(cli_module._DIRECT_FILE_KEYS),
"_DIRECT_FILE_KEYS is out of sync with *_file keys in _parse_config",
)
class TestDirectoryFilePaths(unittest.TestCase):
"""End-to-end coverage of issue #397: a directory passed as a
``file_path`` CLI argument expands to the report files inside it, and
``-r``/``--recursive`` opts into descending into subdirectories. Runs
the real ``_main()`` entry point (real multiprocessing worker, real
parsing, real JSON output) against on-disk sample reports with no
mocking of parsedmarc's own code, per AGENTS.md's mock-at-SDK-boundary
rule (there is no external SDK boundary in this code path to mock)."""
TOP_LEVEL_SAMPLE = "samples/aggregate/!example.com!1538204542!1538463818.xml"
NESTED_SAMPLE = "samples/aggregate/!large-example.com!1711897200!1711983600.xml"
def setUp(self):
# SEEN_AGGREGATE_REPORT_IDS is a module-level ExpiringDict that
# dedupes report IDs across parses within one process; clear it so
# a report "seen" by an earlier test isn't silently dropped here.
# Precedent: tests/test_init.py TestGetDmarcReportsFromMailboxMaildir.setUp.
parsedmarc.SEEN_AGGREGATE_REPORT_IDS.clear()
# Also clear on the way out: these tests reuse
# SAMPLE_AGGREGATE_REPORT_PATH's report ID, and other test classes
# later in this file (e.g. TestSkipsResultsEmailWhenNoReportsParsed)
# parse that same sample through the real _main() dedup path, so a
# left-over "seen" entry here would make their report look like a
# duplicate and silently vanish.
self.addCleanup(parsedmarc.SEEN_AGGREGATE_REPORT_IDS.clear)
self._env_patcher = patch.dict(
os.environ, {"GITHUB_ACTIONS": "true"}, clear=False
)
self._env_patcher.start()
self.addCleanup(self._env_patcher.stop)
def _build_reports_dir(self, tmp_dir):
reports_dir = os.path.join(tmp_dir, "reports")
nested_dir = os.path.join(reports_dir, "nested")
os.makedirs(nested_dir)
top_level_path = os.path.join(
reports_dir, os.path.basename(self.TOP_LEVEL_SAMPLE)
)
nested_path = os.path.join(nested_dir, os.path.basename(self.NESTED_SAMPLE))
with (
open(self.TOP_LEVEL_SAMPLE, "rb") as src,
open(top_level_path, "wb") as dst,
):
dst.write(src.read())
with open(self.NESTED_SAMPLE, "rb") as src, open(nested_path, "wb") as dst:
dst.write(src.read())
return reports_dir
def _write_config(self, tmp_dir, output_dirname, n_procs=None):
cfg_path = os.path.join(tmp_dir, "parsedmarc.ini")
output_dir = os.path.join(tmp_dir, output_dirname)
config_text = (
f"[general]\noffline = True\nsilent = True\noutput = {output_dir}\n"
)
if n_procs is not None:
config_text += f"n_procs = {n_procs}\n"
with open(cfg_path, "w") as f:
f.write(config_text)
return cfg_path, output_dir
def _report_ids(self, output_dir):
with open(os.path.join(output_dir, "aggregate.json")) as f:
reports = json.load(f)
return {report["report_metadata"]["report_id"] for report in reports}
def _sample_report_id(self, path):
result = parsedmarc.parse_report_file(path, offline=True)
assert result["report_type"] == "aggregate"
report = cast(AggregateReport, result["report"])
return report["report_metadata"]["report_id"]
def test_directory_file_path_non_recursive_skips_nested(self):
"""A bare directory ``file_path`` argument behaves like shell
``reports/*``: the top-level sample is parsed, and the nested
subdirectory is skipped (not descended into) without ``-r``.
"""
with tempfile.TemporaryDirectory() as tmp_dir:
reports_dir = self._build_reports_dir(tmp_dir)
cfg_path, output_dir = self._write_config(tmp_dir, "output_non_recursive")
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path, reports_dir]):
parsedmarc.cli._main()
report_ids = self._report_ids(output_dir)
top_level_id = self._sample_report_id(self.TOP_LEVEL_SAMPLE)
nested_id = self._sample_report_id(self.NESTED_SAMPLE)
self.assertIn(top_level_id, report_ids)
self.assertNotIn(nested_id, report_ids)
def test_directory_file_path_recursive_includes_nested(self):
"""With ``-r``/``--recursive``, the directory expands via ``**``
and both the top-level and nested sample reports are parsed.
"""
with tempfile.TemporaryDirectory() as tmp_dir:
reports_dir = self._build_reports_dir(tmp_dir)
cfg_path, output_dir = self._write_config(tmp_dir, "output_recursive")
with patch.object(
sys, "argv", ["parsedmarc", "-c", cfg_path, "-r", reports_dir]
):
parsedmarc.cli._main()
report_ids = self._report_ids(output_dir)
top_level_id = self._sample_report_id(self.TOP_LEVEL_SAMPLE)
nested_id = self._sample_report_id(self.NESTED_SAMPLE)
self.assertIn(top_level_id, report_ids)
self.assertIn(nested_id, report_ids)
def test_directory_file_path_recursive_includes_nested_n_procs_2(self):
"""The same recursive-directory scenario as
``test_directory_file_path_recursive_includes_nested``, but with
``n_procs = 2`` in the config file so the direct-file parsing path
runs through ``parallel_map``'s process pool with more than one
worker. The report-id sets in the output JSON must match the
``n_procs = 1`` (default) run exactly — parallelism must not change
which reports get parsed or deduplicated.
"""
with tempfile.TemporaryDirectory() as tmp_dir:
reports_dir = self._build_reports_dir(tmp_dir)
cfg_path, output_dir = self._write_config(
tmp_dir, "output_recursive_n_procs_2", n_procs=2
)
with patch.object(
sys, "argv", ["parsedmarc", "-c", cfg_path, "-r", reports_dir]
):
parsedmarc.cli._main()
report_ids = self._report_ids(output_dir)
top_level_id = self._sample_report_id(self.TOP_LEVEL_SAMPLE)
nested_id = self._sample_report_id(self.NESTED_SAMPLE)
self.assertIn(top_level_id, report_ids)
self.assertIn(nested_id, report_ids)
self.assertEqual(report_ids, {top_level_id, nested_id})
class TestArchiveDirectory(unittest.TestCase):
"""End-to-end coverage of issue #570: ``[general] archive_directory``
moves successfully processed local report files into a dated
``<year>/<month>/<Aggregate|Failure|SMTP-TLS>/`` tree, and unparseable
files into ``<archive_directory>/Invalid/``. Runs the real ``_main()``
entry point via ``patch.object(sys, "argv", ...)`` against on-disk
sample reports, per AGENTS.md's mock-at-SDK-boundary rule (there is no
external SDK boundary in this code path to mock)."""
AGGREGATE_SAMPLE_1 = "samples/aggregate/!example.com!1538204542!1538463818.xml"
AGGREGATE_SAMPLE_2 = (
"samples/aggregate/!large-example.com!1711897200!1711983600.xml"
)
# Not dmarc_ruf_report_linkedin.eml: that sample begins with a
# "From dmarc-noreply@linkedin.com ..." mbox envelope line, which is
# why Python's mailbox module reads it as a (single-message) mbox
# file and is_mbox() classifies it as an mbox — routing it through
# _main()'s mbox_paths branch instead of the direct-file archiving
# path this test exercises (mbox files are intentionally never
# archived — see the archive_directory docs in docs/source/usage.md).
# The sharepoint sample below starts with a MIME header instead, so
# it isn't mbox-classified.
FAILURE_SAMPLE = (
"samples/failure/DMARC Failure Report for domain.de "
"(mail-from=sharepoint@domain.de, ip=10.10.10.10).eml"
)
SMTP_TLS_SAMPLE = "samples/smtp_tls/rfc8460.json"
def setUp(self):
# SEEN_AGGREGATE_REPORT_IDS is a module-level ExpiringDict that
# dedupes report IDs across parses within one process; clear it so
# a report "seen" by an earlier test isn't silently dropped here,
# and so tests within this class don't interfere with each other.
# Precedent: TestDirectoryFilePaths.setUp above.
parsedmarc.SEEN_AGGREGATE_REPORT_IDS.clear()
self.addCleanup(parsedmarc.SEEN_AGGREGATE_REPORT_IDS.clear)
self._env_patcher = patch.dict(
os.environ, {"GITHUB_ACTIONS": "true"}, clear=False
)
self._env_patcher.start()
self.addCleanup(self._env_patcher.stop)
def _copy_sample(self, src_path, dest_dir, dest_basename=None):
dest_basename = dest_basename or os.path.basename(src_path)
dest_path = os.path.join(dest_dir, dest_basename)
with open(src_path, "rb") as src, open(dest_path, "wb") as dst:
dst.write(src.read())
return dest_path
def _expected_subdir(self, sample_path):
"""Parse *sample_path* the same way the CLI does and return the
``<year>/<month>/<type>`` subdirectory ``_archive_subdir_for_result``
computes for it. Computed dynamically rather than hardcoded because
aggregate ``begin_date`` is local-time, so month buckets are
timezone-dependent."""
result = parsedmarc.parse_report_file(sample_path, offline=True)
subdir = parsedmarc.cli._archive_subdir_for_result(result)
assert subdir is not None
return subdir
def _write_config(
self, tmp_dir, output_dirname, archive_dirname=None, n_procs=None
):
cfg_path = os.path.join(tmp_dir, "parsedmarc.ini")
output_dir = os.path.join(tmp_dir, output_dirname)
config_text = (
f"[general]\noffline = True\nsilent = True\noutput = {output_dir}\n"
)
archive_dir = None
if archive_dirname is not None:
archive_dir = os.path.join(tmp_dir, archive_dirname)
config_text += f"archive_directory = {archive_dir}\n"
if n_procs is not None:
config_text += f"n_procs = {n_procs}\n"
with open(cfg_path, "w") as f:
f.write(config_text)
return cfg_path, output_dir, archive_dir
def test_archive_moves_all_three_types(self):
"""Aggregate, failure, and SMTP TLS report files given as direct
``file_path`` arguments are moved into
``<archive>/<year>/<month>/<Aggregate|Failure|SMTP-TLS>/`` after a
successful parse, the source files are gone from the input
directory, and the aggregate JSON output is still produced."""
with tempfile.TemporaryDirectory() as tmp_dir:
input_dir = os.path.join(tmp_dir, "input")
os.makedirs(input_dir)
agg1 = self._copy_sample(self.AGGREGATE_SAMPLE_1, input_dir)
agg2 = self._copy_sample(self.AGGREGATE_SAMPLE_2, input_dir)
failure = self._copy_sample(self.FAILURE_SAMPLE, input_dir)
smtp_tls = self._copy_sample(self.SMTP_TLS_SAMPLE, input_dir)
cfg_path, output_dir, archive_dir = self._write_config(
tmp_dir, "output", archive_dirname="archive"
)
assert archive_dir is not None
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path, input_dir]):
parsedmarc.cli._main()
for src, sample_path in (
(agg1, self.AGGREGATE_SAMPLE_1),
(agg2, self.AGGREGATE_SAMPLE_2),
(failure, self.FAILURE_SAMPLE),
(smtp_tls, self.SMTP_TLS_SAMPLE),
):
subdir = self._expected_subdir(sample_path)
dest = os.path.join(archive_dir, subdir, os.path.basename(src))
self.assertTrue(os.path.isfile(dest), f"missing {dest}")
self.assertFalse(os.path.isfile(src))
self.assertTrue(os.path.isfile(os.path.join(output_dir, "aggregate.json")))
def test_failed_parse_moved_to_invalid(self):
"""A file that fails to parse (garbage content) is moved to
``<archive_directory>/Invalid/`` rather than left in place, and
the run completes without raising."""
with tempfile.TemporaryDirectory() as tmp_dir:
input_dir = os.path.join(tmp_dir, "input")
os.makedirs(input_dir)
garbage_path = os.path.join(input_dir, "garbage.xml")
with open(garbage_path, "wb") as f:
f.write(b"not a report")
cfg_path, output_dir, archive_dir = self._write_config(
tmp_dir, "output", archive_dirname="archive"
)
assert archive_dir is not None
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path, input_dir]):
parsedmarc.cli._main()
dest = os.path.join(archive_dir, "Invalid", "garbage.xml")
self.assertTrue(os.path.isfile(dest))
self.assertFalse(os.path.isfile(garbage_path))
def test_collision_appends_numeric_suffix(self):
"""A destination file that already exists at the computed archive
path is never overwritten: the newly archived file gets a
numeric suffix appended before its extension instead, and the
pre-existing file's content is untouched."""
with tempfile.TemporaryDirectory() as tmp_dir:
input_dir = os.path.join(tmp_dir, "input")
os.makedirs(input_dir)
src = self._copy_sample(self.AGGREGATE_SAMPLE_1, input_dir)
cfg_path, output_dir, archive_dir = self._write_config(
tmp_dir, "output", archive_dirname="archive"
)
assert archive_dir is not None
subdir = self._expected_subdir(self.AGGREGATE_SAMPLE_1)
dest_dir = os.path.join(archive_dir, subdir)
os.makedirs(dest_dir)
basename = os.path.basename(src)
preexisting_path = os.path.join(dest_dir, basename)
with open(preexisting_path, "wb") as f:
f.write(b"PREEXISTING DUMMY CONTENT")
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path, input_dir]):
parsedmarc.cli._main()
with open(preexisting_path, "rb") as f:
self.assertEqual(f.read(), b"PREEXISTING DUMMY CONTENT")
base, ext = os.path.splitext(basename)
suffixed_path = os.path.join(dest_dir, f"{base}-1{ext}")
self.assertTrue(os.path.isfile(suffixed_path))
self.assertFalse(os.path.isfile(src))
def test_second_run_skips_archived_files(self):
"""Files already inside ``archive_directory`` are excluded from
the next run's ``file_path`` expansion, so the archive may safely
live inside an input directory without its own contents being
re-parsed and re-archived on a later run. SEEN_AGGREGATE_REPORT_IDS
is cleared between runs to prove the exclusion doesn't rely on
aggregate-report dedup (the failure/SMTP-TLS samples aren't
deduped at all, so they alone would already prove this, but
clearing it removes any doubt for the aggregate sample too)."""
with tempfile.TemporaryDirectory() as tmp_dir:
input_dir = os.path.join(tmp_dir, "input")
os.makedirs(input_dir)
self._copy_sample(self.AGGREGATE_SAMPLE_1, input_dir)
self._copy_sample(self.FAILURE_SAMPLE, input_dir)
self._copy_sample(self.SMTP_TLS_SAMPLE, input_dir)
archive_dir = os.path.join(input_dir, "archive")
output_dir = os.path.join(tmp_dir, "output")
cfg_path = os.path.join(tmp_dir, "parsedmarc.ini")
config_text = (
"[general]\noffline = True\nsilent = True\n"
f"output = {output_dir}\narchive_directory = {archive_dir}\n"
)
with open(cfg_path, "w") as f:
f.write(config_text)
def _archive_tree():
tree = {}
for root, _dirs, files in os.walk(archive_dir):
for name in files:
path = os.path.join(root, name)
rel = os.path.relpath(path, archive_dir)
with open(path, "rb") as f:
tree[rel] = f.read()
return tree
with patch.object(
sys, "argv", ["parsedmarc", "-c", cfg_path, "-r", input_dir]
):
parsedmarc.cli._main()
first_run_tree = _archive_tree()
self.assertEqual(len(first_run_tree), 3)
parsedmarc.SEEN_AGGREGATE_REPORT_IDS.clear()
with patch.object(
sys, "argv", ["parsedmarc", "-c", cfg_path, "-r", input_dir]
):
parsedmarc.cli._main()
second_run_tree = _archive_tree()
self.assertEqual(first_run_tree, second_run_tree)
for rel in second_run_tree:
self.assertNotIn("-1", os.path.basename(rel))
def test_archive_with_n_procs_2(self):
"""The same archiving behavior as
``test_archive_moves_all_three_types``, but with ``n_procs = 2``
so the direct-file parsing path runs through the multiprocessing
pool."""
with tempfile.TemporaryDirectory() as tmp_dir:
input_dir = os.path.join(tmp_dir, "input")
os.makedirs(input_dir)
agg1 = self._copy_sample(self.AGGREGATE_SAMPLE_1, input_dir)
agg2 = self._copy_sample(self.AGGREGATE_SAMPLE_2, input_dir)
failure = self._copy_sample(self.FAILURE_SAMPLE, input_dir)
smtp_tls = self._copy_sample(self.SMTP_TLS_SAMPLE, input_dir)
cfg_path, output_dir, archive_dir = self._write_config(
tmp_dir, "output", archive_dirname="archive", n_procs=2
)
assert archive_dir is not None
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path, input_dir]):
parsedmarc.cli._main()
for src, sample_path in (
(agg1, self.AGGREGATE_SAMPLE_1),
(agg2, self.AGGREGATE_SAMPLE_2),
(failure, self.FAILURE_SAMPLE),
(smtp_tls, self.SMTP_TLS_SAMPLE),
):
subdir = self._expected_subdir(sample_path)
dest = os.path.join(archive_dir, subdir, os.path.basename(src))
self.assertTrue(os.path.isfile(dest), f"missing {dest}")
self.assertFalse(os.path.isfile(src))
self.assertTrue(os.path.isfile(os.path.join(output_dir, "aggregate.json")))
def test_no_archive_when_option_unset(self):
"""Without ``archive_directory`` configured, input files are left
in place after processing and no ``archive`` directory is
created."""
with tempfile.TemporaryDirectory() as tmp_dir:
input_dir = os.path.join(tmp_dir, "input")
os.makedirs(input_dir)
agg1 = self._copy_sample(self.AGGREGATE_SAMPLE_1, input_dir)
cfg_path, output_dir, archive_dir = self._write_config(tmp_dir, "output")
self.assertIsNone(archive_dir)
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path, input_dir]):
parsedmarc.cli._main()
self.assertTrue(os.path.isfile(agg1))
self.assertFalse(os.path.isdir(os.path.join(tmp_dir, "archive")))
def test_duplicate_aggregate_reports_both_archived(self):
"""The same aggregate report content under two different
filenames is deduplicated down to one report in the JSON output,
but both source files are archived normally: archiving runs for
every file that parsed successfully, independent of the
in-process report-ID dedup."""
with tempfile.TemporaryDirectory() as tmp_dir:
input_dir = os.path.join(tmp_dir, "input")
os.makedirs(input_dir)
copy1 = self._copy_sample(
self.AGGREGATE_SAMPLE_1, input_dir, dest_basename="copy-a.xml"
)
copy2 = self._copy_sample(
self.AGGREGATE_SAMPLE_1, input_dir, dest_basename="copy-b.xml"
)
cfg_path, output_dir, archive_dir = self._write_config(
tmp_dir, "output", archive_dirname="archive"
)
assert archive_dir is not None
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path, input_dir]):
parsedmarc.cli._main()
with open(os.path.join(output_dir, "aggregate.json")) as f:
reports = json.load(f)
self.assertEqual(len(reports), 1)
subdir = self._expected_subdir(self.AGGREGATE_SAMPLE_1)
dest1 = os.path.join(archive_dir, subdir, "copy-a.xml")
dest2 = os.path.join(archive_dir, subdir, "copy-b.xml")
self.assertTrue(os.path.isfile(dest1))
self.assertTrue(os.path.isfile(dest2))
self.assertFalse(os.path.isfile(copy1))
self.assertFalse(os.path.isfile(copy2))
class TestGmailAuthModes(unittest.TestCase):
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.GmailConnection")
def testCliPassesGmailServiceAccountAuthSettings(
self, mock_gmail_connection, mock_get_mailbox_reports
):
mock_gmail_connection.return_value = MagicMock()
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
config = """[general]
silent = true
[gmail_api]
credentials_file = /tmp/service-account.json
auth_mode = service_account
service_account_user = dmarc@example.com
scopes = https://www.googleapis.com/auth/gmail.modify
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg_file:
cfg_file.write(config)
config_path = cfg_file.name
self.addCleanup(lambda: os.path.exists(config_path) and os.remove(config_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", config_path]):
parsedmarc.cli._main()
self.assertEqual(
mock_gmail_connection.call_args.kwargs.get("auth_mode"), "service_account"
)
self.assertEqual(
mock_gmail_connection.call_args.kwargs.get("service_account_user"),
"dmarc@example.com",
)
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.GmailConnection")
def testCliAcceptsDelegatedUserAlias(self, mock_gmail_connection, mock_get_reports):
mock_gmail_connection.return_value = MagicMock()
mock_get_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
config = """[general]
silent = true
[gmail_api]
credentials_file = /tmp/service-account.json
auth_mode = service_account
delegated_user = delegated@example.com
scopes = https://www.googleapis.com/auth/gmail.modify
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg_file:
cfg_file.write(config)
config_path = cfg_file.name
self.addCleanup(lambda: os.path.exists(config_path) and os.remove(config_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", config_path]):
parsedmarc.cli._main()
self.assertEqual(
mock_gmail_connection.call_args.kwargs.get("service_account_user"),
"delegated@example.com",
)
class TestMailboxWatchSince(unittest.TestCase):
def setUp(self):
from parsedmarc.log import logger as _logger
_logger.disabled = True
self._stdout_patch = patch("sys.stdout", new_callable=io.StringIO)
self._stderr_patch = patch("sys.stderr", new_callable=io.StringIO)
self._stdout_patch.start()
self._stderr_patch.start()
def tearDown(self):
from parsedmarc.log import logger as _logger
_logger.disabled = False
self._stderr_patch.stop()
self._stdout_patch.stop()
def testWatchInboxPassesSinceToMailboxFetch(self):
mailbox_connection = SimpleNamespace()
def fake_watch(check_callback, check_timeout, config_reloading=None):
check_callback(mailbox_connection)
raise _BreakLoop()
mailbox_connection.watch = fake_watch
callback = MagicMock()
with patch.object(
parsedmarc, "get_dmarc_reports_from_mailbox", return_value={}
) as mocked:
with self.assertRaises(_BreakLoop):
parsedmarc.watch_inbox(
mailbox_connection=cast(
parsedmarc.MailboxConnection, mailbox_connection
),
callback=callback,
check_timeout=1,
batch_size=10,
since="1d",
)
self.assertEqual(mocked.call_args.kwargs.get("since"), "1d")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.watch_inbox")
@patch("parsedmarc.cli.IMAPConnection")
def testCliPassesSinceToWatchInbox(
self, mock_imap_connection, mock_watch_inbox, mock_get_mailbox_reports
):
mock_imap_connection.return_value = object()
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
mock_watch_inbox.side_effect = FileExistsError("stop-watch-loop")
config_text = """[general]
silent = true
[imap]
host = imap.example.com
user = user
password = pass
[mailbox]
watch = true
since = 2d
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit) as system_exit:
parsedmarc.cli._main()
self.assertEqual(system_exit.exception.code, 1)
self.assertEqual(mock_watch_inbox.call_args.kwargs.get("since"), "2d")
class TestMailboxPerTypeDeleteOptions(unittest.TestCase):
"""The [mailbox] per-report-type delete options (issue #256) must reach
the library unchanged, including the difference between an explicit
``false`` and an unset option (``None``, meaning "inherit ``delete``")."""
def setUp(self):
from parsedmarc.log import logger as _logger
_logger.disabled = True
self._stdout_patch = patch("sys.stdout", new_callable=io.StringIO)
self._stderr_patch = patch("sys.stderr", new_callable=io.StringIO)
self._stdout_patch.start()
self._stderr_patch.start()
def tearDown(self):
from parsedmarc.log import logger as _logger
_logger.disabled = False
self._stderr_patch.stop()
self._stdout_patch.stop()
def _write_config(self, config_text):
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
return cfg_path
IMAP_CONFIG = """[general]
silent = true
[imap]
host = imap.example.com
user = user
password = pass
[mailbox]
delete = true
delete_failure = false
"""
def _assert_per_type_delete_kwargs(self, kwargs):
self.assertIs(kwargs.get("delete"), True)
self.assertIs(kwargs.get("delete_failure"), False)
# Unset options stay None so the library applies the inheritance.
self.assertIsNone(kwargs.get("delete_aggregate"))
self.assertIsNone(kwargs.get("delete_smtp_tls"))
self.assertIsNone(kwargs.get("delete_invalid"))
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.watch_inbox")
@patch("parsedmarc.cli.IMAPConnection")
def testCliPassesPerTypeDeleteToWatchInbox(
self, mock_imap_connection, mock_watch_inbox, mock_get_mailbox_reports
):
mock_imap_connection.return_value = object()
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
mock_watch_inbox.side_effect = FileExistsError("stop-watch-loop")
cfg_path = self._write_config(self.IMAP_CONFIG + "watch = true\n")
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit) as system_exit:
parsedmarc.cli._main()
self.assertEqual(system_exit.exception.code, 1)
self._assert_per_type_delete_kwargs(mock_watch_inbox.call_args.kwargs)
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.IMAPConnection")
def testCliPassesPerTypeDeleteToOneShotMailboxRun(
self, mock_imap_connection, mock_get_mailbox_reports
):
mock_imap_connection.return_value = object()
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
cfg_path = self._write_config(self.IMAP_CONFIG)
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
parsedmarc.cli._main()
self._assert_per_type_delete_kwargs(mock_get_mailbox_reports.call_args.kwargs)
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.GmailConnection")
def testGmailScopeGuardForcesAllDeleteFlagsOff(
self, mock_gmail_connection, mock_get_mailbox_reports
):
"""The Gmail deletion scope is a mailbox-wide capability grant, so a
per-report-type delete option alone (with ``delete`` unset) is enough
to trip the guard, and a missing scope turns every delete flag off."""
mock_gmail_connection.return_value = MagicMock()
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
cfg_path = self._write_config("""[general]
silent = true
[gmail_api]
credentials_file = /tmp/gmail-credentials.json
scopes = https://www.googleapis.com/auth/gmail.modify
[mailbox]
delete_aggregate = true
""")
from parsedmarc.log import logger as _logger
_logger.disabled = False
try:
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertLogs("parsedmarc.log", level="ERROR") as logs:
parsedmarc.cli._main()
finally:
_logger.disabled = True
self.assertTrue(
any("Message deletion requires scope" in line for line in logs.output),
logs.output,
)
kwargs = mock_get_mailbox_reports.call_args.kwargs
for option in (
"delete",
"delete_aggregate",
"delete_failure",
"delete_smtp_tls",
"delete_invalid",
):
with self.subTest(option=option):
self.assertIs(kwargs.get(option), False)
class TestCliParserConfigWiring(unittest.TestCase):
"""Tests that _main() builds a single ParserConfig (via
_build_parser_config) from parsed opts and passes it as ``config=`` to
the library's mailbox-fetching functions, rather than forwarding
individual option kwargs (offline, dns_timeout, ip_db_path, etc.) by
hand at each call site."""
def setUp(self):
from parsedmarc.log import logger as _logger
_logger.disabled = True
self._stdout_patch = patch("sys.stdout", new_callable=io.StringIO)
self._stderr_patch = patch("sys.stderr", new_callable=io.StringIO)
self._stdout_patch.start()
self._stderr_patch.start()
# SEEN_AGGREGATE_REPORT_IDS is a module-level ExpiringDict shared
# across tests in this process; clear it both ways so state from an
# earlier test class doesn't leak in, and so this class doesn't leak
# into a later one. Precedent: TestDirectoryFilePaths.setUp above.
parsedmarc.SEEN_AGGREGATE_REPORT_IDS.clear()
self.addCleanup(parsedmarc.SEEN_AGGREGATE_REPORT_IDS.clear)
def tearDown(self):
from parsedmarc.log import logger as _logger
_logger.disabled = False
self._stderr_patch.stop()
self._stdout_patch.stop()
def _run_one_shot_mailbox(
self, dns_timeout: float | None = None, dns_retries: int | None = None
) -> parsedmarc.ParserConfig:
"""Runs a real one-shot _main() against a mocked IMAP connection and
mocked get_dmarc_reports_from_mailbox, and returns the ParserConfig
the CLI passed as ``config=``."""
config_lines = ["[general]", "silent = true"]
if dns_timeout is not None:
config_lines.append(f"dns_timeout = {dns_timeout}")
if dns_retries is not None:
config_lines.append(f"dns_retries = {dns_retries}")
config_lines += [
"",
"[imap]",
"host = imap.example.com",
"user = user",
"password = pass",
]
config_text = "\n".join(config_lines) + "\n"
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with (
patch("parsedmarc.cli.get_dmarc_reports_from_mailbox") as mock_get_reports,
patch("parsedmarc.cli.IMAPConnection") as mock_imap,
):
mock_imap.return_value = object()
mock_get_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
parsedmarc.cli._main()
return mock_get_reports.call_args.kwargs["config"]
def test_one_shot_mailbox_run_honors_general_dns_timeout(self):
"""Regression test for the one-shot mailbox call site in _main():
before this fix, that call to get_dmarc_reports_from_mailbox
omitted the dns_timeout/dns_retries kwargs entirely (and, before
config= existed, had no way to pass them at all), so a one-shot run
silently used the library's own hardcoded default
(``dns_timeout: float = 6.0`` on master's
get_dmarc_reports_from_mailbox signature) instead of the operator's
``[general] dns_timeout`` / ``dns_retries`` config values. Watch-mode
runs were unaffected because the watch_inbox call site did pass
dns_timeout/dns_retries directly.
"""
cfg = self._run_one_shot_mailbox(dns_timeout=11.5, dns_retries=3)
self.assertEqual(cfg.dns_timeout, 11.5)
self.assertEqual(cfg.dns_retries, 3)
def test_cli_config_binds_module_default_caches(self):
"""The ParserConfig built by the CLI must bind the process-wide
default caches (parsedmarc.IP_ADDRESS_CACHE,
parsedmarc.SEEN_AGGREGATE_REPORT_IDS, parsedmarc.REVERSE_DNS_MAP) by
identity, not fresh/isolated caches — otherwise every CLI run would
get its own empty caches (defeating the point of the 4-hour IP
cache and the 1-hour dedup cache) even though ParserConfig's default
factories exist specifically to give library callers isolated
caches when they don't pass config=.
"""
cfg = self._run_one_shot_mailbox()
self.assertIs(cfg.ip_address_cache, parsedmarc.IP_ADDRESS_CACHE)
self.assertIs(
cfg.seen_aggregate_report_ids, parsedmarc.SEEN_AGGREGATE_REPORT_IDS
)
self.assertIs(cfg.reverse_dns_map, parsedmarc.REVERSE_DNS_MAP)
class TestMailboxPerformance(unittest.TestCase):
def setUp(self):
from parsedmarc.log import logger as _logger
_logger.disabled = True
self._stdout_patch = patch("sys.stdout", new_callable=io.StringIO)
self._stderr_patch = patch("sys.stderr", new_callable=io.StringIO)
self._stdout_patch.start()
self._stderr_patch.start()
def tearDown(self):
from parsedmarc.log import logger as _logger
_logger.disabled = False
self._stderr_patch.stop()
self._stdout_patch.stop()
def testBatchModeAvoidsExtraFullFetch(self):
connection = _DummyMailboxConnection()
parsedmarc.get_dmarc_reports_from_mailbox(
connection=connection,
reports_folder="INBOX",
test=True,
batch_size=10,
create_folders=False,
)
self.assertEqual(len(connection.fetch_calls), 1)
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliPassesMsGraphCertificateAuthSettings(
self, mock_graph_connection, mock_get_mailbox_reports
):
mock_graph_connection.return_value = object()
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
config_text = """[general]
silent = true
[msgraph]
auth_method = Certificate
client_id = client-id
tenant_id = tenant-id
mailbox = shared@example.com
certificate_path = /tmp/msgraph-cert.pem
certificate_password = cert-pass
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
parsedmarc.cli._main()
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("auth_method"), "Certificate"
)
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("certificate_path"),
"/tmp/msgraph-cert.pem",
)
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("certificate_password"),
"cert-pass",
)
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
@patch("parsedmarc.cli.logger")
def testCliRequiresMsGraphCertificatePath(
self, mock_logger, mock_graph_connection, mock_get_mailbox_reports
):
config_text = """[general]
silent = true
[msgraph]
auth_method = Certificate
client_id = client-id
tenant_id = tenant-id
mailbox = shared@example.com
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit) as system_exit:
parsedmarc.cli._main()
self.assertEqual(system_exit.exception.code, -1)
mock_logger.critical.assert_called_once_with(
"certificate_path setting missing from the msgraph config section"
)
mock_graph_connection.assert_not_called()
mock_get_mailbox_reports.assert_not_called()
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliUsesMsGraphUserAsMailboxForUsernamePasswordAuth(
self, mock_graph_connection, mock_get_mailbox_reports
):
mock_graph_connection.return_value = object()
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
config_text = """[general]
silent = true
[msgraph]
auth_method = UsernamePassword
client_id = client-id
client_secret = client-secret
user = owner@example.com
password = test-password
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
parsedmarc.cli._main()
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("mailbox"),
"owner@example.com",
)
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("username"),
"owner@example.com",
)
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
@patch("parsedmarc.cli.logger")
def testCliRequiresMsGraphPasswordForUsernamePasswordAuth(
self, mock_logger, mock_graph_connection, mock_get_mailbox_reports
):
config_text = """[general]
silent = true
[msgraph]
auth_method = UsernamePassword
client_id = client-id
client_secret = client-secret
user = owner@example.com
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit) as system_exit:
parsedmarc.cli._main()
self.assertEqual(system_exit.exception.code, -1)
mock_logger.critical.assert_called_once_with(
"password setting missing from the msgraph config section"
)
mock_graph_connection.assert_not_called()
mock_get_mailbox_reports.assert_not_called()
class TestMSGraphCliValidation(unittest.TestCase):
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliPassesMsGraphClientSecretAuthSettings(
self, mock_graph_connection, mock_get_mailbox_reports
):
mock_graph_connection.return_value = object()
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
config_text = """[general]
silent = true
[msgraph]
auth_method = ClientSecret
client_id = client-id
client_secret = client-secret
tenant_id = tenant-id
mailbox = shared@example.com
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
parsedmarc.cli._main()
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("auth_method"), "ClientSecret"
)
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("client_secret"),
"client-secret",
)
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("tenant_id"), "tenant-id"
)
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("mailbox"),
"shared@example.com",
)
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
@patch("parsedmarc.cli.logger")
def testCliRequiresMsGraphClientSecretForClientSecretAuth(
self, mock_logger, mock_graph_connection, mock_get_mailbox_reports
):
config_text = """[general]
silent = true
[msgraph]
auth_method = ClientSecret
client_id = client-id
tenant_id = tenant-id
mailbox = shared@example.com
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit) as system_exit:
parsedmarc.cli._main()
self.assertEqual(system_exit.exception.code, -1)
mock_logger.critical.assert_called_once_with(
"client_secret setting missing from the msgraph config section"
)
mock_graph_connection.assert_not_called()
mock_get_mailbox_reports.assert_not_called()
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
@patch("parsedmarc.cli.logger")
def testCliRequiresMsGraphTenantIdForClientSecretAuth(
self, mock_logger, mock_graph_connection, mock_get_mailbox_reports
):
config_text = """[general]
silent = true
[msgraph]
auth_method = ClientSecret
client_id = client-id
client_secret = client-secret
mailbox = shared@example.com
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit) as system_exit:
parsedmarc.cli._main()
self.assertEqual(system_exit.exception.code, -1)
mock_logger.critical.assert_called_once_with(
"tenant_id setting missing from the msgraph config section"
)
mock_graph_connection.assert_not_called()
mock_get_mailbox_reports.assert_not_called()
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
@patch("parsedmarc.cli.logger")
def testCliRequiresMsGraphMailboxForClientSecretAuth(
self, mock_logger, mock_graph_connection, mock_get_mailbox_reports
):
config_text = """[general]
silent = true
[msgraph]
auth_method = ClientSecret
client_id = client-id
client_secret = client-secret
tenant_id = tenant-id
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit) as system_exit:
parsedmarc.cli._main()
self.assertEqual(system_exit.exception.code, -1)
mock_logger.critical.assert_called_once_with(
"mailbox setting missing from the msgraph config section"
)
mock_graph_connection.assert_not_called()
mock_get_mailbox_reports.assert_not_called()
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliAllowsMsGraphDeviceCodeWithoutUser(
self, mock_graph_connection, mock_get_mailbox_reports
):
mock_graph_connection.return_value = object()
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
config_text = """[general]
silent = true
[msgraph]
auth_method = DeviceCode
client_id = client-id
tenant_id = tenant-id
mailbox = shared@example.com
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
parsedmarc.cli._main()
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("auth_method"), "DeviceCode"
)
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("mailbox"),
"shared@example.com",
)
self.assertIsNone(mock_graph_connection.call_args.kwargs.get("username"))
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
@patch("parsedmarc.cli.logger")
def testCliRequiresMsGraphTenantIdForDeviceCodeAuth(
self, mock_logger, mock_graph_connection, mock_get_mailbox_reports
):
config_text = """[general]
silent = true
[msgraph]
auth_method = DeviceCode
client_id = client-id
mailbox = shared@example.com
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit) as system_exit:
parsedmarc.cli._main()
self.assertEqual(system_exit.exception.code, -1)
mock_logger.critical.assert_called_once_with(
"tenant_id setting missing from the msgraph config section"
)
mock_graph_connection.assert_not_called()
mock_get_mailbox_reports.assert_not_called()
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
@patch("parsedmarc.cli.logger")
def testCliRequiresMsGraphMailboxForDeviceCodeAuth(
self, mock_logger, mock_graph_connection, mock_get_mailbox_reports
):
config_text = """[general]
silent = true
[msgraph]
auth_method = DeviceCode
client_id = client-id
tenant_id = tenant-id
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit) as system_exit:
parsedmarc.cli._main()
self.assertEqual(system_exit.exception.code, -1)
mock_logger.critical.assert_called_once_with(
"mailbox setting missing from the msgraph config section"
)
mock_graph_connection.assert_not_called()
mock_get_mailbox_reports.assert_not_called()
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
@patch("parsedmarc.cli.logger")
def testCliRequiresMsGraphTenantIdForCertificateAuth(
self, mock_logger, mock_graph_connection, mock_get_mailbox_reports
):
config_text = """[general]
silent = true
[msgraph]
auth_method = Certificate
client_id = client-id
mailbox = shared@example.com
certificate_path = /tmp/msgraph-cert.pem
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit) as system_exit:
parsedmarc.cli._main()
self.assertEqual(system_exit.exception.code, -1)
mock_logger.critical.assert_called_once_with(
"tenant_id setting missing from the msgraph config section"
)
mock_graph_connection.assert_not_called()
mock_get_mailbox_reports.assert_not_called()
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
@patch("parsedmarc.cli.logger")
def testCliRequiresMsGraphMailboxForCertificateAuth(
self, mock_logger, mock_graph_connection, mock_get_mailbox_reports
):
config_text = """[general]
silent = true
[msgraph]
auth_method = Certificate
client_id = client-id
tenant_id = tenant-id
certificate_path = /tmp/msgraph-cert.pem
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit) as system_exit:
parsedmarc.cli._main()
self.assertEqual(system_exit.exception.code, -1)
mock_logger.critical.assert_called_once_with(
"mailbox setting missing from the msgraph config section"
)
mock_graph_connection.assert_not_called()
mock_get_mailbox_reports.assert_not_called()
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliPassesMsGraphClientAssertionAuthSettings(
self, mock_graph_connection, mock_get_mailbox_reports
):
mock_graph_connection.return_value = object()
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
config_text = """[general]
silent = true
[msgraph]
auth_method = ClientAssertion
client_id = client-id
client_assertion = signed-jwt-assertion
tenant_id = tenant-id
mailbox = shared@example.com
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
parsedmarc.cli._main()
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("auth_method"),
"ClientAssertion",
)
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("client_assertion"),
"signed-jwt-assertion",
)
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("tenant_id"), "tenant-id"
)
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("mailbox"),
"shared@example.com",
)
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
@patch("parsedmarc.cli.logger")
def testCliRequiresMsGraphClientAssertionForClientAssertionAuth(
self, mock_logger, mock_graph_connection, mock_get_mailbox_reports
):
config_text = """[general]
silent = true
[msgraph]
auth_method = ClientAssertion
client_id = client-id
tenant_id = tenant-id
mailbox = shared@example.com
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit) as system_exit:
parsedmarc.cli._main()
self.assertEqual(system_exit.exception.code, -1)
mock_logger.critical.assert_called_once_with(
"client_assertion setting missing from the msgraph config section"
)
mock_graph_connection.assert_not_called()
mock_get_mailbox_reports.assert_not_called()
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
@patch("parsedmarc.cli.logger")
def testCliRequiresMsGraphTenantIdForClientAssertionAuth(
self, mock_logger, mock_graph_connection, mock_get_mailbox_reports
):
config_text = """[general]
silent = true
[msgraph]
auth_method = ClientAssertion
client_id = client-id
client_assertion = signed-jwt-assertion
mailbox = shared@example.com
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit) as system_exit:
parsedmarc.cli._main()
self.assertEqual(system_exit.exception.code, -1)
mock_logger.critical.assert_called_once_with(
"tenant_id setting missing from the msgraph config section"
)
mock_graph_connection.assert_not_called()
mock_get_mailbox_reports.assert_not_called()
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
@patch("parsedmarc.cli.logger")
def testCliRequiresMsGraphMailboxForClientAssertionAuth(
self, mock_logger, mock_graph_connection, mock_get_mailbox_reports
):
config_text = """[general]
silent = true
[msgraph]
auth_method = ClientAssertion
client_id = client-id
client_assertion = signed-jwt-assertion
tenant_id = tenant-id
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit) as system_exit:
parsedmarc.cli._main()
self.assertEqual(system_exit.exception.code, -1)
mock_logger.critical.assert_called_once_with(
"mailbox setting missing from the msgraph config section"
)
mock_graph_connection.assert_not_called()
mock_get_mailbox_reports.assert_not_called()
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliAcceptsLowercaseMsGraphCertificateAuthMethod(
self, mock_graph_connection, mock_get_mailbox_reports
):
"""auth_method values are case-insensitive (e.g. ``certificate``)."""
mock_graph_connection.return_value = object()
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
config_text = """[general]
silent = true
[msgraph]
auth_method = certificate
client_id = client-id
tenant_id = tenant-id
mailbox = shared@example.com
certificate_path = /tmp/msgraph-cert.pem
certificate_password = cert-pass
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
parsedmarc.cli._main()
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("auth_method"), "Certificate"
)
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("mailbox"),
"shared@example.com",
)
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("certificate_path"),
"/tmp/msgraph-cert.pem",
)
self.assertEqual(
mock_graph_connection.call_args.kwargs.get("certificate_password"),
"cert-pass",
)
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
@patch("parsedmarc.cli.logger")
def testCliRejectsInvalidMsGraphAuthMethod(
self, mock_logger, mock_graph_connection, mock_get_mailbox_reports
):
config_text = """[general]
silent = true
[msgraph]
auth_method = NotARealMethod
client_id = client-id
tenant_id = tenant-id
mailbox = shared@example.com
certificate_path = /tmp/msgraph-cert.pem
"""
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit) as system_exit:
parsedmarc.cli._main()
self.assertEqual(system_exit.exception.code, -1)
mock_logger.critical.assert_called_once()
critical_message = mock_logger.critical.call_args.args[0]
self.assertIn("Invalid msgraph auth_method", critical_message)
self.assertIn("NotARealMethod", critical_message)
mock_graph_connection.assert_not_called()
mock_get_mailbox_reports.assert_not_called()
class TestMSGraphConnectionLogging(unittest.TestCase):
"""MS Graph connection observability (issue #814): a redacted
connection summary is logged before connecting, timing after, secret
values never appear in log output, and the dependency loggers that
carry the actual auth/HTTP activity (mailsuite, azure, msgraph,
httpx, httpcore) follow parsedmarc's --verbose/--debug level."""
CERT_CONFIG = """[general]
silent = true
[msgraph]
auth_method = Certificate
client_id = client-id-1234
tenant_id = tenant-id-5678
mailbox = shared@example.com
certificate_path = /tmp/msgraph-cert.pem
certificate_password = s3cret-cert-pass
"""
def setUp(self):
# _configure_dependency_logging mutates process-global loggers;
# snapshot and restore their levels and handlers so these tests
# don't leak state into the rest of the suite.
saved = {}
for name in parsedmarc.cli._DEPENDENCY_LOGGERS:
dep = logging.getLogger(name)
saved[name] = (dep.level, list(dep.handlers), dep.propagate)
def restore():
for name, (level, handlers, propagate) in saved.items():
dep = logging.getLogger(name)
dep.setLevel(level)
dep.handlers = handlers
dep.propagate = propagate
self.addCleanup(restore)
def _write_config(self, config_text):
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
return cfg_path
def _run_main(self, cfg_path, *cli_args):
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path, *cli_args]):
parsedmarc.cli._main()
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliLogsMsGraphConnectionSummaryAndTiming(
self, mock_graph_connection, mock_get_mailbox_reports
):
"""The INFO summary identifies the auth method, tenant, client,
mailbox, and Graph URL before any network I/O, and a timing line
follows once the connection object is initialized."""
mock_graph_connection.return_value = object()
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
cfg_path = self._write_config(self.CERT_CONFIG)
with self.assertLogs("parsedmarc.log", level="INFO") as cm:
self._run_main(cfg_path, "--verbose")
output = "\n".join(cm.output)
self.assertIn("Connecting to Microsoft Graph", output)
self.assertIn("auth_method=Certificate", output)
self.assertIn("tenant_id=tenant-id-5678", output)
self.assertIn("client_id=client-id-1234", output)
self.assertIn("mailbox=shared@example.com", output)
self.assertIn("graph_url=https://graph.microsoft.com", output)
self.assertIn("Microsoft Graph connection initialized in", output)
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliMsGraphLoggingNeverLogsSecretValues(
self, mock_graph_connection, mock_get_mailbox_reports
):
"""Even at --debug, secret values (certificate_password and
client_assertion here) must not appear anywhere in parsedmarc's
log output — the debug detail line reports set/not-set flags
instead."""
mock_graph_connection.return_value = object()
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
cfg_path = self._write_config(self.CERT_CONFIG)
with self.assertLogs("parsedmarc.log", level="DEBUG") as cm:
self._run_main(cfg_path, "--debug")
output = "\n".join(cm.output)
self.assertNotIn("s3cret-cert-pass", output)
self.assertIn("certificate_path=/tmp/msgraph-cert.pem", output)
self.assertIn("certificate_password set", output)
self.assertIn("client_assertion not set", output)
assertion_config = """[general]
silent = true
[msgraph]
auth_method = ClientAssertion
client_id = client-id-1234
tenant_id = tenant-id-5678
mailbox = shared@example.com
client_assertion = s3cret-signed-jwt-assertion
"""
cfg_path = self._write_config(assertion_config)
with self.assertLogs("parsedmarc.log", level="DEBUG") as cm:
self._run_main(cfg_path, "--debug")
output = "\n".join(cm.output)
self.assertNotIn("s3cret-signed-jwt-assertion", output)
self.assertIn("client_assertion set", output)
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliDebugEnablesDependencyLoggers(
self, mock_graph_connection, mock_get_mailbox_reports
):
"""--debug propagates DEBUG level and parsedmarc's handlers to the
mailsuite/azure/msgraph/httpx/httpcore loggers, so token and HTTP
activity reaches the console (and log file) instead of being
dropped."""
mock_graph_connection.return_value = object()
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
cfg_path = self._write_config(self.CERT_CONFIG)
self._run_main(cfg_path, "--debug")
parsedmarc_logger = logging.getLogger("parsedmarc.log")
for name in parsedmarc.cli._DEPENDENCY_LOGGERS:
dep = logging.getLogger(name)
self.assertEqual(dep.level, logging.DEBUG, name)
# Propagation is disabled so a stray logging.basicConfig()
# elsewhere in the process can't double-print these records.
self.assertFalse(dep.propagate, name)
for wanted in parsedmarc_logger.handlers:
self.assertIn(wanted, dep.handlers, name)
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliDefaultKeepsDependencyLoggersAtWarning(
self, mock_graph_connection, mock_get_mailbox_reports
):
"""Without --verbose/--debug, dependency loggers sit at WARNING —
their warnings surface (formatted) but no new noise appears."""
mock_graph_connection.return_value = object()
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
cfg_path = self._write_config(self.CERT_CONFIG)
self._run_main(cfg_path)
for name in parsedmarc.cli._DEPENDENCY_LOGGERS:
self.assertEqual(logging.getLogger(name).level, logging.WARNING, name)
class TestMSGraphEmailResults(unittest.TestCase):
"""#472: the periodic summary email is sent via the same
already-authenticated Microsoft Graph mailbox connection when
[smtp] host is not configured but [msgraph] is, so M365 tenants that
block legacy SMTP AUTH can still receive the summary from the
mailbox they already read reports from. SMTP is preferred when
[smtp] host is set."""
CERT_CONFIG = """[general]
silent = true
[msgraph]
auth_method = Certificate
client_id = client-id-1234
tenant_id = tenant-id-5678
mailbox = shared@example.com
certificate_path = /tmp/msgraph-cert.pem
certificate_password = s3cret-cert-pass
"""
def setUp(self):
# _configure_dependency_logging mutates process-global loggers;
# snapshot and restore their levels and handlers so these tests
# don't leak state into the rest of the suite.
saved = {}
for name in parsedmarc.cli._DEPENDENCY_LOGGERS:
dep = logging.getLogger(name)
saved[name] = (dep.level, list(dep.handlers), dep.propagate)
def restore():
for name, (level, handlers, propagate) in saved.items():
dep = logging.getLogger(name)
dep.setLevel(level)
dep.handlers = handlers
dep.propagate = propagate
self.addCleanup(restore)
def _write_config(self, config_text):
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
return cfg_path
def _run_main(self, cfg_path, *cli_args):
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path, *cli_args]):
parsedmarc.cli._main()
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliSendsSummaryEmailViaMsGraphWhenNoSmtpHost(
self, mock_graph_connection, mock_get_mailbox_reports
):
"""[smtp] with only to/subject (no host) plus [msgraph] sends the
summary via Microsoft Graph's sendMail."""
mock_get_mailbox_reports.return_value = {
"aggregate_reports": _sample_aggregate_reports(),
"failure_reports": [],
"smtp_tls_reports": [],
}
config_text = (
self.CERT_CONFIG
+ """
[smtp]
to = admin@example.com
subject = DMARC Summary
"""
)
cfg_path = self._write_config(config_text)
self._run_main(cfg_path)
send_message = mock_graph_connection.return_value.send_message
send_message.assert_called_once()
call_kwargs = send_message.call_args.kwargs
self.assertEqual(call_kwargs["message_to"], ["admin@example.com"])
self.assertEqual(call_kwargs["subject"], "DMARC Summary")
filename, payload = call_kwargs["attachments"][0]
self.assertRegex(filename, r"^DMARC-\d{4}-\d{2}-\d{2}\.zip$")
with zipfile.ZipFile(io.BytesIO(payload)) as zf:
self.assertIsNone(zf.testzip())
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliSkipsMsGraphSummaryEmailWhenNothingWasParsed(
self, mock_graph_connection, mock_get_mailbox_reports
):
"""Regression test for the Microsoft Graph half of the #200
empty-run guard: with an empty mailbox (no aggregate, failure,
or SMTP TLS reports), the Graph-sent summary email must not be
sent, and an INFO log line should explain why it was skipped.
A refactor that narrows the skip guard's condition to only the
SMTP branch (dropping the msgraph_connection/smtp_to_value
check) must fail this test."""
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
# verbose=true is added (CERT_CONFIG only sets silent=true) so the
# logger's effective level is INFO and the skip message is
# actually emitted for assertLogs to capture.
config_text = (
self.CERT_CONFIG.replace("silent = true", "silent = true\nverbose = true")
+ """
[smtp]
to = admin@example.com
subject = DMARC Summary
"""
)
cfg_path = self._write_config(config_text)
with self.assertLogs("parsedmarc.log", level="INFO") as logs:
self._run_main(cfg_path)
mock_graph_connection.return_value.send_message.assert_not_called()
self.assertTrue(
any("skipping the results email" in line for line in logs.output)
)
@patch("parsedmarc.cli.email_results")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliPrefersSmtpWhenBothSmtpAndMsGraphConfigured(
self, mock_graph_connection, mock_get_mailbox_reports, mock_email_results
):
"""SMTP is preferred over Microsoft Graph when [smtp] host is
set, even with [msgraph] also configured — no fallback, no
dual-send."""
mock_get_mailbox_reports.return_value = {
"aggregate_reports": _sample_aggregate_reports(),
"failure_reports": [],
"smtp_tls_reports": [],
}
config_text = (
self.CERT_CONFIG
+ """
[smtp]
host = smtp.example.com
user = smtp-user
password = smtp-password
from = dmarc@example.com
to = admin@example.com
"""
)
cfg_path = self._write_config(config_text)
self._run_main(cfg_path)
mock_email_results.assert_called_once()
call_args = mock_email_results.call_args
self.assertEqual(call_args.args[1], "smtp.example.com")
self.assertEqual(call_args.args[2], "dmarc@example.com")
self.assertEqual(call_args.args[3], ["admin@example.com"])
self.assertEqual(call_args.kwargs["username"], "smtp-user")
self.assertEqual(call_args.kwargs["password"], "smtp-password")
mock_graph_connection.return_value.send_message.assert_not_called()
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliSkipsGraphSendWithoutSmtpSection(
self, mock_graph_connection, mock_get_mailbox_reports
):
"""A [msgraph]-only, read-only config (no [smtp] section at all)
sends nothing — unchanged behavior for existing reading-only
users."""
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
cfg_path = self._write_config(self.CERT_CONFIG)
self._run_main(cfg_path)
mock_graph_connection.return_value.send_message.assert_not_called()
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
@patch("parsedmarc.cli.logger")
def testCliSmtpWithoutHostRequiresMsGraph(
self, mock_logger, mock_graph_connection, mock_get_mailbox_reports
):
"""[smtp] with to but no host, and no [msgraph] configured at
all, still fails config parsing exactly as it did before this
feature — host is only optional when a Graph connection can
send instead."""
config_text = """[general]
silent = true
[smtp]
to = admin@example.com
"""
cfg_path = self._write_config(config_text)
with self.assertRaises(SystemExit) as system_exit:
self._run_main(cfg_path)
self.assertEqual(system_exit.exception.code, -1)
mock_logger.critical.assert_called_once_with(
"host setting missing from the smtp config section"
)
mock_graph_connection.assert_not_called()
mock_get_mailbox_reports.assert_not_called()
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliLogsMsGraphSendFailure(
self, mock_graph_connection, mock_get_mailbox_reports
):
"""A Graph sendMail failure gets the same single-ERROR-line
treatment as connection/fetch failures."""
mock_get_mailbox_reports.return_value = {
"aggregate_reports": _sample_aggregate_reports(),
"failure_reports": [],
"smtp_tls_reports": [],
}
mock_graph_connection.return_value.send_message.side_effect = ODataError(
response_status_code=403,
error=MainError(
message="Access is denied",
inner_error=InnerError(request_id="rid-1", client_request_id="crid-1"),
),
)
config_text = (
self.CERT_CONFIG
+ """
[smtp]
to = admin@example.com
subject = DMARC Summary
"""
)
cfg_path = self._write_config(config_text)
with self.assertLogs("parsedmarc.log", level="ERROR") as cm:
with self.assertRaises(SystemExit) as system_exit:
self._run_main(cfg_path)
self.assertEqual(system_exit.exception.code, 1)
output = "\n".join(cm.output)
self.assertIn("Microsoft Graph message send failed", output)
self.assertIn("mailbox=", output)
self.assertIn("tenant_id=", output)
self.assertIn("auth_method=Certificate", output)
self.assertIn("status=403", output)
self.assertIn("request-id=rid-1", output)
self.assertIn("client-request-id=crid-1", output)
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliPassesSmtpAttachmentAndMessageToMsGraphSend(
self, mock_graph_connection, mock_get_mailbox_reports
):
"""[smtp] attachment/message are parsed but were never wired
through to either summary-email transport. On the Microsoft
Graph path, the configured attachment filename and message
body must reach send_message()."""
mock_get_mailbox_reports.return_value = {
"aggregate_reports": _sample_aggregate_reports(),
"failure_reports": [],
"smtp_tls_reports": [],
}
config_text = (
self.CERT_CONFIG
+ """
[smtp]
to = admin@example.com
attachment = custom-report.zip
message = Custom body text
"""
)
cfg_path = self._write_config(config_text)
self._run_main(cfg_path)
send_message = mock_graph_connection.return_value.send_message
send_message.assert_called_once()
call_kwargs = send_message.call_args.kwargs
self.assertEqual(call_kwargs["attachments"][0][0], "custom-report.zip")
self.assertEqual(call_kwargs["plain_message"], "Custom body text")
class TestMSGraphFailureLogging(unittest.TestCase):
"""Microsoft Graph connection/fetch/watch failures log a single
clear ERROR line identifying the mailbox/tenant/auth method and
the Graph request-id/client-request-id when available, instead of
a bare logger.exception() that hides the actual error."""
CERT_CONFIG = """[general]
silent = true
[msgraph]
auth_method = Certificate
client_id = client-id-1234
tenant_id = tenant-id-5678
mailbox = shared@example.com
certificate_path = /tmp/msgraph-cert.pem
certificate_password = s3cret-cert-pass
"""
def setUp(self):
saved = {}
for name in parsedmarc.cli._DEPENDENCY_LOGGERS:
dep = logging.getLogger(name)
saved[name] = (dep.level, list(dep.handlers), dep.propagate)
def restore():
for name, (level, handlers, propagate) in saved.items():
dep = logging.getLogger(name)
dep.setLevel(level)
dep.handlers = handlers
dep.propagate = propagate
self.addCleanup(restore)
def _write_config(self, config_text):
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
return cfg_path
def _run_main(self, cfg_path, *cli_args):
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path, *cli_args]):
parsedmarc.cli._main()
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliLogsMsGraphConnectionAuthFailureContext(
self, mock_graph_connection, mock_get_mailbox_reports
):
"""An auth failure during connection construction logs the
redacted context plus the actionable AADSTS code verbatim."""
mock_graph_connection.side_effect = ClientAuthenticationError(
"AADSTS7000215: Invalid client secret"
)
cfg_path = self._write_config(self.CERT_CONFIG)
with self.assertLogs("parsedmarc.log", level="ERROR") as cm:
with self.assertRaises(SystemExit) as system_exit:
self._run_main(cfg_path)
self.assertEqual(system_exit.exception.code, 1)
output = "\n".join(cm.output)
self.assertIn("Microsoft Graph connection failed", output)
self.assertIn("mailbox=shared@example.com", output)
self.assertIn("tenant_id=tenant-id-5678", output)
self.assertIn("auth_method=Certificate", output)
self.assertIn("AADSTS7000215", output)
mock_get_mailbox_reports.assert_not_called()
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliLogsMsGraphMailboxFetchFailureWithRequestId(
self, mock_graph_connection, mock_get_mailbox_reports
):
"""A mailbox-fetch failure (the most common real-world auth
failure point, since app-only auth defers token acquisition to
first use) surfaces both OData inner-error request ids."""
mock_get_mailbox_reports.side_effect = ODataError(
response_status_code=503,
error=MainError(
message="Service unavailable",
inner_error=InnerError(request_id="rid-2", client_request_id="crid-2"),
),
)
cfg_path = self._write_config(self.CERT_CONFIG)
with self.assertLogs("parsedmarc.log", level="ERROR") as cm:
with self.assertRaises(SystemExit) as system_exit:
self._run_main(cfg_path)
self.assertEqual(system_exit.exception.code, 1)
output = "\n".join(cm.output)
self.assertIn("Microsoft Graph mailbox fetch failed", output)
self.assertIn("request-id=rid-2", output)
self.assertIn("client-request-id=crid-2", output)
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliMsGraphErrorFallsBackToResponseHeaderRequestId(
self, mock_graph_connection, mock_get_mailbox_reports
):
"""When the response body didn't deserialize into a proper OData
inner error, the request-id still surfaces from the raw
response headers."""
mock_get_mailbox_reports.side_effect = ODataError(
response_status_code=503,
response_headers={"request-id": "hdr-rid"},
error=None,
)
cfg_path = self._write_config(self.CERT_CONFIG)
with self.assertLogs("parsedmarc.log", level="ERROR") as cm:
with self.assertRaises(SystemExit):
self._run_main(cfg_path)
output = "\n".join(cm.output)
self.assertIn("request-id=hdr-rid", output)
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testCliMsGraphErrorOmitsRequestIdWhenAbsent(
self, mock_graph_connection, mock_get_mailbox_reports
):
"""When neither an inner error nor a response header carries a
request id, the ERROR line simply omits the suffix rather than
printing an empty/misleading id."""
mock_get_mailbox_reports.side_effect = ODataError(response_status_code=500)
cfg_path = self._write_config(self.CERT_CONFIG)
with self.assertLogs("parsedmarc.log", level="ERROR") as cm:
with self.assertRaises(SystemExit) as system_exit:
self._run_main(cfg_path)
self.assertEqual(system_exit.exception.code, 1)
output = "\n".join(cm.output)
self.assertNotIn("request-id=", output)
@patch("parsedmarc.cli.watch_inbox", side_effect=httpx.ConnectError("dns failure"))
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.MSGraphConnection")
def testWatchModeLogsMsGraphErrorAndExits(
self, mock_graph_connection, mock_get_mailbox_reports, mock_watch_inbox
):
"""Before this fix, --watch had no catch-all at all for Graph
errors, so a token/cert expiry mid-watch crashed with a raw
uncaught traceback. It now gets the same single ERROR line."""
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
config_text = self.CERT_CONFIG + "\n[mailbox]\nwatch = true\n"
cfg_path = self._write_config(config_text)
with self.assertLogs("parsedmarc.log", level="ERROR") as cm:
with self.assertRaises(SystemExit) as system_exit:
self._run_main(cfg_path)
self.assertEqual(system_exit.exception.code, 1)
output = "\n".join(cm.output)
self.assertIn("Microsoft Graph mailbox watch failed", output)
self.assertIn("ConnectError", output)
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.IMAPConnection")
def testNonGraphMailboxErrorIsNotMislabeledAsMsGraph(
self, mock_imap_connection, mock_get_mailbox_reports
):
"""The mailbox-fetch handler catches
(ClientAuthenticationError, APIError, httpx.HTTPError) on every
mailbox backend, not just Graph, since httpx.HTTPError can in
principle surface from any HTTP-backed connection. Before this
fix, such an error on a non-Graph connection (e.g. IMAP) still
went through _log_msgraph_failure() and logged a misleading
"Microsoft Graph ... failed (mailbox=None, tenant_id=None,
auth_method=None)" line. It must now log a generic
"Mailbox Error" instead."""
mock_imap_connection.return_value = object()
mock_get_mailbox_reports.side_effect = httpx.ConnectError("boom")
config_text = """[general]
silent = true
[imap]
host = imap.example.com
user = test-user
password = test-password
"""
cfg_path = self._write_config(config_text)
with self.assertLogs("parsedmarc.log", level="ERROR") as cm:
with self.assertRaises(SystemExit) as system_exit:
self._run_main(cfg_path)
self.assertEqual(system_exit.exception.code, 1)
output = "\n".join(cm.output)
self.assertIn("Mailbox Error", output)
self.assertNotIn("Microsoft Graph", output)
class TestSighupReload(unittest.TestCase):
"""Tests for SIGHUP-driven configuration reload in watch mode."""
def setUp(self):
from parsedmarc.log import logger as _logger
_logger.disabled = True
self._stdout_patch = patch("sys.stdout", new_callable=io.StringIO)
self._stderr_patch = patch("sys.stderr", new_callable=io.StringIO)
self._stdout_patch.start()
self._stderr_patch.start()
def tearDown(self):
from parsedmarc.log import logger as _logger
_logger.disabled = False
self._stderr_patch.stop()
self._stdout_patch.stop()
_BASE_CONFIG = """[general]
silent = true
[imap]
host = imap.example.com
user = user
password = pass
[mailbox]
watch = true
"""
@unittest.skipUnless(
hasattr(signal, "SIGHUP"),
"SIGHUP not available on this platform",
)
@patch("parsedmarc.cli._init_output_clients")
@patch("parsedmarc.cli._parse_config")
@patch("parsedmarc.cli._load_config")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.watch_inbox")
@patch("parsedmarc.cli.IMAPConnection")
def testSighupTriggersReloadAndWatchRestarts(
self,
mock_imap,
mock_watch,
mock_get_reports,
mock_load_config,
mock_parse_config,
mock_init_clients,
):
"""SIGHUP causes watch to return, config is re-parsed, and watch restarts."""
import signal as signal_module
mock_imap.return_value = object()
mock_get_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
mock_load_config.return_value = ConfigParser()
def parse_side_effect(config, opts):
opts.imap_host = "imap.example.com"
opts.imap_user = "user"
opts.imap_password = "pass"
opts.mailbox_watch = True
return None
mock_parse_config.side_effect = parse_side_effect
mock_init_clients.return_value = {}
call_count = [0]
def watch_side_effect(*args, **kwargs):
call_count[0] += 1
if call_count[0] == 1:
# Simulate SIGHUP arriving while watch is running
if hasattr(signal_module, "SIGHUP"):
import os
os.kill(os.getpid(), signal_module.SIGHUP)
return # Normal return — reload loop will continue
else:
raise FileExistsError("stop-watch-loop")
mock_watch.side_effect = watch_side_effect
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(self._BASE_CONFIG)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit) as cm:
parsedmarc.cli._main()
# Exited with code 1 (from FileExistsError handler)
self.assertEqual(cm.exception.code, 1)
# watch_inbox was called twice: initial run + after reload
self.assertEqual(mock_watch.call_count, 2)
# _parse_config called for initial load + reload
self.assertGreaterEqual(mock_parse_config.call_count, 2)
@unittest.skipUnless(
hasattr(signal, "SIGHUP"),
"SIGHUP not available on this platform",
)
@patch("parsedmarc.cli._init_output_clients")
@patch("parsedmarc.cli._parse_config")
@patch("parsedmarc.cli._load_config")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.watch_inbox")
@patch("parsedmarc.cli.IMAPConnection")
def testInvalidConfigOnReloadKeepsPreviousState(
self,
mock_imap,
mock_watch,
mock_get_reports,
mock_load_config,
mock_parse_config,
mock_init_clients,
):
"""A failing reload leaves opts and clients unchanged."""
import signal as signal_module
mock_imap.return_value = object()
mock_get_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
mock_load_config.return_value = ConfigParser()
# Initial parse sets required opts; reload parse raises
initial_map = {"prefix_": ["example.com"]}
call_count = [0]
def parse_side_effect(config, opts):
call_count[0] += 1
opts.imap_host = "imap.example.com"
opts.imap_user = "user"
opts.imap_password = "pass"
opts.mailbox_watch = True
if call_count[0] == 1:
return initial_map
raise RuntimeError("bad config")
mock_parse_config.side_effect = parse_side_effect
initial_clients = {"s3_client": MagicMock()}
mock_init_clients.return_value = initial_clients
watch_calls = [0]
def watch_side_effect(*args, **kwargs):
watch_calls[0] += 1
if watch_calls[0] == 1:
if hasattr(signal_module, "SIGHUP"):
import os
os.kill(os.getpid(), signal_module.SIGHUP)
return
else:
raise FileExistsError("stop")
mock_watch.side_effect = watch_side_effect
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(self._BASE_CONFIG)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit) as cm:
parsedmarc.cli._main()
self.assertEqual(cm.exception.code, 1)
# watch was still called twice (reload loop continued after failed reload)
self.assertEqual(mock_watch.call_count, 2)
# Old clients should NOT have been closed (reload failed before swap)
initial_clients["s3_client"].close.assert_not_called()
@unittest.skipUnless(
hasattr(signal, "SIGHUP"),
"SIGHUP not available on this platform",
)
@patch("parsedmarc.cli._init_output_clients")
@patch("parsedmarc.cli._parse_config")
@patch("parsedmarc.cli._load_config")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.watch_inbox")
@patch("parsedmarc.cli.IMAPConnection")
def testReloadClosesOldClients(
self,
mock_imap,
mock_watch,
mock_get_reports,
mock_load_config,
mock_parse_config,
mock_init_clients,
):
"""Successful reload closes the old output clients before replacing them."""
import signal as signal_module
mock_imap.return_value = object()
mock_get_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
mock_load_config.return_value = ConfigParser()
def parse_side_effect(config, opts):
opts.imap_host = "imap.example.com"
opts.imap_user = "user"
opts.imap_password = "pass"
opts.mailbox_watch = True
return None
mock_parse_config.side_effect = parse_side_effect
old_client = MagicMock()
new_client = MagicMock()
init_call = [0]
def init_side_effect(opts):
init_call[0] += 1
if init_call[0] == 1:
return {"kafka_client": old_client}
return {"kafka_client": new_client}
mock_init_clients.side_effect = init_side_effect
watch_calls = [0]
def watch_side_effect(*args, **kwargs):
watch_calls[0] += 1
if watch_calls[0] == 1:
if hasattr(signal_module, "SIGHUP"):
import os
os.kill(os.getpid(), signal_module.SIGHUP)
return
else:
raise FileExistsError("stop")
mock_watch.side_effect = watch_side_effect
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(self._BASE_CONFIG)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit):
parsedmarc.cli._main()
# Old client must have been closed when reload succeeded
old_client.close.assert_called_once()
@unittest.skipUnless(
hasattr(signal, "SIGHUP"),
"SIGHUP not available on this platform",
)
@patch("parsedmarc.cli._init_output_clients")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.watch_inbox")
@patch("parsedmarc.cli.IMAPConnection")
def testRemovedConfigSectionTakesEffectOnReload(
self,
mock_imap,
mock_watch,
mock_get_reports,
mock_init_clients,
):
"""Removing a config section on reload resets that option to its default."""
import signal as signal_module
mock_imap.return_value = object()
mock_get_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
mock_init_clients.return_value = {}
# First config sets kafka_hosts (with required topics); second removes it.
config_v1 = (
self._BASE_CONFIG
+ "\n[kafka]\nhosts = kafka.example.com:9092\n"
+ "aggregate_topic = dmarc_agg\n"
+ "forensic_topic = dmarc_forensic\n"
+ "smtp_tls_topic = smtp_tls\n"
)
config_v2 = self._BASE_CONFIG # no [kafka] section
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_v1)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
watch_calls = [0]
def watch_side_effect(*args, **kwargs):
watch_calls[0] += 1
if watch_calls[0] == 1:
# Rewrite config to remove kafka before triggering reload
with open(cfg_path, "w") as f:
f.write(config_v2)
if hasattr(signal_module, "SIGHUP"):
import os
os.kill(os.getpid(), signal_module.SIGHUP)
return
else:
raise FileExistsError("stop")
mock_watch.side_effect = watch_side_effect
# Capture opts used on each _init_output_clients call
init_opts_captures = []
def init_side_effect(opts):
from argparse import Namespace as NS
init_opts_captures.append(NS(**vars(opts)))
return {}
mock_init_clients.side_effect = init_side_effect
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit):
parsedmarc.cli._main()
# First init: kafka_hosts should be set from v1 config
self.assertIsNotNone(init_opts_captures[0].kafka_hosts)
# Second init (after reload with v2 config): kafka_hosts should be None
self.assertIsNone(init_opts_captures[1].kafka_hosts)
@unittest.skipUnless(
hasattr(signal, "SIGHUP"),
"SIGHUP not available on this platform",
)
@patch("parsedmarc.cli._init_output_clients")
@patch("parsedmarc.cli._parse_config")
@patch("parsedmarc.cli._load_config")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.watch_inbox")
@patch("parsedmarc.cli.IMAPConnection")
def testReloadRefreshesReverseDnsMap(
self,
mock_imap,
mock_watch,
mock_get_reports,
mock_load_config,
mock_parse_config,
mock_init_clients,
):
"""SIGHUP reload repopulates the reverse DNS map so lookups still work."""
import signal as signal_module
from parsedmarc import REVERSE_DNS_MAP
mock_imap.return_value = object()
mock_get_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
mock_load_config.return_value = ConfigParser()
def parse_side_effect(config, opts):
opts.imap_host = "imap.example.com"
opts.imap_user = "user"
opts.imap_password = "pass"
opts.mailbox_watch = True
return None
mock_parse_config.side_effect = parse_side_effect
mock_init_clients.return_value = {}
# Snapshot the map state after each watch_inbox call
map_snapshots = []
watch_calls = [0]
def watch_side_effect(*args, **kwargs):
watch_calls[0] += 1
if watch_calls[0] == 1:
if hasattr(signal_module, "SIGHUP"):
import os
os.kill(os.getpid(), signal_module.SIGHUP)
return
else:
# Capture the map state after reload, before we stop the loop
map_snapshots.append(dict(REVERSE_DNS_MAP))
raise FileExistsError("stop")
mock_watch.side_effect = watch_side_effect
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(self._BASE_CONFIG)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
# Pre-populate the map so we can verify it gets refreshed
REVERSE_DNS_MAP.clear()
REVERSE_DNS_MAP["stale.example.com"] = {
"name": "Stale",
"type": "stale",
}
original_contents = dict(REVERSE_DNS_MAP)
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit):
parsedmarc.cli._main()
self.assertEqual(mock_watch.call_count, 2)
# The map should have been repopulated (not empty, not the stale data)
self.assertEqual(len(map_snapshots), 1)
refreshed = map_snapshots[0]
self.assertGreater(len(refreshed), 0, "Map should not be empty after reload")
self.assertNotEqual(
refreshed,
original_contents,
"Map should have been refreshed, not kept stale data",
)
self.assertNotIn(
"stale.example.com",
refreshed,
"Stale entry should have been cleared by reload",
)
@unittest.skipUnless(
hasattr(signal, "SIGHUP"),
"SIGHUP not available on this platform",
)
@patch("parsedmarc.cli._init_output_clients")
@patch("parsedmarc.cli._parse_config")
@patch("parsedmarc.cli._load_config")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.watch_inbox")
@patch("parsedmarc.cli.IMAPConnection")
def test_sighup_reload_rebuilds_parser_config(
self,
mock_imap,
mock_watch,
mock_get_reports,
mock_load_config,
mock_parse_config,
mock_init_clients,
):
"""After a SIGHUP reload, the ParserConfig passed to watch_inbox as
``config=`` must reflect the reloaded ``[general] dns_timeout``, not
the value from the initial config load.
Guards against _build_parser_config(opts) being called only once at
startup: opts itself is correctly refreshed in place by the existing
``for k, v in vars(new_opts).items(): setattr(opts, k, v)`` loop, but
parser_config is a separate ParserConfig snapshot built from opts —
if the reload path forgot to rebuild it, watch_inbox would keep
receiving the stale pre-reload config object forever.
"""
import signal as signal_module
mock_imap.return_value = object()
mock_get_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
mock_load_config.return_value = ConfigParser()
parse_calls = [0]
def parse_side_effect(config, opts):
parse_calls[0] += 1
opts.imap_host = "imap.example.com"
opts.imap_user = "user"
opts.imap_password = "pass"
opts.mailbox_watch = True
opts.dns_timeout = 5.0 if parse_calls[0] == 1 else 42.0
return None
mock_parse_config.side_effect = parse_side_effect
mock_init_clients.return_value = {}
watch_calls = [0]
def watch_side_effect(*args, **kwargs):
watch_calls[0] += 1
if watch_calls[0] == 1:
if hasattr(signal_module, "SIGHUP"):
import os
os.kill(os.getpid(), signal_module.SIGHUP)
return
else:
raise FileExistsError("stop-watch-loop")
mock_watch.side_effect = watch_side_effect
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(self._BASE_CONFIG)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit):
parsedmarc.cli._main()
self.assertEqual(mock_watch.call_count, 2)
first_config = mock_watch.call_args_list[0].kwargs["config"]
second_config = mock_watch.call_args_list[1].kwargs["config"]
self.assertEqual(first_config.dns_timeout, 5.0)
self.assertEqual(second_config.dns_timeout, 42.0)
class TestSigtermShutdown(unittest.TestCase):
"""Tests for graceful SIGTERM/SIGINT shutdown."""
def setUp(self):
from parsedmarc.log import logger as _logger
_logger.disabled = True
self._stdout_patch = patch("sys.stdout", new_callable=io.StringIO)
self._stderr_patch = patch("sys.stderr", new_callable=io.StringIO)
self._stdout_patch.start()
self._stderr_patch.start()
def tearDown(self):
from parsedmarc.log import logger as _logger
_logger.disabled = False
self._stderr_patch.stop()
self._stdout_patch.stop()
_BASE_CONFIG = """[general]
silent = true
[imap]
host = imap.example.com
user = user
password = pass
[mailbox]
watch = true
"""
def _write_config(self, body=None):
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(body if body is not None else self._BASE_CONFIG)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
return cfg_path
@staticmethod
def _empty_reports():
return {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
@staticmethod
def _parse_config_side_effect(config, opts):
opts.imap_host = "imap.example.com"
opts.imap_user = "user"
opts.imap_password = "pass"
opts.mailbox_watch = True
return None
@patch("parsedmarc.cli._init_output_clients")
@patch("parsedmarc.cli._parse_config")
@patch("parsedmarc.cli._load_config")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.watch_inbox")
@patch("parsedmarc.cli.IMAPConnection")
def testSigtermDuringWatchExitsCleanlyAndClosesClients(
self,
mock_imap,
mock_watch,
mock_get_reports,
mock_load_config,
mock_parse_config,
mock_init_clients,
):
"""SIGTERM during watch: the backend polls config_reloading,
observes the flag, and returns at a safe boundary; _main breaks
the watch loop, returns normally, and closes every output client
that exposes a `.close()`."""
mock_imap.return_value = object()
mock_load_config.return_value = ConfigParser()
mock_parse_config.side_effect = self._parse_config_side_effect
mock_get_reports.return_value = self._empty_reports()
kafka_client = MagicMock(spec=["close"])
elasticsearch_client = MagicMock(spec=["close"])
no_close_client = MagicMock(spec=[]) # no `close` attr → skipped
mock_init_clients.return_value = {
"kafka": kafka_client,
"elasticsearch": elasticsearch_client,
"syslog": no_close_client,
}
observed = []
def watch_side_effect(*args, **kwargs):
# SIGTERM lands while watching; the backend then polls
# config_reloading at its next safe boundary and returns.
os.kill(os.getpid(), signal.SIGTERM)
observed.append(kwargs["config_reloading"]())
mock_watch.side_effect = watch_side_effect
cfg_path = self._write_config()
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
parsedmarc.cli._main()
self.assertEqual(mock_watch.call_count, 1)
self.assertEqual(observed, [True])
kafka_client.close.assert_called()
elasticsearch_client.close.assert_called()
@patch("parsedmarc.cli._init_output_clients")
@patch("parsedmarc.cli._parse_config")
@patch("parsedmarc.cli._load_config")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.watch_inbox")
@patch("parsedmarc.cli.IMAPConnection")
def testFirstSigintGracefulSecondSigintHardExits(
self,
mock_imap,
mock_watch,
mock_get_reports,
mock_load_config,
mock_parse_config,
mock_init_clients,
):
"""First SIGINT → graceful flag, second SIGINT → os._exit(130).
The installed handler is invoked directly via signal.getsignal()
because two POSIX SIGINTs sent in rapid succession from the same
process can be coalesced by the kernel (standard signals don't
queue)."""
mock_imap.return_value = object()
mock_load_config.return_value = ConfigParser()
mock_parse_config.side_effect = self._parse_config_side_effect
mock_get_reports.return_value = self._empty_reports()
mock_init_clients.return_value = {}
sentinel = SystemExit("os._exit was reached")
def fake_exit(code):
raise sentinel
def watch_side_effect(*args, **kwargs):
handler = signal.getsignal(signal.SIGINT)
# getsignal() can return SIG_DFL/SIG_IGN/None; narrow the type
# so the handler can be invoked directly.
assert callable(handler)
handler(signal.SIGINT, None) # first press: graceful flag
handler(signal.SIGINT, None) # second press: hits os._exit
mock_watch.side_effect = watch_side_effect
cfg_path = self._write_config()
with patch("parsedmarc.cli.os._exit", side_effect=fake_exit) as mock_exit:
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path]):
with self.assertRaises(SystemExit) as cm:
parsedmarc.cli._main()
self.assertIs(cm.exception, sentinel)
mock_exit.assert_called_once_with(130)
@patch("parsedmarc.cli.get_dmarc_reports_from_mbox")
@patch("parsedmarc.cli.is_mbox", side_effect=lambda p: p.endswith(".mbox"))
@patch("parsedmarc.cli._init_output_clients")
@patch("parsedmarc.parallel.ProcessPoolExecutor")
@patch("parsedmarc.cli.glob")
def testSigtermDuringOneShotStopsEarlyAndSkipsMbox(
self,
mock_glob,
mock_pool_cls,
mock_init_clients,
mock_is_mbox,
mock_get_mbox,
):
"""SIGTERM during one-shot processing: ``parallel_map``'s
``should_stop`` check (polled after each yielded result, see
``parsedmarc/parallel.py``) stops submitting new jobs once the flag
is set, and the subsequent mbox loop breaks on its first iteration
(the flag is already set). Output clients are still closed.
``ProcessPoolExecutor`` is patched at the stdlib boundary (mirrors
the old ``cli.Process`` patch) with a fake whose ``submit(fn, arg)``
runs ``fn(arg)`` inline and returns an already-completed
``Future``-like object, so no real subprocess is spawned and no
pickling occurs. SIGTERM is raised on the very first ``submit``
call, mirroring the old test's trigger on the first child's
``start()``.
``parallel_map`` primes its submission window up to
``2 * n_procs`` jobs *before* the first result is harvested and
``should_stop`` is ever checked (see ``parallel_map``'s docstring),
so with the default ``n_procs = 1`` the first two files are
submitted and run before the stop takes effect — the ``should_stop``
check only prevents a third submission. Four ``.xml`` files (more
than the window size) are supplied so that the stop is still
observable: exactly 2 of the 4 are submitted, not all of them. One
``.mbox`` file routes into ``mbox_paths`` so the mbox break is
exercised too. ``is_mbox`` is keyed by suffix so the fake filenames
don't trigger ``mailbox.mbox(path, create=True)``."""
mock_glob.return_value = ["a.xml", "b.xml", "c.xml", "d.xml", "e.mbox"]
kafka_client = MagicMock(spec=["close"])
mock_init_clients.return_value = {"kafka": kafka_client}
submitted = []
class FakeFuture:
def __init__(self, value):
self._value = value
def result(self, timeout=None):
return self._value
def cancelled(self):
return False
class FakeExecutor:
def __init__(self, *args, **kwargs):
pass
def __enter__(self):
return self
def __exit__(self, *exc_info):
return False
def submit(self, fn, arg):
if not submitted:
# Mirrors the old test's trigger on the first child's
# start(): SIGTERM arrives after the first job is
# dispatched but while the submission window is still
# being primed.
os.kill(os.getpid(), signal.SIGTERM)
submitted.append(arg)
return FakeFuture(fn(arg))
def shutdown(self, cancel_futures=True):
return None
mock_pool_cls.side_effect = FakeExecutor
with patch.object(
sys, "argv", ["parsedmarc", "a.xml", "b.xml", "c.xml", "d.xml", "e.mbox"]
):
parsedmarc.cli._main()
# The submission window (2 * n_procs, n_procs=1) primes 2 jobs
# before should_stop is first checked; the stop takes effect before
# a 3rd or 4th file is ever submitted.
self.assertEqual(len(submitted), 2)
mock_get_mbox.assert_not_called()
kafka_client.close.assert_called()
@patch("parsedmarc.cli._init_output_clients")
@patch("parsedmarc.cli.glob")
def testNormalOneShotExitClosesOutputClients(
self,
mock_glob,
mock_init_clients,
):
"""A successful one-shot run with no signal still closes its
output clients — regression for the long-standing leak where
_close_output_clients was only called inside the SIGHUP
reload path."""
mock_glob.return_value = []
kafka_client = MagicMock(spec=["close"])
es_client = MagicMock(spec=["close"])
mock_init_clients.return_value = {
"kafka": kafka_client,
"elasticsearch": es_client,
}
# No watch, no mailbox, no files → _main runs through with
# empty parsing_results and returns normally.
with patch.object(sys, "argv", ["parsedmarc", "nothing-here.xml"]):
try:
parsedmarc.cli._main()
except SystemExit:
pass
kafka_client.close.assert_called_once()
es_client.close.assert_called_once()
def _domain_map_tls_reports():
"""Four SMTP TLS reports for the index_prefix_domain_map tests: two
whose policy domains fold to the mapped base domain example.com (one of
them mixed-case), one for an unmapped domain, and one with an empty
policies list -- parse_smtp_tls_report_json() accepts those, and
get_index_prefix() must treat them as unmappable (dropped by the
filter) rather than crash on policies[0]."""
return [
{
"organization_name": "Allowed Org",
"begin_date": "2024-01-01T00:00:00Z",
"end_date": "2024-01-01T23:59:59Z",
"report_id": "allowed-1",
"contact_info": "tls@allowed.example.com",
"policies": [
{
"policy_domain": "allowed.example.com",
"policy_type": "sts",
"successful_session_count": 1,
"failed_session_count": 0,
}
],
},
{
"organization_name": "Unmapped Org",
"begin_date": "2024-01-01T00:00:00Z",
"end_date": "2024-01-01T23:59:59Z",
"report_id": "unmapped-1",
"contact_info": "tls@unmapped.example.net",
"policies": [
{
"policy_domain": "unmapped.example.net",
"policy_type": "sts",
"successful_session_count": 5,
"failed_session_count": 0,
}
],
},
{
"organization_name": "Mixed Case Org",
"begin_date": "2024-01-01T00:00:00Z",
"end_date": "2024-01-01T23:59:59Z",
"report_id": "mixed-case-1",
"contact_info": "tls@mixedcase.example.com",
"policies": [
{
"policy_domain": "MixedCase.Example.Com",
"policy_type": "sts",
"successful_session_count": 2,
"failed_session_count": 0,
}
],
},
{
"organization_name": "No Policies Org",
"begin_date": "2024-01-01T00:00:00Z",
"end_date": "2024-01-01T23:59:59Z",
"report_id": "no-policies-1",
"contact_info": "tls@nopolicies.example.org",
"policies": [],
},
]
class TestIndexPrefixDomainMapTlsFiltering(unittest.TestCase):
"""Tests that SMTP TLS reports for unmapped domains are filtered out
when index_prefix_domain_map is configured."""
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.IMAPConnection")
def testTlsReportsFilteredByDomainMap(
self,
mock_imap_connection,
mock_get_reports,
):
"""TLS reports for domains not in the map should be silently dropped."""
mock_imap_connection.return_value = object()
mock_get_reports.side_effect = _fetch_invoking_save_callback(
{
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": _domain_map_tls_reports(),
}
)
domain_map = {"tenant_a": ["example.com"]}
with NamedTemporaryFile("w", suffix=".yaml", delete=False) as map_file:
import yaml
yaml.dump(domain_map, map_file)
map_path = map_file.name
self.addCleanup(lambda: os.path.exists(map_path) and os.remove(map_path))
config = f"""[general]
save_smtp_tls = true
silent = false
index_prefix_domain_map = {map_path}
[imap]
host = imap.example.com
user = test-user
password = test-password
"""
with NamedTemporaryFile("w", suffix=".ini", delete=False) as config_file:
config_file.write(config)
config_path = config_file.name
self.addCleanup(lambda: os.path.exists(config_path) and os.remove(config_path))
captured = io.StringIO()
with patch.object(sys, "argv", ["parsedmarc", "-c", config_path]):
with patch("sys.stdout", captured):
parsedmarc.cli._main()
# A single JSON document, not two: a run whose only reports came
# from the mailbox saves them inside save_callback and skips the
# second, empty pass rather than printing another blob after it.
output = json.loads(captured.getvalue())
tls_reports = output["smtp_tls_reports"]
self.assertEqual(len(tls_reports), 2)
report_ids = {r["report_id"] for r in tls_reports}
self.assertIn("allowed-1", report_ids)
self.assertIn("mixed-case-1", report_ids)
self.assertNotIn("unmapped-1", report_ids)
# Unmappable (no policies -> no domain), dropped rather than an
# IndexError from get_index_prefix() on policies[0].
self.assertNotIn("no-policies-1", report_ids)
@patch("parsedmarc.cli.email_results")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.IMAPConnection")
def testTlsReportsFilteredForEmailResults(
self,
mock_imap_connection,
mock_get_reports,
mock_email_results,
):
"""The combined results handed to email_results() are filtered by
index_prefix_domain_map exactly like the batches that were saved.
Regression test: get_dmarc_reports_from_mailbox() builds its return
value from its own accumulated lists, not from the batch dict it
passes to save_callback, so the in-place filtering process_reports()
applies to each batch never reaches the combined dict. The mock
mirrors that by handing save_callback a copy while returning the
full, unfiltered set."""
mock_imap_connection.return_value = object()
reports_dict = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": _domain_map_tls_reports(),
}
mock_get_reports.side_effect = _fetch_invoking_save_callback(
reports_dict,
batch={
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": list(reports_dict["smtp_tls_reports"]),
},
)
domain_map = {"tenant_a": ["example.com"]}
with NamedTemporaryFile("w", suffix=".yaml", delete=False) as map_file:
import yaml
yaml.dump(domain_map, map_file)
map_path = map_file.name
self.addCleanup(lambda: os.path.exists(map_path) and os.remove(map_path))
config = f"""[general]
save_smtp_tls = true
silent = true
index_prefix_domain_map = {map_path}
[imap]
host = imap.example.com
user = test-user
password = test-password
[smtp]
host = smtp.example.com
user = smtp-user
password = smtp-password
from = dmarc@example.com
to = admin@example.com
"""
with NamedTemporaryFile("w", suffix=".ini", delete=False) as config_file:
config_file.write(config)
config_path = config_file.name
self.addCleanup(lambda: os.path.exists(config_path) and os.remove(config_path))
with patch.object(sys, "argv", ["parsedmarc", "-c", config_path]):
parsedmarc.cli._main()
mock_email_results.assert_called_once()
emailed_results = mock_email_results.call_args.args[0]
report_ids = {r["report_id"] for r in emailed_results["smtp_tls_reports"]}
self.assertEqual(report_ids, {"allowed-1", "mixed-case-1"})
class TestMailboxSaveCallbackWiring(unittest.TestCase):
"""The CLI's end of the #242 contract: the callback it hands to
get_dmarc_reports_from_mailbox() (and to watch_inbox()) reports whether
a batch reached every configured output destination, so the library
knows whether archiving that batch is safe."""
def setUp(self):
# _main()'s file-parsing loop dedups aggregate reports against this
# process-wide cache, so a sample parsed here would be dropped from
# a later test's results (and vice versa).
parsedmarc.SEEN_AGGREGATE_REPORT_IDS.clear()
self.addCleanup(parsedmarc.SEEN_AGGREGATE_REPORT_IDS.clear)
def _write_config(self, text):
with NamedTemporaryFile("w", suffix=".ini", delete=False) as config_file:
config_file.write(text)
config_path = config_file.name
self.addCleanup(lambda: os.path.exists(config_path) and os.remove(config_path))
return config_path
@patch("parsedmarc.cli.elastic.save_aggregate_report_to_elasticsearch")
@patch("parsedmarc.cli.elastic.migrate_indexes")
@patch("parsedmarc.cli.elastic.set_hosts")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.IMAPConnection")
def testSaveCallbackIsFalseOnlyWhenAnOutputDestinationFailed(
self,
mock_imap_connection,
mock_get_reports,
_mock_set_hosts,
_mock_migrate_indexes,
mock_save_aggregate,
):
"""The save_callback saves the batch it is given and returns a
truthy value only when every destination accepted it. That verdict
is the whole basis on which get_dmarc_reports_from_mailbox() decides
whether to archive or delete the batch's messages."""
mock_imap_connection.return_value = object()
mock_get_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
config_path = self._write_config(
"""[general]
save_aggregate = true
silent = true
[imap]
host = imap.example.com
user = test-user
password = test-password
[elasticsearch]
hosts = localhost
"""
)
with patch.object(sys, "argv", ["parsedmarc", "-c", config_path]):
parsedmarc.cli._main()
save_callback = mock_get_reports.call_args.kwargs.get("save_callback")
self.assertTrue(callable(save_callback))
report = {"policy_published": {"domain": "example.com"}}
batch = {
"aggregate_reports": [report],
"failure_reports": [],
"smtp_tls_reports": [],
}
self.assertTrue(save_callback(batch))
self.assertIs(mock_save_aggregate.call_args.args[0], report)
mock_save_aggregate.side_effect = parsedmarc.elastic.ElasticsearchError(
"simulated output failure"
)
self.assertFalse(save_callback(batch))
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.watch_inbox")
@patch("parsedmarc.cli.IMAPConnection")
def testWatchCallbackIsTheSameAdapterAndRetryCapReachesBothCallSites(
self, mock_imap_connection, mock_watch_inbox, mock_get_reports
):
"""watch_inbox's callback must be the same save-then-report adapter
the single-shot fetch gets, not process_reports directly -- watch
mode would otherwise still archive before confirming the save. The
configured max_unsaved_retries has to reach both call sites too, or
one of the two paths would silently use the default cap."""
mock_imap_connection.return_value = object()
mock_get_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
mock_watch_inbox.side_effect = FileExistsError("stop-watch-loop")
config_path = self._write_config(
"""[general]
silent = true
[imap]
host = imap.example.com
user = user
password = pass
[mailbox]
watch = true
max_unsaved_retries = 7
"""
)
with patch.object(sys, "argv", ["parsedmarc", "-c", config_path]):
with self.assertRaises(SystemExit) as system_exit:
parsedmarc.cli._main()
self.assertEqual(system_exit.exception.code, 1)
single_shot_kwargs = mock_get_reports.call_args.kwargs
watch_kwargs = mock_watch_inbox.call_args.kwargs
self.assertTrue(callable(single_shot_kwargs.get("save_callback")))
self.assertIs(watch_kwargs.get("callback"), single_shot_kwargs["save_callback"])
self.assertEqual(single_shot_kwargs.get("max_unsaved_retries"), 7)
self.assertEqual(watch_kwargs.get("max_unsaved_retries"), 7)
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.IMAPConnection")
def testFileOutputFailureIsRecordedAndReportsTheBatchUnsaved(
self, mock_imap_connection, mock_get_reports
):
"""A failed --output write is recorded like any other destination's
failure instead of escaping uncaught, so it blocks archiving too.
Pointing `output` at a regular file makes save_output() raise the
real ValueError it raises for a non-directory path."""
mock_imap_connection.return_value = object()
with NamedTemporaryFile("w", suffix=".txt", delete=False) as not_a_directory:
output_path = not_a_directory.name
self.addCleanup(lambda: os.path.exists(output_path) and os.remove(output_path))
reports_dict = {
"aggregate_reports": [{"policy_published": {"domain": "example.com"}}],
"failure_reports": [],
"smtp_tls_reports": [],
}
verdicts = []
def _fetch_and_save(**kwargs):
verdicts.append(kwargs["save_callback"](reports_dict))
return reports_dict
mock_get_reports.side_effect = _fetch_and_save
config_path = self._write_config(
f"""[general]
silent = true
output = {output_path}
[imap]
host = imap.example.com
user = test-user
password = test-password
"""
)
with patch.object(sys, "argv", ["parsedmarc", "-c", config_path]):
with self.assertLogs("parsedmarc.log", level="ERROR") as cm:
parsedmarc.cli._main()
self.assertEqual(verdicts, [False])
self.assertTrue(
any("File output Error" in line for line in cm.output), cm.output
)
@patch("parsedmarc.cli.elastic.save_aggregate_report_to_elasticsearch")
@patch("parsedmarc.cli.elastic.migrate_indexes")
@patch("parsedmarc.cli.elastic.set_hosts")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.IMAPConnection")
def testMailboxAndFileReportsAreEachSavedExactlyOnce(
self,
mock_imap_connection,
mock_get_reports,
_mock_set_hosts,
_mock_migrate_indexes,
mock_save_aggregate,
):
"""A run combining a file argument and a mailbox saves in two passes:
the mailbox batch inside save_callback, the file-derived reports
afterward. The final pass must run on the file snapshot alone --
running it on the combined results would send every mailbox report
to every destination a second time."""
mock_imap_connection.return_value = object()
mailbox_report = {"policy_published": {"domain": "mailbox.example.com"}}
mock_get_reports.side_effect = _fetch_invoking_save_callback(
{
"aggregate_reports": [mailbox_report],
"failure_reports": [],
"smtp_tls_reports": [],
}
)
config_path = self._write_config(
"""[general]
save_aggregate = true
silent = true
offline = true
[imap]
host = imap.example.com
user = test-user
password = test-password
[elasticsearch]
hosts = localhost
"""
)
argv = ["parsedmarc", "-c", config_path, SAMPLE_AGGREGATE_REPORT_PATH]
with patch.object(sys, "argv", argv):
parsedmarc.cli._main()
saved_domains = [
call.args[0]["policy_published"]["domain"]
for call in mock_save_aggregate.call_args_list
]
self.assertEqual(saved_domains.count("mailbox.example.com"), 1)
self.assertEqual(len(saved_domains), 2)
@patch("parsedmarc.cli.elastic.save_aggregate_report_to_elasticsearch")
@patch("parsedmarc.cli.elastic.migrate_indexes")
@patch("parsedmarc.cli.elastic.set_hosts")
def testFailOnOutputErrorExitsForFileDerivedReports(
self,
_mock_set_hosts,
_mock_migrate_indexes,
mock_save_aggregate,
):
"""fail_on_output_error still exits non-zero for reports that came
from a file argument rather than a mailbox: with no mailbox
connection there is no save_callback to raise inside, so the failure
surfaces from the final pass over the file snapshot instead."""
mock_save_aggregate.side_effect = parsedmarc.elastic.ElasticsearchError(
"simulated output failure"
)
config_path = self._write_config(
"""[general]
save_aggregate = true
fail_on_output_error = true
silent = true
offline = true
[elasticsearch]
hosts = localhost
"""
)
argv = ["parsedmarc", "-c", config_path, SAMPLE_AGGREGATE_REPORT_PATH]
with patch.object(sys, "argv", argv):
with self.assertRaises(SystemExit) as system_exit:
parsedmarc.cli._main()
self.assertEqual(system_exit.exception.code, 1)
mock_save_aggregate.assert_called_once()
class TestConfigAliases(unittest.TestCase):
"""Tests for config key aliases (env var friendly short names)."""
def test_maildir_create_alias(self):
"""[maildir] create works as alias for maildir_create."""
from argparse import Namespace
from parsedmarc.cli import _load_config, _parse_config
env = {
"PARSEDMARC_MAILDIR_CREATE": "true",
"PARSEDMARC_MAILDIR_PATH": "/tmp/test",
}
with patch.dict(os.environ, env, clear=False):
config = _load_config(None)
opts = Namespace()
_parse_config(config, opts)
self.assertTrue(opts.maildir_create)
def test_maildir_path_alias(self):
"""[maildir] path works as alias for maildir_path."""
from argparse import Namespace
from parsedmarc.cli import _load_config, _parse_config
env = {"PARSEDMARC_MAILDIR_PATH": "/var/mail/dmarc"}
with patch.dict(os.environ, env, clear=False):
config = _load_config(None)
opts = Namespace()
_parse_config(config, opts)
self.assertEqual(opts.maildir_path, "/var/mail/dmarc")
def test_msgraph_url_alias(self):
"""[msgraph] url works as alias for graph_url."""
from parsedmarc.cli import _load_config, _parse_config
from argparse import Namespace
env = {
"PARSEDMARC_MSGRAPH_AUTH_METHOD": "ClientSecret",
"PARSEDMARC_MSGRAPH_CLIENT_ID": "test-id",
"PARSEDMARC_MSGRAPH_CLIENT_SECRET": "test-secret",
"PARSEDMARC_MSGRAPH_TENANT_ID": "test-tenant",
"PARSEDMARC_MSGRAPH_MAILBOX": "test@example.com",
"PARSEDMARC_MSGRAPH_URL": "https://custom.graph.example.com",
}
with patch.dict(os.environ, env, clear=False):
config = _load_config(None)
opts = Namespace()
_parse_config(config, opts)
self.assertEqual(opts.graph_url, "https://custom.graph.example.com")
def test_original_keys_still_work(self):
"""Original INI key names (maildir_create, maildir_path) still work."""
from argparse import Namespace
from parsedmarc.cli import _parse_config
config = ConfigParser(interpolation=None)
config.add_section("maildir")
config.set("maildir", "maildir_path", "/original/path")
config.set("maildir", "maildir_create", "true")
opts = Namespace()
_parse_config(config, opts)
self.assertEqual(opts.maildir_path, "/original/path")
self.assertTrue(opts.maildir_create)
def test_ipinfo_url_option(self):
"""[general] ipinfo_url lands on opts.ipinfo_url."""
from argparse import Namespace
from parsedmarc.cli import _parse_config
config = ConfigParser(interpolation=None)
config.add_section("general")
config.set("general", "ipinfo_url", "https://mirror.example/mmdb")
opts = Namespace()
_parse_config(config, opts)
self.assertEqual(opts.ipinfo_url, "https://mirror.example/mmdb")
def test_ip_db_url_deprecated_alias(self):
"""[general] ip_db_url is accepted as an alias for ipinfo_url but
emits a deprecation warning."""
from argparse import Namespace
from parsedmarc.cli import _parse_config
config = ConfigParser(interpolation=None)
config.add_section("general")
config.set("general", "ip_db_url", "https://old.example/mmdb")
opts = Namespace()
with self.assertLogs("parsedmarc.log", level="WARNING") as cm:
_parse_config(config, opts)
self.assertEqual(opts.ipinfo_url, "https://old.example/mmdb")
self.assertTrue(
any("ip_db_url" in line and "deprecated" in line for line in cm.output),
f"expected deprecation warning, got: {cm.output}",
)
class TestExpandPath(unittest.TestCase):
"""Tests for _expand_path config path expansion."""
def test_expand_tilde(self):
from parsedmarc.cli import _expand_path
result = _expand_path("~/some/path")
self.assertFalse(result.startswith("~"))
self.assertTrue(result.endswith("/some/path"))
def test_expand_env_var(self):
from parsedmarc.cli import _expand_path
with patch.dict(os.environ, {"PARSEDMARC_TEST_DIR": "/opt/data"}):
result = _expand_path("$PARSEDMARC_TEST_DIR/tokens/.token")
self.assertEqual(result, "/opt/data/tokens/.token")
def test_expand_both(self):
from parsedmarc.cli import _expand_path
with patch.dict(os.environ, {"MY_APP": "parsedmarc"}):
result = _expand_path("~/$MY_APP/config")
self.assertNotIn("~", result)
self.assertIn("parsedmarc/config", result)
def test_no_expansion_needed(self):
from parsedmarc.cli import _expand_path
self.assertEqual(_expand_path("/absolute/path"), "/absolute/path")
self.assertEqual(_expand_path("relative/path"), "relative/path")
class TestArchiveSubdirForResult(unittest.TestCase):
"""Unit tests for _archive_subdir_for_result (issue #570): maps a
parsed report to its ``<year>/<month>/<Aggregate|Failure|SMTP-TLS>``
archive subdirectory, using minimal synthetic report dicts rather
than full sample parses."""
def test_aggregate_report_january_zero_pads_month(self):
from parsedmarc.cli import _archive_subdir_for_result
result = cast(
ParsedReport,
{
"report_type": "aggregate",
"report": {
"report_metadata": {"begin_date": "2023-01-05 00:00:00"},
},
},
)
self.assertEqual(
_archive_subdir_for_result(result),
os.path.join("2023", "01", "Aggregate"),
)
def test_failure_report_january_zero_pads_month(self):
from parsedmarc.cli import _archive_subdir_for_result
result = cast(
ParsedReport,
{
"report_type": "failure",
"report": {"arrival_date_utc": "2023-01-05 12:00:00"},
},
)
self.assertEqual(
_archive_subdir_for_result(result),
os.path.join("2023", "01", "Failure"),
)
def test_smtp_tls_report_uses_hyphenated_folder_name(self):
from parsedmarc.cli import _archive_subdir_for_result
result = cast(
ParsedReport,
{
"report_type": "smtp_tls",
"report": {"begin_date": "2016-04-01T00:00:00Z"},
},
)
self.assertEqual(
_archive_subdir_for_result(result),
os.path.join("2016", "04", "SMTP-TLS"),
)
def test_missing_date_key_returns_none(self):
from parsedmarc.cli import _archive_subdir_for_result
result = cast(
ParsedReport,
{
"report_type": "aggregate",
"report": {"report_metadata": {}},
},
)
self.assertIsNone(_archive_subdir_for_result(result))
def test_unparseable_date_returns_none(self):
from parsedmarc.cli import _archive_subdir_for_result
result = cast(
ParsedReport,
{
"report_type": "failure",
"report": {"arrival_date_utc": "not-a-real-date"},
},
)
self.assertIsNone(_archive_subdir_for_result(result))
def test_unknown_report_type_returns_none(self):
from parsedmarc.cli import _archive_subdir_for_result
result = cast(ParsedReport, {"report_type": "unknown", "report": {}})
self.assertIsNone(_archive_subdir_for_result(result))
class TestExcludeArchivedPaths(unittest.TestCase):
"""Unit tests for _exclude_archived_paths (issue #570): filters out
paths already inside the archive directory so a re-run doesn't
re-parse and re-archive its own previous output."""
def test_files_inside_archive_dir_are_excluded(self):
from parsedmarc.cli import _exclude_archived_paths
with tempfile.TemporaryDirectory() as tmp_dir:
archive_dir = os.path.join(tmp_dir, "archive")
nested_dir = os.path.join(archive_dir, "2024", "01", "Aggregate")
os.makedirs(nested_dir)
inside_path = os.path.join(nested_dir, "report.xml")
with open(inside_path, "w") as f:
f.write("x")
outside_path = os.path.join(tmp_dir, "report.xml")
with open(outside_path, "w") as f:
f.write("x")
result = _exclude_archived_paths([inside_path, outside_path], archive_dir)
self.assertEqual(result, [outside_path])
def test_relative_paths_are_resolved_before_comparison(self):
from parsedmarc.cli import _exclude_archived_paths
with tempfile.TemporaryDirectory() as tmp_dir:
archive_dir = os.path.join(tmp_dir, "archive")
os.makedirs(archive_dir)
inside_path = os.path.join(archive_dir, "report.xml")
with open(inside_path, "w") as f:
f.write("x")
cwd = os.getcwd()
try:
os.chdir(tmp_dir)
result = _exclude_archived_paths(
[os.path.join("archive", "report.xml")], "archive"
)
finally:
os.chdir(cwd)
self.assertEqual(result, [])
def test_files_outside_archive_dir_are_kept(self):
from parsedmarc.cli import _exclude_archived_paths
with tempfile.TemporaryDirectory() as tmp_dir:
archive_dir = os.path.join(tmp_dir, "archive")
os.makedirs(archive_dir)
other_path = os.path.join(tmp_dir, "elsewhere", "report.xml")
os.makedirs(os.path.dirname(other_path))
with open(other_path, "w") as f:
f.write("x")
result = _exclude_archived_paths([other_path], archive_dir)
self.assertEqual(result, [other_path])
def test_symlinked_archive_dir_still_excludes_real_path(self):
"""A symlink doesn't defeat exclusion: if archive_directory is
configured through one spelling (e.g. a ``/data`` symlink) while
an input path is discovered through the real mount-point spelling
(e.g. ``/mnt/...``), ``os.path.realpath`` resolves both to the
same canonical path so the file already inside the archive is
still recognized and excluded rather than re-archived forever."""
from parsedmarc.cli import _exclude_archived_paths
with tempfile.TemporaryDirectory() as tmp_dir:
real_archive_dir = os.path.join(tmp_dir, "real_archive")
os.makedirs(real_archive_dir)
symlinked_archive_dir = os.path.join(tmp_dir, "archive_link")
os.symlink(real_archive_dir, symlinked_archive_dir)
real_file_path = os.path.join(real_archive_dir, "report.xml")
with open(real_file_path, "w") as f:
f.write("x")
# archive_directory is configured via the symlinked spelling,
# while the file is discovered via the real spelling.
result = _exclude_archived_paths([real_file_path], symlinked_archive_dir)
self.assertEqual(result, [])
def test_non_comparable_paths_are_kept(self):
"""Per the Python docs, ``os.path.commonpath`` raises
``ValueError`` when the paths "are on the different drives"
(Windows) or mix absolute and relative pathnames
(https://docs.python.org/3/library/os.path.html#os.path.commonpath).
Both inputs here are realpath()-resolved so the mix can't occur
on POSIX, leaving the different-drives case unreachable on Linux
CI — hence the simulated raise. A path that can't be compared
with the archive root can't be inside it, so it must be kept
for parsing, and the ValueError must not propagate."""
from parsedmarc.cli import _exclude_archived_paths
with tempfile.TemporaryDirectory() as tmp_dir:
archive_dir = os.path.join(tmp_dir, "archive")
os.makedirs(archive_dir)
report_path = os.path.join(tmp_dir, "report.xml")
with open(report_path, "w") as f:
f.write("x")
with patch(
"parsedmarc.cli.os.path.commonpath",
side_effect=ValueError("Paths don't have the same drive"),
):
result = _exclude_archived_paths([report_path], archive_dir)
self.assertEqual(result, [report_path])
class TestMoveFileToArchive(unittest.TestCase):
"""Unit tests for _move_file_to_archive (issue #570): the collision
loop that appends a numeric suffix rather than overwriting an
existing destination file."""
def test_no_collision_keeps_original_basename(self):
from parsedmarc.cli import _move_file_to_archive
with tempfile.TemporaryDirectory() as tmp_dir:
src_dir = os.path.join(tmp_dir, "src")
os.makedirs(src_dir)
src_path = os.path.join(src_dir, "report.xml")
with open(src_path, "w") as f:
f.write("content")
dest_dir = os.path.join(tmp_dir, "dest")
dest_path = _move_file_to_archive(src_path, dest_dir)
self.assertEqual(dest_path, os.path.join(dest_dir, "report.xml"))
def test_collision_appends_dash_one(self):
from parsedmarc.cli import _move_file_to_archive
with tempfile.TemporaryDirectory() as tmp_dir:
src_dir = os.path.join(tmp_dir, "src")
os.makedirs(src_dir)
src_path = os.path.join(src_dir, "report.xml")
with open(src_path, "w") as f:
f.write("new content")
dest_dir = os.path.join(tmp_dir, "dest")
os.makedirs(dest_dir)
existing_path = os.path.join(dest_dir, "report.xml")
with open(existing_path, "w") as f:
f.write("original content")
dest_path = _move_file_to_archive(src_path, dest_dir)
self.assertEqual(dest_path, os.path.join(dest_dir, "report-1.xml"))
with open(existing_path) as f:
self.assertEqual(f.read(), "original content")
with open(dest_path) as f:
self.assertEqual(f.read(), "new content")
def test_two_collisions_append_dash_two(self):
from parsedmarc.cli import _move_file_to_archive
with tempfile.TemporaryDirectory() as tmp_dir:
src_dir = os.path.join(tmp_dir, "src")
os.makedirs(src_dir)
src_path = os.path.join(src_dir, "report.xml")
with open(src_path, "w") as f:
f.write("newest content")
dest_dir = os.path.join(tmp_dir, "dest")
os.makedirs(dest_dir)
for name in ("report.xml", "report-1.xml"):
with open(os.path.join(dest_dir, name), "w") as f:
f.write(f"original {name}")
dest_path = _move_file_to_archive(src_path, dest_dir)
self.assertEqual(dest_path, os.path.join(dest_dir, "report-2.xml"))
with open(os.path.join(dest_dir, "report.xml")) as f:
self.assertEqual(f.read(), "original report.xml")
with open(os.path.join(dest_dir, "report-1.xml")) as f:
self.assertEqual(f.read(), "original report-1.xml")
def test_failed_move_reraises_even_when_placeholder_cleanup_fails(self):
"""When the move fails and removing the placeholder also fails,
the move failure still propagates: the OSError from the
best-effort cleanup must be swallowed, not allowed to mask the
actionable error. The move error is deliberately a non-OSError
type so the assertion proves which of the two exceptions
escaped; the placeholder is left behind, as expected when its
cleanup fails."""
from parsedmarc.cli import _move_file_to_archive
with tempfile.TemporaryDirectory() as tmp_dir:
src_path = os.path.join(tmp_dir, "report.xml")
with open(src_path, "w") as f:
f.write("content")
dest_dir = os.path.join(tmp_dir, "dest")
with (
patch(
"parsedmarc.cli.shutil.move",
side_effect=RuntimeError("move failed"),
),
patch(
"parsedmarc.cli.os.remove",
side_effect=OSError("remove failed"),
),
):
with self.assertRaises(RuntimeError):
_move_file_to_archive(src_path, dest_dir)
# The source file is untouched and the zero-byte placeholder
# survives its failed cleanup.
self.assertTrue(os.path.isfile(src_path))
placeholder = os.path.join(dest_dir, "report.xml")
self.assertTrue(os.path.isfile(placeholder))
self.assertEqual(os.path.getsize(placeholder), 0)
# A leftover placeholder must never be executable or
# group/other-accessible: it's created with mode 0o600, not
# os.open's 0o777 default. The requested mode is masked by
# the process umask, which only clears bits, so asserting on
# the owner-exec and group/other bits is umask-independent.
placeholder_mode = stat.S_IMODE(os.stat(placeholder).st_mode)
self.assertEqual(placeholder_mode & 0o177, 0)
class TestArchiveProcessedFile(unittest.TestCase):
"""Unit tests for _archive_processed_file (issue #570): the
orchestrator that routes a processed file to Invalid/ on a parse
failure or the dated subdirectory on success, and never lets a move
failure abort the run."""
def test_exception_result_routes_to_invalid(self):
from parsedmarc.cli import _archive_processed_file
with tempfile.TemporaryDirectory() as tmp_dir:
src_path = os.path.join(tmp_dir, "garbage.xml")
with open(src_path, "w") as f:
f.write("not a report")
archive_dir = os.path.join(tmp_dir, "archive")
_archive_processed_file(
src_path, archive_dir, parsedmarc.ParserError("boom")
)
self.assertTrue(
os.path.isfile(os.path.join(archive_dir, "Invalid", "garbage.xml"))
)
def test_move_failure_is_logged_and_does_not_raise(self):
"""A filesystem error while moving a file into the archive is
logged, not raised: the file has already been definitively
classified (parsed or failed), so a move error must not abort
the run and lose that work."""
from parsedmarc.cli import _archive_processed_file
with tempfile.TemporaryDirectory() as tmp_dir:
src_path = os.path.join(tmp_dir, "garbage.xml")
with open(src_path, "w") as f:
f.write("not a report")
archive_dir = os.path.join(tmp_dir, "archive")
with patch("shutil.move", side_effect=OSError("disk full")):
with self.assertLogs("parsedmarc.log", level="ERROR") as log_ctx:
_archive_processed_file(
src_path, archive_dir, parsedmarc.ParserError("boom")
)
self.assertTrue(any("Error moving" in msg for msg in log_ctx.output))
# The move never completed, so the source file is untouched.
self.assertTrue(os.path.isfile(src_path))
def test_unresolvable_subdir_leaves_file_in_place(self):
"""When _archive_subdir_for_result can't determine a destination
(unknown report type or unparseable date, already warned about by
that helper), the file is left where it is rather than guessed
at."""
from parsedmarc.cli import _archive_processed_file
with tempfile.TemporaryDirectory() as tmp_dir:
src_path = os.path.join(tmp_dir, "report.json")
with open(src_path, "w") as f:
f.write("{}")
archive_dir = os.path.join(tmp_dir, "archive")
result = cast(ParsedReport, {"report_type": "unknown", "report": {}})
_archive_processed_file(src_path, archive_dir, result)
self.assertTrue(os.path.isfile(src_path))
def test_non_parser_error_leaves_file_in_place(self):
"""Only a ParserError (every parse-failure exception, including
InvalidSMTPTLSReport, subclasses it) routes to Invalid/. A
transient OSError — e.g. from _parse_report_file_job's broad
catch, not a report-parsing failure — leaves the file in place
so a later run can retry it, and creates no Invalid/ directory
at all, since renaming it would permanently sideline a file that
was never actually shown to be an invalid report."""
from parsedmarc.cli import _archive_processed_file
with tempfile.TemporaryDirectory() as tmp_dir:
src_path = os.path.join(tmp_dir, "report.xml")
with open(src_path, "w") as f:
f.write("<xml></xml>")
archive_dir = os.path.join(tmp_dir, "archive")
_archive_processed_file(src_path, archive_dir, OSError("transient"))
self.assertTrue(os.path.isfile(src_path))
self.assertFalse(os.path.isdir(archive_dir))
# ---------------------------------------------------------------------------
# _parse_config: per-section INI → opts mapping
#
# Each section of the INI is consumed by a different branch of
# _parse_config. The tests below build a minimal config for one
# section at a time and verify every documented key lands on the right
# opts attribute. A rename, typo, or dropped backwards-compat alias
# would be caught here.
# ---------------------------------------------------------------------------
class _StrToListTests(unittest.TestCase):
def test_str_to_list_strips_leading_whitespace_per_element(self):
from parsedmarc.cli import _str_to_list
self.assertEqual(_str_to_list("a, b ,c"), ["a", "b ", "c"])
def test_str_to_list_single_value(self):
from parsedmarc.cli import _str_to_list
self.assertEqual(_str_to_list("solo"), ["solo"])
def _opts():
"""A fresh Namespace with no attributes — _parse_config sets fields
via attribute assignment on whatever it's given."""
from argparse import Namespace
return Namespace()
def _config_with(section: str, settings: dict) -> "ConfigParser":
"""Build a ConfigParser holding exactly one section."""
from configparser import ConfigParser
cp = ConfigParser()
cp.add_section(section)
for k, v in settings.items():
cp.set(section, k, str(v))
return cp
class TestParseConfigMailbox(unittest.TestCase):
"""The [mailbox] section, including the per-report-type delete options
(issue #256). An option that is absent from the INI must be left alone
entirely: _main defaults the four per-type options to None so the library
inherits the overall ``delete`` value, and writing False for an absent key
would silently disable that inheritance."""
PER_TYPE_DELETE_OPTS = (
"mailbox_delete_aggregate",
"mailbox_delete_failure",
"mailbox_delete_smtp_tls",
"mailbox_delete_invalid",
)
def test_mailbox_full_section(self):
from parsedmarc.cli import _parse_config
cp = _config_with(
"mailbox",
{
"reports_folder": "Reports",
"archive_folder": "Processed",
"watch": "true",
"delete": "true",
"delete_aggregate": "true",
"delete_failure": "false",
"delete_smtp_tls": "true",
"delete_invalid": "false",
"test": "false",
"batch_size": "25",
"check_timeout": "60",
"max_unsaved_retries": "5",
"since": "3d",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.mailbox_reports_folder, "Reports")
self.assertEqual(opts.mailbox_archive_folder, "Processed")
self.assertIs(opts.mailbox_watch, True)
self.assertIs(opts.mailbox_delete, True)
self.assertIs(opts.mailbox_delete_aggregate, True)
# Explicitly false, not None: this type opts out of delete = true.
self.assertIs(opts.mailbox_delete_failure, False)
self.assertIs(opts.mailbox_delete_smtp_tls, True)
self.assertIs(opts.mailbox_delete_invalid, False)
self.assertIs(opts.mailbox_test, False)
self.assertEqual(opts.mailbox_batch_size, 25)
self.assertEqual(opts.mailbox_check_timeout, 60)
self.assertEqual(opts.mailbox_max_unsaved_retries, 5)
self.assertEqual(opts.mailbox_since, "3d")
def test_mailbox_max_unsaved_retries_from_env_var(self):
"""PARSEDMARC_MAILBOX_MAX_UNSAVED_RETRIES resolves to
[mailbox] max_unsaved_retries and parses as an int -- including 0,
which is a meaningful value ("never retry"), not an absent one."""
from parsedmarc.cli import _load_config, _parse_config
env = {"PARSEDMARC_MAILBOX_MAX_UNSAVED_RETRIES": "0"}
with patch.dict(os.environ, env, clear=False):
config = _load_config(None)
opts = _opts()
_parse_config(config, opts)
self.assertEqual(opts.mailbox_max_unsaved_retries, 0)
def test_mailbox_absent_per_type_delete_keys_are_not_set(self):
from parsedmarc.cli import _parse_config
cp = _config_with("mailbox", {"delete": "true"})
opts = _opts()
_parse_config(cp, opts)
self.assertIs(opts.mailbox_delete, True)
for option in self.PER_TYPE_DELETE_OPTS:
with self.subTest(option=option):
self.assertFalse(hasattr(opts, option))
class TestParseConfigGeneral(unittest.TestCase):
"""The [general] section sets dozens of flags. Hit a representative
subset: filenames, save-toggles, DNS settings, output dir."""
def test_general_filenames_and_output(self):
from parsedmarc.cli import _parse_config
cp = _config_with(
"general",
{
"silent": "false",
"output": "/tmp/dmarc-out",
"aggregate_json_filename": "agg.json",
"failure_json_filename": "fail.json",
"smtp_tls_json_filename": "tls.json",
"aggregate_csv_filename": "agg.csv",
"failure_csv_filename": "fail.csv",
"smtp_tls_csv_filename": "tls.csv",
"save_aggregate": "true",
"save_failure": "true",
"save_smtp_tls": "true",
"debug": "false",
"verbose": "false",
"warnings": "false",
"fail_on_output_error": "false",
"offline": "true",
"strip_attachment_payloads": "true",
"n_procs": "4",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.output, "/tmp/dmarc-out")
self.assertEqual(opts.aggregate_json_filename, "agg.json")
self.assertEqual(opts.failure_json_filename, "fail.json")
self.assertEqual(opts.smtp_tls_csv_filename, "tls.csv")
self.assertTrue(opts.save_aggregate)
self.assertTrue(opts.save_failure)
self.assertTrue(opts.save_smtp_tls)
self.assertTrue(opts.offline)
self.assertTrue(opts.strip_attachment_payloads)
self.assertEqual(opts.n_procs, 4)
self.assertFalse(opts.silent)
self.assertFalse(opts.debug)
def test_general_save_forensic_alias_sets_save_failure(self):
"""Backwards compat: save_forensic in INI sets opts.save_failure."""
from parsedmarc.cli import _parse_config
cp = _config_with("general", {"save_forensic": "true"})
opts = _opts()
_parse_config(cp, opts)
self.assertTrue(opts.save_failure)
def test_general_forensic_filename_aliases_set_failure(self):
from parsedmarc.cli import _parse_config
cp = _config_with(
"general",
{
"forensic_json_filename": "fa.json",
"forensic_csv_filename": "fa.csv",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.failure_json_filename, "fa.json")
self.assertEqual(opts.failure_csv_filename, "fa.csv")
def test_general_dns_settings_with_defaults(self):
from parsedmarc.cli import _parse_config
# dns_timeout/dns_retries are typed via getfloat/getint which
# return non-None values for any valid input.
cp = _config_with(
"general",
{
"dns_timeout": "5.0",
"dns_retries": "2",
"dns_test_address": "1.1.1.1",
"nameservers": "1.1.1.1, 8.8.8.8",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.dns_timeout, 5.0)
self.assertEqual(opts.dns_retries, 2)
self.assertEqual(opts.nameservers, ["1.1.1.1", "8.8.8.8"])
def test_general_normalize_timespan_threshold(self):
from parsedmarc.cli import _parse_config
cp = _config_with("general", {"normalize_timespan_threshold_hours": "48"})
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.normalize_timespan_threshold_hours, 48.0)
def test_general_archive_directory_expands_env_var(self):
"""archive_directory goes through _expand_path, so a $VAR
reference in the INI value is expanded (issue #570)."""
from parsedmarc.cli import _parse_config
cp = _config_with(
"general", {"archive_directory": "$SOME_ARCHIVE_VAR/reports-archive"}
)
opts = _opts()
with patch.dict(os.environ, {"SOME_ARCHIVE_VAR": "/opt/dmarc"}):
_parse_config(cp, opts)
self.assertEqual(opts.archive_directory, "/opt/dmarc/reports-archive")
def test_general_archive_directory_unset_leaves_attribute_absent(self):
"""When archive_directory is absent from the INI, _parse_config
never sets opts.archive_directory at all — asserted here as the
attribute staying absent from this test's bare Namespace. (In the
real CLI the attribute pre-exists with the Namespace default of
None, so _parse_config leaving it untouched is what keeps
archiving disabled.)"""
from parsedmarc.cli import _parse_config
cp = _config_with("general", {"silent": "false"})
opts = _opts()
_parse_config(cp, opts)
self.assertFalse(hasattr(opts, "archive_directory"))
class TestParseConfigElasticsearch(unittest.TestCase):
def test_elasticsearch_basic(self):
from parsedmarc.cli import _parse_config
cp = _config_with(
"elasticsearch",
{
"hosts": "es1:9200, es2:9200",
"timeout": "30.0",
"number_of_shards": "3",
"number_of_replicas": "1",
"index_suffix": "tenant_a",
"index_prefix": "cust_",
"monthly_indexes": "true",
"ssl": "true",
"cert_path": "/etc/ca.pem",
"skip_certificate_verification": "true",
"user": "alice",
"password": "secret",
"api_key": "base64key",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.elasticsearch_hosts, ["es1:9200", "es2:9200"])
self.assertEqual(opts.elasticsearch_timeout, 30.0)
self.assertEqual(opts.elasticsearch_number_of_shards, 3)
self.assertEqual(opts.elasticsearch_number_of_replicas, 1)
self.assertEqual(opts.elasticsearch_index_suffix, "tenant_a")
self.assertEqual(opts.elasticsearch_index_prefix, "cust_")
self.assertTrue(opts.elasticsearch_monthly_indexes)
self.assertTrue(opts.elasticsearch_ssl)
self.assertEqual(opts.elasticsearch_ssl_cert_path, "/etc/ca.pem")
self.assertTrue(opts.elasticsearch_skip_certificate_verification)
self.assertEqual(opts.elasticsearch_username, "alice")
self.assertEqual(opts.elasticsearch_password, "secret")
self.assertEqual(opts.elasticsearch_api_key, "base64key")
def test_elasticsearch_apikey_camelcase_alias_pre_8_20(self):
"""`apiKey` (camelCase) is the legacy 8.20-and-earlier name."""
from parsedmarc.cli import _parse_config
cp = _config_with("elasticsearch", {"hosts": "es:9200", "apiKey": "legacy"})
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.elasticsearch_api_key, "legacy")
def test_elasticsearch_missing_hosts_raises(self):
from parsedmarc.cli import ConfigurationError, _parse_config
cp = _config_with("elasticsearch", {"timeout": "30"})
with self.assertRaises(ConfigurationError) as ctx:
_parse_config(cp, _opts())
self.assertIn("hosts", str(ctx.exception))
def test_elasticsearch_serverless_flag(self):
"""``[elasticsearch] serverless = true`` flips ``opts.elasticsearch_serverless``."""
from parsedmarc.cli import _parse_config
cp = _config_with("elasticsearch", {"hosts": "es:9200", "serverless": "true"})
opts = _opts()
_parse_config(cp, opts)
self.assertIs(opts.elasticsearch_serverless, True)
def test_elasticsearch_serverless_passed_to_set_hosts(self):
"""End-to-end: a Serverless config reaches ``elastic.set_hosts(serverless=True)``.
Regression guard: catches anyone who later parses the flag but forgets
to plumb it through to ``set_hosts`` (or vice-versa).
"""
config = """[general]
save_aggregate = true
silent = true
[imap]
host = imap.example.com
user = test-user
password = test-password
[elasticsearch]
hosts = localhost
serverless = true
"""
with tempfile.NamedTemporaryFile(
"w", suffix=".ini", delete=False
) as config_file:
config_file.write(config)
config_path = config_file.name
self.addCleanup(lambda: os.path.exists(config_path) and os.remove(config_path))
with (
patch("parsedmarc.cli.elastic.migrate_indexes"),
patch("parsedmarc.cli.elastic.set_hosts") as mock_set_hosts,
patch(
"parsedmarc.cli.get_dmarc_reports_from_mailbox",
return_value={
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
},
),
patch("parsedmarc.cli.IMAPConnection", return_value=object()),
patch.object(sys, "argv", ["parsedmarc", "-c", config_path]),
):
parsedmarc.cli._main()
mock_set_hosts.assert_called_once()
self.assertIs(mock_set_hosts.call_args.kwargs.get("serverless"), True)
class TestParseConfigOpenSearch(unittest.TestCase):
def test_opensearch_basic(self):
from parsedmarc.cli import _parse_config
cp = _config_with(
"opensearch",
{
"hosts": "os1:9200",
"timeout": "45.0",
"number_of_shards": "2",
"number_of_replicas": "0",
"index_suffix": "x",
"index_prefix": "y_",
"monthly_indexes": "true",
"ssl": "true",
"cert_path": "/etc/ca.pem",
"skip_certificate_verification": "true",
"user": "u",
"password": "p",
"api_key": "k",
"auth_type": "BASIC",
"aws_region": "us-east-1",
"aws_service": "es",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.opensearch_hosts, ["os1:9200"])
self.assertEqual(opts.opensearch_timeout, 45.0)
self.assertEqual(opts.opensearch_number_of_shards, 2)
self.assertEqual(opts.opensearch_number_of_replicas, 0)
self.assertEqual(opts.opensearch_index_suffix, "x")
self.assertEqual(opts.opensearch_index_prefix, "y_")
self.assertTrue(opts.opensearch_monthly_indexes)
self.assertTrue(opts.opensearch_ssl)
self.assertEqual(opts.opensearch_ssl_cert_path, "/etc/ca.pem")
self.assertTrue(opts.opensearch_skip_certificate_verification)
self.assertEqual(opts.opensearch_username, "u")
self.assertEqual(opts.opensearch_password, "p")
self.assertEqual(opts.opensearch_api_key, "k")
# auth_type is lowercased/stripped.
self.assertEqual(opts.opensearch_auth_type, "basic")
self.assertEqual(opts.opensearch_aws_region, "us-east-1")
self.assertEqual(opts.opensearch_aws_service, "es")
def test_opensearch_authentication_type_legacy_alias(self):
"""`authentication_type` is the legacy spelling of `auth_type`."""
from parsedmarc.cli import _parse_config
cp = _config_with(
"opensearch",
{"hosts": "os:9200", "authentication_type": "AWSSigV4"},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.opensearch_auth_type, "awssigv4")
def test_opensearch_apikey_camelcase_alias(self):
from parsedmarc.cli import _parse_config
cp = _config_with("opensearch", {"hosts": "os:9200", "apiKey": "legacy"})
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.opensearch_api_key, "legacy")
def test_opensearch_missing_hosts_raises(self):
from parsedmarc.cli import ConfigurationError, _parse_config
cp = _config_with("opensearch", {"timeout": "30"})
with self.assertRaises(ConfigurationError):
_parse_config(cp, _opts())
class TestParseConfigSplunkHec(unittest.TestCase):
def test_splunk_hec_complete(self):
from parsedmarc.cli import _parse_config
cp = _config_with(
"splunk_hec",
{
"url": "https://splunk:8088",
"token": "abc-token",
"index": "dmarc",
"skip_certificate_verification": "true",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.hec, "https://splunk:8088")
self.assertEqual(opts.hec_token, "abc-token")
self.assertEqual(opts.hec_index, "dmarc")
self.assertTrue(opts.hec_skip_certificate_verification)
def test_splunk_hec_missing_url_raises(self):
from parsedmarc.cli import ConfigurationError, _parse_config
cp = _config_with("splunk_hec", {"token": "t", "index": "i"})
with self.assertRaises(ConfigurationError):
_parse_config(cp, _opts())
def test_splunk_hec_missing_token_raises(self):
from parsedmarc.cli import ConfigurationError, _parse_config
cp = _config_with("splunk_hec", {"url": "https://splunk:8088", "index": "i"})
with self.assertRaises(ConfigurationError):
_parse_config(cp, _opts())
def test_splunk_hec_missing_index_raises(self):
from parsedmarc.cli import ConfigurationError, _parse_config
cp = _config_with("splunk_hec", {"url": "https://splunk:8088", "token": "t"})
with self.assertRaises(ConfigurationError):
_parse_config(cp, _opts())
class TestParseConfigKafka(unittest.TestCase):
def test_kafka_complete(self):
from parsedmarc.cli import _parse_config
cp = _config_with(
"kafka",
{
"hosts": "kafka1:9092, kafka2:9092",
"user": "u",
"password": "p",
"ssl": "true",
"skip_certificate_verification": "true",
"aggregate_topic": "dmarc-aggregate",
"failure_topic": "dmarc-failure",
"smtp_tls_topic": "smtp-tls",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.kafka_hosts, ["kafka1:9092", "kafka2:9092"])
self.assertEqual(opts.kafka_username, "u")
self.assertEqual(opts.kafka_password, "p")
self.assertTrue(opts.kafka_ssl)
self.assertTrue(opts.kafka_skip_certificate_verification)
self.assertEqual(opts.kafka_aggregate_topic, "dmarc-aggregate")
self.assertEqual(opts.kafka_failure_topic, "dmarc-failure")
self.assertEqual(opts.kafka_smtp_tls_topic, "smtp-tls")
def test_kafka_forensic_topic_alias_sets_failure_topic(self):
from parsedmarc.cli import _parse_config
cp = _config_with(
"kafka",
{
"hosts": "k:9092",
"aggregate_topic": "agg",
"forensic_topic": "old-fail",
"smtp_tls_topic": "tls",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.kafka_failure_topic, "old-fail")
def test_kafka_missing_hosts_raises(self):
from parsedmarc.cli import ConfigurationError, _parse_config
cp = _config_with(
"kafka",
{
"aggregate_topic": "a",
"failure_topic": "f",
"smtp_tls_topic": "t",
},
)
with self.assertRaises(ConfigurationError):
_parse_config(cp, _opts())
def test_kafka_missing_aggregate_topic_raises(self):
from parsedmarc.cli import ConfigurationError, _parse_config
cp = _config_with(
"kafka",
{"hosts": "k:9092", "failure_topic": "f", "smtp_tls_topic": "t"},
)
with self.assertRaises(ConfigurationError):
_parse_config(cp, _opts())
def test_kafka_missing_failure_topic_raises(self):
from parsedmarc.cli import ConfigurationError, _parse_config
cp = _config_with(
"kafka",
{"hosts": "k:9092", "aggregate_topic": "a", "smtp_tls_topic": "t"},
)
with self.assertRaises(ConfigurationError):
_parse_config(cp, _opts())
def test_kafka_missing_smtp_tls_topic_raises(self):
from parsedmarc.cli import ConfigurationError, _parse_config
cp = _config_with(
"kafka",
{"hosts": "k:9092", "aggregate_topic": "a", "failure_topic": "f"},
)
with self.assertRaises(ConfigurationError):
_parse_config(cp, _opts())
class TestParseConfigSmtp(unittest.TestCase):
def test_smtp_complete(self):
from parsedmarc.cli import _parse_config
cp = _config_with(
"smtp",
{
"host": "smtp.example.com",
"port": "587",
"ssl": "true",
"skip_certificate_verification": "true",
"user": "u",
"password": "p",
"from": "dmarc@example.com",
"to": "admin@example.com, alert@example.com",
"subject": "DMARC Report",
"attachment": "/tmp/dmarc.zip",
"message": "See attached",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.smtp_host, "smtp.example.com")
self.assertEqual(opts.smtp_port, 587)
self.assertTrue(opts.smtp_ssl)
self.assertTrue(opts.smtp_skip_certificate_verification)
self.assertEqual(opts.smtp_user, "u")
self.assertEqual(opts.smtp_password, "p")
self.assertEqual(opts.smtp_from, "dmarc@example.com")
self.assertEqual(opts.smtp_to, ["admin@example.com", "alert@example.com"])
self.assertEqual(opts.smtp_subject, "DMARC Report")
self.assertEqual(opts.smtp_attachment, "/tmp/dmarc.zip")
self.assertEqual(opts.smtp_message, "See attached")
def test_smtp_missing_host_raises(self):
from parsedmarc.cli import ConfigurationError, _parse_config
cp = _config_with("smtp", {"user": "u", "password": "p"})
with self.assertRaises(ConfigurationError):
_parse_config(cp, _opts())
def test_smtp_missing_user_raises(self):
from parsedmarc.cli import ConfigurationError, _parse_config
cp = _config_with("smtp", {"host": "smtp.example.com", "password": "p"})
with self.assertRaises(ConfigurationError):
_parse_config(cp, _opts())
def test_smtp_missing_password_raises(self):
from parsedmarc.cli import ConfigurationError, _parse_config
cp = _config_with("smtp", {"host": "smtp.example.com", "user": "u"})
with self.assertRaises(ConfigurationError):
_parse_config(cp, _opts())
class TestSmtpAttachmentAndMessageWiring(unittest.TestCase):
"""[smtp] attachment/message are documented and parsed into
opts.smtp_attachment/opts.smtp_message, but were never passed to
email_results(), so a configured custom attachment filename or
message body was silently ignored on the SMTP transport."""
def _write_config(self, config_text):
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
return cfg_path
def _run_main(self, cfg_path, *cli_args):
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path, *cli_args]):
parsedmarc.cli._main()
@patch("parsedmarc.cli.email_results")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.IMAPConnection")
def testSmtpAttachmentAndMessageArePassedToEmailResults(
self, mock_imap_connection, mock_get_mailbox_reports, mock_email_results
):
"""A configured attachment filename and message body reach
email_results() rather than being silently dropped."""
mock_imap_connection.return_value = object()
mock_get_mailbox_reports.return_value = {
"aggregate_reports": _sample_aggregate_reports(),
"failure_reports": [],
"smtp_tls_reports": [],
}
config_text = """[general]
silent = true
[imap]
host = imap.example.com
user = test-user
password = test-password
[smtp]
host = smtp.example.com
user = smtp-user
password = smtp-password
from = dmarc@example.com
to = admin@example.com
attachment = custom-report.zip
message = Custom body text
"""
cfg_path = self._write_config(config_text)
self._run_main(cfg_path)
mock_email_results.assert_called_once()
call_kwargs = mock_email_results.call_args.kwargs
# The configured value passes through _expand_path(), which is a
# no-op here since the filename has no ~ or $VAR references.
self.assertTrue(
call_kwargs["attachment_filename"].endswith("custom-report.zip")
)
self.assertEqual(call_kwargs["message"], "Custom body text")
@patch("parsedmarc.cli.email_results")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.IMAPConnection")
def testSmtpDefaultsFlowThroughWhenNotConfigured(
self, mock_imap_connection, mock_get_mailbox_reports, mock_email_results
):
"""When [smtp] attachment/message are not set, email_results()
still gets the documented defaults (None for the attachment
filename, and the long-documented default message body) rather
than being called with no attachment/message context at all."""
mock_imap_connection.return_value = object()
mock_get_mailbox_reports.return_value = {
"aggregate_reports": _sample_aggregate_reports(),
"failure_reports": [],
"smtp_tls_reports": [],
}
config_text = """[general]
silent = true
[imap]
host = imap.example.com
user = test-user
password = test-password
[smtp]
host = smtp.example.com
user = smtp-user
password = smtp-password
from = dmarc@example.com
to = admin@example.com
"""
cfg_path = self._write_config(config_text)
self._run_main(cfg_path)
mock_email_results.assert_called_once()
call_kwargs = mock_email_results.call_args.kwargs
self.assertIsNone(call_kwargs["attachment_filename"])
self.assertEqual(
call_kwargs["message"], "Please see the attached DMARC results."
)
class TestSkipsResultsEmailWhenNoReportsParsed(unittest.TestCase):
"""#200: a run that parses no reports at all (e.g. an empty inbox,
or a mailbox where every message failed to parse) must not send a
results email with headers-only, data-free CSVs. The email step is
now skipped, with an INFO log line, whenever aggregate_reports,
failure_reports, and smtp_tls_reports are all empty."""
def _write_config(self, config_text):
with tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False) as cfg:
cfg.write(config_text)
cfg_path = cfg.name
self.addCleanup(lambda: os.path.exists(cfg_path) and os.remove(cfg_path))
return cfg_path
def _run_main(self, cfg_path, *cli_args):
with patch.object(sys, "argv", ["parsedmarc", "-c", cfg_path, *cli_args]):
parsedmarc.cli._main()
@patch("parsedmarc.send_email")
@patch("parsedmarc.cli.get_dmarc_reports_from_mailbox")
@patch("parsedmarc.cli.IMAPConnection")
def testSkipsResultsEmailWhenNothingWasParsed(
self, mock_imap_connection, mock_get_mailbox_reports, mock_send_email
):
"""Regression test for #200: with an empty inbox (no aggregate,
failure, or SMTP TLS reports), the SMTP results email must not
be sent, and an INFO log line should explain why it was
skipped."""
mock_imap_connection.return_value = object()
mock_get_mailbox_reports.return_value = {
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
}
config_text = """[general]
silent = true
verbose = true
[imap]
host = imap.example.com
user = test-user
password = test-password
[smtp]
host = smtp.example.com
user = smtp-user
password = smtp-password
from = dmarc@example.com
to = admin@example.com
"""
cfg_path = self._write_config(config_text)
with self.assertLogs("parsedmarc.log", level="INFO") as logs:
self._run_main(cfg_path)
mock_send_email.assert_not_called()
self.assertTrue(
any("skipping the results email" in line for line in logs.output)
)
@patch("parsedmarc.send_email")
def testSendsResultsEmailWithRealPayloadWhenReportsExist(self, mock_send_email):
"""When at least one report is parsed, the results email is
still sent, and the attached zip's aggregate.csv contains actual
data rows (not just a header row)."""
config_text = """[general]
silent = true
offline = true
[smtp]
host = smtp.example.com
user = smtp-user
password = smtp-password
from = dmarc@example.com
to = admin@example.com
"""
cfg_path = self._write_config(config_text)
with patch.object(
sys,
"argv",
["parsedmarc", "-c", cfg_path, SAMPLE_AGGREGATE_REPORT_PATH],
):
parsedmarc.cli._main()
mock_send_email.assert_called_once()
call_kwargs = mock_send_email.call_args.kwargs
attachments = call_kwargs["attachments"]
filename, zip_bytes = attachments[0]
with zipfile.ZipFile(io.BytesIO(zip_bytes)) as zf:
csv_text = zf.read("aggregate.csv").decode("utf-8")
self.assertGreater(len(csv_text.strip().splitlines()), 1)
class TestParseConfigS3(unittest.TestCase):
def test_s3_complete(self):
from parsedmarc.cli import _parse_config
cp = _config_with(
"s3",
{
"bucket": "my-bucket",
"path": "/dmarc/",
"region_name": "us-east-1",
"endpoint_url": "https://s3.example.com",
"access_key_id": "AKIA-x",
"secret_access_key": "secret",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.s3_bucket, "my-bucket")
# Leading and trailing slashes are stripped.
self.assertEqual(opts.s3_path, "dmarc")
self.assertEqual(opts.s3_region_name, "us-east-1")
self.assertEqual(opts.s3_endpoint_url, "https://s3.example.com")
self.assertEqual(opts.s3_access_key_id, "AKIA-x")
self.assertEqual(opts.s3_secret_access_key, "secret")
def test_s3_default_path_is_empty(self):
from parsedmarc.cli import _parse_config
cp = _config_with("s3", {"bucket": "b"})
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.s3_path, "")
def test_s3_missing_bucket_raises(self):
from parsedmarc.cli import ConfigurationError, _parse_config
cp = _config_with("s3", {"path": "x"})
with self.assertRaises(ConfigurationError):
_parse_config(cp, _opts())
class TestParseConfigPostgreSQL(unittest.TestCase):
def test_postgresql_individual_params(self):
from parsedmarc.cli import _parse_config
cp = _config_with(
"postgresql",
{
"host": "db.example.com",
"port": "6543",
"user": "pmarc",
"password": "secret",
"database": "dmarc",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.postgresql_host, "db.example.com")
self.assertEqual(opts.postgresql_port, 6543)
self.assertEqual(opts.postgresql_user, "pmarc")
self.assertEqual(opts.postgresql_password, "secret")
self.assertEqual(opts.postgresql_database, "dmarc")
def test_postgresql_connection_string_takes_precedence(self):
"""connection_string is read and host parsing is skipped."""
from parsedmarc.cli import _parse_config
cp = _config_with(
"postgresql",
{
"connection_string": "postgresql://u:p@h/db",
"host": "ignored.example.com",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.postgresql_connection_string, "postgresql://u:p@h/db")
# The host branch is skipped entirely when a connection_string is set.
self.assertFalse(hasattr(opts, "postgresql_host"))
def test_postgresql_missing_host_and_dsn_raises(self):
from parsedmarc.cli import ConfigurationError, _parse_config
cp = _config_with("postgresql", {"port": "5432"})
with self.assertRaises(ConfigurationError) as ctx:
_parse_config(cp, _opts())
self.assertIn("postgresql", str(ctx.exception))
class TestPostgreSQLCliWiring(unittest.TestCase):
"""End-to-end: a [postgresql] config reaches PostgreSQLClient + create_tables.
Regression guard so the config parse, the Namespace defaults, and the
_init_output_clients wiring can't drift apart.
"""
def test_postgresql_config_constructs_client_and_creates_tables(self):
config = """[general]
save_aggregate = true
silent = true
[imap]
host = imap.example.com
user = test-user
password = test-password
[postgresql]
host = db.example.com
port = 6543
user = pmarc
password = secret
database = dmarc
"""
with tempfile.NamedTemporaryFile(
"w", suffix=".ini", delete=False
) as config_file:
config_file.write(config)
config_path = config_file.name
self.addCleanup(lambda: os.path.exists(config_path) and os.remove(config_path))
with (
patch("parsedmarc.cli.postgres.PostgreSQLClient") as mock_client_cls,
patch(
"parsedmarc.cli.get_dmarc_reports_from_mailbox",
return_value={
"aggregate_reports": [],
"failure_reports": [],
"smtp_tls_reports": [],
},
),
patch("parsedmarc.cli.IMAPConnection", return_value=object()),
patch.object(sys, "argv", ["parsedmarc", "-c", config_path]),
):
parsedmarc.cli._main()
mock_client_cls.assert_called_once()
kwargs = mock_client_cls.call_args.kwargs
self.assertEqual(kwargs.get("host"), "db.example.com")
self.assertEqual(kwargs.get("port"), 6543)
self.assertEqual(kwargs.get("user"), "pmarc")
self.assertEqual(kwargs.get("database"), "dmarc")
mock_client_cls.return_value.create_tables.assert_called_once()
def test_postgresql_aggregate_report_is_saved(self):
"""An aggregate report reaches the client's save method via the loop."""
config = """[general]
save_aggregate = true
silent = true
[imap]
host = imap.example.com
user = test-user
password = test-password
[postgresql]
host = db.example.com
"""
with tempfile.NamedTemporaryFile(
"w", suffix=".ini", delete=False
) as config_file:
config_file.write(config)
config_path = config_file.name
self.addCleanup(lambda: os.path.exists(config_path) and os.remove(config_path))
report = {"policy_published": {"domain": "example.com"}, "records": []}
with (
patch("parsedmarc.cli.postgres.PostgreSQLClient") as mock_client_cls,
patch(
"parsedmarc.cli.get_dmarc_reports_from_mailbox",
side_effect=_fetch_invoking_save_callback(
{
"aggregate_reports": [report],
"failure_reports": [],
"smtp_tls_reports": [],
}
),
),
patch("parsedmarc.cli.IMAPConnection", return_value=object()),
patch.object(sys, "argv", ["parsedmarc", "-c", config_path]),
):
parsedmarc.cli._main()
pg_client = mock_client_cls.return_value
pg_client.save_aggregate_report_to_postgresql.assert_called_once_with(report)
def _run_main(self, reports, save_side_effect=None):
"""Run _main with all save flags on and PostgreSQLClient mocked.
Returns the mocked client instance for assertions. *save_side_effect*,
if given, is applied to every save_* method so error-handling branches
can be exercised.
"""
config = """[general]
save_aggregate = true
save_failure = true
save_smtp_tls = true
silent = true
[imap]
host = imap.example.com
user = test-user
password = test-password
[postgresql]
host = db.example.com
"""
with tempfile.NamedTemporaryFile(
"w", suffix=".ini", delete=False
) as config_file:
config_file.write(config)
config_path = config_file.name
self.addCleanup(lambda: os.path.exists(config_path) and os.remove(config_path))
with (
patch("parsedmarc.cli.postgres.PostgreSQLClient") as mock_client_cls,
patch(
"parsedmarc.cli.get_dmarc_reports_from_mailbox",
side_effect=_fetch_invoking_save_callback(reports),
),
patch("parsedmarc.cli.IMAPConnection", return_value=object()),
patch.object(sys, "argv", ["parsedmarc", "-c", config_path]),
):
client = mock_client_cls.return_value
if save_side_effect is not None:
for m in (
"save_aggregate_report_to_postgresql",
"save_failure_report_to_postgresql",
"save_smtp_tls_report_to_postgresql",
):
getattr(client, m).side_effect = save_side_effect
parsedmarc.cli._main()
return client
def test_postgresql_all_report_types_saved(self):
"""Failure and SMTP-TLS reports also reach their save methods."""
agg = {"policy_published": {"domain": "example.com"}, "records": []}
fail = {"reported_domain": "example.com", "parsed_sample": {}}
tls = {"organization_name": "Org", "policies": [{"policy_domain": "d"}]}
client = self._run_main(
{
"aggregate_reports": [agg],
"failure_reports": [fail],
"smtp_tls_reports": [tls],
}
)
client.save_aggregate_report_to_postgresql.assert_called_once_with(agg)
client.save_failure_report_to_postgresql.assert_called_once_with(fail)
client.save_smtp_tls_report_to_postgresql.assert_called_once_with(tls)
def test_postgresql_already_saved_is_warned_not_fatal(self):
"""AlreadySaved from any save is swallowed (logged), not propagated."""
from parsedmarc import postgres
agg = {"policy_published": {"domain": "example.com"}, "records": []}
fail = {"reported_domain": "example.com", "parsed_sample": {}}
tls = {"organization_name": "Org", "policies": []}
# Should not raise despite every save raising AlreadySaved.
self._run_main(
{
"aggregate_reports": [agg],
"failure_reports": [fail],
"smtp_tls_reports": [tls],
},
save_side_effect=postgres.AlreadySaved("dup"),
)
def test_postgresql_error_is_logged_not_fatal(self):
"""PostgreSQLError from any save is logged, not propagated."""
from parsedmarc import postgres
agg = {"policy_published": {"domain": "example.com"}, "records": []}
fail = {"reported_domain": "example.com", "parsed_sample": {}}
tls = {"organization_name": "Org", "policies": []}
self._run_main(
{
"aggregate_reports": [agg],
"failure_reports": [fail],
"smtp_tls_reports": [tls],
},
save_side_effect=postgres.PostgreSQLError("boom"),
)
class TestParseConfigSyslog(unittest.TestCase):
def test_syslog_complete(self):
from parsedmarc.cli import _parse_config
cp = _config_with(
"syslog",
{
"server": "syslog.example.com",
"port": "6514",
"protocol": "tls",
"cafile_path": "/etc/ca.pem",
"certfile_path": "/etc/c.pem",
"keyfile_path": "/etc/k.pem",
"timeout": "10.0",
"retry_attempts": "5",
"retry_delay": "2",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.syslog_server, "syslog.example.com")
self.assertEqual(opts.syslog_port, "6514")
self.assertEqual(opts.syslog_protocol, "tls")
self.assertEqual(opts.syslog_cafile_path, "/etc/ca.pem")
self.assertEqual(opts.syslog_certfile_path, "/etc/c.pem")
self.assertEqual(opts.syslog_keyfile_path, "/etc/k.pem")
self.assertEqual(opts.syslog_timeout, 10.0)
self.assertEqual(opts.syslog_retry_attempts, 5)
self.assertEqual(opts.syslog_retry_delay, 2)
def test_syslog_defaults(self):
from parsedmarc.cli import _parse_config
cp = _config_with("syslog", {"server": "s"})
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.syslog_port, 514)
self.assertEqual(opts.syslog_protocol, "udp")
self.assertEqual(opts.syslog_timeout, 5.0)
self.assertEqual(opts.syslog_retry_attempts, 3)
self.assertEqual(opts.syslog_retry_delay, 5)
def test_syslog_missing_server_raises(self):
from parsedmarc.cli import ConfigurationError, _parse_config
cp = _config_with("syslog", {"port": "514"})
with self.assertRaises(ConfigurationError):
_parse_config(cp, _opts())
class TestParseConfigGmailApi(unittest.TestCase):
def test_gmail_api_complete(self):
from parsedmarc.cli import _parse_config
cp = _config_with(
"gmail_api",
{
"credentials_file": "/etc/gmail-creds.json",
"token_file": "/var/lib/parsedmarc/gmail.token",
"include_spam_trash": "true",
"paginate_messages": "false",
"scopes": "https://www.googleapis.com/auth/gmail.readonly",
"oauth2_port": "8888",
"auth_mode": "device_code",
"service_account_user": "user@example.com",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.gmail_api_credentials_file, "/etc/gmail-creds.json")
self.assertEqual(opts.gmail_api_token_file, "/var/lib/parsedmarc/gmail.token")
self.assertTrue(opts.gmail_api_include_spam_trash)
self.assertFalse(opts.gmail_api_paginate_messages)
self.assertEqual(
opts.gmail_api_scopes,
["https://www.googleapis.com/auth/gmail.readonly"],
)
self.assertEqual(opts.gmail_api_oauth2_port, 8888)
self.assertEqual(opts.gmail_api_auth_mode, "device_code")
self.assertEqual(opts.gmail_api_service_account_user, "user@example.com")
def test_gmail_api_delegated_user_alias(self):
"""`delegated_user` is the legacy spelling of `service_account_user`."""
from parsedmarc.cli import _parse_config
cp = _config_with(
"gmail_api",
{
"credentials_file": "/c",
"delegated_user": "legacy@example.com",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.gmail_api_service_account_user, "legacy@example.com")
def test_gmail_api_default_scope(self):
from parsedmarc.cli import _parse_config
cp = _config_with("gmail_api", {"credentials_file": "/c"})
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(
opts.gmail_api_scopes,
["https://www.googleapis.com/auth/gmail.modify"],
)
class TestParseConfigLogAnalytics(unittest.TestCase):
def test_log_analytics_complete(self):
from parsedmarc.cli import _parse_config
cp = _config_with(
"log_analytics",
{
"client_id": "cid",
"client_secret": "csec",
"tenant_id": "tid",
"dce": "https://dce.example.com",
"dcr_immutable_id": "dcr-1",
"dcr_aggregate_stream": "Custom-Aggregate_CL",
"dcr_failure_stream": "Custom-Failure_CL",
"dcr_smtp_tls_stream": "Custom-SMTPTLS_CL",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.la_client_id, "cid")
self.assertEqual(opts.la_client_secret, "csec")
self.assertEqual(opts.la_tenant_id, "tid")
self.assertEqual(opts.la_dce, "https://dce.example.com")
self.assertEqual(opts.la_dcr_immutable_id, "dcr-1")
self.assertEqual(opts.la_dcr_aggregate_stream, "Custom-Aggregate_CL")
self.assertEqual(opts.la_dcr_failure_stream, "Custom-Failure_CL")
self.assertEqual(opts.la_dcr_smtp_tls_stream, "Custom-SMTPTLS_CL")
def test_log_analytics_forensic_stream_alias(self):
from parsedmarc.cli import _parse_config
cp = _config_with(
"log_analytics",
{
"client_id": "c",
"dcr_forensic_stream": "Old-Forensic_CL",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.la_dcr_failure_stream, "Old-Forensic_CL")
class TestParseConfigGelf(unittest.TestCase):
def test_gelf_complete(self):
from parsedmarc.cli import _parse_config
cp = _config_with(
"gelf", {"host": "graylog.example.com", "port": "12201", "mode": "tls"}
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.gelf_host, "graylog.example.com")
self.assertEqual(opts.gelf_port, "12201")
self.assertEqual(opts.gelf_mode, "tls")
def test_gelf_missing_host_raises(self):
from parsedmarc.cli import ConfigurationError, _parse_config
cp = _config_with("gelf", {"port": "12201", "mode": "udp"})
with self.assertRaises(ConfigurationError):
_parse_config(cp, _opts())
def test_gelf_missing_port_raises(self):
from parsedmarc.cli import ConfigurationError, _parse_config
cp = _config_with("gelf", {"host": "g", "mode": "udp"})
with self.assertRaises(ConfigurationError):
_parse_config(cp, _opts())
def test_gelf_missing_mode_raises(self):
from parsedmarc.cli import ConfigurationError, _parse_config
cp = _config_with("gelf", {"host": "g", "port": "12201"})
with self.assertRaises(ConfigurationError):
_parse_config(cp, _opts())
class TestParseConfigWebhook(unittest.TestCase):
def test_webhook_complete(self):
from parsedmarc.cli import _parse_config
cp = _config_with(
"webhook",
{
"aggregate_url": "https://hooks.example.com/agg",
"failure_url": "https://hooks.example.com/fail",
"smtp_tls_url": "https://hooks.example.com/tls",
"timeout": "30",
},
)
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.webhook_aggregate_url, "https://hooks.example.com/agg")
self.assertEqual(opts.webhook_failure_url, "https://hooks.example.com/fail")
self.assertEqual(opts.webhook_smtp_tls_url, "https://hooks.example.com/tls")
self.assertEqual(opts.webhook_timeout, 30)
def test_webhook_forensic_url_alias_sets_failure_url(self):
from parsedmarc.cli import _parse_config
cp = _config_with("webhook", {"forensic_url": "https://old.example.com/fail"})
opts = _opts()
_parse_config(cp, opts)
self.assertEqual(opts.webhook_failure_url, "https://old.example.com/fail")
class TestConfigureLogging(unittest.TestCase):
"""cli._configure_logging is a thin wrapper around
parsedmarc.log.configure_logging (the parallel-parsing worker
initializer in parsedmarc/parallel.py calls configure_logging
directly) — if this wrapper stops attaching a handler, any remaining
caller's log output goes dark."""
def setUp(self):
from parsedmarc.log import logger as plog
self._saved_handlers = list(plog.handlers)
self._saved_level = plog.level
def tearDown(self):
from parsedmarc.log import logger as plog
plog.handlers[:] = self._saved_handlers
plog.setLevel(self._saved_level)
def test_sets_log_level(self):
import logging as _logging
from parsedmarc.cli import _configure_logging
from parsedmarc.log import logger as plog
_configure_logging(_logging.DEBUG)
self.assertEqual(plog.level, _logging.DEBUG)
def test_adds_stream_handler_when_none_present(self):
import logging as _logging
from parsedmarc.cli import _configure_logging
from parsedmarc.log import logger as plog
# Clear any existing StreamHandler so we know addHandler runs.
plog.handlers[:] = [
h for h in plog.handlers if type(h) is not _logging.StreamHandler
]
_configure_logging(_logging.INFO)
self.assertTrue(any(type(h) is _logging.StreamHandler for h in plog.handlers))
def test_does_not_duplicate_stream_handler(self):
import logging as _logging
from parsedmarc.cli import _configure_logging
from parsedmarc.log import logger as plog
# Start with a single StreamHandler attached.
plog.handlers[:] = [_logging.StreamHandler()]
before = len(plog.handlers)
_configure_logging(_logging.INFO)
after = len(plog.handlers)
self.assertEqual(before, after)
def test_adds_file_handler_when_log_file_given(self):
import logging as _logging
import tempfile
from parsedmarc.cli import _configure_logging
from parsedmarc.log import logger as plog
with tempfile.NamedTemporaryFile(suffix=".log", delete=False) as tf:
path = tf.name
try:
_configure_logging(_logging.INFO, log_file=path)
self.assertTrue(
any(isinstance(h, _logging.FileHandler) for h in plog.handlers)
)
finally:
for h in list(plog.handlers):
if isinstance(h, _logging.FileHandler):
plog.removeHandler(h)
h.close()
os.remove(path)
def test_unwritable_log_file_logs_warning_does_not_raise(self):
"""If the log file can't be opened, we warn and continue. A
regression that raised would crash the whole parse pipeline."""
import logging as _logging
from parsedmarc.cli import _configure_logging
with self.assertLogs("parsedmarc.log", level="WARNING") as cm:
_configure_logging(_logging.INFO, log_file="/proc/nonexistent/x.log")
self.assertTrue(any("Unable to write to log file" in m for m in cm.output))
if __name__ == "__main__":
unittest.main(verbosity=2)