grafana_dashboards.gen.go

// Code generated by chronogen; DO NOT EDIT
package configv1

import (
	"context"
	"fmt"

	"github.com/chronosphereio/chronoctl-core/src/cmd/cli"
	"github.com/chronosphereio/chronoctl-core/src/cmd/pkg/client"
	"github.com/chronosphereio/chronoctl-core/src/cmd/pkg/clienterror"
	"github.com/chronosphereio/chronoctl-core/src/cmd/pkg/dry"
	"github.com/chronosphereio/chronoctl-core/src/cmd/pkg/file"
	"github.com/chronosphereio/chronoctl-core/src/cmd/pkg/groups"
	"github.com/chronosphereio/chronoctl-core/src/cmd/pkg/output"
	"github.com/chronosphereio/chronoctl-core/src/cmd/pkg/pagination"
	"github.com/chronosphereio/chronoctl-core/src/cmd/pkg/ptr"
	config_v1 "github.com/chronosphereio/chronoctl-core/src/generated/swagger/configv1/client/operations"
	"github.com/chronosphereio/chronoctl-core/src/generated/swagger/configv1/models"
	"github.com/chronosphereio/chronoctl-core/src/types"
	"github.com/spf13/cobra"
	flag "github.com/spf13/pflag"
)

func init() { types.MustRegisterObject(GrafanaDashboardTypeMeta, &GrafanaDashboard{}) }

var _ types.Object = &GrafanaDashboard{}

var GrafanaDashboardTypeMeta = types.TypeMeta{
	APIVersion: "v1/config",
	Kind:       "GrafanaDashboard",
}

type GrafanaDashboard struct {
	types.TypeMeta `json:",inline"`
	Spec           *models.Configv1GrafanaDashboard `json:"spec"`
}

func NewGrafanaDashboard(spec *models.Configv1GrafanaDashboard) *GrafanaDashboard {
	return &GrafanaDashboard{
		TypeMeta: GrafanaDashboardTypeMeta,
		Spec:     spec,
	}
}

func (e *GrafanaDashboard) Description() string {
	return types.TypeDescription(e, "name", e.Spec.Name, "slug", e.Spec.Slug)
}

func (e *GrafanaDashboard) Identifier() string {
	return e.Spec.Slug
}

func CreateGrafanaDashboard(
	ctx context.Context,
	client config_v1.ClientService,
	entity *GrafanaDashboard,
	dryRun bool,
) (*GrafanaDashboard, error) {
	res, err := client.CreateGrafanaDashboard(&config_v1.CreateGrafanaDashboardParams{
		Context: ctx,
		Body: &models.Configv1CreateGrafanaDashboardRequest{
			DryRun:           dryRun,
			GrafanaDashboard: entity.Spec,
		},
	})
	if err != nil {
		return nil, clienterror.Wrap(err)
	}
	return NewGrafanaDashboard(res.Payload.GrafanaDashboard), nil
}

