feat: enhance playbook execution and query handling

- Added a new optional query parameter `promise` to the playbook and inventory endpoints, allowing for asynchronous execution control.
- Introduced a new result state `ResultPending` to indicate ongoing operations.
- Refactored the executor function to handle the `promise` parameter, enabling conditional execution of playbooks.
- Improved error handling and logging during playbook execution.

Signed-off-by: joyceliu <joyceliu@yunify.com>

Author: redscholar

pkg/web/api/result.go

@@ -31,6 +31,8 @@ const (
 	ResultSucceed = "success"
 	// ResultFailed indicates a failed operation result.
 	ResultFailed = "failed"
+	// ResultPending indicates a pending operation result.
+	ResultPending = "pending"
 )
 
 // SUCCESS is a global variable representing a successful operation result with a default success message.

pkg/web/handler/executor.go

@@ -26,46 +26,57 @@ type manager struct {
 	manager map[string]context.CancelFunc // Map of playbook key to its cancel function
 }
 
-func (m *manager) executor(playbook *kkcorev1.Playbook, client ctrlclient.Client) error {
-	// Build the log file path for the playbook execution
-	filename := filepath.Join(
-		_const.GetWorkdirFromConfig(playbook.Spec.Config),
-		_const.RuntimeDir,
-		kkcorev1.SchemeGroupVersion.Group,
-		kkcorev1.SchemeGroupVersion.Version,
-		"playbooks",
-		playbook.Namespace,
-		playbook.Name,
-		playbook.Name+".log",
-	)
-	// Ensure the directory for the log file exists
-	if _, err := os.Stat(filepath.Dir(filename)); err != nil {
-		if !os.IsNotExist(err) {
-			return errors.Wrapf(err, "failed to stat playbook dir %q", filepath.Dir(filename))
+func (m *manager) executor(playbook *kkcorev1.Playbook, client ctrlclient.Client, promise string) error {
+	f := func() error {
+		// Build the log file path for the playbook execution
+		filename := filepath.Join(
+			_const.GetWorkdirFromConfig(playbook.Spec.Config),
+			_const.RuntimeDir,
+			kkcorev1.SchemeGroupVersion.Group,
+			kkcorev1.SchemeGroupVersion.Version,
+			"playbooks",
+			playbook.Namespace,
+			playbook.Name,
+			playbook.Name+".log",
+		)
+		// Ensure the directory for the log file exists
+		if _, err := os.Stat(filepath.Dir(filename)); err != nil {
+			if !os.IsNotExist(err) {
+				return errors.Wrapf(err, "failed to stat playbook dir %q", filepath.Dir(filename))
+			}
+			// If directory does not exist, create it
+			if err := os.MkdirAll(filepath.Dir(filename), os.ModePerm); err != nil {
+				return errors.Wrapf(err, "failed to create playbook dir %q", filepath.Dir(filename))
+			}
 		}
-		// If directory does not exist, create it
-		if err := os.MkdirAll(filepath.Dir(filename), os.ModePerm); err != nil {
-			return errors.Wrapf(err, "failed to create playbook dir %q", filepath.Dir(filename))
+		// Open the log file for writing
+		file, err := os.OpenFile(filename, os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
+		if err != nil {
+			return errors.Wrapf(err, "failed to open log file", "file", filename)
 		}
-	}
-	// Open the log file for writing
-	file, err := os.OpenFile(filename, os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
-	if err != nil {
-		return errors.Wrapf(err, "failed to open log file", "file", filename)
-	}
-	defer file.Close()
+		defer file.Close()
 
-	// Create a cancellable context for playbook execution
-	ctx, cancel := context.WithCancel(context.Background())
-	// Register the playbook and its cancel function in the playbookManager
-	m.addPlaybook(playbook, cancel)
-	// Execute the playbook and write output to the log file
-	if err := executor.NewPlaybookExecutor(ctx, client, playbook, file).Exec(ctx); err != nil {
-		klog.ErrorS(err, "failed to exec playbook", "playbook", playbook.Name)
+		// Create a cancellable context for playbook execution
+		ctx, cancel := context.WithCancel(context.Background())
+		// Register the playbook and its cancel function in the playbookManager
+		m.addPlaybook(playbook, cancel)
+		// Execute the playbook and write output to the log file
+		if err := executor.NewPlaybookExecutor(ctx, client, playbook, file).Exec(ctx); err != nil {
+			klog.ErrorS(err, "failed to exec playbook", "playbook", playbook.Name)
+		}
+		// Remove the playbook from the playbookManager after execution
+		m.deletePlaybook(playbook)
+		return nil
+	}
+	if promise == "true" {
+		go func() {
+			if err := f(); err != nil {
+				klog.ErrorS(err, "failed to execute playbook", "playbook", ctrlclient.ObjectKeyFromObject(playbook))
+			}
+		}()
+		return nil
 	}
-	// Remove the playbook from the playbookManager after execution
-	m.deletePlaybook(playbook)
-	return nil
+	return f()
 }
 
 // addPlaybook adds a playbook and its cancel function to the manager map.

pkg/web/handler/inventory.go

@@ -43,11 +43,11 @@ func NewInventoryHandler(workdir string, restconfig *rest.Config, client ctrlcli
 func (h *InventoryHandler) Post(request *restful.Request, response *restful.Response) {
 	inventory := &kkcorev1.Inventory{}
 	if err := request.ReadEntity(inventory); err != nil {
-		api.HandleBadRequest(response, request, err)
+		api.HandleError(response, request, err)
 		return
 	}
 	if err := h.client.Create(request.Request.Context(), inventory); err != nil {
-		api.HandleBadRequest(response, request, err)
+		api.HandleError(response, request, err)
 		return
 	}
 
@@ -61,21 +61,21 @@ func (h *InventoryHandler) Patch(request *restful.Request, response *restful.Res
 	name := request.PathParameter("inventory")
 	data, err := io.ReadAll(request.Request.Body)
 	if err != nil {
-		api.HandleBadRequest(response, request, err)
+		api.HandleError(response, request, err)
 		return
 	}
 	patchType := request.HeaderParameter("Content-Type")
 
 	// Get the existing inventory object.
 	inventory := &kkcorev1.Inventory{}
 	if err := h.client.Get(request.Request.Context(), ctrlclient.ObjectKey{Namespace: namespace, Name: name}, inventory); err != nil {
-		api.HandleBadRequest(response, request, err)
+		api.HandleError(response, request, err)
 		return
 	}
 
 	// Apply the patch.
 	if err := h.client.Patch(request.Request.Context(), inventory, ctrlclient.RawPatch(types.PatchType(patchType), data)); err != nil {
-		api.HandleBadRequest(response, request, err)
+		api.HandleError(response, request, err)
 		return
 	}
 	// create host-check playbook
@@ -98,28 +98,27 @@ func (h *InventoryHandler) Patch(request *restful.Request, response *restful.Res
 	}
 	// Set the workdir in the playbook's spec config
 	if err := unstructured.SetNestedField(playbook.Spec.Config.Value(), h.workdir, _const.Workdir); err != nil {
-		api.HandleBadRequest(response, request, err)
+		api.HandleError(response, request, err)
 		return
 	}
 	if err := h.client.Create(request.Request.Context(), playbook); err != nil {
-		api.HandleBadRequest(response, request, errors.Wrap(err, "failed to create hostcheck playbook"))
+		api.HandleError(response, request, errors.Wrap(err, "failed to create hostcheck playbook"))
 		return
 	}
 
 	// Execute the playbook asynchronously.
-	if err := playbookManager.executor(playbook, h.client); err != nil {
-		api.HandleBadRequest(response, request, errors.Wrap(err, "failed to execute hostcheck playbook"))
+	if err := playbookManager.executor(playbook, h.client, query.DefaultString(request.QueryParameter("promise"), "true")); err != nil {
+		api.HandleError(response, request, errors.Wrap(err, "failed to execute hostcheck playbook"))
 		return
 	}
-
 	// update inventory annotation
 	old := inventory.DeepCopy()
 	if inventory.Annotations == nil {
 		inventory.Annotations = make(map[string]string)
 	}
 	inventory.Annotations[kkcorev1.HostCheckPlaybookAnnotation] = playbook.Name
 	if err := h.client.Patch(request.Request.Context(), inventory, ctrlclient.MergeFrom(old)); err != nil {
-		api.HandleBadRequest(response, request, errors.Wrap(err, "failed to execute hostcheck playbook"))
+		api.HandleError(response, request, errors.Wrap(err, "failed to execute hostcheck playbook"))
 		return
 	}
 
@@ -133,18 +132,17 @@ func (h *InventoryHandler) List(request *restful.Request, response *restful.Resp
 	var fieldselector fields.Selector
 	// Parse field selector from query parameters if present.
 	if v, ok := queryParam.Filters[query.ParameterFieldSelector]; ok {
-		fs, err := fields.ParseSelector(string(v))
+		fs, err := fields.ParseSelector(v)
 		if err != nil {
 			api.HandleError(response, request, err)
 			return
 		}
 		fieldselector = fs
 	}
-	namespace := request.PathParameter("namespace")
 
 	inventoryList := &kkcorev1.InventoryList{}
 	// List inventory resources from the Kubernetes API.
-	err := h.client.List(request.Request.Context(), inventoryList, &ctrlclient.ListOptions{Namespace: namespace, LabelSelector: queryParam.Selector(), FieldSelector: fieldselector})
+	err := h.client.List(request.Request.Context(), inventoryList, &ctrlclient.ListOptions{Namespace: request.PathParameter("namespace"), LabelSelector: queryParam.Selector(), FieldSelector: fieldselector})
 	if err != nil {
 		api.HandleError(response, request, err)
 		return
@@ -202,7 +200,6 @@ func (h *InventoryHandler) ListHosts(request *restful.Request, response *restful
 	queryParam := query.ParseQueryParameter(request)
 	namespace := request.PathParameter("namespace")
 	name := request.PathParameter("inventory")
-
 	// Retrieve the inventory object from the cluster.
 	inventory := &kkcorev1.Inventory{}
 	err := h.client.Get(request.Request.Context(), ctrlclient.ObjectKey{Namespace: namespace, Name: name}, inventory)
@@ -287,6 +284,8 @@ func (h *InventoryHandler) ListHosts(request *restful.Request, response *restful
 	fillByPlaybook := func(playbook kkcorev1.Playbook, item *api.InventoryHostTable) {
 		// Set status and architecture based on playbook phase and result.
 		switch playbook.Status.Phase {
+		case kkcorev1.PlaybookPhasePending, kkcorev1.PlaybookPhaseRunning:
+			item.Status = api.ResultPending
 		case kkcorev1.PlaybookPhaseFailed:
 			item.Status = api.ResultFailed
 		case kkcorev1.PlaybookPhaseSucceeded:
@@ -321,7 +320,7 @@ func (h *InventoryHandler) ListHosts(request *restful.Request, response *restful
 		val := query.GetFieldByJSONTag(reflect.ValueOf(o), f.Field)
 		switch val.Kind() {
 		case reflect.String:
-			return strings.Contains(val.String(), string(f.Value))
+			return strings.Contains(val.String(), f.Value)
 		default:
 			return true
 		}

pkg/web/handler/playbook.go

@@ -4,7 +4,6 @@ import (
 	"bufio"
 	"context"
 	"encoding/json"
-	"errors"
 	"fmt"
 	"io"
 	"net/http"
@@ -13,14 +12,15 @@ import (
 	"strings"
 	"time"
 
+	"github.com/cockroachdb/errors"
 	"github.com/emicklei/go-restful/v3"
 	kkcorev1 "github.com/kubesphere/kubekey/api/core/v1"
 	kkcorev1alpha1 "github.com/kubesphere/kubekey/api/core/v1alpha1"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/api/meta"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/fields"
 	"k8s.io/client-go/rest"
-	"k8s.io/klog/v2"
 	ctrlclient "sigs.k8s.io/controller-runtime/pkg/client"
 
 	_const "github.com/kubesphere/kubekey/v4/pkg/const"
@@ -46,7 +46,7 @@ func (h *PlaybookHandler) Post(request *restful.Request, response *restful.Respo
 	playbook := &kkcorev1.Playbook{}
 	// Read the playbook entity from the request body
 	if err := request.ReadEntity(playbook); err != nil {
-		api.HandleBadRequest(response, request, err)
+		api.HandleError(response, request, err)
 		return
 	}
 
@@ -73,7 +73,7 @@ func (h *PlaybookHandler) Post(request *restful.Request, response *restful.Respo
 		if err := h.client.List(request.Request.Context(), playbookList, ctrlclient.MatchingLabels{
 			labelKey: labelValue,
 		}); err != nil {
-			api.HandleBadRequest(response, request, err)
+			api.HandleError(response, request, err)
 			return
 		}
 		// If any playbook with the same schema label exists, this is a conflict
@@ -85,22 +85,20 @@ func (h *PlaybookHandler) Post(request *restful.Request, response *restful.Respo
 
 	// Set the workdir in the playbook's spec config
 	if err := unstructured.SetNestedField(playbook.Spec.Config.Value(), h.workdir, _const.Workdir); err != nil {
-		api.HandleBadRequest(response, request, err)
+		api.HandleError(response, request, err)
 		return
 	}
 	playbook.Status.Phase = kkcorev1.PlaybookPhasePending
 	// Create the playbook resource in Kubernetes
 	if err := h.client.Create(context.TODO(), playbook); err != nil {
-		api.HandleBadRequest(response, request, err)
+		api.HandleError(response, request, err)
 		return
 	}
 	// Start playbook execution in a separate goroutine
-	go func() {
-		if err := playbookManager.executor(playbook, h.client); err != nil {
-			klog.ErrorS(err, "failed to executor playbook", "playbook", ctrlclient.ObjectKeyFromObject(playbook))
-		}
-	}()
-
+	if err := playbookManager.executor(playbook, h.client, query.DefaultString(request.QueryParameter("promise"), "true")); err != nil {
+		api.HandleError(response, request, errors.Wrap(err, "failed to execute playbook"))
+		return
+	}
 	// For web UI: it does not run in Kubernetes, so execute playbook immediately.
 	_ = response.WriteEntity(playbook)
 }
@@ -112,23 +110,20 @@ func (h *PlaybookHandler) List(request *restful.Request, response *restful.Respo
 	var fieldselector fields.Selector
 	// Parse field selector from query parameters if present.
 	if v, ok := queryParam.Filters[query.ParameterFieldSelector]; ok {
-		fs, err := fields.ParseSelector(string(v))
+		fs, err := fields.ParseSelector(v)
 		if err != nil {
 			api.HandleError(response, request, err)
 			return
 		}
 		fieldselector = fs
 	}
-	namespace := request.PathParameter("namespace")
-
 	playbookList := &kkcorev1.PlaybookList{}
 	// List playbooks from the Kubernetes API with the specified options.
-	err := h.client.List(request.Request.Context(), playbookList, &ctrlclient.ListOptions{Namespace: namespace, LabelSelector: queryParam.Selector(), FieldSelector: fieldselector})
+	err := h.client.List(request.Request.Context(), playbookList, &ctrlclient.ListOptions{Namespace: request.PathParameter("namespace"), LabelSelector: queryParam.Selector(), FieldSelector: fieldselector})
 	if err != nil {
 		api.HandleError(response, request, err)
 		return
 	}
-
 	// Sort and filter the playbook list using DefaultList.
 	results := query.DefaultList(playbookList.Items, queryParam, func(left, right kkcorev1.Playbook, sortBy string) bool {
 		leftMeta, err := meta.Accessor(left)
@@ -267,7 +262,11 @@ func (h *PlaybookHandler) Delete(request *restful.Request, response *restful.Res
 	// Retrieve the playbook resource to delete.
 	err := h.client.Get(request.Request.Context(), ctrlclient.ObjectKey{Namespace: namespace, Name: name}, playbook)
 	if err != nil {
-		api.HandleError(response, request, err)
+		if apierrors.IsNotFound(err) {
+			response.WriteEntity(api.SUCCESS)
+		} else {
+			api.HandleError(response, request, err)
+		}
 		return
 	}
 	// Stop the playbook execution if it is running.