fix: update some implementations and add more tests

Author: dnitsch

Makefile

@@ -1,7 +1,7 @@
 
 OWNER := dnitsch
 NAME := configmanager
-VERSION := v0.7.1
+VERSION := v0.8.1
 REVISION := $(shell git rev-parse --short HEAD)
 
 LDFLAGS := -ldflags="-s -w -X \"github.com/$(OWNER)/$(NAME)/cmd/configmanager.Version=$(VERSION)\" -X \"github.com/$(OWNER)/$(NAME)/cmd/configmanager.Revision=$(REVISION)\" -extldflags -static"

README.md

@@ -75,7 +75,7 @@ Alternatively you can set the path as stdout which will reduce the need to save
 >!Warning! about eval - if you are retrieving secrets from sources you don't control the input of - best to stick wtih the file approach and then delete the file.
 
 ```bash
-eval "$(AWS_PROFILE=iagadminnonprod configmanager r -t AWSSECRETS#/appxyz/service1-password -t AWSPARAMSTR#/appxyz/service12-settings -p stdout)" && ./.ignore-out.sh
+eval "$(configmanager r -t AWSSECRETS#/appxyz/service1-password -t AWSPARAMSTR#/appxyz/service12-settings -p stdout)" && ./.ignore-out.sh
 ```
 
 The token is made up of 3 parts:
