core: add support for input variables

.changelog/1548.txt

@@ -0,0 +1,3 @@
+```release-note:feature
+core: Add support for input variables
+```

go.mod

@@ -37,6 +37,7 @@ require (
  github.com/go-playground/validator v9.31.0+incompatible
  github.com/gofrs/flock v0.8.0
  github.com/golang/protobuf v1.5.2
+ github.com/google/go-cmp v0.5.5
  github.com/google/go-jsonnet v0.17.0
  github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510
  github.com/google/uuid v1.1.2

internal/cli/base.go

@@ -17,6 +17,7 @@ import (
  clientpkg "github.com/hashicorp/waypoint/internal/client"
  "github.com/hashicorp/waypoint/internal/clierrors"
  "github.com/hashicorp/waypoint/internal/config"
+ "github.com/hashicorp/waypoint/internal/config/variables"
  "github.com/hashicorp/waypoint/internal/pkg/flag"
  pb "github.com/hashicorp/waypoint/internal/server/gen"
  "github.com/hashicorp/waypoint/internal/server/grpcmetadata"
@@ -65,6 +66,9 @@ type baseCommand struct {
  refApp *pb.Ref_Application
  refWorkspace *pb.Ref_Workspace
 
+ // variables hold the values set via flags and local env vars
+ variables []*pb.Variable
+
  //---------------------------------------------------------------
  // Internal fields that should not be accessed directly
 
@@ -74,6 +78,13 @@ type baseCommand struct {
  // flagLabels are set via -label if flagSetOperation is set.
  flagLabels map[string]string
 
+ // flagVars sets values for defined input variables
+ flagVars map[string]string
+
+ // flagVarFile is a HCL or JSON file setting one or more values
+ // for defined input variables
+ flagVarFile []string
+
  // flagRemote is whether to execute using a remote runner or use
  // a local runner.
  flagRemote bool
@@ -239,6 +250,17 @@ func (c *baseCommand) Init(opts ...Option) error {
  }
  }
 
+ // Collect variable values from -var and -varfile flags,
+ // and env vars set with WP_VAR_* and set them on the job
+ vars, diags := variables.LoadVariableValues(c.flagVars, c.flagVarFile)
+ if diags.HasErrors() {
+ // we only return errors for file parsing, so we are specific
+ // in the error log here
+ c.logError(c.Log, "failed to load wpvars file", errors.New(diags.Error()))
+ return diags
+ }
+ c.variables = vars
+
  // Create our client
  if baseCfg.Client {
  c.project, err = c.initClient(nil)
@@ -405,6 +427,20 @@ func (c *baseCommand) flagSet(bit flagSetBit, f func(*flag.Sets)) *flag.Sets {
  "This is specified to the data source type being used in your configuration. " +
  "This is used for example to set a specific Git ref to run against.",
  })
+
+ f.StringMapVar(&flag.StringMapVar{
+ Name: "var",
+ Target: &c.flagVars,
+ Usage: "Variable value to set for this operation. Can be specified multiple times.",
+ })
+
+ f.StringSliceVar(&flag.StringSliceVar{
+ Name: "var-file",
+ Target: &c.flagVarFile,
+ Usage: "HCL or JSON file containing variable values to set for this " +
+ "operation. If any \"*.auto.wpvars\" or \"*.auto.wpvars.json\" " +
+ "files are present, they will be automatically loaded.",
+ })
  }
 
  if bit&flagSetConnection != 0 {

internal/cli/base_init.go

@@ -98,6 +98,7 @@ func (c *baseCommand) initClient(ctx context.Context) (*clientpkg.Project, error
  clientpkg.WithClientConnect(connectOpts...),
  clientpkg.WithProjectRef(c.refProject),
  clientpkg.WithWorkspaceRef(c.refWorkspace),
+ clientpkg.WithVariables(c.variables),
  clientpkg.WithLabels(c.flagLabels),
  clientpkg.WithSourceOverrides(c.flagRemoteSource),
  }

internal/client/job.go

@@ -22,6 +22,7 @@ func (c *Project) job() *pb.Job {
  job := &pb.Job{
  TargetRunner: c.runner,
  Labels: c.labels,
+ Variables: c.variables,
  Workspace: c.workspace,
  Application: &pb.Ref_Application{
  Project: c.project.Project,

internal/client/project.go

@@ -25,6 +25,7 @@ type Project struct {
  workspace *pb.Ref_Workspace
  runner *pb.Ref_Runner
  labels map[string]string
+ variables []*pb.Variable
  dataSourceOverrides map[string]string
  cleanupFunc func()
  serverVersion *pb.VersionInfo
@@ -227,6 +228,14 @@ func WithClientConnect(opts ...serverclient.ConnectOption) Option {
  }
 }
 
+// WithVariables sets variable values from flags and local env on any operations.
+func WithVariables(m []*pb.Variable) Option {
+ return func(c *Project, cfg *config) error {
+ c.variables = m
+ return nil
+ }
+}
+
 // WithLabels sets the labels or any operations.
 func WithLabels(m map[string]string) Option {
  return func(c *Project, cfg *config) error {

internal/config/config.go

@@ -6,8 +6,10 @@ import (
  "path/filepath"
 
  "github.com/hashicorp/hcl/v2"
+ "github.com/hashicorp/hcl/v2/gohcl"
  "github.com/hashicorp/hcl/v2/hclsimple"
 
+ "github.com/hashicorp/waypoint/internal/config/variables"
  "github.com/hashicorp/waypoint/internal/pkg/defaults"
  pb "github.com/hashicorp/waypoint/internal/server/gen"
 )
@@ -18,16 +20,19 @@ type Config struct {
  ctx *hcl.EvalContext
  path string
  pathData map[string]string
+
+ InputVariables map[string]*variables.Variable
 }
 
 type hclConfig struct {
- Project string `hcl:"project,optional"`
- Runner *Runner `hcl:"runner,block" default:"{}"`
- Labels map[string]string `hcl:"labels,optional"`
- Plugin []*Plugin `hcl:"plugin,block"`
- Config *genericConfig `hcl:"config,block"`
- Apps []*hclApp `hcl:"app,block"`
- Body hcl.Body `hcl:",body"`
+ Project string `hcl:"project,optional"`
+ Runner *Runner `hcl:"runner,block" default:"{}"`
+ Labels map[string]string `hcl:"labels,optional"`
+ Variables []*variables.HclVariable `hcl:"variable,block"`
+ Plugin []*Plugin `hcl:"plugin,block"`
+ Config *genericConfig `hcl:"config,block"`
+ Apps []*hclApp `hcl:"app,block"`
+ Body hcl.Body `hcl:",body"`
 }
 
 // Runner is the configuration for supporting runners in this project.
@@ -117,6 +122,18 @@ func Load(path string, opts *LoadOptions) (*Config, error) {
  if err := hclsimple.DecodeFile(path, finalizeContext(ctx), &cfg); err != nil {
  return nil, err
  }
+
+ // Decode variable blocks
+ schema, _ := gohcl.ImpliedBodySchema(&hclConfig{})
+ content, diags := cfg.Body.Content(schema)
+ if diags.HasErrors() {
+ return nil, diags
+ }
+ vs, diags := variables.DecodeVariableBlocks(content)
+ if diags.HasErrors() {
+ return nil, diags
+ }
+
  if err := defaults.Set(&cfg); err != nil {
  return nil, err
  }
@@ -132,10 +149,11 @@ func Load(path string, opts *LoadOptions) (*Config, error) {
  }
 
  return &Config{
- hclConfig: cfg,
- ctx: ctx,
- path: filepath.Dir(path),
- pathData: pathData,
+ hclConfig: cfg,
+ ctx: ctx,
+ path: filepath.Dir(path),
+ pathData: pathData,
+ InputVariables: vs,
  }, nil
 }
 

internal/config/config_test.go

@@ -64,3 +64,44 @@ func TestLoad_compare(t *testing.T) {
  })
  }
 }
+
+func TestConfig_variableDecode(t *testing.T) {
+ cases := []struct {
+ file string
+ err string
+ }{
+ {
+ "valid.hcl",
+ "",
+ },
+ {
+ "invalid_type.hcl",
+ "Invalid type specification",
+ },
+
+ {
+ "invalid_def.hcl",
+ "Invalid default value for variable",
+ },
+ {
+ "duplicate_def.hcl",
+ "Duplicate variable",
+ },
+ }
+
+ for _, tt := range cases {
+ t.Run(tt.file, func(t *testing.T) {
+ require := require.New(t)
+
+ _, err := Load(filepath.Join("testdata", "validate", tt.file), nil)
+
+ if tt.err == "" {
+ require.NoError(err)
+ return
+ }
+
+ require.Error(err)
+ require.Contains(err.Error(), tt.err)
+ })
+ }
+}

internal/config/eval_context.go

@@ -6,6 +6,7 @@ import (
  "github.com/zclconf/go-cty/cty/gocty"
 
  "github.com/hashicorp/waypoint/internal/config/funcs"
+ "github.com/hashicorp/waypoint/internal/config/variables"
 )
 
 // EvalContext returns the common eval context to use for parsing all
@@ -95,6 +96,13 @@ func finalizeContext(ctx *hcl.EvalContext) *hcl.EvalContext {
  return ctx
 }
 
+// AddVariables uses the final map of InputValues to add all input variables
+// to the given hcl EvalContext.
+func AddVariables(ctx *hcl.EvalContext, vs variables.Values) *hcl.EvalContext {
+ variables.AddInputVariables(ctx, vs)
+ return ctx
+}
+
 // hclContextContainer is an interface that config structs that have an HCL
 // context may implement. We use this for certain things such as mapoperation()
 // to set the proper context.

internal/config/testdata/validate/duplicate_def.hcl

@@ -0,0 +1,23 @@
+project = "foo"
+
+app "web" {
+ config {
+ env = {
+ static = "hello"
+ }
+ }
+
+ build {}
+
+ deploy {}
+}
+
+variable "dinosaur" {
+ default = "longneck"
+ type = string
+}
+
+variable "dinosaur" {
+ default = "bigtooth"
+ type = string
+}

internal/config/testdata/validate/invalid_def.hcl

@@ -0,0 +1,18 @@
+project = "foo"
+
+app "web" {
+ config {
+ env = {
+ static = "hello"
+ }
+ }
+
+ build {}
+
+ deploy {}
+}
+
+variable "bees" {
+ default = "buzz"
+ type = bool
+}

internal/config/testdata/validate/invalid_type.hcl

@@ -0,0 +1,19 @@
+project = "foo"
+
+app "web" {
+ config {
+ env = {
+ static = "hello"
+ }
+ }
+
+ build {}
+
+ deploy {}
+}
+
+variable "bees" {
+ default = "buzz"
+ description = "This is my description"
+ type = notatype
+}

internal/config/testdata/validate/valid.hcl

@@ -11,3 +11,9 @@ app "web" {
 
  deploy {}
 }
+
+variable "bees" {
+ default = "buzz"
+ description = "This is my description"
+ type = string
+}

internal/config/testdata/validate/variables.hcl

@@ -0,0 +1,19 @@
+project = "foo"
+
+app "web" {
+ config {
+ env = {
+ static = "hello"
+ }
+ }
+
+ build {}
+
+ deploy {}
+}
+
+variable "bees" {
+ default = "buzz"
+ description = "This is my description"
+ type = string
+}