"""Tests for the top-level parsedmarc package (parsedmarc/__init__.py). Covers the public parsing surface: parse_report_file, parse_report_email, parse_aggregate_report_xml, parse_failure_report, parse_smtp_tls_report_json, extract_report, get_dmarc_reports_from_mbox, and the CSV / JSON renderers. """ import json import mailbox import os import unittest from datetime import datetime, timedelta, timezone from glob import glob from io import BytesIO from pathlib import Path from shutil import rmtree from tempfile import NamedTemporaryFile, mkdtemp from typing import BinaryIO, cast from unittest.mock import MagicMock from lxml import etree # type: ignore[import-untyped] import parsedmarc from parsedmarc.mail import MaildirConnection from parsedmarc.types import AggregateReport, FailureReport, SMTPTLSReport # Detect if running in GitHub Actions to skip DNS lookups OFFLINE_MODE = os.environ.get("GITHUB_ACTIONS", "false").lower() == "true" def minify_xml(xml_string): parser = etree.XMLParser(remove_blank_text=True) tree = etree.fromstring(xml_string.encode("utf-8"), parser) return etree.tostring(tree, pretty_print=False).decode("utf-8") def compare_xml(xml1, xml2): parser = etree.XMLParser(remove_blank_text=True) tree1 = etree.fromstring(xml1.encode("utf-8"), parser) tree2 = etree.fromstring(xml2.encode("utf-8"), parser) return etree.tostring(tree1) == etree.tostring(tree2) 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 testExtractReportXMLComparator(self): """Test XML comparator function""" with open("samples/extract_report/nice-input.xml") as f: xmlnice = f.read() with open("samples/extract_report/changed-input.xml") as f: xmlchanged = minify_xml(f.read()) self.assertTrue(compare_xml(xmlnice, xmlnice)) self.assertTrue(compare_xml(xmlchanged, xmlchanged)) self.assertFalse(compare_xml(xmlnice, xmlchanged)) self.assertFalse(compare_xml(xmlchanged, xmlnice)) print("Passed!") def testExtractReportBytes(self): """Test extract report function for bytes string input""" print() file = "samples/extract_report/nice-input.xml" with open(file, "rb") as f: data = f.read() print("Testing {0}: ".format(file), end="") xmlout = parsedmarc.extract_report(data) with open("samples/extract_report/nice-input.xml") as f: xmlin = f.read() self.assertTrue(compare_xml(xmlout, xmlin)) print("Passed!") def testExtractReportXML(self): """Test extract report function for XML input""" print() file = "samples/extract_report/nice-input.xml" print("Testing {0}: ".format(file), end="") xmlout = parsedmarc.extract_report_from_file_path(file) with open("samples/extract_report/nice-input.xml") as f: xmlin = f.read() self.assertTrue(compare_xml(xmlout, xmlin)) print("Passed!") def testExtractReportXMLFromPath(self): """Test extract report function for pathlib.Path input""" report_path = Path("samples/extract_report/nice-input.xml") xmlout = parsedmarc.extract_report_from_file_path(report_path) with open("samples/extract_report/nice-input.xml") as xmlin_file: xmlin = xmlin_file.read() self.assertTrue(compare_xml(xmlout, xmlin)) def testExtractReportGZip(self): """Test extract report function for gzip input""" print() file = "samples/extract_report/nice-input.xml.gz" print("Testing {0}: ".format(file), end="") xmlout = parsedmarc.extract_report_from_file_path(file) with open("samples/extract_report/nice-input.xml") as f: xmlin = f.read() self.assertTrue(compare_xml(xmlout, xmlin)) print("Passed!") def testExtractReportZip(self): """Test extract report function for zip input""" print() file = "samples/extract_report/nice-input.xml.zip" print("Testing {0}: ".format(file), end="") xmlout = parsedmarc.extract_report_from_file_path(file) with open("samples/extract_report/nice-input.xml") as f: xmlin = minify_xml(f.read()) self.assertTrue(compare_xml(xmlout, xmlin)) with open("samples/extract_report/changed-input.xml") as f: xmlin = f.read() self.assertFalse(compare_xml(xmlout, xmlin)) print("Passed!") def testParseReportFileAcceptsPathForXML(self): report_path = Path( "samples/aggregate/protection.outlook.com!example.com!1711756800!1711843200.xml" ) result = parsedmarc.parse_report_file( report_path, offline=True, ) assert result["report_type"] == "aggregate" report = cast(AggregateReport, result["report"]) self.assertEqual(report["report_metadata"]["org_name"], "outlook.com") def testParseReportFileAcceptsPathForEmail(self): report_path = Path( "samples/aggregate/Report domain- borschow.com Submitter- google.com Report-ID- 949348866075514174.eml" ) result = parsedmarc.parse_report_file( report_path, offline=True, ) assert result["report_type"] == "aggregate" report = cast(AggregateReport, result["report"]) self.assertEqual(report["report_metadata"]["org_name"], "google.com") def testAggregateSamples(self): """Test sample aggregate/rua DMARC reports""" print() sample_paths = glob("samples/aggregate/*") for sample_path in sample_paths: if os.path.isdir(sample_path): continue print("Testing {0}: ".format(sample_path), end="") with self.subTest(sample=sample_path): result = parsedmarc.parse_report_file( sample_path, always_use_local_files=True, offline=OFFLINE_MODE ) assert result["report_type"] == "aggregate" parsedmarc.parsed_aggregate_reports_to_csv( cast(AggregateReport, result["report"]) ) print("Passed!") def testEmptySample(self): """Test empty/unparasable report""" with self.assertRaises(parsedmarc.ParserError): parsedmarc.parse_report_file("samples/empty.xml", offline=OFFLINE_MODE) def testFailureSamples(self): """Test sample failure/ruf DMARC reports""" print() sample_paths = glob("samples/failure/*.eml") for sample_path in sample_paths: print("Testing {0}: ".format(sample_path), end="") with self.subTest(sample=sample_path): with open(sample_path) as sample_file: sample_content = sample_file.read() email_result = parsedmarc.parse_report_email( sample_content, offline=OFFLINE_MODE ) assert email_result["report_type"] == "failure" result = parsedmarc.parse_report_file(sample_path, offline=OFFLINE_MODE) assert result["report_type"] == "failure" parsedmarc.parsed_failure_reports_to_csv( cast(FailureReport, result["report"]) ) print("Passed!") def testFailureReportBackwardCompat(self): """Test that old forensic function aliases still work""" self.assertIs( parsedmarc.parse_forensic_report, parsedmarc.parse_failure_report, ) self.assertIs( parsedmarc.parsed_forensic_reports_to_csv, parsedmarc.parsed_failure_reports_to_csv, ) self.assertIs( parsedmarc.parsed_forensic_reports_to_csv_rows, parsedmarc.parsed_failure_reports_to_csv_rows, ) self.assertIs( parsedmarc.InvalidForensicReport, parsedmarc.InvalidFailureReport, ) def testRFC9990SampleReport(self): """Test parsing the sample report from RFC 9990 Appendix B""" print() sample_path = "samples/aggregate/rfc9990-sample.xml" print("Testing {0}: ".format(sample_path), end="") result = parsedmarc.parse_report_file( sample_path, always_use_local_files=True, offline=True ) report = cast(AggregateReport, result["report"]) # Verify report_type self.assertEqual(result["report_type"], "aggregate") # Verify xml_schema self.assertEqual(report["xml_schema"], "1.0") # Verify report_metadata metadata = report["report_metadata"] self.assertEqual(metadata["org_name"], "Sample Reporter") self.assertEqual(metadata["org_email"], "report_sender@example-reporter.com") self.assertEqual(metadata["org_extra_contact_info"], "...") self.assertEqual(metadata["report_id"], "3v98abbp8ya9n3va8yr8oa3ya") self.assertEqual( metadata["generator"], "Example DMARC Aggregate Reporter v1.2", ) # Verify RFC 9990 policy_published fields pp = report["policy_published"] self.assertEqual(pp["domain"], "example.com") self.assertEqual(pp["p"], "quarantine") self.assertEqual(pp["sp"], "none") self.assertEqual(pp["np"], "none") self.assertEqual(pp["testing"], "n") self.assertEqual(pp["discovery_method"], "treewalk") # adkim/aspf default when not in XML self.assertEqual(pp["adkim"], "r") self.assertEqual(pp["aspf"], "r") # pct is removed in RFC 9989 (and so absent from the RFC 9990 # sample); fo is still part of RFC 9990's PolicyPublishedType but # the appendix sample happens not to set it. self.assertIsNone(pp["pct"]) self.assertIsNone(pp["fo"]) # Verify record self.assertEqual(len(report["records"]), 1) rec = report["records"][0] self.assertEqual(rec["source"]["ip_address"], "192.0.2.123") self.assertEqual(rec["count"], 123) self.assertEqual(rec["policy_evaluated"]["disposition"], "pass") self.assertEqual(rec["policy_evaluated"]["dkim"], "pass") self.assertEqual(rec["policy_evaluated"]["spf"], "fail") # Verify DKIM auth result with human_result self.assertEqual(len(rec["auth_results"]["dkim"]), 1) dkim = rec["auth_results"]["dkim"][0] self.assertEqual(dkim["domain"], "example.com") self.assertEqual(dkim["selector"], "abc123") self.assertEqual(dkim["result"], "pass") self.assertIsNone(dkim["human_result"]) # Verify SPF auth result with human_result self.assertEqual(len(rec["auth_results"]["spf"]), 1) spf = rec["auth_results"]["spf"][0] self.assertEqual(spf["domain"], "example.com") self.assertEqual(spf["result"], "fail") self.assertIsNone(spf["human_result"]) # Verify CSV output includes new fields csv = parsedmarc.parsed_aggregate_reports_to_csv(report) header = csv.split("\n")[0] self.assertIn("np", header.split(",")) self.assertIn("testing", header.split(",")) self.assertIn("discovery_method", header.split(",")) print("Passed!") def testRFC9990FieldsAbsentFromRFC7489Report(self): """Test that RFC 7489 reports have None for RFC 9990-only fields""" print() sample_path = ( "samples/aggregate/example.net!example.com!1529366400!1529452799.xml" ) print("Testing {0}: ".format(sample_path), end="") result = parsedmarc.parse_report_file( sample_path, always_use_local_files=True, offline=True ) report = cast(AggregateReport, result["report"]) pp = report["policy_published"] # RFC 7489 fields present self.assertEqual(pp["pct"], "100") self.assertEqual(pp["fo"], "0") # RFC 9990-only fields absent (None) self.assertIsNone(pp["np"]) self.assertIsNone(pp["testing"]) self.assertIsNone(pp["discovery_method"]) # generator absent (None) self.assertIsNone(report["report_metadata"]["generator"]) print("Passed!") def testRFC9990WithExplicitFields(self): """Test RFC 9990 report with explicit testing and discovery_method""" print() sample_path = ( "samples/aggregate/" "rfc9990-example.net!example.com!1700000000!1700086399.xml" ) print("Testing {0}: ".format(sample_path), end="") result = parsedmarc.parse_report_file( sample_path, always_use_local_files=True, offline=True ) report = cast(AggregateReport, result["report"]) pp = report["policy_published"] self.assertEqual(pp["np"], "reject") self.assertEqual(pp["testing"], "y") self.assertEqual(pp["discovery_method"], "treewalk") print("Passed!") def testRFC9990NamespaceCaptured(self): """The dmarc-2.0 namespace on is preserved on the parsed report so consumers can distinguish RFC 9990 from RFC 7489 reports without inferring from the version element value.""" result = parsedmarc.parse_report_file( "samples/aggregate/rfc9990-sample.xml", always_use_local_files=True, offline=True, ) report = cast(AggregateReport, result["report"]) self.assertEqual( report["xml_namespace"], "urn:ietf:params:xml:ns:dmarc-2.0", ) def testRFC9990NamespaceAbsentOnRFC7489Report(self): """RFC 7489 reports don't declare the dmarc-2.0 namespace, so xml_namespace is None.""" result = parsedmarc.parse_report_file( "samples/aggregate/example.net!example.com!1529366400!1529452799.xml", always_use_local_files=True, offline=True, ) report = cast(AggregateReport, result["report"]) self.assertIsNone(report["xml_namespace"]) def testRFC9990DetectionAcceptsNamespacelessReports(self): """A report that follows the RFC 9990 shape without declaring the namespace (e.g. emits np/testing/discovery_method) is still treated as RFC 9990 for validation purposes — warnings fire, the namespace field reports it honestly as absent.""" with self.assertLogs("parsedmarc.log", level="WARNING") as cm: report = parsedmarc.parse_aggregate_report_xml( """ Test t@example.com r1 17000000001700086399 example.com

