feat: add verbose logging option for RBAC generation and Helm chart rendering

Author: matteogastaldello

internal/composition/composition.go

@@ -178,6 +178,7 @@ func (h *handler) Observe(ctx context.Context, mg *unstructured.Unstructured) (c
 			CompositionDefinitionName:      pkg.CompositionDefinitionInfo.Name,
 			CompositionDefinitionNamespace: pkg.CompositionDefinitionInfo.Namespace,
 			CompositionDefintionGVR:        pkg.CompositionDefinitionInfo.GVR,
+			Verbose:                        meta.IsVerbose(mg),
 		})
 	if err != nil {
 		log.Error(err, "Generating RBAC using chart-inspector")
@@ -316,6 +317,7 @@ func (h *handler) Create(ctx context.Context, mg *unstructured.Unstructured) err
 			CompositionDefinitionName:      pkg.CompositionDefinitionInfo.Name,
 			CompositionDefinitionNamespace: pkg.CompositionDefinitionInfo.Namespace,
 			CompositionDefintionGVR:        pkg.CompositionDefinitionInfo.GVR,
+			Verbose:                        meta.IsVerbose(mg),
 		})
 	if err != nil {
 		log.Error(err, "Generating RBAC using chart-inspector")
@@ -362,7 +364,7 @@ func (h *handler) Create(ctx context.Context, mg *unstructured.Unstructured) err
 	}
 	log.Debug("Installing composition package", "package", pkg.URL)
 
-	all, err := helmchart.GetResourcesRefFromRelease(rel, mg.GetNamespace())
+	all, err := helmchart.GetResourcesRefFromRelease(rel, mg.GetNamespace(), meta.IsVerbose(mg))
 	if err != nil {
 		log.Error(err, "Getting resources from release")
 		return fmt.Errorf("getting resources from release: %w", err)
@@ -440,7 +442,7 @@ func (h *handler) Update(ctx context.Context, mg *unstructured.Unstructured) err
 		return err
 	}
 
-	all, err := helmchart.GetResourcesRefFromRelease(rel, mg.GetNamespace())
+	all, err := helmchart.GetResourcesRefFromRelease(rel, mg.GetNamespace(), meta.IsVerbose(mg))
 	if err != nil {
 		log.Error(err, "Getting resources from release")
 		return fmt.Errorf("getting resources from release: %w", err)
@@ -588,6 +590,7 @@ func (h *handler) Delete(ctx context.Context, mg *unstructured.Unstructured) err
 			CompositionDefinitionName:      pkg.CompositionDefinitionInfo.Name,
 			CompositionDefinitionNamespace: pkg.CompositionDefinitionInfo.Namespace,
 			CompositionDefintionGVR:        pkg.CompositionDefinitionInfo.GVR,
+			Verbose:                        meta.IsVerbose(mg),
 		})
 	rbInstaller := rbac.NewRBACInstaller(h.dynamicClient)
 	err = rbInstaller.UninstallRBAC(generated)

internal/rbacgen/rbacgen.go

@@ -25,6 +25,7 @@ type Parameters struct {
 	CompositionDefinitionName      string                      // The name of the composition definition. Required.
 	CompositionDefinitionNamespace string                      // The namespace of the composition definition.
 	CompositionDefintionGVR        schema.GroupVersionResource // The GVR of the composition definition.
+	Verbose                        bool                        // Whether to enable verbose logging.
 }
 
 type RBACGen struct {
@@ -72,6 +73,13 @@ func (r *RBACGen) Generate(params Parameters) (*rbac.RBAC, error) {
 		Namespaces:         []*corev1.Namespace{},
 	}
 
+	if params.Verbose {
+		fmt.Printf("Resources extracted for RBAC generation:\n")
+		for _, res := range resources {
+			fmt.Printf("- %s/%s (Group: %s, Version: %s, Resource: %s)\n", res.Namespace, res.Name, res.Group, res.Version, res.Resource)
+		}
+	}
+
 	for _, resource := range resources {
 		if resource.Namespace == "" {
 			if resource.Group == "" && resource.Resource == "namespaces" && resource.Version == "v1" {

internal/tools/helmchart/helmchart.go

@@ -109,15 +109,15 @@ func RenderTemplate(ctx context.Context, opts RenderTemplateOptions) (*release.R
 		return nil, nil, err
 	}
 
-	all, err := GetResourcesRefFromRelease(rel, opts.Resource.GetNamespace())
+	all, err := GetResourcesRefFromRelease(rel, opts.Resource.GetNamespace(), false)
 	if err != nil {
 		return nil, nil, fmt.Errorf("failed to get resources from release: %w", err)
 	}
 
 	return rel, all, nil
 }
 
-func GetResourcesRefFromRelease(rel *release.Release, defaultNamespace string) ([]objectref.ObjectRef, error) {
+func GetResourcesRefFromRelease(rel *release.Release, defaultNamespace string, verbose bool) ([]objectref.ObjectRef, error) {
 	out := new(bytes.Buffer)
 
 	// We ignore a potential error here because, when the --debug flag was specified,
@@ -135,6 +135,10 @@ func GetResourcesRefFromRelease(rel *release.Release, defaultNamespace string) (
 		fmt.Fprintf(out, "%s", manifests.String())
 	}
 
+	if verbose {
+		fmt.Printf("Rendered Helm Chart YAML:\n%s\n", out.String())
+	}
+
 	all := []objectref.ObjectRef{}
 	tpl := out.Bytes()
 
@@ -147,20 +151,29 @@ func GetResourcesRefFromRelease(rel *release.Release, defaultNamespace string) (
 
 		var rawObj runtime.RawExtension
 		if err := decoder.Decode(&rawObj); err != nil {
-			return all, err
+			if verbose {
+				fmt.Printf("Failed to decode rendered template spec:\n%s\nError: %v\n", spec, err)
+			}
+			return all, fmt.Errorf("failed to decode rendered template: %w", err)
 		}
 		if rawObj.Raw == nil {
 			continue
 		}
 
 		obj, gvk, err := yaml.NewDecodingSerializer(unstructured.UnstructuredJSONScheme).Decode(rawObj.Raw, nil, nil)
 		if err != nil {
-			return all, err
+			if verbose {
+				fmt.Printf("Failed to decode rendered template to object:\n%s\nError: %v\n", spec, err)
+			}
+			return all, fmt.Errorf("failed to decode rendered template to unstructured: %w", err)
 		}
 
 		unstructuredMap, err := runtime.DefaultUnstructuredConverter.ToUnstructured(obj)
 		if err != nil {
-			return all, err
+			if verbose {
+				fmt.Printf("Failed to convert to unstructured map:\n%s\nError: %v\n", spec, err)
+			}
+			return all, fmt.Errorf("failed to convert to unstructured map: %w", err)
 		}
 
 		unstructuredObj := &unstructured.Unstructured{Object: unstructuredMap}