Skip to content

Commit 76c0a72

Browse files
rkpattnaik780wtrocki
rkpattnaik780
authored and
wtrocki
committed
fix: refactor: place utility methods in pkg/cmd (#1371)
1 parent 3e4e2dd commit 76c0a72

File tree

50 files changed

+210
-195
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+210
-195
lines changed

pkg/kafkautil/aclutil/acl_table.go renamed to pkg/cmd/kafka/acl/aclcmdutil/acl_table.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package aclutil
1+
package aclcmdutil
22

33
import (
44
"fmt"

pkg/kafkautil/aclutil/constants.go renamed to pkg/cmd/kafka/acl/aclcmdutil/constants.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package aclutil
1+
package aclcmdutil
22

33
const (
44
Wildcard = "*"

pkg/kafkautil/aclutil/enums.go renamed to pkg/cmd/kafka/acl/aclcmdutil/enums.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package aclutil
1+
package aclcmdutil
22

33
import kafkainstanceclient "github.com/redhat-developer/app-services-sdk-go/kafkainstance/apiv1internal/client"
44

pkg/kafkautil/aclutil/enums_test.go renamed to pkg/cmd/kafka/acl/aclcmdutil/enums_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package aclutil
1+
package aclcmdutil
22

33
import (
44
"reflect"

pkg/kafkautil/aclutil/util.go renamed to pkg/cmd/kafka/acl/aclcmdutil/util.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package aclutil
1+
package aclcmdutil
22

33
import (
44
"context"

‎pkg/cmd/kafka/acl/admin/admin.go‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ package admin
33
import (
44
"context"
55

6+
"github.com/redhat-developer/app-services-cli/pkg/cmd/kafka/acl/aclcmdutil"
67
flagset "github.com/redhat-developer/app-services-cli/pkg/cmd/kafka/acl/flagutil"
7-
"github.com/redhat-developer/app-services-cli/pkg/kafkautil/aclutil"
88

99
"github.com/AlecAivazis/survey/v2"
1010
"github.com/redhat-developer/app-services-cli/pkg/core/cmdutil/factory"
@@ -85,7 +85,7 @@ func NewAdminACLCommand(f *factory.Factory) *cobra.Command {
8585
}
8686

8787
// user and service account should not allow wildcard
88-
if userID == aclutil.Wildcard || serviceAccount == aclutil.Wildcard || userID == aclutil.AllAlias || serviceAccount == aclutil.AllAlias {
88+
if userID == aclcmdutil.Wildcard || serviceAccount == aclcmdutil.Wildcard || userID == aclcmdutil.AllAlias || serviceAccount == aclcmdutil.AllAlias {
8989
return opts.localizer.MustLocalizeError("kafka.acl.common.error.useAllAccountsFlag")
9090
}
9191

@@ -98,7 +98,7 @@ func NewAdminACLCommand(f *factory.Factory) *cobra.Command {
9898
}
9999

100100
if allAccounts {
101-
opts.principal = aclutil.Wildcard
101+
opts.principal = aclcmdutil.Wildcard
102102
}
103103

104104
return runAdmin(opts)
@@ -134,14 +134,14 @@ func runAdmin(opts *options) (err error) {
134134

135135
aclBindClusterAlter := kafkainstanceclient.NewAclBinding(
136136
kafkainstanceclient.ACLRESOURCETYPE_CLUSTER,
137-
aclutil.KafkaCluster,
137+
aclcmdutil.KafkaCluster,
138138
kafkainstanceclient.ACLPATTERNTYPE_LITERAL,
139-
aclutil.FormatPrincipal(opts.principal),
139+
aclcmdutil.FormatPrincipal(opts.principal),
140140
kafkainstanceclient.ACLOPERATION_ALTER,
141141
kafkainstanceclient.ACLPERMISSIONTYPE_ALLOW,
142142
)
143143

144-
rows := aclutil.MapACLsToTableRows([]kafkainstanceclient.AclBinding{*aclBindClusterAlter}, opts.localizer)
144+
rows := aclcmdutil.MapACLsToTableRows([]kafkainstanceclient.AclBinding{*aclBindClusterAlter}, opts.localizer)
145145

146146
opts.logger.Info(opts.localizer.MustLocalizePlural("kafka.acl.grantPermissions.log.info.aclsPreview", len(rows)))
147147
opts.logger.Info()
@@ -168,7 +168,7 @@ func runAdmin(opts *options) (err error) {
168168

169169
req = req.AclBinding(*aclBindClusterAlter)
170170

171-
err = aclutil.ExecuteACLRuleCreate(req, opts.localizer, kafkaName)
171+
err = aclcmdutil.ExecuteACLRuleCreate(req, opts.localizer, kafkaName)
172172
if err != nil {
173173
return err
174174
}

‎pkg/cmd/kafka/acl/create/create.go‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package create
22

33
import (
44
"github.com/AlecAivazis/survey/v2"
5+
"github.com/redhat-developer/app-services-cli/pkg/cmd/kafka/acl/aclcmdutil"
56
aclFlagutil "github.com/redhat-developer/app-services-cli/pkg/cmd/kafka/acl/flagutil"
67
"github.com/redhat-developer/app-services-cli/pkg/core/cmdutil"
78
"github.com/redhat-developer/app-services-cli/pkg/core/cmdutil/factory"
@@ -10,7 +11,6 @@ import (
1011
"github.com/redhat-developer/app-services-cli/pkg/core/ioutil/dump"
1112
"github.com/redhat-developer/app-services-cli/pkg/core/ioutil/spinner"
1213
"github.com/redhat-developer/app-services-cli/pkg/core/localize"
13-
"github.com/redhat-developer/app-services-cli/pkg/kafkautil/aclutil"
1414
kafkainstanceclient "github.com/redhat-developer/app-services-sdk-go/kafkainstance/apiv1internal/client"
1515
"github.com/spf13/cobra"
1616
)
@@ -33,7 +33,7 @@ type requestParams struct {
3333

3434
// NewCreateCommand creates a new command to add Kafka ACLs
3535
func NewCreateCommand(f *factory.Factory) *cobra.Command {
36-
opts := &aclutil.CrudOptions{
36+
opts := &aclcmdutil.CrudOptions{
3737
Config: f.Config,
3838
Connection: f.Connection,
3939
Logger: f.Logger,
@@ -63,7 +63,7 @@ func NewCreateCommand(f *factory.Factory) *cobra.Command {
6363
errorCollection = append(errorCollection, opts.Localizer.MustLocalizeError("kafka.acl.common.flag.operation.required"))
6464
}
6565

66-
if resourceErrors := aclutil.ValidateAndSetResources(opts, aclFlagutil.ResourceTypeFlagEntries); resourceErrors != nil {
66+
if resourceErrors := aclcmdutil.ValidateAndSetResources(opts, aclFlagutil.ResourceTypeFlagEntries); resourceErrors != nil {
6767
errorCollection = append(errorCollection, resourceErrors)
6868
}
6969

@@ -72,7 +72,7 @@ func NewCreateCommand(f *factory.Factory) *cobra.Command {
7272
}
7373

7474
if len(errorCollection) > 0 {
75-
return aclutil.BuildInstructions(errorCollection)
75+
return aclcmdutil.BuildInstructions(errorCollection)
7676
}
7777

7878
return runAdd(opts.InstanceID, opts)
@@ -99,7 +99,7 @@ func NewCreateCommand(f *factory.Factory) *cobra.Command {
9999
}
100100

101101
// nolint:funlen
102-
func runAdd(instanceID string, opts *aclutil.CrudOptions) error {
102+
func runAdd(instanceID string, opts *aclcmdutil.CrudOptions) error {
103103
ctx := opts.Context
104104

105105
conn, err := opts.Connection(connection.DefaultConfigRequireMasAuth)
@@ -122,7 +122,7 @@ func runAdd(instanceID string, opts *aclutil.CrudOptions) error {
122122
return err
123123
}
124124

125-
if isValidOp, validResourceOperations := aclutil.IsValidResourceOperation(opts.ResourceType, opts.Operation, resourceOperations); !isValidOp {
125+
if isValidOp, validResourceOperations := aclcmdutil.IsValidResourceOperation(opts.ResourceType, opts.Operation, resourceOperations); !isValidOp {
126126
return opts.Localizer.MustLocalizeError("kafka.acl.common.error.invalidResourceOperation",
127127
localize.NewEntry("ResourceType", opts.ResourceType),
128128
localize.NewEntry("Operation", opts.Operation),
@@ -136,12 +136,12 @@ func runAdd(instanceID string, opts *aclutil.CrudOptions) error {
136136
kafkainstanceclient.AclResourceType(requestParams.resourceType),
137137
requestParams.resourceName,
138138
kafkainstanceclient.AclPatternType(requestParams.patternType),
139-
aclutil.FormatPrincipal(opts.Principal),
139+
aclcmdutil.FormatPrincipal(opts.Principal),
140140
kafkainstanceclient.AclOperation(requestParams.operation),
141141
kafkainstanceclient.AclPermissionType(requestParams.permission),
142142
)
143143

144-
rows := aclutil.MapACLsToTableRows([]kafkainstanceclient.AclBinding{*newAclBinding}, opts.Localizer)
144+
rows := aclcmdutil.MapACLsToTableRows([]kafkainstanceclient.AclBinding{*newAclBinding}, opts.Localizer)
145145

146146
opts.Logger.Info(opts.Localizer.MustLocalizePlural("kafka.acl.grantPermissions.log.info.aclsPreview", len(rows)))
147147
opts.Logger.Info()
@@ -174,7 +174,7 @@ func runAdd(instanceID string, opts *aclutil.CrudOptions) error {
174174

175175
req = req.AclBinding(*newAclBinding)
176176

177-
err = aclutil.ExecuteACLRuleCreate(req, opts.Localizer, kafkaName)
177+
err = aclcmdutil.ExecuteACLRuleCreate(req, opts.Localizer, kafkaName)
178178
spinnr.Stop()
179179
if err != nil {
180180
return err
@@ -183,43 +183,43 @@ func runAdd(instanceID string, opts *aclutil.CrudOptions) error {
183183
return nil
184184
}
185185

186-
func getRequestParams(opts *aclutil.CrudOptions) *requestParams {
186+
func getRequestParams(opts *aclcmdutil.CrudOptions) *requestParams {
187187
return &requestParams{
188-
resourceType: kafkainstanceclient.AclResourceType(aclutil.GetMappedResourceTypeFilterValue(opts.ResourceType)),
189-
principal: aclutil.FormatPrincipal(opts.Principal),
190-
resourceName: aclutil.GetResourceName(opts.ResourceName),
191-
patternType: aclutil.GetMappedPatternTypeValue(opts.PatternType),
192-
operation: aclutil.GetMappedOperationValue(opts.Operation),
193-
permission: aclutil.GetMappedPermissionTypeValue(opts.Permission),
188+
resourceType: kafkainstanceclient.AclResourceType(aclcmdutil.GetMappedResourceTypeFilterValue(opts.ResourceType)),
189+
principal: aclcmdutil.FormatPrincipal(opts.Principal),
190+
resourceName: aclcmdutil.GetResourceName(opts.ResourceName),
191+
patternType: aclcmdutil.GetMappedPatternTypeValue(opts.PatternType),
192+
operation: aclcmdutil.GetMappedOperationValue(opts.Operation),
193+
permission: aclcmdutil.GetMappedPermissionTypeValue(opts.Permission),
194194
}
195195
}
196196

197-
func validateAndSetOpts(opts *aclutil.CrudOptions) error {
197+
func validateAndSetOpts(opts *aclcmdutil.CrudOptions) error {
198198

199199
// user and service account should not be provided together
200200
if userID != "" && serviceAccount != "" {
201201
return opts.Localizer.MustLocalizeError("kafka.acl.common.error.bothPrincipalsSelected")
202202
}
203203

204-
if userID == aclutil.Wildcard || serviceAccount == aclutil.Wildcard || userID == aclutil.AllAlias || serviceAccount == aclutil.AllAlias {
204+
if userID == aclcmdutil.Wildcard || serviceAccount == aclcmdutil.Wildcard || userID == aclcmdutil.AllAlias || serviceAccount == aclcmdutil.AllAlias {
205205
return opts.Localizer.MustLocalizeError("kafka.acl.common.error.useAllAccountsFlag")
206206
}
207207

208208
if allAccounts {
209209
if userID != "" || serviceAccount != "" {
210210
return opts.Localizer.MustLocalizeError("kafka.acl.common.error.allAccountsCannotBeUsedWithUserFlag")
211211
}
212-
opts.Principal = aclutil.Wildcard
212+
opts.Principal = aclcmdutil.Wildcard
213213
}
214214

215215
// check if principal is provided
216216
if !allAccounts && (userID == "" && serviceAccount == "") {
217217
return opts.Localizer.MustLocalizeError("kafka.acl.common.error.noPrincipalsSelected")
218218
}
219219

220-
opts.PatternType = aclutil.PatternTypeLITERAL
220+
opts.PatternType = aclcmdutil.PatternTypeLITERAL
221221
if prefix {
222-
opts.PatternType = aclutil.PatternTypePREFIX
222+
opts.PatternType = aclcmdutil.PatternTypePREFIX
223223
}
224224

225225
if userID != "" {

‎pkg/cmd/kafka/acl/delete/delete.go‎

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package delete
22

33
import (
44
"github.com/AlecAivazis/survey/v2"
5+
"github.com/redhat-developer/app-services-cli/pkg/cmd/kafka/acl/aclcmdutil"
56
aclFlagUtil "github.com/redhat-developer/app-services-cli/pkg/cmd/kafka/acl/flagutil"
67
"github.com/redhat-developer/app-services-cli/pkg/core/cmdutil"
78
"github.com/redhat-developer/app-services-cli/pkg/core/cmdutil/factory"
@@ -11,7 +12,6 @@ import (
1112
"github.com/redhat-developer/app-services-cli/pkg/core/ioutil/icon"
1213
"github.com/redhat-developer/app-services-cli/pkg/core/ioutil/spinner"
1314
"github.com/redhat-developer/app-services-cli/pkg/core/localize"
14-
"github.com/redhat-developer/app-services-cli/pkg/kafkautil/aclutil"
1515
kafkainstanceclient "github.com/redhat-developer/app-services-sdk-go/kafkainstance/apiv1internal/client"
1616
"github.com/spf13/cobra"
1717
)
@@ -34,7 +34,7 @@ type requestParams struct {
3434

3535
// NewDeleteCommand creates a new command to delete Kafka ACLs
3636
func NewDeleteCommand(f *factory.Factory) *cobra.Command {
37-
opts := &aclutil.CrudOptions{
37+
opts := &aclcmdutil.CrudOptions{
3838
Config: f.Config,
3939
Connection: f.Connection,
4040
Logger: f.Logger,
@@ -60,7 +60,7 @@ func NewDeleteCommand(f *factory.Factory) *cobra.Command {
6060
errorCollection = append(errorCollection, opts.Localizer.MustLocalizeError("kafka.acl.common.flag.operation.required"))
6161
}
6262

63-
if resourceErrors := aclutil.ValidateAndSetResources(opts, aclFlagUtil.ResourceTypeFlagEntries); resourceErrors != nil {
63+
if resourceErrors := aclcmdutil.ValidateAndSetResources(opts, aclFlagUtil.ResourceTypeFlagEntries); resourceErrors != nil {
6464
errorCollection = append(errorCollection, resourceErrors)
6565
}
6666

@@ -69,7 +69,7 @@ func NewDeleteCommand(f *factory.Factory) *cobra.Command {
6969
}
7070

7171
if len(errorCollection) > 0 {
72-
return aclutil.BuildInstructions(errorCollection)
72+
return aclcmdutil.BuildInstructions(errorCollection)
7373
}
7474

7575
return runDelete(opts.InstanceID, opts)
@@ -97,7 +97,7 @@ func NewDeleteCommand(f *factory.Factory) *cobra.Command {
9797
}
9898

9999
// nolint:funlen
100-
func runDelete(instanceID string, opts *aclutil.CrudOptions) error {
100+
func runDelete(instanceID string, opts *aclcmdutil.CrudOptions) error {
101101
ctx := opts.Context
102102

103103
conn, err := opts.Connection(connection.DefaultConfigRequireMasAuth)
@@ -118,7 +118,7 @@ func runDelete(instanceID string, opts *aclutil.CrudOptions) error {
118118
return err
119119
}
120120

121-
if isValidOp, validResourceOperations := aclutil.IsValidResourceOperation(opts.ResourceType, opts.Operation, resourceOperations); !isValidOp {
121+
if isValidOp, validResourceOperations := aclcmdutil.IsValidResourceOperation(opts.ResourceType, opts.Operation, resourceOperations); !isValidOp {
122122
return opts.Localizer.MustLocalizeError("kafka.acl.common.error.invalidResourceOperation",
123123
localize.NewEntry("ResourceType", opts.ResourceType),
124124
localize.NewEntry("Operation", opts.Operation),
@@ -162,7 +162,7 @@ func runDelete(instanceID string, opts *aclutil.CrudOptions) error {
162162
defer httpRes.Body.Close()
163163
}
164164

165-
err = aclutil.ValidateAPIError(httpRes, opts.Localizer, err, "delete", kafkaInstance.GetName())
165+
err = aclcmdutil.ValidateAPIError(httpRes, opts.Localizer, err, "delete", kafkaInstance.GetName())
166166
spinnr.Stop()
167167

168168
if err != nil {
@@ -182,52 +182,53 @@ func runDelete(instanceID string, opts *aclutil.CrudOptions) error {
182182
localize.NewEntry("Count", deletedCount),
183183
))
184184

185-
rows := aclutil.MapACLsToTableRows(*deletedACLs.Items, opts.Localizer)
185+
rows := aclcmdutil.MapACLsToTableRows(*deletedACLs.Items, opts.Localizer)
186186
opts.Logger.Info(opts.Localizer.MustLocalizePlural("kafka.acl.grantPermissions.log.delete.info.aclsPreview", len(rows)))
187187
opts.Logger.Info()
188+
188189
dump.Table(opts.IO.Out, rows)
189190
opts.Logger.Info()
190191

191192
return nil
192193
}
193194

194-
func getRequestParams(opts *aclutil.CrudOptions) *requestParams {
195+
func getRequestParams(opts *aclcmdutil.CrudOptions) *requestParams {
195196
return &requestParams{
196-
resourceType: aclutil.GetMappedResourceTypeFilterValue(opts.ResourceType),
197-
principal: aclutil.FormatPrincipal(opts.Principal),
198-
resourceName: aclutil.GetResourceName(opts.ResourceName),
199-
patternType: aclutil.GetMappedPatternTypeFilterValue(opts.PatternType),
200-
operation: aclutil.GetMappedOperationFilterValue(opts.Operation),
201-
permission: aclutil.GetMappedPermissionTypeFilterValue(opts.Permission),
197+
resourceType: aclcmdutil.GetMappedResourceTypeFilterValue(opts.ResourceType),
198+
principal: aclcmdutil.FormatPrincipal(opts.Principal),
199+
resourceName: aclcmdutil.GetResourceName(opts.ResourceName),
200+
patternType: aclcmdutil.GetMappedPatternTypeFilterValue(opts.PatternType),
201+
operation: aclcmdutil.GetMappedOperationFilterValue(opts.Operation),
202+
permission: aclcmdutil.GetMappedPermissionTypeFilterValue(opts.Permission),
202203
}
203204
}
204205

205-
func validateAndSetOpts(opts *aclutil.CrudOptions) error {
206+
func validateAndSetOpts(opts *aclcmdutil.CrudOptions) error {
206207

207208
// user and service account should not be provided together
208209
if userID != "" && serviceAccount != "" {
209210
return opts.Localizer.MustLocalizeError("kafka.acl.common.error.bothPrincipalsSelected")
210211
}
211212

212-
if userID == aclutil.Wildcard || serviceAccount == aclutil.Wildcard || userID == aclutil.AllAlias || serviceAccount == aclutil.AllAlias {
213+
if userID == aclcmdutil.Wildcard || serviceAccount == aclcmdutil.Wildcard || userID == aclcmdutil.AllAlias || serviceAccount == aclcmdutil.AllAlias {
213214
return opts.Localizer.MustLocalizeError("kafka.acl.common.error.useAllAccountsFlag")
214215
}
215216

216217
if allAccounts {
217218
if userID != "" || serviceAccount != "" {
218219
return opts.Localizer.MustLocalizeError("kafka.acl.common.error.allAccountsCannotBeUsedWithUserFlag")
219220
}
220-
opts.Principal = aclutil.Wildcard
221+
opts.Principal = aclcmdutil.Wildcard
221222
}
222223

223224
// check if principal is provided
224225
if !allAccounts && (userID == "" && serviceAccount == "") {
225226
return opts.Localizer.MustLocalizeError("kafka.acl.common.error.noPrincipalsSelected")
226227
}
227228

228-
opts.PatternType = aclutil.PatternTypeLITERAL
229+
opts.PatternType = aclcmdutil.PatternTypeLITERAL
229230
if prefix {
230-
opts.PatternType = aclutil.PatternTypePREFIX
231+
opts.PatternType = aclcmdutil.PatternTypePREFIX
231232
}
232233

233234
if userID != "" {

0 commit comments

Comments
 (0)