Skip to content

Commit e62b539

Browse files
mceplmcepl
committed
feat(cli): add verbose output to push and pull commands
Add -v/--verbose flag to git-bug push and pull commands for better user visibility and debugging. - push command: verbose mode logs push details to stderr - pull command: verbose mode logs each operation to stderr, normal mode shows summary - Added comprehensive test coverage for both commands - Documentation updated automatically via build system
1 parent cf47635 commit e62b539

9 files changed

Lines changed: 228 additions & 12 deletions

File tree

‎commands/pull.go‎

Lines changed: 65 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,31 @@ import (
77

88
"github.com/git-bug/git-bug/commands/completion"
99
"github.com/git-bug/git-bug/commands/execenv"
10+
"github.com/git-bug/git-bug/entities/bug"
11+
"github.com/git-bug/git-bug/entities/identity"
1012
"github.com/git-bug/git-bug/entity"
1113
)
1214

1315
func newPullCommand(env *execenv.Env) *cobra.Command {
16+
var verbose bool
17+
1418
cmd := &cobra.Command{
1519
Use: "pull [REMOTE]",
1620
Short: "Pull updates from a git remote",
1721
PreRunE: execenv.LoadBackend(env),
1822
RunE: execenv.CloseBackend(env, func(cmd *cobra.Command, args []string) error {
19-
return runPull(env, args)
23+
return runPull(env, args, verbose)
2024
}),
2125
ValidArgsFunction: completion.GitRemote(env),
2226
}
2327

28+
flags := cmd.Flags()
29+
flags.BoolVarP(&verbose, "verbose", "v", false, "log each operation to stderr")
30+
2431
return cmd
2532
}
2633

