fix: unblock interactive dns search

Author: MNametissa

o2switch_cli/cli/interactive.py

@@ -7,15 +7,14 @@
 from o2switch_cli.cli.context import AppContext
 from o2switch_cli.cli.helpers import run_guarded_interactive
 from o2switch_cli.cli.interactive_support import (
+    build_dns_search_suggestions,
     build_domain_suggestions,
-    build_hostname_suggestions,
     build_subdomain_suggestions,
     filter_domains,
-    filter_hostname_results,
     filter_subdomains,
 )
 from o2switch_cli.cli.ui import TerminalUI
-from o2switch_cli.core.models import DomainDescriptor, HostnameSearchResult, SubdomainDescriptor
+from o2switch_cli.core.models import DomainDescriptor, SubdomainDescriptor
 
 MIN_PAGE_SIZE = 6
 MAX_PAGE_SIZE = 12
@@ -24,7 +23,6 @@
 @dataclass(slots=True)
 class InteractiveDataCache:
     domains: list[DomainDescriptor] | None = None
-    dns_index: list[HostnameSearchResult] | None = None
     subdomains: list[SubdomainDescriptor] | None = None
 
     def get_domains(self, app_context: AppContext, ui: TerminalUI) -> list[DomainDescriptor]:
@@ -33,12 +31,6 @@ def get_domains(self, app_context: AppContext, ui: TerminalUI) -> list[DomainDes
                 self.domains = app_context.runtime().domains.list_domains()
         return self.domains
 
-    def get_dns_index(self, app_context: AppContext, ui: TerminalUI) -> list[HostnameSearchResult]:
-        if self.dns_index is None:
-            with ui.status("Scanning hosted subdomains and DNS zones", spinner="dots12"):
-                self.dns_index = app_context.runtime().dns.search("")
-        return self.dns_index
-
     def get_subdomains(self, app_context: AppContext, ui: TerminalUI) -> list[SubdomainDescriptor]:
         if self.subdomains is None:
             with ui.status("Syncing hosted subdomains", spinner="dots12"):
@@ -54,8 +46,6 @@ def invalidate(
     ) -> None:
         if domains:
             self.domains = None
-        if dns:
-            self.dns_index = None
         if subdomains:
             self.subdomains = None
 
@@ -113,16 +103,18 @@ def action(active_context: AppContext, selected_choice: str = choice) -> None:
                     render_page=lambda page_items, window: ui.print_domains(page_items, window),
                 )
             elif selected_choice == "DNS: search":
-                results = cache.get_dns_index(active_context, ui)
+                domains = cache.get_domains(active_context, ui)
+                subdomains = cache.get_subdomains(active_context, ui)
                 term = ui.prompt_realtime_search(
                     "Search hostnames, IPs, or zones",
-                    suggestions=build_hostname_suggestions(results),
-                    help_text="Realtime DNS and hosted matches update while you type",
+                    suggestions=build_dns_search_suggestions(domains, subdomains),
+                    help_text="Suggestions update while you type; Enter runs the live DNS search",
                 )
