module.py 38 KB

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