none

reject 192.0.2.1 1 none pass pass example.com example.com pass """, offline=True, ) # Namespace honestly None because none was declared. self.assertIsNone(report["xml_namespace"]) # RFC 9990 detection still fired (DKIM selector warning emitted). self.assertTrue( any("selector" in msg for msg in cm.output), f"Expected DKIM selector warning; got: {cm.output}", ) def testRFC9990DKIMMissingSelectorWarning(self): """A DKIM auth result with no in an RFC 9990 report (namespace declared) emits a warning since selector is REQUIRED.""" xml = """ 1.0 Test t@example.com r1 17000000001700086399 example.com

none

 192.0.2.1 1 none pass pass example.com example.com pass """ with self.assertLogs("parsedmarc.log", level="WARNING") as cm: parsedmarc.parse_aggregate_report_xml(xml, offline=True) self.assertTrue( any("selector" in m and "REQUIRED" in m for m in cm.output), f"Expected selector REQUIRED warning; got: {cm.output}", ) def testRFC9990LegacyOverrideTypeWarning(self): """`forwarded` and `sampled_out` were removed in RFC 9990; a warning fires when they appear in an RFC 9990 report.""" xml = """ Test t@example.com r1 17000000001700086399 example.com

none

 192.0.2.1 1 none pass pass forwarded example.com example.com s pass """ with self.assertLogs("parsedmarc.log", level="WARNING") as cm: parsedmarc.parse_aggregate_report_xml(xml, offline=True) self.assertTrue( any("forwarded" in m and "removed in RFC 9990" in m for m in cm.output), f"Expected legacy override warning; got: {cm.output}", ) def testRFC9990LangAttrStringUnwrapped(self): """When a langAttrString element (extra_contact_info, error, comment, human_result) carries a lang attribute, xmltodict turns it into {"#text": "...", "@lang": "en"}; the parser must unwrap to the text payload so the report stays comparable to one without the lang attribute.""" xml = """ Test t@example.com contact-here r1 17000000001700086399 a problem example.com

