module.py 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965
  1. from __future__ import annotations
  2. import logging
  3. import sys
  4. from abc import ABC
  5. from pathlib import Path
  6. from typing import Any, Optional, List, Dict, Tuple
  7. from rich.console import Console
  8. from rich.panel import Panel
  9. from rich.prompt import Confirm
  10. from typer import Argument, Context, Option, Typer, Exit
  11. from .display import DisplayManager
  12. from .exceptions import (
  13. TemplateRenderError,
  14. TemplateSyntaxError,
  15. TemplateValidationError
  16. )
  17. from .library import LibraryManager
  18. from .prompt import PromptHandler
  19. from .template import Template
  20. logger = logging.getLogger(__name__)
  21. console = Console()
  22. console_err = Console(stderr=True)
  23. def parse_var_inputs(var_options: List[str], extra_args: List[str]) -> Dict[str, Any]:
  24. """Parse variable inputs from --var options and extra args.
  25. Supports formats:
  26. --var KEY=VALUE
  27. --var KEY VALUE
  28. Args:
  29. var_options: List of variable options from CLI
  30. extra_args: Additional arguments that may contain values
  31. Returns:
  32. Dictionary of parsed variables
  33. """
  34. variables = {}
  35. # Parse --var KEY=VALUE format
  36. for var_option in var_options:
  37. if '=' in var_option:
  38. key, value = var_option.split('=', 1)
  39. variables[key] = value
  40. else:
  41. # --var KEY VALUE format - value should be in extra_args
  42. if extra_args:
  43. variables[var_option] = extra_args.pop(0)
  44. else:
  45. logger.warning(f"No value provided for variable '{var_option}'")
  46. return variables
  47. class Module(ABC):
  48. """Streamlined base module that auto-detects variables from templates."""
  49. def __init__(self) -> None:
  50. if not all([self.name, self.description]):
  51. raise ValueError(
  52. f"Module {self.__class__.__name__} must define name and description"
  53. )
  54. logger.info(f"Initializing module '{self.name}'")
  55. logger.debug(f"Module '{self.name}' configuration: description='{self.description}'")
  56. self.libraries = LibraryManager()
  57. self.display = DisplayManager()
  58. def list(
  59. self,
  60. raw: bool = Option(False, "--raw", help="Output raw list format instead of rich table")
  61. ) -> list[Template]:
  62. """List all templates."""
  63. logger.debug(f"Listing templates for module '{self.name}'")
  64. templates = []
  65. entries = self.libraries.find(self.name, sort_results=True)
  66. for template_dir, library_name in entries:
  67. try:
  68. template = Template(template_dir, library_name=library_name)
  69. templates.append(template)
  70. except Exception as exc:
  71. logger.error(f"Failed to load template from {template_dir}: {exc}")
  72. continue
  73. filtered_templates = templates
  74. if filtered_templates:
  75. if raw:
  76. # Output raw format (tab-separated values for easy filtering with awk/sed/cut)
  77. # Format: ID\tNAME\tTAGS\tVERSION\tLIBRARY
  78. for template in filtered_templates:
  79. name = template.metadata.name or "Unnamed Template"
  80. tags_list = template.metadata.tags or []
  81. tags = ",".join(tags_list) if tags_list else "-"
  82. version = str(template.metadata.version) if template.metadata.version else "-"
  83. library = template.metadata.library or "-"
  84. print(f"{template.id}\t{name}\t{tags}\t{version}\t{library}")
  85. else:
  86. # Output rich table format
  87. self.display.display_templates_table(
  88. filtered_templates,
  89. self.name,
  90. f"{self.name.capitalize()} templates"
  91. )
  92. else:
  93. logger.info(f"No templates found for module '{self.name}'")
  94. return filtered_templates
  95. def search(
  96. self,
  97. query: str = Argument(..., help="Search string to filter templates by ID")
  98. ) -> list[Template]:
  99. """Search for templates by ID containing the search string."""
  100. logger.debug(f"Searching templates for module '{self.name}' with query='{query}'")
  101. templates = []
  102. entries = self.libraries.find(self.name, sort_results=True)
  103. for template_dir, library_name in entries:
  104. try:
  105. template = Template(template_dir, library_name=library_name)
  106. templates.append(template)
  107. except Exception as exc:
  108. logger.error(f"Failed to load template from {template_dir}: {exc}")
  109. continue
  110. # Apply search filtering
  111. filtered_templates = [t for t in templates if query.lower() in t.id.lower()]
  112. if filtered_templates:
  113. logger.info(f"Found {len(filtered_templates)} templates matching '{query}' for module '{self.name}'")
  114. self.display.display_templates_table(
  115. filtered_templates,
  116. self.name,
  117. f"{self.name.capitalize()} templates matching '{query}'"
  118. )
  119. else:
  120. logger.info(f"No templates found matching '{query}' for module '{self.name}'")
  121. self.display.display_warning(f"No templates found matching '{query}'", context=f"module '{self.name}'")
  122. return filtered_templates
  123. def show(
  124. self,
  125. id: str,
  126. ) -> None:
  127. """Show template details."""
  128. logger.debug(f"Showing template '{id}' from module '{self.name}'")
  129. template = self._load_template_by_id(id)
  130. if not template:
  131. self.display.display_error(f"Template '{id}' not found", context=f"module '{self.name}'")
  132. return
  133. # Apply config defaults (same as in generate)
  134. # This ensures the display shows the actual defaults that will be used
  135. if template.variables:
  136. from .config import ConfigManager
  137. config = ConfigManager()
  138. config_defaults = config.get_defaults(self.name)
  139. if config_defaults:
  140. logger.debug(f"Loading config defaults for module '{self.name}'")
  141. # Apply config defaults (this respects the variable types and validation)
  142. successful = template.variables.apply_defaults(config_defaults, "config")
  143. if successful:
  144. logger.debug(f"Applied config defaults for: {', '.join(successful)}")
  145. # Re-sort sections after applying config (toggle values may have changed)
  146. template.variables.sort_sections()
  147. self._display_template_details(template, id)
  148. def _apply_variable_defaults(self, template: Template) -> None:
  149. """Apply config defaults and CLI overrides to template variables.
  150. Args:
  151. template: Template instance with variables to configure
  152. """
  153. if not template.variables:
  154. return
  155. from .config import ConfigManager
  156. config = ConfigManager()
  157. config_defaults = config.get_defaults(self.name)
  158. if config_defaults:
  159. logger.info(f"Loading config defaults for module '{self.name}'")
  160. successful = template.variables.apply_defaults(config_defaults, "config")
  161. if successful:
  162. logger.debug(f"Applied config defaults for: {', '.join(successful)}")
  163. def _apply_cli_overrides(self, template: Template, var: Optional[List[str]], ctx: Context) -> None:
  164. """Apply CLI variable overrides to template.
  165. Args:
  166. template: Template instance to apply overrides to
  167. var: List of variable override strings from --var flags
  168. ctx: Typer context containing extra args
  169. """
  170. if not template.variables:
  171. return
  172. extra_args = list(ctx.args) if ctx and hasattr(ctx, "args") else []
  173. cli_overrides = parse_var_inputs(var or [], extra_args)
  174. if cli_overrides:
  175. logger.info(f"Received {len(cli_overrides)} variable overrides from CLI")
  176. successful_overrides = template.variables.apply_defaults(cli_overrides, "cli")
  177. if successful_overrides:
  178. logger.debug(f"Applied CLI overrides for: {', '.join(successful_overrides)}")
  179. def _collect_variable_values(self, template: Template, interactive: bool) -> Dict[str, Any]:
  180. """Collect variable values from user prompts and template defaults.
  181. Args:
  182. template: Template instance with variables
  183. interactive: Whether to prompt user for values interactively
  184. Returns:
  185. Dictionary of variable names to values
  186. """
  187. variable_values = {}
  188. # Collect values interactively if enabled
  189. if interactive and template.variables:
  190. prompt_handler = PromptHandler()
  191. collected_values = prompt_handler.collect_variables(template.variables)
  192. if collected_values:
  193. variable_values.update(collected_values)
  194. logger.info(f"Collected {len(collected_values)} variable values from user input")
  195. # Add satisfied variable values (respects dependencies and toggles)
  196. if template.variables:
  197. variable_values.update(template.variables.get_satisfied_values())
  198. return variable_values
  199. def _check_output_directory(self, output_dir: Path, rendered_files: Dict[str, str],
  200. interactive: bool) -> Optional[List[Path]]:
  201. """Check output directory for conflicts and get user confirmation if needed.
  202. Args:
  203. output_dir: Directory where files will be written
  204. rendered_files: Dictionary of file paths to rendered content
  205. interactive: Whether to prompt user for confirmation
  206. Returns:
  207. List of existing files that will be overwritten, or None to cancel
  208. """
  209. dir_exists = output_dir.exists()
  210. dir_not_empty = dir_exists and any(output_dir.iterdir())
  211. # Check which files already exist
  212. existing_files = []
  213. if dir_exists:
  214. for file_path in rendered_files.keys():
  215. full_path = output_dir / file_path
  216. if full_path.exists():
  217. existing_files.append(full_path)
  218. # Warn if directory is not empty
  219. if dir_not_empty:
  220. if interactive:
  221. details = []
  222. if existing_files:
  223. details.append(f"{len(existing_files)} file(s) will be overwritten.")
  224. if not self.display.display_warning_with_confirmation(
  225. f"Directory '{output_dir}' is not empty.",
  226. details if details else None,
  227. default=False
  228. ):
  229. self.display.display_info("Generation cancelled")
  230. return None
  231. else:
  232. # Non-interactive mode: show warning but continue
  233. logger.warning(f"Directory '{output_dir}' is not empty")
  234. if existing_files:
  235. logger.warning(f"{len(existing_files)} file(s) will be overwritten")
  236. return existing_files
  237. def _get_generation_confirmation(self, output_dir: Path, rendered_files: Dict[str, str],
  238. existing_files: Optional[List[Path]], dir_not_empty: bool,
  239. dry_run: bool, interactive: bool) -> bool:
  240. """Display file generation confirmation and get user approval.
  241. Args:
  242. output_dir: Output directory path
  243. rendered_files: Dictionary of file paths to content
  244. existing_files: List of existing files that will be overwritten
  245. dir_not_empty: Whether output directory already contains files
  246. dry_run: Whether this is a dry run
  247. interactive: Whether to prompt for confirmation
  248. Returns:
  249. True if user confirms generation, False to cancel
  250. """
  251. if not interactive:
  252. return True
  253. self.display.display_file_generation_confirmation(
  254. output_dir,
  255. rendered_files,
  256. existing_files if existing_files else None
  257. )
  258. # Final confirmation (only if we didn't already ask about overwriting)
  259. if not dir_not_empty and not dry_run:
  260. if not Confirm.ask("Generate these files?", default=True):
  261. self.display.display_info("Generation cancelled")
  262. return False
  263. return True
  264. def _execute_dry_run(self, id: str, output_dir: Path, rendered_files: Dict[str, str], show_files: bool) -> None:
  265. """Execute dry run mode with comprehensive simulation.
  266. Simulates all filesystem operations that would occur during actual generation,
  267. including directory creation, file writing, and permission checks.
  268. Args:
  269. id: Template ID
  270. output_dir: Directory where files would be written
  271. rendered_files: Dictionary of file paths to rendered content
  272. show_files: Whether to display file contents
  273. """
  274. import os
  275. console.print()
  276. console.print("[bold cyan]Dry Run Mode - Simulating File Generation[/bold cyan]")
  277. console.print()
  278. # Simulate directory creation
  279. self.display.display_heading("Directory Operations", icon_type="folder")
  280. # Check if output directory exists
  281. if output_dir.exists():
  282. self.display.display_success(f"Output directory exists: [cyan]{output_dir}[/cyan]")
  283. # Check if we have write permissions
  284. if os.access(output_dir, os.W_OK):
  285. self.display.display_success("Write permission verified")
  286. else:
  287. self.display.display_warning("Write permission may be denied")
  288. else:
  289. console.print(f" [dim]→[/dim] Would create output directory: [cyan]{output_dir}[/cyan]")
  290. # Check if parent directory exists and is writable
  291. parent = output_dir.parent
  292. if parent.exists() and os.access(parent, os.W_OK):
  293. self.display.display_success("Parent directory writable")
  294. else:
  295. self.display.display_warning("Parent directory may not be writable")
  296. # Collect unique subdirectories that would be created
  297. subdirs = set()
  298. for file_path in rendered_files.keys():
  299. parts = Path(file_path).parts
  300. for i in range(1, len(parts)):
  301. subdirs.add(Path(*parts[:i]))
  302. if subdirs:
  303. console.print(f" [dim]→[/dim] Would create {len(subdirs)} subdirectory(ies)")
  304. for subdir in sorted(subdirs):
  305. console.print(f" [dim]📁[/dim] {subdir}/")
  306. console.print()
  307. # Display file operations in a table
  308. self.display.display_heading("File Operations", icon_type="file")
  309. total_size = 0
  310. new_files = 0
  311. overwrite_files = 0
  312. file_operations = []
  313. for file_path, content in sorted(rendered_files.items()):
  314. full_path = output_dir / file_path
  315. file_size = len(content.encode('utf-8'))
  316. total_size += file_size
  317. # Determine status
  318. if full_path.exists():
  319. status = "Overwrite"
  320. overwrite_files += 1
  321. else:
  322. status = "Create"
  323. new_files += 1
  324. file_operations.append((file_path, file_size, status))
  325. self.display.display_file_operation_table(file_operations)
  326. console.print()
  327. # Summary statistics
  328. if total_size < 1024:
  329. size_str = f"{total_size}B"
  330. elif total_size < 1024 * 1024:
  331. size_str = f"{total_size / 1024:.1f}KB"
  332. else:
  333. size_str = f"{total_size / (1024 * 1024):.1f}MB"
  334. summary_items = {
  335. "Total files:": str(len(rendered_files)),
  336. "New files:": str(new_files),
  337. "Files to overwrite:": str(overwrite_files),
  338. "Total size:": size_str
  339. }
  340. self.display.display_summary_table("Summary", summary_items)
  341. console.print()
  342. # Show file contents if requested
  343. if show_files:
  344. console.print("[bold cyan]Generated File Contents:[/bold cyan]")
  345. console.print()
  346. for file_path, content in sorted(rendered_files.items()):
  347. console.print(f"[cyan]File:[/cyan] {file_path}")
  348. print(f"{'─'*80}")
  349. print(content)
  350. print() # Add blank line after content
  351. console.print()
  352. self.display.display_success("Dry run complete - no files were written")
  353. console.print(f"[dim]Files would have been generated in '{output_dir}'[/dim]")
  354. logger.info(f"Dry run completed for template '{id}' - {len(rendered_files)} files, {total_size} bytes")
  355. def _write_generated_files(self, output_dir: Path, rendered_files: Dict[str, str], quiet: bool = False) -> None:
  356. """Write rendered files to the output directory.
  357. Args:
  358. output_dir: Directory to write files to
  359. rendered_files: Dictionary of file paths to rendered content
  360. quiet: Suppress output messages
  361. """
  362. output_dir.mkdir(parents=True, exist_ok=True)
  363. for file_path, content in rendered_files.items():
  364. full_path = output_dir / file_path
  365. full_path.parent.mkdir(parents=True, exist_ok=True)
  366. with open(full_path, 'w', encoding='utf-8') as f:
  367. f.write(content)
  368. if not quiet:
  369. console.print(f"[green]Generated file: {file_path}[/green]") # Keep simple per-file output
  370. if not quiet:
  371. self.display.display_success(f"Template generated successfully in '{output_dir}'")
  372. logger.info(f"Template written to directory: {output_dir}")
  373. def generate(
  374. self,
  375. id: str = Argument(..., help="Template ID"),
  376. directory: Optional[str] = Argument(None, help="Output directory (defaults to template ID)"),
  377. interactive: bool = Option(True, "--interactive/--no-interactive", "-i/-n", help="Enable interactive prompting for variables"),
  378. var: Optional[list[str]] = Option(None, "--var", "-v", help="Variable override (repeatable). Supports: KEY=VALUE or KEY VALUE"),
  379. dry_run: bool = Option(False, "--dry-run", help="Preview template generation without writing files"),
  380. show_files: bool = Option(False, "--show-files", help="Display generated file contents in plain text (use with --dry-run)"),
  381. quiet: bool = Option(False, "--quiet", "-q", help="Suppress all non-error output"),
  382. ctx: Context = None,
  383. ) -> None:
  384. """Generate from template.
  385. Variable precedence chain (lowest to highest):
  386. 1. Module spec (defined in cli/modules/*.py)
  387. 2. Template spec (from template.yaml)
  388. 3. Config defaults (from ~/.config/boilerplates/config.yaml)
  389. 4. CLI overrides (--var flags)
  390. Examples:
  391. # Generate to directory named after template
  392. cli compose generate traefik
  393. # Generate to custom directory
  394. cli compose generate traefik my-proxy
  395. # Generate with variables
  396. cli compose generate traefik --var traefik_enabled=false
  397. # Preview without writing files (dry run)
  398. cli compose generate traefik --dry-run
  399. # Preview and show generated file contents
  400. cli compose generate traefik --dry-run --show-files
  401. """
  402. logger.info(f"Starting generation for template '{id}' from module '{self.name}'")
  403. # Create a display manager with quiet mode if needed
  404. display = DisplayManager(quiet=quiet) if quiet else self.display
  405. template = self._load_template_by_id(id)
  406. # Apply defaults and overrides
  407. self._apply_variable_defaults(template)
  408. self._apply_cli_overrides(template, var, ctx)
  409. # Re-sort sections after all overrides (toggle values may have changed)
  410. if template.variables:
  411. template.variables.sort_sections()
  412. if not quiet:
  413. self._display_template_details(template, id)
  414. console.print()
  415. # Collect variable values
  416. variable_values = self._collect_variable_values(template, interactive)
  417. try:
  418. # Validate and render template
  419. if template.variables:
  420. template.variables.validate_all()
  421. # Check if we're in debug mode (logger level is DEBUG)
  422. debug_mode = logger.isEnabledFor(logging.DEBUG)
  423. rendered_files, variable_values = template.render(template.variables, debug=debug_mode)
  424. if not rendered_files:
  425. display.display_error("Template rendering returned no files", context="template generation")
  426. raise Exit(code=1)
  427. logger.info(f"Successfully rendered template '{id}'")
  428. # Determine output directory
  429. output_dir = Path(directory) if directory else Path(id)
  430. # Check for conflicts and get confirmation (skip in quiet mode)
  431. if not quiet:
  432. existing_files = self._check_output_directory(output_dir, rendered_files, interactive)
  433. if existing_files is None:
  434. return # User cancelled
  435. # Get final confirmation for generation
  436. dir_not_empty = output_dir.exists() and any(output_dir.iterdir())
  437. if not self._get_generation_confirmation(output_dir, rendered_files, existing_files,
  438. dir_not_empty, dry_run, interactive):
  439. return # User cancelled
  440. else:
  441. # In quiet mode, just check for existing files without prompts
  442. existing_files = []
  443. # Execute generation (dry run or actual)
  444. if dry_run:
  445. if not quiet:
  446. self._execute_dry_run(id, output_dir, rendered_files, show_files)
  447. else:
  448. self._write_generated_files(output_dir, rendered_files, quiet=quiet)
  449. # Display next steps (not in quiet mode)
  450. if template.metadata.next_steps and not quiet:
  451. display.display_next_steps(template.metadata.next_steps, variable_values)
  452. except TemplateRenderError as e:
  453. # Display enhanced error information for template rendering errors (always show errors)
  454. display.display_template_render_error(e, context=f"template '{id}'")
  455. raise Exit(code=1)
  456. except Exception as e:
  457. display.display_error(str(e), context=f"generating template '{id}'")
  458. raise Exit(code=1)
  459. def config_get(
  460. self,
  461. var_name: Optional[str] = Argument(None, help="Variable name to get (omit to show all defaults)"),
  462. ) -> None:
  463. """Get default value(s) for this module.
  464. Examples:
  465. # Get all defaults for module
  466. cli compose defaults get
  467. # Get specific variable default
  468. cli compose defaults get service_name
  469. """
  470. from .config import ConfigManager
  471. config = ConfigManager()
  472. if var_name:
  473. # Get specific variable default
  474. value = config.get_default_value(self.name, var_name)
  475. if value is not None:
  476. console.print(f"[green]{var_name}[/green] = [yellow]{value}[/yellow]")
  477. else:
  478. self.display.display_warning(f"No default set for variable '{var_name}'", context=f"module '{self.name}'")
  479. else:
  480. # Show all defaults (flat list)
  481. defaults = config.get_defaults(self.name)
  482. if defaults:
  483. console.print(f"[bold]Config defaults for module '{self.name}':[/bold]\n")
  484. for var_name, var_value in defaults.items():
  485. console.print(f" [green]{var_name}[/green] = [yellow]{var_value}[/yellow]")
  486. else:
  487. console.print(f"[yellow]No defaults configured for module '{self.name}'[/yellow]")
  488. def config_set(
  489. self,
  490. var_name: str = Argument(..., help="Variable name or var=value format"),
  491. value: Optional[str] = Argument(None, help="Default value (not needed if using var=value format)"),
  492. ) -> None:
  493. """Set a default value for a variable.
  494. This only sets the DEFAULT VALUE, not the variable spec.
  495. The variable must be defined in the module or template spec.
  496. Supports both formats:
  497. - var_name value
  498. - var_name=value
  499. Examples:
  500. # Set default value (format 1)
  501. cli compose defaults set service_name my-awesome-app
  502. # Set default value (format 2)
  503. cli compose defaults set service_name=my-awesome-app
  504. # Set author for all compose templates
  505. cli compose defaults set author "Christian Lempa"
  506. """
  507. from .config import ConfigManager
  508. config = ConfigManager()
  509. # Parse var_name and value - support both "var value" and "var=value" formats
  510. if '=' in var_name and value is None:
  511. # Format: var_name=value
  512. parts = var_name.split('=', 1)
  513. actual_var_name = parts[0]
  514. actual_value = parts[1]
  515. elif value is not None:
  516. # Format: var_name value
  517. actual_var_name = var_name
  518. actual_value = value
  519. else:
  520. self.display.display_error(f"Missing value for variable '{var_name}'", context="config set")
  521. console.print(f"[dim]Usage: defaults set VAR_NAME VALUE or defaults set VAR_NAME=VALUE[/dim]")
  522. raise Exit(code=1)
  523. # Set the default value
  524. config.set_default_value(self.name, actual_var_name, actual_value)
  525. self.display.display_success(f"Set default: [cyan]{actual_var_name}[/cyan] = [yellow]{actual_value}[/yellow]")
  526. console.print(f"\n[dim]This will be used as the default value when generating templates with this module.[/dim]")
  527. def config_remove(
  528. self,
  529. var_name: str = Argument(..., help="Variable name to remove"),
  530. ) -> None:
  531. """Remove a specific default variable value.
  532. Examples:
  533. # Remove a default value
  534. cli compose defaults rm service_name
  535. """
  536. from .config import ConfigManager
  537. config = ConfigManager()
  538. defaults = config.get_defaults(self.name)
  539. if not defaults:
  540. console.print(f"[yellow]No defaults configured for module '{self.name}'[/yellow]")
  541. return
  542. if var_name in defaults:
  543. del defaults[var_name]
  544. config.set_defaults(self.name, defaults)
  545. self.display.display_success(f"Removed default for '{var_name}'")
  546. else:
  547. self.display.display_error(f"No default found for variable '{var_name}'")
  548. def config_clear(
  549. self,
  550. var_name: Optional[str] = Argument(None, help="Variable name to clear (omit to clear all defaults)"),
  551. force: bool = Option(False, "--force", "-f", help="Skip confirmation prompt"),
  552. ) -> None:
  553. """Clear default value(s) for this module.
  554. Examples:
  555. # Clear specific variable default
  556. cli compose defaults clear service_name
  557. # Clear all defaults for module
  558. cli compose defaults clear --force
  559. """
  560. from .config import ConfigManager
  561. config = ConfigManager()
  562. defaults = config.get_defaults(self.name)
  563. if not defaults:
  564. console.print(f"[yellow]No defaults configured for module '{self.name}'[/yellow]")
  565. return
  566. if var_name:
  567. # Clear specific variable
  568. if var_name in defaults:
  569. del defaults[var_name]
  570. config.set_defaults(self.name, defaults)
  571. self.display.display_success(f"Cleared default for '{var_name}'")
  572. else:
  573. self.display.display_error(f"No default found for variable '{var_name}'")
  574. else:
  575. # Clear all defaults
  576. if not force:
  577. detail_lines = [f"This will clear ALL defaults for module '{self.name}':", ""]
  578. for var_name, var_value in defaults.items():
  579. detail_lines.append(f" [green]{var_name}[/green] = [yellow]{var_value}[/yellow]")
  580. self.display.display_warning("Warning: This will clear ALL defaults")
  581. console.print()
  582. for line in detail_lines:
  583. console.print(line)
  584. console.print()
  585. if not Confirm.ask(f"[bold red]Are you sure?[/bold red]", default=False):
  586. console.print("[green]Operation cancelled.[/green]")
  587. return
  588. config.clear_defaults(self.name)
  589. self.display.display_success(f"Cleared all defaults for module '{self.name}'")
  590. def config_list(self) -> None:
  591. """Display the defaults for this specific module in YAML format.
  592. Examples:
  593. # Show the defaults for the current module
  594. cli compose defaults list
  595. """
  596. from .config import ConfigManager
  597. import yaml
  598. config = ConfigManager()
  599. # Get only the defaults for this module
  600. defaults = config.get_defaults(self.name)
  601. if not defaults:
  602. console.print(f"[yellow]No configuration found for module '{self.name}'[/yellow]")
  603. console.print(f"\n[dim]Config file location: {config.get_config_path()}[/dim]")
  604. return
  605. # Create a minimal config structure with only this module's defaults
  606. module_config = {
  607. "defaults": {
  608. self.name: defaults
  609. }
  610. }
  611. # Convert config to YAML string
  612. yaml_output = yaml.dump(module_config, default_flow_style=False, sort_keys=False)
  613. console.print(f"[bold]Configuration for module:[/bold] [cyan]{self.name}[/cyan]")
  614. console.print(f"[dim]Config file: {config.get_config_path()}[/dim]\n")
  615. console.print(Panel(yaml_output, title=f"{self.name.capitalize()} Config", border_style="blue"))
  616. def validate(
  617. self,
  618. template_id: str = Argument(None, help="Template ID to validate (if omitted, validates all templates)"),
  619. path: Optional[str] = Option(None, "--path", "-p", help="Validate a template from a specific directory path"),
  620. verbose: bool = Option(False, "--verbose", "-v", help="Show detailed validation information"),
  621. semantic: bool = Option(True, "--semantic/--no-semantic", help="Enable semantic validation (Docker Compose schema, etc.)")
  622. ) -> None:
  623. """Validate templates for Jinja2 syntax, undefined variables, and semantic correctness.
  624. Validation includes:
  625. - Jinja2 syntax checking
  626. - Variable definition checking
  627. - Semantic validation (when --semantic is enabled):
  628. - Docker Compose file structure
  629. - YAML syntax
  630. - Configuration best practices
  631. Examples:
  632. # Validate all templates in this module
  633. cli compose validate
  634. # Validate a specific template
  635. cli compose validate gitlab
  636. # Validate a template from a specific path
  637. cli compose validate --path /path/to/template
  638. # Validate with verbose output
  639. cli compose validate --verbose
  640. # Skip semantic validation (only Jinja2)
  641. cli compose validate --no-semantic
  642. """
  643. from rich.table import Table
  644. from .validators import get_validator_registry
  645. # Validate from path takes precedence
  646. if path:
  647. try:
  648. template_path = Path(path).resolve()
  649. if not template_path.exists():
  650. self.display.display_error(f"Path does not exist: {path}")
  651. raise Exit(code=1)
  652. if not template_path.is_dir():
  653. self.display.display_error(f"Path is not a directory: {path}")
  654. raise Exit(code=1)
  655. console.print(f"[bold]Validating template from path:[/bold] [cyan]{template_path}[/cyan]\n")
  656. template = Template(template_path, library_name="local")
  657. template_id = template.id
  658. except Exception as e:
  659. self.display.display_error(f"Failed to load template from path '{path}': {e}")
  660. raise Exit(code=1)
  661. elif template_id:
  662. # Validate a specific template by ID
  663. try:
  664. template = self._load_template_by_id(template_id)
  665. console.print(f"[bold]Validating template:[/bold] [cyan]{template_id}[/cyan]\n")
  666. except Exception as e:
  667. self.display.display_error(f"Failed to load template '{template_id}': {e}")
  668. raise Exit(code=1)
  669. else:
  670. # Validate all templates - handled separately below
  671. template = None
  672. # Single template validation
  673. if template:
  674. try:
  675. # Trigger validation by accessing used_variables
  676. _ = template.used_variables
  677. # Trigger variable definition validation by accessing variables
  678. _ = template.variables
  679. self.display.display_success("Jinja2 validation passed")
  680. # Semantic validation
  681. if semantic:
  682. console.print(f"\n[bold cyan]Running semantic validation...[/bold cyan]")
  683. registry = get_validator_registry()
  684. has_semantic_errors = False
  685. # Render template with default values for validation
  686. debug_mode = logger.isEnabledFor(logging.DEBUG)
  687. rendered_files, _ = template.render(template.variables, debug=debug_mode)
  688. for file_path, content in rendered_files.items():
  689. result = registry.validate_file(content, file_path)
  690. if result.errors or result.warnings or (verbose and result.info):
  691. console.print(f"\n[cyan]File:[/cyan] {file_path}")
  692. result.display(f"{file_path}")
  693. if result.errors:
  694. has_semantic_errors = True
  695. if not has_semantic_errors:
  696. self.display.display_success("Semantic validation passed")
  697. else:
  698. self.display.display_error("Semantic validation found errors")
  699. raise Exit(code=1)
  700. if verbose:
  701. console.print(f"\n[dim]Template path: {template.template_dir}[/dim]")
  702. console.print(f"[dim]Found {len(template.used_variables)} variables[/dim]")
  703. if semantic:
  704. console.print(f"[dim]Generated {len(rendered_files)} files[/dim]")
  705. except TemplateRenderError as e:
  706. # Display enhanced error information for template rendering errors
  707. self.display.display_template_render_error(e, context=f"template '{template_id}'")
  708. raise Exit(code=1)
  709. except (TemplateSyntaxError, TemplateValidationError, ValueError) as e:
  710. self.display.display_error(f"Validation failed for '{template_id}':")
  711. console.print(f"\n{e}")
  712. raise Exit(code=1)
  713. except Exception as e:
  714. self.display.display_error(f"Unexpected error validating '{template_id}': {e}")
  715. raise Exit(code=1)
  716. return
  717. else:
  718. # Validate all templates
  719. console.print(f"[bold]Validating all {self.name} templates...[/bold]\n")
  720. entries = self.libraries.find(self.name, sort_results=True)
  721. total = len(entries)
  722. valid_count = 0
  723. invalid_count = 0
  724. errors = []
  725. for template_dir, library_name in entries:
  726. template_id = template_dir.name
  727. try:
  728. template = Template(template_dir, library_name=library_name)
  729. # Trigger validation
  730. _ = template.used_variables
  731. _ = template.variables
  732. valid_count += 1
  733. if verbose:
  734. self.display.display_success(template_id)
  735. except ValueError as e:
  736. invalid_count += 1
  737. errors.append((template_id, str(e)))
  738. if verbose:
  739. self.display.display_error(template_id)
  740. except Exception as e:
  741. invalid_count += 1
  742. errors.append((template_id, f"Load error: {e}"))
  743. if verbose:
  744. self.display.display_warning(template_id)
  745. # Summary
  746. summary_items = {
  747. "Total templates:": str(total),
  748. "[green]Valid:[/green]": str(valid_count),
  749. "[red]Invalid:[/red]": str(invalid_count)
  750. }
  751. self.display.display_summary_table("Validation Summary", summary_items)
  752. # Show errors if any
  753. if errors:
  754. console.print(f"\n[bold red]Validation Errors:[/bold red]")
  755. for template_id, error_msg in errors:
  756. console.print(f"\n[yellow]Template:[/yellow] [cyan]{template_id}[/cyan]")
  757. console.print(f"[dim]{error_msg}[/dim]")
  758. raise Exit(code=1)
  759. else:
  760. self.display.display_success("All templates are valid!")
  761. @classmethod
  762. def register_cli(cls, app: Typer) -> None:
  763. """Register module commands with the main app."""
  764. logger.debug(f"Registering CLI commands for module '{cls.name}'")
  765. module_instance = cls()
  766. module_app = Typer(help=cls.description)
  767. module_app.command("list")(module_instance.list)
  768. module_app.command("search")(module_instance.search)
  769. module_app.command("show")(module_instance.show)
  770. module_app.command("validate")(module_instance.validate)
  771. module_app.command(
  772. "generate",
  773. context_settings={"allow_extra_args": True, "ignore_unknown_options": True}
  774. )(module_instance.generate)
  775. # Add defaults commands (simplified - only manage default values)
  776. defaults_app = Typer(help="Manage default values for template variables")
  777. defaults_app.command("get", help="Get default value(s)")(module_instance.config_get)
  778. defaults_app.command("set", help="Set a default value")(module_instance.config_set)
  779. defaults_app.command("rm", help="Remove a specific default value")(module_instance.config_remove)
  780. defaults_app.command("clear", help="Clear default value(s)")(module_instance.config_clear)
  781. defaults_app.command("list", help="Display the config for this module in YAML format")(module_instance.config_list)
  782. module_app.add_typer(defaults_app, name="defaults")
  783. app.add_typer(module_app, name=cls.name, help=cls.description)
  784. logger.info(f"Module '{cls.name}' CLI commands registered")
  785. def _load_template_by_id(self, id: str) -> Template:
  786. result = self.libraries.find_by_id(self.name, id)
  787. if not result:
  788. raise FileNotFoundError(f"Template '{id}' not found in module '{self.name}'")
  789. template_dir, library_name = result
  790. try:
  791. return Template(template_dir, library_name=library_name)
  792. except Exception as exc:
  793. logger.error(f"Failed to load template '{id}': {exc}")
  794. raise FileNotFoundError(f"Template '{id}' could not be loaded: {exc}") from exc
  795. def _display_template_details(self, template: Template, id: str) -> None:
  796. """Display template information panel and variables table."""
  797. self.display.display_template_details(template, id)