feat: add envsubst support for fromstr command and ReplaceStringInput API method (#36)

+semver: feat 
+semver: feature
+semver: Feature

added envsubst support 

* fix: sonarqube and release tags fixed

Author: dnitsch

.github/workflows/build.yml

@@ -41,7 +41,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     container:
-      image: golang:1.23-bullseye
+      image: golang:1.24-bookworm
     needs: set-version
     env:
       SEMVER: ${{ needs.set-version.outputs.semVer }}
@@ -70,6 +70,8 @@ jobs:
       - name: Run Tests
         run: |
           task coverage
+          ls -alt .coverage/out
+          ls -lat .coverage/report-junit.xml
       - name: Publish Junit style Test Report
         uses: mikepenz/action-junit-report@v4
         if: always() # always run even if the previous step fails
@@ -84,8 +86,8 @@ jobs:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}   # Generate a token on Sonarcloud.io, add it to the secrets of this repo with the name SONAR_TOKEN (Settings > Secrets > Actions > add new repository secret)
         with:
           # Additional arguments for the sonarcloud scanner
-          args:
-            # mandatory
+          # mandatory
+          args: >
             -Dsonar.projectVersion=${{ needs.set-version.outputs.semVer }}
-            -Dsonar.go.coverage.reportPaths=/github/workspace/.coverage/out
-            -Dsonar.go.tests.reportPaths=/github/workspace/.coverage/report-junit.xml
+            -Dsonar.go.coverage.reportPaths=.coverage/out
+            -Dsonar.go.tests.reportPaths=.coverage/report-junit.xml

.github/workflows/release.yml

@@ -41,7 +41,7 @@ jobs:
   release:
     runs-on: ubuntu-latest
     container:
-      image: golang:1.23-bullseye
+      image: golang:1.24-bookworm
       env:
         FOO: Bar
     needs: set-version
@@ -73,7 +73,7 @@ jobs:
       - name: Release binary
         uses: softprops/action-gh-release@v2
         with:
-          tag_name: ${{ needs.set-version.outputs.semVer }}
+          tag_name: v${{ needs.set-version.outputs.semVer }}
           # TODO: add additional info to the release
           generate_release_notes: true
           token: ${{ secrets.GITHUB_TOKEN }}

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 dnitsch
+Copyright (c) 2025 DevLabFoundry
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

cmd/configmanager/configmanager.go

