Skip to content

Commit

Permalink
Merge pull request #683 from Elbehery/backport_fix_cli_panics
Browse files Browse the repository at this point in the history
[1.3] Fix `bbolt keys` and `bbolt get` to prevent them from panicking when no parameter provided
  • Loading branch information
ahrtr authored Feb 1, 2024
2 parents e102fcf + 25dacb3 commit 50aef26
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
9 changes: 9 additions & 0 deletions cmd/bbolt/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@ var (

// ErrKeyNotFound is returned when a key is not found.
ErrKeyNotFound = errors.New("key not found")

// ErrNotEnoughArgs is returned with a cmd is being executed with fewer arguments.
ErrNotEnoughArgs = errors.New("not enough arguments")
)

func main() {
Expand Down Expand Up @@ -908,6 +911,9 @@ func (cmd *keysCommand) Run(args ...string) error {

// Require database path and bucket.
relevantArgs := fs.Args()
if len(relevantArgs) < 2 {
return ErrNotEnoughArgs
}
path, buckets := relevantArgs[0], relevantArgs[1:]
if path == "" {
return ErrPathRequired
Expand Down Expand Up @@ -993,6 +999,9 @@ func (cmd *getCommand) Run(args ...string) error {

// Require database path, bucket and key.
relevantArgs := fs.Args()
if len(relevantArgs) < 3 {
return ErrNotEnoughArgs
}
path, buckets := relevantArgs[0], relevantArgs[1:len(relevantArgs)-1]
key, err := parseBytes(relevantArgs[len(relevantArgs)-1], parseFormat)
if err != nil {
Expand Down
27 changes: 27 additions & 0 deletions cmd/bbolt/main_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,33 @@ func TestCompactCommand_Run(t *testing.T) {
}
}

func TestCommands_Run_NoArgs(t *testing.T) {
testCases := []struct {
name string
cmd string
expErr error
}{
{
name: "get",
cmd: "get",
expErr: main.ErrNotEnoughArgs,
},
{
name: "keys",
cmd: "keys",
expErr: main.ErrNotEnoughArgs,
},
}

for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
m := NewMain()
err := m.Run(tc.cmd)
require.ErrorIs(t, err, main.ErrNotEnoughArgs)
})
}
}

func fillBucket(b *bolt.Bucket, prefix []byte) error {
n := 10 + rand.Intn(50)
for i := 0; i < n; i++ {
Expand Down

0 comments on commit 50aef26

Please sign in to comment.