Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support to remove tag bindings from projects/workspaces #1023

Merged
merged 4 commits into from
Jan 6, 2025
Merged

Add support to remove tag bindings from projects/workspaces #1023

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0c41524
Add DeleteAllTagBindings to projects
sebasslash Dec 26, 2024
eb3b7b9
Add DeleteAllTagBindings to workspaces
sebasslash Dec 26, 2024
6303726
Update changelog entry
sebasslash Dec 26, 2024
e1ea9cb
Run generate_mocks script
sebasslash Dec 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

* Add support for project level auto destroy settings @simonxmh [#1011](https://github.com/hashicorp/go-tfe/pull/1011)
* Add BETA support for Linux arm64 agents, which is EXPERIMENTAL, SUBJECT TO CHANGE, and may not be available to all users @natalie-todd [#1022](https://github.com/hashicorp/go-tfe/pull/1022)

* Adds support to delete all tag bindings on either a project or workspace by @sebasslash [#1023](https://github.com/hashicorp/go-tfe/pull/1023)

# v1.71.0

## Enhancements
Expand Down
14 changes: 14 additions & 0 deletions mocks/project_mocks.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions mocks/workspace_mocks.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

27 changes: 27 additions & 0 deletions project.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ type Projects interface {

// AddTagBindings adds or modifies the value of existing tag binding keys for a project.
AddTagBindings(ctx context.Context, projectID string, options ProjectAddTagBindingsOptions) ([]*TagBinding, error)

// DeleteAllTagBindings removes all existing tag bindings for a project.
DeleteAllTagBindings(ctx context.Context, projectID string) error
}

// projects implements Projects
Expand Down Expand Up @@ -326,6 +329,30 @@ func (s *projects) Delete(ctx context.Context, projectID string) error {
return req.Do(ctx, nil)
}

// Delete all tag bindings associated with a project.
func (s *projects) DeleteAllTagBindings(ctx context.Context, projectID string) error {
if !validStringID(&projectID) {
return ErrInvalidProjectID
}

type aliasOpts struct {
Type string `jsonapi:"primary,projects"`
TagBindings []*TagBinding `jsonapi:"relation,tag-bindings"`
}

opts := &aliasOpts{
TagBindings: []*TagBinding{},
}

u := fmt.Sprintf("projects/%s", url.PathEscape(projectID))
req, err := s.client.NewRequest("PATCH", u, opts)
if err != nil {
return err
}

return req.Do(ctx, nil)
}

func (o ProjectCreateOptions) valid() error {
if !validString(&o.Name) {
return ErrRequiredName
Expand Down
27 changes: 27 additions & 0 deletions projects_integration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,6 +380,33 @@ func TestProjectsAddTagBindings(t *testing.T) {
})
}

func TestProjects_DeleteAllTagBindings(t *testing.T) {
skipUnlessBeta(t)

client := testClient(t)
ctx := context.Background()

pTest, wCleanup := createProject(t, client, nil)
t.Cleanup(wCleanup)

tagBindings := []*TagBinding{
{Key: "foo", Value: "bar"},
{Key: "baz", Value: "qux"},
}

_, err := client.Projects.AddTagBindings(ctx, pTest.ID, ProjectAddTagBindingsOptions{
TagBindings: tagBindings,
})
require.NoError(t, err)

err = client.Projects.DeleteAllTagBindings(ctx, pTest.ID)
require.NoError(t, err)

bindings, err := client.Projects.ListTagBindings(ctx, pTest.ID)
require.NoError(t, err)
require.Empty(t, bindings)
}

func TestProjectsDelete(t *testing.T) {
client := testClient(t)
ctx := context.Background()
Expand Down
29 changes: 29 additions & 0 deletions workspace.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,9 @@ type Workspaces interface {

// AddTagBindings adds or modifies the value of existing tag binding keys for a workspace.
AddTagBindings(ctx context.Context, workspaceID string, options WorkspaceAddTagBindingsOptions) ([]*TagBinding, error)

// DeleteAllTagBindings removes all tag bindings for a workspace.
DeleteAllTagBindings(ctx context.Context, workspaceID string) error
}

// workspaces implements Workspaces.
Expand Down Expand Up @@ -829,6 +832,32 @@ func (s *workspaces) AddTagBindings(ctx context.Context, workspaceID string, opt
return response.Items, err
}

// DeleteAllTagBindings removes all tag bindings associated with a workspace.
// This method will not remove any inherited tag bindings, which must be
// explicitly removed from the parent project.
func (s *workspaces) DeleteAllTagBindings(ctx context.Context, workspaceID string) error {
if !validStringID(&workspaceID) {
return ErrInvalidWorkspaceID
}

type aliasOpts struct {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No suggestions, just curious about the intent behind the name aliasOpts? What is "alias" referring to?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could have probably used a more descriptive name, but normally structs that "shadow" another -- for example to override struct tag definitions -- are referred to as aliases from what I've seen.

A more descriptive name would be aliasUpdateOptions, but given this wasn't part of the public interface I decided for brevity. An alternative declaration could look like:

opts :=  struct {
		Type        string        `jsonapi:"primary,workspaces"`
		TagBindings []*TagBinding `jsonapi:"relation,tag-bindings"`
	} {
		TagBindings: []*TagBinding{},
	}

Let me know if you would prefer this change

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's ok, no changes needed from my end.

Type string `jsonapi:"primary,workspaces"`
TagBindings []*TagBinding `jsonapi:"relation,tag-bindings"`
}

opts := &aliasOpts{
TagBindings: []*TagBinding{},
}

u := fmt.Sprintf("workspaces/%s", url.PathEscape(workspaceID))
req, err := s.client.NewRequest("PATCH", u, opts)
if err != nil {
return err
}

return req.Do(ctx, nil)
}

// Create is used to create a new workspace.
func (s *workspaces) Create(ctx context.Context, organization string, options WorkspaceCreateOptions) (*Workspace, error) {
if !validStringID(&organization) {
Expand Down
27 changes: 27 additions & 0 deletions workspace_integration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1237,6 +1237,33 @@ func TestWorkspacesAddTagBindings(t *testing.T) {
})
}

func TestWorkspaces_DeleteAllTagBindings(t *testing.T) {
skipUnlessBeta(t)

client := testClient(t)
ctx := context.Background()

wTest, wCleanup := createWorkspace(t, client, nil)
t.Cleanup(wCleanup)

tagBindings := []*TagBinding{
{Key: "foo", Value: "bar"},
{Key: "baz", Value: "qux"},
}

_, err := client.Workspaces.AddTagBindings(ctx, wTest.ID, WorkspaceAddTagBindingsOptions{
TagBindings: tagBindings,
})
require.NoError(t, err)

err = client.Workspaces.DeleteAllTagBindings(ctx, wTest.ID)
require.NoError(t, err)

bindings, err := client.Workspaces.ListTagBindings(ctx, wTest.ID)
require.NoError(t, err)
require.Empty(t, bindings)
}

func TestWorkspacesUpdate(t *testing.T) {
client := testClient(t)
ctx := context.Background()
Expand Down
Loading