Use common.Resource consistently throughout the provider #3193
Conversation
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
mgyucht
commented
Feb 1, 2024
| @@ -654,8 +654,8 @@ func DataToStructPointer(d *schema.ResourceData, scm map[string]*schema.Schema, | |||
| } | |||
|
|
|||
| // DataToReflectValue reads reflect value from data | |||
| func DataToReflectValue(d *schema.ResourceData, r *schema.Resource, rv reflect.Value) error { | |||
| return readReflectValueFromData([]string{}, d, rv, r.Schema) | |||
| func DataToReflectValue(d *schema.ResourceData, s map[string]*schema.Schema, rv reflect.Value) error { | |||
There was a problem hiding this comment.
The only places where this is used construct a resource in-line purely to pass the schema, so I changed it to accept the schema instead.
Comment on lines
-617
to
-618
| diags := r.ReadContext(context.Background(), d, nil) | ||
| assert.Len(t, diags, 1) |
There was a problem hiding this comment.
This is an unnecessary test case, as the provider will ensure that the meta argument is always set to a non-nil *DatabricksClient.
Comment on lines
+28
to
+29
| DeprecationMessage string | ||
| Importer *schema.ResourceImporter |
There was a problem hiding this comment.
These are the only fields from schema.Resource that need to be added to this Resource structure.
| @@ -161,6 +161,10 @@ func getCommonClusterObject(clustersAPI clusters.ClustersAPI, clusterName string | |||
| func getOrCreateMountingCluster(clustersAPI clusters.ClustersAPI) (string, error) { | |||
| cluster, err := clustersAPI.GetOrCreateRunningCluster("terraform-mount", getCommonClusterObject(clustersAPI, "terraform-mount")) | |||
| if err != nil { | |||
| // Do not treat missing cluster like a missing resource. | |||
There was a problem hiding this comment.
Needed because common.Resource has a blanket catch-all for missing responses from APIs, but in this case, we need to prevent that from being triggered.
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #3193 +/- ##
==========================================
+ Coverage 83.20% 83.26% +0.05%
==========================================
Files 168 168
Lines 15013 15018 +5
==========================================
+ Hits 12492 12505 +13
+ Misses 1787 1781 -6
+ Partials 734 732 -2
|
mgyucht
commented
Feb 1, 2024
| d := r.TestResourceData() | ||
| d.Set("name", "a name") |
There was a problem hiding this comment.
The actual resource definition adds a "preprocessing" step that checks whether the name and uri attributes are set.
tanmay-db
added a commit
that referenced
this pull request
Feb 5, 2024
### New Features and Improvements * Exporter: timestamps are now added to log entries ([#3146](#3146)). * Validate metastore id for databricks_grant and databricks_grants resources ([#3159](#3159)). * Exporter: Skip emitting of clusters that come from more cluster sources ([#3161](#3161)). * Fix typo in docs ([#3166](#3166)). * Migrate cluster schema to use the go-sdk struct ([#3076](#3076)). * Introduce Generic Settings Resource ([#2997](#2997)). * Update actions/setup-go to v5 ([#3154](#3154)). * Change default branch from `master` to `main` ([#3174](#3174)). * Add .codegen.json configuration ([#3180](#3180)). * Exporter: performance improvements for big workspaces ([#3167](#3167)). * update ([#3192](#3192)). * Exporter: fix generation of cluster policy resources ([#3185](#3185)). * Fix unit test ([#3201](#3201)). * Suppress diff should apply to new fields added in the same chained call to CustomizableSchema ([#3200](#3200)). * Various documentation updates ([#3198](#3198)). * Use common.Resource consistently throughout the provider ([#3193](#3193)). * Extending customizable schema with `AtLeastOneOf`, `ExactlyOneOf`, `RequiredWith` ([#3182](#3182)). * Fix `databricks_connection` regression when creating without owner ([#3186](#3186)). * add test code for job task order ([#3183](#3183)). * Allow using empty strings as job parameters ([#3158](#3158)). * Fix notebook parameters in acceptance test ([#3205](#3205)). * Exporter: Add retries for `Search`, `ReadContext` and `Import` operations when importing the resource ([#3202](#3202)). * Fixed updating owners for UC resources ([#3189](#3189)). * Adds `databricks_volumes` as data source ([#3150](#3150)). ### Documentation Changes ### Exporter ### Internal Changes
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
Feb 6, 2024
* Release v1.35.1 ### New Features and Improvements * Exporter: timestamps are now added to log entries ([#3146](#3146)). * Validate metastore id for databricks_grant and databricks_grants resources ([#3159](#3159)). * Exporter: Skip emitting of clusters that come from more cluster sources ([#3161](#3161)). * Fix typo in docs ([#3166](#3166)). * Migrate cluster schema to use the go-sdk struct ([#3076](#3076)). * Introduce Generic Settings Resource ([#2997](#2997)). * Update actions/setup-go to v5 ([#3154](#3154)). * Change default branch from `master` to `main` ([#3174](#3174)). * Add .codegen.json configuration ([#3180](#3180)). * Exporter: performance improvements for big workspaces ([#3167](#3167)). * update ([#3192](#3192)). * Exporter: fix generation of cluster policy resources ([#3185](#3185)). * Fix unit test ([#3201](#3201)). * Suppress diff should apply to new fields added in the same chained call to CustomizableSchema ([#3200](#3200)). * Various documentation updates ([#3198](#3198)). * Use common.Resource consistently throughout the provider ([#3193](#3193)). * Extending customizable schema with `AtLeastOneOf`, `ExactlyOneOf`, `RequiredWith` ([#3182](#3182)). * Fix `databricks_connection` regression when creating without owner ([#3186](#3186)). * add test code for job task order ([#3183](#3183)). * Allow using empty strings as job parameters ([#3158](#3158)). * Fix notebook parameters in acceptance test ([#3205](#3205)). * Exporter: Add retries for `Search`, `ReadContext` and `Import` operations when importing the resource ([#3202](#3202)). * Fixed updating owners for UC resources ([#3189](#3189)). * Adds `databricks_volumes` as data source ([#3150](#3150)). ### Documentation Changes ### Exporter ### Internal Changes * upd * readable * upd * upd
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes
Purely a refactor of existing resources to consistently use
common.Resourcethroughout the provider, instead of a mixture of*schema.Resourceandcommon.Resource. This is needed for #3188, in which I'll add a field incommon.Resourceindicating whether or not theworkspace_idattribute needs to be added to the schema.Tests
Passes integration tests (with one exception, which is being fixed in #3200).
make testrun locallydocs/folderinternal/acceptance