none

 192.0.2.1 1 none pass pass local_policy a comment example.com example.com s pass looks fine example.com pass spf-detail """ report = parsedmarc.parse_aggregate_report_xml(xml, offline=True) self.assertEqual( report["report_metadata"]["org_extra_contact_info"], "contact-here" ) self.assertEqual(report["report_metadata"]["errors"], ["a problem"]) rec = report["records"][0] reasons = rec["policy_evaluated"]["policy_override_reasons"] self.assertEqual(reasons[0]["comment"], "a comment") self.assertEqual(rec["auth_results"]["dkim"][0]["human_result"], "looks fine") self.assertEqual(rec["auth_results"]["spf"][0]["human_result"], "spf-detail") def testSmtpTlsSamples(self): """Test sample SMTP TLS reports""" print() sample_paths = glob("samples/smtp_tls/*") for sample_path in sample_paths: if os.path.isdir(sample_path): continue print("Testing {0}: ".format(sample_path), end="") with self.subTest(sample=sample_path): result = parsedmarc.parse_report_file(sample_path, offline=OFFLINE_MODE) assert result["report_type"] == "smtp_tls" parsedmarc.parsed_smtp_tls_reports_to_csv( cast(SMTPTLSReport, result["report"]) ) print("Passed!") def testAggregateCsvExposesASNColumns(self): """The aggregate CSV output should include source_asn, source_as_name, and source_as_domain columns.""" result = parsedmarc.parse_report_file( "samples/aggregate/!example.com!1538204542!1538463818.xml", always_use_local_files=True, offline=True, ) csv_text = parsedmarc.parsed_aggregate_reports_to_csv(result["report"]) header = csv_text.splitlines()[0].split(",") self.assertIn("source_asn", header) self.assertIn("source_as_name", header) self.assertIn("source_as_domain", header) def testBucketIntervalBeginAfterEnd(self): """begin > end should raise ValueError""" begin = datetime(2024, 1, 2, tzinfo=timezone.utc) end = datetime(2024, 1, 1, tzinfo=timezone.utc) with self.assertRaises(ValueError): parsedmarc._bucket_interval_by_day(begin, end, 100) def testBucketIntervalNaiveDatetime(self): """Non-timezone-aware datetimes should raise ValueError""" begin = datetime(2024, 1, 1) end = datetime(2024, 1, 2) with self.assertRaises(ValueError): parsedmarc._bucket_interval_by_day(begin, end, 100) def testBucketIntervalDifferentTzinfo(self): """Different tzinfo objects should raise ValueError""" tz1 = timezone.utc tz2 = timezone(timedelta(hours=5)) begin = datetime(2024, 1, 1, tzinfo=tz1) end = datetime(2024, 1, 2, tzinfo=tz2) with self.assertRaises(ValueError): parsedmarc._bucket_interval_by_day(begin, end, 100) def testBucketIntervalNegativeCount(self): """Negative total_count should raise ValueError""" begin = datetime(2024, 1, 1, tzinfo=timezone.utc) end = datetime(2024, 1, 2, tzinfo=timezone.utc) with self.assertRaises(ValueError): parsedmarc._bucket_interval_by_day(begin, end, -1) def testBucketIntervalZeroCount(self): """Zero total_count should return empty list""" begin = datetime(2024, 1, 1, tzinfo=timezone.utc) end = datetime(2024, 1, 2, tzinfo=timezone.utc) result = parsedmarc._bucket_interval_by_day(begin, end, 0) self.assertEqual(result, []) def testBucketIntervalSameBeginEnd(self): """Same begin and end (zero interval) should return empty list""" dt = datetime(2024, 1, 1, 12, 0, 0, tzinfo=timezone.utc) result = parsedmarc._bucket_interval_by_day(dt, dt, 100) self.assertEqual(result, []) def testBucketIntervalSingleDay(self): """Single day interval should return one bucket with total count""" begin = datetime(2024, 1, 1, 0, 0, 0, tzinfo=timezone.utc) end = datetime(2024, 1, 1, 23, 59, 59, tzinfo=timezone.utc) result = parsedmarc._bucket_interval_by_day(begin, end, 100) self.assertEqual(len(result), 1) self.assertEqual(result[0]["count"], 100) self.assertEqual(result[0]["begin"], begin) def testBucketIntervalMultiDay(self): """Multi-day interval should distribute counts proportionally""" begin = datetime(2024, 1, 1, 0, 0, 0, tzinfo=timezone.utc) end = datetime(2024, 1, 3, 0, 0, 0, tzinfo=timezone.utc) result = parsedmarc._bucket_interval_by_day(begin, end, 100) self.assertEqual(len(result), 2) total = sum(b["count"] for b in result) self.assertEqual(total, 100) # Equal days => equal distribution self.assertEqual(result[0]["count"], 50) self.assertEqual(result[1]["count"], 50) def testBucketIntervalRemainderDistribution(self): """Odd count across equal days distributes remainder correctly""" begin = datetime(2024, 1, 1, 0, 0, 0, tzinfo=timezone.utc) end = datetime(2024, 1, 4, 0, 0, 0, tzinfo=timezone.utc) result = parsedmarc._bucket_interval_by_day(begin, end, 10) total = sum(b["count"] for b in result) self.assertEqual(total, 10) self.assertEqual(len(result), 3) def testBucketIntervalPartialDays(self): """Partial days: 12h on day1, 24h on day2 => 1/3 vs 2/3 split""" begin = datetime(2024, 1, 1, 12, 0, 0, tzinfo=timezone.utc) end = datetime(2024, 1, 3, 0, 0, 0, tzinfo=timezone.utc) result = parsedmarc._bucket_interval_by_day(begin, end, 90) total = sum(b["count"] for b in result) self.assertEqual(total, 90) # day1: 12h, day2: 24h => 1/3 vs 2/3 self.assertEqual(result[0]["count"], 30) self.assertEqual(result[1]["count"], 60) def testAppendParsedRecordNoNormalize(self): """No normalization: record appended as-is with interval fields""" records = [] rec = {"count": 10, "source": {"ip_address": "1.2.3.4"}} begin = datetime(2024, 1, 1, 0, 0, 0, tzinfo=timezone.utc) end = datetime(2024, 1, 2, 0, 0, 0, tzinfo=timezone.utc) parsedmarc._append_parsed_record(rec, records, begin, end, False) self.assertEqual(len(records), 1) self.assertFalse(records[0]["normalized_timespan"]) # type: ignore[typeddict-item] self.assertEqual(records[0]["interval_begin"], "2024-01-01 00:00:00") self.assertEqual(records[0]["interval_end"], "2024-01-02 00:00:00") def testAppendParsedRecordNormalize(self): """Normalization: record split into daily buckets""" records = [] rec = {"count": 100, "source": {"ip_address": "1.2.3.4"}} begin = datetime(2024, 1, 1, 0, 0, 0, tzinfo=timezone.utc) end = datetime(2024, 1, 3, 0, 0, 0, tzinfo=timezone.utc) parsedmarc._append_parsed_record(rec, records, begin, end, True) self.assertEqual(len(records), 2) total = sum(r["count"] for r in records) self.assertEqual(total, 100) for r in records: self.assertTrue(r["normalized_timespan"]) # type: ignore[typeddict-item] def testAppendParsedRecordNormalizeZeroCount(self): """Normalization with zero count: nothing appended""" records = [] rec = {"count": 0, "source": {"ip_address": "1.2.3.4"}} begin = datetime(2024, 1, 1, 0, 0, 0, tzinfo=timezone.utc) end = datetime(2024, 1, 3, 0, 0, 0, tzinfo=timezone.utc) parsedmarc._append_parsed_record(rec, records, begin, end, True) self.assertEqual(len(records), 0) def testParseReportRecordNoneSourceIP(self): """Record with None source_ip should raise ValueError""" record = { "row": { "source_ip": None, "count": "1", "policy_evaluated": { "disposition": "none", "dkim": "pass", "spf": "pass", }, }, "identifiers": {"header_from": "example.com"}, "auth_results": {"dkim": [], "spf": []}, } with self.assertRaises(ValueError): parsedmarc._parse_report_record(record, offline=True) def testParseReportRecordMissingDkimSpf(self): """Record with missing dkim/spf auth results defaults correctly""" record = { "row": { "source_ip": "192.0.2.1", "count": "5", "policy_evaluated": { "disposition": "none", "dkim": "pass", "spf": "fail", }, }, "identifiers": {"header_from": "example.com"}, "auth_results": {}, } result = parsedmarc._parse_report_record(record, offline=True) self.assertEqual(result["auth_results"]["dkim"], []) self.assertEqual(result["auth_results"]["spf"], []) def testParseReportRecordReasonHandling(self): """Reasons in policy_evaluated get normalized with comment default""" record = { "row": { "source_ip": "192.0.2.1", "count": "1", "policy_evaluated": { "disposition": "none", "dkim": "pass", "spf": "pass", "reason": {"type": "forwarded"}, }, }, "identifiers": {"header_from": "example.com"}, "auth_results": {"dkim": [], "spf": []}, } result = parsedmarc._parse_report_record(record, offline=True) reasons = result["policy_evaluated"]["policy_override_reasons"] self.assertEqual(len(reasons), 1) self.assertEqual(reasons[0]["type"], "forwarded") self.assertIsNone(reasons[0]["comment"]) def testParseReportRecordReasonList(self): """Multiple reasons as a list are preserved""" record = { "row": { "source_ip": "192.0.2.1", "count": "1", "policy_evaluated": { "disposition": "none", "dkim": "pass", "spf": "pass", "reason": [ {"type": "forwarded", "comment": "relay"}, {"type": "local_policy"}, ], }, }, "identifiers": {"header_from": "example.com"}, "auth_results": {"dkim": [], "spf": []}, } result = parsedmarc._parse_report_record(record, offline=True) reasons = result["policy_evaluated"]["policy_override_reasons"] self.assertEqual(len(reasons), 2) self.assertEqual(reasons[0]["comment"], "relay") self.assertIsNone(reasons[1]["comment"]) def testParseReportRecordIdentities(self): """'identities' key is mapped to 'identifiers'""" record = { "row": { "source_ip": "192.0.2.1", "count": "1", "policy_evaluated": { "disposition": "none", "dkim": "pass", "spf": "pass", }, }, "identities": { "header_from": "Example.COM", "envelope_from": "example.com", }, "auth_results": {"dkim": [], "spf": []}, } result = parsedmarc._parse_report_record(record, offline=True) self.assertIn("identifiers", result) self.assertEqual(result["identifiers"]["header_from"], "example.com") def testParseReportRecordDkimDefaults(self): """DKIM result defaults: selector='none', result='none' when missing""" record = { "row": { "source_ip": "192.0.2.1", "count": "1", "policy_evaluated": { "disposition": "none", "dkim": "fail", "spf": "fail", }, }, "identifiers": {"header_from": "example.com"}, "auth_results": { "dkim": {"domain": "example.com"}, "spf": [], }, } result = parsedmarc._parse_report_record(record, offline=True) dkim = result["auth_results"]["dkim"][0] self.assertEqual(dkim["selector"], "none") self.assertEqual(dkim["result"], "none") self.assertIsNone(dkim["human_result"]) def testParseReportRecordSpfDefaults(self): """SPF result defaults: scope='mfrom', result='none' when missing""" record = { "row": { "source_ip": "192.0.2.1", "count": "1", "policy_evaluated": { "disposition": "none", "dkim": "fail", "spf": "fail", }, }, "identifiers": {"header_from": "example.com"}, "auth_results": { "dkim": [], "spf": {"domain": "example.com"}, }, } result = parsedmarc._parse_report_record(record, offline=True) spf = result["auth_results"]["spf"][0] self.assertEqual(spf["scope"], "mfrom") self.assertEqual(spf["result"], "none") self.assertIsNone(spf["human_result"]) def testParseReportRecordHumanResult(self): """human_result field is included when present""" record = { "row": { "source_ip": "192.0.2.1", "count": "1", "policy_evaluated": { "disposition": "none", "dkim": "pass", "spf": "pass", }, }, "identifiers": {"header_from": "example.com"}, "auth_results": { "dkim": [ { "domain": "example.com", "selector": "s1", "result": "pass", "human_result": "good key", } ], "spf": [ { "domain": "example.com", "scope": "mfrom", "result": "pass", "human_result": "sender valid", } ], }, } result = parsedmarc._parse_report_record(record, offline=True) self.assertEqual(result["auth_results"]["dkim"][0]["human_result"], "good key") self.assertEqual( result["auth_results"]["spf"][0]["human_result"], "sender valid" ) def testParseReportRecordEnvelopeFromFallback(self): """envelope_from falls back to last SPF domain when missing""" record = { "row": { "source_ip": "192.0.2.1", "count": "1", "policy_evaluated": { "disposition": "none", "dkim": "pass", "spf": "pass", }, }, "identifiers": {"header_from": "example.com"}, "auth_results": { "dkim": [], "spf": [ {"domain": "Bounce.Example.COM", "scope": "mfrom", "result": "pass"} ], }, } result = parsedmarc._parse_report_record(record, offline=True) self.assertEqual(result["identifiers"]["envelope_from"], "bounce.example.com") def testParseReportRecordEnvelopeFromNullFallback(self): """envelope_from None value falls back to SPF domain""" record = { "row": { "source_ip": "192.0.2.1", "count": "1", "policy_evaluated": { "disposition": "none", "dkim": "pass", "spf": "pass", }, }, "identifiers": { "header_from": "example.com", "envelope_from": None, }, "auth_results": { "dkim": [], "spf": [ {"domain": "SPF.Example.COM", "scope": "mfrom", "result": "pass"} ], }, } result = parsedmarc._parse_report_record(record, offline=True) self.assertEqual(result["identifiers"]["envelope_from"], "spf.example.com") def testParseReportRecordEnvelopeTo(self): """envelope_to is preserved and moved correctly""" record = { "row": { "source_ip": "192.0.2.1", "count": "1", "policy_evaluated": { "disposition": "none", "dkim": "pass", "spf": "pass", }, }, "identifiers": { "header_from": "example.com", "envelope_from": "bounce@example.com", "envelope_to": "recipient@example.com", }, "auth_results": {"dkim": [], "spf": []}, } result = parsedmarc._parse_report_record(record, offline=True) self.assertEqual(result["identifiers"]["envelope_to"], "recipient@example.com") def testParseReportRecordAlignment(self): """Alignment fields computed correctly from policy_evaluated""" record = { "row": { "source_ip": "192.0.2.1", "count": "1", "policy_evaluated": { "disposition": "none", "dkim": "pass", "spf": "fail", }, }, "identifiers": {"header_from": "example.com"}, "auth_results": {"dkim": [], "spf": []}, } result = parsedmarc._parse_report_record(record, offline=True) self.assertTrue(result["alignment"]["dkim"]) self.assertFalse(result["alignment"]["spf"]) self.assertTrue(result["alignment"]["dmarc"]) def testParseSmtpTlsFailureDetailsMinimal(self): """Minimal failure details with just required fields""" details = { "result-type": "certificate-expired", "failed-session-count": 5, } result = parsedmarc._parse_smtp_tls_failure_details(details) self.assertEqual(result["result_type"], "certificate-expired") self.assertEqual(result["failed_session_count"], 5) self.assertNotIn("sending_mta_ip", result) def testParseSmtpTlsFailureDetailsAllOptional(self): """All optional fields included""" details = { "result-type": "starttls-not-supported", "failed-session-count": 3, "sending-mta-ip": "10.0.0.1", "receiving-ip": "10.0.0.2", "receiving-mx-hostname": "mx.example.com", "receiving-mx-helo": "mx.example.com", "additional-info-uri": "https://example.com/info", "failure-reason-code": "TLS_ERROR", } result = parsedmarc._parse_smtp_tls_failure_details(details) self.assertEqual(result["sending_mta_ip"], "10.0.0.1") self.assertEqual(result["receiving_ip"], "10.0.0.2") self.assertEqual(result["receiving_mx_hostname"], "mx.example.com") self.assertEqual(result["receiving_mx_helo"], "mx.example.com") self.assertEqual(result["additional_info_uri"], "https://example.com/info") self.assertEqual(result["failure_reason_code"], "TLS_ERROR") def testParseSmtpTlsFailureDetailsMissingRequired(self): """Missing required field raises InvalidSMTPTLSReport""" with self.assertRaises(parsedmarc.InvalidSMTPTLSReport): parsedmarc._parse_smtp_tls_failure_details({"result-type": "err"}) def testParseSmtpTlsReportPolicyValid(self): """Valid STS policy parses correctly""" policy = { "policy": { "policy-type": "sts", "policy-domain": "example.com", "policy-string": ["version: STSv1", "mode: enforce"], "mx-host-pattern": ["*.example.com"], }, "summary": { "total-successful-session-count": 100, "total-failure-session-count": 2, }, } result = parsedmarc._parse_smtp_tls_report_policy(policy) self.assertEqual(result["policy_type"], "sts") self.assertEqual(result["policy_domain"], "example.com") self.assertEqual(result["policy_strings"], ["version: STSv1", "mode: enforce"]) self.assertEqual(result["mx_host_patterns"], ["*.example.com"]) self.assertEqual(result["successful_session_count"], 100) self.assertEqual(result["failed_session_count"], 2) def testParseSmtpTlsReportPolicyInvalidType(self): """Invalid policy type raises InvalidSMTPTLSReport""" policy = { "policy": { "policy-type": "invalid", "policy-domain": "example.com", }, "summary": { "total-successful-session-count": 0, "total-failure-session-count": 0, }, } with self.assertRaises(parsedmarc.InvalidSMTPTLSReport): parsedmarc._parse_smtp_tls_report_policy(policy) def testParseSmtpTlsReportPolicyEmptyPolicyString(self): """Empty policy-string list is not included""" policy = { "policy": { "policy-type": "sts", "policy-domain": "example.com", "policy-string": [], "mx-host-pattern": [], }, "summary": { "total-successful-session-count": 50, "total-failure-session-count": 0, }, } result = parsedmarc._parse_smtp_tls_report_policy(policy) self.assertNotIn("policy_strings", result) self.assertNotIn("mx_host_patterns", result) def testParseSmtpTlsReportPolicyWithFailureDetails(self): """Policy with failure-details parses nested details""" policy = { "policy": { "policy-type": "sts", "policy-domain": "example.com", }, "summary": { "total-successful-session-count": 10, "total-failure-session-count": 1, }, "failure-details": [ { "result-type": "certificate-expired", "failed-session-count": 1, } ], } result = parsedmarc._parse_smtp_tls_report_policy(policy) self.assertEqual(len(result["failure_details"]), 1) self.assertEqual( result["failure_details"][0]["result_type"], "certificate-expired" ) def testParseSmtpTlsReportPolicyMissingField(self): """Missing required policy field raises InvalidSMTPTLSReport""" policy = {"policy": {"policy-type": "sts"}, "summary": {}} with self.assertRaises(parsedmarc.InvalidSMTPTLSReport): parsedmarc._parse_smtp_tls_report_policy(policy) def testParseSmtpTlsReportJsonValid(self): """Valid SMTP TLS JSON report parses correctly""" report = json.dumps( { "organization-name": "Example Corp", "date-range": { "start-datetime": "2024-01-01T00:00:00Z", "end-datetime": "2024-01-02T00:00:00Z", }, "contact-info": "admin@example.com", "report-id": "report-123", "policies": [ { "policy": { "policy-type": "sts", "policy-domain": "example.com", }, "summary": { "total-successful-session-count": 50, "total-failure-session-count": 0, }, } ], } ) result = parsedmarc.parse_smtp_tls_report_json(report) self.assertEqual(result["organization_name"], "Example Corp") self.assertEqual(result["report_id"], "report-123") self.assertEqual(len(result["policies"]), 1) def testParseSmtpTlsReportJsonBytes(self): """SMTP TLS report as bytes parses correctly""" report = json.dumps( { "organization-name": "Org", "date-range": { "start-datetime": "2024-01-01", "end-datetime": "2024-01-02", }, "contact-info": "a@b.com", "report-id": "r1", "policies": [ { "policy": {"policy-type": "tlsa", "policy-domain": "a.com"}, "summary": { "total-successful-session-count": 1, "total-failure-session-count": 0, }, } ], } ).encode("utf-8") result = parsedmarc.parse_smtp_tls_report_json(report) self.assertEqual(result["organization_name"], "Org") def testParseSmtpTlsReportJsonMissingField(self): """Missing required field raises InvalidSMTPTLSReport""" report = json.dumps({"organization-name": "Org"}) with self.assertRaises(parsedmarc.InvalidSMTPTLSReport): parsedmarc.parse_smtp_tls_report_json(report) def testParseSmtpTlsReportJsonPoliciesNotList(self): """Non-list policies raises InvalidSMTPTLSReport""" report = json.dumps( { "organization-name": "Org", "date-range": { "start-datetime": "2024-01-01", "end-datetime": "2024-01-02", }, "contact-info": "a@b.com", "report-id": "r1", "policies": "not-a-list", } ) with self.assertRaises(parsedmarc.InvalidSMTPTLSReport): parsedmarc.parse_smtp_tls_report_json(report) def testAggregateReportInvalidNpWarning(self): """Invalid np value is preserved but logs warning""" xml = """ 1.0 Test Org test@example.com test-np-invalid 17040672001704153599 example.com

