Replace string replace w lexer (#12)

* fix: add strings.Replace

* fix: remove unused methods

* fix: pkg generator layout changes (still work to do there...)

updated tests

Author: dnitsch

Makefile

@@ -1,7 +1,7 @@
 
 OWNER := dnitsch
 NAME := configmanager
-GIT_TAG := "1.17.3"
+GIT_TAG := "1.18.0"
 VERSION := "v$(GIT_TAG)"
 # VERSION := "$(shell git describe --tags --abbrev=0)"
 REVISION := $(shell git rev-parse --short HEAD)
@@ -57,5 +57,5 @@ echo:
 
 tagbuildrelease: tag cross-build release
 
-coverage_interactive: test
+show_coverage: test
 	go tool cover -html=.coverage/out

configmanager.go

@@ -58,25 +58,34 @@ func retrieveWithInputReplaced(input string, gv GenerateAPI) (string, error) {
 
 // replaceString fills tokens in a provided input with their actual secret/config values
 func replaceString(inputMap generator.ParsedMap, inputString string) string {
+
+	oldNew := []string(nil)
+	// ordered values by index
+	for _, ov := range orderedKeysList(inputMap) {
+		oldNew = append(oldNew, ov, fmt.Sprint(inputMap[ov]))
+	}
+	replacer := strings.NewReplacer(oldNew...)
+	return replacer.Replace(inputString)
+}
+
+func orderedKeysList(inputMap generator.ParsedMap) []string {
 	mkeys := make([]string, 0, len(inputMap))
 	for k := range inputMap {
 		mkeys = append(mkeys, k)
 	}
 
-	// order map by keys length
-	sort.Slice(mkeys, func(i, j int) bool {
+	// order map by keys length so that when passed to the
+	// replacer it will replace the longest first
+	// removing the possibility of partially overwriting
+	// another token with same prefix
+	sort.SliceStable(mkeys, func(i, j int) bool {
 		l1, l2 := len(mkeys[i]), len(mkeys[j])
 		if l1 != l2 {
 			return l1 > l2
 		}
 		return mkeys[i] > mkeys[j]
 	})
-
-	// ordered values by index
-	for _, oval := range mkeys {
-		inputString = strings.ReplaceAll(inputString, oval, fmt.Sprint(inputMap[oval]))
-	}
-	return inputString
+	return mkeys
 }
 
 type CMRetrieveWithInputReplacediface interface {
@@ -172,8 +181,3 @@ func RetrieveUnmarshalledFromYaml[T any](input []byte, output *T, cm CMRetrieveW
 	}
 	return output, nil
 }
-
-// Insert will update
-func (c *ConfigManager) Insert(force bool) error {
-	return fmt.Errorf("not yet implemented")
-}

go.mod

@@ -9,6 +9,7 @@ require (
 	github.com/aws/aws-sdk-go-v2/config v1.18.8
 	github.com/aws/aws-sdk-go-v2/service/secretsmanager v1.18.1
 	github.com/aws/aws-sdk-go-v2/service/ssm v1.35.0
+	github.com/go-test/deep v1.0.2
 	github.com/rs/zerolog v1.28.0
 	github.com/spf13/cobra v1.6.1
 )

go.sum

@@ -96,6 +96,7 @@ github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9
 github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V4qmtdjCk=
 github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY=
 github.com/go-test/deep v1.0.2 h1:onZX1rnHT3Wv6cqNgYyFOOlgVKJrksuCMCRvJStbMYw=
+github.com/go-test/deep v1.0.2/go.mod h1:wGDj63lr65AM2AQyKZd/NYHGb0R+1RLqB8NKt3aSFNA=
 github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
 github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ=
 github.com/golang-jwt/jwt/v4 v4.4.2 h1:rcc4lwaZgFMCZ5jxF9ABolDcIHdBytAFgqFPbSJQAYs=

internal/cmdutils/cmdutils.go

@@ -126,7 +126,7 @@ func (c *CmdUtils) generateFromStrOutOverwrite(input, outtemp string, outtmp io.
 	}
 
 	// move temp file to output path
-	return os.WriteFile(c.generator.ConfigOutputPath(), tr, 0644)
+	return os.WriteFile(c.generator.Config().OutputPath(), tr, 0644)
 }
 
 // generateStrOutFromInput takes a reader and writer as input

internal/cmdutils/cmdutils_test.go

@@ -116,9 +116,7 @@ func Test_generateFromStrOutOverwrite(t *testing.T) {
 			},
 			genMock: func(t *testing.T, out string) generator.GenVarsiface {
 				gen := &mockGenVars{}
-				gen.confOutputPath = out
-				gen.config = generator.NewConfig()
-
+				gen.config = generator.NewConfig().WithOutputPath(out)
 				return gen
 			},
 			in:     "pass=FOO#/test",

pkg/generator/config.go

@@ -0,0 +1,51 @@
+package generator
+
+// GenVarsConfig defines the input config object to be passed
+type GenVarsConfig struct {
+	outpath        string
+	tokenSeparator string
+	keySeparator   string
+}
+
+// NewConfig
+func NewConfig() *GenVarsConfig {
+	return &GenVarsConfig{
+		tokenSeparator: tokenSeparator,
+		keySeparator:   keySeparator,
+	}
+}
+
+// WithOutputPath
+func (c *GenVarsConfig) WithOutputPath(out string) *GenVarsConfig {
+	c.outpath = out
+	return c
+}
+
+// WithTokenSeparator adds a custom token separator
+// token is the actual value of the parameter/secret in the
+// provider store
+func (c *GenVarsConfig) WithTokenSeparator(tokenSeparator string) *GenVarsConfig {
+	c.tokenSeparator = tokenSeparator
+	return c
+}
+
+// WithKeySeparator adds a custom key separotor
+func (c *GenVarsConfig) WithKeySeparator(keySeparator string) *GenVarsConfig {
+	c.keySeparator = keySeparator
+	return c
+}
+
+// OutputPath returns the outpath set in the config
+func (c *GenVarsConfig) OutputPath() string {
+	return c.outpath
+}
+
+// TokenSeparator returns the tokenSeparator set in the config
+func (c *GenVarsConfig) TokenSeparator() string {
+	return c.tokenSeparator
+}
+
+// KeySeparator returns the keySeparator set in the config
+func (c *GenVarsConfig) KeySeparator() string {
+	return c.keySeparator
+}

pkg/generator/gcpsecrets.go

@@ -40,9 +40,6 @@ func (imp *GcpSecrets) setToken(token string) {
 	imp.token = token
 }
 
-func (imp *GcpSecrets) setValue(val string) {
-}
-
 func (imp *GcpSecrets) getTokenValue(v *retrieveStrategy) (string, error) {
 	defer imp.close()
 

pkg/generator/gcpsecrets_test.go

@@ -18,25 +18,27 @@ func (m mockGcpSecretsApi) AccessSecretVersion(ctx context.Context, req *gcpsecr
 	return m(ctx, req, opts...)
 }
 
+var TEST_GCP_CREDS = []byte(`{
+	"type": "service_account",
+	"project_id": "xxxxx",
+	"private_key_id": "yyyyyyyyyyyy",
+	"private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDf842hcn5Nvp6e\n7yKARaCVIDfLXpKDhRwUOvHMzJ1ioRgQo/kbv1n4yHGCSUFyY6hKGj0HBjaGj5kE\n79H/6Y3dJNGhnsMnxBhHdo+3FI8QF0CHZh460NMZSAJ41UMQSBGssGVsNfyUzXGH\nLc45sIx/Twx3yr1k2GD3E8FlDcKlZqa3xGHf+aipg2X3NxbYi+Sz7Yed+SOMhNHl\ncX6E/TqG9n1aTyIwjMIHscCYarJqURkJxr24ukDroCeMxAfxYTdMvRU2e8pFEdoY\nrgUC88fYfaVI5txJ6j/ZKauKQX9Pa8tSyXJeGva3JYp4VC7V4IyoVviCUgEGWZDN\n6/i3zoF/AgMBAAECggEAcVBCcVYFIkE48SH+Svjv74SFtpj7eSB4vKO2hPFjEOyB\nyKmu+aMwWvjQtiNqwf46wIPWLR+vpxYxTpYpo1sBNMvUZfp2tEA8KKyMuw3j9ThO\npjO9R/UxWrFcztbZP/u3NbFrH/2Q95mbv9IlbnsuG5xbqqEig0wYg+uzBvaXbig3\n/Jr0vLT2BkRCBKQkYGjVZcHlHVLoF7/J8cghFgkV1PGvknOv6/q7qzn9L4TjQIet\nfhrhN8Z1vgFiSYtpjP6YQEUEPSHmCQeD3WzJcnASPpU2uCUwd/z65ltKPnn+rqMt\n6jt9R1S1Ju2ZSjv+kR5fIXzihdOzncyzDDm33c/QwQKBgQD2QDZuzLjTxnhsfGii\nKJDAts+Jqfs/6SeEJcJKtEngj4m7rgzyEjbKVp8qtRHIzglKRWAe62/qzzy2BkKi\nvAd4+ZzmG2SkgypGsKVfjGXVFixz2gtUdmBOmK/TnYsxNT9yTt+rX9IGqKK60q73\nOWl8VsliLIsfvSH7+bqi7sRcXQKBgQDo0VUebyQHoTAXPdzGy2ysrVPDiHcldH0Y\n/hvhQTZwxYaJr3HpOCGol2Xl6zyawuudEQsoQwJ3Li6yeb0YMGiWX77/t+qX3pSn\nkGuoftGaNDV7sLn9UV2y+InF8EL1CasrhG1k5RIuxyfV0w+QUo+E7LpVR5XkbJqT\n9QNKnDQXiwKBgQDvvEYCCqbp7e/xVhEbxbhfFdro4Cat6tRAz+3egrTlvXhO0jzi\nMp9Kz5f3oP5ma0gaGX5hu75icE1fvKqE+d+ghAqe7w5FJzkyRulJI0tEb2jphN7A\n5NoPypBqyZboWjmhlG4mzouPVf/POCuEnk028truDAWJ6by7Lj3oP+HFNQKBgQCc\n5BQ8QiFBkvnZb7LLtGIzq0n7RockEnAK25LmJRAOxs13E2fsBguIlR3x5qgckqY8\nXjPqmd2bet+1HhyzpEuWqkcIBGRum2wJz2T9UxjklbJE/D8Z2i8OYDZX0SUOA8n5\ntXASwduS8lqB2Y1vcHOO3AhlV6xHFnjEpCPnr4PbKQKBgAhQ9D9MPeuz+5yw3yHg\nkvULZRtud+uuaKrOayprN25RTxr9c0erxqnvM7KHeo6/urOXeEa7x2n21kAT0Nch\nkF2RtWBLZKXGZEVBtw1Fw0UKNh4IDgM26dwlzRfTVHCiw6M6dCiTNk9KkP2vlkim\n3QFDSSUp+eBTXA17WkDAQf7w\n-----END PRIVATE KEY-----\n",
+	"client_email": "[email protected]",
+	"client_id": "99999911111111",
+	"auth_uri": "https://accounts.google.com/o/oauth2/auth",
+	"token_uri": "https://oauth2.googleapis.com/token",
+	"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+	"client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/bla"
+  }`)
+
 func fixtureInitMockClient() struct {
 	name   string
 	close  func() error
 	delete func(name string) error
 } {
-	creds := []byte(`{
-		"type": "service_account",
-		"project_id": "xxxxx",
-		"private_key_id": "yyyyyyyyyyyy",
-		"private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDf842hcn5Nvp6e\n7yKARaCVIDfLXpKDhRwUOvHMzJ1ioRgQo/kbv1n4yHGCSUFyY6hKGj0HBjaGj5kE\n79H/6Y3dJNGhnsMnxBhHdo+3FI8QF0CHZh460NMZSAJ41UMQSBGssGVsNfyUzXGH\nLc45sIx/Twx3yr1k2GD3E8FlDcKlZqa3xGHf+aipg2X3NxbYi+Sz7Yed+SOMhNHl\ncX6E/TqG9n1aTyIwjMIHscCYarJqURkJxr24ukDroCeMxAfxYTdMvRU2e8pFEdoY\nrgUC88fYfaVI5txJ6j/ZKauKQX9Pa8tSyXJeGva3JYp4VC7V4IyoVviCUgEGWZDN\n6/i3zoF/AgMBAAECggEAcVBCcVYFIkE48SH+Svjv74SFtpj7eSB4vKO2hPFjEOyB\nyKmu+aMwWvjQtiNqwf46wIPWLR+vpxYxTpYpo1sBNMvUZfp2tEA8KKyMuw3j9ThO\npjO9R/UxWrFcztbZP/u3NbFrH/2Q95mbv9IlbnsuG5xbqqEig0wYg+uzBvaXbig3\n/Jr0vLT2BkRCBKQkYGjVZcHlHVLoF7/J8cghFgkV1PGvknOv6/q7qzn9L4TjQIet\nfhrhN8Z1vgFiSYtpjP6YQEUEPSHmCQeD3WzJcnASPpU2uCUwd/z65ltKPnn+rqMt\n6jt9R1S1Ju2ZSjv+kR5fIXzihdOzncyzDDm33c/QwQKBgQD2QDZuzLjTxnhsfGii\nKJDAts+Jqfs/6SeEJcJKtEngj4m7rgzyEjbKVp8qtRHIzglKRWAe62/qzzy2BkKi\nvAd4+ZzmG2SkgypGsKVfjGXVFixz2gtUdmBOmK/TnYsxNT9yTt+rX9IGqKK60q73\nOWl8VsliLIsfvSH7+bqi7sRcXQKBgQDo0VUebyQHoTAXPdzGy2ysrVPDiHcldH0Y\n/hvhQTZwxYaJr3HpOCGol2Xl6zyawuudEQsoQwJ3Li6yeb0YMGiWX77/t+qX3pSn\nkGuoftGaNDV7sLn9UV2y+InF8EL1CasrhG1k5RIuxyfV0w+QUo+E7LpVR5XkbJqT\n9QNKnDQXiwKBgQDvvEYCCqbp7e/xVhEbxbhfFdro4Cat6tRAz+3egrTlvXhO0jzi\nMp9Kz5f3oP5ma0gaGX5hu75icE1fvKqE+d+ghAqe7w5FJzkyRulJI0tEb2jphN7A\n5NoPypBqyZboWjmhlG4mzouPVf/POCuEnk028truDAWJ6by7Lj3oP+HFNQKBgQCc\n5BQ8QiFBkvnZb7LLtGIzq0n7RockEnAK25LmJRAOxs13E2fsBguIlR3x5qgckqY8\nXjPqmd2bet+1HhyzpEuWqkcIBGRum2wJz2T9UxjklbJE/D8Z2i8OYDZX0SUOA8n5\ntXASwduS8lqB2Y1vcHOO3AhlV6xHFnjEpCPnr4PbKQKBgAhQ9D9MPeuz+5yw3yHg\nkvULZRtud+uuaKrOayprN25RTxr9c0erxqnvM7KHeo6/urOXeEa7x2n21kAT0Nch\nkF2RtWBLZKXGZEVBtw1Fw0UKNh4IDgM26dwlzRfTVHCiw6M6dCiTNk9KkP2vlkim\n3QFDSSUp+eBTXA17WkDAQf7w\n-----END PRIVATE KEY-----\n",
-		"client_email": "[email protected]",
-		"client_id": "99999911111111",
-		"auth_uri": "https://accounts.google.com/o/oauth2/auth",
-		"token_uri": "https://oauth2.googleapis.com/token",
-		"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
-		"client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/bla"
-	  }`)
+
 	cf, _ := os.CreateTemp(".", "*")
-	cf.Write(creds)
+	cf.Write(TEST_GCP_CREDS)
 	resp := struct {
 		name   string
 		close  func() error

pkg/generator/generator.go

@@ -57,7 +57,6 @@ type Generatoriface interface {
 type GenVarsiface interface {
 	Generatoriface
 	Config() *GenVarsConfig
-	ConfigOutputPath() string
 }
 
 type muRawMap struct {
@@ -76,15 +75,12 @@ type GenVars struct {
 	ctx       context.Context
 	config    GenVarsConfig
 	outString []string
-	// rawMap is the internal object that holds the values of original token => retrieved value - decrypted in plain text
+	// rawMap is the internal object that holds the values
+	// of original token => retrieved value - decrypted in plain text
+	// with a mutex RW locker
 	rawMap muRawMap //ParsedMap
 }
 
-// setValue implements GenVarsiface
-func (*GenVars) setValue(s string) {
-	panic("unimplemented")
-}
-
 // ParsedMap is the internal working object definition and
 // the return type if results are not flushed to file
 type ParsedMap map[string]any
@@ -131,12 +127,6 @@ func (c *GenVars) Config() *GenVarsConfig {
 	return &c.config
 }
 
-// ConfigOutputPath returns the output path set on GenVars create
-// withconfig or default value
-func (c *GenVars) ConfigOutputPath() string {
-	return c.config.outpath
-}
-
 func (c *GenVars) RawMap() ParsedMap {
 	c.rawMap.RLock()
 	defer c.rawMap.RUnlock()
@@ -154,41 +144,6 @@ func (c *GenVars) AddRawMap(key, val string) {
 	c.rawMap.tokenMap[key] = c.keySeparatorLookup(key, val)
 }
 
-// GenVarsConfig defines the input config object to be passed
-type GenVarsConfig struct {
-	outpath        string
-	tokenSeparator string
-	keySeparator   string
-}
-
-// NewConfig
-func NewConfig() *GenVarsConfig {
-	return &GenVarsConfig{
-		tokenSeparator: tokenSeparator,
-		keySeparator:   keySeparator,
-	}
-}
-
-// WithOutputPath
-func (c *GenVarsConfig) WithOutputPath(out string) *GenVarsConfig {
-	c.outpath = out
-	return c
-}
-
-// WithTokenSeparator adds a custom token separator
-// token is the actual value of the parameter/secret in the
-// provider store
-func (c *GenVarsConfig) WithTokenSeparator(tokenSeparator string) *GenVarsConfig {
-	c.tokenSeparator = tokenSeparator
-	return c
-}
-
-// WithKeySeparator adds a custom key separotor
-func (c *GenVarsConfig) WithKeySeparator(keySeparator string) *GenVarsConfig {
-	c.keySeparator = keySeparator
-	return c
-}
-
 // Generate generates a k/v map of the tokens with their corresponding secret/paramstore values
 // the standard pattern of a token should follow a path like
 func (c *GenVars) Generate(tokens []string) (ParsedMap, error) {
@@ -215,7 +170,8 @@ type chanResp struct {
 }
 
 type retrieveIface interface {
-	retrieveSpecificCh(ctx context.Context, prefix ImplementationPrefix, in string) chanResp
+	RetrieveByToken(ctx context.Context, impl genVarsStrategy, prefix ImplementationPrefix, in string) chanResp
+	SelectImplementation(ctx context.Context, prefix ImplementationPrefix, in string, config *GenVarsConfig) (genVarsStrategy, error)
 }
 
 // generate checks if any tokens found
@@ -238,7 +194,12 @@ func (c *GenVars) generate(rawMap map[string]string, rs retrieveIface) error {
 	for token, prefix := range rawMap {
 		go func(a string, p ImplementationPrefix) {
 			defer wg.Done()
-			outCh <- rs.retrieveSpecificCh(c.ctx, p, a)
+			strategy, err := rs.SelectImplementation(c.ctx, p, a, c.Config())
+			if err != nil {
+				outCh <- chanResp{err: err}
+				return
+			}
+			outCh <- rs.RetrieveByToken(c.ctx, strategy, p, a)
 		}(token, ImplementationPrefix(prefix))
 	}