Merge pull request #1087 from hashicorp/add-inherited-from-relationship-effective-tags

fix: Add links attribute to effective tags

Author: sebasslash

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Unreleased
 
+# v1.78.0
+
+## Enhancements
+* Adds `Links` field to `EffectiveTagBindings` to check whether an effective tag binding is inherited, by @sebasslash [#1087](https://github.com/hashicorp/go-tfe/pull/1087)
+
 # v1.77.0
 
 ## Enhancements
@@ -17,7 +22,7 @@ In the last release, Runs interface method `ListForOrganization` included pagina
 ## Enhancements
 
 * Adds `DefaultProject` to `OrganizationUpdateOptions` to support updating an organization's default project. This provides BETA support, which is EXPERIMENTAL, SUBJECT TO CHANGE, and may not be available to all users, by @mkam [#1056](https://github.com/hashicorp/go-tfe/pull/1056)
-* Adds `ReadTerraformRegistryModule` to support reading a registry module from Terraform Registry's proxied endpoints by @paladin-devops [#1057](https://github.com/hashicorp/go-tfe/pull/1057) 
+* Adds `ReadTerraformRegistryModule` to support reading a registry module from Terraform Registry's proxied endpoints by @paladin-devops [#1057](https://github.com/hashicorp/go-tfe/pull/1057)
 * Adds a new method `ListForOrganization` to list Runs in an organization by @arybolovlev [#1059](https://github.com/hashicorp/go-tfe/pull/1059)
 
 ## Bug fixes

mocks/project_mocks.go

@@ -28,6 +28,9 @@ type Projects interface {
 	// Read a project by its ID.
 	Read(ctx context.Context, projectID string) (*Project, error)
 
+	// ReadWithOptions a project by its ID.
+	ReadWithOptions(ctx context.Context, projectID string, options ProjectReadOptions) (*Project, error)
+
 	// Update a project.
 	Update(ctx context.Context, projectID string, options ProjectUpdateOptions) (*Project, error)
 
@@ -101,6 +104,11 @@ type ProjectListOptions struct {
 	Include []ProjectIncludeOpt `url:"include,omitempty"`
 }
 
+type ProjectReadOptions struct {
+	// Optional: A list of relations to include
+	Include []ProjectIncludeOpt `url:"include,omitempty"`
+}
+
 // ProjectCreateOptions represents the options for creating a project
 type ProjectCreateOptions struct {
 	// Type is a public field utilized by JSON:API to
@@ -205,6 +213,27 @@ func (s *projects) Create(ctx context.Context, organization string, options Proj
 	return p, nil
 }
 
+// ReadWithOptions a project by its ID.
+func (s *projects) ReadWithOptions(ctx context.Context, projectID string, options ProjectReadOptions) (*Project, error) {
+	if !validStringID(&projectID) {
+		return nil, ErrInvalidProjectID
+	}
+
+	u := fmt.Sprintf("projects/%s", url.PathEscape(projectID))
+	req, err := s.client.NewRequest("GET", u, options)
+	if err != nil {
+		return nil, err
+	}
+
+	p := &Project{}
+	err = req.Do(ctx, p)
+	if err != nil {
+		return nil, err
+	}
+
+	return p, nil
+}
+
 // Read a single project by its ID.
 func (s *projects) Read(ctx context.Context, projectID string) (*Project, error) {
 	if !validStringID(&projectID) {

project.go

@@ -142,6 +142,35 @@ func TestProjectsList(t *testing.T) {
 	})
 }
 
+func TestProjectsReadWithOptions(t *testing.T) {
+	client := testClient(t)
+	ctx := context.Background()
+
+	orgTest, orgTestCleanup := createOrganization(t, client)
+	defer orgTestCleanup()
+
+	pTest, pTestCleanup := createProjectWithOptions(t, client, orgTest, ProjectCreateOptions{
+		Name: "project-with-tags",
+		TagBindings: []*TagBinding{
+			{Key: "foo", Value: "bar"},
+		},
+	})
+	defer pTestCleanup()
+
+	t.Run("when the project exists", func(t *testing.T) {
+		p, err := client.Projects.ReadWithOptions(ctx, pTest.ID, ProjectReadOptions{
+			Include: []ProjectIncludeOpt{ProjectEffectiveTagBindings},
+		})
+		require.NoError(t, err)
+		assert.Equal(t, orgTest.Name, p.Organization.Name)
+
+		// Tag data is included
+		assert.Len(t, p.EffectiveTagBindings, 1)
+		assert.Equal(t, "foo", p.EffectiveTagBindings[0].Key)
+		assert.Equal(t, "bar", p.EffectiveTagBindings[0].Value)
+	})
+}
+
 func TestProjectsRead(t *testing.T) {
 	client := testClient(t)
 	ctx := context.Background()

projects_integration_test.go

@@ -3,7 +3,9 @@
 
 package tfe
 
-import "fmt"
+import (
+	"fmt"
+)
 
 type TagList struct {
 	*Pagination
@@ -23,9 +25,10 @@ type TagBinding struct {
 }
 
 type EffectiveTagBinding struct {
-	ID    string `jsonapi:"primary,effective-tag-bindings"`
-	Key   string `jsonapi:"attr,key"`
-	Value string `jsonapi:"attr,value,omitempty"`
+	ID    string                 `jsonapi:"primary,effective-tag-bindings"`
+	Key   string                 `jsonapi:"attr,key"`
+	Value string                 `jsonapi:"attr,value,omitempty"`
+	Links map[string]interface{} `jsonapi:"links,omitempty"`
 }
 
 func encodeTagFiltersAsParams(filters []*TagBinding) map[string][]string {

tag.go

@@ -987,7 +987,7 @@ func checkResponseCode(r *http.Response) error {
 			return err
 		}
 
-		if errorPayloadContains(errs, "Invalid include parameter") {
+		if errorPayloadContains(errs, "include parameter") {
 			return ErrInvalidIncludeValue
 		}
 		return errors.New(strings.Join(errs, "\n"))

tfe.go

@@ -305,8 +305,17 @@ func TestWorkspacesList(t *testing.T) {
 		orgTest2, orgTest2Cleanup := createOrganization(t, client)
 		t.Cleanup(orgTest2Cleanup)
 
+		prj, pTestCleanup1 := createProjectWithOptions(t, client, orgTest2, ProjectCreateOptions{
+			Name: randomStringWithoutSpecialChar(t),
+			TagBindings: []*TagBinding{
+				{Key: "key3", Value: "value3"},
+			},
+		})
+		t.Cleanup(pTestCleanup1)
+
 		_, wTestCleanup1 := createWorkspaceWithOptions(t, client, orgTest2, WorkspaceCreateOptions{
-			Name: String(randomString(t)),
+			Name:    String(randomString(t)),
+			Project: prj,
 			TagBindings: []*TagBinding{
 				{Key: "key1", Value: "value1"},
 				{Key: "key2", Value: "value2a"},
@@ -319,11 +328,24 @@ func TestWorkspacesList(t *testing.T) {
 		})
 		require.NoError(t, err)
 		require.Len(t, wl.Items, 1)
-		require.Len(t, wl.Items[0].EffectiveTagBindings, 2)
+		require.Len(t, wl.Items[0].EffectiveTagBindings, 3)
 		assert.NotEmpty(t, wl.Items[0].EffectiveTagBindings[0].Key)
 		assert.NotEmpty(t, wl.Items[0].EffectiveTagBindings[0].Value)
 		assert.NotEmpty(t, wl.Items[0].EffectiveTagBindings[1].Key)
 		assert.NotEmpty(t, wl.Items[0].EffectiveTagBindings[1].Value)
+		assert.NotEmpty(t, wl.Items[0].EffectiveTagBindings[2].Key)
+		assert.NotEmpty(t, wl.Items[0].EffectiveTagBindings[2].Value)
+
+		inheritedTagsFound := 0
+		for _, tag := range wl.Items[0].EffectiveTagBindings {
+			if tag.Links["inherited-from"] != nil {
+				inheritedTagsFound += 1
+			}
+		}
+
+		if inheritedTagsFound != 1 {
+			t.Fatalf("Expected 1 inherited tag, got %d", inheritedTagsFound)
+		}
 	})
 
 	t.Run("when using project id filter and project contains workspaces", func(t *testing.T) {
@@ -3089,3 +3111,69 @@ func TestWorkspacesAutoDestroyDuration(t *testing.T) {
 		require.Equal(t, wTest.InheritsProjectAutoDestroy, false)
 	})
 }
+
+func TestWorkspaces_effectiveTagBindingsInheritedFrom(t *testing.T) {
+	skipUnlessBeta(t)
+
+	client := testClient(t)
+	ctx := context.Background()
+
+	orgTest, orgTestCleanup := createOrganization(t, client)
+	t.Cleanup(orgTestCleanup)
+
+	projTest, projTestCleanup := createProject(t, client, orgTest)
+	t.Cleanup(projTestCleanup)
+
+	ws, wsCleanup := createWorkspaceWithOptions(t, client, orgTest, WorkspaceCreateOptions{
+		Name:    String("mycoolworkspace"),
+		Project: projTest,
+	})
+	t.Cleanup(wsCleanup)
+
+	_, err := client.Workspaces.AddTagBindings(ctx, ws.ID, WorkspaceAddTagBindingsOptions{
+		TagBindings: []*TagBinding{
+			{
+				Key:   "a",
+				Value: "1",
+			},
+			{
+				Key:   "b",
+				Value: "2",
+			},
+		},
+	})
+	require.NoError(t, err)
+
+	t.Run("when no tags are inherited from the project", func(t *testing.T) {
+		effectiveBindings, err := client.Workspaces.ListEffectiveTagBindings(ctx, ws.ID)
+		require.NoError(t, err)
+
+		for _, binding := range effectiveBindings {
+			require.Nil(t, binding.Links)
+		}
+	})
+
+	t.Run("when tags are inherited from the project", func(t *testing.T) {
+		_, err := client.Projects.AddTagBindings(ctx, projTest.ID, ProjectAddTagBindingsOptions{
+			TagBindings: []*TagBinding{
+				{
+					Key:   "inherited",
+					Value: "foo",
+				},
+			},
+		})
+		require.NoError(t, err)
+
+		effectiveBindings, err := client.Workspaces.ListEffectiveTagBindings(ctx, ws.ID)
+		require.NoError(t, err)
+
+		for _, binding := range effectiveBindings {
+			if binding.Key == "inherited" {
+				require.NotNil(t, binding.Links)
+				require.NotNil(t, binding.Links["inherited-from"])
+			} else {
+				require.Nil(t, binding.Links)
+			}
+		}
+	})
+}