Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix context passed when resolving secrets in config file #2068

Merged
merged 3 commits into from
May 19, 2022
Merged

Fix context passed when resolving secrets in config file #2068

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
672162e
Fix context passed when resolving secrets in config file
carolynvs May 16, 2022
e15a375
Merge branch 'release/v1' into fix-context-hierarchy-during-load
carolynvs May 17, 2022
5c36f45
Merge branch 'release/v1' into fix-context-hierarchy-during-load
carolynvs May 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions pkg/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ func (c *Config) GetBuildDriver() string {
// Load loads the configuration file, rendering any templating used in the config file
// such as ${secret.NAME} or ${env.NAME}.
// Pass nil for resolveSecret to skip resolving secrets.
func (c *Config) Load(ctx context.Context, resolveSecret func(secretKey string) (string, error)) error {
func (c *Config) Load(ctx context.Context, resolveSecret func(ctx context.Context, secretKey string) (string, error)) error {
ctx, log := tracing.StartSpan(ctx)
defer log.EndSpan()

Expand Down Expand Up @@ -345,7 +345,7 @@ func (c *Config) loadFirstPass(ctx context.Context) error {
return c.loadData(ctx, templateData)
}

func (c *Config) loadFinalPass(ctx context.Context, resolveSecret func(secretKey string) (string, error)) error {
func (c *Config) loadFinalPass(ctx context.Context, resolveSecret func(ctx context.Context, secretKey string) (string, error)) error {
ctx, log := tracing.StartSpan(ctx)
defer log.EndSpan()

Expand All @@ -366,9 +366,9 @@ func (c *Config) loadFinalPass(ctx context.Context, resolveSecret func(secretKey

secretKey := variable[len(secretPrefix):]

_, childLog := log.StartSpanWithName("resolveSecret", attribute.String("porter.config.secret.key", secretKey))
ctx, childLog := log.StartSpanWithName("resolveSecret", attribute.String("porter.config.secret.key", secretKey))
defer childLog.EndSpan()
secretValue, err := resolveSecret(secretKey)
secretValue, err := resolveSecret(ctx, secretKey)
if err != nil {
return childLog.Error(errors.Wrapf(err, "could not render config file because ${secret.%s} could not be resolved", secretKey))
}
Expand Down
2 changes: 1 addition & 1 deletion pkg/config/loader_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ func TestData_Marshal(t *testing.T) {
c.TestContext.AddTestFile("testdata/config.toml", "/home/myuser/.porter/config.toml")

c.DataLoader = LoadFromEnvironment()
resolveTestSecrets := func(secretKey string) (string, error) {
resolveTestSecrets := func(ctx context.Context, secretKey string) (string, error) {
return "topsecret-connectionstring", nil
}
err := c.Load(context.Background(), resolveTestSecrets)
Expand Down
4 changes: 2 additions & 2 deletions pkg/porter/porter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ func NewFor(c *config.Config, store storage.Store, secretStorage secrets.Store)
// It is the responsibility of the caller to also call Close when done with Porter.
func (p *Porter) Connect(ctx context.Context) error {
// Load the config file and replace any referenced secrets
return p.Config.Load(ctx, func(secret string) (string, error) {
value, err := p.Secrets.Resolve(ctx, "secret", secret)
return p.Config.Load(ctx, func(innerCtx context.Context, secret string) (string, error) {
value, err := p.Secrets.Resolve(innerCtx, "secret", secret)
if err != nil {
if strings.Contains(err.Error(), "invalid value source: secret") {
return "", errors.New("No secret store account is configured")
Expand Down