Skip to content

feat: factory function provides more context #437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Benehiko merged 1 commit into from
Jan 27, 2026
Merged

feat: factory function provides more context #437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion plugins/pass/store/store.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package store

import (
"context"

"github.com/docker/secrets-engine/store"
"github.com/docker/secrets-engine/store/keychain"
)
Expand Down Expand Up @@ -32,7 +34,7 @@ func PassStore(serviceGroup string, opts ...keychain.Option) (store.Store, error
kc, err := keychain.New(
serviceGroup,
"docker-pass-cli",
func() *PassValue {
func(_ context.Context, _ store.ID) *PassValue {
return &PassValue{}
},
opts...,
Expand Down
2 changes: 1 addition & 1 deletion store/keychain/cmd/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ func newCommand() (*cobra.Command, error) {
kc, err := keychain.New(
"io.docker.Secrets",
"docker-example-cli",
func() *mocks.MockCredential {
func(_ context.Context, _ store.ID) *mocks.MockCredential {
return &mocks.MockCredential{}
},
)
Expand Down
14 changes: 7 additions & 7 deletions store/keychain/keychain_darwin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ var (
type keychainStore[T store.Secret] struct {
serviceGroup string
serviceName string
factory func() T
factory store.Factory[T]
useDataProtectionKeychain bool
}

Expand Down Expand Up @@ -102,7 +102,7 @@ func (k *keychainStore[T]) Delete(_ context.Context, id store.ID) error {
return nil
}

func (k *keychainStore[T]) Get(_ context.Context, id store.ID) (store.Secret, error) {
func (k *keychainStore[T]) Get(ctx context.Context, id store.ID) (store.Secret, error) {
result, err := getItemWithData(id.String(), k)
if err != nil {
return nil, err
Expand All @@ -114,7 +114,7 @@ func (k *keychainStore[T]) Get(_ context.Context, id store.ID) (store.Secret, er
}
safelyCleanMetadata(attributes)

secret := k.factory()
secret := k.factory(ctx, id)
if err := secret.SetMetadata(attributes); err != nil {
return nil, err
}
Expand All @@ -124,7 +124,7 @@ func (k *keychainStore[T]) Get(_ context.Context, id store.ID) (store.Secret, er
return secret, nil
}

func (k *keychainStore[T]) GetAllMetadata(context.Context) (map[store.ID]store.Secret, error) {
func (k *keychainStore[T]) GetAllMetadata(ctx context.Context) (map[store.ID]store.Secret, error) {
item := newKeychainItem("", k)

// We use the MatchLimitAll attribute to query for multiple items from the
Expand All @@ -149,7 +149,7 @@ func (k *keychainStore[T]) GetAllMetadata(context.Context) (map[store.ID]store.S
}
safelyCleanMetadata(attributes)

secret := k.factory()
secret := k.factory(ctx, id)
if err := secret.SetMetadata(attributes); err != nil {
return nil, err
}
Expand Down Expand Up @@ -184,7 +184,7 @@ func (k *keychainStore[T]) Save(_ context.Context, id store.ID, secret store.Sec
return mapKeychainError(kc.AddItem(item))
}

func (k *keychainStore[T]) Filter(_ context.Context, pattern store.Pattern) (map[store.ID]store.Secret, error) {
func (k *keychainStore[T]) Filter(ctx context.Context, pattern store.Pattern) (map[store.ID]store.Secret, error) {
// Note: Filter on macOS cannot filter by generic attributes and thus we
// cannot split the ID and store it in the keychain as parts for later
// pattern matching.
Expand Down Expand Up @@ -242,7 +242,7 @@ func (k *keychainStore[T]) Filter(_ context.Context, pattern store.Pattern) (map
return nil, err
}

secret := k.factory()
secret := k.factory(ctx, id)
if err := secret.SetMetadata(attr); err != nil {
return nil, err
}
Expand Down
3 changes: 2 additions & 1 deletion store/keychain/keychain_darwin_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ package keychain

import (
"bytes"
"context"
"testing"

"github.com/google/uuid"
Expand All @@ -22,7 +23,7 @@ func TestMacosKeychain(t *testing.T) {
keychainStore := keychainStore[*mocks.MockCredential]{
serviceGroup: serviceGroup,
serviceName: serviceName,
factory: func() *mocks.MockCredential {
factory: func(_ context.Context, _ store.ID) *mocks.MockCredential {
return &mocks.MockCredential{}
},
}
Expand Down
14 changes: 7 additions & 7 deletions store/keychain/keychain_linux.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ func isCollectionUnlocked(collectionPath dbus.ObjectPath, service *kc.SecretServ
type keychainStore[T store.Secret] struct {
serviceGroup string
serviceName string
factory func() T
factory store.Factory[T]
}

func (k *keychainStore[T]) Delete(_ context.Context, id store.ID) error {
Expand Down Expand Up @@ -143,7 +143,7 @@ func (k *keychainStore[T]) Delete(_ context.Context, id store.ID) error {
return service.DeleteItem(items[0])
}

func (k *keychainStore[T]) Get(_ context.Context, id store.ID) (store.Secret, error) {
func (k *keychainStore[T]) Get(ctx context.Context, id store.ID) (store.Secret, error) {
service, err := kc.NewService()
if err != nil {
return nil, err
Expand Down Expand Up @@ -193,7 +193,7 @@ func (k *keychainStore[T]) Get(_ context.Context, id store.ID) (store.Secret, er
if err != nil {
return nil, err
}
secret := k.factory()
secret := k.factory(ctx, id)
if err := secret.SetMetadata(attributes); err != nil {
return nil, err
}
Expand All @@ -204,7 +204,7 @@ func (k *keychainStore[T]) Get(_ context.Context, id store.ID) (store.Secret, er
return secret, nil
}

func (k *keychainStore[T]) GetAllMetadata(context.Context) (map[store.ID]store.Secret, error) {
func (k *keychainStore[T]) GetAllMetadata(ctx context.Context) (map[store.ID]store.Secret, error) {
service, err := kc.NewService()
if err != nil {
return nil, err
Expand Down Expand Up @@ -261,7 +261,7 @@ func (k *keychainStore[T]) GetAllMetadata(context.Context) (map[store.ID]store.S
}
safelyCleanMetadata(attributes)

secret := k.factory()
secret := k.factory(ctx, secretID)
if err := secret.SetMetadata(attributes); err != nil {
return nil, err
}
Expand Down Expand Up @@ -326,7 +326,7 @@ func (k *keychainStore[T]) Save(_ context.Context, id store.ID, secret store.Sec
}

//gocyclo:ignore
func (k *keychainStore[T]) Filter(_ context.Context, pattern store.Pattern) (map[store.ID]store.Secret, error) {
func (k *keychainStore[T]) Filter(ctx context.Context, pattern store.Pattern) (map[store.ID]store.Secret, error) {
service, err := kc.NewService()
if err != nil {
return nil, err
Expand Down Expand Up @@ -402,7 +402,7 @@ func (k *keychainStore[T]) Filter(_ context.Context, pattern store.Pattern) (map
}
safelyCleanMetadata(attributes)

secret := k.factory()
secret := k.factory(ctx, secretID)
if err := secret.SetMetadata(attributes); err != nil {
return nil, err
}
Expand Down
8 changes: 4 additions & 4 deletions store/keychain/keychain_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ func (m *mustUnmarshalError) Unmarshal([]byte) error {
return errors.New("i am failing on purpose")
}

func setupKeychain(t *testing.T, secretFactory func() store.Secret) store.Store {
func setupKeychain(t *testing.T, secretFactory func(context.Context, store.ID) store.Secret) store.Store {
t.Helper()
if secretFactory == nil {
secretFactory = func() store.Secret {
secretFactory = func(_ context.Context, _ store.ID) store.Secret {
return &mocks.MockCredential{}
}
}
Expand Down Expand Up @@ -266,7 +266,7 @@ func TestKeychain(t *testing.T) {
})

t.Run("unmarshal error on get", func(t *testing.T) {
kc := setupKeychain(t, func() store.Secret {
kc := setupKeychain(t, func(_ context.Context, _ store.ID) store.Secret {
return &mustUnmarshalError{}
})
id, err := store.ParseID("something/will/fail")
Expand All @@ -280,7 +280,7 @@ func TestKeychain(t *testing.T) {
})

t.Run("set metadata error on getAllMetadata", func(t *testing.T) {
kc := setupKeychain(t, func() store.Secret {
kc := setupKeychain(t, func(_ context.Context, _ store.ID) store.Secret {
return &mustUnmarshalError{}
})
id, err := store.ParseID("something/will/fail")
Expand Down
14 changes: 7 additions & 7 deletions store/keychain/keychain_windows.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ func decodeSecret(blob []byte, secret store.Secret) error {
type keychainStore[T store.Secret] struct {
serviceGroup string
serviceName string
factory func() T
factory store.Factory[T]
}

func (k *keychainStore[T]) Delete(_ context.Context, id store.ID) error {
Expand All @@ -66,7 +66,7 @@ func (k *keychainStore[T]) Delete(_ context.Context, id store.ID) error {
return nil
}

func (k *keychainStore[T]) Get(_ context.Context, id store.ID) (store.Secret, error) {
func (k *keychainStore[T]) Get(ctx context.Context, id store.ID) (store.Secret, error) {
gc, err := wincred.GetGenericCredential(k.itemLabel(id.String()))
if err != nil {
return nil, mapWindowsCredentialError(err)
Expand All @@ -75,7 +75,7 @@ func (k *keychainStore[T]) Get(_ context.Context, id store.ID) (store.Secret, er
attributes := mapFromWindowsAttributes(gc.Attributes)
safelyCleanMetadata(attributes)

secret := k.factory()
secret := k.factory(ctx, id)
if err := secret.SetMetadata(attributes); err != nil {
return nil, err
}
Expand Down Expand Up @@ -148,7 +148,7 @@ func mapFromWindowsAttributes(winAttrs []wincred.CredentialAttribute) map[string
return attributes
}

func (k *keychainStore[T]) GetAllMetadata(context.Context) (map[store.ID]store.Secret, error) {
func (k *keychainStore[T]) GetAllMetadata(ctx context.Context) (map[store.ID]store.Secret, error) {
credentials, err := wincred.List()
if err != nil {
return nil, mapWindowsCredentialError(err)
Expand All @@ -169,7 +169,7 @@ func (k *keychainStore[T]) GetAllMetadata(context.Context) (map[store.ID]store.S
attributes := mapFromWindowsAttributes(cred.Attributes)
safelyCleanMetadata(attributes)

secret := k.factory()
secret := k.factory(ctx, id)
if err := secret.SetMetadata(attributes); err != nil {
return nil, err
}
Expand Down Expand Up @@ -198,7 +198,7 @@ func (k *keychainStore[T]) Save(_ context.Context, id store.ID, secret store.Sec
return mapWindowsCredentialError(g.Write())
}

func (k *keychainStore[T]) Filter(_ context.Context, pattern store.Pattern) (map[store.ID]store.Secret, error) {
func (k *keychainStore[T]) Filter(ctx context.Context, pattern store.Pattern) (map[store.ID]store.Secret, error) {
// Note: there is no notion of a filter on Windows inside the wincred API.
// It has no way to even filter on known attributes.
// This means we need to retrieve the entire list of ALL secrets, that
Expand Down Expand Up @@ -241,7 +241,7 @@ func (k *keychainStore[T]) Filter(_ context.Context, pattern store.Pattern) (map
gcAttributes := mapFromWindowsAttributes(gc.Attributes)
safelyCleanMetadata(gcAttributes)

secret := k.factory()
secret := k.factory(ctx, id)
if err := secret.SetMetadata(gcAttributes); err != nil {
return nil, err
}
Expand Down
6 changes: 3 additions & 3 deletions store/posixage/store.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ func (f *fileStore[T]) Filter(ctx context.Context, pattern store.Pattern) (map[s
return err
}

secret := f.factory()
secret := f.factory(ctx, id)
if err := secret.SetMetadata(metadata); err != nil {
return err
}
Expand Down Expand Up @@ -241,7 +241,7 @@ func (f *fileStore[T]) Get(ctx context.Context, id store.ID) (store.Secret, erro
return nil, err
}

secret := f.factory()
secret := f.factory(ctx, id)
if err := secret.SetMetadata(metadata); err != nil {
return nil, err
}
Expand Down Expand Up @@ -286,7 +286,7 @@ func (f *fileStore[T]) GetAllMetadata(ctx context.Context) (map[store.ID]store.S
return err
}

secret := f.factory()
secret := f.factory(ctx, id)
if err := secret.SetMetadata(metadata); err != nil {
return err
}
Expand Down
22 changes: 11 additions & 11 deletions store/posixage/store_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ func TestPOSIXAge(t *testing.T) {

masterKey := uuid.NewString()
s, err := New(root,
func() *mocks.MockCredential {
func(_ context.Context, _ store.ID) *mocks.MockCredential {
return &mocks.MockCredential{}
},
WithLogger(&testLogger{t}),
Expand Down Expand Up @@ -143,7 +143,7 @@ func TestPOSIXAge(t *testing.T) {

masterKey := uuid.NewString()
s, err := New(root,
func() *mocks.MockCredential {
func(_ context.Context, _ store.ID) *mocks.MockCredential {
return &mocks.MockCredential{}
},
WithLogger(&testLogger{t}),
Expand Down Expand Up @@ -182,7 +182,7 @@ func TestPOSIXAge(t *testing.T) {

masterKey := uuid.NewString()
s, err := New(root,
func() *mocks.MockCredential {
func(_ context.Context, _ store.ID) *mocks.MockCredential {
return &mocks.MockCredential{}
},
WithLogger(&testLogger{t}),
Expand Down Expand Up @@ -240,7 +240,7 @@ func TestPOSIXAge(t *testing.T) {

masterKey := uuid.NewString()
s, err := New(root,
func() *mocks.MockCredential {
func(_ context.Context, _ store.ID) *mocks.MockCredential {
return &mocks.MockCredential{}
},
WithLogger(&testLogger{t}),
Expand Down Expand Up @@ -301,7 +301,7 @@ func TestPOSIXAge(t *testing.T) {
require.NoError(t, err)

s, err := New(root,
func() *mocks.MockCredential {
func(_ context.Context, _ store.ID) *mocks.MockCredential {
return &mocks.MockCredential{}
},
WithLogger(&testLogger{t}),
Expand Down Expand Up @@ -384,7 +384,7 @@ func TestPOSIXAge(t *testing.T) {
require.NoError(t, err)

s, err := New(root,
func() *mocks.MockCredential {
func(_ context.Context, _ store.ID) *mocks.MockCredential {
return &mocks.MockCredential{}
},
WithLogger(&testLogger{t}),
Expand Down Expand Up @@ -463,7 +463,7 @@ func TestPOSIXAge(t *testing.T) {
})

s, err := New(root,
func() *mocks.MockCredential {
func(_ context.Context, _ store.ID) *mocks.MockCredential {
return &mocks.MockCredential{}
},
WithLogger(&testLogger{t}),
Expand Down Expand Up @@ -530,7 +530,7 @@ func TestPOSIXAge(t *testing.T) {
require.NoError(t, err)

s, err := New(root,
func() *mocks.MockCredential {
func(_ context.Context, _ store.ID) *mocks.MockCredential {
return &mocks.MockCredential{}
},
WithLogger(&testLogger{t}),
Expand Down Expand Up @@ -602,7 +602,7 @@ func TestPOSIXAge(t *testing.T) {
})

s, err := New(root,
func() *mocks.MockCredential {
func(_ context.Context, _ store.ID) *mocks.MockCredential {
return &mocks.MockCredential{}
},
WithLogger(&testLogger{t}),
Expand Down Expand Up @@ -651,7 +651,7 @@ func TestPOSIXAge(t *testing.T) {

encryptError := errors.New("something went wrong inside the encryption callbackFunc")
s, err := New(root,
func() *mocks.MockCredential {
func(_ context.Context, _ store.ID) *mocks.MockCredential {
return &mocks.MockCredential{}
},
WithLogger(&testLogger{t}),
Expand Down Expand Up @@ -684,7 +684,7 @@ func TestPOSIXAge(t *testing.T) {

decryptError := errors.New("something went wrong inside the decryption callbackFunc")
s, err := New(root,
func() *mocks.MockCredential {
func(_ context.Context, _ store.ID) *mocks.MockCredential {
return &mocks.MockCredential{}
},
WithLogger(&testLogger{t}),
Expand Down
2 changes: 1 addition & 1 deletion store/store.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,4 @@ type Store interface {
Filter(ctx context.Context, pattern Pattern) (map[ID]Secret, error)
}

type Factory[T Secret] func() T
type Factory[T Secret] func(context.Context, ID) T
Loading