Added DBC format support for databricks_notebook

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Version changelog
 
+## 0.4.2
+
+* Added `DBC` format support for `databricks_notebook` ([#989](https://github.com/databrickslabs/terraform-provider-databricks/pull/989)). 
+
 ## 0.4.1
 
 * Added `databricks_library` resource to install library on `databricks_cluster` ([#904](https://github.com/databrickslabs/terraform-provider-databricks/pull/904)).

docs/resources/notebook.md

@@ -32,7 +32,16 @@ resource "databricks_notebook" "notebook" {
   language = "PYTHON"
 }
 ```
-
+
+You can also manage [Databricks Archives](https://docs.databricks.com/notebooks/notebooks-manage.html#databricks-archive) to import the whole folders of notebooks statically. Whenever you update `.dbc` file, terraform-managed notebook folder is removed and replaced with contents of the new `.dbc` file. You are strongly advised to use `.dbc` format only with `source` attribute of the resource:
+
+```hcl
+resource "databricks_notebook" "lesson" {
+  source = "${path.module}/IntroNotebooks.dbc"
+  path = "/Shared/Intro" 
+}
+```
+
 ## Argument Reference
 
 -> **Note** Notebook on Databricks workspace would only be changed, if Terraform stage did change. This means that any manual changes to managed notebook won't be overwritten by Terraform, if there's no local change to notebook sources. Notebooks are identified by their path, so changing notebook's name manually on the workspace and then applying Terraform state would result in creation of notebook from Terraform state.

permissions/acceptance/api_test.go

@@ -267,7 +267,7 @@ func TestAccPermissionsNotebooks(t *testing.T) {
 
 		notebookPath := fmt.Sprintf("%s/Dummy", notebookDir)
 
-		err = workspaceAPI.Create(workspace.ImportRequest{
+		err = workspaceAPI.Create(workspace.ImportPath{
 			Path:      notebookPath,
 			Content:   "MSsx",
 			Format:    "SOURCE",

workspace/data_notebook.go

@@ -22,9 +22,9 @@ func DataSourceNotebook() *schema.Resource {
 			Required: true,
 			ForceNew: true,
 			ValidateFunc: validation.StringInSlice([]string{
-				string(DBC),
-				string(Source),
-				string(HTML),
+				"DBC",
+				"SOURCE",
+				"HTML",
 			}, false),
 		},
 		"content": {
@@ -53,7 +53,7 @@ func DataSourceNotebook() *schema.Resource {
 			notebooksAPI := NewNotebooksAPI(ctx, m)
 			path := d.Get("path").(string)
 			format := d.Get("format").(string)
-			notebookContent, err := notebooksAPI.Export(path, ExportFormat(format))
+			notebookContent, err := notebooksAPI.Export(path, format)
 			if err != nil {
 				return diag.FromErr(err)
 			}

workspace/data_notebook_paths.go

@@ -18,12 +18,6 @@ func DataSourceNotebookPaths() *schema.Resource {
 				return diag.FromErr(err)
 			}
 			d.SetId(path)
-			if err = d.Set("recursive", recursive); err != nil {
-				return diag.FromErr(err)
-			}
-			if err = d.Set("path", path); err != nil {
-				return diag.FromErr(err)
-			}
 			var notebookPathList []map[string]string
 			for _, v := range notebookList {
 				notebookPathMap := map[string]string{}

workspace/data_notebook_paths_test.go

@@ -4,12 +4,10 @@ import (
 	"testing"
 
 	"github.com/databrickslabs/terraform-provider-databricks/qa"
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
 )
 
 func TestDataSourceNotebookPaths(t *testing.T) {
-	d, err := qa.ResourceFixture{
+	qa.ResourceFixture{
 		Fixtures: []qa.HTTPFixture{
 			{
 				Method:   "GET",
@@ -53,7 +51,40 @@ func TestDataSourceNotebookPaths(t *testing.T) {
 			"path":      "/a/b/c",
 			"recursive": true,
 		},
-	}.Apply(t)
-	require.NoError(t, err)
-	assert.Equal(t, "/a/b/c", d.Id())
+	}.ApplyNoError(t)
+}
+
+func TestDataSourceNotebookPaths_NoRecursive(t *testing.T) {
+	qa.ResourceFixture{
+		Fixtures: []qa.HTTPFixture{
+			{
+				Method:   "GET",
+				Resource: "/api/2.0/workspace/list?path=%2Fa%2Fb%2Fc",
+				Response: objectList{
+					Objects: []ObjectStatus{
+						{
+							ObjectID:   988,
+							ObjectType: Notebook,
+							Language:   Python,
+							Path:       "/a/b/c/d/e",
+						},
+						{
+							ObjectID:   989,
+							ObjectType: Notebook,
+							Language:   SQL,
+							Path:       "/a/b/c/d/f",
+						},
+					},
+				},
+			},
+		},
+		Read:        true,
+		NonWritable: true,
+		Resource:    DataSourceNotebookPaths(),
+		ID:          ".",
+		State: map[string]interface{}{
+			"path":      "/a/b/c",
+			"recursive": false,
+		},
+	}.ApplyNoError(t)
 }

workspace/data_notebook_test.go

@@ -24,7 +24,7 @@ func TestDataSourceNotebook(t *testing.T) {
 			{
 				Method:   "GET",
 				Resource: "/api/2.0/workspace/export?format=SOURCE&path=%2Fa%2Fb%2Fc",
-				Response: NotebookContent{
+				Response: ExportPath{
 					Content: "SGVsbG8gd29ybGQK",
 				},
 			},

workspace/file_resource.go

@@ -44,7 +44,6 @@ func ReadContent(d *schema.ResourceData) (content []byte, err error) {
 	if err != nil {
 		return
 	}
-	// TODO: file size
 	d.Set("md5", fmt.Sprintf("%x", md5.Sum(content)))
 	log.Printf("[INFO] Setting file content hash to %s", d.Get("md5"))
 	return

workspace/resource_directory_test.go

@@ -47,7 +47,7 @@ func TestResourceDirectoryDelete(t *testing.T) {
 				Method:          http.MethodPost,
 				Resource:        "/api/2.0/workspace/delete",
 				Status:          http.StatusOK,
-				ExpectedRequest: NotebookDeleteRequest{Path: path, Recursive: delete_recursive},
+				ExpectedRequest: DeletePath{Path: path, Recursive: delete_recursive},
 			},
 		},
 		Resource: ResourceDirectory(),
@@ -172,7 +172,7 @@ func TestResourceDirectoryDelete_Error(t *testing.T) {
 			{
 				Method:          "POST",
 				Resource:        "/api/2.0/workspace/delete",
-				ExpectedRequest: NotebookDeleteRequest{Path: path, Recursive: false},
+				ExpectedRequest: DeletePath{Path: path, Recursive: false},
 				Response: common.APIErrorBody{
 					ErrorCode: "INVALID_REQUEST",
 					Message:   "Internal error happened",