[BETA] Create a project-owned varset (#992)

* Create a project-owned varset

* Add test for reading parent

* Add CHANGELOG entry

Author: jbonhag

CHANGELOG.md

@@ -6,6 +6,7 @@
 * Add support for filtering by key/value tags by @brandonc [#987](https://github.com/hashicorp/go-tfe/pull/987)
 * Add support for reading a registry module by its unique identifier by @dsa0x
  [#988](https://github.com/hashicorp/go-tfe/pull/988)
+* Adds BETA support for a variable set `Parent` relation, which is EXPERIMENTAL, SUBJECT TO CHANGE, and may not be available to all users by @jbonhag [#992](https://github.com/hashicorp/go-tfe/pull/992)
 
 # v1.68.0
 

variable_set.go

@@ -65,6 +65,13 @@ type VariableSetList struct {
 	Items []*VariableSet
 }
 
+// Parent represents the variable set's parent (currently only organizations and projects are supported).
+// This relation is considered BETA, SUBJECT TO CHANGE, and likely unavailable to most users.
+type Parent struct {
+	Organization *Organization
+	Project      *Project
+}
+
 // VariableSet represents a Terraform Enterprise variable set.
 type VariableSet struct {
 	ID          string `jsonapi:"primary,varsets"`
@@ -74,10 +81,13 @@ type VariableSet struct {
 	Priority    bool   `jsonapi:"attr,priority"`
 
 	// Relations
-	Organization *Organization          `jsonapi:"relation,organization"`
-	Workspaces   []*Workspace           `jsonapi:"relation,workspaces,omitempty"`
-	Projects     []*Project             `jsonapi:"relation,projects,omitempty"`
-	Variables    []*VariableSetVariable `jsonapi:"relation,vars,omitempty"`
+	Organization *Organization `jsonapi:"relation,organization"`
+	// Optional: Parent represents the variable set's parent (currently only organizations and projects are supported).
+	// This relation is considered BETA, SUBJECT TO CHANGE, and likely unavailable to most users.
+	Parent     *Parent                `jsonapi:"polyrelation,parent"`
+	Workspaces []*Workspace           `jsonapi:"relation,workspaces,omitempty"`
+	Projects   []*Project             `jsonapi:"relation,projects,omitempty"`
+	Variables  []*VariableSetVariable `jsonapi:"relation,vars,omitempty"`
 }
 
 // A list of relations to include. See available resources
@@ -122,6 +132,10 @@ type VariableSetCreateOptions struct {
 	// If true the variables in the set override any other variable values set
 	// in a more specific scope including values set on the command line.
 	Priority *bool `jsonapi:"attr,priority,omitempty"`
+
+	// Optional: Parent represents the variable set's parent (currently only organizations and projects are supported).
+	// This relation is considered BETA, SUBJECT TO CHANGE, and likely unavailable to most users.
+	Parent *Parent `jsonapi:"polyrelation,parent"`
 }
 
 // VariableSetReadOptions represents the options for reading variable sets.

variable_set_test.go

@@ -232,6 +232,40 @@ func TestVariableSetsCreate(t *testing.T) {
 		assert.Nil(t, vs)
 		assert.EqualError(t, err, ErrRequiredGlobalFlag.Error())
 	})
+
+	t.Run("when creating project-owned variable set", func(t *testing.T) {
+		skipUnlessBeta(t)
+
+		prjTest, prjTestCleanup := createProject(t, client, orgTest)
+		t.Cleanup(prjTestCleanup)
+
+		options := VariableSetCreateOptions{
+			Name:        String("project-varset"),
+			Description: String("a project variable set"),
+			Global:      Bool(false),
+			Parent: &Parent{
+				Project: prjTest,
+			},
+		}
+
+		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.Parent.Project.ID, item.Parent.Project.ID)
+		}
+	})
 }
 
 func TestVariableSetsRead(t *testing.T) {
@@ -255,6 +289,15 @@ func TestVariableSetsRead(t *testing.T) {
 		assert.Nil(t, vs)
 		assert.Error(t, err)
 	})
+
+	t.Run("with parent relationship", func(t *testing.T) {
+		skipUnlessBeta(t)
+
+		vs, err := client.VariableSets.Read(ctx, vsTest.ID, nil)
+		require.NoError(t, err)
+		assert.Equal(t, vsTest, vs)
+		assert.Equal(t, orgTest.Name, vs.Parent.Organization.Name)
+	})
 }
 
 func TestVariableSetsUpdate(t *testing.T) {