@@ -22,6 +22,7 @@ type rootCmdFlags struct {
 	verbose        bool
 	tokenSeparator string
 	keySeparator   string
+	enableEnvSubst bool
 }
 
 type Root struct {
@@ -47,6 +48,7 @@ func NewRootCmd(logger log.ILogger) *Root { //channelOut, channelErr io.Writer
 	rc.Cmd.PersistentFlags().BoolVarP(&rc.rootFlags.verbose, "verbose", "v", false, "Verbosity level")
 	rc.Cmd.PersistentFlags().StringVarP(&rc.rootFlags.tokenSeparator, "token-separator", "s", "#", "Separator to use to mark concrete store and the key within it")
 	rc.Cmd.PersistentFlags().StringVarP(&rc.rootFlags.keySeparator, "key-separator", "k", "|", "Separator to use to mark a key look up in a map. e.g. AWSSECRETS#/token/map|key1")
+	rc.Cmd.PersistentFlags().BoolVarP(&rc.rootFlags.enableEnvSubst, "enable-envsubst", "e", false, "Enable envsubst on input. This will fail on any unset or empty variables")
 	addSubCmds(rc)
 	return rc
 }
@@ -70,7 +72,7 @@ func cmdutilsInit(rootCmd *Root, cmd *cobra.Command, path string) (*cmdutils.Cmd
 	}
 
 	cm := configmanager.New(cmd.Context())
-	cm.Config.WithTokenSeparator(rootCmd.rootFlags.tokenSeparator).WithOutputPath(path).WithKeySeparator(rootCmd.rootFlags.keySeparator)
+	cm.Config.WithTokenSeparator(rootCmd.rootFlags.tokenSeparator).WithOutputPath(path).WithKeySeparator(rootCmd.rootFlags.keySeparator).WithEnvSubst(rootCmd.rootFlags.enableEnvSubst)
 	gnrtr := generator.NewGenerator(cmd.Context(), func(gv *generator.GenVars) {
 		if rootCmd.rootFlags.verbose {
 			rootCmd.logger.SetLevel(log.DebugLvl)

cmd/configmanager/fromfileinput_test.go

@@ -13,4 +13,7 @@ func TestFromStr_command(t *testing.T) {
 	t.Run("should error on missing flag", func(t *testing.T) {
 		cmdRunTestHelper(t, &cmdTestInput{args: []string{"fromstr", "--path", "testdata/input.yml"}, errored: true})
 	})
+	t.Run("should error on missing var when envsubst enabled", func(t *testing.T) {
+		cmdRunTestHelper(t, &cmdTestInput{args: []string{"fromstr", "--input", "foo AWSPARAMSTR://${NOT_FOUND}", "-s", "://", "--enable-envsubst", "--path", "stdout"}, errored: true})
+	})
 }

cmd/configmanager/insert.go

@@ -20,7 +20,6 @@ func newInsertCmd(rootCmd *Root) {
 		Long:    ``,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return fmt.Errorf("not yet implemented")
-
 		},
 		PreRunE: func(cmd *cobra.Command, args []string) error {
 			if len(f.insertKv) < 1 {

configmanager.go

@@ -3,13 +3,15 @@ package configmanager
 import (
 	"context"
 	"encoding/json"
+	"errors"
 	"fmt"
 	"regexp"
 	"slices"
 	"strings"
 
 	"github.com/DevLabFoundry/configmanager/internal/config"
 	"github.com/DevLabFoundry/configmanager/pkg/generator"
+	"github.com/a8m/envsubst"
 	"gopkg.in/yaml.v3"
 )
 
@@ -66,10 +68,24 @@ func (c *ConfigManager) retrieve(tokens []string) (generator.ParsedMap, error) {
 	return c.generator.Generate(tokens)
 }
 
+var ErrEnvSubst = errors.New("envsubst enabled and errored on")
+
 // RetrieveWithInputReplaced parses given input against all possible token strings
 // using regex to grab a list of found tokens in the given string and returns the replaced string
 func (c *ConfigManager) RetrieveWithInputReplaced(input string) (string, error) {
-
+	// replaces all env vars using strict mode of no unset and no empty
+	//
+	// NOTE: this happens before the FindTokens is called
+	// currently it uses a regex, and envsubst uses a more robust lexer => parser mechanism
+	//
+	// NOTE: configmanager needs an own lexer => parser to allow for easier modification extension in the future
+	if c.GeneratorConfig().EnvSubstEnabled() {
+		var err error
+		input, err = envsubst.StringRestrictedNoDigit(input, true, true, false)
+		if err != nil {
+			return "", fmt.Errorf("%w\n%v", ErrEnvSubst, err)
+		}
+	}
 	m, err := c.retrieve(FindTokens(input))
 
 	if err != nil {

configmanager_test.go

@@ -3,6 +3,7 @@ package configmanager_test
 import (
 	"context"
 	"fmt"
+	"os"
 	"reflect"
 	"sort"
 	"testing"
@@ -169,6 +170,45 @@ foo23 = val1
 	}
 }
 
+func Test_replaceString_with_envsubst(t *testing.T) {
+	t.Parallel()
+	ttests := map[string]struct {
+		expect string
+		setup  func() func()
+		input  string
+		genvar *mockGenerator
+	}{
+		"replaced successfully": {
+			input:  `{"patchPayloadTemplate":"{"password":"FOO#/${BAR}","passwordConfirm":"FOO#/${BAZ:-test}"}}`,
+			expect: `{"patchPayloadTemplate":"{"password":"val1","passwordConfirm":"val1"}}`,
+			genvar: &mockGenerator{},
+			setup: func() func() {
+				os.Setenv("BAR", "test")
+				return func() {
+					os.Unsetenv("BAR")
+				}
+			},
+		},
+	}
+	for name, tt := range ttests {
+		t.Run(name, func(t *testing.T) {
+			tearDown := tt.setup()
+			defer tearDown()
+
+			cm := configmanager.New(context.TODO())
+			cm.WithGenerator(tt.genvar)
+			cm.Config.WithEnvSubst(true)
+			got, err := cm.RetrieveWithInputReplaced(tt.input)
+			if err != nil {
+				t.Errorf("failed with %v", err)
+			}
+			if got != tt.expect {
+				t.Errorf(testutils.TestPhrase, got, tt.expect)
+			}
+		})
+	}
+}
+
 type testSimpleStruct struct {
 	Foo string `json:"foo" yaml:"foo"`
 	Bar string `json:"bar" yaml:"bar"`
@@ -583,7 +623,7 @@ func Test_Generator_Config_(t *testing.T) {
 			}
 			got := cm.GeneratorConfig()
 			if diff := deep.Equal(got, &tt.expect); diff != nil {
-				t.Errorf(testutils.TestPhraseWithContext, "generator config", fmt.Sprintf("%q", got), fmt.Sprintf("%q", tt.expect))
+				t.Errorf(testutils.TestPhraseWithContext, "generator config", fmt.Sprintf("%v", got), fmt.Sprintf("%v", tt.expect))
 			}
 		})
 	}

go.mod

@@ -1,6 +1,8 @@
 module github.com/DevLabFoundry/configmanager
 
-go 1.23.2
+go 1.24
+
+toolchain go1.24.2
 
 require (
 	cloud.google.com/go/secretmanager v1.14.6
@@ -30,6 +32,7 @@ require (
 	github.com/Azure/azure-sdk-for-go/sdk/internal v1.10.0 // indirect
 	github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/internal v1.1.1 // indirect
 	github.com/AzureAD/microsoft-authentication-library-for-go v1.4.2 // indirect
+	github.com/a8m/envsubst v1.4.3
 	github.com/aws/aws-sdk-go v1.55.6 // indirect
 	github.com/aws/aws-sdk-go-v2/credentials v1.17.65 // indirect
 	github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.16.30 // indirect
@@ -49,7 +52,6 @@ require (
 	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/golang-jwt/jwt/v5 v5.2.2 // indirect
-	github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect
 	github.com/google/s2a-go v0.1.9 // indirect
 	github.com/google/uuid v1.6.0 // indirect
 	github.com/googleapis/enterprise-certificate-proxy v0.3.6 // indirect
@@ -76,7 +78,6 @@ require (
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/ryanuber/go-glob v1.0.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
-	go.opencensus.io v0.24.0 // indirect
 	go.opentelemetry.io/auto/sdk v1.1.0 // indirect
 	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.60.0 // indirect
 	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.60.0 // indirect