func newGrafanaDashboardCreateCmd() *cobra.Command {
	var (
		permissiveParsing bool
		dryRunFlags       = dry.NewFlags()
		clientFlags       = client.NewClientFlags()
		outputFlags       = output.NewFlags(output.WithoutOutputDirectory(), output.WithoutCreateFilePerObject())
		fileFlags         = file.NewFlags(true /* required */)
	)

	var (
		use   string
		short string
	)
	use = "create -f <file>"
	short = "Creates a single GrafanaDashboard."

	cmd := &cobra.Command{
		Use:     use,
		GroupID: groups.Commands.ID,
		Short:   short,
		RunE: func(cmd *cobra.Command, args []string) error {
			ctx, cancel := context.WithTimeout(cmd.Context(), clientFlags.Timeout())
			defer cancel()
			if err := outputFlags.Validate(); err != nil {
				return err
			}
			defer outputFlags.Close(cmd.OutOrStdout())
			stderr := output.NewStderrPrinter(cmd)

			client, err := clientFlags.ConfigV1Client()
			if err != nil {
				return err
			}

			var grafanaDashboard *GrafanaDashboard
			file, err := fileFlags.File()
			if err != nil {
				return err
			}
			defer file.Close() //nolint:errcheck
			grafanaDashboard, err = types.MustDecodeSingleObject[*GrafanaDashboard](file, permissiveParsing)
			if err != nil {
				return err
			}

			if dryRunFlags.DryRun {
				stderr.Println("--dry-run is set")
			}
			fullGrafanaDashboard, err := CreateGrafanaDashboard(ctx, client, grafanaDashboard, dryRunFlags.DryRun)
			if err != nil {
				return err
			}

			if dryRunFlags.DryRun {
				stderr.Println("GrafanaDashboard is valid and can be created")
				return nil
			}
			stderr.Printf("GrafanaDashboard with slug %q created successfully\n", fullGrafanaDashboard.Spec.Slug)

			if err := outputFlags.WriteObject(fullGrafanaDashboard, cmd.OutOrStdout()); err != nil {
				return err
			}
			return nil
		},
	}
	dryRunFlags.AddFlags(cmd)
	clientFlags.AddFlags(cmd)
	outputFlags.AddFlags(cmd)
	fileFlags.AddFlags(cmd)
	cmd.Flags().BoolVar(&permissiveParsing, "no-strict", false, "If set, manifests with unknown fields are not rejected. Defaults to false.")

	return cmd
}

func GetGrafanaDashboard(
	ctx context.Context,
	client config_v1.ClientService,
	slug string,
) (*GrafanaDashboard, error) {
	res, err := client.ReadGrafanaDashboard(&config_v1.ReadGrafanaDashboardParams{
		Context: ctx,
		Slug:    slug,
	})
	if err != nil {
		return nil, clienterror.Wrap(err)
	}
	return NewGrafanaDashboard(res.GetPayload().GrafanaDashboard), nil
}

func newGrafanaDashboardReadCmd() *cobra.Command {
	clientFlags := client.NewClientFlags()
	outputFlags := output.NewFlags(output.WithoutOutputDirectory(), output.WithoutCreateFilePerObject())
	var (
		short string
		use   string
		args  cobra.PositionalArgs
	)
	short = "Reads a single GrafanaDashboard by slug"
	use = "read <slug>"
	args = cobra.ExactArgs(1)

	cmd := &cobra.Command{
		Use:     use,
		GroupID: groups.Commands.ID,
		Short:   short,
		Args:    args,
		RunE: func(cmd *cobra.Command, args []string) error {
			ctx, cancel := context.WithTimeout(cmd.Context(), clientFlags.Timeout())
			defer cancel()
			if err := outputFlags.Validate(); err != nil {
				return err
			}
			defer outputFlags.Close(cmd.OutOrStdout())

			client, err := clientFlags.ConfigV1Client()
			if err != nil {
				return err
			}
			entity, err := GetGrafanaDashboard(ctx, client, args[0])
			if err != nil {
				return err
			}
			if err := outputFlags.WriteObject(entity, cmd.OutOrStdout()); err != nil {
				return err
			}
			return nil
		},
	}

	clientFlags.AddFlags(cmd)
	outputFlags.AddFlags(cmd)

	return cmd
}

func UpdateGrafanaDashboard(
	ctx context.Context,
	client config_v1.ClientService,
	entity *GrafanaDashboard,
	opts UpdateOptions,
) (*GrafanaDashboard, error) {
	res, err := client.UpdateGrafanaDashboard(&config_v1.UpdateGrafanaDashboardParams{
		Context: ctx,
		Slug:    entity.Spec.Slug,
		Body: config_v1.UpdateGrafanaDashboardBody{
			CreateIfMissing:  opts.CreateIfMissing,
			DryRun:           opts.DryRun,
			GrafanaDashboard: entity.Spec,
		},
	})
	if err != nil {
		return nil, clienterror.Wrap(err)
	}

	return NewGrafanaDashboard(res.Payload.GrafanaDashboard), nil
}

