feat: add confirmation dialog

Author: Enda Phelan

cmd/rhoas/main.go

@@ -91,7 +91,7 @@ func initConfig(f *factory.Factory) error {
 func rootError(err error, localizer localize.Localizer) error {
 	prefix := icon.ErrorPrefix()
 	errMessage := err.Error()
-	if prefix == icon.CrossMark {
+	if prefix == icon.ErrorSymbol {
 		errMessage = firstCharToUpper(errMessage)
 	}
 	return fmt.Errorf("%v %v. %v", icon.ErrorPrefix(), errMessage, localizer.MustLocalize("common.log.error.verboseModeHint"))

docs/commands/rhoas_kafka_acl.adoc

@@ -2,7 +2,6 @@ package acl
 
 import (
 	"github.com/redhat-developer/app-services-cli/pkg/cmd/factory"
-	"github.com/redhat-developer/app-services-cli/pkg/cmd/kafka/acl/grant"
 	"github.com/redhat-developer/app-services-cli/pkg/cmd/kafka/acl/delete"
 	"github.com/redhat-developer/app-services-cli/pkg/cmd/kafka/acl/grant"
 	"github.com/redhat-developer/app-services-cli/pkg/cmd/kafka/acl/list"

docs/commands/rhoas_kafka_acl_delete.adoc

@@ -12,7 +12,6 @@ var resourceTypeFilterMap = map[string]kafkainstanceclient.AclResourceTypeFilter
 
 var operationFilterMap = map[string]kafkainstanceclient.AclOperationFilter{
 	OperationFilterALL:              kafkainstanceclient.ACLOPERATIONFILTER_ALL,
-	OperationFilterANY:              kafkainstanceclient.ACLOPERATIONFILTER_ANY,
 	OperationFilterREAD:             kafkainstanceclient.ACLOPERATIONFILTER_READ,
 	OperationFilterWRITE:            kafkainstanceclient.ACLOPERATIONFILTER_WRITE,
 	OperationFilterCREATE:           kafkainstanceclient.ACLOPERATIONFILTER_DELETE,

pkg/cmd/kafka/acl/acl.go

@@ -23,7 +23,6 @@ const (
 
 const (
 	OperationFilterALL              = "all"
-	OperationFilterANY              = "any"
 	OperationFilterREAD             = "read"
 	OperationFilterWRITE            = "write"
 	OperationFilterCREATE           = "create"
@@ -41,9 +40,10 @@ const (
 )
 
 const (
-	TopicFlagName       = "topic"
-	GroupFlagName       = "group"
-	TransactionalIDFlag = "transactional-id"
+	ClusterFlagName         = "cluster"
+	TopicFlagName           = "topic"
+	GroupFlagName           = "group"
+	TransactionalIDFlagName = "transactional-id"
 )
 
 type flagSet struct {
@@ -157,7 +157,7 @@ func (fs *flagSet) AddConsumerGroup(group *string) {
 
 // AddTransactionalID adds a flag for setting the consumer group ID
 func (fs *flagSet) AddTransactionalID(id *string) {
-	flagName := TransactionalIDFlag
+	flagName := TransactionalIDFlagName
 
 	fs.flags.StringVar(
 		id,
@@ -179,28 +179,16 @@ func (fs *flagSet) AddPrefix(prefix *bool) {
 	)
 }
 
-// AddPatternType adds a flag to choose the ACL resource pattern type
-func (fs *flagSet) AddPatternType(patternType *string) *markRequiredOpt {
-	flagName := "pattern-type"
+// AddPrefix adds a flag for sertting the "cluster" ACL resource type
+func (fs *flagSet) AddCluster(prefix *bool) {
+	flagName := ClusterFlagName
 
-	// TODO: Add available options to description
-	fs.flags.StringVar(
-		patternType,
+	fs.flags.BoolVar(
+		prefix,
 		flagName,
-		"",
-		"Determine the pattern type of the ACL resource",
+		false,
+		"Cluster ACL resource type",
 	)
-
-	patternTypes := make([]string, 0, len(patternTypeFilterMap))
-	for i := range patternTypeFilterMap {
-		patternTypes = append(patternTypes, i)
-	}
-
-	_ = fs.cmd.RegisterFlagCompletionFunc(flagName, func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-		return patternTypes, cobra.ShellCompDirectiveNoSpace
-	})
-
-	return withMarkRequiredFunc(fs.cmd, flagName)
 }
 
 // AddUser adds a flag to pass a user ID principal

pkg/cmd/kafka/acl/common/enums.go

@@ -0,0 +1,57 @@
+package common
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/redhat-developer/app-services-cli/pkg/kafka/acl"
+	"github.com/redhat-developer/app-services-cli/pkg/localize"
+	kafkainstanceclient "github.com/redhat-developer/app-services-sdk-go/kafkainstance/apiv1internal/client"
+)
+
+type permissionsRow struct {
+	Principal   string `json:"principal,omitempty" header:"Principal"`
+	Permission  string `json:"permission,omitempty" header:"Permission"`
+	Operation   string `json:"operation,omitempty" header:"Operation"`
+	Description string `json:"description,omitempty" header:"description"`
+}
+
+func MapACLsToTable(bindings []kafkainstanceclient.AclBinding, localizer localize.Localizer) []permissionsRow {
+	rows := make([]permissionsRow, len(bindings))
+
+	for i, p := range bindings {
+
+		description := buildDescription(p.PatternType, localizer)
+		row := permissionsRow{
+			Principal:   formatPrincipal(p.GetPrincipal(), localizer),
+			Permission:  string(p.GetPermission()),
+			Operation:   string(p.GetOperation()),
+			Description: fmt.Sprintf("%s %s \"%s\"", p.GetResourceType(), description, p.GetResourceName()),
+		}
+		rows[i] = row
+	}
+	return rows
+}
+
+func formatPrincipal(principal string, localizer localize.Localizer) string {
+	s := strings.Split(principal, ":")[1]
+
+	if s == acl.Wildcard {
+		return localizer.MustLocalize("kafka.acl.list.allAccounts")
+	}
+
+	return s
+}
+
+func buildDescription(patternType kafkainstanceclient.AclPatternType, localizer localize.Localizer) string {
+	if patternType == kafkainstanceclient.ACLPATTERNTYPE_LITERAL {
+		return localizer.MustLocalize("kafka.acl.list.is")
+	}
+
+	return localizer.MustLocalize("kafka.acl.list.startsWith")
+}
+
+// FormatPrincipal formats the provided principal ID to "User:principal"
+func FormatPrincipal(userID string) string {
+	return fmt.Sprintf("User:%s", userID)
+}

pkg/cmd/kafka/acl/common/flags.go

@@ -3,18 +3,26 @@ package delete
 import (
 	"context"
 
+	"github.com/AlecAivazis/survey/v2"
 	"github.com/redhat-developer/app-services-cli/internal/config"
 	"github.com/redhat-developer/app-services-cli/pkg/cmd/factory"
 	"github.com/redhat-developer/app-services-cli/pkg/cmd/kafka/acl/common"
 	"github.com/redhat-developer/app-services-cli/pkg/cmdutil"
 	"github.com/redhat-developer/app-services-cli/pkg/connection"
+	"github.com/redhat-developer/app-services-cli/pkg/dump"
+	"github.com/redhat-developer/app-services-cli/pkg/icon"
 	"github.com/redhat-developer/app-services-cli/pkg/iostreams"
 	"github.com/redhat-developer/app-services-cli/pkg/localize"
 	"github.com/redhat-developer/app-services-cli/pkg/logging"
 	kafkainstanceclient "github.com/redhat-developer/app-services-sdk-go/kafkainstance/apiv1internal/client"
 	"github.com/spf13/cobra"
 )
 
+var (
+	serviceAccount string
+	userID         string
+)
+
 type options struct {
 	Config     config.IConfig
 	Connection factory.ConnectionFunc
@@ -32,10 +40,10 @@ type options struct {
 	group           string
 	topic           string
 	transactionalID string
-	userID          string
-	serviceAccount  string
+	principal       string
 
-	output string
+	skipConfirm bool
+	output      string
 }
 
 // NewDeleteCommand creates a new command to list Kafka ACL rules
@@ -82,14 +90,30 @@ func NewDeleteCommand(f *factory.Factory) *cobra.Command {
 			resourceTypeFlagEntries := []*localize.TemplateEntry{
 				localize.NewEntry("ClusterFlag", common.ClusterFlagName),
 				localize.NewEntry("TopicFlag", common.TopicFlagName),
-				localize.NewEntry("TransactionalIDFlag", common.TopicFlagName),
+				localize.NewEntry("TransactionalIDFlag", common.TransactionalIDFlagName),
 				localize.NewEntry("GroupFlag", common.GroupFlagName),
 			}
 
 			if selectedResourceTypeCount != 1 {
 				return opts.localizer.MustLocalizeError("kafka.acl.common.error.oneResourceTypeAllowed", resourceTypeFlagEntries...)
 			}
 
+			// check if priincipal is provided
+			if userID == "" && serviceAccount == "" {
+				return opts.localizer.MustLocalizeError("kafka.acl.common.error.noPrincipalsSelected")
+			}
+
+			// user and service account should not be provided together
+			if userID != "" && serviceAccount != "" {
+				return opts.localizer.MustLocalizeError("kafka.acl.common.error.bothPrincipalsSelected")
+			}
+
+			if userID != "" {
+				opts.principal = userID
+			} else {
+				opts.principal = serviceAccount
+			}
+
 			cfg, err := opts.Config.Load()
 			if err != nil {
 				return err
@@ -109,16 +133,16 @@ func NewDeleteCommand(f *factory.Factory) *cobra.Command {
 
 	_ = fs.AddPermission(&opts.permission).Required()
 	_ = fs.AddOperation(&opts.operation).Required()
-	// TODO: Should not be required when resource type is cluster
 
 	fs.AddCluster(&opts.cluster)
 	fs.AddPrefix(&opts.prefix)
 	fs.AddTopic(&opts.topic)
 	fs.AddConsumerGroup(&opts.group)
 	fs.AddTransactionalID(&opts.transactionalID)
 	fs.AddOutput(&opts.output)
-	fs.AddUser(&opts.userID)
-	fs.AddServiceAccount(&opts.serviceAccount)
+	fs.AddUser(&userID)
+	fs.AddServiceAccount(&serviceAccount)
+	fs.AddYes(&opts.skipConfirm)
 
 	return cmd
 }
@@ -157,10 +181,50 @@ func runDelete(instanceID string, opts *options) error {
 	if opts.prefix {
 		patternType = kafkainstanceclient.ACLPATTERNTYPEFILTER_PREFIXED
 	}
+
+	// TODO ensure ALL ACLs are fetched
+	aclList, httpRes, err := adminAPI.AclsApi.GetAcls(opts.Context).
+		ResourceType(common.GetResourceTypeFilter(opts.resourceType)).
+		Principal(common.FormatPrincipal(opts.principal)).
+		PatternType(patternType).
+		ResourceName(opts.resourceName).
+		Operation(common.GetOperationFilter(opts.operation)).
+		Permission(common.GetPermissionFilter(opts.permission)).
+		Execute()
+	if httpRes != nil {
+		defer httpRes.Body.Close()
+	}
+	if err != nil {
+		return err
+	}
+	if aclList.GetTotal() == 0 {
+		opts.Logger.Info("No ACLs matching this criteria to delete")
+		return nil
+	}
+
+	rows := common.MapACLsToTable(aclList.GetItems(), opts.localizer)
+	opts.Logger.Info(icon.Warning(), "The following ACLs will be deleted:")
+	opts.Logger.Info()
+	dump.Table(opts.IO.ErrOut, rows)
+	opts.Logger.Info()
+
+	if !opts.skipConfirm {
+		prompt := &survey.Confirm{
+			Message: "Are you sure you want to delete these ACLs?",
+		}
+		if err = survey.AskOne(prompt, &opts.skipConfirm); err != nil {
+			return err
+		}
+
+		if !opts.skipConfirm {
+			opts.Logger.Debug("User has not confirmed there wish to delete ACLs, returning")
+			return nil
+		}
+	}
+
 	bindingList, httpRes, err := adminAPI.AclsApi.DeleteAcls(opts.Context).
 		ResourceType(common.GetResourceTypeFilter(opts.resourceType)).
-		// TODO: Allow adding of principal via arguments
-		Principal("User:enda1").
+		Principal(common.FormatPrincipal(opts.principal)).
 		PatternType(patternType).
 		ResourceName(opts.resourceName).
 		Operation(common.GetOperationFilter(opts.operation)).
@@ -175,7 +239,7 @@ func runDelete(instanceID string, opts *options) error {
 		return err
 	}
 
-	opts.Logger.Info("Deleted", len(bindingList.GetItems()), "ACLs")
+	opts.Logger.Info("Deleted", bindingList.GetTotal(), "ACL(s)")
 
 	return nil
 }