Merge pull request #389 from sirlatrom/fix-388

Support instance level CI variables

Author: nicholasklick

docs/resources/instance_variable.html.markdown

@@ -0,0 +1,46 @@
+---
+layout: "gitlab"
+page_title: "GitLab: gitlab_instance_variable"
+sidebar_current: "docs-gitlab-resource-instance-variable"
+description: |-
+  Creates and manages CI/CD variables for GitLab instances
+---
+
+# gitlab\_instance\_variable
+
+This resource allows you to create and manage CI/CD variables for your GitLab instance.
+For further information on variables, consult the [gitlab
+documentation](https://docs.gitlab.com/ee/api/instance_level_ci_variables.html).
+
+## Example Usage
+
+```hcl
+resource "gitlab_instance_variable" "example" {
+   key       = "instance_variable_key"
+   value     = "instance_variable_value"
+   protected = false
+   masked    = false
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `key` - (Required, string) The name of the variable.
+
+* `value` - (Required, string) The value of the variable.
+
+* `variable_type` - (Optional, string)  The type of a variable. Available types are: env_var (default) and file.
+
+* `protected` - (Optional, boolean) If set to `true`, the variable will be passed only to pipelines running on protected branches and tags. Defaults to `false`.
+
+* `masked` - (Optional, boolean) If set to `true`, the value of the variable will be hidden in job logs. The value must meet the [masking requirements](https://docs.gitlab.com/ee/ci/variables/#masked-variable-requirements). Defaults to `false`.
+
+## Import
+
+GitLab instance variables can be imported using an id made up of `variablename`, e.g.
+
+```console
+$ terraform import gitlab_instance_variable.example instance_variable_key
+```

gitlab/provider.go

@@ -94,6 +94,7 @@ func Provider() terraform.ResourceProvider {
 			"gitlab_project_mirror":             resourceGitlabProjectMirror(),
 			"gitlab_project_level_mr_approvals": resourceGitlabProjectLevelMRApprovals(),
 			"gitlab_project_approval_rule":      resourceGitlabProjectApprovalRule(),
+			"gitlab_instance_variable":          resourceGitlabInstanceVariable(),
 		},
 	}
 

gitlab/resource_gitlab_instance_variable.go

@@ -0,0 +1,137 @@
+package gitlab
+
+import (
+	"log"
+	"net/http"
+
+	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+	gitlab "github.com/xanzy/go-gitlab"
+)
+
+func resourceGitlabInstanceVariable() *schema.Resource {
+	return &schema.Resource{
+		Create: resourceGitlabInstanceVariableCreate,
+		Read:   resourceGitlabInstanceVariableRead,
+		Update: resourceGitlabInstanceVariableUpdate,
+		Delete: resourceGitlabInstanceVariableDelete,
+		Importer: &schema.ResourceImporter{
+			State: schema.ImportStatePassthrough,
+		},
+
+		Schema: map[string]*schema.Schema{
+			"key": {
+				Type:         schema.TypeString,
+				ForceNew:     true,
+				Required:     true,
+				ValidateFunc: StringIsGitlabVariableName,
+			},
+			"value": {
+				Type:      schema.TypeString,
+				Required:  true,
+				Sensitive: true,
+			},
+			"variable_type": {
+				Type:         schema.TypeString,
+				Optional:     true,
+				Default:      "env_var",
+				ValidateFunc: StringIsGitlabVariableType,
+			},
+			"protected": {
+				Type:     schema.TypeBool,
+				Optional: true,
+				Default:  false,
+			},
+			"masked": {
+				Type:     schema.TypeBool,
+				Optional: true,
+				Default:  false,
+			},
+		},
+	}
+}
+
+func resourceGitlabInstanceVariableCreate(d *schema.ResourceData, meta interface{}) error {
+	client := meta.(*gitlab.Client)
+
+	key := d.Get("key").(string)
+	value := d.Get("value").(string)
+	variableType := stringToVariableType(d.Get("variable_type").(string))
+	protected := d.Get("protected").(bool)
+	masked := d.Get("masked").(bool)
+
+	options := gitlab.CreateInstanceVariableOptions{
+		Key:          &key,
+		Value:        &value,
+		VariableType: variableType,
+		Protected:    &protected,
+		Masked:       &masked,
+	}
+	log.Printf("[DEBUG] create gitlab instance level CI variable %s", key)
+
+	_, _, err := client.InstanceVariables.CreateVariable(&options)
+	if err != nil {
+		return err
+	}
+
+	d.SetId(key)
+
+	return resourceGitlabInstanceVariableRead(d, meta)
+}
+
+func resourceGitlabInstanceVariableRead(d *schema.ResourceData, meta interface{}) error {
+	client := meta.(*gitlab.Client)
+
+	key := d.Id()
+
+	log.Printf("[DEBUG] read gitlab instance level CI variable %s", key)
+
+	v, resp, err := client.InstanceVariables.GetVariable(key)
+	if err != nil {
+		if resp.StatusCode == http.StatusNotFound {
+			log.Printf("[DEBUG] gitlab instance level CI variable for %s not found so removing from state", d.Id())
+			d.SetId("")
+			return nil
+		}
+		return err
+	}
+
+	d.Set("key", v.Key)
+	d.Set("value", v.Value)
+	d.Set("variable_type", v.VariableType)
+	d.Set("protected", v.Protected)
+	d.Set("masked", v.Masked)
+	return nil
+}
+
+func resourceGitlabInstanceVariableUpdate(d *schema.ResourceData, meta interface{}) error {
+	client := meta.(*gitlab.Client)
+
+	key := d.Get("key").(string)
+	value := d.Get("value").(string)
+	variableType := stringToVariableType(d.Get("variable_type").(string))
+	protected := d.Get("protected").(bool)
+	masked := d.Get("masked").(bool)
+
+	options := &gitlab.UpdateInstanceVariableOptions{
+		Value:        &value,
+		Protected:    &protected,
+		VariableType: variableType,
+		Masked:       &masked,
+	}
+	log.Printf("[DEBUG] update gitlab instance level CI variable %s", key)
+
+	_, _, err := client.InstanceVariables.UpdateVariable(key, options)
+	if err != nil {
+		return err
+	}
+	return resourceGitlabInstanceVariableRead(d, meta)
+}
+
+func resourceGitlabInstanceVariableDelete(d *schema.ResourceData, meta interface{}) error {
+	client := meta.(*gitlab.Client)
+	key := d.Get("key").(string)
+	log.Printf("[DEBUG] Delete gitlab instance level CI variable %s", key)
+
+	_, err := client.InstanceVariables.RemoveVariable(key)
+	return err
+}

gitlab/resource_gitlab_instance_variable_test.go

@@ -0,0 +1,131 @@
+package gitlab
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/helper/acctest"
+	"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
+	"github.com/hashicorp/terraform-plugin-sdk/terraform"
+	"github.com/xanzy/go-gitlab"
+)
+
+func TestAccGitlabInstanceVariable_basic(t *testing.T) {
+	var instanceVariable gitlab.InstanceVariable
+	rString := acctest.RandString(5)
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:  func() { testAccPreCheck(t) },
+		Providers: testAccProviders,
+		Steps: []resource.TestStep{
+			// Create a variable with default options
+			{
+				Config: testAccGitlabInstanceVariableConfig(rString),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckGitlabInstanceVariableExists("gitlab_instance_variable.foo", &instanceVariable),
+					testAccCheckGitlabInstanceVariableAttributes(&instanceVariable, &testAccGitlabInstanceVariableExpectedAttributes{
+						Key:   fmt.Sprintf("key_%s", rString),
+						Value: fmt.Sprintf("value-%s", rString),
+					}),
+				),
+			},
+			// Update the instance variable to toggle all the values to their inverse
+			{
+				Config: testAccGitlabInstanceVariableUpdateConfig(rString),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckGitlabInstanceVariableExists("gitlab_instance_variable.foo", &instanceVariable),
+					testAccCheckGitlabInstanceVariableAttributes(&instanceVariable, &testAccGitlabInstanceVariableExpectedAttributes{
+						Key:       fmt.Sprintf("key_%s", rString),
+						Value:     fmt.Sprintf("value-inverse-%s", rString),
+						Protected: true,
+					}),
+				),
+			},
+			// Update the instance variable to toggle the options back
+			{
+				Config: testAccGitlabInstanceVariableConfig(rString),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckGitlabInstanceVariableExists("gitlab_instance_variable.foo", &instanceVariable),
+					testAccCheckGitlabInstanceVariableAttributes(&instanceVariable, &testAccGitlabInstanceVariableExpectedAttributes{
+						Key:       fmt.Sprintf("key_%s", rString),
+						Value:     fmt.Sprintf("value-%s", rString),
+						Protected: false,
+					}),
+				),
+			},
+		},
+	})
+}
+
+func testAccCheckGitlabInstanceVariableExists(n string, instanceVariable *gitlab.InstanceVariable) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		rs, ok := s.RootModule().Resources[n]
+		if !ok {
+			return fmt.Errorf("Not Found: %s", n)
+		}
+
+		key := rs.Primary.Attributes["key"]
+		if key == "" {
+			return fmt.Errorf("No variable key is set")
+		}
+		conn := testAccProvider.Meta().(*gitlab.Client)
+
+		gotVariable, _, err := conn.InstanceVariables.GetVariable(key)
+		if err != nil {
+			return err
+		}
+		*instanceVariable = *gotVariable
+		return nil
+	}
+}
+
+type testAccGitlabInstanceVariableExpectedAttributes struct {
+	Key       string
+	Value     string
+	Protected bool
+	Masked    bool
+}
+
+func testAccCheckGitlabInstanceVariableAttributes(variable *gitlab.InstanceVariable, want *testAccGitlabInstanceVariableExpectedAttributes) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		if variable.Key != want.Key {
+			return fmt.Errorf("got key %s; want %s", variable.Key, want.Key)
+		}
+
+		if variable.Value != want.Value {
+			return fmt.Errorf("got value %s; value %s", variable.Value, want.Value)
+		}
+
+		if variable.Protected != want.Protected {
+			return fmt.Errorf("got protected %t; want %t", variable.Protected, want.Protected)
+		}
+
+		if variable.Masked != want.Masked {
+			return fmt.Errorf("got masked %t; want %t", variable.Masked, want.Masked)
+		}
+
+		return nil
+	}
+}
+
+func testAccGitlabInstanceVariableConfig(rString string) string {
+	return fmt.Sprintf(`
+resource "gitlab_instance_variable" "foo" {
+  key = "key_%s"
+  value = "value-%s"
+  variable_type = "file"
+  masked = false
+}
+	`, rString, rString)
+}
+
+func testAccGitlabInstanceVariableUpdateConfig(rString string) string {
+	return fmt.Sprintf(`
+resource "gitlab_instance_variable" "foo" {
+  key = "key_%s"
+  value = "value-inverse-%s"
+  protected = true
+  masked = false
+}
+	`, rString, rString)
+}