Skip to content

[Internal] Unified Terraform Provider: Plugin framework resources and data sources #5061

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

[Internal] Unified Terraform Provider: Plugin framework resources and data sources #5061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b639a3b
[Internal] Unified Terraform Provider: Plugin framework resources and…
tanmay-db Sep 29, 2025
6dd418d
[Internal] Unified Terraform Provider: Client bump
tanmay-db Sep 29, 2025
8c6d570
test
tanmay-db Sep 29, 2025
3b6a602
Merge branch 'bump-client' into unified-tf-plugin
tanmay-db Sep 29, 2025
09aba57
work
tanmay-db Sep 29, 2025
ca4b7df
shares
tanmay-db Sep 29, 2025
e56b678
passing tests
tanmay-db Oct 5, 2025
55d013d
-
tanmay-db Oct 6, 2025
d69e203
Merge branch 'main' of github.com:databricks/terraform-provider-datab…
tanmay-db Oct 6, 2025
c52be26
-
tanmay-db Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 147 additions & 3 deletions common/client.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

38 changes: 27 additions & 11 deletions internal/providers/pluginfw/products/app/data_app.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ import (
"github.com/databricks/terraform-provider-databricks/internal/providers/pluginfw/tfschema"
"github.com/databricks/terraform-provider-databricks/internal/service/apps_tf"
"github.com/hashicorp/terraform-plugin-framework/datasource"
"github.com/hashicorp/terraform-plugin-framework/path"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
)

func DataSourceApp() datasource.DataSource {
Expand All @@ -24,20 +24,22 @@ type dataSourceApp struct {
}

type dataApp struct {
Name types.String `tfsdk:"name"`
App types.Object `tfsdk:"app"`
Name types.String `tfsdk:"name"`
App types.Object `tfsdk:"app"`
ProviderConfigData types.Object `tfsdk:"provider_config"`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still best to keep these names matching with the tfsdk names where possible.

}

func (dataApp) ApplySchemaCustomizations(attrs map[string]tfschema.AttributeBuilder) map[string]tfschema.AttributeBuilder {
attrs["name"] = attrs["name"].SetRequired()
attrs["app"] = attrs["app"].SetComputed()

attrs["provider_config"] = attrs["provider_config"].SetOptional()
return attrs
}

func (dataApp) GetComplexFieldTypes(context.Context) map[string]reflect.Type {
return map[string]reflect.Type{
"app": reflect.TypeOf(apps_tf.App{}),
"app": reflect.TypeOf(apps_tf.App{}),
"provider_config": reflect.TypeOf(tfschema.ProviderConfigData{}),
}
}

Expand All @@ -59,19 +61,33 @@ func (a *dataSourceApp) Configure(ctx context.Context, req datasource.ConfigureR

func (a *dataSourceApp) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
ctx = pluginfwcontext.SetUserAgentInDataSourceContext(ctx, resourceName)
w, diags := a.client.GetWorkspaceClient()
resp.Diagnostics.Append(diags...)

var config dataApp
resp.Diagnostics.Append(req.Config.Get(ctx, &config)...)
if resp.Diagnostics.HasError() {
return
}

var name types.String
resp.Diagnostics.Append(req.Config.GetAttribute(ctx, path.Root("name"), &name)...)
var workspaceID string
if !config.ProviderConfigData.IsNull() {
var namespace tfschema.ProviderConfigData
resp.Diagnostics.Append(config.ProviderConfigData.As(ctx, &namespace, basetypes.ObjectAsOptions{
UnhandledNullAsEmpty: true,
UnhandledUnknownAsEmpty: true,
})...)
if resp.Diagnostics.HasError() {
return
}
workspaceID = namespace.WorkspaceID.ValueString()
}

w, diags := a.client.GetWorkspaceClientForUnifiedProviderWithDiagnostics(ctx, workspaceID)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}

appGoSdk, err := w.Apps.GetByName(ctx, name.ValueString())
appGoSdk, err := w.Apps.GetByName(ctx, config.Name.ValueString())
if err != nil {
resp.Diagnostics.AddError("failed to read app", err.Error())
return
Expand All @@ -82,7 +98,7 @@ func (a *dataSourceApp) Read(ctx context.Context, req datasource.ReadRequest, re
if resp.Diagnostics.HasError() {
return
}
dataApp := dataApp{Name: name, App: newApp.ToObjectValue(ctx)}
dataApp := dataApp{Name: config.Name, App: newApp.ToObjectValue(ctx), ProviderConfigData: config.ProviderConfigData}
resp.Diagnostics.Append(resp.State.Set(ctx, dataApp)...)
if resp.Diagnostics.HasError() {
return
Expand Down
33 changes: 28 additions & 5 deletions internal/providers/pluginfw/products/app/data_apps.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/attr"
"github.com/hashicorp/terraform-plugin-framework/datasource"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
)

func DataSourceApps() datasource.DataSource {
Expand All @@ -25,18 +26,20 @@ type dataSourceApps struct {
}

type dataApps struct {
Apps types.List `tfsdk:"app"`
Apps types.List `tfsdk:"app"`
ProviderConfigData types.Object `tfsdk:"provider_config"`
}

func (dataApps) ApplySchemaCustomizations(attrs map[string]tfschema.AttributeBuilder) map[string]tfschema.AttributeBuilder {
attrs["app"] = attrs["app"].SetComputed()

attrs["provider_config"] = attrs["provider_config"].SetOptional()
return attrs
}

func (dataApps) GetComplexFieldTypes(context.Context) map[string]reflect.Type {
return map[string]reflect.Type{
"app": reflect.TypeOf(apps_tf.App{}),
"app": reflect.TypeOf(apps_tf.App{}),
"provider_config": reflect.TypeOf(tfschema.ProviderConfigData{}),
}
}

Expand All @@ -58,7 +61,27 @@ func (a *dataSourceApps) Configure(ctx context.Context, req datasource.Configure

func (a *dataSourceApps) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
ctx = pluginfwcontext.SetUserAgentInDataSourceContext(ctx, resourceName)
w, diags := a.client.GetWorkspaceClient()

var config dataApps
resp.Diagnostics.Append(req.Config.Get(ctx, &config)...)
if resp.Diagnostics.HasError() {
return
}

var workspaceID string
if !config.ProviderConfigData.IsNull() {
var namespace tfschema.ProviderConfigData
resp.Diagnostics.Append(config.ProviderConfigData.As(ctx, &namespace, basetypes.ObjectAsOptions{
UnhandledNullAsEmpty: true,
UnhandledUnknownAsEmpty: true,
})...)
if resp.Diagnostics.HasError() {
return
}
workspaceID = namespace.WorkspaceID.ValueString()
}

w, diags := a.client.GetWorkspaceClientForUnifiedProviderWithDiagnostics(ctx, workspaceID)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
Expand All @@ -79,7 +102,7 @@ func (a *dataSourceApps) Read(ctx context.Context, req datasource.ReadRequest, r
}
apps = append(apps, app.ToObjectValue(ctx))
}
dataApps := dataApps{Apps: types.ListValueMust(apps_tf.App{}.Type(ctx), apps)}
dataApps := dataApps{Apps: types.ListValueMust(apps_tf.App{}.Type(ctx), apps), ProviderConfigData: config.ProviderConfigData}
resp.Diagnostics.Append(resp.State.Set(ctx, dataApps)...)
if resp.Diagnostics.HasError() {
return
Expand Down
Loading
Loading