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

Updated docs and tests for databricks_volume resource #2355

Merged
merged 5 commits into from
May 31, 2023
Merged

Updated docs and tests for databricks_volume resource #2355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c13f4a8
comments
tanmay-db May 31, 2023
ba0777e
comments
tanmay-db May 31, 2023
d97d341
comments
tanmay-db May 31, 2023
5a9ce30
update
tanmay-db May 31, 2023
7e521df
upd
tanmay-db May 31, 2023
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
19 changes: 10 additions & 9 deletions catalog/resource_volume.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,18 @@ func ResourceVolume() *schema.Resource {
}
d.SetId(v.FullName)

// Update owner if it is provided
if d.Get("owner") != "" {
var updateVolumeRequestContent catalog.UpdateVolumeRequestContent
common.DataToStructPointer(d, s, &updateVolumeRequestContent)
updateVolumeRequestContent.FullNameArg = d.Id()
_, err = w.Volumes.Update(ctx, updateVolumeRequestContent)
if err != nil {
return err
}
// Don't update owner if it is not provided
if d.Get("owner") == "" {
return nil
}

var updateVolumeRequestContent catalog.UpdateVolumeRequestContent
common.DataToStructPointer(d, s, &updateVolumeRequestContent)
updateVolumeRequestContent.FullNameArg = d.Id()
_, err = w.Volumes.Update(ctx, updateVolumeRequestContent)
if err != nil {
return err
}
return nil
},
Read: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error {
Expand Down
24 changes: 12 additions & 12 deletions catalog/resource_volume_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ func TestVolumesCreateWithoutInitialOwner(t *testing.T) {
},
{
Method: http.MethodGet,
Resource: "/api/2.1/unity-catalog/volumes/" + "testCatalogName.testSchemaName.testName" + "?",
Resource: "/api/2.1/unity-catalog/volumes/testCatalogName.testSchemaName.testName?",
Response: catalog.VolumeInfo{
Name: "testName",
VolumeType: catalog.VolumeType("testVolumeType"),
Expand Down Expand Up @@ -97,7 +97,7 @@ func TestVolumesCreateWithInitialOwner(t *testing.T) {
},
{
Method: http.MethodGet,
Resource: "/api/2.1/unity-catalog/volumes/" + "testCatalogName.testSchemaName.testName" + "?",
Resource: "/api/2.1/unity-catalog/volumes/testCatalogName.testSchemaName.testName?",
Response: catalog.VolumeInfo{
Name: "testName",
VolumeType: catalog.VolumeType("testVolumeType"),
Expand All @@ -110,7 +110,7 @@ func TestVolumesCreateWithInitialOwner(t *testing.T) {
},
{
Method: http.MethodPatch,
Resource: "/api/2.1/unity-catalog/volumes/" + "testCatalogName.testSchemaName.testName",
Resource: "/api/2.1/unity-catalog/volumes/testCatalogName.testSchemaName.testName",
ExpectedRequest: catalog.UpdateVolumeRequestContent{
Name: "testName",
Comment: "This is a test comment.",
Expand Down Expand Up @@ -201,7 +201,7 @@ func TestVolumesCreateWithInitialOwner_Error(t *testing.T) {
},
{
Method: http.MethodGet,
Resource: "/api/2.1/unity-catalog/volumes/" + "testCatalogName.testSchemaName.testName" + "?",
Resource: "/api/2.1/unity-catalog/volumes/testCatalogName.testSchemaName.testName?",
Response: catalog.VolumeInfo{
Name: "testName",
VolumeType: catalog.VolumeType("testVolumeType"),
Expand All @@ -214,7 +214,7 @@ func TestVolumesCreateWithInitialOwner_Error(t *testing.T) {
},
{
Method: http.MethodPatch,
Resource: "/api/2.1/unity-catalog/volumes/" + "testCatalogName.testSchemaName.testName",
Resource: "/api/2.1/unity-catalog/volumes/testCatalogName.testSchemaName.testName",
Response: apierr.APIErrorBody{
ErrorCode: "SERVER_ERROR",
Message: "Something unexpected happened",
Expand All @@ -241,7 +241,7 @@ func TestVolumesRead(t *testing.T) {
Fixtures: []qa.HTTPFixture{
{
Method: http.MethodGet,
Resource: "/api/2.1/unity-catalog/volumes/" + "testCatalogName.testSchemaName.testName" + "?",
Resource: "/api/2.1/unity-catalog/volumes/testCatalogName.testSchemaName.testName?",
Response: catalog.VolumeInfo{
Name: "testName",
VolumeType: catalog.VolumeType("testVolumeType"),
Expand Down Expand Up @@ -276,7 +276,7 @@ func TestResourceVolumeRead_Error(t *testing.T) {
Fixtures: []qa.HTTPFixture{
{
Method: "GET",
Resource: "/api/2.1/unity-catalog/volumes/" + "testCatalogName.testSchemaName.testName" + "?",
Resource: "/api/2.1/unity-catalog/volumes/testCatalogName.testSchemaName.testName?",
Response: apierr.APIErrorBody{
ErrorCode: "INVALID_REQUEST",
Message: "Internal error happened",
Expand All @@ -297,7 +297,7 @@ func TestVolumesUpdate(t *testing.T) {
Fixtures: []qa.HTTPFixture{
{
Method: http.MethodGet,
Resource: "/api/2.1/unity-catalog/volumes/" + "testCatalogName.testSchemaName.testName" + "?",
Resource: "/api/2.1/unity-catalog/volumes/testCatalogName.testSchemaName.testName?",
Response: catalog.VolumeInfo{
Name: "testNameNew",
VolumeType: catalog.VolumeType("testVolumeType"),
Expand All @@ -310,7 +310,7 @@ func TestVolumesUpdate(t *testing.T) {
},
{
Method: http.MethodPatch,
Resource: "/api/2.1/unity-catalog/volumes/" + "testCatalogName.testSchemaName.testName",
Resource: "/api/2.1/unity-catalog/volumes/testCatalogName.testSchemaName.testName",
ExpectedRequest: catalog.UpdateVolumeRequestContent{
Name: "testNameNew",
Comment: "This is a new test comment.",
Expand Down Expand Up @@ -352,7 +352,7 @@ func TestVolumeUpdate_Error(t *testing.T) {
Fixtures: []qa.HTTPFixture{
{
Method: http.MethodPatch,
Resource: "/api/2.1/unity-catalog/volumes/" + "testCatalogName.testSchemaName.testName",
Resource: "/api/2.1/unity-catalog/volumes/testCatalogName.testSchemaName.testName",
ExpectedRequest: catalog.UpdateVolumeRequestContent{
Name: "testNameNew",
Comment: "This is a new test comment.",
Expand Down Expand Up @@ -385,7 +385,7 @@ func TestVolumeDelete(t *testing.T) {
Fixtures: []qa.HTTPFixture{
{
Method: http.MethodDelete,
Resource: "/api/2.1/unity-catalog/volumes/" + "testCatalogName.testSchemaName.testName" + "?",
Resource: "/api/2.1/unity-catalog/volumes/testCatalogName.testSchemaName.testName?",
},
},
Resource: ResourceVolume(),
Expand All @@ -401,7 +401,7 @@ func TestVolumeDelete_Error(t *testing.T) {
Fixtures: []qa.HTTPFixture{
{
Method: http.MethodDelete,
Resource: "/api/2.1/unity-catalog/volumes/" + "testCatalogName.testSchemaName.testName" + "?",
Resource: "/api/2.1/unity-catalog/volumes/testCatalogName.testSchemaName.testName?",
Response: apierr.APIErrorBody{
ErrorCode: "INVALID_STATE",
Message: "Something went wrong",
Expand Down
15 changes: 14 additions & 1 deletion docs/resources/volume.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,26 @@ resource "databricks_schema" "things" {
}
}
resource "databricks_storage_credential" "external" {
name = "creds"
aws_iam_role {
role_arn = aws_iam_role.external_data_access.arn
}
}
resource "databricks_external_location" "some" {
name = "external-location"
url = "s3://${aws_s3_bucket.external.id}/some"
credential_name = databricks_storage_credential.external.id
}
resource "databricks_volume" "this" {
name = "quickstart_volume"
catalog_name = databricks_catalog.sandbox.name
schema_name = databricks_schema.things.name
owner = "volume_owner"
volume_type = "EXTERNAL"
storage_location = ""
storage_location = databricks_external_location.some.url
comment = "this volume is managed by terraform"
}
```
Expand Down
55 changes: 24 additions & 31 deletions internal/acceptance/volume_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,28 @@
package acceptance

import (
"fmt"
"testing"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest"
)

func TestUcAccVolumesResourceWithoutInitialOwnerAWSFullLifecycle(t *testing.T) {
GetEnvOrSkipTest(t, "TEST_BUCKET")
randomName := acctest.RandStringFromCharSet(10, acctest.CharSetAlphaNum)
unityWorkspaceLevel(t, step{
Template: fmt.Sprintf(`
Template: `
resource "databricks_schema" "this" {
name = "schema-%[1]s"
name = "schema-{var.STICKY_RANDOM}"
catalog_name = "main"
}
resource "databricks_storage_credential" "external" {
name = "cred-%[1]s"
name = "cred-{var.STICKY_RANDOM}"
aws_iam_role {
role_arn = "{env.TEST_METASTORE_DATA_ACCESS_ARN}"
}
comment = "Managed by TF"
}
resource "databricks_external_location" "some" {
name = "external-%[1]s"
url = "s3://{env.TEST_BUCKET}/somepath-%[1]s"
name = "external-{var.STICKY_RANDOM}"
url = "s3://{env.TEST_BUCKET}/somepath-{var.STICKY_RANDOM}"
credential_name = databricks_storage_credential.external.id
comment = "Managed by TF"
}
Expand All @@ -39,25 +34,25 @@ func TestUcAccVolumesResourceWithoutInitialOwnerAWSFullLifecycle(t *testing.T) {
schema_name = databricks_schema.this.name
volume_type = "EXTERNAL"
storage_location = databricks_external_location.some.url
}`, randomName),
}`,
}, step{
Template: fmt.Sprintf(`
Template: `
resource "databricks_schema" "this" {
name = "schema-%[1]s"
name = "schema-{var.STICKY_RANDOM}"
catalog_name = "main"
}
resource "databricks_storage_credential" "external" {
name = "cred-%[1]s"
name = "cred-{var.STICKY_RANDOM}"
aws_iam_role {
role_arn = "{env.TEST_METASTORE_DATA_ACCESS_ARN}"
}
comment = "Managed by TF"
}
resource "databricks_external_location" "some" {
name = "external-%[1]s"
url = "s3://{env.TEST_BUCKET}/somepath-%[1]s"
name = "external-{var.STICKY_RANDOM}"
url = "s3://{env.TEST_BUCKET}/somepath-{var.STICKY_RANDOM}"
credential_name = databricks_storage_credential.external.id
comment = "Managed by TF"
}
Expand All @@ -70,31 +65,29 @@ func TestUcAccVolumesResourceWithoutInitialOwnerAWSFullLifecycle(t *testing.T) {
schema_name = databricks_schema.this.name
volume_type = "EXTERNAL"
storage_location = databricks_external_location.some.url
}`, randomName),
}`,
})
}

func TestUcAccVolumesResourceWithInitialOnwerAWSFullLifecycle(t *testing.T) {
GetEnvOrSkipTest(t, "TEST_BUCKET")
randomName := acctest.RandStringFromCharSet(10, acctest.CharSetAlphaNum)
unityWorkspaceLevel(t, step{
Template: fmt.Sprintf(`
Template: `
resource "databricks_schema" "this" {
name = "schema-%[1]s"
name = "schema-{var.STICKY_RANDOM}"
catalog_name = "main"
}
resource "databricks_storage_credential" "external" {
name = "cred-%[1]s"
name = "cred-{var.STICKY_RANDOM}"
aws_iam_role {
role_arn = "{env.TEST_METASTORE_DATA_ACCESS_ARN}"
}
comment = "Managed by TF"
}
resource "databricks_external_location" "some" {
name = "external-%[1]s"
url = "s3://{env.TEST_BUCKET}/somepath-%[1]s"
name = "external-{var.STICKY_RANDOM}"
url = "s3://{env.TEST_BUCKET}/somepath-{var.STICKY_RANDOM}"
credential_name = databricks_storage_credential.external.id
comment = "Managed by TF"
}
Expand All @@ -107,25 +100,25 @@ func TestUcAccVolumesResourceWithInitialOnwerAWSFullLifecycle(t *testing.T) {
schema_name = databricks_schema.this.name
volume_type = "EXTERNAL"
storage_location = databricks_external_location.some.url
}`, randomName),
}`,
}, step{
Template: fmt.Sprintf(`
Template: `
resource "databricks_schema" "this" {
name = "schema-%[1]s"
name = "schema-{var.STICKY_RANDOM}"
catalog_name = "main"
}
resource "databricks_storage_credential" "external" {
name = "cred-%[1]s"
name = "cred-{var.STICKY_RANDOM}"
aws_iam_role {
role_arn = "{env.TEST_METASTORE_DATA_ACCESS_ARN}"
}
comment = "Managed by TF"
}
resource "databricks_external_location" "some" {
name = "external-%[1]s"
url = "s3://{env.TEST_BUCKET}/somepath-%[1]s"
name = "external-{var.STICKY_RANDOM}"
url = "s3://{env.TEST_BUCKET}/somepath-{var.STICKY_RANDOM}"
credential_name = databricks_storage_credential.external.id
comment = "Managed by TF"
}
Expand All @@ -138,6 +131,6 @@ func TestUcAccVolumesResourceWithInitialOnwerAWSFullLifecycle(t *testing.T) {
schema_name = databricks_schema.this.name
volume_type = "EXTERNAL"
storage_location = databricks_external_location.some.url
}`, randomName),
}`,
})
}