Merge pull request #54 from Roming22/feat/verbose-integration

feat(integration): add verbose flag to NewIntegration command

Author: otaviof

docs/architecture.md

@@ -60,7 +60,7 @@ graph LR
 | `internal/chartfs/` | Filesystem abstraction for charts | No | `ChartFS`, `OverlayFS`, `BufferedFiles` |
 | `internal/installer/` | Orchestrates chart installation and MCP Jobs | No | `Installer`, `Job` |
 | `internal/k8s/` | Kubernetes client utilities | No | `Interface`, `Kube` |
-| `internal/flags/` | Global CLI flag definitions | No | `Flags` (Debug, DryRun, KubeConfigPath, LogLevel, Timeout) |
+| `internal/flags/` | Global CLI flag definitions | No | `Flags` (DryRun, KubeConfigPath, LogLevel, Timeout, Verbose) |
 | `internal/subcmd/` | Standard CLI subcommand implementations | No | deploy, config, topology, integration, mcp-server, template, installer |
 | `internal/mcptools/` | MCP tool definitions for AI assistants | No | `Interface`, `MCPToolsBuilder` |
 | `internal/annotations/` | Helm chart annotation constants | No | `helmet.redhat-appstudio.github.com/*` |

docs/cli-reference.md

@@ -26,11 +26,11 @@ These flags are available for every command:
 
 | Flag | Type | Default | Description |
 |------|------|---------|-------------|
-| `--debug` | bool | `false` | Enable debug mode (verbose logging) |
 | `--dry-run` | bool | `false` | Enable dry-run mode (no cluster mutations) |
 | `--kube-config` | string | `$KUBECONFIG` or `~/.kube/config` | Path to kubeconfig file |
 | `--log-level` | string | `warn` | Log verbosity level (`debug`, `info`, `warn`, `error`) |
 | `--timeout` | duration | `15m` | Helm client timeout duration |
+| `--verbose` / `-v` | bool | `false` | Verbose output |
 | `--version` | bool | `false` | Show application version and commit ID |
 
 Flags use Cobra's persistent flag mechanism, inheriting from the root command to all subcommands.
@@ -110,8 +110,8 @@ helmet-ex deploy
 # Deploy single chart
 helmet-ex deploy charts/helmet-product-a
 
-# Dry-run with debug output
-helmet-ex deploy --dry-run --debug
+# Dry-run with verbose output
+helmet-ex deploy --dry-run --verbose
 
 # Use custom values template
 helmet-ex deploy --values-template /path/to/values.yaml.tpl
@@ -235,8 +235,8 @@ helmet-ex template --show-values=false charts/helmet-product-a
 # Show both values and manifests
 helmet-ex template charts/helmet-product-a
 
