Merge pull request #64 from beatz174-bit/codex/add-interactive-picker-for-terraform-outputs

Add interactive Terraform output picker for Dynu brownfield generator

infrastructure/terraform/dynu/README.md

@@ -71,6 +71,53 @@ The helper script writes these files under `generated/`:
 
 These are generated outputs meant for operator review before use in production.
 
+
+### Generator output selection (interactive + automation)
+
+The brownfield generator defaults to Terraform output `dynu_dns_records`:
+
+```bash
+python3 scripts/generate-brownfield-records.py --dry-run
+```
+
+If the default output is missing/unusable and stdin is interactive, the script shows a picker of available Terraform outputs and indicates which ones are usable for DNS imports.
+
+```bash
+# Interactive mode: choose from available Terraform outputs
+python3 scripts/generate-brownfield-records.py --dry-run
+
+# Non-interactive mode: specify output explicitly
+python3 scripts/generate-brownfield-records.py \
+  --records-output dynu_dns_inventory \
+  --dry-run
+
+# Disable menu and fail fast
+python3 scripts/generate-brownfield-records.py \
+  --no-interactive \
+  --dry-run
+
+# Use saved terraform output JSON and choose interactively
+terraform output -json > generated/terraform-output.json
+python3 scripts/generate-brownfield-records.py \
+  --from-file generated/terraform-output.json \
+  --dry-run
+```
+
+Notes:
+
+- The menu shows Terraform outputs currently stored in state.
+- If newly added outputs do not appear, run:
+
+```bash
+terraform apply -refresh-only
+```
+
+- The selected output must contain real Dynu provider record fields:
+  - `id`
+  - `domain_id`
+  - `hostname`
+  - `record_type`
+
 ## Troubleshooting
 
 ### Plan shows a large wall of `+` values under outputs

infrastructure/terraform/dynu/scripts/generate-brownfield-records.py

@@ -16,6 +16,8 @@ GENERATED_DIR = TF_ROOT / "generated"
 TF_FILE = GENERATED_DIR / "dynu_dns_records.generated.tf"
 IMPORT_SCRIPT = GENERATED_DIR / "import-dynu-dns-records.sh"
 INVENTORY_FILE = GENERATED_DIR / "dynu_dns_records_inventory.json"
