-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Properly read Git metadata when running inside workspace (#1945)
## Changes Since there is no .git directory in Workspace file system, we need to make an API call to api/2.0/workspace/get-status?return_git_info=true to fetch git the root of the repo, current branch, commit and origin. Added new function FetchRepositoryInfo that either looks up and parses .git or calls remote API depending on env. Refactor Repository/View/FileSet to accept repository root rather than calculate it. This helps because: - Repository is currently created in multiple places and finding the repository root is becoming relatively expensive (API call needed). - Repository/FileSet/View do not have access to current Bundle which is where WorkplaceClient is stored. ## Tests - Tested manually by running "bundle validate --json" inside web terminal within Databricks env. - Added integration tests for the new API. --------- Co-authored-by: Andrew Nester <[email protected]> Co-authored-by: Pieter Noordhuis <[email protected]>
- Loading branch information
3 people
authored
Dec 5, 2024
1 parent
0a36681
commit 0ad790e
Showing
17 changed files
with
471 additions
and
89 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| package internal | ||
|
|
||
| import ( | ||
| "os" | ||
| "os/exec" | ||
| "path" | ||
| "path/filepath" | ||
| "testing" | ||
|
|
||
| "github.com/databricks/cli/internal/acc" | ||
| "github.com/databricks/cli/libs/dbr" | ||
| "github.com/databricks/cli/libs/git" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| const examplesRepoUrl = "https://github.com/databricks/bundle-examples" | ||
| const examplesRepoProvider = "gitHub" | ||
|
|
||
| func assertFullGitInfo(t *testing.T, expectedRoot string, info git.RepositoryInfo) { | ||
| assert.Equal(t, "main", info.CurrentBranch) | ||
| assert.NotEmpty(t, info.LatestCommit) | ||
| assert.Equal(t, examplesRepoUrl, info.OriginURL) | ||
| assert.Equal(t, expectedRoot, info.WorktreeRoot) | ||
| } | ||
|
|
||
| func assertEmptyGitInfo(t *testing.T, info git.RepositoryInfo) { | ||
| assertSparseGitInfo(t, "", info) | ||
| } | ||
|
|
||
| func assertSparseGitInfo(t *testing.T, expectedRoot string, info git.RepositoryInfo) { | ||
| assert.Equal(t, "", info.CurrentBranch) | ||
| assert.Equal(t, "", info.LatestCommit) | ||
| assert.Equal(t, "", info.OriginURL) | ||
| assert.Equal(t, expectedRoot, info.WorktreeRoot) | ||
| } | ||
|
|
||
| func TestAccFetchRepositoryInfoAPI_FromRepo(t *testing.T) { | ||
| ctx, wt := acc.WorkspaceTest(t) | ||
| me, err := wt.W.CurrentUser.Me(ctx) | ||
| require.NoError(t, err) | ||
|
|
||
| targetPath := acc.RandomName(path.Join("/Workspace/Users", me.UserName, "/testing-clone-bundle-examples-")) | ||
| stdout, stderr := RequireSuccessfulRun(t, "repos", "create", examplesRepoUrl, examplesRepoProvider, "--path", targetPath) | ||
| t.Cleanup(func() { | ||
| RequireSuccessfulRun(t, "repos", "delete", targetPath) | ||
| }) | ||
|
|
||
| assert.Empty(t, stderr.String()) | ||
| assert.NotEmpty(t, stdout.String()) | ||
| ctx = dbr.MockRuntime(ctx, true) | ||
|
|
||
| for _, inputPath := range []string{ | ||
| path.Join(targetPath, "knowledge_base/dashboard_nyc_taxi"), | ||
| targetPath, | ||
| } { | ||
| t.Run(inputPath, func(t *testing.T) { | ||
| info, err := git.FetchRepositoryInfo(ctx, inputPath, wt.W) | ||
| assert.NoError(t, err) | ||
| assertFullGitInfo(t, targetPath, info) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestAccFetchRepositoryInfoAPI_FromNonRepo(t *testing.T) { | ||
| ctx, wt := acc.WorkspaceTest(t) | ||
| me, err := wt.W.CurrentUser.Me(ctx) | ||
| require.NoError(t, err) | ||
|
|
||
| rootPath := acc.RandomName(path.Join("/Workspace/Users", me.UserName, "testing-nonrepo-")) | ||
| _, stderr := RequireSuccessfulRun(t, "workspace", "mkdirs", path.Join(rootPath, "a/b/c")) | ||
| t.Cleanup(func() { | ||
| RequireSuccessfulRun(t, "workspace", "delete", "--recursive", rootPath) | ||
| }) | ||
|
|
||
| assert.Empty(t, stderr.String()) | ||
| ctx = dbr.MockRuntime(ctx, true) | ||
|
|
||
| tests := []struct { | ||
| input string | ||
| msg string | ||
| }{ | ||
| { | ||
| input: path.Join(rootPath, "a/b/c"), | ||
| msg: "", | ||
| }, | ||
| { | ||
| input: rootPath, | ||
| msg: "", | ||
| }, | ||
| { | ||
| input: path.Join(rootPath, "/non-existent"), | ||
| msg: "doesn't exist", | ||
| }, | ||
| } | ||
|
|
||
| for _, test := range tests { | ||
| t.Run(test.input+" <==> "+test.msg, func(t *testing.T) { | ||
| info, err := git.FetchRepositoryInfo(ctx, test.input, wt.W) | ||
| if test.msg == "" { | ||
| assert.NoError(t, err) | ||
| } else { | ||
| assert.Error(t, err) | ||
| assert.Contains(t, err.Error(), test.msg) | ||
| } | ||
| assertEmptyGitInfo(t, info) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestAccFetchRepositoryInfoDotGit_FromGitRepo(t *testing.T) { | ||
| ctx, wt := acc.WorkspaceTest(t) | ||
|
|
||
| repo := cloneRepoLocally(t, examplesRepoUrl) | ||
|
|
||
| for _, inputPath := range []string{ | ||
| filepath.Join(repo, "knowledge_base/dashboard_nyc_taxi"), | ||
| repo, | ||
| } { | ||
| t.Run(inputPath, func(t *testing.T) { | ||
| info, err := git.FetchRepositoryInfo(ctx, inputPath, wt.W) | ||
| assert.NoError(t, err) | ||
| assertFullGitInfo(t, repo, info) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func cloneRepoLocally(t *testing.T, repoUrl string) string { | ||
| tempDir := t.TempDir() | ||
| localRoot := filepath.Join(tempDir, "repo") | ||
|
|
||
| cmd := exec.Command("git", "clone", "--depth=1", examplesRepoUrl, localRoot) | ||
| err := cmd.Run() | ||
| require.NoError(t, err) | ||
| return localRoot | ||
| } | ||
|
|
||
| func TestAccFetchRepositoryInfoDotGit_FromNonGitRepo(t *testing.T) { | ||
| ctx, wt := acc.WorkspaceTest(t) | ||
|
|
||
| tempDir := t.TempDir() | ||
| root := filepath.Join(tempDir, "repo") | ||
| require.NoError(t, os.MkdirAll(filepath.Join(root, "a/b/c"), 0700)) | ||
|
|
||
| tests := []string{ | ||
| filepath.Join(root, "a/b/c"), | ||
| root, | ||
| filepath.Join(root, "/non-existent"), | ||
| } | ||
|
|
||
| for _, input := range tests { | ||
| t.Run(input, func(t *testing.T) { | ||
| info, err := git.FetchRepositoryInfo(ctx, input, wt.W) | ||
| assert.NoError(t, err) | ||
| assertEmptyGitInfo(t, info) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestAccFetchRepositoryInfoDotGit_FromBrokenGitRepo(t *testing.T) { | ||
| ctx, wt := acc.WorkspaceTest(t) | ||
|
|
||
| tempDir := t.TempDir() | ||
| root := filepath.Join(tempDir, "repo") | ||
| path := filepath.Join(root, "a/b/c") | ||
| require.NoError(t, os.MkdirAll(path, 0700)) | ||
| require.NoError(t, os.WriteFile(filepath.Join(root, ".git"), []byte(""), 0000)) | ||
|
|
||
| info, err := git.FetchRepositoryInfo(ctx, path, wt.W) | ||
| assert.NoError(t, err) | ||
| assertSparseGitInfo(t, root, info) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.