SUP-1085: Cluster Queue resource implementation

CHANGELOG.md

@@ -3,8 +3,9 @@
 All notable changes to this project will be documented in this file.
 
 ## Unreleased
-* Support option to archive on delete [[PR #296](https://github.com/buildkite/terraform-provider-buildkite/pull/296)]
-* SUP-270 Fix branch_configuration updating to empty string [[PR #298](https://github.com/buildkite/terraform-provider-buildkite/pull/298)]
+* Support option to archive on delete [[PR #296](https://github.com/buildkite/terraform-provider-buildkite/pull/296)] @mcncl
+* SUP-1085: Cluster Queue resource implementation [[PR #297](https://github.com/buildkite/terraform-provider-buildkite/pull/297)] @james2791
+* SUP-270 Fix branch_configuration updating to empty string [[PR #298](https://github.com/buildkite/terraform-provider-buildkite/pull/298)] @jradtilbrook
 
 ## [v0.19.2](https://github.com/buildkite/terraform-provider-buildkite/compare/v0.19.1...v0.19.2)
 * Consistent naming for environment variables [[PR #290](https://github.com/buildkite/terraform-provider-buildkite/pull/290)] @mcncl

buildkite/graphql/cluster_queue.graphql

@@ -0,0 +1,79 @@
+fragment ClusterQueueValues on ClusterQueue {
+    id
+    uuid
+    key
+    # @genqlient(pointer: true)
+    description             
+    cluster {
+        id
+        uuid
+    }
+}
+
+query getClusterQueues($orgSlug: ID!, $id: ID!) {
+    organization(slug: $orgSlug) {
+        cluster(id: $id) {
+            queues(first: 50) {
+                edges {
+                    node {
+                        ...ClusterQueueValues
+                    }
+                }
+            }
+        }
+    }
+}
+
+mutation createClusterQueue(
+    $organizationId: ID!, 
+    $clusterId: ID!,
+    $key: String!,
+    # @genqlient(pointer: true)
+    $description: String
+) {
+    clusterQueueCreate(
+        input: {
+            organizationId: $organizationId
+            clusterId: $clusterId,
+            key: $key
+            description: $description
+        }
+    ) {
+        clusterQueue {
+            ...ClusterQueueValues
+        }
+    }
+}
+
+mutation updateClusterQueue(
+    $organizationId: ID!, 
+    $id: ID!,
+    # @genqlient(pointer: true)
+    $description: String
+) {
+    clusterQueueUpdate(
+        input: {
+            organizationId: $organizationId
+            id: $id
+            description: $description
+        }
+    ) {
+        clusterQueue {
+            ...ClusterQueueValues
+        }
+    }
+}
+
+mutation deleteClusterQueue(
+    $organizationId: ID!, 
+    $id: ID!,
+){
+    clusterQueueDelete(
+        input: {
+            organizationId: $organizationId
+            id: $id
+        }
+    ) {
+        clientMutationId
+    }
+}

buildkite/provider.go

@@ -92,6 +92,7 @@ func (tf *terraformProvider) Metadata(ctx context.Context, req provider.Metadata
 func (*terraformProvider) Resources(context.Context) []func() resource.Resource {
 	return []func() resource.Resource{
 		NewAgentTokenResource,
+		NewClusterQueueResource,
 	}
 }
 

buildkite/resource_cluster_queue.go

@@ -0,0 +1,242 @@
+package buildkite
+
+import (
+	"context"
+	"fmt"
+	"log"
+	"strings"
+
+	"github.com/hashicorp/terraform-plugin-framework/path"
+	"github.com/hashicorp/terraform-plugin-framework/resource"
+	resource_schema "github.com/hashicorp/terraform-plugin-framework/resource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+)
+
+type ClusterQueueResourceModel struct {
+	Id          types.String `tfsdk:"id"`
+	Uuid        types.String `tfsdk:"uuid"`
+	ClusterId   types.String `tfsdk:"cluster_id"`
+	ClusterUuid types.String `tfsdk:"cluster_uuid"`
+	Key         types.String `tfsdk:"key"`
+	Description types.String `tfsdk:"description"`
+}
+
+type ClusterQueueResource struct {
+	client *Client
+}
+
+func NewClusterQueueResource() resource.Resource {
+	return &ClusterQueueResource{}
+}
+
+func (ClusterQueueResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
+	resp.TypeName = req.ProviderTypeName + "_cluster_queue"
+}
+
+func (cq *ClusterQueueResource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) {
+	if req.ProviderData == nil {
+		return
+	}
+
+	cq.client = req.ProviderData.(*Client)
+}
+
+func (ClusterQueueResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
+	resp.Schema = resource_schema.Schema{
+		MarkdownDescription: "A Cluster Queue is a queue belonging to a specific Cluster for its Agents to target builds on. ",
+		Attributes: map[string]resource_schema.Attribute{
+			"id": resource_schema.StringAttribute{
+				Computed: true,
+				PlanModifiers: []planmodifier.String{
+					stringplanmodifier.UseStateForUnknown(),
+				},
+			},
+			"uuid": resource_schema.StringAttribute{
+				Computed: true,
+				PlanModifiers: []planmodifier.String{
+					stringplanmodifier.UseStateForUnknown(),
+				},
+			},
+			"cluster_uuid": resource_schema.StringAttribute{
+				Computed: true,
+				PlanModifiers: []planmodifier.String{
+					stringplanmodifier.UseStateForUnknown(),
+				},
+			},
+			"cluster_id": resource_schema.StringAttribute{
+				Required:            true,
+				MarkdownDescription: "The ID of the Cluster that this Cluster Queue belongs to.",
+			},
+			"key": resource_schema.StringAttribute{
+				Required:            true,
+				MarkdownDescription: "The key of the Cluster Queue.",
+			},
+			"description": resource_schema.StringAttribute{
+				Optional:            true,
+				MarkdownDescription: "A description for the Cluster Queue. ",
+			},
+		},
+	}
+}
+
+func (cq *ClusterQueueResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
+	var plan, state ClusterQueueResourceModel
+
+	resp.Diagnostics.Append(req.Plan.Get(ctx, &plan)...)
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	log.Printf("Creating cluster queue with key %s into cluster %s ...", plan.Key.ValueString(), plan.ClusterId.ValueString())
+	apiResponse, err := createClusterQueue(
+		cq.client.genqlient,
+		cq.client.organizationId,
+		plan.ClusterId.ValueString(),
+		plan.Key.ValueString(),
+		plan.Description.ValueStringPointer(),
+	)
+
+	if err != nil {
+		resp.Diagnostics.AddError(
+			"Unable to create Cluster Queue",
+			fmt.Sprintf("Unable to create Cluster Queue: %s", err.Error()),
+		)
+		return
+	}
+
+	state.Id = types.StringValue(apiResponse.ClusterQueueCreate.ClusterQueue.Id)
+	state.Uuid = types.StringValue(apiResponse.ClusterQueueCreate.ClusterQueue.Uuid)
+	state.ClusterId = plan.ClusterId
+	state.ClusterUuid = types.StringValue(apiResponse.ClusterQueueCreate.ClusterQueue.Cluster.Uuid)
+	state.Key = types.StringValue(apiResponse.ClusterQueueCreate.ClusterQueue.Key)
+	state.Description = types.StringPointerValue(apiResponse.ClusterQueueCreate.ClusterQueue.Description)
+
+	resp.Diagnostics.Append(resp.State.Set(ctx, &state)...)
+}
+
+func (cq *ClusterQueueResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
+	var state ClusterQueueResourceModel
+
+	resp.Diagnostics.Append(req.State.Get(ctx, &state)...)
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	log.Printf("Getting cluster queues for cluster %s ...", state.ClusterUuid.ValueString())
+	queues, err := getClusterQueues(cq.client.genqlient, cq.client.organization, state.ClusterUuid.ValueString())
+
+	if err != nil {
+		resp.Diagnostics.AddError(
+			"Unable to read Cluster Queues",
+			fmt.Sprintf("Unable to read Cluster Queues: %s", err.Error()),
+		)
+		return
+	}
+
+	// Find the cluster queue from the returned queues to update state
+	for _, edge := range queues.Organization.Cluster.Queues.Edges {
+		if edge.Node.Id == state.Id.ValueString() {
+			log.Printf("Found cluster queue with ID %s in cluster %s", edge.Node.Id, state.ClusterUuid.ValueString())
+			// Update ClusterQueueResourceModel with Node values and append
+			updateClusterQueueResource(edge.Node, &state)
+			resp.Diagnostics.Append(resp.State.Set(ctx, &state)...)
+			return
+		}
+	}
+
+	// If not returned by this point, the cluster queue could not be found
+	// This is a tradeoff of the current getClusterQueues Genqlient query (searches for 50 queues via the cluster UUID in state)
+	resp.Diagnostics.AddError(
+		"Unable to find Cluster Queue",
+		fmt.Sprintf("Unable to find Cluster Queue: %s", err.Error()),
+	)
+	return
+}
+
+func (cq *ClusterQueueResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse) {
+	importComponents := strings.Split(req.ID, ",")
+
+	if len(importComponents) != 2 || importComponents[0] == "" || importComponents[1] == "" {
+		resp.Diagnostics.AddError(
+			"Unexpected Import Identifier",
+			fmt.Sprintf("Expected import identifier with format: id,cluster_uuid. Got: %q", req.ID),
+		)
+		return
+	}
+
+	// Adding the cluster queue ID/cluster UUID to state for Read
+	log.Printf("Importing cluster queue %s ...", importComponents[0])
+	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("id"), importComponents[0])...)
+	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("cluster_uuid"), importComponents[1])...)
+}
+
+func (cq *ClusterQueueResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
+	var state ClusterQueueResourceModel
+	var description string
+
+	//Load state and ontain description from plan (singularly)
+	resp.Diagnostics.Append(req.State.Get(ctx, &state)...)
+	resp.Diagnostics.Append(req.Plan.GetAttribute(ctx, path.Root("description"), &description)...)
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	log.Printf("Updating cluster queue %s ...", state.Id.ValueString())
+	apiResponse, err := updateClusterQueue(
+		cq.client.genqlient,
+		cq.client.organizationId,
+		state.Id.ValueString(),
+		&description,
+	)
+
+	if err != nil {
+		resp.Diagnostics.AddError(
+			"Unable to update Cluster Queue",
+			fmt.Sprintf("Unable to update Cluster Queue: %s", err.Error()),
+		)
+		return
+	}
+
+	state.Description = types.StringPointerValue(apiResponse.ClusterQueueUpdate.ClusterQueue.Description)
+
+	resp.Diagnostics.Append(resp.State.Set(ctx, &state)...)
+}
+
+func (cq *ClusterQueueResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) {
+	var plan ClusterQueueResourceModel
+
+	resp.Diagnostics.Append(req.State.Get(ctx, &plan)...)
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	log.Printf("Deleting cluster queue %s ...", plan.Id.ValueString())
+	_, err := deleteClusterQueue(
+		cq.client.genqlient,
+		cq.client.organizationId,
+		plan.Id.ValueString(),
+	)
+
+	if err != nil {
+		resp.Diagnostics.AddError(
+			"Unable to create Cluster Queue",
+			fmt.Sprintf("Unable to delete Cluster Queue: %s", err.Error()),
+		)
+		return
+	}
+}
+
+func updateClusterQueueResource(clusterQueueNode getClusterQueuesOrganizationClusterQueuesClusterQueueConnectionEdgesClusterQueueEdgeNodeClusterQueue, cq *ClusterQueueResourceModel) {
+	cq.Id = types.StringValue(clusterQueueNode.Id)
+	cq.Uuid = types.StringValue(clusterQueueNode.Uuid)
+	cq.Key = types.StringValue(clusterQueueNode.Key)
+	cq.Description = types.StringPointerValue(clusterQueueNode.Description)
+	cq.ClusterId = types.StringValue(clusterQueueNode.Cluster.Id)
+	cq.ClusterUuid = types.StringValue(clusterQueueNode.Cluster.Uuid)
+}