@@ -112,12 +112,10 @@ func replaceTokens(in string, t *v1alpha.CustomFooCrdSpec) error {
 	m, err := configmanager.Retrieve(tokens, cnf)
 
 	if err != nil {
-		log.Error().Msgf("failed to retrieve vars from tokens. err: %s", err)
 		return err
 	}
 
 	if err := json.Unmarshal(replaceString(m, in), &t); err != nil {
-		log.Error().Msgf("failed to unmarshal back to type with replaced vars. err: %s", err)
 		return err
 	}
 	return nil

cmd/configmanager/retrieve.go

@@ -3,7 +3,6 @@ package cmd
 import (
 	"fmt"
 
-	"github.com/dnitsch/configmanager/internal/utils"
 	"github.com/dnitsch/configmanager/pkg/generator"
 	"github.com/spf13/cobra"
 )
@@ -39,9 +38,9 @@ func init() {
 }
 
 func retrieveRun(cmd *cobra.Command, args []string) error {
-
 	conf := generator.NewConfig().WithTokenSeparator(tokenSeparator).WithOutputPath(path)
-	err := utils.GenerateTokens(*conf, tokens)
+	gv := generator.NewGenerator().WithConfig(conf)
+	err := gv.GenerateFromCmd(tokens)
 	if err != nil {
 		return err
 	}

cmd/configmanager/root.go

@@ -28,11 +28,4 @@ func Execute() {
 
 func init() {
 	configmanagerCmd.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "Verbosity level")
-	// // Set global log level
-	// lvl, err := zerolog.ParseLevel(strings.ToLower(os.Getenv("LOG_LEVEL")))
-	// if err != nil {
-	// 	log.Error().Str("StartUpLogger", err.Error())
-	// 	return true, nil
-	// }
-	// logger := zerolog.New(os.Stderr).With().Timestamp().Logger().Level(lvl)
 }

configmanager.go

@@ -6,6 +6,11 @@ import (
 	"github.com/dnitsch/configmanager/pkg/generator"
 )
 
+type ConfigManager interface {
+	Retrieve(tokens []string, config generator.GenVarsConfig) (generator.ParsedMap, error)
+	Insert()
+}
+
 // Retrieve gets a rawMap from a set implementation
 // will be empty if no matches found
 func Retrieve(tokens []string, config generator.GenVarsConfig) (generator.ParsedMap, error) {

internal/utils/utils.go renamed to pkg/generator/cmd.go

@@ -1,16 +1,13 @@
-package utils
+package generator
 
 import (
 	"fmt"
 
-	"github.com/dnitsch/configmanager/pkg/generator"
 	"github.com/dnitsch/configmanager/pkg/log"
 )
 
-// GenerateTokens is a helper cmd method to call from retrieveCmd
-func GenerateTokens(config generator.GenVarsConfig, tokens []string) error {
-	gv := generator.NewGenerator()
-	gv.WithConfig(&config)
+// GenerateFromTokens is a helper cmd method to call from retrieveCmd
+func (gv *GenVars) GenerateFromCmd(tokens []string) error {
 	_, err := gv.Generate(tokens)
 	if err != nil {
 		log.Errorf("%e", err)
@@ -25,11 +22,11 @@ func GenerateTokens(config generator.GenVarsConfig, tokens []string) error {
 		log.Errorf("%e", err)
 		return err
 	}
-	log.Infof("Vars written to: %s\n", f)
+	log.Infof("Vars written to: %s", f)
 	return nil
 }
 
 //UploadTokensWithVals takes in a map of key/value pairs and uploads them
-func UploadTokensWithVals(config generator.GenVarsConfig, tokens map[string]string) error {
+func (gv *GenVars) UploadTokensWithVals(tokens map[string]string) error {
 	return fmt.Errorf("notYetImplemented")
 }

pkg/generator/cmd_test.go

@@ -0,0 +1,14 @@
+package generator
+
+import "testing"
+
+func Test_GenerateFromCmd(t *testing.T) {
+	tests := []struct {
+		name string
+	}{}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+
+		})
+	}
+}

pkg/generator/defaultstrategy.go

@@ -13,6 +13,6 @@ func (implmt *DefaultStrategy) setToken(token string) {
 func (implmt *DefaultStrategy) setValue(val string) {
 }
 
-func (implmt *DefaultStrategy) getTokenValue(v *genVars) (string, error) {
+func (implmt *DefaultStrategy) getTokenValue(v *GenVars) (string, error) {
 	return "", nil
 }

pkg/generator/generator.go

@@ -15,33 +15,27 @@ const (
 	tokenSeparator = "#"
 	// keySeparator used for accessing nested
 	// objects within the retrieved map
-	keySeparator     = "|"
-	secretMgrPrefix  = "AWSSECRETS"
-	paramStorePrefix = "AWSPARAMSTR"
-
+	keySeparator = "|"
+	//
+	// secretMgrPrefix  = "AWSSECRETS"
+	// paramStorePrefix = "AWSPARAMSTR"
 	SecretMgrPrefix  = "AWSSECRETS"
 	ParamStorePrefix = "AWSPARAMSTR"
 )
 
-// // VarPrefix maps implementation to prefix
-// type VarPrefix struct {
-// 	secretsMgr string
-// 	paramStore string
-// }
-
 var (
-	// varPrefix = VarPrefix{secretsMgr: secretMgrPrefix, paramStore: paramStorePrefix}
 	// default varPrefix
 	VarPrefix = map[string]bool{SecretMgrPrefix: true, ParamStorePrefix: true}
 )
 
-type genVarsStrategy interface {
-	getTokenValue(c *genVars) (s string, e error)
-	setToken(s string)
-	setValue(s string)
+type Generatoriface interface {
+	Generate(tokens []string) (ParsedMap, error)
+	ConvertToExportVar()
+	FlushToFile() (string, error)
 }
 
-type genVars struct {
+type GenVars struct {
+	Generatoriface
 	implementation genVarsStrategy
 	token          string
 	ctx            context.Context
@@ -56,18 +50,18 @@ type genVars struct {
 type ParsedMap map[string]any
 
 // NewGenerator returns a new instance
-func NewGenerator() *genVars {
+func NewGenerator() *GenVars {
 	defaultStrategy := NewDefatultStrategy()
 	return newGenVars(defaultStrategy)
 }
 
-func newGenVars(e genVarsStrategy) *genVars {
+func newGenVars(e genVarsStrategy) *GenVars {
 	m := ParsedMap{}
 	defaultConf := GenVarsConfig{
 		tokenSeparator: tokenSeparator,
 		keySeparator:   keySeparator,
 	}
-	return &genVars{
+	return &GenVars{
 		implementation: e,
 		rawMap:         m,
 		// return using default config
@@ -76,7 +70,7 @@ func newGenVars(e genVarsStrategy) *genVars {
 }
 
 // WithConfig uses custom config
-func (c *genVars) WithConfig(cfg *GenVarsConfig) *genVars {
+func (c *GenVars) WithConfig(cfg *GenVarsConfig) *GenVars {
 	// backwards compatibility
 	if cfg != nil {
 		c.config = *cfg
@@ -121,30 +115,13 @@ func (c *GenVarsConfig) WithKeySeparator(keySeparator string) *GenVarsConfig {
 	return c
 }
 
-func (c *genVars) setImplementation(strategy genVarsStrategy) {
-	c.implementation = strategy
-}
-
-func (c *genVars) setToken(s string) {
-	c.implementation.setToken(s)
-}
-
-func (c *genVars) setVaule(s string) {
-	c.implementation.setValue(s)
-}
-
-func (c *genVars) getTokenValue() (string, error) {
-	log.Info("Strategy implementation")
-	return c.implementation.getTokenValue(c)
-}
-
-func (c *genVars) stripPrefix(in, prefix string) string {
+func (c *GenVars) stripPrefix(in, prefix string) string {
 	return strings.Replace(in, fmt.Sprintf("%s%s", prefix, c.config.tokenSeparator), "", 1)
 }
 
 // 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) {
+func (c *GenVars) Generate(tokens []string) (ParsedMap, error) {
 
 	for _, token := range tokens {
 		prefix := strings.Split(token, c.config.tokenSeparator)[0]
@@ -160,9 +137,9 @@ func (c *genVars) Generate(tokens []string) (ParsedMap, error) {
 	return c.rawMap, nil
 }
 
-func (c *genVars) retrieveSpecific(prefix, in string) (string, error) {
+func (c *GenVars) retrieveSpecific(prefix, in string) (string, error) {
 	switch prefix {
-	case secretMgrPrefix:
+	case SecretMgrPrefix:
 		// default strategy paramstore
 		scrtMgr, err := NewSecretsMgr(c.ctx)
 		if err != nil {
@@ -171,7 +148,7 @@ func (c *genVars) retrieveSpecific(prefix, in string) (string, error) {
 		c.setImplementation(scrtMgr)
 		c.setToken(in)
 		return c.getTokenValue()
-	case paramStorePrefix:
+	case ParamStorePrefix:
 		paramStr, err := NewParamStore(c.ctx)
 		if err != nil {
 			return "", err
@@ -199,7 +176,7 @@ func isParsed(res any, trm *ParsedMap) bool {
 }
 
 // ConvertToExportVar
-func (c *genVars) ConvertToExportVar() {
+func (c *GenVars) ConvertToExportVar() {
 	for k, v := range c.rawMap {
 		rawKeyToken := strings.Split(k, "/") // assumes a path like token was used
 		topLevelKey := rawKeyToken[len(rawKeyToken)-1]
@@ -223,7 +200,7 @@ func envVarNormalize(pmap ParsedMap) ParsedMap {
 	return normalizedMap
 }
 
-func (c *genVars) exportVars(exportMap ParsedMap) {
+func (c *GenVars) exportVars(exportMap ParsedMap) {
 
 	for k, v := range exportMap {
 		// NOTE: \n line ending is not totally cross platform
@@ -244,7 +221,7 @@ func normalizeKey(k string) string {
 	return strings.ToUpper(string(r))
 }
 
-func (c *genVars) FlushToFile() (string, error) {
+func (c *GenVars) FlushToFile() (string, error) {
 
 	// moved up to
 	joinedStr := listToString(c.outString)

pkg/generator/generator_test.go

@@ -16,7 +16,7 @@ var (
 
 type fixture struct {
 	t *testing.T
-	c *genVars
+	c *GenVars
 }
 
 func newFixture(t *testing.T) *fixture {