mirror of
				https://github.com/kevinveenbirkenbach/computer-playbook.git
				synced 2025-10-31 10:19:09 +00:00 
			
		
		
		
	refactor(dns): replace sys-dns-parent-hosts with sys-dns-wildcards; emit only *.parent wildcards from CURRENT_PLAY_DOMAINS_ALL
Rename filter parent_build_records→wildcard_records; create only wildcard (*.parent) A/AAAA records (no base/apex); switch to CURRENT_PLAY_DOMAINS_ALL; update vars to SYN_DNS_WILDCARD_RECORDS; adjust role/task names, defaults, and docs; add unittest expecting *.a.b from www.a.b.example.com. See: https://chatgpt.com/share/68c35dc1-7170-800f-8fbe-772e61780597
This commit is contained in:
		
							
								
								
									
										0
									
								
								tests/unit/roles/sys-dns-wildcards/__init__.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										0
									
								
								tests/unit/roles/sys-dns-wildcards/__init__.py
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,211 @@ | ||||
| # tests/unit/roles/sys-dns-wildcards/filter_plugins/test_wildcard_dns.py | ||||
| import unittest | ||||
| import importlib.util | ||||
| from pathlib import Path | ||||
|  | ||||
|  | ||||
| def _load_module(): | ||||
|     """ | ||||
|     Load the wildcard_dns filter plugin from: | ||||
|       roles/sys-dns-wildcards/filter_plugins/wildcard_dns.py | ||||
|     """ | ||||
|     here = Path(__file__).resolve() | ||||
|     # Go up to repository root (…/tests/unit/roles/… → 5 levels up) | ||||
|     repo_root = here.parents[5] if len(here.parents) >= 6 else here.parents[0] | ||||
|  | ||||
|     path = repo_root / "roles" / "sys-dns-wildcards" / "filter_plugins" / "wildcard_dns.py" | ||||
|     if not path.exists(): | ||||
|         raise FileNotFoundError(f"Could not find {path}") | ||||
|  | ||||
|     spec = importlib.util.spec_from_file_location("wildcard_dns", path) | ||||
|     mod = importlib.util.module_from_spec(spec) | ||||
|     assert spec and spec.loader | ||||
|     spec.loader.exec_module(mod)  # type: ignore[attr-defined] | ||||
|     return mod | ||||
|  | ||||
|  | ||||
| _wildcard_dns = _load_module() | ||||
|  | ||||
|  | ||||
| def _get_filter(): | ||||
|     """Return the wildcard_records filter function from the plugin.""" | ||||
|     fm = _wildcard_dns.FilterModule() | ||||
|     filters = fm.filters() | ||||
|     if "wildcard_records" not in filters: | ||||
|         raise AssertionError("wildcard_records filter not found") | ||||
|     return filters["wildcard_records"] | ||||
|  | ||||
|  | ||||
| def _as_set(records): | ||||
|     """Normalize records for order-independent comparison.""" | ||||
|     return { | ||||
|         (r.get("type"), r.get("name"), r.get("content"), bool(r.get("proxied"))) | ||||
|         for r in records | ||||
|     } | ||||
|  | ||||
|  | ||||
| class TestWildcardDNS(unittest.TestCase): | ||||
|     def setUp(self): | ||||
|         self.wildcard_records = _get_filter() | ||||
|  | ||||
|     def test_only_wildcards_no_apex_or_base(self): | ||||
|         apex = "example.com" | ||||
|         cpda = { | ||||
|             "svc-a": ["c.wiki.example.com", "a.b.example.com"], | ||||
|             "svc-b": {"extra": ["www.a.b.example.com"]}, | ||||
|             "svc-c": "example.com", | ||||
|         } | ||||
|  | ||||
|         recs = self.wildcard_records( | ||||
|             current_play_domains_all=cpda, | ||||
|             apex=apex, | ||||
|             ip4="203.0.113.10", | ||||
|             ip6="2606:4700:4700::1111", | ||||
|             proxied=True, | ||||
|             explicit_domains=None, | ||||
|             min_child_depth=2, | ||||
|             ipv6_enabled=True, | ||||
|         ) | ||||
|  | ||||
|         got = _as_set(recs) | ||||
|         expected = { | ||||
|             ("A", "*.wiki", "203.0.113.10", True), | ||||
|             ("AAAA", "*.wiki", "2606:4700:4700::1111", True), | ||||
|             ("A", "*.b", "203.0.113.10", True), | ||||
|             ("AAAA", "*.b", "2606:4700:4700::1111", True), | ||||
|             # now included because www.a.b.example.com promotes a.b.example.com as a parent | ||||
|             ("A", "*.a.b", "203.0.113.10", True), | ||||
|             ("AAAA", "*.a.b", "2606:4700:4700::1111", True), | ||||
|         } | ||||
|         self.assertEqual(got, expected) | ||||
|  | ||||
|     def test_min_child_depth_prevents_apex_wildcard(self): | ||||
|         apex = "example.com" | ||||
|         cpda = {"svc": ["x.example.com"]}  # depth = 1 | ||||
|  | ||||
|         recs = self.wildcard_records( | ||||
|             current_play_domains_all=cpda, | ||||
|             apex=apex, | ||||
|             ip4="198.51.100.42", | ||||
|             ip6="2606:4700:4700::1111", | ||||
|             proxied=False, | ||||
|             explicit_domains=None, | ||||
|             min_child_depth=2,  # requires >= 2 → no parent derived | ||||
|             ipv6_enabled=True, | ||||
|         ) | ||||
|         self.assertEqual(recs, []) | ||||
|  | ||||
|     def test_ipv6_disabled_and_private_ipv6_filtered(self): | ||||
|         apex = "example.com" | ||||
|         cpda = {"svc": ["a.b.example.com"]} | ||||
|  | ||||
|         # IPv6 disabled → only A record | ||||
|         recs1 = self.wildcard_records( | ||||
|             current_play_domains_all=cpda, | ||||
|             apex=apex, | ||||
|             ip4="203.0.113.9", | ||||
|             ip6="2606:4700:4700::1111", | ||||
|             proxied=False, | ||||
|             explicit_domains=None, | ||||
|             min_child_depth=2, | ||||
|             ipv6_enabled=False, | ||||
|         ) | ||||
|         self.assertEqual(_as_set(recs1), {("A", "*.b", "203.0.113.9", False)}) | ||||
|  | ||||
|         # IPv6 enabled but ULA (not global) → skip AAAA | ||||
|         recs2 = self.wildcard_records( | ||||
|             current_play_domains_all=cpda, | ||||
|             apex=apex, | ||||
|             ip4="203.0.113.9", | ||||
|             ip6="fd00::1", | ||||
|             proxied=False, | ||||
|             explicit_domains=None, | ||||
|             min_child_depth=2, | ||||
|             ipv6_enabled=True, | ||||
|         ) | ||||
|         self.assertEqual(_as_set(recs2), {("A", "*.b", "203.0.113.9", False)}) | ||||
|  | ||||
|     def test_proxied_flag_true_is_set(self): | ||||
|         recs = self.wildcard_records( | ||||
|             current_play_domains_all={"svc": ["a.b.example.com"]}, | ||||
|             apex="example.com", | ||||
|             ip4="203.0.113.7", | ||||
|             ip6=None, | ||||
|             proxied=True, | ||||
|             explicit_domains=None, | ||||
|             min_child_depth=2, | ||||
|             ipv6_enabled=True, | ||||
|         ) | ||||
|         self.assertTrue(all(r.get("proxied") is True for r in recs)) | ||||
|         self.assertEqual(_as_set(recs), {("A", "*.b", "203.0.113.7", True)}) | ||||
|  | ||||
|     def test_explicit_domains_override_source(self): | ||||
|         cpda = {"svc": ["ignore.me.example.com", "a.b.example.com"]} | ||||
|         explicit = ["c.wiki.example.com"] | ||||
|  | ||||
|         recs = self.wildcard_records( | ||||
|             current_play_domains_all=cpda, | ||||
|             apex="example.com", | ||||
|             ip4="203.0.113.5", | ||||
|             ip6="2606:4700:4700::1111", | ||||
|             proxied=False, | ||||
|             explicit_domains=explicit, | ||||
|             min_child_depth=2, | ||||
|             ipv6_enabled=True, | ||||
|         ) | ||||
|         self.assertEqual( | ||||
|             _as_set(recs), | ||||
|             { | ||||
|                 ("A", "*.wiki", "203.0.113.5", False), | ||||
|                 ("AAAA", "*.wiki", "2606:4700:4700::1111", False), | ||||
|             }, | ||||
|         ) | ||||
|  | ||||
|     def test_nested_structures_flattened_correctly(self): | ||||
|         cpda = { | ||||
|             "svc1": { | ||||
|                 "primary": ["c.wiki.example.com"], | ||||
|                 "extra": {"alt": ["a.b.example.com"]}, | ||||
|             }, | ||||
|             "svc2": "www.a.b.example.com", | ||||
|             "svc3": ["x.example.net"],  # wrong apex → ignored | ||||
|         } | ||||
|  | ||||
|         recs = self.wildcard_records( | ||||
|             current_play_domains_all=cpda, | ||||
|             apex="example.com", | ||||
|             ip4="203.0.113.21", | ||||
|             ip6="2606:4700:4700::1111", | ||||
|             proxied=False, | ||||
|             explicit_domains=None, | ||||
|             min_child_depth=2, | ||||
|             ipv6_enabled=True, | ||||
|         ) | ||||
|         got = _as_set(recs) | ||||
|         expected = { | ||||
|             ("A", "*.wiki", "203.0.113.21", False), | ||||
|             ("AAAA", "*.wiki", "2606:4700:4700::1111", False), | ||||
|             ("A", "*.b", "203.0.113.21", False), | ||||
|             ("AAAA", "*.b", "2606:4700:4700::1111", False), | ||||
|             # now included because www.a.b.example.com promotes a.b.example.com as a parent | ||||
|             ("A", "*.a.b", "203.0.113.21", False), | ||||
|             ("AAAA", "*.a.b", "2606:4700:4700::1111", False), | ||||
|         } | ||||
|         self.assertEqual(got, expected) | ||||
|  | ||||
|     def test_error_on_missing_ip4(self): | ||||
|         with self.assertRaises(Exception): | ||||
|             self.wildcard_records( | ||||
|                 current_play_domains_all={"svc": ["a.b.example.com"]}, | ||||
|                 apex="example.com", | ||||
|                 ip4="",  # must not be empty | ||||
|                 ip6=None, | ||||
|                 proxied=False, | ||||
|                 explicit_domains=None, | ||||
|                 min_child_depth=2, | ||||
|                 ipv6_enabled=True, | ||||
|             ) | ||||
|  | ||||
|  | ||||
| if __name__ == "__main__": | ||||
|     unittest.main() | ||||
		Reference in New Issue
	
	Block a user