Skip to content

Commit

Permalink
[NET-1723] deduplicate code
Browse files Browse the repository at this point in the history
  • Loading branch information
@roncodingenthusiast
roncodingenthusiast committed Mar 1, 2023
1 parent 29a84c4 commit 63d2fb4
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 55 deletions.
8 changes: 8 additions & 0 deletions .changelog/16288.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
```release-note:deprecation
cli: Deprecate the `-merge-policies` and `-merge-roles` flags from the `consul token update` command in favour of: `-add-policy-id`, `-add-policy-name`, `-add-role-name`, and `-add-role-id`.
```

```release-note:improvement
cli: added `-add-policy-id`, `-add-policy-name`, `-add-role-name`, and `-add-role-id` flags to the `consul token update` command.
These flags will allow updates to token's policies/roles without having to override them completely.
```
76 changes: 29 additions & 47 deletions command/acl/token/update/token_update.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,19 +63,19 @@ func (c *cmd) init() {
c.flags.Var((*flags.AppendSliceValue)(&c.policyIDs), "policy-id", "ID of a "+
"policy to use for this token. May be specified multiple times")
c.flags.Var((*flags.AppendSliceValue)(&c.addPolicyIDs), "add-policy-id", "ID of a "+
"policy to use for this token. Appends this policy to existing policies. May be specified multiple times")
"policy to use for this token. The token retains existing policies. May be specified multiple times")
c.flags.Var((*flags.AppendSliceValue)(&c.policyNames), "policy-name", "Name of a "+
"policy to use for this token. May be specified multiple times")
c.flags.Var((*flags.AppendSliceValue)(&c.addPolicyNames), "add-policy-name", "Name of a "+
"policy to use for this token. Appends this policy to existing policies. May be specified multiple times")
"policy to add to this token. The token retains existing policies. May be specified multiple times")
c.flags.Var((*flags.AppendSliceValue)(&c.roleIDs), "role-id", "ID of a "+
"role to use for this token. May be specified multiple times")
c.flags.Var((*flags.AppendSliceValue)(&c.roleNames), "role-name", "Name of a "+
"role to use for this token. May be specified multiple times")
c.flags.Var((*flags.AppendSliceValue)(&c.addRoleIDs), "add-role-id", "ID of a "+
"role to add to this token. Appends this role to existing roles. May be specified multiple times")
"role to add to this token. The token retains existing roles. May be specified multiple times")
c.flags.Var((*flags.AppendSliceValue)(&c.addRoleNames), "add-role-name", "Name of a "+
"role to add to this token. Appends this role to existing roles. May be specified multiple times")
"role to add to this token. The token retains existing roles. May be specified multiple times")
c.flags.Var((*flags.AppendSliceValue)(&c.serviceIdents), "service-identity", "Name of a "+
"service identity to use for this token. May be specified multiple times. Format is "+
"the SERVICENAME or SERVICENAME:DATACENTER1,DATACENTER2,...")
Expand All @@ -97,10 +97,10 @@ func (c *cmd) init() {

// Deprecations
c.flags.StringVar(&c.tokenID, "id", "", "DEPRECATED. Use -accessor-id instead.")
c.flags.BoolVar(&c.mergePolicies, "merge-policies", false, "Deprecated. Merge the new policies "+
"with the existing policies. Use -add-policy-id or -add-policy-name instead.")
c.flags.BoolVar(&c.mergeRoles, "merge-roles", false, "Deprecated. Merge the new roles "+
"with the existing roles. Use -add-role-id or -add-role-name instead.")
c.flags.BoolVar(&c.mergePolicies, "merge-policies", false, "DEPRECATED. "+
"Use -add-policy-id or -add-policy-name instead.")
c.flags.BoolVar(&c.mergeRoles, "merge-roles", false, "DEPRECATED. "+
"Use -add-role-id or -add-role-name instead.")
}