27-
func runPull(env *execenv.Env, args []string) error {
34+
func runPull(env *execenv.Env, args []string, verbose bool) error {
2835
if len(args) > 1 {
2936
return errors.New("Only pulling from one remote at a time is supported")
3037
}
@@ -34,24 +41,75 @@ func runPull(env *execenv.Env, args []string) error {
3441
remote = args[0]
3542
}
3643

37-
env.Out.Println("Fetching remote ...")
44+
if verbose {
45+
env.Err.Println("Fetching remote ...")
46+
} else {
47+
env.Out.Println("Fetching remote ...")
48+
}
3849

3950
stdout, err := env.Backend.Fetch(remote)
4051
if err != nil {
4152
return err
4253
}
4354

44-
env.Out.Println(stdout)
55+
if verbose {
56+
env.Err.Println(stdout)
57+
env.Err.Println("Merging data ...")
58+
} else {
59+
env.Out.Println(stdout)
60+
env.Out.Println("Merging data ...")
61+
}
4562

46-
env.Out.Println("Merging data ...")
63+
// Track statistics
64+
newBugs := 0
65+
updatedBugs := 0
66+
newIdentities := 0
67+
updatedIdentities := 0
4768

4869
for result := range env.Backend.MergeAll(remote) {
4970
if result.Err != nil {
50-
env.Err.Println(result.Err)
71+
if verbose {
72+
env.Err.Printf("Error: %v\n", result.Err)
73+
} else {
74+
env.Err.Println(result.Err)
75+
}
76+
continue
5177
}
5278

5379
if result.Status != entity.MergeStatusNothing {
54-
env.Out.Printf("%s: %s\n", result.Id.Human(), result)
80+
if verbose {
81+
env.Err.Printf("%s: %s\n", result.Id.Human(), result)
82+
} else {
83+
env.Out.Printf("%s: %s\n", result.Id.Human(), result)
84+
}
85+
86+
// Count entity changes by checking the entity type
87+
if result.Entity != nil {
88+
switch result.Entity.(type) {
89+
case *bug.Bug:
90+
if result.Status == entity.MergeStatusNew {
91+
newBugs++
92+
} else if result.Status == entity.MergeStatusUpdated {
93+
updatedBugs++
94+
}
95+
case *identity.Identity:
96+
if result.Status == entity.MergeStatusNew {
97+
newIdentities++
98+
} else if result.Status == entity.MergeStatusUpdated {
99+
updatedIdentities++
100+
}
101+
}
102+
}
103+
}
104+
}
105+
106+
// Print summary
107+
if !verbose {
108+
if newBugs > 0 || updatedBugs > 0 || newIdentities > 0 || updatedIdentities > 0 {
109+
env.Out.Printf("Summary: %d new bugs, %d updated bugs, %d new identities, %d updated identities\n",
110+
newBugs, updatedBugs, newIdentities, updatedIdentities)
111+
} else {
112+
env.Out.Println("No new changes")
55113
}
56114
}
57115

‎commands/pull_test.go‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
package commands
2+
3+
import (
4+
"testing"
5+
6+
"github.com/stretchr/testify/require"
7+
8+
"github.com/git-bug/git-bug/commands/execenv"
9+
)
10+
11+
func TestPullVerbose(t *testing.T) {
12+
env := execenv.NewTestEnv(t)
13+
14+
// Test without verbose with no remotes (should fail with some kind of error)
15+
err := runPull(env, []string{"nonexistent"}, false)
16+
require.Error(t, err)
17+
stdout := env.Out.String()
18+
stderr := env.Err.String()
19+
20+
// In non-verbose mode, should see normal output on stdout
21+
require.NotEmpty(t, stdout)
22+
require.Contains(t, stdout, "Fetching remote ...")
23+
// Error happens before "Merging data ..." is printed
24+
25+
// Reset buffers
26+
env.Out.Reset()
27+
env.Err.Reset()
28+
29+
// Test with verbose with same error
30+
err = runPull(env, []string{"nonexistent"}, true)
31+
require.Error(t, err)
32+
33+
stdout = env.Out.String()
34+
stderr = env.Err.String()
35+
36+
// In verbose mode, should have verbose output to stderr
37+
require.Empty(t, stdout)
38+
require.NotEmpty(t, stderr)
39+
require.Contains(t, stderr, "Fetching remote ...")
40+
// Error happens before "Merging data ..." is printed
41+
}
42+
43+
func TestPullOutputModes(t *testing.T) {
44+
env := execenv.NewTestEnv(t)
45+
46+
// Test default to origin when no remote specified (non-verbose)
47+
err := runPull(env, []string{}, false)
48+
require.Error(t, err) // Should fail since no origin remote exists
49+
50+
stdout := env.Out.String()
51+
52+
// In non-verbose mode, should show normal output on stdout
53+
require.NotEmpty(t, stdout)
54+
require.Contains(t, stdout, "Fetching remote ...")
55+
// Error happens before "Merging data ..." is printed
56+
57+
// Reset buffers
58+
env.Out.Reset()
59+
env.Err.Reset()
60+
61+
// Test with verbose flag
62+
err = runPull(env, []string{}, true)
63+
require.Error(t, err)
64+
65+
stdout = env.Out.String()
66+
stderr := env.Err.String()
67+
68+
// In verbose mode, normal output goes to stderr
69+
require.Empty(t, stdout)
70+
require.NotEmpty(t, stderr)
71+
require.Contains(t, stderr, "Fetching remote ...")
72+
}
73+
74+
func TestPullTooManyRemotes(t *testing.T) {
75+
env := execenv.NewTestEnv(t)
76+
77+
// Test with too many remotes
78+
err := runPull(env, []string{"remote1", "remote2"}, false)
79+
require.Error(t, err)
80+
require.Contains(t, err.Error(), "Only pulling from one remote at a time is supported")
81+
}

‎commands/push.go‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,25 @@ import (
1010
)
1111

1212
func newPushCommand(env *execenv.Env) *cobra.Command {
13+
var verbose bool
14+
1315
cmd := &cobra.Command{
1416
Use: "push [REMOTE]",
1517
Short: "Push updates to a git remote",
1618
PreRunE: execenv.LoadBackend(env),
1719
RunE: execenv.CloseBackend(env, func(cmd *cobra.Command, args []string) error {
18-
return runPush(env, args)
20+
return runPush(env, args, verbose)
1921
}),
2022
ValidArgsFunction: completion.GitRemote(env),
2123
}
2224

25+
flags := cmd.Flags()
26+
flags.BoolVarP(&verbose, "verbose", "v", false, "log each operation to stderr")
27+
2328
return cmd
2429
}
2530

26-
func runPush(env *execenv.Env, args []string) error {
31+
func runPush(env *execenv.Env, args []string, verbose bool) error {
2732
if len(args) > 1 {
2833
return errors.New("Only pushing to one remote at a time is supported")
2934
}
@@ -38,7 +43,12 @@ func runPush(env *execenv.Env, args []string) error {
3843
return err
3944
}
4045

41-
env.Out.Println(stdout)
46+
if verbose {
47+
env.Err.Println("Pushing to remote:", remote)
48+
env.Err.Println(stdout)
49+
} else {
50+
env.Out.Println(stdout)
51+
}
4252

4353
return nil
4454
}

‎commands/push_test.go‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
package commands
2+
3+
import (
4+
"testing"
5+
6+
"github.com/stretchr/testify/require"
7+
8+
"github.com/git-bug/git-bug/commands/execenv"
9+
)
10+
11+
func TestPushVerbose(t *testing.T) {
12+
env := execenv.NewTestEnv(t)
13+
14+
// Test that both verbose and non-verbose handle errors similarly
15+
// (they return early on error)
16+
17+
// Test without verbose with no remotes (should fail with some kind of error)
18+
err := runPush(env, []string{"nonexistent"}, false)
19+
require.Error(t, err)
20+
21+
// Reset buffers
22+
env.Out.Reset()
23+
env.Err.Reset()
24+
25+
// Test with verbose with same error
26+
err = runPush(env, []string{"nonexistent"}, true)
27+
require.Error(t, err)
28+
29+
// Both should fail early without much output
30+
stdout := env.Out.String()
31+
stderr := env.Err.String()
32+
require.Empty(t, stdout)
33+
require.Empty(t, stderr)
34+
}
35+
36+
func TestPushDefaultRemote(t *testing.T) {
37+
env := execenv.NewTestEnv(t)
38+
39+
// Test default to origin when no remote specified
40+
err := runPush(env, []string{}, false)
41+
require.Error(t, err) // Should fail since no origin remote exists
42+
}
43+
44+
func TestPushTooManyRemotes(t *testing.T) {
45+
env := execenv.NewTestEnv(t)
46+
47+
// Test with too many remotes
48+
err := runPush(env, []string{"remote1", "remote2"}, false)
49+
require.Error(t, err)
50+
require.Contains(t, err.Error(), "Only pushing to one remote at a time is supported")
51+
}

‎doc/man/git-bug-pull.1‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ Pull updates from a git remote
1717
\fB-h\fP, \fB--help\fP[=false]
1818
help for pull
1919

20+
.PP
21+
\fB-v\fP, \fB--verbose\fP[=false]
22+
log each operation to stderr
23+
2024

2125
.SH SEE ALSO
2226
\fBgit-bug(1)\fP

‎doc/man/git-bug-push.1‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ Push updates to a git remote
1717
\fB-h\fP, \fB--help\fP[=false]
1818
help for push
1919

20+
.PP
21+
\fB-v\fP, \fB--verbose\fP[=false]
22+
log each operation to stderr
23+
2024

2125
.SH SEE ALSO
2226
\fBgit-bug(1)\fP

‎doc/md/git-bug_pull.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ git-bug pull [REMOTE] [flags]
99
### Options
1010

1111
```
12-
-h, --help help for pull
12+
-h, --help help for pull
13+
-v, --verbose log each operation to stderr
1314
```
1415

1516
### SEE ALSO

‎doc/md/git-bug_push.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ git-bug push [REMOTE] [flags]
99
### Options
1010

1111
```
12-
-h, --help help for push
12+
-h, --help help for push
13+
-v, --verbose log each operation to stderr
1314
```
1415

1516
### SEE ALSO

‎package-lock.json‎

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)