From e8d3ae6287ff3e8efa8d3583bb805a3b8dd8e84f Mon Sep 17 00:00:00 2001 From: Ben Johnson Date: Fri, 21 Mar 2014 22:00:34 -0600 Subject: Add 'bolt get'. --- cmd/bolt/main_test.go | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 cmd/bolt/main_test.go (limited to 'cmd/bolt/main_test.go') diff --git a/cmd/bolt/main_test.go b/cmd/bolt/main_test.go new file mode 100644 index 0000000..5c70c97 --- /dev/null +++ b/cmd/bolt/main_test.go @@ -0,0 +1,75 @@ +package main_test + +import ( + "io/ioutil" + "os" + "strings" + "testing" + + "github.com/boltdb/bolt" + . "github.com/boltdb/bolt/cmd/bolt" + "github.com/stretchr/testify/assert" +) + +// Ensure that a value can be retrieved from the CLI. +func TestGet(t *testing.T) { + SetTestMode(true) + open(func(db *bolt.DB) { + db.Do(func(tx *bolt.Tx) error { + tx.CreateBucket("widgets") + tx.Bucket("widgets").Put([]byte("foo"), []byte("bar")) + return nil + }) + output := run("get", db.Path(), "widgets", "foo") + assert.Equal(t, "bar", output) + }) +} + +// Ensure that an error is reported if the database is not found. +func TestGetDBNotFound(t *testing.T) { + SetTestMode(true) + output := run("get", "no/such/db", "widgets", "foo") + assert.Equal(t, "stat no/such/db: no such file or directory", output) +} + +// Ensure that an error is reported if the bucket is not found. +func TestGetBucketNotFound(t *testing.T) { + SetTestMode(true) + open(func(db *bolt.DB) { + output := run("get", db.Path(), "widgets", "foo") + assert.Equal(t, "bucket not found: widgets", output) + }) +} + +// Ensure that an error is reported if the key is not found. +func TestGetKeyNotFound(t *testing.T) { + SetTestMode(true) + open(func(db *bolt.DB) { + db.Do(func(tx *bolt.Tx) error { + return tx.CreateBucket("widgets") + }) + output := run("get", db.Path(), "widgets", "foo") + assert.Equal(t, "key not found: foo", output) + }) +} + +// open creates and opens a Bolt database in the temp directory. +func open(fn func(*bolt.DB)) { + f, _ := ioutil.TempFile("", "bolt-") + f.Close() + os.Remove(f.Name()) + defer os.RemoveAll(f.Name()) + + db, err := bolt.Open(f.Name(), 0600) + if err != nil { + panic("db open error: " + err.Error()) + } + fn(db) +} + +// run executes a command against the CLI and returns the output. +func run(args ...string) string { + args = append([]string{"bolt"}, args...) + NewApp().Run(args) + return strings.TrimSpace(LogBuffer()) +} -- cgit v1.2.3 From 8fa6531b1cff8288d453dafa656753fb08192aeb Mon Sep 17 00:00:00 2001 From: Ben Johnson Date: Fri, 21 Mar 2014 22:05:28 -0600 Subject: Add 'bolt keys'. --- cmd/bolt/main.go | 46 +++++++++++++++++++++++++++++++++++++++++++--- cmd/bolt/main_test.go | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 75 insertions(+), 3 deletions(-) (limited to 'cmd/bolt/main_test.go') diff --git a/cmd/bolt/main.go b/cmd/bolt/main.go index 0a17a13..c29d5df 100644 --- a/cmd/bolt/main.go +++ b/cmd/bolt/main.go @@ -23,14 +23,19 @@ func NewApp() *cli.App { { Name: "get", Usage: "retrieve a value for given key", - Action: Get, + Action: GetCommand, + }, + { + Name: "keys", + Usage: "retrieve a list of all keys in a bucket", + Action: KeysCommand, }, } return app } -// Get retrieves the value for a given bucket/key. -func Get(c *cli.Context) { +// GetCommand retrieves the value for a given bucket/key. +func GetCommand(c *cli.Context) { path, name, key := c.Args().Get(0), c.Args().Get(1), c.Args().Get(2) if _, err := os.Stat(path); os.IsNotExist(err) { fatal(err) @@ -68,6 +73,41 @@ func Get(c *cli.Context) { } } +// KeysCommand retrieves a list of keys for a given bucket. +func KeysCommand(c *cli.Context) { + path, name := c.Args().Get(0), c.Args().Get(1) + if _, err := os.Stat(path); os.IsNotExist(err) { + fatal(err) + return + } + + db, err := bolt.Open(path, 0600) + if err != nil { + fatal(err) + return + } + defer db.Close() + + err = db.With(func(tx *bolt.Tx) error { + // Find bucket. + b := tx.Bucket(name) + if b == nil { + fatalf("bucket not found: %s", name) + return nil + } + + // Iterate over each key. + return b.ForEach(func(key, _ []byte) error { + logger.Println(string(key)) + return nil + }) + }) + if err != nil { + fatal(err) + return + } +} + var logger = log.New(os.Stderr, "", 0) var logBuffer *bytes.Buffer diff --git a/cmd/bolt/main_test.go b/cmd/bolt/main_test.go index 5c70c97..95b4df5 100644 --- a/cmd/bolt/main_test.go +++ b/cmd/bolt/main_test.go @@ -53,6 +53,38 @@ func TestGetKeyNotFound(t *testing.T) { }) } +// Ensure that a list of keys can be retrieved for a given bucket. +func TestKeys(t *testing.T) { + SetTestMode(true) + open(func(db *bolt.DB) { + db.Do(func(tx *bolt.Tx) error { + tx.CreateBucket("widgets") + tx.Bucket("widgets").Put([]byte("0002"), []byte("")) + tx.Bucket("widgets").Put([]byte("0001"), []byte("")) + tx.Bucket("widgets").Put([]byte("0003"), []byte("")) + return nil + }) + output := run("keys", db.Path(), "widgets") + assert.Equal(t, "0001\n0002\n0003", output) + }) +} + +// Ensure that an error is reported if the database is not found. +func TestKeysDBNotFound(t *testing.T) { + SetTestMode(true) + output := run("keys", "no/such/db", "widgets") + assert.Equal(t, "stat no/such/db: no such file or directory", output) +} + +// Ensure that an error is reported if the bucket is not found. +func TestKeysBucketNotFound(t *testing.T) { + SetTestMode(true) + open(func(db *bolt.DB) { + output := run("keys", db.Path(), "widgets") + assert.Equal(t, "bucket not found: widgets", output) + }) +} + // open creates and opens a Bolt database in the temp directory. func open(fn func(*bolt.DB)) { f, _ := ioutil.TempFile("", "bolt-") -- cgit v1.2.3 From 64a52452d32d2552c71bc4d4424b8a578a2103ed Mon Sep 17 00:00:00 2001 From: Ben Johnson Date: Fri, 21 Mar 2014 22:51:22 -0600 Subject: Add 'bolt set'. --- cmd/bolt/main.go | 43 ++++++++++++++++++++++++++++++++++++++++--- cmd/bolt/main_test.go | 29 +++++++++++++++++++++++++++++ 2 files changed, 69 insertions(+), 3 deletions(-) (limited to 'cmd/bolt/main_test.go') diff --git a/cmd/bolt/main.go b/cmd/bolt/main.go index 248884e..387ffa4 100644 --- a/cmd/bolt/main.go +++ b/cmd/bolt/main.go @@ -23,17 +23,22 @@ func NewApp() *cli.App { app.Commands = []cli.Command{ { Name: "get", - Usage: "retrieve a value for given key", + Usage: "Retrieve a value for given key in a bucket", Action: GetCommand, }, + { + Name: "set", + Usage: "Sets a value for given key in a bucket", + Action: SetCommand, + }, { Name: "keys", - Usage: "retrieve a list of all keys in a bucket", + Usage: "Retrieve a list of all keys in a bucket", Action: KeysCommand, }, { Name: "pages", - Usage: "dump page information for a database", + Usage: "Dumps page information for a database", Action: PagesCommand, }, } @@ -79,6 +84,38 @@ func GetCommand(c *cli.Context) { } } +// SetCommand sets the value for a given key in a bucket. +func SetCommand(c *cli.Context) { + path, name, key, value := c.Args().Get(0), c.Args().Get(1), c.Args().Get(2), c.Args().Get(3) + if _, err := os.Stat(path); os.IsNotExist(err) { + fatal(err) + return + } + + db, err := bolt.Open(path, 0600) + if err != nil { + fatal(err) + return + } + defer db.Close() + + err = db.Do(func(tx *bolt.Tx) error { + // Find bucket. + b := tx.Bucket(name) + if b == nil { + fatalf("bucket not found: %s", name) + return nil + } + + // Set value for a given key. + return b.Put([]byte(key), []byte(value)) + }) + if err != nil { + fatal(err) + return + } +} + // KeysCommand retrieves a list of keys for a given bucket. func KeysCommand(c *cli.Context) { path, name := c.Args().Get(0), c.Args().Get(1) diff --git a/cmd/bolt/main_test.go b/cmd/bolt/main_test.go index 95b4df5..1884dfa 100644 --- a/cmd/bolt/main_test.go +++ b/cmd/bolt/main_test.go @@ -53,6 +53,35 @@ func TestGetKeyNotFound(t *testing.T) { }) } +// Ensure that a value can be set from the CLI. +func TestSet(t *testing.T) { + SetTestMode(true) + open(func(db *bolt.DB) { + db.Do(func(tx *bolt.Tx) error { + tx.CreateBucket("widgets") + return nil + }) + assert.Equal(t, "", run("set", db.Path(), "widgets", "foo", "bar")) + assert.Equal(t, "bar", run("get", db.Path(), "widgets", "foo")) + }) +} + +// Ensure that an error is reported if the database is not found. +func TestSetDBNotFound(t *testing.T) { + SetTestMode(true) + output := run("set", "no/such/db", "widgets", "foo", "bar") + assert.Equal(t, "stat no/such/db: no such file or directory", output) +} + +// Ensure that an error is reported if the bucket is not found. +func TestSetBucketNotFound(t *testing.T) { + SetTestMode(true) + open(func(db *bolt.DB) { + output := run("set", db.Path(), "widgets", "foo", "bar") + assert.Equal(t, "bucket not found: widgets", output) + }) +} + // Ensure that a list of keys can be retrieved for a given bucket. func TestKeys(t *testing.T) { SetTestMode(true) -- cgit v1.2.3 From 845a4d47ce37cfe51e285e78430aa363dbbf1a59 Mon Sep 17 00:00:00 2001 From: Ben Johnson Date: Fri, 21 Mar 2014 22:56:17 -0600 Subject: Add 'bolt buckets'. --- cmd/bolt/main.go | 32 ++++++++++++++++++++++++++++++++ cmd/bolt/main_test.go | 22 ++++++++++++++++++++++ 2 files changed, 54 insertions(+) (limited to 'cmd/bolt/main_test.go') diff --git a/cmd/bolt/main.go b/cmd/bolt/main.go index 387ffa4..cfb9765 100644 --- a/cmd/bolt/main.go +++ b/cmd/bolt/main.go @@ -36,6 +36,11 @@ func NewApp() *cli.App { Usage: "Retrieve a list of all keys in a bucket", Action: KeysCommand, }, + { + Name: "buckets", + Usage: "Retrieves a list of all buckets", + Action: BucketsCommand, + }, { Name: "pages", Usage: "Dumps page information for a database", @@ -151,6 +156,33 @@ func KeysCommand(c *cli.Context) { } } +// BucketsCommand retrieves a list of all buckets. +func BucketsCommand(c *cli.Context) { + path := c.Args().Get(0) + if _, err := os.Stat(path); os.IsNotExist(err) { + fatal(err) + return + } + + db, err := bolt.Open(path, 0600) + if err != nil { + fatal(err) + return + } + defer db.Close() + + err = db.With(func(tx *bolt.Tx) error { + for _, b := range tx.Buckets() { + logger.Println(b.Name()) + } + return nil + }) + if err != nil { + fatal(err) + return + } +} + // PagesCommand prints a list of all pages in a database. func PagesCommand(c *cli.Context) { path := c.Args().Get(0) diff --git a/cmd/bolt/main_test.go b/cmd/bolt/main_test.go index 1884dfa..b755ccd 100644 --- a/cmd/bolt/main_test.go +++ b/cmd/bolt/main_test.go @@ -114,6 +114,28 @@ func TestKeysBucketNotFound(t *testing.T) { }) } +// Ensure that a list of buckets can be retrieved. +func TestBuckets(t *testing.T) { + SetTestMode(true) + open(func(db *bolt.DB) { + db.Do(func(tx *bolt.Tx) error { + tx.CreateBucket("woojits") + tx.CreateBucket("widgets") + tx.CreateBucket("whatchits") + return nil + }) + output := run("buckets", db.Path()) + assert.Equal(t, "whatchits\nwidgets\nwoojits", output) + }) +} + +// Ensure that an error is reported if the database is not found. +func TestBucketsDBNotFound(t *testing.T) { + SetTestMode(true) + output := run("buckets", "no/such/db") + assert.Equal(t, "stat no/such/db: no such file or directory", output) +} + // open creates and opens a Bolt database in the temp directory. func open(fn func(*bolt.DB)) { f, _ := ioutil.TempFile("", "bolt-") -- cgit v1.2.3