Skip to content

Commit

Permalink
refactor(sharing_outputs): no default value for the sensitive fields. (…
Browse files Browse the repository at this point in the history 
…#1927)

## What this PR does / why we need it:

Backport of #1926 to
`v0.10.x` branch.

## Which issue(s) this PR fixes:
none

## Special notes for your reviewer:

## Does this PR introduce a user-facing change?
```
yes, change the behavior.
```
  • Loading branch information
@i4ki
i4ki authored Oct 17, 2024
2 parents 7143077 + 5a0df59 commit 110f853
Show file tree
Hide file tree
Showing 5 changed files with 141 additions and 34 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ Given a version number `MAJOR.MINOR.PATCH`, we increment the:
- Add support for dot (`.`) in the tag syntax.
- Now you can add tags like `v1.0.0-abc_xyz`

### Changed

- The **Outputs Sharing** feature now has no default value for the `sensitive` field of `input` and `output` blocks.

## v0.10.8

### Fixed
Expand Down
28 changes: 16 additions & 12 deletions config/sharing_backend.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ type (
Backend string
FromStackID string
value hhcl.Expression
Sensitive bool
Sensitive *bool
mock hhcl.Expression
}

Expand All @@ -34,7 +34,7 @@ type (
Description string
Backend string
Value hhcl.Expression
Sensitive bool
Sensitive *bool
}

// Outputs is a list of outputs.
Expand All @@ -44,11 +44,10 @@ type (
// EvalInput evaluates an input block using the provided evaluation context.
func EvalInput(evalctx *eval.Context, input hcl.Input) (Input, error) {
evaluatedInput := Input{
Range: input.Range,
Name: input.Name, // TODO(i4k): validate name.
Sensitive: true,
value: input.Value,
mock: input.Mock,
Range: input.Range,
Name: input.Name, // TODO(i4k): validate name.
value: input.Value,
mock: input.Mock,
}
var err error
errs := errors.L()
Expand All @@ -59,7 +58,10 @@ func EvalInput(evalctx *eval.Context, input hcl.Input) (Input, error) {
errs.Append(validateID(evaluatedInput.FromStackID, "input.from_stack_id"))

if input.Sensitive != nil {
evaluatedInput.Sensitive, err = evalBool(evalctx, input.Sensitive, "input.sensitive")
val, err := evalBool(evalctx, input.Sensitive, "input.sensitive")
if err == nil {
evaluatedInput.Sensitive = &val
}
errs.Append(err)
}
if err := errs.AsError(); err != nil {
Expand Down Expand Up @@ -93,9 +95,8 @@ func (i *Input) Mock(evalctx *eval.Context) (cty.Value, bool, error) {
// EvalOutput evaluates an output block using the provided evaluation context.
func EvalOutput(evalctx *eval.Context, output hcl.Output) (Output, error) {
evaluatedOutput := Output{
Name: output.Name,
Sensitive: true,
Value: output.Value,
Name: output.Name,
Value: output.Value,
}
var err error
errs := errors.L()
Expand All @@ -104,7 +105,10 @@ func EvalOutput(evalctx *eval.Context, output hcl.Output) (Output, error) {
errs.Append(err)
}
if output.Sensitive != nil {
evaluatedOutput.Sensitive, err = evalBool(evalctx, output.Sensitive, "output.sensitive")
val, err := evalBool(evalctx, output.Sensitive, "output.sensitive")
if err == nil {
evaluatedOutput.Sensitive = &val
}
errs.Append(err)
}
evaluatedOutput.Backend, err = evalString(evalctx, output.Backend, "output.backend")
Expand Down
62 changes: 57 additions & 5 deletions config/sharing_backend_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@ func TestEvalSharingBackendInput(t *testing.T) {
wantErr error
wantValueErr error
}
t.Helper()
t.Parallel()
falsy := false
truthy := true
for _, tc := range []testcase{
{
name: "invalid backend attribute",
Expand Down Expand Up @@ -77,7 +79,30 @@ func TestEvalSharingBackendInput(t *testing.T) {
wantErr: errors.E(`"input.from_stack_id" "id cannot contain spaces" doesn't match "^[a-zA-Z0-9_-]{1,64}$"`),
},
{
name: "complete working input",
name: "complete working input - sensitive=(unset)",
globals: map[string]cty.Value{
"my_backend": cty.StringVal("my-backend"),
"other_stack": cty.StringVal("other-stack"),
"val": cty.StringVal("from-global"),
},
config: Input(
Labels("var_name"),
Expr("value", `"${outputs.var_name}-${global.val}"`),
Expr("from_stack_id", `global.other_stack`),
Expr("backend", `global.my_backend`),
),
outputs: map[string]cty.Value{
"var_name": cty.StringVal("test"),
},
want: config.Input{
Name: "var_name",
FromStackID: "other-stack",
Backend: "my-backend",
},
wantValue: cty.StringVal("test-from-global"),
},
{
name: "complete working input - sensitive=false",
globals: map[string]cty.Value{
"my_backend": cty.StringVal("my-backend"),
"other_stack": cty.StringVal("other-stack"),
Expand All @@ -98,7 +123,33 @@ func TestEvalSharingBackendInput(t *testing.T) {
Name: "var_name",
FromStackID: "other-stack",
Backend: "my-backend",
Sensitive: false,
Sensitive: &falsy,
},
wantValue: cty.StringVal("test-from-global"),
},
{
name: "complete working input - sensitive=true",
globals: map[string]cty.Value{
"my_backend": cty.StringVal("my-backend"),
"other_stack": cty.StringVal("other-stack"),
"val": cty.StringVal("from-global"),
"is_secret": cty.BoolVal(true),
},
config: Input(
Labels("var_name"),
Expr("value", `"${outputs.var_name}-${global.val}"`),
Expr("from_stack_id", `global.other_stack`),
Expr("backend", `global.my_backend`),
Expr("sensitive", `global.is_secret`),
),
outputs: map[string]cty.Value{
"var_name": cty.StringVal("test"),
},
want: config.Input{
Name: "var_name",
FromStackID: "other-stack",
Backend: "my-backend",
Sensitive: &truthy,
},
wantValue: cty.StringVal("test-from-global"),
},
Expand Down Expand Up @@ -171,7 +222,8 @@ func TestEvalSharingBackendOutput(t *testing.T) {
wantValue string
wantErr error
}
t.Helper()
t.Parallel()
falsy := false
for _, tc := range []testcase{
{
name: "invalid backend attribute",
Expand Down Expand Up @@ -200,7 +252,7 @@ func TestEvalSharingBackendOutput(t *testing.T) {
Name: "var_name",
Description: "my output description",
Backend: "my-backend",
Sensitive: false,
Sensitive: &falsy,
},
wantValue: `module.test.var_name`,
},
Expand Down
73 changes: 58 additions & 15 deletions generate/generate_sharing_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ func TestGenerateSharing(t *testing.T) {
},
},
{
name: "single input generated",
name: "single input generated - sensitive=(unset)",
layout: []string{
"s:stacks/stack-1",
"s:stacks/stack-2",
Expand Down Expand Up @@ -87,7 +87,60 @@ func TestGenerateSharing(t *testing.T) {
Block("variable",
Labels("var_name"),
Expr("type", "any"),
Bool("sensitive", true),
),
),
},
},
},
wantReport: generate.Report{
Successes: []generate.Result{
{
Dir: project.NewPath("/stacks/stack-1"),
Created: []string{"test.tf"},
},
},
},
},
{
name: "single input generated - sensitive=false",
layout: []string{
"s:stacks/stack-1",
"s:stacks/stack-2",
},
configs: []hclconfig{
{
path: "/",
add: enableSharingExperiment,
},
{
path: "/",
add: Block("sharing_backend",
Labels("name"),
Expr("type", "terraform"),
Expr("command", `["echo"]`),
Str("filename", "test.tf"),
),
},
{
path: "/stacks/stack-1",
add: Input(
Labels("var_name"),
Str("backend", "name"),
Expr("value", "outputs.var_name"),
Str("from_stack_id", "abc"),
Bool("sensitive", false),
),
},
},
want: []generatedFile{
{
dir: "/stacks/stack-1",
files: map[string]fmt.Stringer{
"test.tf": Doc(
Block("variable",
Labels("var_name"),
Expr("type", "any"),
Bool("sensitive", false),
),
),
},
Expand Down Expand Up @@ -157,7 +210,6 @@ func TestGenerateSharing(t *testing.T) {
Block("variable",
Labels("var_name2"),
Expr("type", "any"),
Bool("sensitive", true),
),
),
},
Expand All @@ -173,7 +225,7 @@ func TestGenerateSharing(t *testing.T) {
},
},
{
name: "single output generated",
name: "single output generated - sensitive=(unset)",
layout: []string{
"s:stacks/stack-1",
"s:stacks/stack-2",
Expand Down Expand Up @@ -210,7 +262,6 @@ func TestGenerateSharing(t *testing.T) {
Block("output",
Labels("var_name"),
Expr("value", "module.something"),
Bool("sensitive", true),
),
),
},
Expand Down Expand Up @@ -252,7 +303,6 @@ func TestGenerateSharing(t *testing.T) {
Labels("var_name1"),
Str("backend", "name"),
Expr("value", "module.something1"),
Bool("sensitive", false),
),
},
{
Expand All @@ -274,7 +324,6 @@ func TestGenerateSharing(t *testing.T) {
Block("output",
Labels("var_name1"),
Expr("value", "module.something1"),
Bool("sensitive", false),
),
Block("output",
Labels("var_name2"),
Expand Down Expand Up @@ -363,6 +412,7 @@ func TestGenerateSharing(t *testing.T) {
Labels("var_output4"),
Str("backend", "name"),
Expr("value", "module.something4"),
Bool("sensitive", false),
),
Input(
Labels("var_input4"),
Expand All @@ -386,7 +436,6 @@ func TestGenerateSharing(t *testing.T) {
Block("variable",
Labels("var_input2"),
Expr("type", "any"),
Bool("sensitive", true),
),
Block("variable",
Labels("var_input3"),
Expand All @@ -396,27 +445,23 @@ func TestGenerateSharing(t *testing.T) {
Block("variable",
Labels("var_input4"),
Expr("type", "any"),
Bool("sensitive", true),
),
Block("output",
Labels("var_output1"),
Expr("value", "module.something1"),
Bool("sensitive", true),
),
Block("output",
Labels("var_output2"),
Expr("value", "module.something2"),
Bool("sensitive", true),
),
Block("output",
Labels("var_output3"),
Expr("value", "module.something3"),
Bool("sensitive", true),
),
Block("output",
Labels("var_output4"),
Expr("value", "module.something4"),
Bool("sensitive", true),
Bool("sensitive", false),
),
),
},
Expand Down Expand Up @@ -467,15 +512,13 @@ func TestSharingOrphanedFilesAreDeleted(t *testing.T) {
expectedOutput := genhcl.Header(genhcl.DefaultComment) + Block("output",
Labels("name"),
Expr("value", "module.test"),
Bool("sensitive", true),
).String() + "\n"
gotOutput := s.RootEntry().ReadFile("s1/sharing.tf")
assert.EqualStrings(t, expectedOutput, string(gotOutput))

expectedInput := genhcl.Header(genhcl.DefaultComment) + Block("variable",
Labels("name"),
Expr("type", "any"),
Bool("sensitive", true),
).String() + "\n"
gotInput := s.RootEntry().ReadFile("s2/sharing.tf")
assert.EqualStrings(t, expectedInput, string(gotInput))
Expand Down
8 changes: 6 additions & 2 deletions generate/sharing/sharing_backend.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@ func PrepareFile(root *config.Root, filename string, inputs config.Inputs, outpu
Bytes: []byte("any"),
},
})
blockBody.SetAttributeValue("sensitive", cty.BoolVal(in.Sensitive))
if in.Sensitive != nil {
blockBody.SetAttributeValue("sensitive", cty.BoolVal(*in.Sensitive))
}
body.AppendBlock(varBlock)
}
for _, out := range outputs {
Expand All @@ -53,7 +55,9 @@ func PrepareFile(root *config.Root, filename string, inputs config.Inputs, outpu
outBlock := hclwrite.NewBlock("output", []string{out.Name})
blockBody := outBlock.Body()
blockBody.SetAttributeRaw("value", ast.TokensForExpression(out.Value))
blockBody.SetAttributeValue("sensitive", cty.BoolVal(out.Sensitive))
if out.Sensitive != nil {
blockBody.SetAttributeValue("sensitive", cty.BoolVal(*out.Sensitive))
}
body.AppendBlock(outBlock)
}

Expand Down

0 comments on commit 110f853

Please sign in to comment.