-                matches = filter_hostname_results(results, term)
-                if not matches and term.strip():
-                    with ui.status("Checking live hostname availability", spinner="earth"):
-                        matches = active_context.runtime().dns.search(term)
+                if not term.strip():
+                    ui.print_info("Enter a hostname, IP, or zone to run a DNS search.")
+                    return
+                with ui.status("Searching hosted subdomains and DNS zones", spinner="dots12"):
+                    matches = active_context.runtime().dns.search(term)
                 ui.browse_pages(
                     matches,
                     page_size=_page_size(ui),

o2switch_cli/cli/interactive_support.py

@@ -140,6 +140,46 @@ def build_hostname_suggestions(results: Sequence[HostnameSearchResult]) -> list[
     return suggestions
 
 
+def build_dns_search_suggestions(
+    domains: Sequence[DomainDescriptor],
+    subdomains: Sequence[SubdomainDescriptor],
+) -> list[SearchSuggestion]:
+    seen: set[tuple[str, str]] = set()
+    suggestions: list[SearchSuggestion] = []
+
+    for item in domains:
+        meta = f"domain · {item.type.value}"
+        key = (item.domain, meta)
+        if key in seen:
+            continue
+        seen.add(key)
+        suggestions.append(
+            SearchSuggestion(
+                value=item.domain,
+                label=item.domain,
+                meta=meta,
+                search_blob=_search_blob([item.domain, item.type.value, "domain"]),
+            )
+        )
+
+    for item in subdomains:
+        meta = f"hosted · {item.root_domain}"
+        key = (item.fqdn, meta)
+        if key in seen:
+            continue
+        seen.add(key)
+        suggestions.append(
+            SearchSuggestion(
+                value=item.fqdn,
+                label=item.fqdn,
+                meta=meta,
+                search_blob=_search_blob([item.fqdn, item.label, item.root_domain, item.docroot, "hosted"]),
+            )
+        )
+
+    return suggestions
+
+
 def build_subdomain_suggestions(subdomains: Sequence[SubdomainDescriptor]) -> list[SearchSuggestion]:
     return [
         SearchSuggestion(

tests/test_interactive.py

@@ -0,0 +1,140 @@
+from __future__ import annotations
+
+from contextlib import contextmanager
+
+from o2switch_cli.cli.context import AppContext
+from o2switch_cli.cli.interactive import run_interactive_menu
+from o2switch_cli.config.settings import AppSettings
+from o2switch_cli.core.models import (
+    DomainDescriptor,
+    DomainType,
+    HostnameSearchResult,
+    SearchCategory,
+    SubdomainDescriptor,
+)
+
+
+def _app_context() -> AppContext:
+    return AppContext(
+        settings=AppSettings(),
+        output_format="text",
+        dry_run=False,
+        force=False,
+        yes=False,
+        verbose=False,
+        verify_after_mutation=True,
+        allow_prompt=True,
+    )
+
+
+@contextmanager
+def _noop_status(*args, **kwargs):
+    yield None
+
+
+def test_interactive_dns_search_skips_backend_lookup_for_blank_term(monkeypatch) -> None:
+    class FakeDomains:
+        def list_domains(self) -> list[DomainDescriptor]:
+            return [DomainDescriptor(domain="ginutech.com", type=DomainType.ADDON)]
+
+    class FakeSubdomains:
+        def search(self, term: str) -> list[SubdomainDescriptor]:
+            assert term == ""
+            return [SubdomainDescriptor(fqdn="app.ginutech.com", label="app", root_domain="ginutech.com")]
+
+    class FakeDNS:
+        def search(self, term: str) -> list[HostnameSearchResult]:
+            raise AssertionError(f"dns.search should not run for blank interactive input, got {term!r}")
+
+    class FakeRuntime:
+        domains = FakeDomains()
+        subdomains = FakeSubdomains()
+        dns = FakeDNS()
+
+    answers = iter(["DNS: search", "Exit"])
+    messages: list[str] = []
+
+    class FakeSelect:
+        def ask(self):
+            return next(answers)
+
+    monkeypatch.setattr(AppContext, "runtime", lambda self: FakeRuntime())
+    monkeypatch.setattr(
+        "o2switch_cli.cli.interactive.questionary.select",
+        lambda *args, **kwargs: FakeSelect(),
+    )
+    monkeypatch.setattr("o2switch_cli.cli.interactive.TerminalUI.print_banner", lambda self: None)
+    monkeypatch.setattr(
+        "o2switch_cli.cli.interactive.TerminalUI.prompt_realtime_search",
+        lambda self, *args, **kwargs: "",
+    )
+    monkeypatch.setattr(
+        "o2switch_cli.cli.interactive.TerminalUI.print_info",
+        lambda self, message: messages.append(message),
+    )
+    monkeypatch.setattr("o2switch_cli.cli.interactive.TerminalUI.browse_pages", lambda self, *args, **kwargs: None)
+    monkeypatch.setattr("o2switch_cli.cli.interactive.TerminalUI.status", _noop_status)
+
+    run_interactive_menu(_app_context())
+
+    assert messages == ["Enter a hostname, IP, or zone to run a DNS search."]
+
+
+def test_interactive_dns_search_queries_submitted_term_only(monkeypatch) -> None:
+    class FakeDomains:
+        def list_domains(self) -> list[DomainDescriptor]:
+            return [DomainDescriptor(domain="ginutech.com", type=DomainType.ADDON)]
+
+    class FakeSubdomains:
+        def search(self, term: str) -> list[SubdomainDescriptor]:
+            assert term == ""
+            return [SubdomainDescriptor(fqdn="app.ginutech.com", label="app", root_domain="ginutech.com")]
+
+    calls: list[str] = []
+
+    class FakeDNS:
+        def search(self, term: str) -> list[HostnameSearchResult]:
+            calls.append(term)
+            return [
+                HostnameSearchResult(
+                    category=SearchCategory.DNS_RECORDS,
+                    hostname="name.ginutech.com",
+                    record_type="A",
+                    value="5.196.30.71",
+                    zone="ginutech.com",
+                )
+            ]
+
+    class FakeRuntime:
+        domains = FakeDomains()
+        subdomains = FakeSubdomains()
+        dns = FakeDNS()
+
+    answers = iter(["DNS: search", "Exit"])
+    browsed: list[list[HostnameSearchResult]] = []
+
+    class FakeSelect:
+        def ask(self):
+            return next(answers)
+
+    monkeypatch.setattr(AppContext, "runtime", lambda self: FakeRuntime())
+    monkeypatch.setattr(
+        "o2switch_cli.cli.interactive.questionary.select",
+        lambda *args, **kwargs: FakeSelect(),
+    )
+    monkeypatch.setattr("o2switch_cli.cli.interactive.TerminalUI.print_banner", lambda self: None)
+    monkeypatch.setattr(
+        "o2switch_cli.cli.interactive.TerminalUI.prompt_realtime_search",
+        lambda self, *args, **kwargs: "name.ginutech.com",
+    )
+    monkeypatch.setattr("o2switch_cli.cli.interactive.TerminalUI.print_info", lambda self, message: None)
+    monkeypatch.setattr(
+        "o2switch_cli.cli.interactive.TerminalUI.browse_pages",
+        lambda self, items, **kwargs: browsed.append(list(items)),
+    )
+    monkeypatch.setattr("o2switch_cli.cli.interactive.TerminalUI.status", _noop_status)
+
+    run_interactive_menu(_app_context())
+
+    assert calls == ["name.ginutech.com"]
+    assert [item.hostname for item in browsed[0]] == ["name.ginutech.com"]

tests/test_interactive_support.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from o2switch_cli.cli.interactive_support import (
+    build_dns_search_suggestions,
     build_hostname_suggestions,
     filter_domains,
     filter_hostname_results,
@@ -11,6 +12,7 @@
     DomainType,
     HostnameSearchResult,
     SearchCategory,
+    SubdomainDescriptor,
 )
 
 
@@ -73,3 +75,21 @@ def test_build_hostname_suggestions_deduplicates_repeat_rows() -> None:
     suggestions = build_hostname_suggestions(results)
     assert len(suggestions) == 1
     assert suggestions[0].value == "odoo.ginutech.com"
+
+
+def test_build_dns_search_suggestions_combines_domains_and_subdomains() -> None:
+    domains = [
+        DomainDescriptor(domain="ginutech.com", type=DomainType.ADDON),
+        DomainDescriptor(domain="ginutech.com", type=DomainType.ADDON),
+    ]
+    subdomains = [
+        SubdomainDescriptor(fqdn="app.ginutech.com", label="app", root_domain="ginutech.com"),
+        SubdomainDescriptor(fqdn="app.ginutech.com", label="app", root_domain="ginutech.com"),
+    ]
+
+    suggestions = build_dns_search_suggestions(domains, subdomains)
+
+    assert [(item.value, item.meta) for item in suggestions] == [
+        ("ginutech.com", "domain · addon"),
+        ("app.ginutech.com", "hosted · ginutech.com"),
+    ]