kubevela/references/cli/workflow.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"
	"os"

	"github.com/spf13/cobra"
	k8stypes "k8s.io/apimachinery/pkg/types"

	pkgmulticluster "github.com/kubevela/pkg/multicluster"

	common2 "github.com/oam-dev/kubevela/apis/core.oam.dev/common"
	"github.com/oam-dev/kubevela/apis/core.oam.dev/v1beta1"
	"github.com/oam-dev/kubevela/apis/types"
	"github.com/oam-dev/kubevela/pkg/oam"
	"github.com/oam-dev/kubevela/pkg/utils/common"
	cmdutil "github.com/oam-dev/kubevela/pkg/utils/util"
	"github.com/oam-dev/kubevela/pkg/workflow/operation"
	"github.com/oam-dev/kubevela/references/appfile"
)

// NewWorkflowCommand create `workflow` command
func NewWorkflowCommand(c common.Args, ioStreams cmdutil.IOStreams) *cobra.Command {
	cmd := &cobra.Command{
		Use:   "workflow",
		Short: "Operate application delivery workflow.",
		Long:  "Operate the Workflow during Application Delivery.",
		Annotations: map[string]string{
			types.TagCommandType: types.TypeCD,
		},
	}
	cmd.AddCommand(
		NewWorkflowSuspendCommand(c, ioStreams),
		NewWorkflowResumeCommand(c, ioStreams),
		NewWorkflowTerminateCommand(c, ioStreams),
		NewWorkflowRestartCommand(c, ioStreams),
		NewWorkflowRollbackCommand(c, ioStreams),
	)
	return cmd
}

// NewWorkflowSuspendCommand create workflow suspend command
func NewWorkflowSuspendCommand(c common.Args, ioStream cmdutil.IOStreams) *cobra.Command {
	cmd := &cobra.Command{
		Use:     "suspend",
		Short:   "Suspend an application workflow.",
		Long:    "Suspend an application workflow in cluster.",
		Example: "vela workflow suspend <application-name>",
		PreRun:  checkApplicationNotRunning(c),
		RunE: func(cmd *cobra.Command, args []string) error {
			if len(args) < 1 {
				return fmt.Errorf("must specify application name")
			}
			namespace, err := GetFlagNamespaceOrEnv(cmd, c)
			if err != nil {
				return err
			}
			app, err := appfile.LoadApplication(namespace, args[0], c)
			if err != nil {
				return err
			}

			config, err := c.GetConfig()
			if err != nil {
				return err
			}
			config.Wrap(pkgmulticluster.NewTransportWrapper())
			cli, err := c.GetClient()
			if err != nil {
				return err
			}

			wo := operation.NewWorkflowOperator(cli, cmd.OutOrStdout())
			return wo.Suspend(context.Background(), app)
		},
	}
	addNamespaceAndEnvArg(cmd)
	return cmd
}

// NewWorkflowResumeCommand create workflow resume command
func NewWorkflowResumeCommand(c common.Args, ioStream cmdutil.IOStreams) *cobra.Command {
	cmd := &cobra.Command{
		Use:     "resume",
		Short:   "Resume a suspend application workflow.",
		Long:    "Resume a suspend application workflow in cluster.",
		Example: "vela workflow resume <application-name>",
		PreRun:  checkApplicationNotRunning(c),
		RunE: func(cmd *cobra.Command, args []string) error {
			if len(args) < 1 {
				return fmt.Errorf("must specify application name")
			}
			namespace, err := GetFlagNamespaceOrEnv(cmd, c)
			if err != nil {
				return err
			}
			app, err := appfile.LoadApplication(namespace, args[0], c)
			if err != nil {
				return err
			}

			config, err := c.GetConfig()
			if err != nil {
				return err
			}
			config.Wrap(pkgmulticluster.NewTransportWrapper())
			cli, err := c.GetClient()
			if err != nil {
				return err
			}

			wo := operation.NewWorkflowOperator(cli, cmd.OutOrStdout())
			return wo.Resume(context.Background(), app)
		},
	}
	addNamespaceAndEnvArg(cmd)
	return cmd
}

// NewWorkflowTerminateCommand create workflow terminate command
func NewWorkflowTerminateCommand(c common.Args, ioStream cmdutil.IOStreams) *cobra.Command {
	cmd := &cobra.Command{
		Use:     "terminate",
		Short:   "Terminate an application workflow.",
		Long:    "Terminate an application workflow in cluster.",
		Example: "vela workflow terminate <application-name>",
		PreRun:  checkApplicationNotRunning(c),
		RunE: func(cmd *cobra.Command, args []string) error {
			if len(args) < 1 {
				return fmt.Errorf("must specify application name")
			}
			namespace, err := GetFlagNamespaceOrEnv(cmd, c)
			if err != nil {
				return err
			}
			app, err := appfile.LoadApplication(namespace, args[0], c)
			if err != nil {
				return err
			}
			if app.Status.Workflow == nil {
				return fmt.Errorf("the workflow in application is not running")
			}
			cli, err := c.GetClient()
			if err != nil {
				return err
			}
			wo := operation.NewWorkflowOperator(cli, cmd.OutOrStdout())
			return wo.Terminate(context.Background(), app)
		},
	}
	addNamespaceAndEnvArg(cmd)
	return cmd
}

