Implement support for the Custom Attribute APIs. Closes #722

This includes the Custom Attributes for Users, Groups and Projects.

Author: timofurrer

docs/resources/group_custom_attribute.md

@@ -0,0 +1,37 @@
+# gitlab\_group\_custom\_attribute
+
+This resource allows you to set custom attributes for a group.
+
+## Example Usage
+
+```hcl
+resource "gitlab_group_custom_attribute" "attr" {
+  group = "42"
+  key   = "location"
+  value = "Greenland"
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `group` - (Required) The id of the group.
+
+* `key` - (Required) Key for the Custom Attribute.
+
+* `value` - (Required) Value for the Custom Attribute.
+
+## Import
+
+You can import a group custom attribute using the following id pattern:
+
+```shell
+$ terraform import gitlab_group_custom_attribute.attr <group-id>:<key>
+```
+
+For the example above this would be:
+
+```shell
+$ terraform import gitlab_group_custom_attribute.attr 42:location
+```

docs/resources/project_custom_attribute.md

@@ -0,0 +1,37 @@
+# gitlab\_project\_custom\_attribute
+
+This resource allows you to set custom attributes for a project.
+
+## Example Usage
+
+```hcl
+resource "gitlab_project_custom_attribute" "attr" {
+  project = "42"
+  key     = "location"
+  value   = "Greenland"
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `project` - (Required) The id of the project.
+
+* `key` - (Required) Key for the Custom Attribute.
+
+* `value` - (Required) Value for the Custom Attribute.
+
+## Import
+
+You can import a project custom attribute using the following id pattern:
+
+```shell
+$ terraform import gitlab_project_custom_attribute.attr <project-id>:<key>
+```
+
+For the example above this would be:
+
+```shell
+$ terraform import gitlab_project_custom_attribute.attr 42:location
+```

docs/resources/user_custom_attribute.md

@@ -0,0 +1,37 @@
+# gitlab\_user\_custom\_attribute
+
+This resource allows you to set custom attributes for a user.
+
+## Example Usage
+
+```hcl
+resource "gitlab_user_custom_attribute" "attr" {
+  user  = "42"
+  key   = "location"
+  value = "Greenland"
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `user` - (Required) The id of the user.
+
+* `key` - (Required) Key for the Custom Attribute.
+
+* `value` - (Required) Value for the Custom Attribute.
+
+## Import
+
+You can import a user custom attribute using the following id pattern:
+
+```shell
+$ terraform import gitlab_user_custom_attribute.attr <user-id>:<key>
+```
+
+For the example above this would be:
+
+```shell
+$ terraform import gitlab_user_custom_attribute.attr 42:location
+```

gitlab/custom_attribute_helper.go

@@ -0,0 +1,129 @@
+package gitlab
+
+import (
+	"fmt"
+	"log"
+	"strconv"
+	"strings"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	gitlab "github.com/xanzy/go-gitlab"
+)
+
+type CustomAttributeGetter func(int, string, ...gitlab.RequestOptionFunc) (*gitlab.CustomAttribute, *gitlab.Response, error)
+type CustomAttributeSetter func(int, gitlab.CustomAttribute, ...gitlab.RequestOptionFunc) (*gitlab.CustomAttribute, *gitlab.Response, error)
+type CustomAttributeDeleter func(int, string, ...gitlab.RequestOptionFunc) (*gitlab.Response, error)
+
+type CreateGetter func(*gitlab.Client) CustomAttributeGetter
+type CreateSetter func(*gitlab.Client) CustomAttributeSetter
+type CreateDeleter func(*gitlab.Client) CustomAttributeDeleter
+
+func CreateCustomAttributeResource(idName string, createGetter CreateGetter, createSetter CreateSetter, createDeleter CreateDeleter) *schema.Resource {
+	setToState := func(d *schema.ResourceData, userId int, customAttribute *gitlab.CustomAttribute) {
+		// lintignore:R001
+		d.Set(idName, userId)
+		d.Set("key", customAttribute.Key)
+		d.Set("value", customAttribute.Value)
+	}
+
+	readFunc := func(d *schema.ResourceData, meta interface{}) error {
+		client := meta.(*gitlab.Client)
+		getter := createGetter(client)
+		log.Printf("[DEBUG] read Custom Attribute %s", d.Id())
+
+		id, key, err := parseId(d.Id())
+		if err != nil {
+			return err
+		}
+
+		customAttribute, _, err := getter(id, key)
+		if err != nil {
+			return err
+		}
+
+		setToState(d, id, customAttribute)
+		return nil
+	}
+
+	setFunc := func(d *schema.ResourceData, meta interface{}) error {
+		client := meta.(*gitlab.Client)
+		setter := createSetter(client)
+
+		id := d.Get(idName).(int)
+		options := &gitlab.CustomAttribute{
+			Key:   d.Get("key").(string),
+			Value: d.Get("value").(string),
+		}
+
+		log.Printf("[DEBUG] set (create or update) Custom Attribute %s with value %s for %s %d", options.Key, options.Value, idName, id)
+
+		customAttribute, _, err := setter(id, *options)
+		if err != nil {
+			return err
+		}
+
+		d.SetId(buildId(id, customAttribute.Key))
+		return readFunc(d, meta)
+	}
+
+	deleteFunc := func(d *schema.ResourceData, meta interface{}) error {
+		client := meta.(*gitlab.Client)
+		deleter := createDeleter(client)
+		log.Printf("[DEBUG] delete Custom Attribute %s", d.Id())
+
+		id, key, err := parseId(d.Id())
+		if err != nil {
+			return err
+		}
+
+		_, err = deleter(id, key)
+		if err != nil {
+			return err
+		}
+
+		return nil
+	}
+
+	return &schema.Resource{
+		Create: setFunc,
+		Read:   readFunc,
+		Update: setFunc,
+		Delete: deleteFunc,
+		Importer: &schema.ResourceImporter{
+			StateContext: schema.ImportStatePassthroughContext,
+		},
+
+		Schema: map[string]*schema.Schema{
+			idName: {
+				Type:     schema.TypeInt,
+				Required: true,
+			},
+			"key": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"value": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+		},
+	}
+}
+
+func parseId(id string) (int, string, error) {
+	parts := strings.SplitN(id, ":", 2)
+	if len(parts) != 2 {
+		return -1, "", fmt.Errorf("unexpected ID format (%q). Expected id:key", id)
+	}
+
+	subjectId, err := strconv.Atoi(parts[0])
+	if err != nil {
+		return -1, "", fmt.Errorf("unexpected ID format (%q). Expected id:key whereas `id` must be an integer", id)
+	}
+
+	return subjectId, parts[1], nil
+}
+
+func buildId(id int, key string) string {
+	return fmt.Sprintf("%d:%s", id, key)
+}

gitlab/provider.go

@@ -66,7 +66,9 @@ func Provider() *schema.Provider {
 			"gitlab_branch_protection":          resourceGitlabBranchProtection(),
 			"gitlab_tag_protection":             resourceGitlabTagProtection(),
 			"gitlab_group":                      resourceGitlabGroup(),
+			"gitlab_group_custom_attribute":     resourceGitlabGroupCustomAttribute(),
 			"gitlab_project":                    resourceGitlabProject(),
+			"gitlab_project_custom_attribute":   resourceGitlabProjectCustomAttribute(),
 			"gitlab_label":                      resourceGitlabLabel(),
 			"gitlab_group_label":                resourceGitlabGroupLabel(),
 			"gitlab_pipeline_schedule":          resourceGitlabPipelineSchedule(),
@@ -77,6 +79,7 @@ func Provider() *schema.Provider {
 			"gitlab_deploy_key_enable":          resourceGitlabDeployEnableKey(),
 			"gitlab_deploy_token":               resourceGitlabDeployToken(),
 			"gitlab_user":                       resourceGitlabUser(),
+			"gitlab_user_custom_attribute":      resourceGitlabUserCustomAttribute(),
 			"gitlab_project_membership":         resourceGitlabProjectMembership(),
 			"gitlab_group_membership":           resourceGitlabGroupMembership(),
 			"gitlab_project_variable":           resourceGitlabProjectVariable(),

gitlab/resource_gitlab_group_custom_attribute.go

@@ -0,0 +1,21 @@
+package gitlab
+
+import (
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	gitlab "github.com/xanzy/go-gitlab"
+)
+
+func resourceGitlabGroupCustomAttribute() *schema.Resource {
+	return CreateCustomAttributeResource(
+		"group",
+		func(client *gitlab.Client) CustomAttributeGetter {
+			return client.CustomAttribute.GetCustomGroupAttribute
+		},
+		func(client *gitlab.Client) CustomAttributeSetter {
+			return client.CustomAttribute.SetCustomGroupAttribute
+		},
+		func(client *gitlab.Client) CustomAttributeDeleter {
+			return client.CustomAttribute.DeleteCustomGroupAttribute
+		},
+	)
+}

gitlab/resource_gitlab_group_custom_attribute_test.go

@@ -0,0 +1,114 @@
+package gitlab
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
+	"github.com/xanzy/go-gitlab"
+)
+
+func TestAccGitlabGroupCustomAttribute_basic(t *testing.T) {
+	var group gitlab.Group
+	var customAttribute gitlab.CustomAttribute
+	rInt := acctest.RandInt()
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckGitlabGroupDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config: fmt.Sprintf(`
+resource "gitlab_group" "group" {
+  	name = "foo-name-%d"
+    path = "foo-path-%d"
+}
+
+resource "gitlab_group_custom_attribute" "attr" {
+	group = gitlab_group.group.id
+	key   = "foo"
+	value = "bar"
+}`, rInt, rInt),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckGitlabGroupExists("gitlab_group.group", &group),
+					testAccCheckGitlabGroupCustomAttributeExists("gitlab_group_custom_attribute.attr", &customAttribute),
+					testAccCheckGitlabGroupCustomAttributes(&customAttribute, &testAccGitlabGroupExpectedCustomAttributes{
+						Key:   "foo",
+						Value: "bar",
+					}),
+				),
+			},
+			// Update the custom attribute
+			{
+				Config: fmt.Sprintf(`
+resource "gitlab_group" "group" {
+	name = "foo-name-%d"
+	path = "foo-path-%d"
+}
+
+resource "gitlab_group_custom_attribute" "attr" {
+	group = gitlab_group.group.id
+	key   = "foo"
+	value = "updated"
+}`, rInt, rInt),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckGitlabGroupExists("gitlab_group.group", &group),
+					testAccCheckGitlabGroupCustomAttributeExists("gitlab_group_custom_attribute.attr", &customAttribute),
+					testAccCheckGitlabGroupCustomAttributes(&customAttribute, &testAccGitlabGroupExpectedCustomAttributes{
+						Key:   "foo",
+						Value: "updated",
+					}),
+				),
+			},
+			{
+				ResourceName:      "gitlab_group_custom_attribute.attr",
+				ImportState:       true,
+				ImportStateVerify: true,
+			},
+		},
+	})
+}
+
+func testAccCheckGitlabGroupCustomAttributeExists(n string, customAttribute *gitlab.CustomAttribute) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		rs, ok := s.RootModule().Resources[n]
+		if !ok {
+			return fmt.Errorf("Not Found: %s", n)
+		}
+
+		id, key, err := parseId(rs.Primary.ID)
+		if err != nil {
+			return err
+		}
+
+		client := testAccProvider.Meta().(*gitlab.Client)
+		gotCustomAttribute, _, err := client.CustomAttribute.GetCustomGroupAttribute(id, key)
+		if err != nil {
+			return err
+		}
+		*customAttribute = *gotCustomAttribute
+		return nil
+	}
+}
+
+type testAccGitlabGroupExpectedCustomAttributes struct {
+	Key   string
+	Value string
+}
+
+func testAccCheckGitlabGroupCustomAttributes(got *gitlab.CustomAttribute, want *testAccGitlabGroupExpectedCustomAttributes) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		if got.Key != want.Key {
+			return fmt.Errorf("got key %q; want %q", got.Key, want.Key)
+		}
+
+		if got.Value != want.Value {
+			return fmt.Errorf("got value %q; want %q", got.Value, want.Value)
+		}
+
+		return nil
+	}
+}