func newGrafanaDashboardUpdateCmd() *cobra.Command {
	var (
		permissiveParsing bool
		createIfMissing   bool
		dryRunFlags       = dry.NewFlags()
		clientFlags       = client.NewClientFlags()
		outputFlags       = output.NewFlags(output.WithoutOutputDirectory(), output.WithoutCreateFilePerObject())
		fileFlags         = file.NewFlags(true /* required */)
	)

	cmd := &cobra.Command{
		Use:     "update -f <filename>",
		GroupID: groups.Commands.ID,
		Short:   "Updates an existing GrafanaDashboard.",
		RunE: func(cmd *cobra.Command, args []string) error {
			ctx, cancel := context.WithTimeout(cmd.Context(), clientFlags.Timeout())
			defer cancel()
			if err := outputFlags.Validate(); err != nil {
				return err
			}
			defer outputFlags.Close(cmd.OutOrStdout())
			stderr := output.NewStderrPrinter(cmd)

			client, err := clientFlags.ConfigV1Client()
			if err != nil {
				return err
			}

			file, err := fileFlags.File()
			if err != nil {
				return err
			}
			defer file.Close() //nolint:errcheck

			grafanaDashboard, err := types.MustDecodeSingleObject[*GrafanaDashboard](file, permissiveParsing)
			if err != nil {
				return err
			}

			updateOpts := UpdateOptions{
				DryRun:          dryRunFlags.DryRun,
				CreateIfMissing: createIfMissing,
			}

			if dryRunFlags.DryRun {
				stderr.Println("--dry-run is set, update not persisted")
			}

			fullGrafanaDashboard, err := UpdateGrafanaDashboard(ctx, client, grafanaDashboard, updateOpts)
			if err != nil {
				return err
			}

			if dryRunFlags.DryRun {
				stderr.Println("GrafanaDashboard is valid and can be updated")
				return nil
			}
			stderr.Printf("GrafanaDashboard with slug %q applied successfully\n", fullGrafanaDashboard.Spec.Slug)

			if err := outputFlags.WriteObject(fullGrafanaDashboard, cmd.OutOrStdout()); err != nil {
				return err
			}
			return nil
		},
	}
	dryRunFlags.AddFlags(cmd)
	clientFlags.AddFlags(cmd)
	outputFlags.AddFlags(cmd)
	fileFlags.AddFlags(cmd)
	cmd.Flags().BoolVar(&permissiveParsing, "no-strict", false, "If set, manifests with unknown fields are allowed. Defaults to false.")
	cmd.Flags().BoolVar(&createIfMissing, "create-if-missing", false, "If set, creates the GrafanaDashboard if it does not already exist. Defaults to false.")

	return cmd
}

func DeleteGrafanaDashboard(
	ctx context.Context,
	client config_v1.ClientService,
	slug string,
) error {
	_, err := client.DeleteGrafanaDashboard(&config_v1.DeleteGrafanaDashboardParams{
		Context: ctx,
		Slug:    slug,
	})
	if err != nil {
		return clienterror.Wrap(err)
	}
	return nil
}

func newGrafanaDashboardDeleteCmd() *cobra.Command {
	clientFlags := client.NewClientFlags()
	outputFlags := output.NewFlags(output.WithoutOutputDirectory(), output.WithoutCreateFilePerObject())

	cmd := &cobra.Command{
		Use:     "delete <slug>",
		GroupID: groups.Commands.ID,
		Short:   "Deletes a single GrafanaDashboard by slug",
		Args:    cobra.ExactArgs(1),
		RunE: func(cmd *cobra.Command, args []string) error {
			ctx, cancel := context.WithTimeout(cmd.Context(), clientFlags.Timeout())
			defer cancel()
			if err := outputFlags.Validate(); err != nil {
				return err
			}
			defer outputFlags.Close(cmd.OutOrStdout())

			client, err := clientFlags.ConfigV1Client()
			if err != nil {
				return err
			}

			res, err := client.DeleteGrafanaDashboard(&config_v1.DeleteGrafanaDashboardParams{
				Context: ctx,
				Slug:    args[0],
			})
			if err != nil {
				return clienterror.Wrap(err)
			}
			_ = res
			fmt.Fprintf(cmd.OutOrStdout(), "deleted GrafanaDashboard with slug %q\n", args[0])

			return nil
		},
	}
	clientFlags.AddFlags(cmd)
	outputFlags.AddFlags(cmd)
	return cmd
}

