module.py 35 KB

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