-# Debug mode shows raw values before template rendering
-helmet-ex template --debug charts/helmet-product-a
+# Verbose mode shows raw values before template rendering
+helmet-ex template --verbose charts/helmet-product-a
 ```
 
 ### `installer`

docs/mcp.md

@@ -75,7 +75,7 @@ When `deploy` is invoked, the MCP server — authenticated via the user's kubeco
 2. **`ClusterRoleBinding`** named `{appName}`, binding the `ServiceAccount` to the `cluster-admin` `ClusterRole` (via server-side apply)
 3. **`Job`** named `{appName}-deploy-job` (via `Create` — only one Job is allowed; use `force: true` to replace an existing one) with:
    - Container image: the consumer's installer application image (from `WithMCPImage()` or `--image`)
-   - Args: `["deploy"]` (with optional `--debug`, `--dry-run`)
+   - Args: `["deploy"]` (with optional `--verbose`, `--dry-run`)
    - Env: `KUBECONFIG=""` (forces [in-cluster authentication](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#service-account-tokens))
    - RestartPolicy: `Never`, BackoffLimit: `0`
    - Labels: `type=installer-job.helmet.redhat-appstudio.github.com`
@@ -171,7 +171,7 @@ All tools are prefixed with `<app-name>_` (e.g., `helmet-ex_config_get`).
 
 | Tool | Arguments | Description |
 |------|-----------|-------------|
-| `deploy` | `dry_run` (bool, default true), `force` (bool), `debug` (bool) | Creates deployment Job |
+| `deploy` | `dry-run` (bool, default true), `force` (bool), `verbose` (bool) | Creates deployment Job |
 | `status` | None | Reports current phase and suggested next action |
 
 ### Topology and Notes

framework/app.go

@@ -85,7 +85,7 @@ func (a *App) setupRootCmd() error {
 
 	// Register standard subcommands.
 	a.rootCmd.AddCommand(subcmd.NewIntegration(
-		a.AppCtx, runCtx, a.integrationManager,
+		a.AppCtx, runCtx, a.integrationManager, a.flags,
 	))
 
 	// Use default builder if none provided.

internal/deployer/helm.go

@@ -44,15 +44,15 @@ var ErrUpgradeFailed = errors.New("upgrade failed")
 
 // printRelease prints the Helm release information.
 func (h *Helm) printRelease(rel *release.Release) {
-	// In debug mode, print the configuration values using key-value pairs.
-	if !h.flags.DryRun && h.flags.Debug {
+	// In verbose mode, print the configuration values using key-value pairs.
+	if !h.flags.DryRun && h.flags.Verbose {
 		printer.ValuesPrinter("Config", rel.Config)
 	}
 	printer.HelmReleasePrinter(rel)
-	// Print extended release information only in dry-run or debug mode. This
+	// Print extended release information only in dry-run or verbose mode. This
 	// allows rendering chart templates (dry-run) while inspecting the release
 	// manifests.
-	if h.flags.DryRun || h.flags.Debug {
+	if h.flags.DryRun || h.flags.Verbose {
 		printer.HelmExtendedReleasePrinter(rel)
 	}
 	printer.HelmReleaseNotesPrinter(rel)

internal/flags/flags.go

@@ -15,8 +15,8 @@ import (
 
 // Flags represents the global flags for the application.
 type Flags struct {
-	Debug          bool          // debug mode
 	DryRun         bool          // dry-run mode
+	Verbose        bool          // verbose output
 	KubeConfigPath string        // path to the kubeconfig file
 	LogLevel       *slog.Level   // log verbosity level
 	Timeout        time.Duration // helm client timeout
@@ -25,9 +25,15 @@ type Flags struct {
 
 // PersistentFlags sets up the global flags.
 func (f *Flags) PersistentFlags(p *pflag.FlagSet) {
-	p.BoolVar(&f.Debug, "debug", f.Debug, "enable debug mode")
 	p.BoolVar(&f.DryRun, "dry-run", f.DryRun, "enable dry-run mode")
 	p.BoolVar(&f.Version, "version", f.Version, "show the application version")
+	p.BoolVarP(
+		&f.Verbose,
+		"verbose",
+		"v",
+		f.Verbose,
+		"Enable verbose output",
+	)
 	p.StringVar(
 		&f.KubeConfigPath,
 		"kube-config",
@@ -60,7 +66,7 @@ func (f *Flags) GetLogger(out io.Writer) *slog.Logger {
 
 // LoggerWith returns a logger with contextual information.
 func (f *Flags) LoggerWith(l *slog.Logger) *slog.Logger {
-	return l.With("debug", f.Debug, "dry-run", f.DryRun, "timeout", f.Timeout)
+	return l.With("dry-run", f.DryRun, "timeout", f.Timeout, "verbose", f.Verbose)
 }
 
 // ShowVersion shows the application version.
@@ -83,11 +89,11 @@ func NewFlags() *Flags {
 		kubeConfigPath = path.Join(usr.HomeDir, ".kube", "config")
 	}
 	return &Flags{
-		Debug:          false,
 		DryRun:         false,
 		KubeConfigPath: kubeConfigPath,
 		LogLevel:       &defaultLogLevel,
 		Timeout:        15 * time.Minute,
+		Verbose:        false,
 		Version:        false,
 	}
 }

internal/flags/flags_test.go

@@ -0,0 +1,24 @@
+package flags
+
+import (
+	"testing"
+
+	"github.com/spf13/pflag"
+)
+
+func TestPersistentFlags_VerboseRegistered(t *testing.T) {
+	f := NewFlags()
+	fs := pflag.NewFlagSet("test", pflag.ContinueOnError)
+	f.PersistentFlags(fs)
+
+	flag := fs.Lookup("verbose")
+	if flag == nil {
+		t.Fatal(`expected persistent flag "verbose"`)
+	}
+	if flag.Shorthand != "v" {
+		t.Errorf("shorthand: got %q, want %q", flag.Shorthand, "v")
+	}
+	if flag.DefValue != "false" {
+		t.Errorf("DefValue: got %q, want %q", flag.DefValue, "false")
+	}
+}

internal/installer/job.go

@@ -191,7 +191,7 @@ func (j *Job) applyClusterRoleBinding(
 // in-cluster.
 func (j *Job) createJob(
 	ctx context.Context,
-	debug, dryRun bool,
+	verbose, dryRun bool,
 	namespace, image string,
 ) error {
 	bc, err := j.kube.BatchV1ClientSet("")
@@ -201,8 +201,8 @@ func (j *Job) createJob(
 
 	// Setting up the list of arguments for the deployment job.
 	args := []string{"deploy"}
-	if debug {
-		args = append(args, "--debug")
+	if verbose {
+		args = append(args, "--verbose")
 		args = append(args, "--log-level=debug")
 	}
 	if dryRun {
@@ -273,7 +273,7 @@ func (j *Job) GetJobLogFollowCmd(namespace string) string {
 // creates the job.
 func (j *Job) Run(
 	ctx context.Context,
-	debug, dryRun, force bool,
+	verbose, dryRun, force bool,
 	namespace, image string,
 ) error {
 	state, err := j.GetState(ctx)
@@ -301,7 +301,7 @@ func (j *Job) Run(
 		return fmt.Errorf("unable to apply the cluster role binding: %w", err)
 	}
 	// Creating the job itself.
-	return j.createJob(ctx, debug, dryRun, namespace, image)
+	return j.createJob(ctx, verbose, dryRun, namespace, image)
 }
 
 // NewJob instantiates a new Job object.

internal/mcptools/deploytools.go

@@ -29,8 +29,8 @@ const (
 	// deploySuffix deploy tool name suffix.
 	deploySuffix = "_deploy"
 
-	// DebugArg enables debug mode for the deployment job.
-	DebugArg = "debug"
+	// VerboseArg enables verbose mode for the deployment job.
+	VerboseArg = "verbose"
 	// DryRunArg runs the deployment job on dry-run.
 	DryRunArg = "dry-run"
 	// ForceArg forces the recreation of the deployment job.
@@ -61,10 +61,10 @@ place. Inspect the error message below to assess the issue.`,
 	}
 
 	// Deployment job flags.
