Skip to content
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
/timber
coverage.html
coverage.out
coverage-process.out
tmp/
4 changes: 3 additions & 1 deletion internal/cli/generate_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import (

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"github.com/nnutter/timber/internal/testenv"
)

func TestGenerateZshGeneratesWrapperCompletionAndAutoloadHelper(t *testing.T) {
Expand Down Expand Up @@ -156,7 +158,7 @@ func buildTestTimberBinary(t *testing.T) string {
require.NoError(t, err)
envKeys := []string{"GOMODCACHE", "GOCACHE", "GOPROXY", "GOTOOLCHAIN"}

build := shellTestCommand(t, "go", "build", "-o", filepath.Join(binDir, "timber"), ".")
build := shellTestCommand(t, "go", testenv.BuildArgs(filepath.Join(binDir, "timber"), ".")...)
build.Dir = repoRoot
// testCommand isolates HOME, which would empty the module and build
// caches; keep the real Go toolchain directories so the build stays
Expand Down
14 changes: 7 additions & 7 deletions internal/cli/review/activity_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,12 @@ import (
)

func TestReviewRunningReportsLiveLockNotPersistedAttempt(t *testing.T) {
binary := buildGitReview(t)
dir := featureRepo(t)
path, err := review.WorktreePath(t.Context(), dir)
require.NoError(t, err)
check := func(cwd string, running bool) {
t.Helper()
out, terminal, err := executeBinary(t, binary, cwd, "status", "--is-reviewing", "--json")
out, terminal, err := execute(t, cwd, "status", "--is-reviewing", "--json")
require.NoError(t, err)
require.Empty(t, terminal)
want := `{"version":1,"command":"status","is_reviewing":false}`
Expand Down Expand Up @@ -82,35 +81,36 @@ while [ ! -f "$TEST_RELEASED" ]; do sleep 0.05; done`)
check(other, false)
// A detached checkout without rebase metadata has no branch to check.
git(t, dir, "checkout", "--detach")
out, terminal, err := executeBinary(t, binary, dir, "status", "--is-reviewing", "--json")
out, terminal, err := execute(t, dir, "status", "--is-reviewing", "--json")
require.Error(t, err)
require.Empty(t, terminal)
require.Contains(t, out, `"status":"error"`)
}

func TestReviewRunningOutsideRepository(t *testing.T) {
t.Parallel()
out, terminal, err := execute(t, t.TempDir(), "status", "--is-reviewing", "--json")
require.Error(t, err)
require.Empty(t, terminal)
require.Contains(t, out, `"status":"error"`)
}

func TestStatusIsReviewingTerminalAndConflicts(t *testing.T) {
binary := buildGitReview(t)
t.Parallel()
dir := featureRepo(t)
out, terminal, err := executeBinary(t, binary, dir, "status", "--is-reviewing")
out, terminal, err := execute(t, dir, "status", "--is-reviewing")
require.NoError(t, err)
require.Empty(t, terminal)
require.Contains(t, out, "Is reviewing: false")
out, terminal, err = executeBinary(t, binary, dir, "status", "--is-reviewing", "--json")
out, terminal, err = execute(t, dir, "status", "--is-reviewing", "--json")
require.NoError(t, err)
require.Empty(t, terminal)
require.Contains(t, out, `"is_reviewing"`)
for _, args := range [][]string{
{"status", "--is-reviewing", "--needs-review", "--json"},
{"status", "--is-reviewing", "--verbose", "--json"},
} {
out, terminal, err := executeBinary(t, binary, dir, args...)
out, terminal, err := execute(t, dir, args...)
require.Error(t, err)
require.Empty(t, terminal)
require.Contains(t, out, `"status":"error"`)
Expand Down
4 changes: 3 additions & 1 deletion internal/cli/review/binary_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@ import (
"testing"

"github.com/stretchr/testify/require"

"github.com/nnutter/timber/internal/testenv"
)

func buildGitReview(t *testing.T) string {
t.Helper()
binary := filepath.Join(t.TempDir(), "git-review")
cmd := exec.CommandContext(t.Context(), "go", "build", "-o", binary, "./testdata/standalone")
cmd := exec.CommandContext(t.Context(), "go", testenv.BuildArgs(binary, "./testdata/standalone")...)
out, err := cmd.CombinedOutput()
require.NoError(t, err, "%s", out)
return binary
Expand Down
68 changes: 38 additions & 30 deletions internal/cli/review/cli_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,45 +47,56 @@ func execute(t *testing.T, dir string, args ...string) (string, string, error) {
return output.String(), terminal.String(), err
}

func TestCommandsShareStructuredResults(t *testing.T) {
func TestGitDispatchesReviewSubcommand(t *testing.T) {
binary := buildGitReview(t)
dir := featureRepo(t)
t.Setenv("PATH", filepath.Dir(binary)+string(os.PathListSeparator)+os.Getenv("PATH"))
for _, tc := range []struct {
binary string
args []string
}{
{binary: binary, args: []string{"status", "--needs-review", "--json"}},
{binary: binary, args: []string{"--json", "status", "--needs-review"}},
{binary: "git", args: []string{"review", "status", "--needs-review", "--json"}},
out, terminal, err := executeBinary(t, "git", dir, "review", "status", "--needs-review", "--json")
require.NoError(t, err, "%s", terminal)
require.Empty(t, terminal)
checkNeedsReviewJSON(t, out)
}

func checkNeedsReviewJSON(t *testing.T, out string) {
t.Helper()
require.Equal(t, 1, strings.Count(out, "\n"))
var result review.Result
require.NoError(t, json.Unmarshal([]byte(out), &result))
require.Equal(t, "status", result.Command)
require.Len(t, result.Entries, 1)
require.Equal(t, "needs_review", result.Entries[0].Status)
require.Len(t, result.Entries[0].Stack.Commits[0], 40)
require.NotContains(t, out, "\x1b")
}

func TestCommandsShareStructuredResults(t *testing.T) {
t.Parallel()
dir := featureRepo(t)
for _, args := range [][]string{
{"status", "--needs-review", "--json"},
{"--json", "status", "--needs-review"},
} {
out, terminal, err := executeBinary(t, tc.binary, dir, tc.args...)
require.NoError(t, err, "command: %s %v\nstdout: %s\nstderr: %s", tc.binary, tc.args, out, terminal)
out, terminal, err := execute(t, dir, args...)
require.NoError(t, err, "command: %v\nstdout: %s\nstderr: %s", args, out, terminal)
require.Empty(t, terminal)
require.Equal(t, 1, strings.Count(out, "\n"))
var result review.Result
require.NoError(t, json.Unmarshal([]byte(out), &result))
require.Equal(t, "status", result.Command)
require.Equal(t, "needs_review", result.Entries[0].Status)
require.Len(t, result.Entries[0].Stack.Commits[0], 40)
require.NotContains(t, out, "\x1b")
checkNeedsReviewJSON(t, out)
}
out, terminal, err := executeBinary(t, binary, dir, "status", "--needs-review")
out, terminal, err := execute(t, dir, "status", "--needs-review")
require.NoError(t, err)
require.Empty(t, terminal)
require.Contains(t, out, "Needs review")
require.Contains(t, out, "Add feature")
require.Contains(t, out, "COMMITS (inclusive)")
require.NotContains(t, out, "Approved stacks are omitted from this summary.")
out, terminal, err = executeBinary(t, binary, dir, "confirm", "HEAD", "--json")
out, terminal, err = execute(t, dir, "confirm", "HEAD", "--json")
require.NoError(t, err)
require.Empty(t, terminal)
var approved review.Result
require.NoError(t, json.Unmarshal([]byte(out), &approved))
require.Equal(t, "approved", approved.Status)
require.Equal(t, "approve", approved.Command)
require.Equal(t, "user-command", approved.Entries[0].Attempt.ApprovalSource)
out, _, err = executeBinary(t, binary, dir, "status", "--needs-review", "--json")
out, _, err = execute(t, dir, "status", "--needs-review", "--json")
require.NoError(t, err)
var listed review.Result
require.NoError(t, json.Unmarshal([]byte(out), &listed))
Expand All @@ -94,7 +105,7 @@ func TestCommandsShareStructuredResults(t *testing.T) {
}

func TestJSONErrorsIncludeArgumentAndGitFailures(t *testing.T) {
binary := buildGitReview(t)
t.Parallel()
dir := featureRepo(t)
git(t, dir, "branch", "--unset-upstream")
for _, args := range [][]string{
Expand All @@ -104,10 +115,8 @@ func TestJSONErrorsIncludeArgumentAndGitFailures(t *testing.T) {
{"not-a-command", "--json"},
{"--json", "status", "--needs-review", "--unknown"},
} {
out, terminal, err := executeBinary(t, binary, dir, args...)
var exit *exec.ExitError
require.ErrorAs(t, err, &exit)
require.Equal(t, 1, exit.ExitCode())
out, terminal, err := execute(t, dir, args...)
require.Error(t, err)
require.Empty(t, terminal)
require.Equal(t, 1, strings.Count(out, "\n"))
var result display.ErrorResult
Expand Down Expand Up @@ -166,6 +175,7 @@ func TestReviewAliasResumesTheInterruptedAttempt(t *testing.T) {
}

func TestTerminalRenderingRetainsFeedbackAndRemovesControlSequences(t *testing.T) {
t.Parallel()
dir := featureRepo(t)
view, err := (review.Repository{Dir: dir}).Snapshot(t.Context())
require.NoError(t, err)
Expand Down Expand Up @@ -202,10 +212,7 @@ func TestTuicrKeepsWorktreeLockedAfterGitReviewDies(t *testing.T) {
t.Setenv("XDG_CACHE_HOME", t.TempDir())
t.Setenv("XDG_DATA_HOME", t.TempDir())
bin := t.TempDir()
binary := filepath.Join(bin, "review-test")
build := exec.CommandContext(t.Context(), "go", "build", "-o", binary, "./testdata/standalone")
buildOut, err := build.CombinedOutput()
require.NoError(t, err, "%s", buildOut)
binary := buildGitReview(t)
started := filepath.Join(bin, "started")
exitFile := filepath.Join(bin, "exit")
t.Setenv("TEST_STARTED", started)
Expand All @@ -226,7 +233,7 @@ func TestTuicrKeepsWorktreeLockedAfterGitReviewDies(t *testing.T) {
return string(data) == "finished"
}, 5*time.Second, 10*time.Millisecond)
}()
require.Eventually(t, func() bool { _, err := os.Stat(started); return err == nil }, 5*time.Second, 10*time.Millisecond)
require.Eventually(t, func() bool { _, err := os.Stat(started); return err == nil }, 30*time.Second, 10*time.Millisecond, "tuicr did not start")
require.NoError(t, cmd.Process.Kill())
require.Error(t, cmd.Wait())
out, _, err := execute(t, dir, "commits", "--json")
Expand All @@ -237,6 +244,7 @@ func TestTuicrKeepsWorktreeLockedAfterGitReviewDies(t *testing.T) {
}

func TestHelpAndVersion(t *testing.T) {
t.Parallel()
out, _, err := execute(t, t.TempDir(), "--help")
require.NoError(t, err)
require.Contains(t, out, "approve")
Expand Down
5 changes: 2 additions & 3 deletions internal/cli/review/commitmsg_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ import (
// `timber hooks commit-msg` that earlier installed hooks still call.

func TestCommitMsgMatchesGerritHook(t *testing.T) {
binary := buildGitReview(t)
reference, err := filepath.Abs("testdata/commit-msg")
require.NoError(t, err)
t.Setenv("GIT_COMMITTER_DATE", "2001-02-03T04:05:06 +0000")
Expand Down Expand Up @@ -59,7 +58,7 @@ func TestCommitMsgMatchesGerritHook(t *testing.T) {
cmd := exec.CommandContext(t.Context(), "sh", reference, "reference message")
cmd.Dir = dir
refOut, refErr := cmd.CombinedOutput()
out, stderr, actualErr := executeBinary(t, binary, dir, "commit-msg", "actual message")
out, stderr, actualErr := execute(t, dir, "commit-msg", "actual message")
require.Equal(t, refErr == nil, actualErr == nil, "reference: %s; actual: %s", refOut, stderr)
require.Empty(t, out)
expected, err := os.ReadFile(filepath.Join(dir, "reference message"))
Expand All @@ -68,7 +67,7 @@ func TestCommitMsgMatchesGerritHook(t *testing.T) {
require.NoError(t, err)
require.Equal(t, string(expected), string(actual))
if actualErr == nil {
_, stderr, err = executeBinary(t, binary, dir, "commit-msg", "actual message")
_, stderr, err = execute(t, dir, "commit-msg", "actual message")
require.NoError(t, err, "%s", stderr)
again, err := os.ReadFile(filepath.Join(dir, "actual message"))
require.NoError(t, err)
Expand Down
2 changes: 1 addition & 1 deletion internal/cli/review/commits/commits.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func (c *Command) runReview(ctx context.Context, options review.ReviewOptions, c
if flag, err := cmd.Flags().GetBool("json"); err == nil {
asJSON = flag
}
reader, err := review.DefaultSavedReader()
reader, err := review.DefaultSavedReader(c.Service.Repository.Environment)
if err != nil {
return err
}
Expand Down
9 changes: 5 additions & 4 deletions internal/cli/review/feedback_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import (
)

func TestFeedbackReadsPersistedCurrentAndHistoricalNotes(t *testing.T) {
binary := buildGitReview(t)
t.Parallel()
dir := featureRepo(t)
repository := review.Repository{Dir: dir}
original, err := repository.Snapshot(t.Context())
Expand Down Expand Up @@ -41,7 +41,7 @@ func TestFeedbackReadsPersistedCurrentAndHistoricalNotes(t *testing.T) {
before, err := os.ReadFile(changed.Path)
require.NoError(t, err)
for _, args := range [][]string{{"feedback", "--json"}, {"--json", "feedback"}} {
out, terminal, err := executeBinary(t, binary, dir, args...)
out, terminal, err := execute(t, dir, args...)
require.NoError(t, err)
require.Empty(t, terminal)
var result review.Result
Expand All @@ -62,7 +62,7 @@ func TestFeedbackReadsPersistedCurrentAndHistoricalNotes(t *testing.T) {
require.Equal(t, "Explain the change", *saved.SessionNotes)
}
}
out, terminal, err := executeBinary(t, binary, dir, "feedback")
out, terminal, err := execute(t, dir, "feedback")
require.NoError(t, err)
require.Empty(t, terminal)
require.Contains(t, out, "Historical feedback: removed-stack")
Expand All @@ -80,7 +80,7 @@ func TestFeedbackReadsPersistedCurrentAndHistoricalNotes(t *testing.T) {
state.Attempts[3].Replacement = &changed.Stacks[0]
return nil
}))
out, _, err = executeBinary(t, binary, dir, "feedback", "--json")
out, _, err = execute(t, dir, "feedback", "--json")
require.NoError(t, err)
var result review.Result
require.NoError(t, json.Unmarshal([]byte(out), &result))
Expand All @@ -93,6 +93,7 @@ func TestFeedbackReadsPersistedCurrentAndHistoricalNotes(t *testing.T) {
}

func TestFeedbackDoesNotLaunchOrRecoverReviews(t *testing.T) {
t.Parallel()
dir := featureRepo(t)
view, err := (review.Repository{Dir: dir}).Snapshot(t.Context())
require.NoError(t, err)
Expand Down
2 changes: 1 addition & 1 deletion internal/cli/review/files/files.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ func (c *Command) RunE(cmd *cobra.Command, args []string) error {
if flag, err := cmd.Flags().GetBool("json"); err == nil {
asJSON = flag
}
reader, err := review.DefaultSavedReader()
reader, err := review.DefaultSavedReader(c.Service.Repository.Environment)
if err != nil {
return err
}
Expand Down
38 changes: 6 additions & 32 deletions internal/cli/review/files_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import (
"encoding/json/v2"
"os"
"path/filepath"
"strings"
"testing"

"github.com/stretchr/testify/require"
Expand Down Expand Up @@ -42,6 +41,7 @@ func TestFilesCommandArgMapping(t *testing.T) {
require.Equal(t, 1, result.Version)
require.Equal(t, "files", result.Command)
require.Equal(t, "cancelled", result.Status)
require.Nil(t, result.Review)
launch, err := os.ReadFile(log)
require.NoError(t, err)
require.Equal(t, tc.wantArgs+"\n", string(launch))
Expand Down Expand Up @@ -78,26 +78,6 @@ func TestFilesUpstreamAndEmptyRange(t *testing.T) {
require.ErrorIs(t, err, os.ErrNotExist)
}

func TestFilesCommandDistinguishesCommits(t *testing.T) {
dir := featureRepo(t)
t.Setenv("XDG_CACHE_HOME", t.TempDir())
t.Setenv("XDG_DATA_HOME", t.TempDir())
bin := t.TempDir()
require.NoError(t, os.WriteFile(filepath.Join(bin, "tuicr"), []byte("#!/bin/sh\nexit 0\n"), 0o700))
t.Setenv("PATH", bin+string(os.PathListSeparator)+os.Getenv("PATH"))
commitsOut, _, err := execute(t, dir, "commits", "--json")
require.NoError(t, err)
var commits review.Result
require.NoError(t, json.Unmarshal([]byte(commitsOut), &commits))
require.Equal(t, "commits", commits.Command)
filesOut, _, err := execute(t, dir, "files", "--json")
require.NoError(t, err)
var files review.FilesResult
require.NoError(t, json.Unmarshal([]byte(filesOut), &files))
require.Equal(t, "files", files.Command)
require.NotEqual(t, commits.Command, files.Command)
}

func TestFilesCommandTerminalAndErrors(t *testing.T) {
dir := featureRepo(t)
t.Setenv("XDG_CACHE_HOME", t.TempDir())
Expand Down Expand Up @@ -151,25 +131,19 @@ func TestFilesHoldsWorktreeLock(t *testing.T) {
started := filepath.Join(bin, "started")
require.NoError(t, os.WriteFile(filepath.Join(bin, "tuicr"), []byte("#!/bin/sh\nprintf started > \""+started+"\"\nsleep 3\n"), 0o700))
t.Setenv("PATH", bin+string(os.PathListSeparator)+os.Getenv("PATH"))
// Launch files in background via binary to check lock held during TUI.
binary := buildGitReview(t)
t.Setenv("PATH", filepath.Dir(binary)+string(os.PathListSeparator)+os.Getenv("PATH"))
done := make(chan struct{})
done := make(chan error, 1)
go func() {
defer close(done)
out, _, _ := executeBinary(t, binary, dir, "files", "--json")
if strings.Contains(out, `"status":"cancelled"`) {
return
}
_, _, err := execute(t, dir, "files", "--json")
done <- err
}()
require.Eventually(t, func() bool {
_, err := os.Stat(started)
return err == nil
}, 5_000_000_000, 10_000_000)
// While files holds the repository-wide lock, status --is-reviewing
// reports true, just as it does during a commits review.
out, _, err := executeBinary(t, binary, dir, "status", "--is-reviewing", "--json")
out, _, err := execute(t, dir, "status", "--is-reviewing", "--json")
require.NoError(t, err)
require.Contains(t, out, `"is_reviewing":true`)
<-done
require.NoError(t, <-done)
}
Loading
Loading