type GrafanaDashboardListOpts struct {
	// Limit represents that maximum number of items we wish to return.
	Limit int
	// PageToken is the pagination token we want to start our request at.
	PageToken string
	// PageMaxSize is the maximum page size to use when making List calls.
	PageMaxSize          int
	BucketSlugs          []string
	CollectionSlugs      []string
	IncludeDashboardJSON bool
	Names                []string
	Slugs                []string
}

func (r *GrafanaDashboardListOpts) registerFlags(flags *flag.FlagSet) {
	var emptyBucketSlugs []string
	flags.StringSliceVar(&r.BucketSlugs, "bucket-slugs", emptyBucketSlugs, "Filters results by bucket_slug, where any GrafanaDashboard with a matching bucket_slug in the given list (and matches all other filters) is returned.")
	var emptyCollectionSlugs []string
	flags.StringSliceVar(&r.CollectionSlugs, "collection-slugs", emptyCollectionSlugs, "Filters results by collection_slug, where any GrafanaDashboard with a matching collection_slug in the given list (and matches all other filters) is returned.")
	var emptyIncludeDashboardJSON bool
	flags.BoolVar(&r.IncludeDashboardJSON, "include-dashboard-json", emptyIncludeDashboardJSON, "Optional flag to populate the dashboard_json of the returned dashboards. By default, dashboard_json will be left empty.")
	var emptyNames []string
	flags.StringSliceVar(&r.Names, "names", emptyNames, "Filters results by name, where any GrafanaDashboard with a matching name in the given list (and matches all other filters) is returned.")
	var emptySlugs []string
	flags.StringSliceVar(&r.Slugs, "slugs", emptySlugs, "Filters results by slug, where any GrafanaDashboard with a matching slug in the given list (and matches all other filters) is returned.")
	flags.IntVar(&r.Limit, "limit", 0, "maximum number of items to return")
	flags.IntVar(&r.PageMaxSize, "page-max-size", 0, "maximum page size")
	flags.StringVar(&r.PageToken, "page-token", "", "begins listing items at the start of the pagination token")
}

func ListGrafanaDashboards(
	ctx context.Context,
	client config_v1.ClientService,
	streamer output.Streamer[*GrafanaDashboard],
	opts GrafanaDashboardListOpts,
) (pagination.Token, error) {
	var (
		gotItems    = 0
		nextToken   = opts.PageToken
		pageMaxSize = opts.PageMaxSize
	)

	// Use the limit if it's set, and smaller than a set page size.
	if opts.Limit > 0 && (opts.Limit < pageMaxSize || pageMaxSize == 0) {
		pageMaxSize = opts.Limit
	}

	for {
		res, err := client.ListGrafanaDashboards(&config_v1.ListGrafanaDashboardsParams{
			Context:              ctx,
			PageToken:            &nextToken,
			PageMaxSize:          ptr.Int64(int64(pageMaxSize)),
			BucketSlugs:          opts.BucketSlugs,
			CollectionSlugs:      opts.CollectionSlugs,
			IncludeDashboardJSON: &opts.IncludeDashboardJSON,
			Names:                opts.Names,
			Slugs:                opts.Slugs,
		})
		if err != nil {
			return pagination.Token(""), clienterror.Wrap(err)
		}

		for _, v := range res.Payload.GrafanaDashboards {
			if err := streamer(NewGrafanaDashboard(v)); err != nil {
				return pagination.Token(""), err
			}
			gotItems++
		}

		nextToken = res.Payload.Page.NextToken
		if nextToken == "" {
			return pagination.Token(""), nil
		}

		if opts.Limit > 0 && gotItems >= opts.Limit {
			return pagination.Token(nextToken), nil
		}

		pageMaxSize = pagination.CalculatePageSize(pagination.Calculation{
			GotItems:    gotItems,
			MaxItems:    opts.Limit,
			MaxPageSize: len(res.Payload.GrafanaDashboards),
		})
	}
}

