-
Notifications
You must be signed in to change notification settings - Fork 398
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Internal] Add StructToSchema for Plugin Framework #3928
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Few comments on this one, but mostly looking great!
if kind == reflect.Ptr { | ||
elem := typeField.Type.Elem() | ||
sv := reflect.New(elem).Elem() | ||
nestedScm := typeToSchema(sv) | ||
scm[fieldName] = SingleNestedAttributeBuilder{Attributes: nestedScm, Optional: isOptional, Required: !isOptional} | ||
} else if kind == reflect.Slice { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if kind == reflect.Ptr { | |
elem := typeField.Type.Elem() | |
sv := reflect.New(elem).Elem() | |
nestedScm := typeToSchema(sv) | |
scm[fieldName] = SingleNestedAttributeBuilder{Attributes: nestedScm, Optional: isOptional, Required: !isOptional} | |
} else if kind == reflect.Slice { | |
value := field.Value | |
if kind == reflect.Ptr { | |
kind = typeField.Type.Elem().Kind() | |
value := field.Elem() | |
} | |
if kind == reflect.Slice { |
Then on line 83 we use this value
instead of field.Value
. This means that pointers always receive consistent treatment as if they were not pointers from the perspective of schema calculation. It's basically the equivalent to lines 17-20.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated, I think for the value
field, it actually is a bit more complex than that. I tried field.Value.Elem()
but that gave me an error for "zero value" when I do value.Interface()
, so I ended up using reflect.New
to create a new instance
scm[fieldName] = ListAttributeBuilder{ElementType: types.Float64Type, Optional: isOptional, Required: !isOptional} | ||
case reflect.TypeOf(types.String{}): | ||
scm[fieldName] = ListAttributeBuilder{ElementType: types.StringType, Optional: isOptional, Required: !isOptional} | ||
default: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For these default
cases, these are always types defined in the Go SDK right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes kind of, these will the nested structs and they will be in the same form as in the gosdk but they'll still live in the tf_sdk package.
The primitive fields nested inside of these structs will still use the tf types
### New Features and Improvements * Automatically create `parent_path` folder if it doesn't exist ([#3778](#3778)). ### Bug Fixes * Fixed logging for underlying Go SDK ([#3917](#3917)). * OPENAPI_SHA check ([#3935](#3935)). * Remove not necessary field in `databricks_job` schema ([#3907](#3907)). ### Internal Changes * Add AttributeBuilder for Plugin Framework schema ([#3922](#3922)). * Add CustomizableSchema for Plugin Framework ([#3927](#3927)). * Add StructToSchema for Plugin Framework ([#3928](#3928)). * Add codegen template and generated files for tfsdk structs ([#3911](#3911)). * Add converter functions and tests for plugin framework ([#3914](#3914)). * Added support to use protocol version 6 provider server for SDK plugin ([#3862](#3862)). * Bump Go SDK to v0.45.0 ([#3933](#3933)). * Change name with the aliases in codegen template ([#3936](#3936)). * Update jd version from latest to 1.8.1 ([#3915](#3915)). * Upgrade `staticcheck` to v0.5.1 to get Go 1.23 support ([#3931](#3931)). ### Exporter * Better support for notebooks with /Workspace path ([#3901](#3901)). * Improve exporting of DLT and test coverage ([#3898](#3898)).
### New Features and Improvements * Automatically create `parent_path` folder if it doesn't exist ([#3778](#3778)). ### Bug Fixes * Fixed logging for underlying Go SDK ([#3917](#3917)). * OPENAPI_SHA check ([#3935](#3935)). * Remove not necessary field in `databricks_job` schema ([#3907](#3907)). ### Internal Changes * Add AttributeBuilder for Plugin Framework schema ([#3922](#3922)). * Add CustomizableSchema for Plugin Framework ([#3927](#3927)). * Add StructToSchema for Plugin Framework ([#3928](#3928)). * Add codegen template and generated files for tfsdk structs ([#3911](#3911)). * Add converter functions and tests for plugin framework ([#3914](#3914)). * Added support to use protocol version 6 provider server for SDK plugin ([#3862](#3862)). * Bump Go SDK to v0.45.0 ([#3933](#3933)). * Change name with the aliases in codegen template ([#3936](#3936)). * Update jd version from latest to 1.8.1 ([#3915](#3915)). * Upgrade `staticcheck` to v0.5.1 to get Go 1.23 support ([#3931](#3931)). ### Exporter * Better support for notebooks with /Workspace path ([#3901](#3901)). * Improve exporting of DLT and test coverage ([#3898](#3898)).
### New Features and Improvements * Add support for filters in `databricks_clusters` data source ([#4014](#4014)). * Added `no_wait` option for clusters to skip waiting to start on cluster creation ([#3953](#3953)). * Introduced Plugin Framework ([#3920](#3920)). ### Bug Fixes * Add suppress diff for `azure_attributes.spot_bid_max_price` in `databricks_instance_pool` ([#3970](#3970)). * Correctly send workload_type fields in `databricks_cluster` to allow users to disable usage in certain contexts ([#3972](#3972)). * Fix `databricks_sql_table` treatment of properties ([#3925](#3925)). * Force send fields for settings resources ([#3978](#3978)). * Handle cluster deletion in `databricks_library` read ([#3909](#3909)). * Make subscriptions optional for SqlAlertTask ([#3983](#3983)). * Permanently delete `ERROR` and `TERMINATED` state clusters if their creation fails ([#4021](#4021)). ### Documentation * Add troubleshooting guide for Provider "registry.terraform.io/databricks/databricks" planned an invalid value ([#3961](#3961)). * Adopt official naming of Mosaic AI Vector Search ([#3971](#3971)). * Document Terraform 1.0 as minimum version ([#3952](#3952)). * Mention Salesforce as supported type in `databricks_connection` ([#3949](#3949)). * Reimplement Azure Databricks deployment guide to use VNet injection & NPIP ([#3986](#3986)). * Resolves [#3127](#3127): Remove deprecated account_id field from mws_credentials resource ([#3974](#3974)). * Small Grammar Corrections in Docs ([#4006](#4006)). * Update `databricks_vector_search_index` docs to match latest SDK ([#4008](#4008)). * Update aws_unity_catalog_assume_role_policy.md ([#3968](#3968)). * Update documentation regarding authentication with Azure-managed Service Principal using GITHUB OIDC ([#3932](#3932)). * Update metastore_assignment.md to properly reflect possible usage ([#3967](#3967)). * Update minimum supported terraform version to 1.1.5 ([#3965](#3965)). * Update resources diagram to include newer resources ([#3962](#3962)). * Update workspace_binding import command ([#3944](#3944)). * fix possible values for `securable_type` in `databricks_workspace_binding` ([#3942](#3942)). ### Internal Changes * Add `AddPlanModifer` method for AttributeBuilder ([#4009](#4009)). * Add integration tests for volumes and quality monitor plugin framework ([#3975](#3975)). * Add support for `computed` tag in TfSDK Structs ([#4005](#4005)). * Added `databricks_quality_monitor` resource and `databricks_volumes` data source to plugin framework ([#3958](#3958)). * Allow vector search tests to fail ([#3959](#3959)). * Clean up comments in library resource ([#4015](#4015)). * Fix irregularities in plugin framework converter function errors ([#4010](#4010)). * Make test utils public and move integration test for quality monitor ([#3993](#3993)). * Migrate Share resource to Go SDK ([#3916](#3916)). * Migrate `databricks_cluster` data source to plugin framework ([#3988](#3988)). * Migrate imports for terraform plugin framework + update init test provider factory ([#3943](#3943)). * Move volumes test next to plugin framework data source ([#3995](#3995)). * Refactor provider and related packages ([#3940](#3940)). * Support import in acceptance test + adding import state for quality monitor ([#3994](#3994)). * Library plugin framework migration ([#3979](#3979)). * Fix `TestAccClusterResource_WorkloadType` ([#3989](#3989)). ### Dependency Updates * Bump github.com/hashicorp/hcl/v2 from 2.21.0 to 2.22.0 ([#3948](#3948)). * Update Go SDK to 0.46.0 ([#4007](#4007)). ### Exporter * Don't generate instance pools if the pool name is empty ([#3960](#3960)). * Expand list of non-interactive clusters ([#4023](#4023)). * Ignore databricks_artifact_allowlist with zero artifact_matcher blocks ([#4019](#4019)). ## [Release] Release v1.51.0 ### Breaking Changes With this release, only protocol version 6 will be supported which is compatible with terraform CLI version 1.1.5 and later. If you are using an older version of the terraform CLI, please upgrade it to use this and further releases of Databricks terraform provider. ### New Features and Improvements * Automatically create `parent_path` folder when creating `databricks_dashboard resource` if it doesn't exist ([#3778](#3778)). ### Bug Fixes * Fixed logging for underlying Go SDK ([#3917](#3917)). * Remove not necessary field in `databricks_job` schema ([#3907](#3907)). ### Internal Changes * Add AttributeBuilder for Plugin Framework schema ([#3922](#3922)). * Add CustomizableSchema for Plugin Framework ([#3927](#3927)). * Add StructToSchema for Plugin Framework ([#3928](#3928)). * Add codegen template and generated files for tfsdk structs ([#3911](#3911)). * Add converter functions and tests for plugin framework ([#3914](#3914)). * Added support to use protocol version 6 provider server for SDK plugin ([#3862](#3862)). * Bump Go SDK to v0.45.0 ([#3933](#3933)). * Change name with the aliases in codegen template ([#3936](#3936)). * Update jd version from latest to 1.8.1 ([#3915](#3915)). * Upgrade `staticcheck` to v0.5.1 to get Go 1.23 support ([#3931](#3931)). * OPENAPI_SHA check ([#3935](#3935)). * Use generic error for missing clusters ([#3938](#3938)) ### Exporter * Better support for notebooks with /Workspace path ([#3901](#3901)). * Improve exporting of DLT and test coverage ([#3898](#3898)).
Changes
StructToSchema
and corresponding unit tests, as well as tests forCustomizableSchema
Tests
make test
run locallydocs/
folderinternal/acceptance