Introduce ephemeral marks (#358)

* Bump aqua installer and registry

* Introduce ephemeral marks

Author: wata727

Makefile

@@ -1,5 +1,5 @@
 prepare:
-	curl -sSfL https://raw.githubusercontent.com/aquaproj/aqua-installer/v2.1.1/aqua-installer | bash
+	curl -sSfL https://raw.githubusercontent.com/aquaproj/aqua-installer/v3.0.1/aqua-installer | bash
 	@echo ''
 	@echo 'Add $${AQUA_ROOT_DIR}/bin to the environment variable PATH.'
 	@echo 'export PATH="$${AQUA_ROOT_DIR:-$${XDG_DATA_HOME:-$$HOME/.local/share}/aquaproj-aqua}/bin:$$PATH"'

aqua.yaml

@@ -8,7 +8,7 @@
 #   - all
 registries:
 - type: standard
-  ref: v3.159.0 # renovate: depName=aquaproj/aqua-registry
+  ref: v4.290.0 # renovate: depName=aquaproj/aqua-registry
 packages:
 - name: protocolbuffers/protobuf/[email protected]
 - name: protocolbuffers/protobuf-go/[email protected]

plugin/internal/fromproto/fromproto.go

@@ -217,9 +217,14 @@ func Value(value []byte, ty cty.Type, valueMarks []*proto.ValueMark) (cty.Value,
 		pvm[idx] = cty.PathValueMarks{
 			Path: AttributePath(mark.Path),
 		}
+		vm := []interface{}{}
 		if mark.Sensitive {
-			pvm[idx].Marks = cty.NewValueMarks(marks.Sensitive)
+			vm = append(vm, marks.Sensitive)
 		}
+		if mark.Ephemeral {
+			vm = append(vm, marks.Ephemeral)
+		}
+		pvm[idx].Marks = cty.NewValueMarks(vm...)
 	}
 
 	return val.MarkWithPaths(pvm), nil

plugin/internal/plugin2host/client.go

@@ -18,6 +18,7 @@ import (
 	"github.com/terraform-linters/tflint-plugin-sdk/plugin/internal/proto"
 	"github.com/terraform-linters/tflint-plugin-sdk/plugin/internal/toproto"
 	"github.com/terraform-linters/tflint-plugin-sdk/terraform/addrs"
+	"github.com/terraform-linters/tflint-plugin-sdk/terraform/lang/marks"
 	"github.com/terraform-linters/tflint-plugin-sdk/tflint"
 	"github.com/zclconf/go-cty/cty"
 	"github.com/zclconf/go-cty/cty/gocty"
@@ -314,7 +315,11 @@ func (c *GRPCClient) EvaluateExpr(expr hcl.Expression, target interface{}, opts
 
 	if err != nil {
 		// If it cannot be represented as a Go value, exit without invoking the callback rather than returning an error.
-		if errors.Is(err, tflint.ErrUnknownValue) || errors.Is(err, tflint.ErrNullValue) || errors.Is(err, tflint.ErrSensitive) || errors.Is(err, tflint.ErrUnevaluable) {
+		if errors.Is(err, tflint.ErrUnknownValue) ||
+			errors.Is(err, tflint.ErrNullValue) ||
+			errors.Is(err, tflint.ErrSensitive) ||
+			errors.Is(err, tflint.ErrEphemeral) ||
+			errors.Is(err, tflint.ErrUnevaluable) {
 			return nil
 		}
 		return err
@@ -391,7 +396,7 @@ func (c *GRPCClient) evaluateExpr(expr hcl.Expression, target interface{}, opts
 		return gocty.FromCtyValue(val, target)
 	}
 
-	// Returns an error if the value cannot be decoded to a Go value (e.g. unknown, null, sensitive).
+	// Returns an error if the value cannot be decoded to a Go value (e.g. unknown, null, marked).
 	// This allows the caller to handle the value by the errors package.
 	err = cty.Walk(val, func(path cty.Path, v cty.Value) (bool, error) {
 		if !v.IsKnown() {
@@ -402,10 +407,14 @@ func (c *GRPCClient) evaluateExpr(expr hcl.Expression, target interface{}, opts
 			logger.Debug(fmt.Sprintf("null value found in %s", expr.Range()))
 			return false, tflint.ErrNullValue
 		}
-		if v.IsMarked() {
+		if v.HasMark(marks.Sensitive) {
 			logger.Debug(fmt.Sprintf("sensitive value found in %s", expr.Range()))
 			return false, tflint.ErrSensitive
 		}
+		if v.HasMark(marks.Ephemeral) {
+			logger.Debug(fmt.Sprintf("ephemeral value found in %s", expr.Range()))
+			return false, tflint.ErrEphemeral
+		}
 		return true, nil
 	})
 	if err != nil {

plugin/internal/plugin2host/plugin2host_test.go

@@ -2015,6 +2015,42 @@ func TestEvaluateExpr(t *testing.T) {
 			GetFileImpl: fileExists,
 			ErrCheck:    neverHappend,
 		},
+		{
+			Name:       "ephemeral",
+			Expr:       hclExpr(`var.foo`),
+			TargetType: reflect.TypeOf(""),
+			ServerImpl: func(expr hcl.Expression, opts tflint.EvaluateExprOption) (cty.Value, error) {
+				return evalExpr(expr, &hcl.EvalContext{
+					Variables: map[string]cty.Value{
+						"var": cty.MapVal(map[string]cty.Value{
+							"foo": cty.StringVal("bar").Mark(marks.Ephemeral),
+						}),
+					},
+				})
+			},
+			Want:        "",
+			GetFileImpl: fileExists,
+			ErrCheck: func(err error) bool {
+				return !errors.Is(err, tflint.ErrEphemeral)
+			},
+		},
+		{
+			Name:       "ephemeral as cty.Value",
+			Expr:       hclExpr(`var.foo`),
+			TargetType: reflect.TypeOf(cty.Value{}),
+			ServerImpl: func(expr hcl.Expression, opts tflint.EvaluateExprOption) (cty.Value, error) {
+				return evalExpr(expr, &hcl.EvalContext{
+					Variables: map[string]cty.Value{
+						"var": cty.MapVal(map[string]cty.Value{
+							"foo": cty.StringVal("bar").Mark(marks.Ephemeral),
+						}),
+					},
+				})
+			},
+			Want:        cty.StringVal("bar").Mark(marks.Ephemeral),
+			GetFileImpl: fileExists,
+			ErrCheck:    neverHappend,
+		},
 	}
 
 	for _, test := range tests {
@@ -2334,6 +2370,32 @@ func TestEvaluateExpr_callback(t *testing.T) {
 				return err == nil || err.Error() != `value is cty.StringVal("foo").Mark(marks.Sensitive)`
 			},
 		},
+		{
+			name: "callback with ephemeral value as Go value",
+			expr: hclExpr(`var.foo`),
+			target: func(val string) error {
+				return fmt.Errorf("value is %s", val)
+			},
+			serverImpl: func(expr hcl.Expression, opts tflint.EvaluateExprOption) (cty.Value, error) {
+				return cty.StringVal("foo").Mark(marks.Ephemeral), nil
+			},
+			getFileImpl: fileExists,
+			errCheck:    neverHappend,
+		},
+		{
+			name: "callback with ephemeral value as cty.Value",
+			expr: hclExpr(`var.foo`),
+			target: func(val cty.Value) error {
+				return fmt.Errorf("value is %s", val.GoString())
+			},
+			serverImpl: func(expr hcl.Expression, opts tflint.EvaluateExprOption) (cty.Value, error) {
+				return cty.StringVal("foo").Mark(marks.Ephemeral), nil
+			},
+			getFileImpl: fileExists,
+			errCheck: func(err error) bool {
+				return err == nil || err.Error() != `value is cty.StringVal("foo").Mark(marks.Ephemeral)`
+			},
+		},
 	}
 
 	for _, test := range tests {