func newGrafanaDashboardListCmd() *cobra.Command {
	var listOptions GrafanaDashboardListOpts
	clientFlags := client.NewClientFlags()
	outputFlags := output.NewFlags()

	cmd := &cobra.Command{
		Use:     "list",
		Short:   "Lists all GrafanaDashboards and applies optional filters",
		GroupID: groups.Commands.ID,
		RunE: func(cmd *cobra.Command, args []string) error {
			ctx, cancel := context.WithTimeout(cmd.Context(), clientFlags.Timeout())
			defer cancel()
			if err := outputFlags.Validate(); err != nil {
				return err
			}

			writer, err := outputFlags.NewWriterManager(cmd.OutOrStdout())
			if err != nil {
				return err
			}
			defer writer.Close()

			client, err := clientFlags.ConfigV1Client()
			if err != nil {
				return err
			}

			streamer := output.NewWriteObjectStreamer[*GrafanaDashboard](writer)
			nextToken, err := ListGrafanaDashboards(ctx, client, streamer, listOptions)
			if err != nil {
				return err
			}

			if nextToken != "" {
				nextPage := pagination.Result{
					Kind:          pagination.ResultKind,
					Message:       "There are additional grafanaDashboards. To view more, use the next page token or run the full command.",
					NextPageToken: nextToken,
					FullCommand: fmt.Sprintf("%s --page-token %q",
						cli.BuildCommandString(cmd, []string{"page-token"}),
						nextToken),
				}
				if err := outputFlags.WriteObject(nextPage, cmd.OutOrStdout()); err != nil {
					return err
				}
			}

			return nil
		},
	}

	listOptions.registerFlags(cmd.Flags())
	clientFlags.AddFlags(cmd)
	outputFlags.AddFlags(cmd)

	return cmd
}

const GrafanaDashboardScaffoldYAML = `api_version: v1/config
kind: GrafanaDashboard
spec:
    # Unique identifier of the GrafanaDashboard. If slug is not provided, one will be generated based of the name field. Cannot be modified after the GrafanaDashboard is created.
    slug: <string>
    # Required name of the GrafanaDashboard. May be modified after the GrafanaDashboard is created.
    name: <string>
    # Slug of the bucket the dashboard belongs to. Required if collection_slug
    # is not set.
    bucket_slug: <string>
    # Slug of the collection the dashboard belongs to. Required if bucket_slug
    # is not set.
    collection_slug: <string>
    # Required raw JSON of the Grafana dashboard.
    dashboard_json: <string>
    collection:
        slug: <string>
        # Type values must match entitiespb.Collection.CollectionType.
        type: <SIMPLE|SERVICE>
`

func newGrafanaDashboardScaffoldCmd() *cobra.Command {
	cmd := &cobra.Command{
		Use:     "scaffold",
		GroupID: groups.Commands.ID,
		Short:   "Scaffolds a complete object with placeholder values",
		Run: func(cmd *cobra.Command, args []string) {
			fmt.Fprint(cmd.OutOrStdout(), GrafanaDashboardScaffoldYAML)
		},
	}
	return cmd
}

func NewGrafanaDashboardCmd() *cobra.Command {
	root := &cobra.Command{
		Use:     "grafana-dashboards",
		GroupID: groups.Config.ID,
		Short:   "All commands for GrafanaDashboards",
	}

	root.AddGroup(groups.Commands)
	root.AddCommand(
		newGrafanaDashboardCreateCmd(),
		newGrafanaDashboardReadCmd(),
		newGrafanaDashboardUpdateCmd(),
		newGrafanaDashboardDeleteCmd(),
		newGrafanaDashboardListCmd(),
		newGrafanaDashboardScaffoldCmd(),
	)
	return root
}