resource/gitlab_topic: Add title argument support for GitLab 15.0

Closes: #1043

Author: timofurrer

docs/resources/topic.md

@@ -23,7 +23,8 @@ The `gitlab_topic` resource allows to manage the lifecycle of topics that are th
 
 ```terraform
 resource "gitlab_topic" "functional_programming" {
-  name        = "Functional Programming"
+  name        = "functional-programming"
+  title       = "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"
   avatar_hash = filesha256("${path.module}/avatar.png")
@@ -43,6 +44,7 @@ resource "gitlab_topic" "functional_programming" {
 - `avatar_hash` (String) The hash of the avatar image. Use `filesha256("path/to/avatar.png")` whenever possible. **Note**: this is used to trigger an update of the avatar. If it's not given, but an avatar is given, the avatar will be updated each time.
 - `description` (String) A text describing the topic.
 - `soft_destroy` (Boolean, Deprecated) Empty the topics fields instead of deleting it.
+- `title` (String) The topic's description. Requires at least GitLab 15.0 for which it's a required argument.
 
 ### Read-Only
 

examples/resources/gitlab_topic/resource.tf

@@ -1,5 +1,6 @@
 resource "gitlab_topic" "functional_programming" {
-  name        = "Functional Programming"
+  name        = "functional-programming"
+  title       = "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"
   avatar_hash = filesha256("${path.module}/avatar.png")

internal/provider/resource_gitlab_topic.go

@@ -37,6 +37,11 @@ var _ = registerResource("gitlab_topic", func() *schema.Resource {
 				Type:        schema.TypeString,
 				Required:    true,
 			},
+			"title": {
+				Description: "The topic's description. Requires at least GitLab 15.0 for which it's a required argument.",
+				Type:        schema.TypeString,
+				Optional:    true,
+			},
 			"soft_destroy": {
 				Description: "Empty the topics fields instead of deleting it.",
 				Type:        schema.TypeBool,
@@ -81,10 +86,18 @@ var _ = registerResource("gitlab_topic", func() *schema.Resource {
 
 func resourceGitlabTopicCreate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*gitlab.Client)
+	if err := resourceGitlabTopicEnsureTitleSupport(ctx, client, d); err != nil {
+		return diag.FromErr(err)
+	}
+
 	options := &gitlab.CreateTopicOptions{
 		Name: gitlab.String(d.Get("name").(string)),
 	}
 
+	if v, ok := d.GetOk("title"); ok {
+		options.Title = gitlab.String(v.(string))
+	}
+
 	if v, ok := d.GetOk("description"); ok {
 		options.Description = gitlab.String(v.(string))
 	}
@@ -129,6 +142,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("title", topic.Title)
 	d.Set("description", topic.Description)
 	d.Set("avatar_url", topic.AvatarURL)
 	return nil
@@ -137,11 +151,18 @@ func resourceGitlabTopicRead(ctx context.Context, d *schema.ResourceData, meta i
 func resourceGitlabTopicUpdate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*gitlab.Client)
 	options := &gitlab.UpdateTopicOptions{}
+	if err := resourceGitlabTopicEnsureTitleSupport(ctx, client, d); err != nil {
+		return diag.FromErr(err)
+	}
 
 	if d.HasChange("name") {
 		options.Name = gitlab.String(d.Get("name").(string))
 	}
 
+	if d.HasChange("title") {
+		options.Title = gitlab.String(d.Get("title").(string))
+	}
+
 	if d.HasChange("description") {
 		options.Description = gitlab.String(d.Get("description").(string))
 	}
@@ -230,3 +251,18 @@ func resourceGitlabTopicGetAvatar(avatarPath string) (*gitlab.TopicAvatar, error
 		Image:    avatarFile,
 	}, nil
 }
+
+func resourceGitlabTopicEnsureTitleSupport(ctx context.Context, client *gitlab.Client, d *schema.ResourceData) error {
+	isTitleSupported, err := isGitLabVersionAtLeast(ctx, client, "15.0")()
+	if err != nil {
+		return err
+	}
+
+	if _, ok := d.GetOk("title"); isTitleSupported && !ok {
+		return fmt.Errorf("title is a required attribute for GitLab 15.0 and newer. Please specify it in the configuration.")
+	} else if !isTitleSupported && ok {
+		return fmt.Errorf("title is not supported by your version of GitLab. At least GitLab 15.0 is required")
+	}
+
+	return nil
+}

internal/provider/resource_gitlab_topic_test.go

@@ -4,8 +4,10 @@
 package provider
 
 import (
+	"context"
 	"fmt"
 	"os"
+	"regexp"
 	"strconv"
 	"testing"
 
@@ -25,7 +27,7 @@ func TestAccGitlabTopic_basic(t *testing.T) {
 		Steps: []resource.TestStep{
 			// Create a topic with default options
 			{
-				Config: testAccGitlabTopicRequiredConfig(rInt),
+				Config: testAccGitlabTopicRequiredConfig(t, rInt),
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckGitlabTopicExists("gitlab_topic.foo", &topic),
 					testAccCheckGitlabTopicAttributes(&topic, &testAccGitlabTopicExpectedAttributes{
@@ -44,7 +46,7 @@ func TestAccGitlabTopic_basic(t *testing.T) {
 			},
 			// Update the topics values
 			{
-				Config: testAccGitlabTopicFullConfig(rInt),
+				Config: testAccGitlabTopicFullConfig(t, rInt),
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckGitlabTopicExists("gitlab_topic.foo", &topic),
 					testAccCheckGitlabTopicAttributes(&topic, &testAccGitlabTopicExpectedAttributes{
@@ -66,7 +68,7 @@ func TestAccGitlabTopic_basic(t *testing.T) {
 			},
 			// Update back to the default topics avatar
 			{
-				Config: testAccGitlabTopicFullConfig(rInt),
+				Config: testAccGitlabTopicFullConfig(t, rInt),
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckGitlabTopicExists("gitlab_topic.foo", &topic),
 					testAccCheckGitlabTopicAttributes(&topic, &testAccGitlabTopicExpectedAttributes{
@@ -88,7 +90,7 @@ func TestAccGitlabTopic_basic(t *testing.T) {
 			},
 			// Update the topics avatar
 			{
-				Config: testAccGitlabTopicFullUpdatedAvatarConfig(rInt),
+				Config: testAccGitlabTopicFullUpdatedAvatarConfig(t, rInt),
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckGitlabTopicExists("gitlab_topic.foo", &topic),
 					testAccCheckGitlabTopicAttributes(&topic, &testAccGitlabTopicExpectedAttributes{
@@ -110,7 +112,7 @@ func TestAccGitlabTopic_basic(t *testing.T) {
 			},
 			// Update back to the default topics avatar
 			{
-				Config: testAccGitlabTopicFullConfig(rInt),
+				Config: testAccGitlabTopicFullConfig(t, rInt),
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckGitlabTopicExists("gitlab_topic.foo", &topic),
 					testAccCheckGitlabTopicAttributes(&topic, &testAccGitlabTopicExpectedAttributes{
@@ -132,7 +134,7 @@ func TestAccGitlabTopic_basic(t *testing.T) {
 			},
 			// Update the avatar image, but keep the filename to test the `CustomizeDiff` function
 			{
-				Config: testAccGitlabTopicFullConfig(rInt),
+				Config: testAccGitlabTopicFullConfig(t, rInt),
 				PreConfig: func() {
 					// overwrite the avatar image file
 					if err := copyFile("testdata/gitlab_topic/avatar.png", "testdata/gitlab_topic/avatar.png.bak"); err != nil {
@@ -168,7 +170,7 @@ func TestAccGitlabTopic_basic(t *testing.T) {
 			},
 			// Update the topics values back to their initial state
 			{
-				Config: testAccGitlabTopicRequiredConfig(rInt),
+				Config: testAccGitlabTopicRequiredConfig(t, rInt),
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckGitlabTopicExists("gitlab_topic.foo", &topic),
 					testAccCheckGitlabTopicAttributes(&topic, &testAccGitlabTopicExpectedAttributes{
@@ -189,7 +191,7 @@ func TestAccGitlabTopic_basic(t *testing.T) {
 			},
 			// Updating the topic to have a description before it is deleted
 			{
-				Config: testAccGitlabTopicFullConfig(rInt),
+				Config: testAccGitlabTopicFullConfig(t, rInt),
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckGitlabTopicExists("gitlab_topic.foo", &topic),
 					testAccCheckGitlabTopicAttributes(&topic, &testAccGitlabTopicExpectedAttributes{
@@ -221,7 +223,7 @@ func TestAccGitlabTopic_withoutAvatarHash(t *testing.T) {
 		Steps: []resource.TestStep{
 			// Create a topic with avatar, but without giving a hash
 			{
-				Config: testAccGitlabTopicAvatarWithoutHashConfig(rInt),
+				Config: testAccGitlabTopicAvatarWithoutHashConfig(t, rInt),
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckGitlabTopicExists("gitlab_topic.foo", &topic),
 					resource.TestCheckResourceAttrSet("gitlab_topic.foo", "avatar_url"),
@@ -230,7 +232,7 @@ func TestAccGitlabTopic_withoutAvatarHash(t *testing.T) {
 			},
 			// Update the avatar image, but keep the filename to test the `CustomizeDiff` function
 			{
-				Config:             testAccGitlabTopicAvatarWithoutHashConfig(rInt),
+				Config:             testAccGitlabTopicAvatarWithoutHashConfig(t, rInt),
 				ExpectNonEmptyPlan: true,
 			},
 		},
@@ -247,7 +249,7 @@ func TestAccGitlabTopic_softDestroy(t *testing.T) {
 		Steps: []resource.TestStep{
 			// Create a topic with soft_destroy enabled
 			{
-				Config: testAccGitlabTopicSoftDestroyConfig(rInt),
+				Config: testAccGitlabTopicSoftDestroyConfig(t, rInt),
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckGitlabTopicExists("gitlab_topic.foo", &topic),
 				),
@@ -256,6 +258,46 @@ func TestAccGitlabTopic_softDestroy(t *testing.T) {
 	})
 }
 
+func TestAccGitlabTopic_titleSupport(t *testing.T) {
+	rInt := acctest.RandInt()
+
+	resource.Test(t, resource.TestCase{
+		ProviderFactories: providerFactories,
+		CheckDestroy:      testAccCheckGitlabTopicDestroy,
+		Steps: []resource.TestStep{
+			{
+				SkipFunc: isGitLabVersionAtLeast(context.TODO(), testGitlabClient, "15.0"),
+				Config: fmt.Sprintf(`
+					resource "gitlab_topic" "this" {
+						name = "foo-%d"
+						title = "Foo-%d"
+					}
+				`, rInt, rInt),
+				ExpectError: regexp.MustCompile(`title is not supported by your version of GitLab. At least GitLab 15.0 is required`),
+			},
+			{
+				SkipFunc: isGitLabVersionLessThan(context.TODO(), testGitlabClient, "15.0"),
+				Config: fmt.Sprintf(`
+					resource "gitlab_topic" "this" {
+						name = "foo-%d"
+					}
+				`, rInt),
+				ExpectError: regexp.MustCompile(`title is a required attribute for GitLab 15.0 and newer. Please specify it in the configuration.`),
+			},
+			{
+				SkipFunc: isGitLabVersionLessThan(context.TODO(), testGitlabClient, "15.0"),
+				Config: fmt.Sprintf(`
+					resource "gitlab_topic" "this" {
+						name = "foo-%d"
+						title = "Foo-%d"
+					}
+				`, rInt, rInt),
+				Check: resource.TestCheckResourceAttr("gitlab_topic.this", "title", fmt.Sprintf("Foo-%d", rInt)),
+			},
+		},
+	})
+}
+
 func testAccCheckGitlabTopicExists(n string, assign *gitlab.Topic) resource.TestCheckFunc {
 	return func(s *terraform.State) (err error) {
 
@@ -369,47 +411,73 @@ func testAccCheckGitlabTopicSoftDestroy(s *terraform.State) (err error) {
 	return nil
 }
 
-func testAccGitlabTopicRequiredConfig(rInt int) string {
+func testAccGitlabTopicRequiredConfig(t *testing.T, rInt int) string {
+	var titleConfig string
+	if testAccIsRunningAtLeast(t, "15.0") {
+		titleConfig = fmt.Sprintf(`title = "Foo Req %d"`, rInt)
+	}
+
 	return fmt.Sprintf(`
 resource "gitlab_topic" "foo" {
   name = "foo-req-%d"
-}`, rInt)
+  %s
+}`, rInt, titleConfig)
 }
 