none

banana maybe magic 192.0.2.1 1 none pass pass example.com example.compass """ report = parsedmarc.parse_aggregate_report_xml(xml, offline=True) # Invalid values are still stored self.assertEqual(report["policy_published"]["np"], "banana") self.assertEqual(report["policy_published"]["testing"], "maybe") self.assertEqual(report["policy_published"]["discovery_method"], "magic") def testAggregateReportPassDisposition(self): """'pass' as valid disposition is preserved""" xml = """ TestOrg test@example.com test-pass 17040672001704153599 example.com

reject

 192.0.2.1 1 pass pass pass example.com example.compass """ report = parsedmarc.parse_aggregate_report_xml(xml, offline=True) self.assertEqual( report["records"][0]["policy_evaluated"]["disposition"], "pass" ) def testAggregateReportMultipleRecords(self): """Reports with multiple records are all parsed""" xml = """ TestOrg test@example.com test-multi 17040672001704153599 example.com

none

 192.0.2.1 10 nonepasspass example.com example.compass 192.0.2.2 5 quarantinefailfail example.com example.comfail """ report = parsedmarc.parse_aggregate_report_xml(xml, offline=True) self.assertEqual(len(report["records"]), 2) self.assertEqual(report["records"][0]["count"], 10) self.assertEqual(report["records"][1]["count"], 5) def testAggregateReportInvalidXmlRecovery(self): """Badly formed XML is recovered via lxml""" xml = 'Testt@e.comr117040672001704153599example.com

none

192.0.2.11nonepasspassexample.comexample.compass' report = parsedmarc.parse_aggregate_report_xml(xml, offline=True) self.assertEqual(report["report_metadata"]["report_id"], "r1") def testAggregateReportCsvRowsContainRFC9990Fields(self): """CSV rows include np, testing, discovery_method columns""" result = parsedmarc.parse_report_file( "samples/aggregate/rfc9990-sample.xml", always_use_local_files=True, offline=True, ) report = cast(AggregateReport, result["report"]) rows = parsedmarc.parsed_aggregate_reports_to_csv_rows(report) self.assertTrue(len(rows) > 0) row = rows[0] self.assertIn("np", row) self.assertIn("testing", row) self.assertIn("discovery_method", row) self.assertIn("source_ip_address", row) self.assertIn("dkim_domains", row) self.assertIn("spf_domains", row) def testAggregateReportSchemaVersion(self): """RFC 9990 report with returns correct xml_schema""" xml = """ 1.0 TestOrg test@example.com test-version 17040672001704153599 example.com

