Deprecated redundant fields for notebook and file

* `databricks_notebook` & `databricks_dbfs_file` field `content` is deprecated and would be renamed to `content_base64` to further increase clarity.
* `databricks_dbfs_file` has got `content`, `content_b64_md5`, `overwrite`, `mkdirs`, `validate_remote_file` fields deprecated and they will be removed in the next version, where critical code path will be shared with `databricks_notebook`.

Author: nfx

CHANGELOG.md

@@ -5,9 +5,12 @@
 * Fixed documentation issues.
 * Added missing resource importers and test to cover it.
 * Migrated build from TravisCI to GitHub Actions.
+* Fixed custom `config_file` issue configuration handling ([#420](https://github.com/databrickslabs/terraform-provider-databricks/issues/420)).
 
 **Deprecations**
 * `databricks_notebook` has got `overwrite`, `mkdirs` and `format` parameters, that always have to be set to certain values in order to follow expected behavior of terraform. These fields would be removed in 0.3 and always set to proper values.
+* `databricks_notebook` & `databricks_dbfs_file` field `content` is deprecated and would be renamed to `content_base64` to further increase clarity. 
+* `databricks_dbfs_file` has got `content`, `content_b64_md5`, `overwrite`, `mkdirs`, `validate_remote_file` fields deprecated and they will be removed in the next version, where critical code path will be shared with `databricks_notebook`.
 * `network_error_messages` and `verify_workspace_runnning` from `databricks_mws_workspaces` is deprecated and going to be removed in 0.3.
 * `error_messages` from `databricks_mws_networks` are deprecated and would be removed in 0.3.
 * `ebs_volume_type` and `azure_disk_volume_type` from `databricks_instance_pool` is going to be moved to `disk_type` sub-block in 0.3, which means you'll slightly have to modify configuration while migrating to 0.3. Computed field `default_tags` is going to be removed from resource. This is done to further increase maintainability of provider in the future.

docs/resources/dbfs_file.md

@@ -35,14 +35,13 @@ resource "databricks_dbfs_file" "my_dbfs_file" {
 
 The following arguments are supported:
 
-* `content` - (Optional) The content of the file as a base64 encoded string.
+* `content` - (Optional) The content of the file as a base64 encoded string. **This field is deprecated and would be removed in the next version.**
 * `source` - (Optional) The full absolute path to the file. Please use [pathexpand](https://www.terraform.io/docs/configuration/functions/pathexpand.html).
-* `content_b64_md5` - (Required) The checksum for the content please use the [md5](https://www.terraform.io/docs/configuration/functions/md5.html) and [filebase64](https://www.terraform.io/docs/configuration/functions/filebase64.html) functions in terraform to retrieve the checksum.
+* `content_b64_md5` - (Required) The checksum for the content please use the [md5](https://www.terraform.io/docs/configuration/functions/md5.html) and [filebase64](https://www.terraform.io/docs/configuration/functions/filebase64.html) functions in terraform to retrieve the checksum. **This field is deprecated and would be removed in the next version.**
 * `path` - (Required) The path of the file in which you wish to save.
-* `overwrite` - (Optional) This is used to determine whether it should delete the existing file with the same name when it writes. The default is set to false.
-* `mkdirs` - (Optional) When the resource is created, this field is used to determine if it needs to make the parent directories. The default value is set to true.
-* `validate_remote_file` - (Optional) This is used to compare the actual contents of the file to determine if the remote file is valid or not. If the base64 content is different 
-it will attempt to do a delete, create.
+* `overwrite` - (Optional) This is used to determine whether it should delete the existing file with the same name when it writes. The default is set to false. **This field is deprecated and would be removed in the next version.**
+* `mkdirs` - (Optional) When the resource is created, this field is used to determine if it needs to make the parent directories. The default value is set to true. **This field is deprecated and would be removed in the next version.**
+* `validate_remote_file` - (Optional) This is used to compare the actual contents of the file to determine if the remote file is valid or not. If the base64 content is different it will attempt to do a delete, create. **This field is deprecated and would be removed in the next version.**
 
 
 ## Attribute Reference

docs/resources/notebook.md

@@ -26,9 +26,9 @@ resource "databricks_notebook" "notebook" {
 
 The following arguments are supported:
 
-* `content` - (Required) The base64-encoded content. If the limit (10MB) is exceeded, an exception with error code MAX_NOTEBOOK_SIZE_EXCEEDED will be thrown.
-* `path` -  (Required) The absolute path of the notebook or directory, beginning with "/", e.g. "/mynotebook". This field is **required**.
-* `language` -  (Required) The language. If format is set to SOURCE, this field is required; otherwise, it will be ignored. Possible choices are SCALA, PYTHON, SQL, R.
+* `content` - (Required) The base64-encoded content. If the limit (10MB) is exceeded, an exception with error code MAX_NOTEBOOK_SIZE_EXCEEDED will be thrown. *This field is **deprecated** and will be renamed to `content_base64` in 0.3.*
+* `path` -  (Required) The absolute path of the notebook or directory, beginning with "/", e.g. "/mynotebook".
+* `language` -  (Required) The language. If format is set to SOURCE, this field is required; otherwise, it will be ignored. Possible choices are SCALA, PYTHON, SQL, R. *This field will become optional in the next release.*
 * `overwrite` - (Required) The flag that specifies whether to overwrite an existing object. It is false by default. *This field is **deprecated** and will be removed in 0.3.*
 * `mkdirs` - (Required) Create the given directory and necessary parent directories if they do not exist. If there exists an object (not a directory) at any prefix of the input path, this call returns an error RESOURCE_ALREADY_EXISTS. If this operation fails it may have succeeded in creating some of the necessary parent directories. *This field is **deprecated** and will be removed in 0.3.*
 * `format` -  (Required) This specifies the format of the file to be imported. This resource currently only supports SOURCE. The value is case sensitive. SOURCE is suitable for .scala, .py, .r, .sql extension based files, HTML for .html files, JUPYTER for .ipynb files. Though the API supports DBC, HTML, and JUPYTER currently we do not support them as effectively identifying DIFF is currently not feasible. *This field is **deprecated** and will be removed in 0.3.*

storage/resource_dbfs_file.go

@@ -30,6 +30,9 @@ func ResourceDBFSFile() *schema.Resource {
 
 		Schema: map[string]*schema.Schema{
 			"content": {
+				Deprecated: "databricks_dbfs_file.content is deprecated and would be "+
+							"renamed to `content_base64` in the next version. Please "+
+							"rewrite your configuration to use `source` field.",
 				Type:     schema.TypeString,
 				Optional: true,
 				ForceNew: true,
@@ -41,6 +44,8 @@ func ResourceDBFSFile() *schema.Resource {
 				ConflictsWith: []string{"content"},
 			},
 			"content_b64_md5": {
+				Deprecated: "databricks_dbfs_file.content_b64_md5 is deprecated and would be "+
+							"removed in the next version.",
 				Type:     schema.TypeString,
 				Required: true,
 				ForceNew: true,
@@ -51,16 +56,22 @@ func ResourceDBFSFile() *schema.Resource {
 				ForceNew: true,
 			},
 			"overwrite": {
+				Deprecated: "databricks_dbfs_file.overwrite is deprecated and would be "+
+							"removed in the next version.",
 				Type:     schema.TypeBool,
 				Optional: true,
 				Default:  false,
 			},
 			"mkdirs": {
+				Deprecated: "databricks_dbfs_file.mkdirs is deprecated and would be "+
+							"removed in the next version.",
 				Type:     schema.TypeBool,
 				Optional: true,
 				Default:  true,
 			},
 			"validate_remote_file": {
+				Deprecated: "databricks_dbfs_file.validate_remote_file is deprecated and would be "+
+							"removed in the next version.",
 				Type:     schema.TypeBool,
 				Optional: true,
 			},

workspace/resource_notebook.go

@@ -205,6 +205,8 @@ func ResourceNotebook() *schema.Resource {
 		},
 		Schema: map[string]*schema.Schema{
 			"content": {
+				Deprecated: "databricks_notebook.content is deprecated and is "+
+							"going to be renamed to `content_base64` in version 0.3",
 				Type:     schema.TypeString,
 				Required: true,
 				ForceNew: true,