Feature: add support for applying/removing variable set against workspaces

variable_set.go

@@ -29,7 +29,13 @@ type VariableSets interface {
 	// Delete a variable set by ID.
 	Delete(ctx context.Context, variableSetID string) error
 
-	// Update list of workspaces to which the variable set is applied to match the supplied list
+	// Apply variable set to workspaces in the supplied list.
+	ApplyToWorkspaces(ctx context.Context, variableSetID string, options *VariableSetApplyToWorkspacesOptions) error
+
+	// Remove variable set from workspaces in the supplied list.
+	RemoveFromWorkspaces(ctx context.Context, variableSetID string, options *VariableSetRemoveFromWorkspacesOptions) error
+
+	// Update list of workspaces to which the variable set is applied to match the supplied list.
 	UpdateWorkspaces(ctx context.Context, variableSetID string, options *VariableSetUpdateWorkspacesOptions) (*VariableSet, error)
 }
 
@@ -200,6 +206,7 @@ type VariableSetUpdateOptions struct {
 	Global *bool `jsonapi:"attr,global,omitempty"`
 }
 
+// Update an existing variable set.
 func (s *variableSets) Update(ctx context.Context, variableSetID string, options *VariableSetUpdateOptions) (*VariableSet, error) {
 	if !validStringID(&variableSetID) {
 		return nil, ErrInvalidVariableSetID
@@ -235,6 +242,72 @@ func (s *variableSets) Delete(ctx context.Context, variableSetID string) error {
 	return s.client.do(ctx, req, nil)
 }
 
+// VariableSetApplyToWorkspacesOptions represents the options for applying variable sets to workspaces.
+type VariableSetApplyToWorkspacesOptions struct {
+	// The workspaces to apply the variable set to (additive).
+	Workspaces []*Workspace
+}
+
+func (o *VariableSetApplyToWorkspacesOptions) valid() error {
+	for _, s := range o.Workspaces {
+		if !validStringID(&s.ID) {
+			return ErrRequiredWorkspaceID
+		}
+	}
+	return nil
+}
+
+// Apply variable set to workspaces in the supplied list.
+func (s *variableSets) ApplyToWorkspaces(ctx context.Context, variableSetID string, options *VariableSetApplyToWorkspacesOptions) error {
+	if !validStringID(&variableSetID) {
+		return ErrInvalidVariableSetID
+	}
+	if err := options.valid(); err != nil {
+		return err
+	}
+
+	u := fmt.Sprintf("varsets/%s/relationships/workspaces", url.QueryEscape(variableSetID))
+	req, err := s.client.newRequest("POST", u, options.Workspaces)
+	if err != nil {
+		return err
+	}
+
+	return s.client.do(ctx, req, nil)
+}
+
+// VariableSetRemoveFromWorkspacesOptions represents the options for removing variable sets from workspaces.
+type VariableSetRemoveFromWorkspacesOptions struct {
+	// The workspaces to remove the variable set from.
+	Workspaces []*Workspace
+}
+
+func (o *VariableSetRemoveFromWorkspacesOptions) valid() error {
+	for _, s := range o.Workspaces {
+		if !validStringID(&s.ID) {
+			return ErrRequiredWorkspaceID
+		}
+	}
+	return nil
+}
+
+// Remove variable set from workspaces in the supplied list.
+func (s *variableSets) RemoveFromWorkspaces(ctx context.Context, variableSetID string, options *VariableSetRemoveFromWorkspacesOptions) error {
+	if !validStringID(&variableSetID) {
+		return ErrInvalidVariableSetID
+	}
+	if err := options.valid(); err != nil {
+		return err
+	}
+
+	u := fmt.Sprintf("varsets/%s/relationships/workspaces", url.QueryEscape(variableSetID))
+	req, err := s.client.newRequest("DELETE", u, options.Workspaces)
+	if err != nil {
+		return err
+	}
+
+	return s.client.do(ctx, req, nil)
+}
+
 // VariableSetUpdateWorkspacesOptions represents a subset of update options specifically for applying variable sets to workspaces
 type VariableSetUpdateWorkspacesOptions struct {
 	// Type is a public field utilized by JSON:API to

variable_set_test.go

@@ -190,6 +190,67 @@ func TestVariableSetsDelete(t *testing.T) {
 	})
 }
 
+func TestVariableSetsApplyToAndRemoveFromWorkspaces(t *testing.T) {
+	client := testClient(t)
+	ctx := context.Background()
+
+	orgTest, orgTestCleanup := createOrganization(t, client)
+	defer orgTestCleanup()
+
+	vsTest, _ := createVariableSet(t, client, orgTest, VariableSetCreateOptions{})
+
+	wTest1, _ := createWorkspace(t, client, orgTest)
+	wTest2, _ := createWorkspace(t, client, orgTest)
+
+	t.Run("with first workspace added", func(t *testing.T) {
+		options := VariableSetApplyToWorkspacesOptions{
+			Workspaces: []*Workspace{wTest1},
+		}
+
+		err := client.VariableSets.ApplyToWorkspaces(ctx, vsTest.ID, &options)
+		require.NoError(t, err)
+
+		vsAfter, err := client.VariableSets.Read(ctx, vsTest.ID, nil)
+		require.NoError(t, err)
+
+		// Variable set should be applied to [wTest1]
+		assert.Equal(t, len(options.Workspaces), len(vsAfter.Workspaces))
+		assert.Equal(t, options.Workspaces[0].ID, vsAfter.Workspaces[0].ID)
+	})
+
+	t.Run("with second workspace added", func(t *testing.T) {
+		options := VariableSetApplyToWorkspacesOptions{
+			Workspaces: []*Workspace{wTest2},
+		}
+
+		err := client.VariableSets.ApplyToWorkspaces(ctx, vsTest.ID, &options)
+		require.NoError(t, err)
+
+		vsAfter, err := client.VariableSets.Read(ctx, vsTest.ID, nil)
+		require.NoError(t, err)
+
+		// Variable set should be applied to [wTest1, wTest2]
+		assert.Equal(t, len(options.Workspaces), len(vsAfter.Workspaces))
+		assert.Equal(t, options.Workspaces[1].ID, vsAfter.Workspaces[1].ID)
+	})
+
+	t.Run("with first workspace removed", func(t *testing.T) {
+		options := VariableSetRemoveFromWorkspacesOptions{
+			Workspaces: []*Workspace{wTest1},
+		}
+
+		err := client.VariableSets.RemoveFromWorkspaces(ctx, vsTest.ID, &options)
+		require.NoError(t, err)
+
+		vsAfter, err := client.VariableSets.Read(ctx, vsTest.ID, nil)
+		require.NoError(t, err)
+
+		// Variable set should be applied to [wTest2]
+		assert.Equal(t, 1, len(vsAfter.Workspaces))
+		assert.Equal(t, wTest2.ID, vsAfter.Workspaces[0].ID)
+	})
+}
+
 func TestVariableSetsUpdateWorkspaces(t *testing.T) {
 	client := testClient(t)
 	ctx := context.Background()