none

 192.0.2.1 1 nonepasspass example.com example.compass """ report = parsedmarc.parse_aggregate_report_xml(xml, offline=True) self.assertEqual(report["xml_schema"], "1.0") def testAggregateReportDraftSchema(self): """Report without defaults to 'draft' schema""" xml = """ TestOrg test@example.com test-draft 17040672001704153599 example.com

none

 192.0.2.1 1 nonepasspass example.com example.compass """ report = parsedmarc.parse_aggregate_report_xml(xml, offline=True) self.assertEqual(report["xml_schema"], "draft") def testAggregateReportGeneratorField(self): """Generator field is correctly extracted""" xml = """ TestOrg test@example.com test-gen My Reporter v1.0 17040672001704153599 example.com

none

 192.0.2.1 1 nonepasspass example.com example.compass """ report = parsedmarc.parse_aggregate_report_xml(xml, offline=True) self.assertEqual(report["report_metadata"]["generator"], "My Reporter v1.0") def testAggregateReportReportErrors(self): """Report errors in metadata are captured""" xml = """ TestOrg test@example.com test-err Some error 17040672001704153599 example.com

none

 192.0.2.1 1 nonepasspass example.com example.compass """ report = parsedmarc.parse_aggregate_report_xml(xml, offline=True) self.assertIn("Some error", report["report_metadata"]["errors"]) def testAggregateReportPolicyDefaults(self): """Policy defaults: adkim/aspf='r', sp=p, pct/fo=None""" xml = """ TestOrg test@example.com test-defaults 17040672001704153599 example.com

reject

 192.0.2.1 1 nonepasspass example.com example.compass """ report = parsedmarc.parse_aggregate_report_xml(xml, offline=True) pp = report["policy_published"] self.assertEqual(pp["adkim"], "r") self.assertEqual(pp["aspf"], "r") self.assertEqual(pp["sp"], "reject") # defaults to p self.assertIsNone(pp["pct"]) self.assertIsNone(pp["fo"]) self.assertIsNone(pp["np"]) self.assertIsNone(pp["testing"]) self.assertIsNone(pp["discovery_method"]) def testMagicXmlTagDetection(self): """XML without declaration (starting with '<') is extracted""" xml_no_decl = b"Ta@b.comr117040672001704153599example.com

none

192.0.2.11nonepasspassexample.comexample.compass" self.assertTrue(xml_no_decl.startswith(parsedmarc.MAGIC_XML_TAG)) # Ensure it extracts as XML result = parsedmarc.extract_report(xml_no_decl) self.assertIn("", result) def testSmtpTlsCsvRows(self): """parsed_smtp_tls_reports_to_csv_rows produces correct rows""" report_json = json.dumps( { "organization-name": "Org", "date-range": { "start-datetime": "2024-01-01T00:00:00Z", "end-datetime": "2024-01-02T00:00:00Z", }, "contact-info": "a@b.com", "report-id": "r1", "policies": [ { "policy": { "policy-type": "sts", "policy-domain": "example.com", "policy-string": ["v: STSv1"], "mx-host-pattern": ["*.example.com"], }, "summary": { "total-successful-session-count": 10, "total-failure-session-count": 1, }, "failure-details": [ {"result-type": "cert-expired", "failed-session-count": 1} ], } ], } ) parsed = parsedmarc.parse_smtp_tls_report_json(report_json) rows = parsedmarc.parsed_smtp_tls_reports_to_csv_rows(parsed) self.assertTrue(len(rows) >= 2) self.assertEqual(rows[0]["organization_name"], "Org") self.assertEqual(rows[0]["policy_domain"], "example.com") def testParsedAggregateReportsToCsvRowsList(self): """parsed_aggregate_reports_to_csv_rows handles list of reports""" result = parsedmarc.parse_report_file( "samples/aggregate/rfc9990-sample.xml", always_use_local_files=True, offline=True, ) report = cast(AggregateReport, result["report"]) # Pass as a list rows = parsedmarc.parsed_aggregate_reports_to_csv_rows([report]) self.assertTrue(len(rows) > 0) # Verify non-str/int/bool values are cleaned for row in rows: for v in row.values(): self.assertIn(type(v), [str, int, bool]) def testExceptionHierarchy(self): """Exception class hierarchy is correct""" self.assertTrue(issubclass(parsedmarc.ParserError, RuntimeError)) self.assertTrue( issubclass(parsedmarc.InvalidDMARCReport, parsedmarc.ParserError) ) self.assertTrue( issubclass(parsedmarc.InvalidAggregateReport, parsedmarc.InvalidDMARCReport) ) self.assertTrue( issubclass(parsedmarc.InvalidFailureReport, parsedmarc.InvalidDMARCReport) ) self.assertTrue( issubclass(parsedmarc.InvalidSMTPTLSReport, parsedmarc.ParserError) ) self.assertIs(parsedmarc.InvalidForensicReport, parsedmarc.InvalidFailureReport) def testAggregateReportNormalization(self): """Reports spanning >24h get normalized per day""" xml = """ TestOrg test@example.com test-norm 17040672001704326400 example.com

none

 192.0.2.1 90 nonepasspass example.com example.compass """ # Span is 259200 seconds (3 days), exceeds default 24h threshold report = parsedmarc.parse_aggregate_report_xml(xml, offline=True) self.assertTrue(report["report_metadata"]["timespan_requires_normalization"]) # Records should be split across days self.assertTrue(len(report["records"]) > 1) total = sum(r["count"] for r in report["records"]) self.assertEqual(total, 90) for r in report["records"]: self.assertTrue(r["normalized_timespan"]) # type: ignore[typeddict-item] def testExtractReportFromFilePathNotFound(self): """extract_report_from_file_path raises ParserError for missing file""" with self.assertRaises(parsedmarc.ParserError): parsedmarc.extract_report_from_file_path("nonexistent_file.xml") def testExtractReportInvalidArchive(self): """extract_report raises ParserError for unrecognized binary content""" with self.assertRaises(parsedmarc.ParserError): parsedmarc.extract_report(b"\x00\x01\x02\x03\x04\x05\x06\x07") def testParseAggregateReportFile(self): """parse_aggregate_report_file parses bytes input directly""" print() sample_path = "samples/aggregate/rfc9990-sample.xml" print("Testing {0}: ".format(sample_path), end="") with open(sample_path, "rb") as f: data = f.read() report = parsedmarc.parse_aggregate_report_file( data, offline=True, always_use_local_files=True, ) self.assertEqual(report["report_metadata"]["org_name"], "Sample Reporter") self.assertEqual(report["policy_published"]["domain"], "example.com") print("Passed!") def testParseInvalidAggregateSample(self): """Test invalid aggregate samples are handled""" print() sample_paths = glob("samples/aggregate_invalid/*") for sample_path in sample_paths: if os.path.isdir(sample_path): continue print("Testing {0}: ".format(sample_path), end="") with self.subTest(sample=sample_path): parsed_report = cast( AggregateReport, parsedmarc.parse_report_file( sample_path, always_use_local_files=True, offline=OFFLINE_MODE )["report"], ) parsedmarc.parsed_aggregate_reports_to_csv(parsed_report) print("Passed!") def testParseReportFileWithBytes(self): """parse_report_file handles bytes input""" with open("samples/aggregate/rfc9990-sample.xml", "rb") as f: data = f.read() result = parsedmarc.parse_report_file( data, always_use_local_files=True, offline=True ) self.assertEqual(result["report_type"], "aggregate") def testFailureReportCsvRoundtrip(self): """Failure report CSV generation works on sample reports""" print() sample_paths = glob("samples/failure/*.eml") for sample_path in sample_paths: print("Testing CSV for {0}: ".format(sample_path), end="") with self.subTest(sample=sample_path): parsed_report = cast( FailureReport, parsedmarc.parse_report_file(sample_path, offline=OFFLINE_MODE)[ "report" ], ) csv_output = parsedmarc.parsed_failure_reports_to_csv(parsed_report) self.assertIsNotNone(csv_output) self.assertIn(",", csv_output) rows = parsedmarc.parsed_failure_reports_to_csv_rows(parsed_report) self.assertTrue(len(rows) > 0) print("Passed!") class TestExtractReport(unittest.TestCase): """Tests for parsedmarc.extract_report()""" def testExtractReportFromBytes(self): """extract_report handles raw XML bytes""" xml = b'' result = parsedmarc.extract_report(xml) self.assertIn("", result) def testExtractReportFromBase64Xml(self): """extract_report handles base64-encoded XML string""" import base64 xml = b'' b64 = base64.b64encode(xml).decode() result = parsedmarc.extract_report(b64) self.assertIn("", result) def testExtractReportFromGzip(self): """extract_report handles gzip compressed content""" import gzip xml = b'' compressed = gzip.compress(xml) result = parsedmarc.extract_report(compressed) self.assertIn("", result) def testExtractReportFromZip(self): """extract_report handles zip compressed content""" import zipfile xml = b'' buf = BytesIO() with zipfile.ZipFile(buf, "w") as zf: zf.writestr("report.xml", xml) result = parsedmarc.extract_report(buf.getvalue()) self.assertIn("", result) def testExtractReportFromBinaryIO(self): """extract_report handles file-like BinaryIO objects""" xml = b'' bio = BytesIO(xml) result = parsedmarc.extract_report(bio) self.assertIn("", result) def testExtractReportFromNonSeekableStream(self): """extract_report handles non-seekable streams""" xml = b'' class NonSeekable: def __init__(self, data): self._data = data self._pos = 0 def read(self, n=-1): if n == -1: result = self._data[self._pos :] self._pos = len(self._data) else: result = self._data[self._pos : self._pos + n] self._pos += n return result def seekable(self): return False def close(self): pass result = parsedmarc.extract_report(cast(BinaryIO, NonSeekable(xml))) self.assertIn("", result) def testExtractReportInvalidContent(self): """extract_report raises ParserError for invalid content""" with self.assertRaises(parsedmarc.ParserError): parsedmarc.extract_report(b"this is not a valid archive") def testExtractReportTextModeRaises(self): """extract_report raises ParserError for text-mode streams""" class TextStream: def read(self, n=-1): return "text data" def seekable(self): return True def seek(self, pos): pass def close(self): pass with self.assertRaises(parsedmarc.ParserError): parsedmarc.extract_report(cast(BinaryIO, TextStream())) class TestMalformedXmlRecovery(unittest.TestCase): """Tests for XML recovery in parse_aggregate_report_xml""" def testRecoversMalformedXml(self): """Malformed XML triggers recovery path and still parses""" # XML with a broken tag that xmltodict will reject but lxml can recover malformed_xml = """ example.com dmarc@example.com 12345 16800000001680086400 example.com