-func testAccGitlabTopicFullConfig(rInt int) string {
+func testAccGitlabTopicFullConfig(t *testing.T, rInt int) string {
+	var titleConfig string
+	if testAccIsRunningAtLeast(t, "15.0") {
+		titleConfig = fmt.Sprintf(`title = "Foo Req %d"`, rInt)
+	}
 	return fmt.Sprintf(`
 resource "gitlab_topic" "foo" {
   name        = "foo-full-%d"
+  %s
   description = "Terraform acceptance tests"
   avatar      = "${path.module}/testdata/gitlab_topic/avatar.png"
   avatar_hash = filesha256("${path.module}/testdata/gitlab_topic/avatar.png")
-}`, rInt)
+}`, rInt, titleConfig)
 }
 
-func testAccGitlabTopicFullUpdatedAvatarConfig(rInt int) string {
+func testAccGitlabTopicFullUpdatedAvatarConfig(t *testing.T, rInt int) string {
+	var titleConfig string
+	if testAccIsRunningAtLeast(t, "15.0") {
+		titleConfig = fmt.Sprintf(`title = "Foo Req %d"`, rInt)
+	}
 	return fmt.Sprintf(`
 resource "gitlab_topic" "foo" {
   name        = "foo-full-%d"
+  %s
   description = "Terraform acceptance tests"
   avatar 	  = "${path.module}/testdata/gitlab_topic/avatar-update.png"
   avatar_hash = filesha256("${path.module}/testdata/gitlab_topic/avatar-update.png")
-}`, rInt)
+}`, rInt, titleConfig)
 }
 
