Renames and documentaitons

mstoykov · mstoykov · commit b95a49c2fbea · 2025-02-28T15:38:09.000+02:00
diff --git a/cmd/state/state.go b/cmd/state/state.go
@@ -58,7 +58,7 @@ type GlobalState struct {
 	Logger         *logrus.Logger //nolint:forbidigo //TODO:change to FieldLogger
 	FallbackLogger logrus.FieldLogger
 
-	SecretsManager *secretsource.SecretsManager
+	SecretsManager *secretsource.Manager
 	Usage          *usage.Usage
 }
 
diff --git a/internal/cmd/root.go b/internal/cmd/root.go
@@ -272,7 +272,7 @@ func (c *rootCommand) setupLoggers(stop <-chan struct{}) error {
 	// it is important that we add this hook first as hooks are executed in order of addition
 	// and this means no other hook will get secrets
 	var secretsHook logrus.Hook
-	c.globalState.SecretsManager, secretsHook, err = secretsource.NewSecretsManager(secretsources)
+	c.globalState.SecretsManager, secretsHook, err = secretsource.NewManager(secretsources)
 	if err != nil {
 		return err
 	}
@@ -314,15 +314,15 @@ func (c *rootCommand) setLoggerHook(ctx context.Context, h log.AsyncHook) {
 	c.globalState.Logger.SetOutput(io.Discard) // don't output to anywhere else
 }
 
-func createSecretSources(gs *state.GlobalState) (map[string]secretsource.SecretSource, error) {
+func createSecretSources(gs *state.GlobalState) (map[string]secretsource.Source, error) {
 	baseParams := secretsource.Params{
 		Logger:      gs.Logger,
 		Environment: gs.Env,
 		FS:          gs.FS,
 		Usage:       gs.Usage,
 	}
 
-	result := make(map[string]secretsource.SecretSource)
+	result := make(map[string]secretsource.Source)
 	for _, line := range gs.Flags.SecretSource {
 		t, config, ok := strings.Cut(line, "=")
 		if !ok {
diff --git a/internal/js/modules/k6/secrets/secrets.go b/internal/js/modules/k6/secrets/secrets.go
@@ -17,7 +17,7 @@ type (
 	// Secrets represents an instance of the k6 module.
 	Secrets struct {
 		vu             modules.VU
-		secretsManager *secretsource.SecretsManager
+		secretsManager *secretsource.Manager
 	}
 )
 
@@ -66,7 +66,7 @@ func (mi *Secrets) secrets() (*sobek.Object, error) {
 }
 
 func secretSourceObjectForSourceName(
-	rt *sobek.Runtime, manager *secretsource.SecretsManager, sourceName string,
+	rt *sobek.Runtime, manager *secretsource.Manager, sourceName string,
 ) (*sobek.Object, error) {
 	obj := rt.NewObject()
 	err := obj.Set("get", func(key string) (string, error) {
diff --git a/internal/js/modules/k6/secrets/secrets_test.go b/internal/js/modules/k6/secrets/secrets_test.go
@@ -11,10 +11,10 @@ import (
 	"go.k6.io/k6/secretsource"
 )
 
-func testRuntimeWithSecrets(t testing.TB, secretSources map[string]secretsource.SecretSource) *modulestest.Runtime {
+func testRuntimeWithSecrets(t testing.TB, secretSources map[string]secretsource.Source) *modulestest.Runtime {
 	testRuntime := modulestest.NewRuntime(t)
 	var err error
-	testRuntime.VU.InitEnvField.SecretsManager, _, err = secretsource.NewSecretsManager(secretSources)
+	testRuntime.VU.InitEnvField.SecretsManager, _, err = secretsource.NewManager(secretSources)
 	require.NoError(t, err)
 
 	m, ok := New().NewModuleInstance(testRuntime.VU).(*Secrets)
@@ -28,15 +28,15 @@ func TestSecrets(t *testing.T) {
 	t.Parallel()
 
 	type secretsTest struct {
-		secretsources map[string]secretsource.SecretSource
+		secretsources map[string]secretsource.Source
 		script        string
 		expectedValue any
 		expectedError string
 	}
 
 	cases := map[string]secretsTest{
 		"simple": {
-			secretsources: map[string]secretsource.SecretSource{
+			secretsources: map[string]secretsource.Source{
 				"default": mock.NewMockSecretSource("some", map[string]string{
 					"secret": "value",
 				}),
@@ -45,7 +45,7 @@ func TestSecrets(t *testing.T) {
 			expectedValue: "value",
 		},
 		"error": {
-			secretsources: map[string]secretsource.SecretSource{
+			secretsources: map[string]secretsource.Source{
 				"default": mock.NewMockSecretSource("some", map[string]string{
 					"secret": "value",
 				}),
@@ -54,7 +54,7 @@ func TestSecrets(t *testing.T) {
 			expectedError: "no value",
 		},
 		"multiple": {
-			secretsources: map[string]secretsource.SecretSource{
+			secretsources: map[string]secretsource.Source{
 				"default": mock.NewMockSecretSource("some", map[string]string{
 					"secret": "value",
 				}),
@@ -66,7 +66,7 @@ func TestSecrets(t *testing.T) {
 			expectedValue: "value",
 		},
 		"multiple get default": {
-			secretsources: map[string]secretsource.SecretSource{
+			secretsources: map[string]secretsource.Source{
 				"default": mock.NewMockSecretSource("some", map[string]string{
 					"secret": "value",
 				}),
@@ -78,7 +78,7 @@ func TestSecrets(t *testing.T) {
 			expectedValue: "value",
 		},
 		"multiple get not default": {
-			secretsources: map[string]secretsource.SecretSource{
+			secretsources: map[string]secretsource.Source{
 				"default": mock.NewMockSecretSource("some", map[string]string{
 					"secret": "value",
 				}),
@@ -90,12 +90,12 @@ func TestSecrets(t *testing.T) {
 			expectedValue: "value2",
 		},
 		"get secret without source": {
-			secretsources: map[string]secretsource.SecretSource{},
+			secretsources: map[string]secretsource.Source{},
 			script:        "secrets.get('secret')",
 			expectedError: "no source with name default",
 		},
 		"get none existing source": {
-			secretsources: map[string]secretsource.SecretSource{
+			secretsources: map[string]secretsource.Source{
 				"default": mock.NewMockSecretSource("some", map[string]string{
 					"secret": "value",
 				}),
diff --git a/internal/secretsource/file/file.go b/internal/secretsource/file/file.go
@@ -11,7 +11,7 @@ import (
 )
 
 func init() {
-	secretsource.RegisterExtension("file", func(params secretsource.Params) (secretsource.SecretSource, error) {
+	secretsource.RegisterExtension("file", func(params secretsource.Params) (secretsource.Source, error) {
 		fss := &fileSecretSource{}
 		err := fss.parseArg(params.ConfigArgument)
 		if err != nil {
diff --git a/internal/secretsource/mock/mock.go b/internal/secretsource/mock/mock.go
@@ -10,7 +10,7 @@ import (
 )
 
 func init() {
-	secretsource.RegisterExtension("mock", func(params secretsource.Params) (secretsource.SecretSource, error) {
+	secretsource.RegisterExtension("mock", func(params secretsource.Params) (secretsource.Source, error) {
 		list := strings.Split(params.ConfigArgument, ",")
 		secrets := make(map[string]string, len(list))
 		name := "mock"
@@ -31,7 +31,7 @@ func init() {
 }
 
 // NewMockSecretSource returns a new secret source mock with the provided name and map of secrets
-func NewMockSecretSource(name string, secrets map[string]string) secretsource.SecretSource {
+func NewMockSecretSource(name string, secrets map[string]string) secretsource.Source {
 	return &mockSecretSource{
 		internal: secrets,
 		name:     name,
diff --git a/lib/test_state.go b/lib/test_state.go
@@ -25,7 +25,7 @@ type TestPreInitState struct {
 	Logger         logrus.FieldLogger
 	TracerProvider *trace.TracerProvider
 	Usage          *usage.Usage
-	SecretsManager *secretsource.SecretsManager
+	SecretsManager *secretsource.Manager
 }
 
 // TestRunState contains the pre-init state as well as all of the state and
diff --git a/secretsource/extension.go b/secretsource/extension.go
@@ -8,11 +8,11 @@ import (
 )
 
 // Constructor returns an instance of an output extension module.
-type Constructor func(Params) (SecretSource, error)
+type Constructor func(Params) (Source, error)
 
 // Params contains all possible constructor parameters an output may need.
 type Params struct {
-	ConfigArgument string
+	ConfigArgument string // the string on the cli
 
 	Logger      logrus.FieldLogger
 	Environment map[string]string
diff --git a/secretsource/interface.go b/secretsource/interface.go
@@ -1,8 +1,10 @@
 package secretsource
 
-// SecretSource is the interface a secret source needs to implement
-type SecretSource interface {
+// Source is the interface a secret source needs to implement
+type Source interface {
+	// A name to be used when k6 has multiple sources
 	Name() string
+	// Human readable description to be printed on the cli
 	Description() string
 	Get(key string) (value string, err error)
 }
diff --git a/secretsource/manager.go b/secretsource/manager.go
@@ -10,19 +10,19 @@ import (
 // DefaultSourceName is the name for the default secret source
 const DefaultSourceName = "default"
 
-// SecretsManager manages secrets making certain for them to be redacted from logs
-type SecretsManager struct {
+// Manager manages secrets making certain for them to be redacted from logs
+type Manager struct {
 	hook    *secretsHook
-	sources map[string]SecretSource
+	sources map[string]Source
 	cache   map[string]*sync.Map
 }
 
-// NewSecretsManager returns a new NewSecretsManager with the provided secretsHook and will redact secrets from the hook
-func NewSecretsManager(sources map[string]SecretSource) (*SecretsManager, logrus.Hook, error) {
+// NewManager returns a new NewManager with the provided secretsHook and will redact secrets from the hook
+func NewManager(sources map[string]Source) (*Manager, logrus.Hook, error) {
 	cache := make(map[string]*sync.Map, len(sources)-1)
 	hook := &secretsHook{}
 	if len(sources) == 0 {
-		return &SecretsManager{
+		return &Manager{
 			hook:  hook,
 			cache: cache,
 		}, hook, nil
@@ -39,7 +39,7 @@ func NewSecretsManager(sources map[string]SecretSource) (*SecretsManager, logrus
 		}
 		cache[k] = new(sync.Map)
 	}
-	sm := &SecretsManager{
+	sm := &Manager{
 		hook:    hook,
 		sources: sources,
 		cache:   cache,
@@ -50,7 +50,7 @@ func NewSecretsManager(sources map[string]SecretSource) (*SecretsManager, logrus
 // Get is the way to get a secret for the provided source name and key of the secret.
 // It can be used with the [DefaultSourceName].
 // This automatically starts redacting the secret before returning it.
-func (sm *SecretsManager) Get(sourceName, key string) (string, error) {
+func (sm *Manager) Get(sourceName, key string) (string, error) {
 	sourceCache, ok := sm.cache[sourceName]
 	if !ok {
 		return "", fmt.Errorf("no source with name %s", sourceName)

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ type GlobalState struct {`
`58`	`58`	`Logger *logrus.Logger //nolint:forbidigo //TODO:change to FieldLogger`
`59`	`59`	`FallbackLogger logrus.FieldLogger`
`60`	`60`
`61`		`- SecretsManager *secretsource.SecretsManager`
	`61`	`+ SecretsManager *secretsource.Manager`
`62`	`62`	`Usage *usage.Usage`
`63`	`63`	`}`
`64`	`64`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ type (`
`17`	`17`	`// Secrets represents an instance of the k6 module.`
`18`	`18`	`Secrets struct {`
`19`	`19`	`vu modules.VU`
`20`		`- secretsManager *secretsource.SecretsManager`
	`20`	`+ secretsManager *secretsource.Manager`
`21`	`21`	`}`
`22`	`22`	`)`
`23`	`23`
`@@ -66,7 +66,7 @@ func (mi Secrets) secrets() (sobek.Object, error) {`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`func secretSourceObjectForSourceName(`
`69`		`- rt sobek.Runtime, manager secretsource.SecretsManager, sourceName string,`
	`69`	`+ rt sobek.Runtime, manager secretsource.Manager, sourceName string,`
`70`	`70`	`) (*sobek.Object, error) {`
`71`	`71`	`obj := rt.NewObject()`
`72`	`72`	`err := obj.Set("get", func(key string) (string, error) {`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ import (`
`11`	`11`	`)`
`12`	`12`
`13`	`13`	`func init() {`
`14`		`- secretsource.RegisterExtension("file", func(params secretsource.Params) (secretsource.SecretSource, error) {`
	`14`	`+ secretsource.RegisterExtension("file", func(params secretsource.Params) (secretsource.Source, error) {`
`15`	`15`	`fss := &fileSecretSource{}`
`16`	`16`	`err := fss.parseArg(params.ConfigArgument)`
`17`	`17`	`if err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ type TestPreInitState struct {`
`25`	`25`	`Logger logrus.FieldLogger`
`26`	`26`	`TracerProvider *trace.TracerProvider`
`27`	`27`	`Usage *usage.Usage`
`28`		`- SecretsManager *secretsource.SecretsManager`
	`28`	`+ SecretsManager *secretsource.Manager`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`// TestRunState contains the pre-init state as well as all of the state and`