none

 203.0.113.11 nonepasspass example.com example.compass """ # lxml recovery may succeed or fail depending on how broken the XML is # Either way, no unhandled exception should escape try: report = parsedmarc.parse_aggregate_report_xml(malformed_xml, offline=True) self.assertIn("report_metadata", report) except parsedmarc.InvalidAggregateReport: pass # Also acceptable def testBytesXmlInput(self): """XML bytes input is decoded""" xml = b""" example.com dmarc@example.com test-bytes-input 16800000001680086400 example.com

none

 203.0.113.11 nonepasspass example.com example.compass """ report = parsedmarc.parse_aggregate_report_xml(xml.decode(), offline=True) self.assertEqual(report["report_metadata"]["report_id"], "test-bytes-input") def testExpatErrorRaises(self): """Completely invalid XML raises InvalidAggregateReport""" with self.assertRaises(parsedmarc.InvalidAggregateReport): parsedmarc.parse_aggregate_report_xml("not xml at all {}", offline=True) def testMissingOrgName(self): """Missing org_name raises InvalidAggregateReport""" xml = """ dmarc@example.com missing-org 16800000001680086400 example.com

none

 1.2.3.41 nonepasspass example.com example.compass """ with self.assertRaises(parsedmarc.InvalidAggregateReport): parsedmarc.parse_aggregate_report_xml(xml, offline=True) class TestPolicyPublishedEdgeCases(unittest.TestCase): """Tests for edge cases in policy_published parsing""" VALID_XML_TEMPLATE = """ example.com dmarc@example.com test-{tag} 16800000001680086400 {extra_metadata} example.com

reject

{policy_extra} 203.0.113.11 nonepasspass example.com example.compass """ def _parse(self, tag="default", policy_extra="", extra_metadata=""): xml = self.VALID_XML_TEMPLATE.format( tag=tag, policy_extra=policy_extra, extra_metadata=extra_metadata ) return parsedmarc.parse_aggregate_report_xml(xml, offline=True) def testPolicyPublishedListHandled(self): """policy_published as a list uses first element""" # The code checks `if type(policy_published) is list` # This is tested implicitly when xmltodict returns a list; # we test via the np field presence report = self._parse(tag="np", policy_extra="quarantine") self.assertEqual(report["policy_published"]["np"], "quarantine") def testNpFieldValues(self): """np field is parsed correctly""" for val in ["none", "quarantine", "reject"]: report = self._parse(tag=f"np-{val}", policy_extra=f"{val}") self.assertEqual(report["policy_published"]["np"], val) def testTestingField(self): """testing field is parsed correctly""" for val in ["y", "n"]: report = self._parse( tag=f"testing-{val}", policy_extra=f"{val}" ) self.assertEqual(report["policy_published"]["testing"], val) def testDiscoveryMethodField(self): """discovery_method field is parsed correctly""" for val in ["psl", "treewalk"]: report = self._parse( tag=f"disc-{val}", policy_extra=f"{val}", ) self.assertEqual(report["policy_published"]["discovery_method"], val) def testGeneratorField(self): """generator field in report_metadata is parsed""" report = self._parse( tag="gen", extra_metadata="TestGen/1.0" ) self.assertEqual(report["report_metadata"]["generator"], "TestGen/1.0") def testPctFieldNone(self): """pct defaults to None when absent (removed in RFC 9989)""" report = self._parse(tag="no-pct") self.assertIsNone(report["policy_published"]["pct"]) def testFoFieldNone(self): """fo defaults to None when absent (RFC 9990 keeps it optional)""" report = self._parse(tag="no-fo") self.assertIsNone(report["policy_published"]["fo"]) def testReportMetadataErrors(self): """Report metadata errors are captured""" report = self._parse( tag="errors", extra_metadata="DNS timeout", ) self.assertIn("DNS timeout", report["report_metadata"]["errors"]) def testReportMetadataErrorsList(self): """Report metadata errors as list are captured""" report = self._parse( tag="errors-list", extra_metadata="error1error2", ) self.assertIn("error1", report["report_metadata"]["errors"]) self.assertIn("error2", report["report_metadata"]["errors"]) def testRecordParseFailureSkipped(self): """Bad records are skipped with a warning, not crashing""" xml = """ example.com dmarc@example.com bad-records 16800000001680086400 example.com