// NewWorkflowRestartCommand create workflow restart command
func NewWorkflowRestartCommand(c common.Args, ioStream cmdutil.IOStreams) *cobra.Command {
	cmd := &cobra.Command{
		Use:     "restart",
		Short:   "Restart an application workflow.",
		Long:    "Restart an application workflow in cluster.",
		Example: "vela workflow restart <application-name>",
		PreRun:  checkApplicationNotRunning(c),
		RunE: func(cmd *cobra.Command, args []string) error {
			if len(args) < 1 {
				return fmt.Errorf("must specify application name")
			}
			namespace, err := GetFlagNamespaceOrEnv(cmd, c)
			if err != nil {
				return err
			}
			app, err := appfile.LoadApplication(namespace, args[0], c)
			if err != nil {
				return err
			}
			config, err := c.GetConfig()
			if err != nil {
				return err
			}
			config.Wrap(pkgmulticluster.NewTransportWrapper())
			cli, err := c.GetClient()
			if err != nil {
				return err
			}

			wo := operation.NewWorkflowOperator(cli, cmd.OutOrStdout())
			return wo.Restart(context.Background(), app)
		},
	}
	addNamespaceAndEnvArg(cmd)
	return cmd
}

// NewWorkflowRollbackCommand create workflow rollback command
func NewWorkflowRollbackCommand(c common.Args, ioStream cmdutil.IOStreams) *cobra.Command {
	cmd := &cobra.Command{
		Use:     "rollback",
		Short:   "Rollback an application workflow to the latest revision.",
		Long:    "Rollback an application workflow to the latest revision.",
		Example: "vela workflow rollback <application-name>",
		RunE: func(cmd *cobra.Command, args []string) error {
			if len(args) < 1 {
				return fmt.Errorf("must specify application name")
			}
			namespace, err := GetFlagNamespaceOrEnv(cmd, c)
			if err != nil {
				return err
			}
			app, err := appfile.LoadApplication(namespace, args[0], c)
			if err != nil {
				return err
			}
			config, err := c.GetConfig()
			if err != nil {
				return err
			}
			config.Wrap(pkgmulticluster.NewTransportWrapper())
			cli, err := c.GetClient()
			if err != nil {
				return err
			}
			if app.Status.Workflow != nil && !app.Status.Workflow.Terminated && !app.Status.Workflow.Suspend && !app.Status.Workflow.Finished {
				return fmt.Errorf("can not rollback a running workflow")
			}
			if oam.GetPublishVersion(app) == "" {
				if app.Status.LatestRevision == nil || app.Status.LatestRevision.Name == "" {
					return fmt.Errorf("the latest revision is not set: %s", app.Name)
				}
				// get the last revision
				revision := &v1beta1.ApplicationRevision{}
				if err := cli.Get(context.TODO(), k8stypes.NamespacedName{Name: app.Status.LatestRevision.Name, Namespace: app.Namespace}, revision); err != nil {
					return fmt.Errorf("failed to get the latest revision: %w", err)
				}

				app.Spec = revision.Spec.Application.Spec
				if err := cli.Status().Update(context.TODO(), app); err != nil {
					return err
				}

				fmt.Printf("Successfully rollback workflow to the latest revision: %s\n", app.Name)
				return nil
			}
			wo := operation.NewWorkflowOperator(cli, cmd.OutOrStdout())
			return wo.Rollback(context.Background(), app)
		},
	}
	addNamespaceAndEnvArg(cmd)
	return cmd
}

func checkApplicationNotRunning(c common.Args) func(cmd *cobra.Command, args []string) {
	return func(cmd *cobra.Command, args []string) {
		// Any error will be returned to let the normal execution report the error
		if len(args) < 1 {
			return
		}
		namespace, err := GetFlagNamespaceOrEnv(cmd, c)
		if err != nil {
			return
		}
		app, err := appfile.LoadApplication(namespace, args[0], c)
		if err != nil {
			return
		}
		if app.Status.Phase == common2.ApplicationRunning {
			cmd.Printf("%s workflow not allowed because application %s is running\n", cmd.Use, args[0])
			os.Exit(1)
		}
	}
}