Modify databricks_repo to support Git folders in the workspace (#3447)

* Modify `databricks_repo` to support Git folders in the workspace

Changes include:

* adjust `path` check to enforce it only on `/Repos`, not everywhere.
* adjust documentation

* address comments

---------

Co-authored-by: Miles Yucht <[email protected]>

Author: alexott

docs/resources/repo.md

@@ -3,13 +3,13 @@ subcategory: "Workspace"
 ---
 # databricks_repo Resource
 
-This resource allows you to manage [Databricks Repos](https://docs.databricks.com/repos.html).
+This resource allows you to manage [Databricks Git folders](https://docs.databricks.com/en/repos/index.html) (formerly known as Databricks Repos).
 
--> **Note** To create a Repo from a private repository you need to configure Git token as described in the [documentation](https://docs.databricks.com/repos.html#configure-your-git-integration-with-databricks).  To set this token you can use [databricks_git_credential](git_credential.md) resource.
+-> **Note** To create a Git folder from a private repository you need to configure Git token as described in the [documentation](https://docs.databricks.com/en/repos/index.html#configure-your-git-integration-with-databricks).  To set this token you can use [databricks_git_credential](git_credential.md) resource.
 
 ## Example Usage
 
-You can declare Terraform-managed Repo by specifying `url` attribute of Git repository. In addition to that you may need to specify `git_provider` attribute if Git provider doesn't belong to cloud Git providers (Github, GitLab, ...).  If `path` attribute isn't provided, then repo will be created in the user's repo directory (`/Repos/<username>/...`):
+You can declare Terraform-managed Git folder by specifying `url` attribute of Git repository. In addition to that you may need to specify `git_provider` attribute if Git provider doesn't belong to cloud Git providers (Github, GitLab, ...).  If `path` attribute isn't provided, then Git folder will be created in the default location:
 
 
 ```hcl
@@ -20,30 +20,30 @@ resource "databricks_repo" "nutter_in_home" {
 
 ## Argument Reference
 
--> **Note** Repo in Databricks workspace would only be changed, if Terraform stage did change. This means that any manual changes to managed repository won't be overwritten by Terraform, if there's no local changes to configuration. If Repo in Databricks workspace is modifying, application of configuration changes will fail.
+-> **Note** Git folder in Databricks workspace would only be changed, if Terraform stage did change. This means that any manual changes to managed repository won't be overwritten by Terraform, if there's no local changes to configuration. If Git folder in Databricks workspace is modified, application of configuration changes will fail.
 
 The following arguments are supported:
 
-* `url` -  (Required) The URL of the Git Repository to clone from. If the value changes, repo is re-created.
+* `url` -  (Required) The URL of the Git Repository to clone from. If the value changes, Git folder is re-created.
 * `git_provider` - (Optional, if it's possible to detect Git provider by host name) case insensitive name of the Git provider.  Following values are supported right now (could be a subject for a change, consult [Repos API documentation](https://docs.databricks.com/dev-tools/api/latest/repos.html)): `gitHub`, `gitHubEnterprise`, `bitbucketCloud`, `bitbucketServer`, `azureDevOpsServices`, `gitLab`, `gitLabEnterpriseEdition`, `awsCodeCommit`.
-* `path` - (Optional) path to put the checked out Repo. If not specified, then repo will be created in the user's repo directory (`/Repos/<username>/...`).  If the value changes, repo is re-created.
+* `path` - (Optional) path to put the checked out Git folder. If not specified, , then the Git folder will be created in the default location.  If the value changes, Git folder is re-created.
 * `branch` - (Optional) name of the branch for initial checkout. If not specified, the default branch of the repository will be used.  Conflicts with `tag`.  If `branch` is removed, and `tag` isn't specified, then the repository will stay at the previously checked out state.
 * `tag` - (Optional) name of the tag for initial checkout.  Conflicts with `branch`.
 
 ### sparse_checkout
 
-Optional `sparse_checkout` configuration block contains attributes related to [sparse checkout feature](https://docs.databricks.com/repos/git-operations-with-repos.html#configure-sparse-checkout-mode) in Databricks Repos.  It supports following attributes:
+Optional `sparse_checkout` configuration block contains attributes related to [sparse checkout feature](https://docs.databricks.com/repos/git-operations-with-repos.html#configure-sparse-checkout-mode) in Databricks Git folders.  It supports following attributes:
 
 * `patterns` - array of paths (directories) that will be used for sparse checkout.  List of patterns could be updated in-place.
 
-Addition or removal of the `sparse_checkout` configuration block will lead to recreation of the repo.
+Addition or removal of the `sparse_checkout` configuration block will lead to recreation of the Git folder.
 
 
 ## Attribute Reference
 
 In addition to all arguments above, the following attributes are exported:
 
-* `id` -  Repo identifier
+* `id` -  Git folder identifier
 * `commit_hash` - Hash of the HEAD commit at time of the last executed operation. It won't change if you manually perform pull operation via UI or API
 * `workspace_path` - path on Workspace File System (WSFS) in form of `/Workspace` + `path`
 
@@ -53,7 +53,7 @@ In addition to all arguments above, the following attributes are exported:
 
 ## Import
 
-The resource Repo can be imported using the Repo ID (obtained via UI or using API)
+The resource can be imported using the Git folder ID (obtained via UI or using API)
 
 ```bash
 $ terraform import databricks_repo.this repo_id

repos/resource_repo.go

@@ -152,17 +152,13 @@ func GetGitProviderFromUrl(uri string) string {
 
 func validatePath(i interface{}, k string) (_ []string, errors []error) {
 	v := i.(string)
-	if v != "" {
-		if !strings.HasPrefix(v, "/Repos/") {
-			errors = append(errors, fmt.Errorf("should start with /Repos/, got '%s'", v))
-			return
-		}
-		v = strings.TrimSuffix(v, "/")
-		parts := strings.Split(v, "/")
-		if len(parts) != 4 { // we require 3 path parts + starting /
-			errors = append(errors, fmt.Errorf("should have 3 components (/Repos/<directory>/<repo>), got %d", len(parts)-1))
-			return
-		}
+	if v == "" || !strings.HasPrefix(v, "/Repos/") {
+		return
+	}
+	v = strings.TrimSuffix(v, "/")
+	parts := strings.Split(v, "/")
+	if len(parts) != 4 { // we require 3 path parts + starting /
+		errors = append(errors, fmt.Errorf("should have 3 components (/Repos/<directory>/<repo>), got %d", len(parts)-1))
 	}
 	return
 }

repos/resource_repo_test.go

@@ -203,10 +203,10 @@ func TestResourceRepoCreateCustomDirectoryWrongLocation(t *testing.T) {
 		Resource: ResourceRepo(),
 		State: map[string]any{
 			"url":  "https://github.com/user/test.git",
-			"path": "/NotRepos/Production/test/",
+			"path": "/Repos/Production/test/abc/",
 		},
 		Create: true,
-	}.ExpectError(t, "invalid config supplied. [path] should start with /Repos/, got '/NotRepos/Production/test/'")
+	}.ExpectError(t, "invalid config supplied. [path] should have 3 components (/Repos/<directory>/<repo>), got 4")
 }
 
 func TestResourceRepoCreateCustomDirectoryWrongPath(t *testing.T) {