none

 203.0.113.11 nonepasspass example.com example.compass bad-ipnot-a-number nonepasspass example.com example.compass """ report = parsedmarc.parse_aggregate_report_xml(xml, offline=True) # At least the valid record should be parsed self.assertTrue(len(report["records"]) >= 1) class TestParseReportFile(unittest.TestCase): """Tests for parse_report_file with various input types""" def testParseReportFileFromBytes(self): """parse_report_file works with bytes input""" xml_path = "samples/aggregate/!example.com!1538204542!1538463818.xml" with open(xml_path, "rb") as f: content = f.read() result = parsedmarc.parse_report_file(content, offline=True) self.assertEqual(result["report_type"], "aggregate") def testParseReportFileFromBinaryIO(self): """parse_report_file works with BinaryIO input""" xml_path = "samples/aggregate/!example.com!1538204542!1538463818.xml" with open(xml_path, "rb") as f: result = parsedmarc.parse_report_file(f, offline=True) self.assertEqual(result["report_type"], "aggregate") def testParseReportFileFromPathlib(self): """parse_report_file works with pathlib.Path input""" xml_path = Path("samples/aggregate/!example.com!1538204542!1538463818.xml") result = parsedmarc.parse_report_file(xml_path, offline=True) self.assertEqual(result["report_type"], "aggregate") def testParseReportFileSmtpTls(self): """parse_report_file detects SMTP TLS reports""" result = parsedmarc.parse_report_file( "samples/smtp_tls/smtp_tls.json", offline=True ) self.assertEqual(result["report_type"], "smtp_tls") def testParseReportFileEmail(self): """parse_report_file detects failure reports in email format""" eml_path = "samples/failure/dmarc_ruf_report_linkedin.eml" result = parsedmarc.parse_report_file(eml_path, offline=True) self.assertEqual(result["report_type"], "failure") def testParseReportFileInvalid(self): """parse_report_file raises ParserError for invalid content""" with self.assertRaises(parsedmarc.ParserError): parsedmarc.parse_report_file(b"this is not a report", offline=True) class TestParseReportEmail(unittest.TestCase): """Tests for parse_report_email edge cases""" def testSmtpTlsEmailReport(self): """parse_report_email handles SMTP TLS reports in email format""" eml_path = "samples/smtp_tls/google.com_smtp_tls_report.eml" with open(eml_path, "rb") as f: content = f.read() result = parsedmarc.parse_report_email(content, offline=True) self.assertEqual(result["report_type"], "smtp_tls") def testInvalidEmailRaisesError(self): """parse_report_email raises error for non-DMARC email""" email_str = """From: test@example.com Subject: Hello World Content-Type: text/plain This is not a DMARC report.""" with self.assertRaises(parsedmarc.InvalidDMARCReport): parsedmarc.parse_report_email(email_str, offline=True) class TestFailureReportParsing(unittest.TestCase): """Tests for failure report field defaults and edge cases""" def _make_feedback_report(self, **overrides): """Create a minimal feedback report string""" fields = { "Feedback-Type": "auth-failure", "User-Agent": "test/1.0", "Version": "1", "Original-Mail-From": "sender@example.com", "Arrival-Date": "Thu, 1 Jan 2024 00:00:00 +0000", "Source-IP": "203.0.113.1", "Reported-Domain": "example.com", "Auth-Failure": "dmarc", } fields.update(overrides) return "\n".join(f"{k}: {v}" for k, v in fields.items()) def _make_sample(self): return """From: sender@example.com To: recipient@example.com Subject: Test Date: Thu, 1 Jan 2024 00:00:00 +0000 Test body""" def _default_msg_date(self): return datetime(2024, 1, 1, 0, 0, 0, tzinfo=timezone.utc) def testMissingVersion(self): """Missing version defaults to None""" report_str = self._make_feedback_report() lines = [ln for ln in report_str.split("\n") if not ln.startswith("Version:")] report_str = "\n".join(lines) report = parsedmarc.parse_failure_report( report_str, self._make_sample(), self._default_msg_date(), offline=True ) self.assertIsNone(report["version"]) def testMissingUserAgent(self): """Missing user_agent defaults to None""" report_str = self._make_feedback_report() lines = [ ln for ln in report_str.split("\n") if not ln.startswith("User-Agent:") ] report_str = "\n".join(lines) report = parsedmarc.parse_failure_report( report_str, self._make_sample(), self._default_msg_date(), offline=True ) self.assertIsNone(report["user_agent"]) def testMissingDeliveryResult(self): """Missing delivery_result maps to 'other' when field absent""" report_str = self._make_feedback_report() report = parsedmarc.parse_failure_report( report_str, self._make_sample(), self._default_msg_date(), offline=True ) # When delivery_result is not in the parsed report, it's set to None, # but then the validation check maps None (not in delivery_results list) to "other" self.assertEqual(report["delivery_result"], "other") def testDeliveryResultMapped(self): """Known delivery_result values are mapped correctly""" for val in ["delivered", "spam", "policy", "reject"]: report_str = self._make_feedback_report(**{"Delivery-Result": val}) report = parsedmarc.parse_failure_report( report_str, self._make_sample(), self._default_msg_date(), offline=True ) self.assertEqual(report["delivery_result"], val) def testDeliveryResultUnknownMapsToOther(self): """Unknown delivery_result maps to 'other'""" report_str = self._make_feedback_report(**{"Delivery-Result": "unknown-value"}) report = parsedmarc.parse_failure_report( report_str, self._make_sample(), self._default_msg_date(), offline=True ) self.assertEqual(report["delivery_result"], "other") def testIdentityAlignmentNone(self): """identity_alignment='none' results in empty auth mechanisms""" report_str = self._make_feedback_report(**{"Identity-Alignment": "none"}) report = parsedmarc.parse_failure_report( report_str, self._make_sample(), self._default_msg_date(), offline=True ) self.assertEqual(report["authentication_mechanisms"], []) def testIdentityAlignmentMultiple(self): """identity_alignment with multiple values is split""" report_str = self._make_feedback_report(**{"Identity-Alignment": "dkim,spf"}) report = parsedmarc.parse_failure_report( report_str, self._make_sample(), self._default_msg_date(), offline=True ) self.assertEqual(report["authentication_mechanisms"], ["dkim", "spf"]) def testIdentityAlignmentCFWSWhitespaceStripped(self): """RFC 9991 ABNF allows CFWS around the commas in Identity-Alignment. The previous parser left leading whitespace on the second token ('dkim, spf' -> ['dkim', ' spf']); CFWS-aware splitting yields ['dkim', 'spf'].""" report_str = self._make_feedback_report(**{"Identity-Alignment": "dkim, spf"}) report = parsedmarc.parse_failure_report( report_str, self._make_sample(), self._default_msg_date(), offline=True ) self.assertEqual(report["authentication_mechanisms"], ["dkim", "spf"]) def testAuthFailureCFWSWhitespaceStripped(self): """Auth-Failure (also comma-separated per RFC 9991) is whitespace- stripped per token.""" report_str = self._make_feedback_report(**{"Auth-Failure": "dmarc, spf"}) report = parsedmarc.parse_failure_report( report_str, self._make_sample(), self._default_msg_date(), offline=True ) self.assertEqual(report["auth_failure"], ["dmarc", "spf"]) def testMissingIdentityAlignmentWarns(self): """Identity-Alignment is REQUIRED per RFC 9991; the parser defaults silently for permissiveness but logs a warning so the broken reporter is visible.""" report_str = self._make_feedback_report() lines = [ ln for ln in report_str.split("\n") if not ln.startswith("Identity-Alignment:") ] report_str = "\n".join(lines) with self.assertLogs("parsedmarc.log", level="WARNING") as cm: report = parsedmarc.parse_failure_report( report_str, self._make_sample(), self._default_msg_date(), offline=True, ) self.assertEqual(report["authentication_mechanisms"], []) self.assertTrue( any("Identity-Alignment" in m and "RFC 9991" in m for m in cm.output), f"Expected Identity-Alignment RFC 9991 warning; got: {cm.output}", ) def testMissingAuthFailureWarns(self): """Auth-Failure is REQUIRED per RFC 9991; the parser defaults to 'dmarc' but logs a warning.""" report_str = self._make_feedback_report() lines = [ ln for ln in report_str.split("\n") if not ln.startswith("Auth-Failure:") ] report_str = "\n".join(lines) with self.assertLogs("parsedmarc.log", level="WARNING") as cm: report = parsedmarc.parse_failure_report( report_str, self._make_sample(), self._default_msg_date(), offline=True, ) self.assertEqual(report["auth_failure"], ["dmarc"]) self.assertTrue( any("Auth-Failure" in m and "RFC 9991" in m for m in cm.output), f"Expected Auth-Failure RFC 9991 warning; got: {cm.output}", ) def testMissingReportedDomainFallback(self): """Missing reported_domain falls back to sample from domain""" report_str = self._make_feedback_report() lines = [ ln for ln in report_str.split("\n") if not ln.startswith("Reported-Domain:") ] report_str = "\n".join(lines) report = parsedmarc.parse_failure_report( report_str, self._make_sample(), self._default_msg_date(), offline=True ) self.assertEqual(report["reported_domain"], "example.com") def testMissingArrivalDateWithMsgDate(self): """Missing arrival_date uses msg_date fallback""" report_str = self._make_feedback_report() lines = [ ln for ln in report_str.split("\n") if not ln.startswith("Arrival-Date:") ] report_str = "\n".join(lines) msg_date = datetime(2024, 6, 15, 12, 0, 0, tzinfo=timezone.utc) report = parsedmarc.parse_failure_report( report_str, self._make_sample(), msg_date, offline=True ) self.assertIn("2024-06-15", report["arrival_date"]) def testMissingArrivalDateNoMsgDateRaises(self): """Missing arrival_date with no msg_date raises""" report_str = self._make_feedback_report() lines = [ ln for ln in report_str.split("\n") if not ln.startswith("Arrival-Date:") ] report_str = "\n".join(lines) with self.assertRaises(parsedmarc.InvalidFailureReport): parsedmarc.parse_failure_report( report_str, self._make_sample(), cast(datetime, None), # intentionally None to test error path offline=True, ) class TestSmtpTlsReportErrors(unittest.TestCase): """Tests for SMTP TLS report error handling""" def testMissingRequiredField(self): """Missing required field raises InvalidSMTPTLSReport""" json_str = json.dumps({"policies": []}) with self.assertRaises(parsedmarc.InvalidSMTPTLSReport): parsedmarc.parse_smtp_tls_report_json(json_str) def testInvalidJson(self): """Invalid JSON raises InvalidSMTPTLSReport""" with self.assertRaises(parsedmarc.InvalidSMTPTLSReport): parsedmarc.parse_smtp_tls_report_json("not json {{{") class TestBucketIntervalEdgeCases(unittest.TestCase): """Tests for _bucket_interval_by_day edge cases""" def testDayCursorAdjustment(self): """When begin is before midnight due to tz, day_cursor adjusts back""" # Use a timezone where midnight calculation might cause day_cursor > begin import pytz tz = pytz.FixedOffset(-600) # UTC-10 begin = datetime(2024, 1, 1, 23, 30, 0, tzinfo=timezone.utc).astimezone(tz) end = datetime(2024, 1, 3, 0, 0, 0, tzinfo=timezone.utc).astimezone(tz) buckets = parsedmarc._bucket_interval_by_day(begin, end, 100) total = sum(b["count"] for b in buckets) self.assertEqual(total, 100) class TestGetDmarcReportsFromMbox(unittest.TestCase): """Tests for mbox parsing""" def testEmptyMbox(self): """Empty mbox returns empty results""" with NamedTemporaryFile(suffix=".mbox", delete=False) as f: f.write(b"") path = f.name try: results = parsedmarc.get_dmarc_reports_from_mbox(path, offline=True) self.assertEqual(results["aggregate_reports"], []) self.assertEqual(results["failure_reports"], []) self.assertEqual(results["smtp_tls_reports"], []) finally: os.remove(path) def testMboxWithAggregateReport(self): """Mbox with aggregate report email is parsed""" from email.mime.multipart import MIMEMultipart from email.mime.application import MIMEApplication import gzip xml = b""" example.com dmarc@example.com mbox-test-123 16800000001680086400 example.com

