Code Cleanup Around Audit Backends #20933
Conversation
remove function argument no longer needed
vault/audit_test.go
Outdated
| @@ -239,7 +239,7 @@ func TestCore_DisableAudit(t *testing.T) { | |||
| c, keys, _ := TestCoreUnsealed(t) | |||
| c.auditBackends["noop"] = corehelpers.NoopAuditFactory(nil) | |||
|
|
|||
| existed, err := c.disableAudit(namespace.RootContext(nil), "foo", true) | |||
| existed, err := c.disableAudit(namespace.RootContext(context.TODO()), "foo", true) | |||
There was a problem hiding this comment.
Is there a reason we're using context.TODO() over context.Background()? I think Background fits better for this purpose, as we know we should be using a context and the function does properly accept one. I could be missing something, though :)
There was a problem hiding this comment.
context.TODO() was the suggested replacement in the go-staticcheck warning. But I can give context.Background() a try as well.
There was a problem hiding this comment.
context.TODO() was the suggested replacement in the go-staticcheck warning. But I can give context.Background() a try as well.
There was a problem hiding this comment.
I've replaced context.TODO() with context.Background() and all of the tests continue passing, so I'm in favour of using the Background function over the TODO function, especially since I noticed afterwards, other tests were also using the Background function when a Context was needed.
@peteski22 do you mean changing |
No, I just wasn't sure if a changelog is required, or what section things need to go under for clean up in general. 😄 |
This PR cleans up an unused field in the backendEntry struct and removes function arguments that were only needed to initialize that unnecessary field in the struct.
As an added bonus, the few compiler warnings that were reported in the audit_test.go file were also resolved.