-func testAccGitlabTopicAvatarWithoutHashConfig(rInt int) string {
+func testAccGitlabTopicAvatarWithoutHashConfig(t *testing.T, rInt int) string {
+	var titleConfig string
+	if testAccIsRunningAtLeast(t, "15.0") {
+		titleConfig = fmt.Sprintf(`title = "Foo Req %d"`, rInt)
+	}
 	return fmt.Sprintf(`
 resource "gitlab_topic" "foo" {
   name   = "foo-%d"
+  %s
   avatar = "${path.module}/testdata/gitlab_topic/avatar.png"
-}`, rInt)
+}`, rInt, titleConfig)
 }
 
-func testAccGitlabTopicSoftDestroyConfig(rInt int) string {
+func testAccGitlabTopicSoftDestroyConfig(t *testing.T, rInt int) string {
+	var titleConfig string
+	if testAccIsRunningAtLeast(t, "15.0") {
+		titleConfig = fmt.Sprintf(`title = "Foo Req %d"`, rInt)
+	}
 	return fmt.Sprintf(`
 resource "gitlab_topic" "foo" {
   name        = "foo-soft-destroy-%d"
+  %s
   description = "Terraform acceptance tests"
 
   soft_destroy = true
-}`, rInt)
+}`, rInt, titleConfig)
 }