none

 203.0.113.11 nonepasspass example.com example.compass """ compressed = gzip.compress(xml) msg = MIMEMultipart() msg["From"] = "dmarc@example.com" msg["To"] = "postmaster@example.com" msg["Subject"] = "DMARC Aggregate Report" msg["Date"] = "Thu, 1 Jan 2024 00:00:00 +0000" att = MIMEApplication(compressed, "gzip") att.add_header("Content-Disposition", "attachment", filename="report.xml.gz") msg.attach(att) with NamedTemporaryFile(suffix=".mbox", delete=False, mode="w") as f: # mbox format requires "From " line f.write("From dmarc@example.com Thu Jan 1 00:00:00 2024\n") f.write(msg.as_string()) f.write("\n") path = f.name try: results = parsedmarc.get_dmarc_reports_from_mbox(path, offline=True) self.assertTrue(len(results["aggregate_reports"]) >= 1) finally: os.remove(path) class TestGetDmarcReportsFromMailboxValidation(unittest.TestCase): """Input validation on get_dmarc_reports_from_mailbox. These guards prevent two real footguns: the test/delete combo would otherwise delete every message after parsing — silently destructive — and a None connection would NPE deep in the iteration loop with a confusing traceback. Fail fast at the door instead.""" def test_delete_and_test_combination_raises(self): from unittest.mock import MagicMock with self.assertRaises(ValueError) as ctx: parsedmarc.get_dmarc_reports_from_mailbox( connection=MagicMock(), delete=True, test=True ) self.assertIn("mutually exclusive", str(ctx.exception)) def test_none_connection_raises(self): with self.assertRaises(ValueError) as ctx: parsedmarc.get_dmarc_reports_from_mailbox(connection=None) self.assertIn("connection", str(ctx.exception).lower()) class TestMigrateForensicArchiveFolderErrorHandling(unittest.TestCase): """The one migration scenario a real on-disk Maildir can't reproduce: a backend that raises mid-operation. _migrate_forensic_archive_folder must warn and continue (warn, don't crash) so a mailbox it cannot reorganize doesn't abort the whole run. The rename / merge / no-op behavior is covered for real (no mocks) in TestMigrateForensicArchiveFolderMaildir; only this failure path needs a mock, to force a folder operation to raise.""" def test_backend_error_is_warned_not_raised(self): conn = MagicMock() conn.folder_exists.side_effect = lambda name: name.endswith("/Forensic") conn.rename_folder.side_effect = RuntimeError("server said no") with self.assertLogs("parsedmarc.log", level="WARNING") as cm: parsedmarc._migrate_forensic_archive_folder(conn, "Archive") self.assertTrue( any("Could not migrate" in line for line in cm.output), cm.output, ) class TestMigrateForensicArchiveFolderMaildir(unittest.TestCase): """End-to-end migration against a real on-disk Maildir via mailsuite's MaildirConnection — no mocks. This exercises the actual mailsuite 2.1.0 folder API (folder_exists / rename_folder / merge_folders / delete_folder) and the on-disk result, so it would catch a real behavioral break that a mock-based test cannot (e.g. a signature mismatch, or messages left behind in the legacy folder).""" def setUp(self): self._tmp = mkdtemp() self.addCleanup(rmtree, self._tmp, ignore_errors=True) self.conn = MaildirConnection(self._tmp, maildir_create=True) # Parent must exist before nested subfolders, as get_dmarc_reports_- # from_mailbox creates it (create_folder(archive_folder)) first. self.conn.create_folder("Archive") def _seed(self, folder, subject): """Drop a real RFC 822 message into an on-disk Maildir subfolder.""" self.conn.create_folder(folder) box = mailbox.Maildir(os.path.join(self._tmp, "." + folder)) box.add( mailbox.MaildirMessage( "From: reporter@example.com\n" "To: dmarc@example.org\n" f"Subject: {subject}\n\nbody\n" ) ) box.flush() def test_rename_moves_legacy_folder_and_its_messages(self): """Only the legacy folder exists: it (and the message inside it) is renamed to Failure, leaving nothing behind in Forensic.""" self._seed("Archive/Forensic", "legacy failure report") self.assertTrue(self.conn.folder_exists("Archive/Forensic")) self.assertFalse(self.conn.folder_exists("Archive/Failure")) parsedmarc._migrate_forensic_archive_folder(self.conn, "Archive") self.assertFalse(self.conn.folder_exists("Archive/Forensic")) self.assertTrue(self.conn.folder_exists("Archive/Failure")) self.assertEqual(len(self.conn.fetch_messages("Archive/Failure")), 1) def test_merge_consolidates_messages_when_both_exist(self): """Both folders exist: the legacy folder's messages are merged into the existing Failure folder (which keeps its own), and the emptied legacy folder is deleted.""" self._seed("Archive/Failure", "post-rename failure report") self._seed("Archive/Forensic", "legacy failure report") parsedmarc._migrate_forensic_archive_folder(self.conn, "Archive") self.assertFalse(self.conn.folder_exists("Archive/Forensic")) self.assertTrue(self.conn.folder_exists("Archive/Failure")) self.assertEqual(len(self.conn.fetch_messages("Archive/Failure")), 2) def test_no_legacy_folder_is_noop(self): """No legacy folder (the common case): nothing is created or changed.""" parsedmarc._migrate_forensic_archive_folder(self.conn, "Archive") self.assertFalse(self.conn.folder_exists("Archive/Forensic")) self.assertFalse(self.conn.folder_exists("Archive/Failure")) def test_orchestration_migrates_before_creating_folders(self): """get_dmarc_reports_from_mailbox runs the migration *before* it creates folders: a seeded legacy Forensic folder ends up consolidated into the newly-created Failure subfolder (message and all), not split across the two. Driven through the real orchestration with an empty INBOX, so no parsing or network occurs.""" self._seed("Archive/Forensic", "legacy failure report") result = parsedmarc.get_dmarc_reports_from_mailbox(connection=self.conn) self.assertFalse(self.conn.folder_exists("Archive/Forensic")) self.assertTrue(self.conn.folder_exists("Archive/Failure")) self.assertEqual(len(self.conn.fetch_messages("Archive/Failure")), 1) self.assertEqual(result["failure_reports"], []) class TestEmailResultsErrorBranches(unittest.TestCase): """email_results requires mail_to to be a list — this is enforced by an assert. A regression that dropped the assert would mean the SMTP code further down would silently iterate over the characters of a string.""" def test_mail_to_must_be_list(self): with self.assertRaises(AssertionError): parsedmarc.email_results( { "aggregate_reports": [], "failure_reports": [], "smtp_tls_reports": [], }, host="smtp.example.com", mail_from="from@example.com", mail_to="admin@example.com", # str, not list — triggers assert ) class TestAppendJson(unittest.TestCase): """append_json writes new files cleanly and merges into existing JSON arrays without breaking valid JSON.""" def test_writes_new_file(self): with NamedTemporaryFile("w", suffix=".json", delete=False) as tf: path = tf.name os.remove(path) # ensure file is fresh try: parsedmarc.append_json(path, [{"a": 1}]) with open(path) as f: data = json.loads(f.read()) self.assertEqual(data, [{"a": 1}]) finally: if os.path.exists(path): os.remove(path) def test_appends_to_existing_file(self): with NamedTemporaryFile("w", suffix=".json", delete=False) as tf: path = tf.name try: parsedmarc.append_json(path, [{"a": 1}]) parsedmarc.append_json(path, [{"b": 2}]) with open(path) as f: data = json.loads(f.read()) self.assertEqual(data, [{"a": 1}, {"b": 2}]) finally: if os.path.exists(path): os.remove(path) def test_empty_list_on_existing_file_is_noop(self): with NamedTemporaryFile("w", suffix=".json", delete=False) as tf: path = tf.name try: parsedmarc.append_json(path, [{"a": 1}]) parsedmarc.append_json(path, []) with open(path) as f: data = json.loads(f.read()) self.assertEqual(data, [{"a": 1}]) finally: if os.path.exists(path): os.remove(path) def test_corrupt_existing_file_is_overwritten_cleanly(self): """If the existing JSON file is corrupt (e.g. truncated by a prior crash, or hit the pre-fix `append_json` bug), the read-merge-write path falls back to overwriting with the new content rather than silently failing to record. Recording at the cost of losing prior corrupt data is the lesser evil — those bytes are already unparseable, so no downstream consumer can read them anyway.""" with NamedTemporaryFile("w", suffix=".json", delete=False) as tf: tf.write("{ this is not valid json at all") path = tf.name try: parsedmarc.append_json(path, [{"new": "data"}]) with open(path) as f: data = json.loads(f.read()) self.assertEqual(data, [{"new": "data"}]) finally: if os.path.exists(path): os.remove(path) def test_existing_file_with_non_list_root_is_overwritten(self): """If the existing file parses cleanly but the root isn't a list (e.g. someone wrote {"foo": 1} by hand), the isinstance(loaded, list) guard kicks in and we overwrite rather than concatenating a dict and a list.""" with NamedTemporaryFile("w", suffix=".json", delete=False) as tf: tf.write('{"not": "a list"}') path = tf.name try: parsedmarc.append_json(path, [{"new": "data"}]) with open(path) as f: data = json.loads(f.read()) self.assertEqual(data, [{"new": "data"}]) finally: if os.path.exists(path): os.remove(path) class TestAppendCsv(unittest.TestCase): def test_writes_new_file_with_header(self): with NamedTemporaryFile("w", suffix=".csv", delete=False) as tf: path = tf.name os.remove(path) try: parsedmarc.append_csv(path, "h1,h2\nv1,v2\n") with open(path) as f: content = f.read() self.assertEqual(content, "h1,h2\nv1,v2\n") finally: if os.path.exists(path): os.remove(path) def test_appends_strips_header_on_existing_file(self): """Second append must not re-emit the header line.""" with NamedTemporaryFile("w", suffix=".csv", delete=False) as tf: path = tf.name try: parsedmarc.append_csv(path, "h1,h2\nv1,v2\n") parsedmarc.append_csv(path, "h1,h2\nv3,v4\n") with open(path) as f: content = f.read() # Only one header line in the merged output. self.assertEqual(content.count("h1,h2"), 1) self.assertIn("v3,v4", content) finally: if os.path.exists(path): os.remove(path) def test_append_empty_csv_on_existing_file_is_noop(self): """append_csv with just a header row (no data) should not rewrite the file when one already exists.""" with NamedTemporaryFile("w", suffix=".csv", delete=False) as tf: path = tf.name try: parsedmarc.append_csv(path, "h1,h2\nv1,v2\n") parsedmarc.append_csv(path, "h1,h2\n") with open(path) as f: content = f.read() # File unchanged. self.assertEqual(content, "h1,h2\nv1,v2\n") finally: if os.path.exists(path): os.remove(path) if __name__ == "__main__": unittest.main(verbosity=2)