Allowing {name} to be replaced in key formats and labels.

TODO.md

@@ -52,13 +52,12 @@
 - [x] Fix: Remove support for optional properties, define them in lower layer instead??? should be an error
 - [x] Fix: Bad logging (racoon WARN[0000] dotenv file local.env was not found ... racoon DEBU[0000] dotenv file local.env loaded)
 - [x] Feature: Allow prefix for dotenv output (could be used to do "export FOO=bar" or "MYSVC_FOO=bar")
+- [x] Feature: Allow {name} to be replaced with the manifest name
 
 - [ ] (in-progress) Initial round of real world testing
 
-- [ ] Feature: Allow {name} to be replaced with the manifest name (make sure we support this everywhere)
 - [ ] Feature: Add output type "combine", that combines aliased outputs
 - [ ] Feature: Comments in dotenv output? To add generated by comment and possibly include property name and description?
-
 - [ ] More tests on multiple levels and components (e2e, unit etc)
 - [ ] Feature: Cleanup command to remove files specified in outputs
 - [ ] Feature: Conditional outputs, based on same matching method as layers

internal/api/encrypted.go

@@ -24,17 +24,17 @@ type EncryptedProperty struct {
 	Value       *string `json:"value" yaml:"value"`
 }
 
-func NewEncryptedConfig(m config.Manifest, p config.OrderedParameterList, backend backend.Backend) *EncryptedConfig {
+func NewEncryptedConfig(ctx config.AppContext, backend backend.Backend) *EncryptedConfig {
 	ec := EncryptedConfig{
 		backend:    backend,
-		parameters: p,
+		parameters: ctx.Parameters,
 
-		Name:       m.Name,
+		Name:       ctx.Manifest.Name,
 		Labels:     make(map[string]string),
 		Properties: make([]EncryptedProperty, 0),
 	}
-	for k, v := range m.Labels {
-		ec.Labels[k] = p.Replace(v)
+	for k, v := range ctx.Manifest.Labels {
+		ec.Labels[k] = ctx.Replace(v)
 	}
 	return &ec
 }

internal/command/export.go

@@ -78,7 +78,7 @@ func Export(metadata config.AppMetadata) *cli.Command {
 				return err
 			}
 
-			encconf := api.NewEncryptedConfig(m, ctx.Parameters, backend)
+			encconf := api.NewEncryptedConfig(ctx, backend)
 
 			visit := visitor.New(ctx)
 
@@ -173,7 +173,7 @@ func Export(metadata config.AppMetadata) *cli.Command {
 						continue
 					}
 
-					path = ctx.Parameters.Replace(path)
+					path = ctx.Replace(path)
 
 					filtered := []string{}
 					filteredValues := make(map[string]string)

internal/config/context.go

@@ -2,6 +2,7 @@ package config
 
 import (
 	"context"
+	"strings"
 
 	"github.com/dotnetmentor/racoon/internal/environment"
 	"github.com/sirupsen/logrus"
@@ -28,6 +29,13 @@ type AppMetadata struct {
 	Date    string
 }
 
+func (c AppContext) Replace(format string) string {
+	fv := format
+	fv = strings.ReplaceAll(fv, "{name}", c.Manifest.Name)
+	fv = c.Parameters.replace(fv)
+	return fv
+}
+
 func NewContext(metadata AppMetadata, paths ...string) (AppContext, error) {
 	l := logrus.New()
 	l.Formatter = &PrefixedTextFormatter{

internal/config/parameter.go

@@ -4,6 +4,8 @@ import (
 	"fmt"
 	"regexp"
 	"strings"
+
+	"github.com/dotnetmentor/racoon/internal/utils"
 )
 
 type parameters map[string]string
@@ -40,10 +42,16 @@ func (p parameters) ValidateParams(pl ParameterConfigList) error {
 		}
 	}
 
+	reserved := []string{"name", "key"}
+
 	// validate parameters
 	for _, pc := range pl {
 		pv, ok := p[pc.Key]
 
+		if utils.StringSliceContains(reserved, pc.Key) {
+			return fmt.Errorf("parameter key \"%s\" is reserved and cannot be used", pc.Key)
+		}
+
 		if pc.Required {
 			if !ok {
 				return fmt.Errorf("required parameter must be set, parameter: %s", pc.Key)
@@ -79,7 +87,7 @@ func (p parameters) Ordered(pl ParameterConfigList) (ordered OrderedParameterLis
 	return ordered
 }
 
-func (op OrderedParameterList) Replace(s string) string {
+func (op OrderedParameterList) replace(s string) string {
 	for _, p := range op {
 		s = strings.ReplaceAll(s, fmt.Sprintf("{%s}", p.Key), p.Value)
 	}

internal/store/awsParameterStore.go

@@ -39,7 +39,7 @@ func (s *AwsParameterStore) Read(ctx config.AppContext, layer api.Layer, key str
 		return api.NewValue(api.NewValueSource(layer, api.SourceTypeAwsParameterStore), "", "", missingKeyError(), sensitive || sourceConfig.ForceSensitive)
 	}
 
-	psk := awpParameterStoreKey(ctx.Parameters.Replace(pskf), key)
+	psk := awpParameterStoreKey(ctx.Replace(pskf), key)
 	ctx.Log.Debugf("reading %s from %s", psk, config.SourceTypeAwsParameterStore)
 	out, err := s.client.GetParameter(ctx.Context, &ssm.GetParameterInput{
 		Name:           &psk,
@@ -101,7 +101,7 @@ func (s *AwsParameterStore) Write(ctx config.AppContext, key, value, description
 	})
 
 	for k, v := range ctx.Manifest.Labels {
-		fv := ctx.Parameters.Replace(v)
+		fv := ctx.Replace(v)
 		tags = append(tags, ssmtypes.Tag{
 			Key:   aws.String(k),
 			Value: aws.String(fv),

internal/store/environment.go

@@ -22,7 +22,7 @@ type Environment struct {
 
 func (s *Environment) Read(ctx config.AppContext, layer api.Layer, key string, sensitive bool, propertySource config.ValueFromEvnironment, sourceConfig config.EnvConfig) api.Value {
 	for _, dff := range sourceConfig.Dotfiles {
-		df := ctx.Parameters.Replace(dff)
+		df := ctx.Replace(dff)
 		if utils.StringSliceContains(s.dotfilesLoaded, df) {
 			continue
 		}