3cdbd2dca9
* eph: add ephemeral resource Adds a new example ephemeral resource using a required configurable attribute and an example ID. * tools: bump terraform-plugin-docs Bump to the latest stable release, as it includes support for ephemeral resource documentation generation. * docs: add ephemeral resource documentation * provider: register new example ephemeral resource * eph: improve alphabetical ordering of struct fields * eph: use a computed 'value' attribute To help provider developers easily understand the concept of ephemeral resources, we use a 'value' attribute in the schema, which is set to an example token (token-123). * docs: update ephemeral resource docs * provider: create a separate echo provider factory container Since not every acceptance test requires an ephemeral provider server for the CLI to connect to and interact with, this introduces a separate provider factory container that includes the echo provider. * eph: add basic acceptance test for ephemeral resource * docs: rename ephemeral resource configuration file * eph: improve http response diag
102 lines
3.0 KiB
Go
102 lines
3.0 KiB
Go
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
|
|
package provider
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
|
|
"github.com/hashicorp/terraform-plugin-framework/datasource"
|
|
"github.com/hashicorp/terraform-plugin-framework/ephemeral"
|
|
"github.com/hashicorp/terraform-plugin-framework/function"
|
|
"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"
|
|
)
|
|
|
|
// Ensure ScaffoldingProvider satisfies various provider interfaces.
|
|
var _ provider.Provider = &ScaffoldingProvider{}
|
|
var _ provider.ProviderWithFunctions = &ScaffoldingProvider{}
|
|
var _ provider.ProviderWithEphemeralResources = &ScaffoldingProvider{}
|
|
|
|
// ScaffoldingProvider defines the provider implementation.
|
|
type ScaffoldingProvider struct {
|
|
// version is set to the provider version on release, "dev" when the
|
|
// provider is built and ran locally, and "test" when running acceptance
|
|
// testing.
|
|
version string
|
|
}
|
|
|
|
// ScaffoldingProviderModel describes the provider data model.
|
|
type ScaffoldingProviderModel struct {
|
|
Endpoint types.String `tfsdk:"endpoint"`
|
|
}
|
|
|
|
func (p *ScaffoldingProvider) Metadata(ctx context.Context, req provider.MetadataRequest, resp *provider.MetadataResponse) {
|
|
resp.TypeName = "scaffolding"
|
|
resp.Version = p.version
|
|
}
|
|
|
|
func (p *ScaffoldingProvider) Schema(ctx context.Context, req provider.SchemaRequest, resp *provider.SchemaResponse) {
|
|
resp.Schema = schema.Schema{
|
|
Attributes: map[string]schema.Attribute{
|
|
"endpoint": schema.StringAttribute{
|
|
MarkdownDescription: "Example provider attribute",
|
|
Optional: true,
|
|
},
|
|
},
|
|
}
|
|
}
|
|
|
|
func (p *ScaffoldingProvider) Configure(ctx context.Context, req provider.ConfigureRequest, resp *provider.ConfigureResponse) {
|
|
var data ScaffoldingProviderModel
|
|
|
|
resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)
|
|
|
|
if resp.Diagnostics.HasError() {
|
|
return
|
|
}
|
|
|
|
// Configuration values are now available.
|
|
// if data.Endpoint.IsNull() { /* ... */ }
|
|
|
|
// Example client configuration for data sources and resources
|
|
client := http.DefaultClient
|
|
resp.DataSourceData = client
|
|
resp.ResourceData = client
|
|
}
|
|
|
|
func (p *ScaffoldingProvider) Resources(ctx context.Context) []func() resource.Resource {
|
|
return []func() resource.Resource{
|
|
NewExampleResource,
|
|
}
|
|
}
|
|
|
|
func (p *ScaffoldingProvider) EphemeralResources(ctx context.Context) []func() ephemeral.EphemeralResource {
|
|
return []func() ephemeral.EphemeralResource{
|
|
NewExampleEphemeralResource,
|
|
}
|
|
}
|
|
|
|
func (p *ScaffoldingProvider) DataSources(ctx context.Context) []func() datasource.DataSource {
|
|
return []func() datasource.DataSource{
|
|
NewExampleDataSource,
|
|
}
|
|
}
|
|
|
|
func (p *ScaffoldingProvider) Functions(ctx context.Context) []func() function.Function {
|
|
return []func() function.Function{
|
|
NewExampleFunction,
|
|
}
|
|
}
|
|
|
|
func New(version string) func() provider.Provider {
|
|
return func() provider.Provider {
|
|
return &ScaffoldingProvider{
|
|
version: version,
|
|
}
|
|
}
|
|
}
|