kubevela/references/cli/debug.go

/*
Copyright 2021 The KubeVela Authors.

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 cli

import (
	"context"
	"fmt"
	"strings"

	"cuelang.org/go/cue"
	"cuelang.org/go/cue/cuecontext"
	"github.com/AlecAivazis/survey/v2"
	"github.com/FogDong/uitable"
	"github.com/fatih/color"
	"github.com/pkg/errors"
	"github.com/spf13/cobra"
	corev1 "k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
	"sigs.k8s.io/controller-runtime/pkg/client"
	"sigs.k8s.io/yaml"

	workflowv1alpha1 "github.com/kubevela/workflow/api/v1alpha1"
	"github.com/kubevela/workflow/pkg/cue/model/sets"
	"github.com/kubevela/workflow/pkg/debug"
	wfTypes "github.com/kubevela/workflow/pkg/types"

	"github.com/oam-dev/kubevela/apis/types"
	"github.com/oam-dev/kubevela/pkg/appfile/dryrun"
	"github.com/oam-dev/kubevela/pkg/utils/common"
	cmdutil "github.com/oam-dev/kubevela/pkg/utils/util"
)

type debugOpts struct {
	step   string
	focus  string
	errMsg string
	opts   []string
	errMap map[string]string
	// TODO: (fog) add watch flag
	// watch bool
}

// NewDebugCommand create `debug` command
func NewDebugCommand(c common.Args, order string, ioStreams cmdutil.IOStreams) *cobra.Command {
	ctx := context.Background()
	dOpts := &debugOpts{}
	wargs := &WorkflowArgs{
		Args:   c,
		Writer: ioStreams.Out,
	}
	cmd := &cobra.Command{
		Use:     "debug",
		Aliases: []string{"debug"},
		Short:   "Debug running application.",
		Long:    "Debug running application with debug policy.",
		Example: `vela debug <application-name>`,
		Annotations: map[string]string{
			types.TagCommandType:  types.TypeApp,
			types.TagCommandOrder: order,
		},
		PreRun: wargs.checkDebugMode(),
		RunE: func(cmd *cobra.Command, args []string) error {
			if len(args) < 1 {
				return fmt.Errorf("must specify application name")
			}
			if err := wargs.getWorkflowInstance(ctx, cmd, args); err != nil {
				return err
			}
			if wargs.Type == instanceTypeWorkflowRun {
				return fmt.Errorf("please use `vela workflow debug <name>` instead")
			}
			if wargs.App == nil {
				return fmt.Errorf("application %s not found", args[0])
			}

			return dOpts.debugApplication(ctx, wargs, c, ioStreams)
		},
	}
	addNamespaceAndEnvArg(cmd)
	cmd.Flags().StringVarP(&dOpts.step, "step", "s", "", "specify the step or component to debug")
	cmd.Flags().StringVarP(&dOpts.focus, "focus", "f", "", "specify the focus value to debug, only valid for application with workflow")
	return cmd
}

func (d *debugOpts) debugApplication(ctx context.Context, wargs *WorkflowArgs, c common.Args, ioStreams cmdutil.IOStreams) error {
	app := wargs.App
	cli, err := c.GetClient()
	if err != nil {
		return err
	}
	config, err := c.GetConfig()
	if err != nil {
		return err
	}
	d.opts = wargs.getWorkflowSteps()
	d.errMap = wargs.ErrMap
	if app.Spec.Workflow != nil && len(app.Spec.Workflow.Steps) > 0 {
		return d.debugWorkflow(ctx, wargs, cli, ioStreams)
	}

	dryRunOpt := dryrun.NewDryRunOption(cli, config, []*unstructured.Unstructured{}, false)
	comps, _, err := dryRunOpt.ExecuteDryRun(ctx, app)
	if err != nil {
		ioStreams.Info(color.RedString("%s%s", emojiFail, err.Error()))
		return nil
	}
	return d.debugComponents(comps, ioStreams)
}

func (d *debugOpts) debugWorkflow(ctx context.Context, wargs *WorkflowArgs, cli client.Client, ioStreams cmdutil.IOStreams) error {
	if d.step == "" {
		prompt := &survey.Select{
			Message: "Select the workflow step to debug:",
			Options: d.opts,
		}
		var step string
		err := survey.AskOne(prompt, &step, survey.WithValidator(survey.Required))
		if err != nil {
			return fmt.Errorf("failed to select workflow step: %w", err)
		}
		d.step = unwrapStepID(step, wargs.WorkflowInstance)
		d.errMsg = d.errMap[d.step]
	} else {
		d.step = unwrapStepID(d.step, wargs.WorkflowInstance)
	}

	// debug workflow steps
	rawValue, data, err := d.getDebugRawValue(ctx, cli, wargs.WorkflowInstance)
	if err != nil {
		if data != "" {
			ioStreams.Info(color.RedString("%s%s", emojiFail, err.Error()))
			ioStreams.Info(color.GreenString("Original Data in Debug:\n"), data)
			return nil
		}
		return err
	}

	if err := d.handleCueSteps(rawValue, ioStreams); err != nil {
		ioStreams.Info(color.RedString("%s%s", emojiFail, err.Error()))
		ioStreams.Info(color.GreenString("Original Data in Debug:\n"), data)
		return nil
	}
	return nil
}

func (d *debugOpts) debugComponents(comps []*types.ComponentManifest, ioStreams cmdutil.IOStreams) error {
	opts := d.opts
	all := color.YellowString("all fields")
	exit := color.CyanString("exit debug mode")
	opts = append(opts, all, exit)

	var components = make(map[string]*unstructured.Unstructured)
	var traits = make(map[string][]*unstructured.Unstructured)
	for _, comp := range comps {
		components[comp.Name] = comp.ComponentOutput
		traits[comp.Name] = comp.ComponentOutputsAndTraits
	}

	if d.step != "" {
		return renderComponents(d.step, components[d.step], traits[d.step], ioStreams)
	}
	for {
		prompt := &survey.Select{
			Message: "Select the components to debug:",
			Options: opts,
		}
		var step string
		err := survey.AskOne(prompt, &step, survey.WithValidator(survey.Required))
		if err != nil {
			return fmt.Errorf("failed to select components: %w", err)
		}

		if step == exit {
			break
		}
		if step == all {
			for _, step := range d.opts {
				step = unwrapStepName(step)
				if err := renderComponents(step, components[step], traits[step], ioStreams); err != nil {
					return err
				}
			}
			continue
		}
		step = unwrapStepName(step)
		if err := renderComponents(step, components[step], traits[step], ioStreams); err != nil {
			return err
		}
	}
	return nil
}

func renderComponents(compName string, comp *unstructured.Unstructured, traits []*unstructured.Unstructured, ioStreams cmdutil.IOStreams) error {
	ioStreams.Info(color.CyanString("\n▫️ %s", compName))
	result, err := yaml.Marshal(comp)
	if err != nil {
		return errors.WithMessage(err, "marshal result for component "+compName+" object in yaml format")
	}
	ioStreams.Info(string(result), "\n")
	for _, t := range traits {
		result, err := yaml.Marshal(t)
		if err != nil {
			return errors.WithMessage(err, "marshal result for component "+compName+" object in yaml format")
		}
		ioStreams.Info(string(result), "\n")
	}
	return nil
}

func wrapStepName(step workflowv1alpha1.StepStatus) string {
	var stepName string
	switch step.Phase {
	case workflowv1alpha1.WorkflowStepPhaseSucceeded:
		stepName = emojiSucceed + step.Name
	case workflowv1alpha1.WorkflowStepPhaseFailed:
		stepName = emojiFail + step.Name
	case workflowv1alpha1.WorkflowStepPhaseSkipped:
		stepName = emojiSkip + step.Name
	default:
		stepName = emojiExecuting + step.Name
	}
	return stepName
}

func unwrapStepName(step string) string {
	step = strings.TrimPrefix(step, "  ")
	switch {
	case strings.HasPrefix(step, emojiSucceed):
		return strings.TrimPrefix(step, emojiSucceed)
	case strings.HasPrefix(step, emojiFail):
		return strings.TrimPrefix(step, emojiFail)
	case strings.HasPrefix(step, emojiSkip):
		return strings.TrimPrefix(step, emojiSkip)
	case strings.HasPrefix(step, emojiExecuting):
		return strings.TrimPrefix(step, emojiExecuting)
	default:
		return step
	}
}

func unwrapStepID(step string, instance *wfTypes.WorkflowInstance) string {
	step = unwrapStepName(step)
	for _, status := range instance.Status.Steps {
		if status.Name == step {
			return status.ID
		}
		for _, sub := range status.SubStepsStatus {
			if sub.Name == step {
				return sub.ID
			}
		}
	}
	return step
}

func (d *debugOpts) getDebugRawValue(ctx context.Context, cli client.Client, instance *wfTypes.WorkflowInstance) (cue.Value, string, error) {
	debugCM := &corev1.ConfigMap{}
	if err := cli.Get(ctx, client.ObjectKey{Name: debug.GenerateContextName(instance.Name, d.step, string(instance.UID)), Namespace: instance.Namespace}, debugCM); err != nil {
		for _, step := range instance.Status.Steps {
			if step.Name == d.step && (step.Type == wfTypes.WorkflowStepTypeSuspend || step.Type == wfTypes.WorkflowStepTypeStepGroup) {
				return cue.Value{}, "", fmt.Errorf("no debug data for a suspend or step-group step, please choose another step")
			}
			for _, sub := range step.SubStepsStatus {
				if sub.Name == d.step && sub.Type == wfTypes.WorkflowStepTypeSuspend {
					return cue.Value{}, "", fmt.Errorf("no debug data for a suspend step, please choose another step")
				}
			}
		}
		return cue.Value{}, "", fmt.Errorf("failed to get debug configmap, please make sure the you're in the debug mode`: %w", err)
	}

	if debugCM.Data == nil || debugCM.Data["debug"] == "" {
		return cue.Value{}, "", fmt.Errorf("debug configmap is empty")
	}
	v := cuecontext.New().CompileString(debugCM.Data["debug"])
	if v.Err() != nil {
		return cue.Value{}, debugCM.Data["debug"], fmt.Errorf("failed to parse debug configmap: %w", v.Err())
	}
	return v, debugCM.Data["debug"], nil
}

func (d *debugOpts) handleCueSteps(v cue.Value, ioStreams cmdutil.IOStreams) error {
	if d.focus != "" {
		f := v.LookupPath(cue.ParsePath(d.focus))
		if f.Err() != nil {
			return f.Err()
		}
		ioStreams.Info(color.New(color.FgCyan).Sprint("\n", d.focus, "\n"))
		rendered, err := renderFields(f, &renderOptions{})
		if err != nil {
			return err
		}
		ioStreams.Info(rendered, "\n")
		return nil
	}

	return d.separateBySteps(v, ioStreams)
}

func (d *debugOpts) separateBySteps(v cue.Value, ioStreams cmdutil.IOStreams) error {
	fieldMap := make(map[string]cue.Value)
	fieldList := make([]string, 0)
	it, err := v.Fields(cue.Optional(true), cue.Hidden(true))
	if err != nil {
		return fmt.Errorf("failed to get fields: %w", err)
	}
	for it.Next() {
		if it.Value().IncompleteKind() == cue.BottomKind {
			break
		}
		fieldName := it.Selector().String()
		fieldList = append(fieldList, fieldName)
		fieldMap[fieldName] = it.Value()
	}

	errStep := ""
	if d.errMsg != "" {
		s := strings.Split(d.errMsg, ":")
		errStep = strings.TrimPrefix(s[0], "step ")
	}
	opts := make([]string, 0)
	for _, field := range fieldList {
		if field == errStep {
			opts = append(opts, emojiFail+field)
		} else {
			opts = append(opts, emojiSucceed+field)
		}
	}
	all := color.YellowString("all fields")
	exit := color.CyanString("exit debug mode")
	opts = append(opts, all, exit)
	for {
		prompt := &survey.Select{
			Message: "Select the field to debug: ",
			Options: opts,
		}
		var field string
		err := survey.AskOne(prompt, &field, survey.WithValidator(survey.Required))
		if err != nil {
			return fmt.Errorf("failed to select: %w", err)
		}
		if field == exit {
			break
		}
		if field == all {
			for _, field := range fieldList {
				ioStreams.Info(color.CyanString("\n▫️ %s", field))
				rendered, err := renderFields(fieldMap[field], &renderOptions{})
				if err != nil {
					return err
				}
				ioStreams.Info(rendered, "\n")
			}
			continue
		}
		field = unwrapStepName(field)
		ioStreams.Info(color.CyanString("\n▫️ %s", field))
		rendered, err := renderFields(fieldMap[field], &renderOptions{})
		if err != nil {
			return err
		}
		ioStreams.Info(rendered, "\n")
	}
	return nil
}

type renderOptions struct {
	hideIndex    bool
	filterFields []string
}

func renderFields(v cue.Value, opt *renderOptions) (string, error) {
	table := uitable.New()
	table.MaxColWidth = 200
	table.Wrap = true
	i := 0

	it, err := v.Fields(cue.Optional(true), cue.Hidden(true))
	if err != nil {
		return "", fmt.Errorf("failed to get fields: %w", err)
	}
	for it.Next() {
		in := it.Value()
		fieldName := in.Path().String()
		key := ""
		if in.LookupPath(cue.ParsePath("#do")).Exists() {
			rendered, err := renderFields(in, opt)
			if err != nil {
				continue
			}
			i++
			if !opt.hideIndex {
				key += fmt.Sprintf("%v.", i)
			}
			key += fieldName
			if !strings.Contains(fieldName, "#") {
				v = v.FillPath(cue.ParsePath(fieldName), in)
				if v.Err() != nil {
					renderValuesInRow(table, key, rendered, false)
				}
			}
			if len(opt.filterFields) > 0 {
				for _, filter := range opt.filterFields {
					if filter != fieldName {
						renderValuesInRow(table, key, rendered, true)
					}
				}
			} else {
				renderValuesInRow(table, key, rendered, true)
			}
			continue
		}
		vStr, err := sets.ToString(in)
		if err != nil {
			continue
		}
		i++
		if !opt.hideIndex {
			key += fmt.Sprintf("%v.", i)
		}
		key += fieldName
		if !strings.Contains(fieldName, "#") {
			v = v.FillPath(cue.ParsePath(fieldName), in)
			if v.Err() != nil {
				renderValuesInRow(table, key, vStr, false)
			}
		}

		if len(opt.filterFields) > 0 {
			for _, filter := range opt.filterFields {
				if filter != fieldName {
					renderValuesInRow(table, key, vStr, true)
				}
			}
		} else {
			renderValuesInRow(table, key, vStr, true)
		}
	}
	return table.String(), nil
}

func renderValuesInRow(table *uitable.Table, k, v string, isPass bool) {
	v = strings.TrimSpace(v)
	if isPass {
		if strings.Contains(k, "#do") || strings.Contains(k, "#provider") {
			k = color.YellowString("%s:", k)
		} else {
			k = color.GreenString("%s:", k)
		}
	} else {
		k = color.RedString("%s:", k)
		v = color.RedString("%s%s", emojiFail, v)
	}
	if v == `"steps"` {
		v = color.BlueString(v)
	}

	table.AddRow(k, v)
}