feat(must gather): include configmaps and add option to write output to a file

Author: lburgazzoli

rhoc/pkg/cmd/must_gather/must_gather.go

@@ -1,18 +1,21 @@
 package must_gather
 
 import (
+	"bufio"
+	"errors"
 	"fmt"
-	"github.com/bf2fc6cc711aee1a0c2a/cos-tools/rhoc/pkg/util/kubernetes/pods"
-	"github.com/bf2fc6cc711aee1a0c2a/cos-tools/rhoc/pkg/util/kubernetes/resources"
-	"gopkg.in/yaml.v3"
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"k8s.io/apimachinery/pkg/runtime/schema"
+	"io"
 	"os"
 
 	"github.com/bf2fc6cc711aee1a0c2a/cos-tools/rhoc/pkg/util/cmdutil"
+	"github.com/bf2fc6cc711aee1a0c2a/cos-tools/rhoc/pkg/util/kubernetes/pods"
+	"github.com/bf2fc6cc711aee1a0c2a/cos-tools/rhoc/pkg/util/kubernetes/resources"
 	"github.com/redhat-developer/app-services-cli/pkg/shared/factory"
+
 	"github.com/spf13/cobra"
+	"gopkg.in/yaml.v3"
 
+	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/cli-runtime/pkg/genericclioptions"
 	"k8s.io/cli-runtime/pkg/printers"
 	"k8s.io/client-go/discovery"
@@ -24,6 +27,7 @@ import (
 type options struct {
 	id        string
 	logs      bool
+	file      string
 	resources []string
 	gvrs      []schema.GroupVersionResource
 	f         *factory.Factory
@@ -73,62 +77,101 @@ func NewMustGatherCommand(f *factory.Factory) *cobra.Command {
 				}
 			}
 
-			ulist := make([]map[string]interface{}, 0)
+			for i := range opts.gvrs {
+				// exclude secrets
+				if opts.gvrs[i].Group == "" && opts.gvrs[i].Version == "v1" && opts.gvrs[i].Resource == "secrets" {
+					opts.gvrs[i].Group = ""
+					opts.gvrs[i].Version = ""
+					opts.gvrs[i].Resource = ""
+				}
+			}
+
+			var o io.Writer
+			var mustClose bool
+
+			if opts.file == "" {
+				o = f.IOStreams.Out
+				mustClose = false
+			} else {
+				f, err := os.Create(opts.file)
+				if err != nil {
+					return err
+				}
+
+				o = f
+				mustClose = true
+			}
+
+			out := bufio.NewWriter(o)
+			defer func() {
+				_ = out.Flush()
 
-			for _, gvr := range opts.gvrs {
+				if mustClose {
+					if c, ok := o.(io.Closer); ok {
+						_ = c.Close()
+					}
+				}
+			}()
+
+			items, err := resources.List(f.Context, dynamicClient, opts.gvrs, opts.id)
+			if err != nil {
+				return err
+			}
 
-				resList, err := dynamicClient.Resource(gvr).List(f.Context, metav1.ListOptions{
-					LabelSelector: "cos.bf2.org/connector.id=" + opts.id,
-				})
+			if len(items) != 0 {
+				raw, err := yaml.Marshal(items)
 				if err != nil {
 					return err
 				}
 
-				for _, res := range resList.Items {
-					switch {
-					case res.GetAPIVersion() == "v1" && res.GetKind() == "Secret":
-						continue
-					case res.GetAPIVersion() == "v1" && res.GetKind() == "ConfigMap":
-						continue
-					default:
-						fmt.Printf("Gathering -> %s:%s\n", res.GetAPIVersion(), gvr.Resource)
+				_, err = out.Write(raw)
+				if err != nil {
+					return err
+				}
+			}
 
-						// remove managed fields as they are only making noise
-						res.SetManagedFields(nil)
+			if opts.logs {
+				for _, item := range items {
+					if item.GetAPIVersion() == "v1" && item.GetKind() == "Pod" {
+						containers, err := pods.ListContainers(f.Context, client, item.GetNamespace(), item.GetName())
+						if err != nil {
+							return err
+						}
 
-						ulist = append(ulist, res.Object)
+						for _, container := range containers {
+							_, err = fmt.Fprintf(
+								out,
+								"%s/%s:%s:%s@%s\n",
+								item.GetAPIVersion(),
+								item.GetKind(),
+								item.GetNamespace(),
+								item.GetName(),
+								container)
 
-						if res.GetAPIVersion() == "v1" && res.GetKind() == "Pod" && opts.logs {
-							containers, err := pods.ListContainers(f.Context, client, res.GetNamespace(), res.GetName())
 							if err != nil {
 								return err
 							}
 
-							for _, container := range containers {
-								err := pods.Logs(f.Context, client, res.GetNamespace(), res.GetName(), container, os.Stdout)
-								if err != nil {
-									return err
-								}
+							err := pods.Logs(f.Context, client, item.GetNamespace(), item.GetName(), container, out)
+							if err != nil && !errors.Is(err, io.EOF) {
+								return err
 							}
 						}
-					}
-				}
-			}
 
-			if len(ulist) != 0 {
-				out, err := yaml.Marshal(ulist)
-				if err != nil {
-					return err
+						_, err = out.Write([]byte{'\n'})
+						if err != nil {
+							return err
+						}
+					}
 				}
-
-				fmt.Println(string(out))
 			}
 
 			return nil
 		},
 	}
 
 	cmdutil.AddID(cmd, &opts.id).Required()
+	cmdutil.AddFile(cmd, &opts.file)
 
 	cmd.Flags().BoolVar(&opts.logs, "logs", opts.logs, "Include logs")
 	cmd.Flags().StringSliceVar(&opts.resources, "resource", nil, "resources to include apiVersion:plural")

rhoc/pkg/util/cmdutil/cmdutil.go

@@ -351,6 +351,19 @@ func AddRevision(cmd *cobra.Command, output *int64) *FlagOptions {
 	return withFlagOptions(cmd, name)
 }
 
+func AddFile(cmd *cobra.Command, output *string) *FlagOptions {
+	name := "file"
+
+	cmd.Flags().StringVar(
+		output,
+		name,
+		"",
+		"file",
+	)
+
+	return withFlagOptions(cmd, name)
+}
+
 func withFlagOptions(cmd *cobra.Command, flagName string) *FlagOptions {
 	options := FlagOptions{}
 

rhoc/pkg/util/kubernetes/pods/pods.go

@@ -48,10 +48,10 @@ func Logs(ctx context.Context, client kubernetes.Interface, namespace string, na
 	for {
 		data, err := reader.ReadBytes('\n')
 		if errors.Is(err, io.EOF) {
-			return err
+			return nil
 		}
 		if err != nil {
-			break
+			return err
 		}
 
 		data = re.ReplaceAll(data, empty)

rhoc/pkg/util/kubernetes/resources/resources.go

@@ -1,9 +1,13 @@
 package resources
 
 import (
+	"context"
 	"github.com/bf2fc6cc711aee1a0c2a/cos-tools/rhoc/pkg/util/collections"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/client-go/discovery"
+	"k8s.io/client-go/dynamic"
 	"strings"
 )
 
@@ -62,3 +66,33 @@ func Parse(resources []string) ([]schema.GroupVersionResource, error) {
 
 	return answer, nil
 }
+
+func List(ctx context.Context, client dynamic.Interface, resources []schema.GroupVersionResource, connectorId string) ([]unstructured.Unstructured, error) {
+	items := make([]unstructured.Unstructured, 0)
+
+	for _, gvr := range resources {
+
+		if gvr.Resource == "" {
+			continue
+		}
+
+		resList, err := client.Resource(gvr).List(ctx, metav1.ListOptions{
+			LabelSelector: "cos.bf2.org/connector.id=" + connectorId,
+		})
+		if err != nil {
+			return nil, err
+		}
+
+		//case item.GetAPIVersion() == "v1" && item.GetKind() == "Secret":
+		//continue
+
+		for i := range resList.Items {
+			// remove managed fields as they are only making noise
+			resList.Items[i].SetManagedFields(nil)
+
+			items = append(items, resList.Items[i])
+		}
+	}
+
+	return items, nil
+}