Bug: fix waypoint_template.variable_options when no options is included (#1242)

* Do not call ElementAs when parsing variable_options.options

* modify existing test to validate no `options` works

* changelog: waypoint_template bug fix

* changelog: waypoint_template bug fix

* update test to include new ncm variable

* using fun variable names out of positive peer pressure

* Add test changes to waypoint resources

* options not required for variablesets

* update docs to show options is optional

* fix test input

* include changelog entry for fix on addon_definition

Author: drewmullen

.changelog/1242.txt

@@ -0,0 +1,7 @@
+```release-note:bug
+Fixed a bug when `tfe_waypoint_template.variable_options` did not specify `options` list.
+```
+
+```release-note:bug
+Fixed a bug for `hcp_waypoint_add_on_definition.variable_options` which incorrectly required `options`. 
+```

docs/resources/waypoint_add_on_definition.md

@@ -77,9 +77,9 @@ Required:
 Required:
 
 - `name` (String) Variable name
-- `options` (List of String) List of options
 - `variable_type` (String) Variable type
 
 Optional:
 
+- `options` (List of String) List of options
 - `user_editable` (Boolean) Whether the variable is editable by the user creating an add-on. If options are provided, then the user may only use those options, regardless of this setting.

internal/provider/waypoint/data_source_waypoint_add_on_test.go

@@ -76,7 +76,7 @@ func TestAcc_Waypoint_AddOn_DataSource_WithInputVars(t *testing.T) {
 				Config: testDataAddOnWithInputVarsConfig(templateName, appName, defName, addOnName),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr(dataSourceName, "name", addOnName),
-					resource.TestCheckResourceAttr(dataSourceName, "input_variables.#", "5"),
+					resource.TestCheckResourceAttr(dataSourceName, "input_variables.#", "6"),
 				),
 			},
 		},

internal/provider/waypoint/data_source_waypoint_application_test.go

@@ -75,7 +75,7 @@ func TestAcc_Waypoint_Application_DataSource_WithInputVars(t *testing.T) {
 				Config: testDataApplicationWithInputVarsConfig(templateName, applicationName),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr(dataSourceName, "name", applicationName),
-					resource.TestCheckResourceAttr(dataSourceName, "input_variables.#", "3"),
+					resource.TestCheckResourceAttr(dataSourceName, "input_variables.#", "4"),
 				),
 			},
 		},

internal/provider/waypoint/data_source_waypoint_template_test.go

@@ -88,11 +88,13 @@ func TestAcc_Waypoint_Data_template_with_variable_options(t *testing.T) {
 				Config: testDataAppTemplateWithVariablesWithOptionsConfig(name),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr(dataSourceName, "name", name),
-					resource.TestCheckResourceAttr(dataSourceName, "variable_options.#", "2"),
+					resource.TestCheckResourceAttr(dataSourceName, "variable_options.#", "3"),
 					resource.TestCheckResourceAttr(dataSourceName, "variable_options.0.name", "faction"),
 					resource.TestCheckResourceAttr(dataSourceName, "variable_options.0.variable_type", "string"),
 					resource.TestCheckResourceAttr(dataSourceName, "variable_options.1.name", "vault_dweller_name"),
 					resource.TestCheckResourceAttr(dataSourceName, "variable_options.1.variable_type", "string"),
+					resource.TestCheckResourceAttr(dataSourceName, "variable_options.2.name", "vault_dweller_shelter"),
+					resource.TestCheckResourceAttr(dataSourceName, "variable_options.2.variable_type", "string"),
 				),
 			},
 		},

internal/provider/waypoint/resource_waypoint_add_on_definition.go