func (c *cmd) Run(args []string) int {
Expand Down Expand Up @@ -160,8 +160,8 @@ func (c *cmd) Run(args []string) int {
}

if c.mergePolicies {
c.UI.Warn("merge-policies is deprecated and will be removed in future consul version. " +
"This is being replaced by `add-policy-name` and `add-policy-id`.")
c.UI.Warn("merge-policies is deprecated and will be removed in future Consul version. " +
"Use `add-policy-name` and `add-policy-id` instead.")

for _, policyName := range c.policyNames {
found := false
Expand Down Expand Up @@ -204,35 +204,27 @@ func (c *cmd) Run(args []string) int {
hasPolicyFields := len(c.policyIDs) > 0 || len(c.policyNames) > 0

if hasPolicyFields && hasAddPolicyFields {
c.UI.Error("Cannot specified both add-policy-id/add-policy-name and policy-id/policy-name")
c.UI.Error("Cannot specify both add-policy-id/add-policy-name and policy-id/policy-name")
return 1
}

if hasAddPolicyFields {
for _, addedPolicyName := range c.addPolicyNames {
t.Policies = append(t.Policies, &api.ACLTokenPolicyLink{Name: addedPolicyName})
}
policyIDs := c.addPolicyIDs
policyNames := c.addPolicyNames

for _, addedPolicyId := range c.addPolicyIDs {
policyID, err := acl.GetPolicyIDFromPartial(client, addedPolicyId)
if err != nil {
c.UI.Error(fmt.Sprintf("Error resolving policy ID %s: %v", policyID, err))
return 1
}
t.Policies = append(t.Policies, &api.ACLTokenPolicyLink{ID: policyID})
}
} else {
// c.UI.Warn("Overwriting policies with new specified policies")
if hasPolicyFields {
policyIDs = c.policyIDs
policyNames = c.policyNames
t.Policies = nil
// c.UI.Warn("Overwriting policies with new specified policies")
}

for _, policyName := range c.policyNames {
for _, policyName := range policyNames {
// We could resolve names to IDs here but there isn't any reason why its would be better
// than allowing the agent to do it.
t.Policies = append(t.Policies, &api.ACLTokenPolicyLink{Name: policyName})
}

for _, policyID := range c.policyIDs {
for _, policyID := range policyIDs {
policyID, err := acl.GetPolicyIDFromPartial(client, policyID)
if err != nil {
c.UI.Error(fmt.Sprintf("Error resolving policy ID %s: %v", policyID, err))
Expand All @@ -243,8 +235,8 @@ func (c *cmd) Run(args []string) int {
}

if c.mergeRoles {
c.UI.Warn("merge-roles is deprecated and will be removed in future consul version. " +
"This is being replaced by `add-role-name` and `add-role-id`.")
c.UI.Warn("merge-roles is deprecated and will be removed in future Consul version. " +
"Use `add-role-name` and `add-role-id` instead.")

for _, roleName := range c.roleNames {
found := false
Expand Down Expand Up @@ -286,37 +278,27 @@ func (c *cmd) Run(args []string) int {
hasRoleFields := len(c.roleIDs) > 0 || len(c.roleNames) > 0

if hasRoleFields && hasAddRoleFields {
c.UI.Error("Cannot specified both add-role-id/add-role-name and role-id/role-name")
c.UI.Error("Cannot specify both add-role-id/add-role-name and role-id/role-name")
return 1
}

if hasAddRoleFields {
for _, roleName := range c.addRoleNames {
// We could resolve names to IDs here but there isn't any reason why its would be better
// than allowing the agent to do it.
t.Roles = append(t.Roles, &api.ACLTokenRoleLink{Name: roleName})
}
roleNames := c.addRoleNames
roleIDs := c.addRoleIDs

for _, roleID := range c.addRoleIDs {
roleID, err := acl.GetRoleIDFromPartial(client, roleID)
if err != nil {
c.UI.Error(fmt.Sprintf("Error resolving role ID %s: %v", roleID, err))
return 1
}
t.Roles = append(t.Roles, &api.ACLTokenRoleLink{ID: roleID})
}
} else {
if hasRoleFields {
roleNames = c.roleNames
roleIDs = c.roleIDs
// c.UI.Warn("Overwriting policies with new specified policies")
t.Roles = nil
}

for _, roleName := range c.roleNames {
for _, roleName := range roleNames {
// We could resolve names to IDs here but there isn't any reason why its would be better
// than allowing the agent to do it.
t.Roles = append(t.Roles, &api.ACLTokenRoleLink{Name: roleName})
}

for _, roleID := range c.roleIDs {
for _, roleID := range roleIDs {
roleID, err := acl.GetRoleIDFromPartial(client, roleID)
if err != nil {
c.UI.Error(fmt.Sprintf("Error resolving role ID %s: %v", roleID, err))
Expand Down
24 changes: 16 additions & 8 deletions website/content/commands/acl/token/update.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,13 @@ Usage: `consul acl token update [options]`

- `-merge-policies` - Deprecated. Merge the new policies with the existing policies.

~> This is deprecated and will be removed in future consul version. Use `add-policy-id` or `add-policy-name`
~> This is deprecated and will be removed in future Consul version. Use `add-policy-id` or `add-policy-name`
instead.

- `-merge-roles` - Merge the new roles with the existing roles.
- `-merge-roles` - Deprecated. Merge the new roles with the existing roles.

~> This is deprecated and will be removed in future Consul version. Use `add-role-id` or `add-role-name`
instead.

- `-merge-service-identities` - Merge the new service identities with the existing service identities.

Expand All @@ -56,16 +59,21 @@ instead.

- `-policy-name=<value>` - Name of a policy to use for this token. Overwrites existing policies. May be specified multiple times.

~> `-policy-id` and `-policy-name` will completely overwrite existing policies. Use `-add-policy-id` or `-add-policy-name` if you
are trying to append more policies to your existing token policies.
~> `-policy-id` and `-policy-name` will completely overwrite existing token policies. Use `-add-policy-id` or `-add-policy-name` to retain existing policies.

- `-add-policy-id=<value>` - ID of policy to be added for this token. The token retains existing policies. May be specified multiple times.

- `-add-policy-name=<value>` - Name of a policy to be added for this token. The token retains existing policies. May be specified multiple times.

- `-role-id=<value>` - ID of a role to use for this token. Overwrites existing roles. May be specified multiple times.

- `-add-policy-id=<value>` - ID of policy to be added for this token. Added to existing policies. May be specified multiple times.
- `-role-name=<value>` - Name of a role to use for this token. Overwrites existing roles. May be specified multiple times.

- `-add-policy-name=<value>` - Name of a policy to be added for this token. Added to existing policies. May be specified multiple times.
~> `-role-id` and `-role-name` will completely overwrite existing policies. Use `-add-role-id` or `-add-role-name` to retain the existing roles.

- `-role-id=<value>` - ID of a role to use for this token. May be specified multiple times.
- `-add-role-id=<value>` - ID of a role to add to this token. The token retains existing roles. May be specified multiple times.

- `-role-name=<value>` - Name of a role to use for this token. May be specified multiple times.
- `-add-role-name=<value>` - Name of a role to add to this token. The token retains existing roles. May be specified multiple times.

- `-service-identity=<value>` - Name of a service identity to use for this
token. May be specified multiple times. Format is the `SERVICENAME` or
Expand Down

0 comments on commit 63d2fb4

Please sign in to comment.