+DEFAULT_RECORDS_OUTPUT = "dynu_dns_records"
+REQUIRED_RECORD_FIELDS = ("id", "domain_id", "hostname", "record_type")
 
 HEADER_TF = """# ---------------------------------------------------------------------------
 # GENERATED FILE - REVIEW BEFORE USE
@@ -57,6 +59,137 @@ def run_terraform_output() -> dict:
     return json.loads(proc.stdout)
 
 
+def type_shape_name(value: object) -> str:
+    if isinstance(value, list):
+        return "list"
+    if isinstance(value, dict):
+        return "object"
+    return type(value).__name__
+
+
+def extract_records(payload: object, output_name: str) -> list[dict]:
+    source = payload
+    if isinstance(payload, list):
+        source = payload
+    elif isinstance(payload, dict):
+        if isinstance(payload.get("value"), list):
+            source = payload["value"]
+        elif isinstance(payload.get("records"), list):
+            source = payload["records"]
+        elif isinstance(payload.get("value"), dict) and isinstance(payload["value"].get("records"), list):
+            source = payload["value"]["records"]
+        elif output_name in payload and isinstance(payload[output_name], dict):
+            output_wrapper = payload[output_name]
+            if isinstance(output_wrapper.get("value"), list):
+                source = output_wrapper["value"]
+            elif isinstance(output_wrapper.get("value"), dict) and isinstance(output_wrapper["value"].get("records"), list):
+                source = output_wrapper["value"]["records"]
+            elif isinstance(output_wrapper.get("records"), list):
+                source = output_wrapper["records"]
+            else:
+                raise RuntimeError(f"Output '{output_name}' does not contain a records list.")
+        else:
+            raise RuntimeError(f"Output '{output_name}' not found and no records list discovered.")
+    else:
+        raise RuntimeError(f"Unsupported JSON payload type: {type(payload).__name__}")
+
+    if not isinstance(source, list):
+        raise RuntimeError(f"Output '{output_name}' did not resolve to a list of records.")
+    return source
+
+
+def validate_records(records: list[dict], output_name: str) -> None:
+    for i, record in enumerate(records):
+        if not isinstance(record, dict):
+            raise RuntimeError(f"Selected output '{output_name}' has non-object record at index {i}: {type(record).__name__}.")
+        missing = [field for field in REQUIRED_RECORD_FIELDS if field not in record]
+        if missing:
+            missing_text = ", ".join(missing)
+            raise RuntimeError(
+                f"Selected output '{output_name}' contains records, but they are not importable Dynu provider records. "
+                f"Record #{i} is missing required fields: {missing_text}. "
+                "Choose an output sourced from data.dynu_dns_records.root, such as dynu_dns_records or dynu_dns_inventory."
+            )
+
+
+def describe_output(output_name: str, output_wrapper: object, full_outputs: dict) -> dict:
+    details = {
+        "name": output_name,
+        "usable": False,
+        "shape": type_shape_name(output_wrapper),
+        "record_count": "none",
+        "error": "no records list found",
+    }
+    if isinstance(output_wrapper, dict) and "value" in output_wrapper:
+        details["shape"] = type_shape_name(output_wrapper.get("value"))
+
+    try:
+        records = extract_records(full_outputs, output_name)
+    except RuntimeError as exc:
+        details["error"] = str(exc)
+        return details
+
+    details["record_count"] = len(records)
+    try:
+        validate_records(records, output_name)
+    except RuntimeError as exc:
+        details["error"] = str(exc)
+        if isinstance(output_wrapper, dict) and isinstance(output_wrapper.get("value"), dict) and isinstance(output_wrapper["value"].get("records"), list):
+            details["shape"] = "object with records list"
+        elif isinstance(output_wrapper, dict) and isinstance(output_wrapper.get("value"), list):
+            details["shape"] = "list"
+        return details
+
+    details["usable"] = True
+    details["error"] = None
+    if isinstance(output_wrapper, dict) and isinstance(output_wrapper.get("value"), dict) and isinstance(output_wrapper["value"].get("records"), list):
+        details["shape"] = "object with records list"
+    elif isinstance(output_wrapper, dict) and isinstance(output_wrapper.get("value"), list):
+        details["shape"] = "list"
+    return details
+
+
+def choose_output_interactively(outputs: dict, descriptions: list[dict]) -> str | None:
+    print("\nAvailable Terraform outputs:\n")
+    indexed = {str(i): item for i, item in enumerate(descriptions, 1)}
+    by_name = {item["name"]: item for item in descriptions}
+
+    for i, item in enumerate(descriptions, 1):
+        print(f"  {i}) {item['name']}")
+        print(f"     usable: {'yes' if item['usable'] else 'no'}")
+        print(f"     shape: {item['shape']}")
+        print(f"     record count: {item['record_count']}")
+        if item["error"]:
+            print(f"     reason: {item['error']}")
+        print()
+
+    attempts = 0
+    while attempts < 3:
+        attempts += 1
+        try:
+            selection = input(f"Choose an output to use for DNS records [1-{len(descriptions)}], or press Enter to cancel: ").strip()
+        except KeyboardInterrupt:
+            print("\nSelection cancelled.")
+            return None
+
+        if selection == "":
+            print("Selection cancelled.")
+            return None
+
+        candidate = indexed.get(selection) or by_name.get(selection)
+        if candidate is None:
+            print("Invalid selection. Enter a number from the list or an exact output name.")
+            continue
+
+        if not candidate["usable"]:
+            print(f"Output '{candidate['name']}' is not usable: {candidate['error']}")
+            continue
+
+        return candidate["name"]
+
+    raise RuntimeError("Too many invalid selections. Exiting without writing files.")
+
+
 def tf_name(record: dict) -> str:
     base = f"{record.get('hostname', '')}_{record.get('record_type', '')}_{record.get('id', '')}".lower()
     base = base.replace("*", "wildcard")
@@ -146,40 +279,59 @@ def main() -> int:
     parser.add_argument("--dry-run", action="store_true", help="Print intended output paths without writing files.")
     parser.add_argument("--overwrite", "--force", action="store_true", dest="overwrite", help="Overwrite existing generated files.")
     parser.add_argument("--from-file", type=Path, help="Load inventory JSON from a file instead of calling terraform output.")
+    parser.add_argument(
+        "--records-output",
+        default=None,
+        help=(
+            "Terraform output name containing Dynu DNS records. "
+            f"Defaults to {DEFAULT_RECORDS_OUTPUT}; if missing in an interactive terminal, "
+            "the script prompts you to choose from available outputs."
+        ),
+    )
+    parser.add_argument("--no-interactive", action="store_true", help="Disable interactive output selection.")
     args = parser.parse_args()
 
-    try:
+    records_output_explicit = args.records_output is not None
-        if args.from_file:
+    records_output = args.records_output or DEFAULT_RECORDS_OUTPUT
-            payload = json.loads(args.from_file.read_text(encoding="utf-8"))
-            if isinstance(payload, list):
-                records = payload
-            elif isinstance(payload, dict) and isinstance(payload.get("value"), list):
-                records = payload["value"]
-            elif isinstance(payload, dict) and isinstance(payload.get("dynu_dns_records", {}).get("value"), list):
-                records = payload["dynu_dns_records"]["value"]
-            else:
-                raise RuntimeError(
-                    "--from-file JSON must be one of: a raw list of records, "
-                    "a Terraform output wrapper with 'value' list, or full 'terraform output -json' "
-                    "with 'dynu_dns_records.value'."
-                )
-        else:
-            out = run_terraform_output()
-            if "dynu_dns_records" not in out:
-                available = ", ".join(sorted(out.keys())) or "(none)"
-                raise RuntimeError(
-                    "Missing Terraform output 'dynu_dns_records'. "
-                    f"Available outputs: {available}. "
-                    "Run 'terraform apply -refresh-only' after adding the "
-                    "data.dynu_dns_records.root data source and dynu_dns_records output."
-                )
-            records = out["dynu_dns_records"].get("value")
 
-        if not isinstance(records, list):
+    try:
+        payload = json.loads(args.from_file.read_text(encoding="utf-8")) if args.from_file else run_terraform_output()
+
+        selected_output = records_output
+        descriptions: list[dict] = []
+        if isinstance(payload, dict):
+            descriptions = [describe_output(name, payload[name], payload) for name in sorted(payload)]
+
+        try:
+            records = extract_records(payload, selected_output)
+            validate_records(records, selected_output)
+        except RuntimeError as exc:
+            is_interactive = sys.stdin.isatty() and not args.no_interactive
+            should_prompt = isinstance(payload, dict) and not records_output_explicit and is_interactive
+            if should_prompt:
+                print(f"Terraform output '{selected_output}' was not found or is unusable.\n")
+                chosen = choose_output_interactively(payload, descriptions)
+                if chosen is None:
+                    print("Exiting without writing files.")
+                    return 1
+                selected_output = chosen
+                records = extract_records(payload, selected_output)
+                validate_records(records, selected_output)
+            else:
+                if isinstance(payload, dict):
+                    available = ", ".join(sorted(payload.keys())) or "(none)"
+                    if records_output_explicit:
                         raise RuntimeError(
-                "Terraform output 'dynu_dns_records' did not return a list. "
+                            f"Missing or unusable Terraform output '{selected_output}'. "
-                f"Got: {type(records).__name__}"
+                            f"Available outputs: {available}. Details: {exc}"
                         )
+                    raise RuntimeError(
+                        f"Missing or unusable Terraform output '{selected_output}'. "
+                        f"Available outputs: {available}.\n\n"
+                        "Run interactively to choose an output, or pass one explicitly, for example:\n\n"
+                        "  python3 scripts/generate-brownfield-records.py --records-output dynu_dns_inventory --dry-run"
+                    )
+                raise
 
         GENERATED_DIR.mkdir(parents=True, exist_ok=True)
         write_file(INVENTORY_FILE, json.dumps(records, indent=2, sort_keys=True) + "\n", args.dry_run, args.overwrite)