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.

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

Migrated databricks_ip_access_list resource to Go SDK #2306

Merged
merged 9 commits into from
May 19, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
79 changes: 24 additions & 55 deletions access/resource_ip_access_list.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package access
import (
"context"

"github.com/databricks/databricks-sdk-go/service/settings"
"github.com/databricks/terraform-provider-databricks/common"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
Expand Down Expand Up @@ -43,54 +44,6 @@ type ipAccessListUpdateRequest struct {
Enabled bool `json:"enabled,omitempty" tf:"default:true"`
}

// Preview feature: https://docs.databricks.com/security/network/ip-access-list.html
// REST API: https://docs.databricks.com/dev-tools/api/latest/ip-access-list.html#operation/create-list
type ipAccessListsAPI struct {
client *common.DatabricksClient
context context.Context
}

// NewIPAccessListsAPI ...
func NewIPAccessListsAPI(ctx context.Context, m any) ipAccessListsAPI {
return ipAccessListsAPI{
client: m.(*common.DatabricksClient),
context: ctx,
}
}

// Create creates the IP Access List to given the instance pool configuration
func (a ipAccessListsAPI) Create(cr createIPAccessListRequest) (status IpAccessListStatus, err error) {
wrapper := IpAccessListStatusWrapper{}
err = a.client.Post(a.context, "/ip-access-lists", cr, &wrapper)
if err != nil {
return
}
status = wrapper.IPAccessList
return
}

func (a ipAccessListsAPI) Update(objectID string, ur ipAccessListUpdateRequest) error {
return a.client.Put(a.context, "/ip-access-lists/"+objectID, ur)
}

func (a ipAccessListsAPI) Delete(objectID string) (err error) {
err = a.client.Delete(a.context, "/ip-access-lists/"+objectID, map[string]any{})
return
}

func (a ipAccessListsAPI) Read(objectID string) (status IpAccessListStatus, err error) {
wrapper := IpAccessListStatusWrapper{}
err = a.client.Get(a.context, "/ip-access-lists/"+objectID, nil, &wrapper)
status = wrapper.IPAccessList
return
}

func (a ipAccessListsAPI) List() (listResponse ListIPAccessListsResponse, err error) {
listResponse = ListIPAccessListsResponse{}
err = a.client.Get(a.context, "/ip-access-lists", nil, &listResponse)
return
}

// ResourceIPAccessList manages IP access lists
func ResourceIPAccessList() *schema.Resource {
s := common.StructToSchema(ipAccessListUpdateRequest{}, func(s map[string]*schema.Schema) map[string]*schema.Schema {
Expand All @@ -105,30 +58,46 @@ func ResourceIPAccessList() *schema.Resource {
return common.Resource{
Schema: s,
Create: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error {
var iacl createIPAccessListRequest
w, err := c.WorkspaceClient()
if err != nil {
return err
}
var iacl settings.CreateIpAccessList
common.DataToStructPointer(d, s, &iacl)
status, err := NewIPAccessListsAPI(ctx, c).Create(iacl)
status, err := w.IpAccessLists.Create(ctx, iacl)
if err != nil {
return err
}
d.SetId(status.ListID)
d.SetId(status.IpAccessList.ListId)
return nil
},
Read: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error {
status, err := NewIPAccessListsAPI(ctx, c).Read(d.Id())
w, err := c.WorkspaceClient()
if err != nil {
return err
}
status, err := w.IpAccessLists.GetByIpAccessListId(ctx, d.Id())
if err != nil {
return err
}
common.StructToData(status, s, d)
return nil
},
Update: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error {
var iacl ipAccessListUpdateRequest
w, err := c.WorkspaceClient()
if err != nil {
return err
}
var iacl settings.UpdateIpAccessList
common.DataToStructPointer(d, s, &iacl)
return NewIPAccessListsAPI(ctx, c).Update(d.Id(), iacl)
return w.IpAccessLists.Update(ctx, iacl)
},
Delete: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error {
return NewIPAccessListsAPI(ctx, c).Delete(d.Id())
w, err := c.WorkspaceClient()
if err != nil {
return err
}
return w.IpAccessLists.DeleteByIpAccessListId(ctx, d.Id())
},
}.ToResource()
}
10 changes: 7 additions & 3 deletions access/resource_ip_access_list_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"net/http"
"testing"

"github.com/databricks/databricks-sdk-go"
"github.com/databricks/databricks-sdk-go/apierr"
"github.com/databricks/terraform-provider-databricks/qa"

Expand Down Expand Up @@ -303,7 +304,9 @@ func TestIPACLDelete_Error(t *testing.T) {
}

func TestListIpAccessLists(t *testing.T) {
client, server, err := qa.HttpFixtureClient(t, []qa.HTTPFixture{
w, err := databricks.NewWorkspaceClient()
require.NoError(t, err)
_, server, err := qa.HttpFixtureClient(t, []qa.HTTPFixture{
{
Method: "GET",
Resource: "/api/2.0/ip-access-lists",
Expand All @@ -314,7 +317,8 @@ func TestListIpAccessLists(t *testing.T) {
require.NoError(t, err)

ctx := context.Background()
ipLists, err := NewIPAccessListsAPI(ctx, client).List()
ipLists, err := w.IpAccessLists.Impl().List(ctx)

require.NoError(t, err)
assert.Equal(t, len(ipLists.ListIPAccessListsResponse), 0)
assert.Equal(t, 0, len(ipLists.IpAccessLists))
}
12 changes: 8 additions & 4 deletions exporter/importables.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ import (
"golang.org/x/exp/slices"

"github.com/databricks/databricks-sdk-go/service/settings"
"github.com/databricks/terraform-provider-databricks/access"
"github.com/databricks/terraform-provider-databricks/clusters"
"github.com/databricks/terraform-provider-databricks/common"
"github.com/databricks/terraform-provider-databricks/jobs"
Expand Down Expand Up @@ -1110,15 +1109,20 @@ var resourcesMap map[string]importable = map[string]importable{
return d.Get("list_type").(string) + "_" + d.Get("label").(string)
},
List: func(ic *importContext) error {
ipListsResp, err := access.NewIPAccessListsAPI(ic.Context, ic.Client).List()
w, err := ic.Client.WorkspaceClient()
if err != nil {
return err
}
ipListsResp, err := w.IpAccessLists.Impl().List(ic.Context)

if err != nil {
return err
}
ipLists := ipListsResp.ListIPAccessListsResponse
ipLists := ipListsResp.IpAccessLists
for offset, ipList := range ipLists {
ic.Emit(&resource{
Resource: "databricks_ip_access_list",
ID: ipList.ListID,
ID: ipList.ListId,
})
log.Printf("[INFO] Scanned %d of %d IP Access Lists", offset+1, len(ipLists))
}
Expand Down
7 changes: 1 addition & 6 deletions internal/acceptance/ip_access_list_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,16 @@ import (
"testing"
)

func TestIPACLListsResourceFullLifecycle(t *testing.T) {
func TestAccIPACLListsResourceFullLifecycle(t *testing.T) {
workspaceLevel(t, step{
Template: `
resource "databricks_workspace_conf" "features" {
enable_ip_access_lists = "true"
}

resource "databricks_ip_access_list" "this" {
label = "tf-{var.RANDOM}"
list_type = "BLOCK"
ip_addresses = [
"10.0.10.25",
"10.0.10.0/24"
]
depends_on = [databricks_workspace_conf.features]
}`,
})
}