feat(kafka acl): add base and list command (#1173)

Author: rkpattnaik780

docs/commands/rhoas_kafka.adoc

@@ -0,0 +1,24 @@
+package acl
+
+import (
+	"github.com/redhat-developer/app-services-cli/pkg/cmd/factory"
+	"github.com/redhat-developer/app-services-cli/pkg/cmd/kafka/acl/list"
+	"github.com/spf13/cobra"
+)
+
+// NewAclCommand creates a new command sub-group for Kafka ACL operations
+func NewAclCommand(f *factory.Factory) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "acl",
+		Short:   f.Localizer.MustLocalize("kafka.acl.cmd.shortDescription"),
+		Long:    f.Localizer.MustLocalize("kafka.acl.cmd.longDescription"),
+		Example: f.Localizer.MustLocalize("kafka.acl.cmd.example"),
+		Args:    cobra.ExactArgs(1),
+	}
+
+	cmd.AddCommand(
+		list.NewListACLCommand(f),
+	)
+
+	return cmd
+}

docs/commands/rhoas_kafka_acl.adoc

@@ -0,0 +1,174 @@
+package list
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+	"strings"
+
+	"github.com/redhat-developer/app-services-cli/internal/build"
+	"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/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/iostreams"
+	"github.com/redhat-developer/app-services-cli/pkg/localize"
+	"github.com/redhat-developer/app-services-cli/pkg/logging"
+	"github.com/spf13/cobra"
+
+	kafkainstanceclient "github.com/redhat-developer/app-services-sdk-go/kafkainstance/apiv1internal/client"
+)
+
+type options struct {
+	Config     config.IConfig
+	Connection factory.ConnectionFunc
+	Logger     logging.Logger
+	IO         *iostreams.IOStreams
+	localizer  localize.Localizer
+	Context    context.Context
+
+	page    int32
+	size    int32
+	kafkaID string
+	output  string
+}
+
+type permissionsRow struct {
+	Principal   string `json:"principal,omitempty" header:"Principal"`
+	Permission  string `json:"permission,omitempty" header:"permission"`
+	Description string `json:"description,omitempty" header:"description"`
+}
+
+// NewListACLCommand creates a new command to list Kafka ACL rules
+func NewListACLCommand(f *factory.Factory) *cobra.Command {
+
+	opts := &options{
+		Config:     f.Config,
+		Connection: f.Connection,
+		Logger:     f.Logger,
+		IO:         f.IOStreams,
+		localizer:  f.Localizer,
+		Context:    f.Context,
+	}
+
+	cmd := &cobra.Command{
+		Use:     "list",
+		Short:   f.Localizer.MustLocalize("kafka.acl.list.cmd.shortDescription"),
+		Long:    f.Localizer.MustLocalize("kafka.acl.list.cmd.longDescription"),
+		Example: f.Localizer.MustLocalize("kafka.acl.list.cmd.example"),
+		Args:    cobra.NoArgs,
+		RunE: func(cmd *cobra.Command, _ []string) error {
+
+			cfg, err := opts.Config.Load()
+			if err != nil {
+				return err
+			}
+
+			if !cfg.HasKafka() {
+				return opts.localizer.MustLocalizeError("kafka.acl.common.error.noKafkaSelected")
+			}
+
+			opts.kafkaID = cfg.Services.Kafka.ClusterID
+
+			return runList(opts)
+		},
+	}
+
+	cmd.Flags().Int32VarP(&opts.page, "page", "", cmdutil.ConvertPageValueToInt32(build.DefaultPageNumber), opts.localizer.MustLocalize("kafka.acl.list.flag.page.description"))
+	cmd.Flags().Int32VarP(&opts.size, "size", "", cmdutil.ConvertSizeValueToInt32(build.DefaultPageSize), opts.localizer.MustLocalize("kafka.acl.list.flag.size.description"))
+	cmd.Flags().StringVarP(&opts.output, "output", "o", "", opts.localizer.MustLocalize("kafka.acl.list.flag.output.description"))
+
+	return cmd
+}
+
+func runList(opts *options) (err error) {
+	conn, err := opts.Connection(connection.DefaultConfigRequireMasAuth)
+	if err != nil {
+		return err
+	}
+
+	api, kafkaInstance, err := conn.API().KafkaAdmin(opts.kafkaID)
+	if err != nil {
+		return err
+	}
+
+	req := api.AclsApi.GetAcls(opts.Context)
+
+	req = req.Page(float32(opts.page))
+
+	req = req.Size(float32(opts.size))
+
+	permissionsData, httpRes, err := req.Execute()
+	if httpRes != nil {
+		defer httpRes.Body.Close()
+	}
+
+	if err != nil {
+		if httpRes == nil {
+			return err
+		}
+
+		operationTmplPair := localize.NewEntry("Operation", "list")
+
+		switch httpRes.StatusCode {
+		case http.StatusUnauthorized:
+			return opts.localizer.MustLocalizeError("kafka.acl.common.error.unauthorized", operationTmplPair)
+		case http.StatusForbidden:
+			return opts.localizer.MustLocalizeError("kafka.acl.common.error.forbidden", operationTmplPair)
+		case http.StatusInternalServerError:
+			return opts.localizer.MustLocalizeError("kafka.acl.common.error.internalServerError")
+		case http.StatusServiceUnavailable:
+			return opts.localizer.MustLocalizeError("kafka.acl.common.error.unableToConnectToKafka", localize.NewEntry("Name", kafkaInstance.GetName()))
+		default:
+			return err
+		}
+	}
+
+	switch opts.output {
+	case dump.EmptyFormat:
+		opts.Logger.Info("")
+		permissions := permissionsData.GetItems()
+		rows := mapPermissionListResultsToTableFormat(permissions, opts.localizer)
+		dump.Table(opts.IO.Out, rows)
+	default:
+		return dump.Formatted(opts.IO.Out, opts.output, permissionsData)
+	}
+
+	return nil
+}
+
+func mapPermissionListResultsToTableFormat(permissions []kafkainstanceclient.AclBinding, localizer localize.Localizer) []permissionsRow {
+
+	rows := make([]permissionsRow, len(permissions))
+
+	for i, p := range permissions {
+
+		description := buildDescription(p.PatternType, localizer)
+		row := permissionsRow{
+			Principal:   formatPrincipal(p.GetPrincipal(), localizer),
+			Permission:  fmt.Sprintf("%s | %s", p.GetPermission(), 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 == "*" {
+		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")
+}

docs/commands/rhoas_kafka_acl_list.adoc

@@ -8,6 +8,7 @@ import (
 	"github.com/spf13/cobra"
 
 	"github.com/redhat-developer/app-services-cli/pkg/cmd/factory"
+	"github.com/redhat-developer/app-services-cli/pkg/cmd/kafka/acl"
 	"github.com/redhat-developer/app-services-cli/pkg/cmd/kafka/create"
 	"github.com/redhat-developer/app-services-cli/pkg/cmd/kafka/delete"
 	"github.com/redhat-developer/app-services-cli/pkg/cmd/kafka/describe"
@@ -35,6 +36,7 @@ func NewKafkaCommand(f *factory.Factory) *cobra.Command {
 		topic.NewTopicCommand(f),
 		consumergroup.NewConsumerGroupCommand(f),
 		update.NewUpdateCommand(f),
+		acl.NewAclCommand(f),
 	)
 
 	return cmd