feat: add license resource

ethanndickson · ethanndickson · commit a69c40e4305e · 2024-09-16T06:31:00.000Z
diff --git a/internal/provider/license_resource.go b/internal/provider/license_resource.go
@@ -0,0 +1,194 @@
+package provider
+
+import (
+	"context"
+	"fmt"
+	"time"
+
+	"github.com/coder/coder/v2/codersdk"
+	"github.com/hashicorp/terraform-plugin-framework/resource"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/int32planmodifier"
+	"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"
+)
+
+// Ensure provider defined types fully satisfy framework interfaces.
+var _ resource.Resource = &LicenseResource{}
+
+func NewLicenseResource() resource.Resource {
+	return &LicenseResource{}
+}
+
+// LicenseResource defines the resource implementation.
+type LicenseResource struct {
+	data *CoderdProviderData
+}
+
+// LicenseResourceModel describes the resource data model.
+type LicenseResourceModel struct {
+	ID        types.Int32  `tfsdk:"id"`
+	ExpiresAt types.Int64  `tfsdk:"expires_at"`
+	License   types.String `tfsdk:"license"`
+}
+
+func (r *LicenseResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
+	resp.TypeName = req.ProviderTypeName + "_license"
+}
+
+func (r *LicenseResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
+	resp.Schema = schema.Schema{
+		MarkdownDescription: "A license for a Coder deployment.\n\nTerraform does not guarantee this resource" +
+			"will be created before other resources or attributes that require a licensed deployment. " +
+			"It is instead recommended to use the `depends_on` meta-argument.",
+
+		Attributes: map[string]schema.Attribute{
+			"id": schema.Int32Attribute{
+				MarkdownDescription: "Integer ID of the license.",
+				Computed:            true,
+				PlanModifiers: []planmodifier.Int32{
+					int32planmodifier.UseStateForUnknown(),
+				},
+			},
+			"expires_at": schema.Int64Attribute{
+				MarkdownDescription: "Unix timestamp of when the license expires.",
+				Computed:            true,
+			},
+			"license": schema.StringAttribute{
+				MarkdownDescription: "A license key for Coder.",
+				Required:            true,
+				Sensitive:           true,
+				PlanModifiers: []planmodifier.String{
+					stringplanmodifier.RequiresReplace(),
+				},
+			},
+		},
+	}
+}
+
+func (r *LicenseResource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) {
+	// Prevent panic if the provider has not been configured.
+	if req.ProviderData == nil {
+		return
+	}
+
+	data, ok := req.ProviderData.(*CoderdProviderData)
+
+	if !ok {
+		resp.Diagnostics.AddError(
+			"Unexpected Resource Configure Type",
+			fmt.Sprintf("Expected *CoderdProviderData, got: %T. Please report this issue to the provider developers.", req.ProviderData),
+		)
+
+		return
+	}
+
+	r.data = data
+}
+
+func (r *LicenseResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
+	var data LicenseResourceModel
+
+	// Read Terraform plan data into the model
+	resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...)
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	client := r.data.Client
+
+	license, err := client.AddLicense(ctx, codersdk.AddLicenseRequest{
+		License: data.License.ValueString(),
+	})
+	if err != nil {
+		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to add license, got error: %s", err))
+		return
+	}
+	data.ID = types.Int32Value(license.ID)
+	expiresAt, err := license.ExpiresAt()
+	if err != nil {
+		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to parse license expiration, got error: %s", err))
+		return
+	}
+	data.ExpiresAt = types.Int64Value(expiresAt.Unix())
+
+	// Save data into Terraform state
+	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
+}
+
+func (r *LicenseResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
+	var data LicenseResourceModel
+
+	// Read Terraform prior state data into the model
+	resp.Diagnostics.Append(req.State.Get(ctx, &data)...)
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	licenses, err := r.data.Client.Licenses(ctx)
+	if err != nil {
+		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to list licenses, got error: %s", err))
+		return
+	}
+
+	found := false
+	for _, license := range licenses {
+		if license.ID == data.ID.ValueInt32() {
+			found = true
+			expiresAt, err := license.ExpiresAt()
+			if err != nil {
+				resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to parse license expiration, got error: %s", err))
+				return
+			}
+			if expiresAt.Before(time.Now()) {
+				resp.Diagnostics.AddError("Client Error", "License has expired.")
+				return
+			}
+			data.ExpiresAt = types.Int64Value(expiresAt.Unix())
+		}
+	}
+	if !found {
+		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("License with ID %d not found", data.ID.ValueInt32()))
+	}
+
+	// Save updated data into Terraform state
+	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
+}
+
+func (r *LicenseResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
+	var data LicenseResourceModel
+
+	// Read Terraform plan data into the model
+	resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...)
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	// Update is handled by replacement
+
+	// Save updated data into Terraform state
+	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
+}
+
+func (r *LicenseResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) {
+	var data LicenseResourceModel
+
+	// Read Terraform prior state data into the model
+	resp.Diagnostics.Append(req.State.Get(ctx, &data)...)
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	client := r.data.Client
+
+	err := client.DeleteLicense(ctx, data.ID.ValueInt32())
+	if err != nil {
+		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to delete license, got error: %s", err))
+		return
+	}
+}
diff --git a/internal/provider/license_resource_test.go b/internal/provider/license_resource_test.go
@@ -0,0 +1,74 @@
+package provider
+
+import (
+	"context"
+	"os"
+	"strings"
+	"testing"
+	"text/template"
+
+	"github.com/coder/terraform-provider-coderd/integration"
+	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+	"github.com/stretchr/testify/require"
+)
+
+func TestAccLicenseResource(t *testing.T) {
+	if os.Getenv("TF_ACC") == "" {
+		t.Skip("Acceptance tests are disabled.")
+	}
+	ctx := context.Background()
+	client := integration.StartCoder(ctx, t, "license_acc", false)
+
+	license := os.Getenv("CODER_ENTERPRISE_LICENSE")
+	if license == "" {
+		t.Skip("No license found for license resource tests, skipping")
+	}
+
+	cfg1 := testAccLicenseResourceconfig{
+		URL:     client.URL.String(),
+		Token:   client.SessionToken(),
+		License: license,
+	}
+
+	resource.Test(t, resource.TestCase{
+		IsUnitTest:               true,
+		PreCheck:                 func() { testAccPreCheck(t) },
+		ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
+		Steps: []resource.TestStep{
+			{
+				Config: cfg1.String(t),
+			},
+		},
+	})
+}
+
+type testAccLicenseResourceconfig struct {
+	URL     string
+	Token   string
+	License string
+}
+
+func (c testAccLicenseResourceconfig) String(t *testing.T) string {
+	t.Helper()
+	tpl := `
+provider coderd {
+	url   = "{{.URL}}"
+	token = "{{.Token}}"
+}
+
+resource "coderd_license" "test" {
+	license              = "{{.License}}"
+}
+`
+	funcMap := template.FuncMap{
+		"orNull": PrintOrNull,
+	}
+
+	buf := strings.Builder{}
+	tmpl, err := template.New("licenseResource").Funcs(funcMap).Parse(tpl)
+	require.NoError(t, err)
+
+	err = tmpl.Execute(&buf, c)
+	require.NoError(t, err)
+	return buf.String()
+}
diff --git a/internal/provider/provider.go b/internal/provider/provider.go
@@ -138,6 +138,7 @@ func (p *CoderdProvider) Resources(ctx context.Context) []func() resource.Resour
 		NewGroupResource,
 		NewTemplateResource,
 		NewWorkspaceProxyResource,
+		NewLicenseResource,
 	}
 }
 

Original file line number	Diff line number	Diff line change
`@@ -138,6 +138,7 @@ func (p *CoderdProvider) Resources(ctx context.Context) []func() resource.Resour`
`138`	`138`	`NewGroupResource,`
`139`	`139`	`NewTemplateResource,`
`140`	`140`	`NewWorkspaceProxyResource,`
	`141`	`+ NewLicenseResource,`
`141`	`142`	`}`
`142`	`143`	`}`
`143`	`144`