-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add gitbranch and sha into spaces payload (#4734)
- Loading branch information
Showing
14 changed files
with
286 additions
and
11 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
package runsummary | ||
|
||
import ( | ||
"github.com/vercel/turbo/cli/internal/ci" | ||
"github.com/vercel/turbo/cli/internal/env" | ||
"github.com/vercel/turbo/cli/internal/scm" | ||
"github.com/vercel/turbo/cli/internal/turbopath" | ||
) | ||
|
||
type scmState struct { | ||
Type string `json:"type"` | ||
Sha string `json:"sha"` | ||
Branch string `json:"branch"` | ||
} | ||
|
||
// getSCMState returns the sha and branch when in a git repo | ||
// Otherwise it should return empty strings right now. | ||
// We my add handling of other scms and non-git tracking in the future. | ||
func getSCMState(dir turbopath.AbsoluteSystemPath) *scmState { | ||
allEnvVars := env.GetEnvMap() | ||
|
||
state := &scmState{Type: "git"} | ||
|
||
// If we're in CI, try to get the values we need from environment variables | ||
if ci.IsCi() { | ||
vendor := ci.Info() | ||
state.Sha = allEnvVars[vendor.ShaEnvVar] | ||
state.Branch = allEnvVars[vendor.BranchEnvVar] | ||
} | ||
|
||
// Otherwise fallback to using `git` | ||
if state.Branch == "" { | ||
state.Branch = scm.GetCurrentBranch(dir) | ||
} | ||
|
||
if state.Sha == "" { | ||
state.Sha = scm.GetCurrentSha(dir) | ||
} | ||
|
||
return state | ||
} |
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,136 @@ | ||
package scm | ||
|
||
import ( | ||
"os" | ||
"os/exec" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/assert" | ||
"github.com/vercel/turbo/cli/internal/fs" | ||
"github.com/vercel/turbo/cli/internal/turbopath" | ||
) | ||
|
||
func TestGetCurrentBranchMain(t *testing.T) { | ||
targetbranch := "main" | ||
testDir := getTestDir(t, "myrepo") | ||
originalName, originalEmail := getOriginalConfig(testDir) | ||
|
||
// Setup git | ||
gitCommand(t, testDir, []string{"config", "--global", "user.email", "turbo@vercel.com"}) | ||
gitCommand(t, testDir, []string{"config", "--global", "user.name", "Turbobot"}) | ||
gitCommand(t, testDir, []string{"init"}) | ||
|
||
gitCommand(t, testDir, []string{"checkout", "-B", targetbranch}) | ||
branch := GetCurrentBranch(testDir) | ||
assert.Equal(t, branch, targetbranch) | ||
|
||
// cleanup | ||
gitRm(t, testDir) | ||
gitCommand(t, testDir, []string{"config", "--global", "user.email", originalEmail}) | ||
gitCommand(t, testDir, []string{"config", "--global", "user.name", originalName}) | ||
} | ||
|
||
func TestGetCurrentBranchNonMain(t *testing.T) { | ||
targetbranch := "mybranch" | ||
testDir := getTestDir(t, "myrepo") | ||
|
||
originalName, originalEmail := getOriginalConfig(testDir) | ||
|
||
// Setup git | ||
gitCommand(t, testDir, []string{"config", "--global", "user.email", "turbo@vercel.com"}) | ||
gitCommand(t, testDir, []string{"config", "--global", "user.name", "Turbobot"}) | ||
gitCommand(t, testDir, []string{"init"}) | ||
gitCommand(t, testDir, []string{"checkout", "-B", targetbranch}) | ||
|
||
branch := GetCurrentBranch(testDir) | ||
assert.Equal(t, branch, targetbranch) | ||
|
||
// cleanup | ||
gitRm(t, testDir) | ||
gitCommand(t, testDir, []string{"config", "--global", "user.email", originalEmail}) | ||
gitCommand(t, testDir, []string{"config", "--global", "user.name", originalName}) | ||
} | ||
|
||
func TestGetCurrentSHA(t *testing.T) { | ||
testDir := getTestDir(t, "myrepo") | ||
originalName, originalEmail := getOriginalConfig(testDir) | ||
|
||
// Setup git | ||
gitCommand(t, testDir, []string{"config", "--global", "user.email", "turbo@vercel.com"}) | ||
gitCommand(t, testDir, []string{"config", "--global", "user.name", "Turbobot"}) | ||
gitCommand(t, testDir, []string{"init"}) | ||
|
||
// initial sha is blank because there are no commits | ||
initSha := GetCurrentSha(testDir) | ||
assert.True(t, initSha == "", "initial sha is empty") | ||
|
||
// first commit | ||
gitCommand(t, testDir, []string{"commit", "--allow-empty", "-am", "new commit"}) | ||
sha1 := GetCurrentSha(testDir) | ||
assert.True(t, sha1 != "sha on commit 1 is not empty") | ||
|
||
// second commit | ||
gitCommand(t, testDir, []string{"commit", "--allow-empty", "-am", "new commit"}) | ||
sha2 := GetCurrentSha(testDir) | ||
assert.True(t, sha2 != "", "sha on commit 2 is not empty") | ||
assert.True(t, sha2 != sha1, "sha on commit 2 changes from commit 1") | ||
|
||
// cleanup | ||
gitRm(t, testDir) | ||
gitCommand(t, testDir, []string{"config", "--global", "user.email", originalEmail}) | ||
gitCommand(t, testDir, []string{"config", "--global", "user.name", originalName}) | ||
} | ||
|
||
// Helper functions | ||
func getTestDir(t *testing.T, testName string) turbopath.AbsoluteSystemPath { | ||
defaultCwd, err := os.Getwd() | ||
if err != nil { | ||
t.Errorf("failed to get cwd: %v", err) | ||
} | ||
cwd, err := fs.CheckedToAbsoluteSystemPath(defaultCwd) | ||
if err != nil { | ||
t.Fatalf("cwd is not an absolute directory %v: %v", defaultCwd, err) | ||
} | ||
|
||
return cwd.UntypedJoin("testdata", testName) | ||
} | ||
|
||
func gitRm(t *testing.T, dir turbopath.AbsoluteSystemPath) { | ||
cmd := exec.Command("rm", []string{"-rf", ".git"}...) | ||
cmd.Dir = dir.ToString() | ||
if out, err := cmd.Output(); err != nil { | ||
t.Fatalf("Failed to cleanup git dir: %s\n%v", out, err) | ||
} | ||
} | ||
|
||
func getOriginalConfig(cwd turbopath.AbsoluteSystemPath) (string, string) { | ||
// Ignore errors. If there was an error, it's likely because there was no value for these | ||
// configs (e.g. in CI), so git is returning non-zero status code. This is ok, and we'll use the | ||
// zero-value empty strings. | ||
name, _ := _gitCommand(cwd, []string{"config", "--global", "user.name"}) | ||
email, _ := _gitCommand(cwd, []string{"config", "--global", "user.name"}) | ||
|
||
return name, email | ||
} | ||
|
||
func gitCommand(t *testing.T, cwd turbopath.AbsoluteSystemPath, args []string) string { | ||
out, err := _gitCommand(cwd, args) | ||
|
||
if err != nil { | ||
t.Fatalf("Failed git command %s: %s\n%v", args, out, err) | ||
} | ||
|
||
return string(out) | ||
} | ||
|
||
func _gitCommand(cwd turbopath.AbsoluteSystemPath, args []string) (string, error) { | ||
cmd := exec.Command("git", args...) | ||
cmd.Dir = cwd.ToString() | ||
out, err := cmd.CombinedOutput() | ||
|
||
if err != nil { | ||
return "", err | ||
} | ||
|
||
return string(out), nil | ||
} |
Empty file.
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 |
---|---|---|
|
@@ -76,6 +76,7 @@ Setup | |
"globalCacheInputs", | ||
"id", | ||
"packages", | ||
"scm", | ||
"tasks", | ||
"turboVersion", | ||
"version" | ||
|
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
Oops, something went wrong.