@@ -161,7 +161,8 @@ func (r *AddOnDefinitionResource) Schema(ctx context.Context, req resource.Schem
 						},
 						"options": &schema.ListAttribute{
 							ElementType: types.StringType,
-							Required:    true,
+							Optional:    true,
+							Computed:    true,
 							Description: "List of options",
 						},
 						"user_editable": &schema.BoolAttribute{
@@ -244,10 +245,13 @@ func (r *AddOnDefinitionResource) Create(ctx context.Context, req resource.Creat
 	var varOpts []*waypoint_models.HashicorpCloudWaypointTFModuleVariable
 	for _, v := range plan.TerraformVariableOptions {
 		strOpts := []string{}
-		diags := v.Options.ElementsAs(ctx, &strOpts, false)
-		if diags.HasError() {
-			resp.Diagnostics.Append(diags...)
-			return
+		if len(v.Options.Elements()) != 0 {
+
+			diags := v.Options.ElementsAs(ctx, &strOpts, false)
+			if diags.HasError() {
+				resp.Diagnostics.Append(diags...)
+				return
+			}
 		}
 
 		varOpts = append(varOpts, &waypoint_models.HashicorpCloudWaypointTFModuleVariable{

internal/provider/waypoint/resource_waypoint_add_on_test.go

@@ -66,7 +66,7 @@ func TestAcc_Waypoint_AddOnInputVariables(t *testing.T) {
 					testAccCheckWaypointAddOnExists(t, resourceName, &addOnModel),
 					testAccCheckWaypointAddOnName(t, &addOnModel, addOnName),
 					resource.TestCheckResourceAttr(resourceName, "name", addOnName),
-					resource.TestCheckResourceAttr(resourceName, "add_on_input_variables.#", "2"),
+					resource.TestCheckResourceAttr(resourceName, "add_on_input_variables.#", "3"),
 					resource.TestCheckResourceAttr(resourceName, "add_on_input_variables.0.name", "faction"),
 					resource.TestCheckResourceAttr(resourceName, "add_on_input_variables.0.value", "brotherhood-of-steel"),
 					resource.TestCheckResourceAttr(resourceName, "add_on_input_variables.0.variable_type", "string"),
@@ -289,6 +289,11 @@ resource "hcp_waypoint_add_on_definition" "test_var_opts" {
         "institute"
       ]
     },
+    {
+      name          = "vault_dweller_shelter"
+      variable_type = "string"
+      user_editable = true
+    }
   ]
 }
 
@@ -307,6 +312,11 @@ resource "hcp_waypoint_add_on" "test_var_opts" {
       name          = "vault_dweller_name"
       variable_type = "string"
       value         = "courier"
+    },
+    {
+      name          = "vault_dweller_shelter"
+      variable_type = "string"
+      value         = "value101"
     }
   ]
 }
@@ -365,6 +375,11 @@ resource "hcp_waypoint_add_on_definition" "test_var_opts" {
         "brotherhood-of-steel",
       ]
     },
+    {
+      name          = "vault_dweller_shelter"
+      variable_type = "string"
+      user_editable = true
+    }
   ]
 }
 

internal/provider/waypoint/resource_waypoint_application_test.go

@@ -61,7 +61,7 @@ func TestAcc_Waypoint_ApplicationInputVariables(t *testing.T) {
 					testAccCheckWaypointApplicationExists(t, resourceName, &applicationModel),
 					testAccCheckWaypointApplicationName(t, &applicationModel, applicationName),
 					resource.TestCheckResourceAttr(resourceName, "name", applicationName),
-					resource.TestCheckResourceAttr(resourceName, "application_input_variables.#", "2"),
+					resource.TestCheckResourceAttr(resourceName, "application_input_variables.#", "3"),
 					resource.TestCheckResourceAttr(resourceName, "application_input_variables.0.name", "faction"),
 					resource.TestCheckResourceAttr(resourceName, "application_input_variables.0.value", "brotherhood-of-steel"),
 					resource.TestCheckResourceAttr(resourceName, "application_input_variables.0.variable_type", "string"),
@@ -305,6 +305,11 @@ resource "hcp_waypoint_template" "test_var_opts" {
         "institute"
       ]
     },
+    {
+      name          = "vault_dweller_shelter"
+      variable_type = "string"
+      user_editable = true
+    }
   ]
 }
 
@@ -322,6 +327,11 @@ resource "hcp_waypoint_application" "test_var_opts" {
       name  		= "vault_dweller_name"
       variable_type = "string"
 	  value 		= "courier"
+    },
+    {
+      name          = "vault_dweller_shelter"
+      variable_type = "string"
+	  value 		= "vault101"
     }
   ]
 }`, tempName, appName)
@@ -358,6 +368,11 @@ resource "hcp_waypoint_template" "test_var_opts" {
         "brotherhood-of-steel",
       ]
     },
+    {
+      name          = "vault_dweller_shelter"
+      variable_type = "string"
+      user_editable = true
+    }
   ]
 }
 

internal/provider/waypoint/resource_waypoint_template.go

@@ -286,9 +286,11 @@ func (r *TemplateResource) Create(ctx context.Context, req resource.CreateReques
 	var varOpts []*waypoint_models.HashicorpCloudWaypointTFModuleVariable
 	for _, v := range plan.TerraformVariableOptions {
 		strOpts := []string{}
-		diags = v.Options.ElementsAs(ctx, &strOpts, false)
-		if diags.HasError() {
-			return
+		if len(v.Options.Elements()) != 0 {
+			diags = v.Options.ElementsAs(ctx, &strOpts, false)
+			if diags.HasError() {
+				return
+			}
 		}
 
 		varOpts = append(varOpts, &waypoint_models.HashicorpCloudWaypointTFModuleVariable{

internal/provider/waypoint/resource_waypoint_template_test.go

@@ -292,6 +292,11 @@ resource "hcp_waypoint_template" "var_opts_test" {
         "raiders",
         "institute"
       ]
+    },
+    {
+      name          = "vault_dweller_shelter"
+      variable_type = "string"
+      user_editable = true
     }
   ]
 }`, name)