Skip to content

Commit 77b098a

Browse files
committed
fix: linter issues in agent/consul (#22651)
1 parent 2110be4 commit 77b098a

File tree

73 files changed

+287
-300
lines changed

Some content is hidden

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

73 files changed

+287
-300
lines changed

.golangci.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,6 @@ linters:
103103
- third_party$
104104
- builtin$
105105
- examples$
106-
- agent/consul
107106
formatters:
108107
enable:
109108
- gofmt

agent/consul/acl_ce.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,19 @@ func (r *ACLResolver) resolveEnterpriseDefaultsForIdentity(identity structs.ACLI
3434
}
3535

3636
// resolveEnterpriseIdentityAndRoles will resolve an enterprise identity to an additional set of roles
37-
func (_ *ACLResolver) resolveEnterpriseIdentityAndRoles(_ structs.ACLIdentity) (structs.ACLIdentity, structs.ACLRoles, error) {
37+
func (*ACLResolver) resolveEnterpriseIdentityAndRoles(_ structs.ACLIdentity) (structs.ACLIdentity, structs.ACLRoles, error) {
3838
// this function does nothing in CE
3939
return nil, nil, nil
4040
}
4141

4242
// resolveEnterpriseIdentityAndPolicies will resolve an enterprise identity to an additional set of policies
43-
func (_ *ACLResolver) resolveEnterpriseIdentityAndPolicies(_ structs.ACLIdentity) (structs.ACLIdentity, structs.ACLPolicies, error) {
43+
func (*ACLResolver) resolveEnterpriseIdentityAndPolicies(_ structs.ACLIdentity) (structs.ACLIdentity, structs.ACLPolicies, error) {
4444
// this function does nothing in CE
4545
return nil, nil, nil
4646
}
4747

4848
// resolveLocallyManagedEnterpriseToken will resolve a managed service provider token to an identity and authorizer
49-
func (_ *ACLResolver) resolveLocallyManagedEnterpriseToken(_ string) (structs.ACLIdentity, acl.Authorizer, bool) {
49+
func (*ACLResolver) resolveLocallyManagedEnterpriseToken(_ string) (structs.ACLIdentity, acl.Authorizer, bool) {
5050
return nil, nil, false
5151
}
5252

agent/consul/acl_endpoint.go

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@ func (a *ACL) TokenRead(args *structs.ACLTokenGetRequest, reply *structs.ACLToke
325325
return fmt.Errorf("token has expired: %w", acl.ErrNotFound)
326326
} else if token == nil {
327327
// token does not exist
328-
if ns := args.EnterpriseMeta.NamespaceOrEmpty(); ns != "" {
328+
if ns := args.NamespaceOrEmpty(); ns != "" {
329329
return fmt.Errorf("token not found in namespace %s: %w", ns, acl.ErrNotFound)
330330
}
331331
return fmt.Errorf("token does not exist: %w", acl.ErrNotFound)
@@ -485,7 +485,7 @@ func (a *ACL) TokenClone(args *structs.ACLTokenSetRequest, reply *structs.ACLTok
485485
if err != nil {
486486
return err
487487
} else if token == nil {
488-
if ns := args.ACLToken.EnterpriseMeta.NamespaceOrEmpty(); ns != "" {
488+
if ns := args.ACLToken.NamespaceOrEmpty(); ns != "" {
489489
return fmt.Errorf("token not found in namespace %s: %w", ns, acl.ErrNotFound)
490490
}
491491
return fmt.Errorf("token does not exist: %w", acl.ErrNotFound)
@@ -630,7 +630,7 @@ func (a *ACL) TokenDelete(args *structs.ACLTokenDeleteRequest, reply *string) er
630630
return a.srv.forwardDC("ACL.TokenDelete", a.srv.config.PrimaryDatacenter, args, reply)
631631
} else {
632632
// in Primary Datacenter but the token does not exist - return early indicating it wasn't found.
633-
if ns := args.EnterpriseMeta.NamespaceOrEmpty(); ns != "" {
633+
if ns := args.NamespaceOrEmpty(); ns != "" {
634634
return fmt.Errorf("token not found in namespace %s: %w", ns, acl.ErrNotFound)
635635
}
636636
return fmt.Errorf("token does not exist: %w", acl.ErrNotFound)
@@ -646,7 +646,7 @@ func (a *ACL) TokenDelete(args *structs.ACLTokenDeleteRequest, reply *string) er
646646
}
647647

648648
// Purge the identity from the cache to prevent using the previous definition of the identity
649-
a.srv.ACLResolver.cache.RemoveIdentityWithSecretToken(token.SecretID)
649+
a.srv.cache.RemoveIdentityWithSecretToken(token.SecretID)
650650

651651
if reply != nil {
652652
*reply = token.AccessorID
@@ -684,15 +684,15 @@ func (a *ACL) TokenList(args *structs.ACLTokenListRequest, reply *structs.ACLTok
684684
return err
685685
}
686686
// merge the token default meta into the requests meta
687-
args.EnterpriseMeta.Merge(&requestMeta)
688-
args.EnterpriseMeta.FillAuthzContext(&authzContext)
687+
args.Merge(&requestMeta)
688+
args.FillAuthzContext(&authzContext)
689689
if err := authz.ToAllowAuthorizer().ACLReadAllowed(&authzContext); err != nil {
690690
return err
691691
}
692692

693693
var methodMeta *acl.EnterpriseMeta
694694
if args.AuthMethod != "" {
695-
methodMeta = args.ACLAuthMethodEnterpriseMeta.ToEnterpriseMeta()
695+
methodMeta = args.ToEnterpriseMeta()
696696
// attempt to merge in the overall meta, wildcards will not be merged
697697
methodMeta.MergeNoWildcard(&args.EnterpriseMeta)
698698
// in the event that the meta above didn't merge due to being a wildcard
@@ -981,7 +981,7 @@ func (a *ACL) PolicySet(args *structs.ACLPolicySetRequest, reply *structs.ACLPol
981981
}
982982

983983
// Remove from the cache to prevent stale cache usage
984-
a.srv.ACLResolver.cache.RemovePolicy(policy.ID)
984+
a.srv.cache.RemovePolicy(policy.ID)
985985

986986
if _, policy, err := a.srv.fsm.State().ACLPolicyGetByID(nil, policy.ID, &policy.EnterpriseMeta); err == nil && policy != nil {
987987
*reply = *policy
@@ -1024,7 +1024,7 @@ func (a *ACL) PolicyDelete(args *structs.ACLPolicyDeleteRequest, reply *string)
10241024
}
10251025

10261026
if policy == nil {
1027-
if ns := args.EnterpriseMeta.NamespaceOrEmpty(); ns != "" {
1027+
if ns := args.NamespaceOrEmpty(); ns != "" {
10281028
return fmt.Errorf("policy not found in namespace %s: %w", ns, acl.ErrNotFound)
10291029
}
10301030
return fmt.Errorf("policy does not exist: %w", acl.ErrNotFound)
@@ -1043,7 +1043,7 @@ func (a *ACL) PolicyDelete(args *structs.ACLPolicyDeleteRequest, reply *string)
10431043
return fmt.Errorf("Failed to apply policy delete request: %v", err)
10441044
}
10451045

1046-
a.srv.ACLResolver.cache.RemovePolicy(policy.ID)
1046+
a.srv.cache.RemovePolicy(policy.ID)
10471047

10481048
*reply = policy.Name
10491049

@@ -1104,12 +1104,12 @@ func (a *ACL) PolicyResolve(args *structs.ACLPolicyBatchGetRequest, reply *struc
11041104
}
11051105

11061106
// get full list of policies for this token
1107-
identity, policies, err := a.srv.ACLResolver.resolveTokenToIdentityAndPolicies(args.Token)
1107+
identity, policies, err := a.srv.resolveTokenToIdentityAndPolicies(args.Token)
11081108
if err != nil {
11091109
return err
11101110
}
11111111

1112-
entIdentity, entPolicies, err := a.srv.ACLResolver.resolveEnterpriseIdentityAndPolicies(identity)
1112+
entIdentity, entPolicies, err := a.srv.resolveEnterpriseIdentityAndPolicies(identity)
11131113
if err != nil {
11141114
return err
11151115
}
@@ -1419,7 +1419,7 @@ func (a *ACL) RoleSet(args *structs.ACLRoleSetRequest, reply *structs.ACLRole) e
14191419
}
14201420

14211421
// Remove from the cache to prevent stale cache usage
1422-
a.srv.ACLResolver.cache.RemoveRole(role.ID)
1422+
a.srv.cache.RemoveRole(role.ID)
14231423

14241424
if _, role, err := a.srv.fsm.State().ACLRoleGetByID(nil, role.ID, &role.EnterpriseMeta); err == nil && role != nil {
14251425
*reply = *role
@@ -1462,7 +1462,7 @@ func (a *ACL) RoleDelete(args *structs.ACLRoleDeleteRequest, reply *string) erro
14621462
}
14631463

14641464
if role == nil {
1465-
if ns := args.EnterpriseMeta.NamespaceOrEmpty(); ns != "" {
1465+
if ns := args.NamespaceOrEmpty(); ns != "" {
14661466
return fmt.Errorf("role not found in namespace %s: %w", ns, acl.ErrNotFound)
14671467
}
14681468
return fmt.Errorf("role does not exist: %w", acl.ErrNotFound)
@@ -1477,7 +1477,7 @@ func (a *ACL) RoleDelete(args *structs.ACLRoleDeleteRequest, reply *string) erro
14771477
return fmt.Errorf("Failed to apply role delete request: %v", err)
14781478
}
14791479

1480-
a.srv.ACLResolver.cache.RemoveRole(role.ID)
1480+
a.srv.cache.RemoveRole(role.ID)
14811481

14821482
*reply = role.Name
14831483

@@ -1532,12 +1532,12 @@ func (a *ACL) RoleResolve(args *structs.ACLRoleBatchGetRequest, reply *structs.A
15321532
}
15331533

15341534
// get full list of roles for this token
1535-
identity, roles, err := a.srv.ACLResolver.resolveTokenToIdentityAndRoles(args.Token)
1535+
identity, roles, err := a.srv.resolveTokenToIdentityAndRoles(args.Token)
15361536
if err != nil {
15371537
return err
15381538
}
15391539

1540-
entIdentity, entRoles, err := a.srv.ACLResolver.resolveEnterpriseIdentityAndRoles(identity)
1540+
entIdentity, entRoles, err := a.srv.resolveEnterpriseIdentityAndRoles(identity)
15411541
if err != nil {
15421542
return err
15431543
}
@@ -1777,7 +1777,7 @@ func (a *ACL) BindingRuleDelete(args *structs.ACLBindingRuleDeleteRequest, reply
17771777
}
17781778

17791779
if rule == nil {
1780-
if ns := args.EnterpriseMeta.NamespaceOrEmpty(); ns != "" {
1780+
if ns := args.NamespaceOrEmpty(); ns != "" {
17811781
return fmt.Errorf("binding rule not found in namespace %s: %w", ns, acl.ErrNotFound)
17821782
}
17831783
return fmt.Errorf("binding rule does not exist: %w", acl.ErrNotFound)
@@ -2025,7 +2025,7 @@ func (a *ACL) AuthMethodDelete(args *structs.ACLAuthMethodDeleteRequest, reply *
20252025
}
20262026

20272027
if method == nil {
2028-
if ns := args.EnterpriseMeta.NamespaceOrEmpty(); ns != "" {
2028+
if ns := args.NamespaceOrEmpty(); ns != "" {
20292029
return fmt.Errorf("auth method not found in namespace %s: %w", ns, acl.ErrNotFound)
20302030
}
20312031
return fmt.Errorf("auth method does not exist: %w", acl.ErrNotFound)

agent/consul/acl_endpoint_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5018,7 +5018,7 @@ func TestACLEndpoint_Login_with_MaxTokenTTL(t *testing.T) {
50185018
},
50195019
EnterpriseMeta: *defaultEntMeta,
50205020
}
5021-
expect.ACLAuthMethodEnterpriseMeta.FillWithEnterpriseMeta(defaultEntMeta)
5021+
expect.FillWithEnterpriseMeta(defaultEntMeta)
50225022
require.Equal(t, got, expect)
50235023
}
50245024

@@ -5125,7 +5125,7 @@ func TestACLEndpoint_Login_with_TokenLocality(t *testing.T) {
51255125
},
51265126
EnterpriseMeta: *defaultEntMeta,
51275127
}
5128-
expect.ACLAuthMethodEnterpriseMeta.FillWithEnterpriseMeta(defaultEntMeta)
5128+
expect.FillWithEnterpriseMeta(defaultEntMeta)
51295129
require.Equal(t, got, expect)
51305130

51315131
// Now turn around and nuke it.

agent/consul/acl_replication_types.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ func (r *aclTokenReplicator) FetchRemote(srv *Server, lastRemoteIndex uint64) (i
3232
}
3333

3434
r.remote = remote.Tokens
35-
return len(remote.Tokens), remote.QueryMeta.Index, nil
35+
return len(remote.Tokens), remote.Index, nil
3636
}
3737

3838
func (r *aclTokenReplicator) FetchLocal(srv *Server) (int, uint64, error) {
@@ -142,7 +142,7 @@ func (r *aclPolicyReplicator) FetchRemote(srv *Server, lastRemoteIndex uint64) (
142142
}
143143

144144
r.remote = remote.Policies
145-
return len(remote.Policies), remote.QueryMeta.Index, nil
145+
return len(remote.Policies), remote.Index, nil
146146
}
147147

148148
func (r *aclPolicyReplicator) FetchLocal(srv *Server) (int, uint64, error) {
@@ -239,7 +239,7 @@ func (r *aclRoleReplicator) FetchRemote(srv *Server, lastRemoteIndex uint64) (in
239239
}
240240

241241
r.remote = remote.Roles
242-
return len(remote.Roles), remote.QueryMeta.Index, nil
242+
return len(remote.Roles), remote.Index, nil
243243
}
244244

245245
func (r *aclRoleReplicator) FetchLocal(srv *Server) (int, uint64, error) {

agent/consul/acl_server.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ func (s *Server) aclBinder() *auth.Binder {
217217
func (s *Server) aclTokenWriter() *auth.TokenWriter {
218218
return auth.NewTokenWriter(auth.TokenWriterConfig{
219219
RaftApply: s.raftApply,
220-
ACLCache: s.ACLResolver.cache,
220+
ACLCache: s.cache,
221221
Store: s.fsm.State(),
222222
CheckUUID: s.checkTokenUUID,
223223
MaxExpirationTTL: s.config.ACLTokenMaxExpirationTTL,

agent/consul/acl_test.go

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1534,9 +1534,8 @@ func TestACLResolver_Client(t *testing.T) {
15341534
return acl.ErrNotFound
15351535
}
15361536

1537-
select {
1538-
case <-readyCh:
1539-
}
1537+
<-readyCh
1538+
15401539
time.Sleep(100 * time.Millisecond)
15411540
return nil
15421541
},
@@ -2326,7 +2325,7 @@ func TestACLResolver_ResolveToken_UpdatesPurgeTheCache(t *testing.T) {
23262325
require.NoError(t, err)
23272326

23282327
testutil.RunStep(t, "first resolve", func(t *testing.T) {
2329-
authz, err := srv.ACLResolver.ResolveToken(token)
2328+
authz, err := srv.ResolveToken(token)
23302329
require.NoError(t, err)
23312330
require.NotNil(t, authz)
23322331
require.Equal(t, acl.Allow, authz.KeyRead("foo", nil))
@@ -2345,7 +2344,7 @@ func TestACLResolver_ResolveToken_UpdatesPurgeTheCache(t *testing.T) {
23452344
err := msgpackrpc.CallWithCodec(codec, "ACL.PolicySet", &reqPolicy, &structs.ACLPolicy{})
23462345
require.NoError(t, err)
23472346

2348-
authz, err := srv.ACLResolver.ResolveToken(token)
2347+
authz, err := srv.ResolveToken(token)
23492348
require.NoError(t, err)
23502349
require.NotNil(t, authz)
23512350
require.Equal(t, acl.Deny, authz.KeyRead("foo", nil))
@@ -2361,7 +2360,7 @@ func TestACLResolver_ResolveToken_UpdatesPurgeTheCache(t *testing.T) {
23612360
err := msgpackrpc.CallWithCodec(codec, "ACL.TokenDelete", &req, &resp)
23622361
require.NoError(t, err)
23632362

2364-
_, err = srv.ACLResolver.ResolveToken(token)
2363+
_, err = srv.ResolveToken(token)
23652364
require.True(t, acl.IsErrNotFound(err), "Error %v is not acl.ErrNotFound", err)
23662365
})
23672366
}

agent/consul/acl_token_exp.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ func (s *Server) reapExpiredACLTokens(local, global bool) (int, error) {
111111

112112
// Purge the identities from the cache
113113
for _, secretID := range secretIDs {
114-
s.ACLResolver.cache.RemoveIdentityWithSecretToken(secretID)
114+
s.cache.RemoveIdentityWithSecretToken(secretID)
115115
}
116116

117117
return len(req.TokenIDs), nil

agent/consul/acl_token_exp_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ func testACLTokenReap_Primary(t *testing.T, local, global bool) {
192192
})
193193
})
194194

195-
time.Sleep(token3.ExpirationTime.Sub(time.Now()) + 10*time.Millisecond)
195+
time.Sleep(time.Until(*token3.ExpirationTime) + 10*time.Millisecond)
196196

197197
t.Run("one should be reaped", func(t *testing.T) {
198198
n, err := s1.reapExpiredACLTokens(local, global)
@@ -209,7 +209,7 @@ func testACLTokenReap_Primary(t *testing.T, local, global bool) {
209209
})
210210
})
211211

212-
time.Sleep(token4.ExpirationTime.Sub(time.Now()) + 10*time.Millisecond)
212+
time.Sleep(time.Until(*token4.ExpirationTime) + 10*time.Millisecond)
213213

214214
t.Run("two should be reaped", func(t *testing.T) {
215215
n, err := s1.reapExpiredACLTokens(local, global)

agent/consul/auth/login.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ func (l *Login) TokenForVerifiedIdentity(identity *authmethod.Identity, authMeth
5151
Policies: bindings.Policies,
5252
EnterpriseMeta: bindings.EnterpriseMeta,
5353
}
54-
token.ACLAuthMethodEnterpriseMeta.FillWithEnterpriseMeta(&authMethod.EnterpriseMeta)
54+
token.FillWithEnterpriseMeta(&authMethod.EnterpriseMeta)
5555

5656
updated, err := l.writer.Create(token, true)
5757
switch {

0 commit comments

Comments
 (0)