nginx-supportpkg.go

/**

Copyright 2024 F5, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

**/

package cmd

import (
	"fmt"
	"os"
	"slices"

	"github.com/nginxinc/nginx-k8s-supportpkg/pkg/data_collector"
	"github.com/nginxinc/nginx-k8s-supportpkg/pkg/jobs"
	"github.com/nginxinc/nginx-k8s-supportpkg/pkg/version"
	"github.com/spf13/cobra"
)

func Execute() {

	var namespaces []string
	var product string
	var jobList []jobs.Job

	var rootCmd = &cobra.Command{
		Use:   "nginx-supportpkg",
		Short: "nginx-supportpkg - a tool to create Ingress Controller diagnostics package",
		Long:  `nginx-supportpkg - a tool to create Ingress Controller diagnostics package`,
		Run: func(cmd *cobra.Command, args []string) {

			collector, err := data_collector.NewDataCollector(namespaces...)
			if err != nil {
				fmt.Println(fmt.Errorf("unable to start data collector: %s", err))
				os.Exit(1)
			}

			collector.Logger.Printf("Starting kubectl-nginx-supportpkg - version: %s - build: %s", version.Version, version.Build)
			collector.Logger.Printf("Input args are %v", os.Args)

			switch product {
			case "nic":
				jobList = slices.Concat(jobs.CommonJobList(), jobs.NICJobList())
			case "ngf":
				jobList = slices.Concat(jobs.CommonJobList(), jobs.NGFJobList())
			case "ngx":
				jobList = slices.Concat(jobs.CommonJobList(), jobs.NGXJobList())
			default:
				fmt.Printf("Error: product must be in the following list: [nic, ngf, ngx]\n")
				os.Exit(1)
			}

			if collector.AllNamespacesExist() {
				failedJobs := 0
				for _, job := range jobList {
					fmt.Printf("Running job %s...", job.Name)
					err = job.Collect(collector)
					if err != nil {
						fmt.Printf(" Error: %s\n", err)
						failedJobs++
					} else {
						fmt.Print(" OK\n")
					}
				}

				tarFile, err := collector.WrapUp(product)
				if err != nil {
					fmt.Println(fmt.Errorf("error when wrapping up: %s", err))
					os.Exit(1)
				} else {
					if failedJobs == 0 {
						fmt.Printf("Supportpkg successfully generated: %s\n", tarFile)
					} else {
						fmt.Printf("WARNING: %d failed job(s)\n", failedJobs)
						fmt.Printf("Supportpkg generated with warnings: %s\n", tarFile)
					}

				}
			} else {
				fmt.Println(" Error: Some namespaces do not exist")
			}
		},
	}

	rootCmd.Flags().StringSliceVarP(&namespaces, "namespace", "n", []string{}, "list of namespaces to collect information from")
	if err := rootCmd.MarkFlagRequired("namespace"); err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	rootCmd.Flags().StringVarP(&product, "product", "p", "", "products to collect information from")
	if err := rootCmd.MarkFlagRequired("product"); err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	versionStr := "nginx-supportpkg - version: " + version.Version + " - build: " + version.Build + "\n"
	rootCmd.SetVersionTemplate(versionStr)
	rootCmd.Version = versionStr

	rootCmd.SetUsageTemplate(
		versionStr +
			"Usage:" +
			"\n nginx-supportpkg -h|--help" +
			"\n nginx-supportpkg -v|--version" +
			"\n nginx-supportpkg [-n|--namespace] ns1 [-n|--namespace] ns2 [-p|--product] [nic,ngf,ngx]" +
			"\n nginx-supportpkg [-n|--namespace] ns1,ns2 [-p|--product] [nic,ngf,ngx] \n")

	if err := rootCmd.Execute(); err != nil {
		fmt.Println(err)
		os.Exit(1)
	}
}