Skip to content
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

[Internal] Make Read after Create/Update configurable #4190

Merged
merged 2 commits into from
Nov 4, 2024
+107 −11
Merged

[Internal] Make Read after Create/Update configurable #4190

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f654f6
[Internal] Make `Read` after `Create`/`Update` configurable
alexott Nov 3, 2024
3c0a6c7
Split test cases
alexott Nov 4, 2024
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
29 changes: 18 additions & 11 deletions common/resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,18 @@ import (

// Resource aims to simplify things like error & deleted entities handling
type Resource struct {
Create func(ctx context.Context, d *schema.ResourceData, c *DatabricksClient) error
Read func(ctx context.Context, d *schema.ResourceData, c *DatabricksClient) error
Update func(ctx context.Context, d *schema.ResourceData, c *DatabricksClient) error
Delete func(ctx context.Context, d *schema.ResourceData, c *DatabricksClient) error
CustomizeDiff func(ctx context.Context, d *schema.ResourceDiff) error
StateUpgraders []schema.StateUpgrader
Schema map[string]*schema.Schema
SchemaVersion int
Timeouts *schema.ResourceTimeout
DeprecationMessage string
Importer *schema.ResourceImporter
Create func(ctx context.Context, d *schema.ResourceData, c *DatabricksClient) error
Read func(ctx context.Context, d *schema.ResourceData, c *DatabricksClient) error
Update func(ctx context.Context, d *schema.ResourceData, c *DatabricksClient) error
Delete func(ctx context.Context, d *schema.ResourceData, c *DatabricksClient) error
CustomizeDiff func(ctx context.Context, d *schema.ResourceDiff) error
StateUpgraders []schema.StateUpgrader
Schema map[string]*schema.Schema
SchemaVersion int
Timeouts *schema.ResourceTimeout
DeprecationMessage string
Importer *schema.ResourceImporter
CanSkipReadAfterCreateAndUpdate func(d *schema.ResourceData) bool
}

func nicerError(ctx context.Context, err error, action string) error {
Expand Down Expand Up @@ -94,6 +95,9 @@ func (r Resource) ToResource() *schema.Resource {
err = nicerError(ctx, err, "update")
return diag.FromErr(err)
}
if r.CanSkipReadAfterCreateAndUpdate != nil && r.CanSkipReadAfterCreateAndUpdate(d) {
return nil
}
if err := recoverable(r.Read)(ctx, d, c); err != nil {
err = nicerError(ctx, err, "read")
return diag.FromErr(err)
Expand Down Expand Up @@ -162,6 +166,9 @@ func (r Resource) ToResource() *schema.Resource {
err = nicerError(ctx, err, "create")
return diag.FromErr(err)
}
if r.CanSkipReadAfterCreateAndUpdate != nil && r.CanSkipReadAfterCreateAndUpdate(d) {
return nil
}
if err = recoverable(r.Read)(ctx, d, c); err != nil {
err = nicerError(ctx, err, "read")
return diag.FromErr(err)
Expand Down
95 changes: 95 additions & 0 deletions common/resource_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package common
import (
"context"
"fmt"
"log"
"testing"

"github.com/databricks/databricks-sdk-go/apierr"
Expand Down Expand Up @@ -38,6 +39,100 @@ func TestImportingCallsRead(t *testing.T) {
assert.Equal(t, 1, d.Get("foo"))
}

func TestCreateSkipRead(t *testing.T) {
res := Resource{
Create: func(ctx context.Context,
d *schema.ResourceData,
c *DatabricksClient) error {
log.Println("[DEBUG] Create called")
return d.Set("foo", 1)
},
Read: func(ctx context.Context,
d *schema.ResourceData,
c *DatabricksClient) error {
log.Println("[DEBUG] Read called")
d.Set("foo", 2)
return nil
},
Schema: map[string]*schema.Schema{
"foo": {
Type: schema.TypeInt,
Required: true,
},
},
CanSkipReadAfterCreateAndUpdate: func(d *schema.ResourceData) bool {
return true
},
}

client := &DatabricksClient{}
ctx := context.Background()
// Test with skipping read
alexott marked this conversation as resolved.
Show resolved Hide resolved
r := res.ToResource()
d := r.TestResourceData()
diags := r.CreateContext(ctx, d, client)
assert.False(t, diags.HasError())
assert.Equal(t, 1, d.Get("foo"))
// Test without skipping read
res.CanSkipReadAfterCreateAndUpdate = nil
r = res.ToResource()
d = r.TestResourceData()
diags = r.CreateContext(ctx, d, client)
assert.False(t, diags.HasError())
assert.Equal(t, 2, d.Get("foo"))
}

func TestUpdateSkipRead(t *testing.T) {
res := Resource{
Update: func(ctx context.Context,
d *schema.ResourceData,
c *DatabricksClient) error {
log.Println("[DEBUG] Update called")
return d.Set("foo", 1)
},
Read: func(ctx context.Context,
d *schema.ResourceData,
c *DatabricksClient) error {
log.Println("[DEBUG] Read called")
d.Set("foo", 2)
return nil
},
Schema: map[string]*schema.Schema{
"foo": {
Type: schema.TypeInt,
Required: true,
},
},
CanSkipReadAfterCreateAndUpdate: func(d *schema.ResourceData) bool {
return true
},
}

client := &DatabricksClient{}
ctx := context.Background()
// Test with skipping read
r := res.ToResource()
d := r.TestResourceData()
datas, err := r.Importer.StateContext(ctx, d, client)
require.NoError(t, err)
assert.Len(t, datas, 1)
assert.False(t, r.Schema["foo"].ForceNew)
assert.Equal(t, "", d.Id())

diags := r.UpdateContext(ctx, d, client)
assert.False(t, diags.HasError())
assert.Equal(t, 1, d.Get("foo"))
// Test without skipping read
res.CanSkipReadAfterCreateAndUpdate = nil
r = res.ToResource()
d = r.TestResourceData()
_, err = r.Importer.StateContext(ctx, d, client)
require.NoError(t, err)
diags = r.UpdateContext(ctx, d, client)
assert.False(t, diags.HasError())
assert.Equal(t, 2, d.Get("foo"))
}

func TestHTTP404TriggersResourceRemovalForReadAndDelete(t *testing.T) {
nope := func(ctx context.Context,
d *schema.ResourceData,
Expand Down
Loading