- Notifications
You must be signed in to change notification settings - Fork3
feat: addcoderd_provisioner_key resource#141
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
Show all changes
9 commits Select commitHold shift + click to select a range
416c80f starting
aslilac9fc4cb8 Merge branch 'main' into lilac/provisioner_key
aslilac2500b9c bad tests but passing :^)
aslilac26eab19 `AddError`
aslilaca139d31 beep boop
aslilacf920756 fill tags, check for replacement
aslilacb606af1 nevermind about pointers
aslilacadf93d5 docs
aslilacd307dff tweak descriptions
aslilacFile 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
29 changes: 29 additions & 0 deletionsdocs/resources/provisioner_key.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,29 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "coderd_provisioner_key Resource - terraform-provider-coderd" | ||
| subcategory: "" | ||
| description: |- | ||
| A provisioner key for a Coder deployment. | ||
| --- | ||
| # coderd_provisioner_key (Resource) | ||
| A provisioner key for a Coder deployment. | ||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
| ### Required | ||
| - `name` (String) The name of the key. | ||
| - `organization_id` (String) The organization that provisioners connected with this key will be connected to. | ||
| ### Optional | ||
| - `tags` (Map of String) The tags that provisioners connected with this key will accept jobs for. | ||
| ### Read-Only | ||
| - `key` (String, Sensitive) The acquired provisioner key |
6 changes: 3 additions & 3 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
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
154 changes: 154 additions & 0 deletionsinternal/provider/provisioner_key_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,154 @@ | ||
| 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/mapplanmodifier" | ||
| "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 = &ProvisionerKeyResource{} | ||
| func NewProvisionerKeyResource() resource.Resource { | ||
| return &ProvisionerKeyResource{} | ||
| } | ||
| // ProvisionerKeyResource defines the resource implementation. | ||
| type ProvisionerKeyResource struct { | ||
| *CoderdProviderData | ||
| } | ||
| // ProvisionerKeyResourceModel describes the resource data model. | ||
| type ProvisionerKeyResourceModel struct { | ||
| OrganizationID UUID `tfsdk:"organization_id"` | ||
| Name types.String `tfsdk:"name"` | ||
| Tags types.Map `tfsdk:"tags"` | ||
| Key types.String `tfsdk:"key"` | ||
| } | ||
| func (r *ProvisionerKeyResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) { | ||
| resp.TypeName = req.ProviderTypeName + "_provisioner_key" | ||
| } | ||
| func (r *ProvisionerKeyResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) { | ||
| resp.Schema = schema.Schema{ | ||
| MarkdownDescription: "A provisioner key for a Coder deployment.", | ||
| Attributes: map[string]schema.Attribute{ | ||
| "organization_id": schema.StringAttribute{ | ||
| CustomType: UUIDType, | ||
| MarkdownDescription: "The organization that provisioners connected with this key will be connected to.", | ||
| Required: true, | ||
| PlanModifiers: []planmodifier.String{ | ||
| stringplanmodifier.RequiresReplace(), | ||
| }, | ||
| }, | ||
| "name": schema.StringAttribute{ | ||
| MarkdownDescription: "The name of the key.", | ||
| Required: true, | ||
| PlanModifiers: []planmodifier.String{ | ||
| stringplanmodifier.RequiresReplace(), | ||
| }, | ||
| }, | ||
| "tags": schema.MapAttribute{ | ||
| MarkdownDescription: "The tags that provisioners connected with this key will accept jobs for.", | ||
| ElementType: types.StringType, | ||
| Optional: true, | ||
| PlanModifiers: []planmodifier.Map{ | ||
| mapplanmodifier.RequiresReplace(), | ||
| }, | ||
| }, | ||
| "key": schema.StringAttribute{ | ||
| MarkdownDescription: "The acquired provisioner key", | ||
| Computed: true, | ||
| Sensitive: true, | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
| func (r *ProvisionerKeyResource) 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.CoderdProviderData = data | ||
| } | ||
| func (r *ProvisionerKeyResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) { | ||
| // Read Terraform plan data into the model | ||
| var data ProvisionerKeyResourceModel | ||
| resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...) | ||
| if resp.Diagnostics.HasError() { | ||
| return | ||
| } | ||
| var tags map[string]string | ||
| resp.Diagnostics.Append(data.Tags.ElementsAs(ctx, &tags, false)...) | ||
| createKeyResult, err := r.Client.CreateProvisionerKey(ctx, data.OrganizationID.ValueUUID(), codersdk.CreateProvisionerKeyRequest{ | ||
| Name: data.Name.ValueString(), | ||
| Tags: tags, | ||
| }) | ||
| if err != nil { | ||
| resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to create provisioner_key, got error: %s", err)) | ||
| return | ||
| } | ||
| data.Key = types.StringValue(createKeyResult.Key) | ||
| // Save data into Terraform state | ||
| resp.Diagnostics.Append(resp.State.Set(ctx, &data)...) | ||
| } | ||
| func (r *ProvisionerKeyResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) { | ||
| // Read Terraform prior state data into the model | ||
| var data ProvisionerKeyResourceModel | ||
| resp.Diagnostics.Append(req.State.Get(ctx, &data)...) | ||
| if resp.Diagnostics.HasError() { | ||
| return | ||
| } | ||
| // Provisioner keys are immutable, no reading necessary. | ||
| // Save updated data into Terraform state | ||
| resp.Diagnostics.Append(resp.State.Set(ctx, &data)...) | ||
| } | ||
| func (r *ProvisionerKeyResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) { | ||
| // Provisioner keys are immutable, updating is always invalid. | ||
| resp.Diagnostics.AddError("Invalid Update", "Terraform is attempting to update a resource which must be replaced") | ||
| } | ||
| func (r *ProvisionerKeyResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) { | ||
| // Read Terraform prior state data into the model | ||
| var data ProvisionerKeyResourceModel | ||
| resp.Diagnostics.Append(req.State.Get(ctx, &data)...) | ||
| if resp.Diagnostics.HasError() { | ||
| return | ||
| } | ||
| err := r.Client.DeleteProvisionerKey(ctx, data.OrganizationID.ValueUUID(), data.Name.ValueString()) | ||
| if err != nil { | ||
| resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to delete provisionerkey, got error: %s", err)) | ||
| return | ||
| } | ||
| } |
114 changes: 114 additions & 0 deletionsinternal/provider/provisioner_key_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,114 @@ | ||
| package provider | ||
| import ( | ||
| "context" | ||
| "os" | ||
| "strings" | ||
| "testing" | ||
| "text/template" | ||
| "github.com/coder/terraform-provider-coderd/integration" | ||
| "github.com/google/uuid" | ||
| "github.com/hashicorp/terraform-plugin-testing/helper/resource" | ||
| "github.com/hashicorp/terraform-plugin-testing/knownvalue" | ||
| "github.com/hashicorp/terraform-plugin-testing/plancheck" | ||
| "github.com/hashicorp/terraform-plugin-testing/statecheck" | ||
| "github.com/hashicorp/terraform-plugin-testing/tfjsonpath" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
| func TestAccProvisionerKeyResource(t *testing.T) { | ||
| if os.Getenv("TF_ACC") == "" { | ||
| t.Skip("Acceptance tests are disabled.") | ||
| } | ||
| ctx := context.Background() | ||
| client := integration.StartCoder(ctx, t, "provisioner_key_acc", true) | ||
| orgs, err := client.Organizations(ctx) | ||
| require.NoError(t, err) | ||
| firstOrg := orgs[0].ID | ||
| cfg1 := testAccProvisionerKeyResourceConfig{ | ||
| URL: client.URL.String(), | ||
| Token: client.SessionToken(), | ||
| OrganizationID: firstOrg, | ||
| Name: "example-provisioner-key", | ||
| } | ||
| cfg2 := cfg1 | ||
| cfg2.Tags = map[string]string{ | ||
| "wibble": "wobble", | ||
| } | ||
| cfg3 := cfg2 | ||
| cfg3.Name = "different-provisioner-key" | ||
| resource.Test(t, resource.TestCase{ | ||
| IsUnitTest: true, | ||
| PreCheck: func() { testAccPreCheck(t) }, | ||
| ProtoV6ProviderFactories: testAccProtoV6ProviderFactories, | ||
| Steps: []resource.TestStep{ | ||
| { | ||
| Config: cfg1.String(t), | ||
| }, | ||
| { | ||
| Config: cfg2.String(t), | ||
| ConfigPlanChecks: resource.ConfigPlanChecks{ | ||
| PreApply: []plancheck.PlanCheck{ | ||
| plancheck.ExpectResourceAction("coderd_provisioner_key.test", plancheck.ResourceActionReplace), | ||
| }, | ||
| }, | ||
| ConfigStateChecks: []statecheck.StateCheck{ | ||
| statecheck.ExpectKnownValue("coderd_provisioner_key.test", tfjsonpath.New("tags").AtMapKey("wibble"), knownvalue.StringExact("wobble")), | ||
| }, | ||
| }, | ||
| { | ||
| Config: cfg3.String(t), | ||
| ConfigPlanChecks: resource.ConfigPlanChecks{ | ||
| PreApply: []plancheck.PlanCheck{ | ||
| plancheck.ExpectResourceAction("coderd_provisioner_key.test", plancheck.ResourceActionReplace), | ||
| }, | ||
| }, | ||
| }, | ||
aslilac marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| }, | ||
| }) | ||
| } | ||
| type testAccProvisionerKeyResourceConfig struct { | ||
| URL string | ||
| Token string | ||
| OrganizationID uuid.UUID | ||
| Name string | ||
| Tags map[string]string | ||
| } | ||
| func (c testAccProvisionerKeyResourceConfig) String(t *testing.T) string { | ||
| t.Helper() | ||
| tpl := ` | ||
| provider coderd { | ||
| url = "{{.URL}}" | ||
| token = "{{.Token}}" | ||
| } | ||
| resource "coderd_provisioner_key" "test" { | ||
| organization_id = "{{.OrganizationID}}" | ||
| name = "{{.Name}}" | ||
| tags = { | ||
| {{- range $key, $value := .Tags}} | ||
| {{$key}} = "{{$value}}" | ||
| {{- end}} | ||
| } | ||
| } | ||
| ` | ||
| buf := strings.Builder{} | ||
| tmpl, err := template.New("provisionerKeyResource").Parse(tpl) | ||
| require.NoError(t, err) | ||
| err = tmpl.Execute(&buf, c) | ||
| require.NoError(t, err) | ||
| return buf.String() | ||
| } | ||
6 changes: 3 additions & 3 deletionsinternal/provider/template_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
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.