- Notifications
You must be signed in to change notification settings - Fork3
feat: add license resource#99
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
31 changes: 31 additions & 0 deletionsdocs/resources/license.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "coderd_license Resource - terraform-provider-coderd" | ||
| subcategory: "" | ||
| description: |- | ||
| A license for a Coder deployment. | ||
| It's recommended to create multiple instances of this resource when updating a license. Modifying an existing license will cause the resource to be replaced, which may result in a brief unlicensed period. | ||
| Terraform does not guarantee this resource will be created before other resources or attributes that require a licensed deployment. The depends_on meta-argument is instead recommended. | ||
| --- | ||
| # coderd_license (Resource) | ||
| A license for a Coder deployment. | ||
| It's recommended to create multiple instances of this resource when updating a license. Modifying an existing license will cause the resource to be replaced, which may result in a brief unlicensed period. | ||
| Terraform does not guarantee this resource will be created before other resources or attributes that require a licensed deployment. The `depends_on` meta-argument is instead recommended. | ||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
| ### Required | ||
| - `license` (String, Sensitive) A license key for Coder. | ||
| ### Read-Only | ||
| - `expires_at` (Number) Unix timestamp of when the license expires. | ||
| - `id` (Number) Integer ID of the license. |
193 changes: 193 additions & 0 deletionsinternal/provider/license_resource.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| package provider | ||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "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" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| ) | ||
| // 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\nIt's recommended to create multiple instances of this " + | ||
| "resource when updating a license. Modifying an existing license will cause the resource to be replaced, " + | ||
| "which may result in a brief unlicensed period.\n\n" + | ||
| "Terraform does not guarantee this resource " + | ||
| "will be created before other resources or attributes that require a licensed deployment. " + | ||
| "The `depends_on` meta-argument is instead recommended.", | ||
| 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 | ||
| } | ||
| 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 | ||
| } | ||
| } |
74 changes: 74 additions & 0 deletionsinternal/provider/license_resource_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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() | ||
| } |
1 change: 1 addition & 0 deletionsinternal/provider/provider.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.