-	var debug, dryRun, force bool
+	var verbose, dryRun, force bool
 
-	if v, ok := ctr.GetArguments()[DebugArg].(bool); ok {
-		debug = v
+	if v, ok := ctr.GetArguments()[VerboseArg].(bool); ok {
+		verbose = v
 	}
 	if v, ok := ctr.GetArguments()[DryRunArg].(bool); ok {
 		dryRun = v
@@ -77,7 +77,7 @@ place. Inspect the error message below to assess the issue.`,
 	logsCmd := d.job.GetJobLogFollowCmd(cfg.Namespace())
 
 	// Issue the deployment job using the informed flags.
-	err = d.job.Run(ctx, debug, dryRun, force, cfg.Namespace(), d.image)
+	err = d.job.Run(ctx, verbose, dryRun, force, cfg.Namespace(), d.image)
 	if err != nil {
 		return mcp.NewToolResultError(fmt.Sprintf(`
 Unable to issue the deployment Job, it returned the following error:
@@ -101,14 +101,14 @@ deployment status; this can take a few minutes depending on cluster performance.
 Use the tool periodically to verify that the deployment is proceeding as expected.
 
 Informed flags:
-	- debug: %v
+	- verbose: %v
 	- dry-run: %v
 	- force: %v
 
 You can follow the Kubernetes Job logs by running:
 
 	%s`,
-		d.appName+statusSuffix, debug, dryRun, force, logsCmd,
+		d.appName+statusSuffix, verbose, dryRun, force, logsCmd,
 	)), nil
 }
 
@@ -143,9 +143,9 @@ Job and create a new one regardless of its state.`,
 				mcp.DefaultBool(false),
 			),
 			mcp.WithBoolean(
-				DebugArg,
+				VerboseArg,
 				mcp.Description(`
-Sets the debug mode for the deployment job. This will enable verbose logging and
+Sets verbose mode for the deployment job. This enables debug logging and
 additional platform deployment information.`,
 				),
 				mcp.DefaultBool(false),

internal/subcmd/deploy.go

@@ -134,14 +134,14 @@ subcommand to configure them. For example:
 		if err != nil {
 			return err
 		}
-		if d.flags.Debug {
+		if d.flags.Verbose {
 			i.PrintRawValues()
 		}
 
 		if err := i.RenderValues(); err != nil {
 			return err
 		}
-		if d.flags.Debug {
+		if d.flags.Verbose {
 			i.PrintValues()
 		}