resource/gitlab_topic: Support avatars

timofurrer · timofurrer · commit 743fa2e4bd39 · 2022-03-28T18:18:50.000+02:00
diff --git a/docs/resources/topic.md b/docs/resources/topic.md
@@ -25,6 +25,7 @@ The `gitlab_topic` resource allows to manage the lifecycle of topics that are th
 resource "gitlab_topic" "functional_programming" {
   name        = "Functional Programming"
   description = "In computer science, functional programming is a programming paradigm where programs are constructed by applying and composing functions."
+  avatar      = "${path.module}/avatar.png"
 }
 ```
 
@@ -33,13 +34,19 @@ resource "gitlab_topic" "functional_programming" {
 
 ### Required
 
-- `name` (String) The topic's name
+- `name` (String) The topic's name.
 
 ### Optional
 
-- `description` (String) A text describing the topic
+- `avatar` (String) A local path to the avatar image to upload. **Note**: not available for imported resources
+- `description` (String) A text describing the topic.
 - `id` (String) The ID of this resource.
-- `soft_destroy` (Boolean, Deprecated) Empty the topics fields instead of deleting it
+- `soft_destroy` (Boolean, Deprecated) Empty the topics fields instead of deleting it.
+
+### Read-Only
+
+- `_avatar_hash` (String) The hash of the avatar image. **Note**: this is an internally used attribute to track the avatar image.
+- `avatar_url` (String) The URL of the avatar image.
 
 ## Import
 
diff --git a/examples/resources/gitlab_topic/resource.tf b/examples/resources/gitlab_topic/resource.tf
@@ -1,4 +1,5 @@
 resource "gitlab_topic" "functional_programming" {
   name        = "Functional Programming"
   description = "In computer science, functional programming is a programming paradigm where programs are constructed by applying and composing functions."
+  avatar      = "${path.module}/avatar.png"
 }
diff --git a/internal/provider/helper_test.go b/internal/provider/helper_test.go
@@ -2,6 +2,7 @@ package provider
 
 import (
 	"fmt"
+	"io"
 	"os"
 	"strings"
 	"testing"
@@ -394,3 +395,23 @@ func testCheckResourceAttrLazy(name string, key string, value func() string) res
 		return resource.TestCheckResourceAttr(name, key, value())(s)
 	}
 }
+
+func copyFile(src, dst string) error {
+	in, err := os.Open(src)
+	if err != nil {
+		return err
+	}
+	defer in.Close()
+
+	out, err := os.Create(dst)
+	if err != nil {
+		return err
+	}
+	defer out.Close()
+
+	_, err = io.Copy(out, in)
+	if err != nil {
+		return err
+	}
+	return out.Close()
+}
diff --git a/internal/provider/resource_gitlab_topic.go b/internal/provider/resource_gitlab_topic.go
@@ -1,9 +1,13 @@
 package provider
 
 import (
+	"bytes"
 	"context"
+	"crypto/sha256"
 	"fmt"
+	"io"
 	"log"
+	"os"
 	"strconv"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
@@ -32,21 +36,57 @@ var _ = registerResource("gitlab_topic", func() *schema.Resource {
 
 		Schema: map[string]*schema.Schema{
 			"name": {
-				Description: "The topic's name",
+				Description: "The topic's name.",
 				Type:        schema.TypeString,
 				Required:    true,
 			},
 			"soft_destroy": {
-				Description: "Empty the topics fields instead of deleting it",
+				Description: "Empty the topics fields instead of deleting it.",
 				Type:        schema.TypeBool,
 				Optional:    true,
 				Deprecated:  "GitLab 14.9 introduced the proper deletion of topics. This field is no longer needed.",
 			},
 			"description": {
-				Description: "A text describing the topic",
+				Description: "A text describing the topic.",
 				Type:        schema.TypeString,
 				Optional:    true,
 			},
+			"avatar": {
+				Description: "A local path to the avatar image to upload. **Note**: not available for imported resources",
+				Type:        schema.TypeString,
+				Optional:    true,
+			},
+			"_avatar_hash": {
+				Description: "The hash of the avatar image. **Note**: this is an internally used attribute to track the avatar image.",
+				Type:        schema.TypeString,
+				Computed:    true,
+			},
+			"avatar_url": {
+				Description: "The URL of the avatar image.",
+				Type:        schema.TypeString,
+				Computed:    true,
+			},
+		},
+		CustomizeDiff: func(ctx context.Context, rd *schema.ResourceDiff, i interface{}) error {
+			if v, ok := rd.GetOk("avatar"); ok {
+				avatarPath := v.(string)
+				avatarFile, err := os.Open(avatarPath)
+				if err != nil {
+					return fmt.Errorf("Unable to open avatar file %s: %s", avatarPath, err)
+				}
+
+				avatarHash, err := getSha256(avatarFile)
+				if err != nil {
+					return fmt.Errorf("Unable to get hash from avatar file %s: %s", avatarPath, err)
+				}
+
+				if rd.Get("_avatar_hash").(string) != avatarHash {
+					if err := rd.SetNew("_avatar_hash", avatarHash); err != nil {
+						return fmt.Errorf("Unable to set _avatar_hash: %s", err)
+					}
+				}
+			}
+			return nil
 		},
 	}
 })
@@ -61,6 +101,16 @@ func resourceGitlabTopicCreate(ctx context.Context, d *schema.ResourceData, meta
 		options.Description = gitlab.String(v.(string))
 	}
 
+	avatarHash := ""
+	if v, ok := d.GetOk("avatar"); ok {
+		avatar, hash, err := resourceGitlabTopicGetAvatar(v.(string))
+		if err != nil {
+			return diag.FromErr(err)
+		}
+		options.Avatar = avatar
+		avatarHash = hash
+	}
+
 	log.Printf("[DEBUG] create gitlab topic %s", *options.Name)
 
 	topic, _, err := client.Topics.CreateTopic(options, gitlab.WithContext(ctx))
@@ -69,7 +119,9 @@ func resourceGitlabTopicCreate(ctx context.Context, d *schema.ResourceData, meta
 	}
 
 	d.SetId(fmt.Sprintf("%d", topic.ID))
-
+	if options.Avatar != nil {
+		d.Set("_avatar_hash", avatarHash)
+	}
 	return resourceGitlabTopicRead(ctx, d, meta)
 }
 
@@ -95,6 +147,7 @@ func resourceGitlabTopicRead(ctx context.Context, d *schema.ResourceData, meta i
 	d.SetId(fmt.Sprintf("%d", topic.ID))
 	d.Set("name", topic.Name)
 	d.Set("description", topic.Description)
+	d.Set("avatar_url", topic.AvatarURL)
 
 	return nil
 }
@@ -111,6 +164,26 @@ func resourceGitlabTopicUpdate(ctx context.Context, d *schema.ResourceData, meta
 		options.Description = gitlab.String(d.Get("description").(string))
 	}
 
+	if d.HasChanges("avatar", "_avatar_hash") {
+		avatarPath := d.Get("avatar").(string)
+		var avatar *gitlab.TopicAvatar
+		var avatarHash string
+		// NOTE: the avatar should be removed
+		if avatarPath == "" {
+			avatar = &gitlab.TopicAvatar{}
+			avatarHash = ""
+		} else {
+			changedAvatar, changedAvatarHash, err := resourceGitlabTopicGetAvatar(avatarPath)
+			if err != nil {
+				return diag.FromErr(err)
+			}
+			avatar = changedAvatar
+			avatarHash = changedAvatarHash
+		}
+		options.Avatar = avatar
+		d.Set("_avatar_hash", avatarHash)
+	}
+
 	log.Printf("[DEBUG] update gitlab topic %s", d.Id())
 
 	topicID, err := strconv.Atoi(d.Id())
@@ -121,7 +194,6 @@ func resourceGitlabTopicUpdate(ctx context.Context, d *schema.ResourceData, meta
 	if err != nil {
 		return diag.Errorf("Failed to update topic %d: %s", topicID, err)
 	}
-
 	return resourceGitlabTopicRead(ctx, d, meta)
 }
 
@@ -166,3 +238,31 @@ func resourceGitlabTopicDelete(ctx context.Context, d *schema.ResourceData, meta
 
 	return nil
 }
+
+func resourceGitlabTopicGetAvatar(avatarPath string) (*gitlab.TopicAvatar, string, error) {
+	avatarFile, err := os.Open(avatarPath)
+	if err != nil {
+		return nil, "", fmt.Errorf("Unable to open avatar file %s: %s", avatarPath, err)
+	}
+
+	avatarImageBuf := &bytes.Buffer{}
+	teeReader := io.TeeReader(avatarFile, avatarImageBuf)
+	avatarHash, err := getSha256(teeReader)
+	if err != nil {
+		return nil, "", fmt.Errorf("Unable to get hash from avatar file %s: %s", avatarPath, err)
+	}
+
+	avatarImageReader := bytes.NewReader(avatarImageBuf.Bytes())
+	return &gitlab.TopicAvatar{
+		Filename: avatarPath,
+		Image:    avatarImageReader,
+	}, avatarHash, nil
+}
+
+func getSha256(r io.Reader) (string, error) {
+	h := sha256.New()
+	if _, err := io.Copy(h, r); err != nil {
+		return "", fmt.Errorf("Unable to get hash %s", err)
+	}
+	return fmt.Sprintf("%x", h.Sum(nil)), nil
+}
diff --git a/internal/provider/resource_gitlab_topic_test.go b/internal/provider/resource_gitlab_topic_test.go
@@ -2,6 +2,7 @@ package provider
 
 import (
 	"fmt"
+	"os"
 	"strconv"
 	"testing"
 
@@ -36,7 +37,7 @@ func TestAccGitlabTopic_basic(t *testing.T) {
 				ImportState:       true,
 				ImportStateVerify: true,
 				ImportStateVerifyIgnore: []string{
-					"soft_destroy",
+					"avatar", "_avatar_hash", "soft_destroy",
 				},
 			},
 			// Update the topics values
@@ -48,6 +49,8 @@ func TestAccGitlabTopic_basic(t *testing.T) {
 						Name:        fmt.Sprintf("foo-full-%d", rInt),
 						Description: "Terraform acceptance tests",
 					}),
+					resource.TestCheckResourceAttrSet("gitlab_topic.foo", "avatar_url"),
+					resource.TestCheckResourceAttr("gitlab_topic.foo", "_avatar_hash", "8d29d9c393facb9d86314eb347a03fde503f2c0422bf55af7df086deb126107e"),
 				),
 			},
 			// Verify import
@@ -56,7 +59,43 @@ func TestAccGitlabTopic_basic(t *testing.T) {
 				ImportState:       true,
 				ImportStateVerify: true,
 				ImportStateVerifyIgnore: []string{
-					"soft_destroy",
+					"avatar", "_avatar_hash", "soft_destroy",
+				},
+			},
+			// Update the avatar image, but keep the filename to test the `CustomizeDiff` function
+			{
+				Config: testAccGitlabTopicFullConfig(rInt),
+				PreConfig: func() {
+					// overwrite the avatar image file
+					if err := copyFile("testdata/gitlab_topic/avatar.png", "testdata/gitlab_topic/avatar.png.bak"); err != nil {
+						t.Fatalf("failed to backup the avatar image file: %v", err)
+					}
+					if err := copyFile("testdata/gitlab_topic/avatar-update.png", "testdata/gitlab_topic/avatar.png"); err != nil {
+						t.Fatalf("failed to overwrite the avatar image file: %v", err)
+					}
+					t.Cleanup(func() {
+						if err := os.Rename("testdata/gitlab_topic/avatar.png.bak", "testdata/gitlab_topic/avatar.png"); err != nil {
+							t.Fatalf("failed to restore the avatar image file: %v", err)
+						}
+					})
+				},
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckGitlabTopicExists("gitlab_topic.foo", &topic),
+					testAccCheckGitlabTopicAttributes(&topic, &testAccGitlabTopicExpectedAttributes{
+						Name:        fmt.Sprintf("foo-full-%d", rInt),
+						Description: "Terraform acceptance tests",
+					}),
+					resource.TestCheckResourceAttrSet("gitlab_topic.foo", "avatar_url"),
+					resource.TestCheckResourceAttr("gitlab_topic.foo", "_avatar_hash", "a58bd926fd3baabd41c56e810f62ade8705d18a4e280fb35764edb4b778444db"),
+				),
+			},
+			// Verify import
+			{
+				ResourceName:      "gitlab_topic.foo",
+				ImportState:       true,
+				ImportStateVerify: true,
+				ImportStateVerifyIgnore: []string{
+					"avatar", "_avatar_hash", "soft_destroy",
 				},
 			},
 			// Update the topics values back to their initial state
@@ -67,6 +106,8 @@ func TestAccGitlabTopic_basic(t *testing.T) {
 					testAccCheckGitlabTopicAttributes(&topic, &testAccGitlabTopicExpectedAttributes{
 						Name: fmt.Sprintf("foo-req-%d", rInt),
 					}),
+					resource.TestCheckResourceAttr("gitlab_topic.foo", "avatar_url", ""),
+					resource.TestCheckResourceAttr("gitlab_topic.foo", "_avatar_hash", ""),
 				),
 			},
 			// Verify import
@@ -75,7 +116,7 @@ func TestAccGitlabTopic_basic(t *testing.T) {
 				ImportState:       true,
 				ImportStateVerify: true,
 				ImportStateVerifyIgnore: []string{
-					"soft_destroy",
+					"avatar", "_avatar_hash", "soft_destroy",
 				},
 			},
 			// Updating the topic to have a description before it is deleted
@@ -95,7 +136,7 @@ func TestAccGitlabTopic_basic(t *testing.T) {
 				ImportState:       true,
 				ImportStateVerify: true,
 				ImportStateVerifyIgnore: []string{
-					"soft_destroy",
+					"avatar", "_avatar_hash", "soft_destroy",
 				},
 			},
 		},
@@ -247,6 +288,7 @@ func testAccGitlabTopicFullConfig(rInt int) string {
 resource "gitlab_topic" "foo" {
   name             = "foo-full-%d"
   description      = "Terraform acceptance tests"
+  avatar 		   = "${path.module}/testdata/gitlab_topic/avatar.png"
 }`, rInt)
 }
 
diff --git a/internal/provider/testdata/gitlab_topic/avatar-update.png b/internal/provider/testdata/gitlab_topic/avatar-update.png
diff --git a/internal/provider/testdata/gitlab_topic/avatar.png b/internal/provider/testdata/gitlab_topic/avatar.png

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`resource "gitlab_topic" "functional_programming" {`
`2`	`2`	`name = "Functional Programming"`
`3`	`3`	`description = "In computer science, functional programming is a programming paradigm where programs are constructed by applying and composing functions."`
	`4`	`+ avatar = "${path.module}/avatar.png"`
`4`	`5`	`}`