Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[1.3] Fix bbolt keys and bbolt get to prevent them from panicking when no parameter provided #683

Merged
merged 1 commit into from
Feb 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading