-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: setup initial plugin framework skaffolding (#749)
Related to #752 Co-authored-by: jo <[email protected]>
- Loading branch information
Showing
59 changed files
with
853 additions
and
426 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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,162 @@ | ||
| package hcloud | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "os" | ||
| "time" | ||
|
|
||
| "github.com/hashicorp/go-hclog" | ||
| "github.com/hashicorp/terraform-plugin-framework/datasource" | ||
| "github.com/hashicorp/terraform-plugin-framework/path" | ||
| "github.com/hashicorp/terraform-plugin-framework/provider" | ||
| "github.com/hashicorp/terraform-plugin-framework/provider/schema" | ||
| "github.com/hashicorp/terraform-plugin-framework/resource" | ||
| "github.com/hashicorp/terraform-plugin-framework/types" | ||
| "github.com/hashicorp/terraform-plugin-log/tflog" | ||
| "github.com/hetznercloud/hcloud-go/hcloud" | ||
| "github.com/hetznercloud/terraform-provider-hcloud/internal/util/tflogutil" | ||
| ) | ||
|
|
||
| type PluginProvider struct{} | ||
|
|
||
| var _ provider.Provider = &PluginProvider{} | ||
|
|
||
| func NewPluginProvider() provider.Provider { | ||
| return &PluginProvider{} | ||
| } | ||
|
|
||
| // Metadata should return the metadata for the provider, such as | ||
| // a type name and version data. | ||
| // | ||
| // Implementing the MetadataResponse.TypeName will populate the | ||
| // datasource.MetadataRequest.ProviderTypeName and | ||
| // resource.MetadataRequest.ProviderTypeName fields automatically. | ||
| func (p *PluginProvider) Metadata(_ context.Context, _ provider.MetadataRequest, resp *provider.MetadataResponse) { | ||
| resp.TypeName = "hcloud" | ||
| resp.Version = Version | ||
| } | ||
|
|
||
| // Schema should return the schema for this provider. | ||
| func (p *PluginProvider) Schema(_ context.Context, _ provider.SchemaRequest, resp *provider.SchemaResponse) { | ||
| resp.Schema = schema.Schema{ | ||
| Attributes: map[string]schema.Attribute{ | ||
| "token": schema.StringAttribute{ | ||
| Description: "The Hetzner Cloud API token, can also be specified with the HCLOUD_TOKEN environment variable.", | ||
| Optional: true, | ||
| Sensitive: true, | ||
| }, | ||
| "endpoint": schema.StringAttribute{ | ||
| Description: "The Hetzner Cloud API endpoint, can be used to override the default API Endpoint https://api.hetzner.cloud/v1.", | ||
| Optional: true, | ||
| }, | ||
| "poll_interval": schema.StringAttribute{ | ||
| Description: "The interval at which actions are polled by the client. Default `500ms`. Increase this interval if you run into rate limiting errors.", | ||
| Optional: true, | ||
| }, | ||
| }, | ||
| // TODO: Uncomment once we get rid of the SDK v2 Provider | ||
| // MarkdownDescription: `The Hetzner Cloud (hcloud) provider is used to interact with the resources supported by | ||
| // [Hetzner Cloud](https://www.hetzner.com/cloud). The provider needs to be configured with the proper credentials | ||
| // before it can be used.`, | ||
| } | ||
| } | ||
|
|
||
| // PluginProviderModel describes the provider data model. | ||
| type PluginProviderModel struct { | ||
| Token types.String `tfsdk:"token"` | ||
| Endpoint types.String `tfsdk:"endpoint"` | ||
| PollInterval types.String `tfsdk:"poll_interval"` | ||
| } | ||
|
|
||
| // Configure is called at the beginning of the provider lifecycle, when | ||
| // Terraform sends to the provider the values the user specified in the | ||
| // provider configuration block. These are supplied in the | ||
| // ConfigureProviderRequest argument. | ||
| // Values from provider configuration are often used to initialize an | ||
| // API client, which should be stored on the struct to initialize an | ||
| // Provider interface. | ||
| func (p *PluginProvider) Configure(ctx context.Context, req provider.ConfigureRequest, resp *provider.ConfigureResponse) { | ||
| var data PluginProviderModel | ||
|
|
||
| resp.Diagnostics.Append(req.Config.Get(ctx, &data)...) | ||
| if resp.Diagnostics.HasError() { | ||
| return | ||
| } | ||
|
|
||
| opts := []hcloud.ClientOption{ | ||
| hcloud.WithApplication("hcloud-terraform", Version), | ||
| } | ||
|
|
||
| endpoint := os.Getenv("HCLOUD_ENDPOINT") | ||
| if data.Endpoint.ValueString() != "" { | ||
| endpoint = data.Endpoint.ValueString() | ||
| } | ||
| if endpoint != "" { | ||
| opts = append(opts, hcloud.WithEndpoint(endpoint)) | ||
| } | ||
|
|
||
| token := os.Getenv("HCLOUD_TOKEN") | ||
| if data.Token.ValueString() != "" { | ||
| token = data.Token.ValueString() | ||
| } | ||
| if token != "" { | ||
| opts = append(opts, hcloud.WithToken(token)) | ||
| } else { | ||
| resp.Diagnostics.AddAttributeError( | ||
| path.Root("token"), | ||
| "Missing Hetzner Cloud API token", | ||
| "While configuring the provider, the Hetzner Cloud API token was not found in the HCLOUD_TOKEN environment variable or provider configuration block token attribute.", | ||
| ) | ||
| } | ||
|
|
||
| if data.PollInterval.ValueString() != "" { | ||
| pollInterval, err := time.ParseDuration(data.PollInterval.ValueString()) | ||
| if err != nil { | ||
| resp.Diagnostics.AddAttributeError( | ||
| path.Root("poll_interval"), | ||
| "Unparsable poll interval value", | ||
| fmt.Sprintf("An unexpected error was encountered trying to parse the value.\n\n%s", err.Error()), | ||
| ) | ||
| } | ||
| opts = append(opts, hcloud.WithPollBackoffFunc(hcloud.ExponentialBackoff(2, pollInterval))) | ||
| } | ||
|
|
||
| if resp.Diagnostics.HasError() { | ||
| return | ||
| } | ||
|
|
||
| // Debug writer | ||
| opts = append(opts, | ||
| hcloud.WithDebugWriter( | ||
| tflogutil.NewWriter( | ||
| tflog.NewSubsystem(ctx, "hcloud-go", tflog.WithLevel(hclog.Debug)), | ||
| ), | ||
| ), | ||
| ) | ||
|
|
||
| client := hcloud.NewClient(opts...) | ||
| resp.DataSourceData = client | ||
| resp.ResourceData = client | ||
|
|
||
| tflog.Info(ctx, "terraform-provider-hcloud info", map[string]any{"version": Version, "commit": Commit}) | ||
| tflog.Info(ctx, "hcloud-go info", map[string]any{"version": hcloud.Version}) | ||
| } | ||
|
|
||
| // DataSources returns a slice of functions to instantiate each DataSource | ||
| // implementation. | ||
| // | ||
| // The data source type name is determined by the DataSource implementing | ||
| // the Metadata method. All data sources must have unique names. | ||
| func (p *PluginProvider) DataSources(_ context.Context) []func() datasource.DataSource { | ||
| return []func() datasource.DataSource{} | ||
| } | ||
|
|
||
| // Resources returns a slice of functions to instantiate each Resource | ||
| // implementation. | ||
| // | ||
| // The resource type name is determined by the Resource implementing | ||
| // the Metadata method. All resources must have unique names. | ||
| func (p *PluginProvider) Resources(_ context.Context) []func() resource.Resource { | ||
| return []func() resource.Resource{} | ||
| } |
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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.