resource_variable.go

package octopusdeploy

import (
	"context"
	"fmt"
	"log"
	"strings"
	"sync"

	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
)

var mutex = &sync.Mutex{}

func resourceVariable() *schema.Resource {
	return &schema.Resource{
		CreateContext: resourceVariableCreate,
		DeleteContext: resourceVariableDelete,
		Description:   "This resource manages variables in Octopus Deploy.",
		Importer:      &schema.ResourceImporter{State: resourceVariableImport},
		ReadContext:   resourceVariableRead,
		Schema:        getVariableSchema(),
		UpdateContext: resourceVariableUpdate,
	}
}

func resourceVariableImport(d *schema.ResourceData, m interface{}) ([]*schema.ResourceData, error) {
	log.Printf("[INFO] importing variable (%s)", d.Id())

	importStrings := strings.Split(d.Id(), ":")
	if len(importStrings) != 2 {
		return nil, fmt.Errorf("octopusdeploy_variable import must be in the form of OwnerID:VariableID (e.g. Projects-62:0906031f-68ba-4a15-afaa-657c1564e07b")
	}

	d.Set("owner_id", importStrings[0])
	d.SetId(importStrings[1])

	return []*schema.ResourceData{d}, nil
}

func resourceVariableCreate(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
	mutex.Lock()
	defer mutex.Unlock()

	if err := validateVariable(d); err != nil {
		return diag.FromErr(err)
	}

	projectID, projectOk := d.GetOk("project_id")
	ownerID, ownerOk := d.GetOk("owner_id")

	if !projectOk && !ownerOk {
		return diag.Errorf("one of project_id or owner_id must be configured")
	}

	var variableOwnerID string

	if projectOk {
		variableOwnerID = projectID.(string)
	} else {
		variableOwnerID = ownerID.(string)
	}

	variable := expandVariable(d)

	log.Printf("[INFO] creating variable: %#v", variable)

	client := m.(*octopusdeploy.Client)
	variableSet, err := client.Variables.AddSingle(variableOwnerID, variable)
	if err != nil {
		return diag.FromErr(err)
	}

	for _, v := range variableSet.Variables {
		if v.Name == variable.Name && v.Type == variable.Type && (v.IsSensitive || v.Value == variable.Value) && v.Description == variable.Description && v.IsSensitive == variable.IsSensitive {
			scopeMatches, _, err := client.Variables.MatchesScope(v.Scope, &variable.Scope)
			if err != nil {
				return diag.FromErr(err)
			}
			if scopeMatches {
				d.SetId(v.ID)
				log.Printf("[INFO] variable created (%s)", d.Id())
				return nil
			}
		}
	}

	d.SetId("")
	return diag.Errorf("unable to locate variable for owner ID, %s", variableOwnerID)
}

func resourceVariableRead(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
	log.Printf("[INFO] reading variable (%s)", d.Id())

	id := d.Id()

	projectID, projectOk := d.GetOk("project_id")
	ownerID, ownerOk := d.GetOk("owner_id")

	if !projectOk && !ownerOk {
		return diag.Errorf("one of project_id or owner_id must be configured")
	}

	var variableOwnerID string

	if projectOk {
		variableOwnerID = projectID.(string)
	} else {
		variableOwnerID = ownerID.(string)
	}

	client := m.(*octopusdeploy.Client)
	variable, err := client.Variables.GetByID(variableOwnerID, id)
	if err != nil {
		if apiError, ok := err.(*octopusdeploy.APIError); ok {
			if apiError.StatusCode == 404 {
				log.Printf("[INFO] variable (%s) not found; deleting from state", d.Id())
				d.SetId("")
				return nil
			}
		}
		return diag.FromErr(err)
	}

	if err := setVariable(ctx, d, variable); err != nil {
		return diag.FromErr(err)
	}

	log.Printf("[INFO] variable read (%s)", d.Id())
	return nil
}

func resourceVariableUpdate(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
	mutex.Lock()
	defer mutex.Unlock()

	log.Printf("[INFO] updating variable (%s)", d.Id())

	if err := validateVariable(d); err != nil {
		return diag.FromErr(err)
	}

	variable := expandVariable(d)

	projectID, projectOk := d.GetOk("project_id")
	ownerID, ownerOk := d.GetOk("owner_id")

	if !projectOk && !ownerOk {
		return diag.Errorf("one of project_id or owner_id must be configured")
	}

	var variableOwnerID string

	if projectOk {
		variableOwnerID = projectID.(string)
	} else {
		variableOwnerID = ownerID.(string)
	}

	client := m.(*octopusdeploy.Client)
	variableSet, err := client.Variables.UpdateSingle(variableOwnerID, variable)
	if err != nil {
		return diag.FromErr(err)
	}

	for _, v := range variableSet.Variables {
		if v.Name == variable.Name && v.Type == variable.Type && (v.IsSensitive || v.Value == variable.Value) && v.Description == variable.Description && v.IsSensitive == variable.IsSensitive {
			scopeMatches, _, _ := client.Variables.MatchesScope(v.Scope, &variable.Scope)
			if scopeMatches {
				if err := setVariable(ctx, d, v); err != nil {
					return diag.FromErr(err)
				}
				log.Printf("[INFO] variable updated (%s)", d.Id())
				return nil
			}
		}
	}

	d.SetId("")
	return diag.Errorf("unable to locate variable for owner ID, %s", variableOwnerID)
}

func resourceVariableDelete(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
	mutex.Lock()
	defer mutex.Unlock()

	log.Printf("[INFO] deleting variable (%s)", d.Id())

	projectID, projectOk := d.GetOk("project_id")
	ownerID, ownerOk := d.GetOk("owner_id")

	if !projectOk && !ownerOk {
		return diag.Errorf("one of project_id or owner_id must be configured")
	}

	var variableOwnerID string

	if projectOk {
		variableOwnerID = projectID.(string)
	} else {
		variableOwnerID = ownerID.(string)
	}

	client := m.(*octopusdeploy.Client)
	_, err := client.Variables.DeleteSingle(variableOwnerID, d.Id())
	if err != nil {
		if apiError, ok := err.(*octopusdeploy.APIError); ok {
			if apiError.StatusCode == 404 {
				log.Printf("[INFO] variable (%s) not found; deleting from state", d.Id())
				d.SetId("")
				return nil
			}
		}
		return diag.FromErr(err)
	}

	log.Printf("[INFO] variable deleted (%s)", d.Id())
	d.SetId("")
	return nil
}

// Validating is done in its own function as we need to compare options once the entire
// schema has been parsed, which as far as I can tell we can't do in a normal validation
// function.
func validateVariable(d *schema.ResourceData) error {
	tfSensitive := d.Get("is_sensitive").(bool)
	tfType := d.Get("type").(string)

	if tfSensitive && tfType != "Sensitive" {
		return fmt.Errorf("when is_sensitive is set to true, type needs to be 'Sensitive'")
	}

	if !tfSensitive && tfType == "Sensitive" {
		return fmt.Errorf("when type is set to 'Sensitive', is_sensitive needs to be true")
	}

	return nil
}