feat: Dry run flag to print preflight specs to std out (#1240)

banjoh · web-flow · commit b9f4fc4390d0 · 2023-09-12T14:42:10.000+01:00
diff --git a/cmd/analyze/cli/root.go b/cmd/analyze/cli/root.go
@@ -4,7 +4,7 @@ import (
 	"os"
 	"strings"
 
-	"github.com/replicatedhq/troubleshoot/cmd/util"
+	"github.com/replicatedhq/troubleshoot/cmd/internal/util"
 	"github.com/replicatedhq/troubleshoot/pkg/k8sutil"
 	"github.com/replicatedhq/troubleshoot/pkg/logger"
 	"github.com/spf13/cobra"
@@ -43,6 +43,8 @@ func RootCmd() *cobra.Command {
 
 	cobra.OnInitialize(initConfig)
 
+	cmd.AddCommand(util.VersionCmd())
+
 	cmd.Flags().String("analyzers", "", "filename or url of the analyzers to use")
 	cmd.Flags().Bool("debug", false, "enable debug logging")
 
diff --git a/cmd/collect/cli/root.go b/cmd/collect/cli/root.go
@@ -4,7 +4,7 @@ import (
 	"os"
 	"strings"
 
-	"github.com/replicatedhq/troubleshoot/cmd/util"
+	"github.com/replicatedhq/troubleshoot/cmd/internal/util"
 	"github.com/replicatedhq/troubleshoot/pkg/k8sutil"
 	"github.com/replicatedhq/troubleshoot/pkg/logger"
 	"github.com/spf13/cobra"
@@ -43,7 +43,7 @@ func RootCmd() *cobra.Command {
 
 	cobra.OnInitialize(initConfig)
 
-	cmd.AddCommand(VersionCmd())
+	cmd.AddCommand(util.VersionCmd())
 
 	cmd.Flags().StringSlice("redactors", []string{}, "names of the additional redactors to use")
 	cmd.Flags().Bool("redact", true, "enable/disable default redactions")
diff --git a/cmd/collect/cli/version.go b/cmd/collect/cli/version.go
diff --git a/cmd/internal/util/profilers.go b/cmd/internal/util/profilers.go
diff --git a/cmd/internal/util/version.go b/cmd/internal/util/version.go
@@ -1,4 +1,4 @@
-package cli
+package util
 
 import (
 	"fmt"
diff --git a/cmd/preflight/cli/root.go b/cmd/preflight/cli/root.go
@@ -6,7 +6,7 @@ import (
 	"os"
 	"strings"
 
-	"github.com/replicatedhq/troubleshoot/cmd/util"
+	"github.com/replicatedhq/troubleshoot/cmd/internal/util"
 	"github.com/replicatedhq/troubleshoot/internal/traces"
 	"github.com/replicatedhq/troubleshoot/pkg/constants"
 	"github.com/replicatedhq/troubleshoot/pkg/k8sutil"
@@ -64,10 +64,14 @@ that a cluster meets the requirements to run an application.`,
 
 	cobra.OnInitialize(initConfig)
 
-	cmd.AddCommand(VersionCmd())
+	cmd.AddCommand(util.VersionCmd())
 	cmd.AddCommand(OciFetchCmd())
 	preflight.AddFlags(cmd.PersistentFlags())
 
+	// Dry run flag should be in cmd.PersistentFlags() flags made available to all subcommands
+	// Adding here to avoid that
+	cmd.Flags().Bool("dry-run", false, "print the preflight spec without running preflight checks")
+
 	k8sutil.AddFlags(cmd.Flags())
 
 	// Initialize klog flags
diff --git a/cmd/preflight/cli/version.go b/cmd/preflight/cli/version.go
diff --git a/cmd/troubleshoot/cli/root.go b/cmd/troubleshoot/cli/root.go
@@ -5,7 +5,7 @@ import (
 	"os"
 	"strings"
 
-	"github.com/replicatedhq/troubleshoot/cmd/util"
+	"github.com/replicatedhq/troubleshoot/cmd/internal/util"
 	"github.com/replicatedhq/troubleshoot/internal/traces"
 	"github.com/replicatedhq/troubleshoot/pkg/k8sutil"
 	"github.com/replicatedhq/troubleshoot/pkg/logger"
@@ -62,7 +62,7 @@ from a server that can be used to assist when troubleshooting a Kubernetes clust
 
 	cmd.AddCommand(Analyze())
 	cmd.AddCommand(Redact())
-	cmd.AddCommand(VersionCmd())
+	cmd.AddCommand(util.VersionCmd())
 
 	cmd.Flags().StringSlice("redactors", []string{}, "names of the additional redactors to use")
 	cmd.Flags().Bool("redact", true, "enable/disable default redactions")
diff --git a/docs/preflight.md b/docs/preflight.md
@@ -29,6 +29,7 @@ preflight [url] [flags]
       --cpuprofile string              File path to write cpu profiling data
       --debug                          enable debug logging
       --disable-compression            If true, opt-out of response compression for all requests to the server
+      --dry-run                        print the preflight spec without running preflight checks
       --format string                  output format, one of human, json, yaml. only used when interactive is set to false (default "human")
   -h, --help                           help for preflight
       --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
@@ -53,4 +54,4 @@ preflight [url] [flags]
 * [preflight oci-fetch](preflight_oci-fetch.md)	 - Fetch a preflight from an OCI registry and print it to standard out
 * [preflight version](preflight_version.md)	 - Print the current version and exit
 
-###### Auto generated by spf13/cobra on 8-Jun-2023
+###### Auto generated by spf13/cobra on 31-Aug-2023
diff --git a/docs/preflight_oci-fetch.md b/docs/preflight_oci-fetch.md
@@ -33,4 +33,4 @@ preflight oci-fetch [URI] [flags]
 
 * [preflight](preflight.md)	 - Run and retrieve preflight checks in a cluster
 
-###### Auto generated by spf13/cobra on 8-Jun-2023
+###### Auto generated by spf13/cobra on 31-Aug-2023
diff --git a/docs/preflight_version.md b/docs/preflight_version.md
@@ -37,4 +37,4 @@ preflight version [flags]
 
 * [preflight](preflight.md)	 - Run and retrieve preflight checks in a cluster
 
-###### Auto generated by spf13/cobra on 3-Jan-2023
+###### Auto generated by spf13/cobra on 31-Aug-2023
diff --git a/docs/support-bundle.md b/docs/support-bundle.md
@@ -55,4 +55,4 @@ support-bundle [urls...] [flags]
 * [support-bundle redact](support-bundle_redact.md)	 - Redact information from a generated support bundle archive
 * [support-bundle version](support-bundle_version.md)	 - Print the current version and exit
 
-###### Auto generated by spf13/cobra on 8-Jun-2023
+###### Auto generated by spf13/cobra on 31-Aug-2023
diff --git a/docs/support-bundle_analyze.md b/docs/support-bundle_analyze.md
@@ -30,4 +30,4 @@ support-bundle analyze [url] [flags]
 
 * [support-bundle](support-bundle.md)	 - Generate a support bundle
 
-###### Auto generated by spf13/cobra on 3-Jan-2023
+###### Auto generated by spf13/cobra on 31-Aug-2023
diff --git a/docs/support-bundle_redact.md b/docs/support-bundle_redact.md
@@ -39,4 +39,4 @@ support-bundle redact [urls...] [flags]
 
 * [support-bundle](support-bundle.md)	 - Generate a support bundle
 
-###### Auto generated by spf13/cobra on 3-Jan-2023
+###### Auto generated by spf13/cobra on 31-Aug-2023
diff --git a/docs/support-bundle_version.md b/docs/support-bundle_version.md
@@ -27,4 +27,4 @@ support-bundle version [flags]
 
 * [support-bundle](support-bundle.md)	 - Generate a support bundle
 
-###### Auto generated by spf13/cobra on 3-Jan-2023
+###### Auto generated by spf13/cobra on 31-Aug-2023
diff --git a/go.mod b/go.mod
@@ -245,7 +245,7 @@ require (
 	sigs.k8s.io/kustomize/api v0.13.5-0.20230601165947-6ce0bf390ce3 // indirect
 	sigs.k8s.io/kustomize/kyaml v0.14.3-0.20230601165947-6ce0bf390ce3 // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.2.3 // indirect
-	sigs.k8s.io/yaml v1.3.0 // indirect
+	sigs.k8s.io/yaml v1.3.0
 )
 
 replace (
diff --git a/internal/testutils/utils.go b/internal/testutils/utils.go
@@ -15,7 +15,10 @@ import (
 
 func GetTestFixture(t *testing.T, path string) string {
 	t.Helper()
-	p := filepath.Join("../../testdata", path)
+	p := path
+	if !filepath.IsAbs(path) {
+		p = filepath.Join("../../testdata", path)
+	}
 	b, err := os.ReadFile(p)
 	require.NoError(t, err)
 	return string(b)
diff --git a/pkg/loader/loader.go b/pkg/loader/loader.go
@@ -2,6 +2,8 @@ package loader
 
 import (
 	"context"
+	"reflect"
+	"strings"
 
 	"github.com/pkg/errors"
 	"github.com/replicatedhq/troubleshoot/internal/util"
@@ -10,10 +12,10 @@ import (
 	"github.com/replicatedhq/troubleshoot/pkg/constants"
 	"github.com/replicatedhq/troubleshoot/pkg/docrewrite"
 	"github.com/replicatedhq/troubleshoot/pkg/types"
-	"gopkg.in/yaml.v2"
 	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/klog/v2"
+	"sigs.k8s.io/yaml"
 )
 
 var decoder runtime.Decoder
@@ -97,6 +99,33 @@ func (kinds *TroubleshootKinds) Add(other *TroubleshootKinds) {
 	kinds.SupportBundlesV1Beta2 = append(kinds.SupportBundlesV1Beta2, other.SupportBundlesV1Beta2...)
 }
 
+// ToYaml returns a yaml document/multi-doc of all the parsed specs
+// This function utilises reflection to iterate over all the fields
+// of the TroubleshootKinds object then marshals them to yaml.
+func (kinds *TroubleshootKinds) ToYaml() (string, error) {
+	rawList := []string{}
+	obj := reflect.ValueOf(*kinds)
+
+	for i := 0; i < obj.NumField(); i++ {
+		field := obj.Field(i)
+		if field.Kind() != reflect.Slice {
+			continue
+		}
+
+		// skip empty slices to avoid empty yaml documents
+		for count := 0; count < field.Len(); count++ {
+			val := field.Index(count)
+			yamlOut, err := yaml.Marshal(val.Interface())
+			if err != nil {
+				return "", err
+			}
+			rawList = append(rawList, string(yamlOut))
+		}
+	}
+
+	return strings.Join(rawList, "---\n"), nil
+}
+
 func NewTroubleshootKinds() *TroubleshootKinds {
 	return &TroubleshootKinds{}
 }
diff --git a/pkg/loader/loader_test.go b/pkg/loader/loader_test.go
@@ -522,3 +522,60 @@ func TestAddingKinds(t *testing.T) {
 	}
 	assert.Equal(t, k2, k1)
 }
+
+func TestToYaml(t *testing.T) {
+	k := &TroubleshootKinds{
+		AnalyzersV1Beta2: []troubleshootv1beta2.Analyzer{
+			{
+				TypeMeta: metav1.TypeMeta{
+					Kind:       "Analyzer",
+					APIVersion: "troubleshoot.sh/v1beta2",
+				},
+				Spec: troubleshootv1beta2.AnalyzerSpec{
+					Analyzers: []*troubleshootv1beta2.Analyze{
+						{
+							ClusterVersion: &troubleshootv1beta2.ClusterVersion{
+								Outcomes: []*troubleshootv1beta2.Outcome{
+									{
+										Pass: &troubleshootv1beta2.SingleOutcome{
+											Message: "Cluster is up to date",
+										},
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+		},
+		SupportBundlesV1Beta2: []troubleshootv1beta2.SupportBundle{
+			{
+				TypeMeta: metav1.TypeMeta{
+					Kind:       "SupportBundle",
+					APIVersion: "troubleshoot.sh/v1beta2",
+				},
+				Spec: troubleshootv1beta2.SupportBundleSpec{
+					Collectors: []*troubleshootv1beta2.Collect{
+						{
+							ClusterResources: &troubleshootv1beta2.ClusterResources{
+								IgnoreRBAC: true,
+							},
+						},
+					},
+				},
+			},
+		},
+	}
+
+	y, err := k.ToYaml()
+	require.NoError(t, err)
+	assert.Contains(t, string(y), `apiVersion: troubleshoot.sh/v1beta2
+kind: SupportBundle
+metadata:
+  creationTimestamp: null
+spec:
+  collectors:
+  - clusterResources:
+      ignoreRBAC: true`)
+	assert.Contains(t, string(y), "message: Cluster is up to date")
+}
diff --git a/pkg/preflight/flags.go b/pkg/preflight/flags.go
@@ -16,6 +16,7 @@ const (
 	flagSince                     = "since"
 	flagOutput                    = "output"
 	flagDebug                     = "debug"
+	flagDryRun                    = "dry-run"
 )
 
 type PreflightFlags struct {
diff --git a/pkg/preflight/read_specs.go b/pkg/preflight/read_specs.go
@@ -7,46 +7,55 @@ import (
 	"github.com/replicatedhq/troubleshoot/internal/specs"
 	troubleshootv1beta2 "github.com/replicatedhq/troubleshoot/pkg/apis/troubleshoot/v1beta2"
 	"github.com/replicatedhq/troubleshoot/pkg/k8sutil"
+	"github.com/replicatedhq/troubleshoot/pkg/loader"
 	"github.com/spf13/viper"
 	"k8s.io/client-go/kubernetes"
 )
 
-type PreflightSpecs struct {
-	PreflightSpec     *troubleshootv1beta2.Preflight
-	HostPreflightSpec *troubleshootv1beta2.HostPreflight
-	UploadResultSpecs []*troubleshootv1beta2.Preflight
-}
-
-func (p *PreflightSpecs) Read(args []string) error {
+func readSpecs(args []string) (*loader.TroubleshootKinds, error) {
 	config, err := k8sutil.GetRESTConfig()
 	if err != nil {
-		return errors.Wrap(err, "failed to convert kube flags to rest config")
+		return nil, errors.Wrap(err, "failed to convert kube flags to rest config")
 	}
 
 	client, err := kubernetes.NewForConfig(config)
 	if err != nil {
-		return errors.Wrap(err, "failed to convert create k8s client")
+		return nil, errors.Wrap(err, "failed to convert create k8s client")
 	}
 
 	ctx := context.Background()
 	kinds, err := specs.LoadFromCLIArgs(ctx, client, args, viper.GetViper())
 	if err != nil {
-		return err
+		return nil, err
 	}
 
+	ret := loader.NewTroubleshootKinds()
+
+	// Concatenate all preflight inclusterSpecs that don't have an upload destination
+	inclusterSpecs := []troubleshootv1beta2.Preflight{}
+	var concatenatedSpec *troubleshootv1beta2.Preflight
 	for _, v := range kinds.PreflightsV1Beta2 {
 		v := v // https://golang.org/doc/faq#closures_and_goroutines
 		if v.Spec.UploadResultsTo == "" {
-			p.PreflightSpec = ConcatPreflightSpec(p.PreflightSpec, &v)
+			concatenatedSpec = ConcatPreflightSpec(concatenatedSpec, &v)
 		} else {
-			p.UploadResultSpecs = append(p.UploadResultSpecs, &v)
+			inclusterSpecs = append(inclusterSpecs, v)
 		}
 	}
 
+	if concatenatedSpec != nil {
+		inclusterSpecs = append(inclusterSpecs, *concatenatedSpec)
+	}
+	ret.PreflightsV1Beta2 = inclusterSpecs
+
+	var hostSpec *troubleshootv1beta2.HostPreflight
 	for _, v := range kinds.HostPreflightsV1Beta2 {
 		v := v // https://golang.org/doc/faq#closures_and_goroutines
-		p.HostPreflightSpec = ConcatHostPreflightSpec(p.HostPreflightSpec, &v)
+		hostSpec = ConcatHostPreflightSpec(hostSpec, &v)
+	}
+	if hostSpec != nil {
+		ret.HostPreflightsV1Beta2 = []troubleshootv1beta2.HostPreflight{*hostSpec}
 	}
 
-	return nil
+	return ret, nil
 }
diff --git a/pkg/preflight/read_specs_test.go b/pkg/preflight/read_specs_test.go
diff --git a/pkg/preflight/run.go b/pkg/preflight/run.go
diff --git a/pkg/preflight/validate_specs.go b/pkg/preflight/validate_specs.go
diff --git a/pkg/preflight/validate_specs_test.go b/pkg/preflight/validate_specs_test.go

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package cli`
	`1`	`+package util`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"fmt"`
Original file line number	Diff line number	Diff line change
`@@ -33,4 +33,4 @@ preflight oci-fetch [URI] [flags]`
`33`	`33`
`34`	`34`	`* [preflight](preflight.md) - Run and retrieve preflight checks in a cluster`
`35`	`35`
`36`		`-###### Auto generated by spf13/cobra on 8-Jun-2023`
	`36`	`+###### Auto generated by spf13/cobra on 31-Aug-2023`