TF-9286 Add the enforced attribute to variable_set

CHANGELOG.md

@@ -2,6 +2,8 @@
 <!-- Add CHANGELOG entry to this section for any PR awaiting the next release -->
 <!-- Please also include if this is a Bug Fix, Enhancement, or Feature -->
 
+## Enhancements
+* Added BETA support for including `enforced` attribute to variable_set on create and update by @Netra2104 [#778](https://github.com/hashicorp/go-tfe/pull/778)
 
 # v1.34.0
 ## Features

variable_set.go

@@ -71,6 +71,8 @@ type VariableSet struct {
 	Name        string `jsonapi:"attr,name"`
 	Description string `jsonapi:"attr,description"`
 	Global      bool   `jsonapi:"attr,global"`
+	// **Note: This field is still in BETA and subject to change.**
+	Enforced bool `jsonapi:"attr,enforced"`
 
 	// Relations
 	Organization *Organization          `jsonapi:"relation,organization"`
@@ -113,6 +115,10 @@ type VariableSetCreateOptions struct {
 
 	// If true the variable set is considered in all runs in the organization.
 	Global *bool `jsonapi:"attr,global,omitempty"`
+
+	// **Note: This field is still in BETA and subject to change.**
+	// If true the variables in the set cannot be overwritten and take precedence.
+	Enforced *bool `jsonapi:"attr,enforced,omitempty"`
 }
 
 // VariableSetReadOptions represents the options for reading variable sets.
@@ -138,6 +144,10 @@ type VariableSetUpdateOptions struct {
 
 	// If true the variable set is considered in all runs in the organization.
 	Global *bool `jsonapi:"attr,global,omitempty"`
+
+	// **Note: This field is still in BETA and subject to change.**
+	// If true the variables in the set cannot be overwritten and take precedence.
+	Enforced *bool `jsonapi:"attr,enforced,omitempty"`
 }
 
 // VariableSetApplyToWorkspacesOptions represents the options for applying variable sets to workspaces.

variable_set_test.go

@@ -208,6 +208,58 @@ func TestVariableSetsCreate(t *testing.T) {
 	})
 }
 
+func TestVariableSetsWithEnforcedCreate(t *testing.T) {
+	skipUnlessBeta(t)
+	client := testClient(t)
+	ctx := context.Background()
+
+	orgTest, orgTestCleanup := createOrganization(t, client)
+	t.Cleanup(orgTestCleanup)
+
+	t.Run("with valid options", func(t *testing.T) {
+		options := VariableSetCreateOptions{
+			Name:        String("varset"),
+			Description: String("a variable set"),
+			Global:      Bool(false),
+			Enforced:    Bool(false),
+		}
+
+		vs, err := client.VariableSets.Create(ctx, orgTest.Name, &options)
+		require.NoError(t, err)
+
+		// Get refreshed view from the API
+		refreshed, err := client.VariableSets.Read(ctx, vs.ID, nil)
+		require.NoError(t, err)
+
+		for _, item := range []*VariableSet{
+			vs,
+			refreshed,
+		} {
+			assert.NotEmpty(t, item.ID)
+			assert.Equal(t, *options.Name, item.Name)
+			assert.Equal(t, *options.Description, item.Description)
+			assert.Equal(t, *options.Global, item.Global)
+			assert.Equal(t, *options.Enforced, item.Enforced)
+		}
+	})
+
+	t.Run("when options is missing name", func(t *testing.T) {
+		vs, err := client.VariableSets.Create(ctx, "foo", &VariableSetCreateOptions{
+			Global: Bool(true),
+		})
+		assert.Nil(t, vs)
+		assert.EqualError(t, err, ErrRequiredName.Error())
+	})
+
+	t.Run("when options is missing global flag", func(t *testing.T) {
+		vs, err := client.VariableSets.Create(ctx, "foo", &VariableSetCreateOptions{
+			Name: String("foo"),
+		})
+		assert.Nil(t, vs)
+		assert.EqualError(t, err, ErrRequiredGlobalFlag.Error())
+	})
+}
+
 func TestVariableSetsRead(t *testing.T) {
 	client := testClient(t)
 	ctx := context.Background()
@@ -270,6 +322,50 @@ func TestVariableSetsUpdate(t *testing.T) {
 	})
 }
 
+func TestVariableSetsUpdateWithEnforced(t *testing.T) {
+	skipUnlessBeta(t)
+	client := testClient(t)
+	ctx := context.Background()
+
+	orgTest, orgTestCleanup := createOrganization(t, client)
+	t.Cleanup(orgTestCleanup)
+
+	vsTest, _ := createVariableSet(t, client, orgTest, VariableSetCreateOptions{
+		Name:        String("OriginalName"),
+		Description: String("Original Description"),
+		Global:      Bool(false),
+		Enforced:    Bool(false),
+	})
+
+	t.Run("when updating a subset of values", func(t *testing.T) {
+		options := VariableSetUpdateOptions{
+			Name:        String("UpdatedName"),
+			Description: String("Updated Description"),
+			Global:      Bool(true),
+			Enforced:    Bool(true),
+		}
+
+		vsAfter, err := client.VariableSets.Update(ctx, vsTest.ID, &options)
+		require.NoError(t, err)
+
+		assert.Equal(t, *options.Name, vsAfter.Name)
+		assert.Equal(t, *options.Description, vsAfter.Description)
+		assert.Equal(t, *options.Global, vsAfter.Global)
+		assert.Equal(t, *options.Enforced, vsAfter.Enforced)
+	})
+
+	t.Run("when options has an invalid variable set ID", func(t *testing.T) {
+		vsAfter, err := client.VariableSets.Update(ctx, badIdentifier, &VariableSetUpdateOptions{
+			Name:        String("UpdatedName"),
+			Description: String("Updated Description"),
+			Global:      Bool(true),
+			Enforced:    Bool(true),
+		})
+		assert.Nil(t, vsAfter)
+		assert.EqualError(t, err, ErrInvalidVariableSetID.Error())
+	})
+}
+
 func TestVariableSetsDelete(t *testing.T) {
 	client := testClient(t)
 	ctx := context.Background()