refactor(waltr): add kv to the application

Author: mvprowess

cmd/waltr/main.go

@@ -4,7 +4,9 @@ import (
 	"github.com/fmjstudios/gopskit/internal/waltr/app"
 	"github.com/fmjstudios/gopskit/internal/waltr/cmd"
 	_ "github.com/fmjstudios/gopskit/pkg/stamp"
+	"golang.org/x/sync/errgroup"
 	"log"
+	"os"
 )
 
 func main() {
@@ -17,4 +19,16 @@ func main() {
 	if err := cmdRoot.Execute(); err != nil {
 		kern.Log.Fatalf("%s exited with error: %v\n", kern.Name, err)
 	}
+
+	g := new(errgroup.Group)
+	g.Go(func() error {
+		return kern.KV.Close()
+	})
+
+	err = g.Wait()
+	if err != nil {
+		log.Fatalf("could not shut down waltr database connection: %v", err)
+	}
+
+	os.Exit(0)
 }

internal/waltr/app/app.go

@@ -4,9 +4,11 @@ import (
 	"fmt"
 	"github.com/fmjstudios/gopskit/pkg/core"
 	"github.com/fmjstudios/gopskit/pkg/fs"
+	"github.com/fmjstudios/gopskit/pkg/kv"
 	"github.com/fmjstudios/gopskit/pkg/log"
 	"github.com/fmjstudios/gopskit/pkg/proc"
 	"github.com/spf13/cobra"
+	"path/filepath"
 	"time"
 
 	"github.com/fmjstudios/gopskit/pkg/kube"
@@ -60,6 +62,13 @@ func New(opts ...Opt) (*State, error) {
 		return nil, fmt.Errorf("could not create kubernetes client: %v", err)
 	}
 
+	// embedded BadgerDB database
+	dbpath := filepath.Join(platf.Data, "data")
+	db, err := kv.New(dbpath)
+	if err != nil {
+		return nil, err
+	}
+
 	// enforce HTTPS
 	va := fmt.Sprintf("https://127.0.0.1:%s", kube.DefaultLocalPort)
 	vc, err := vault.New(vault.WithAddress(va), vault.WithRequestTimeout(60*time.Second), vault.WithTLS(vault.TLSConfiguration{
@@ -77,6 +86,7 @@ func New(opts ...Opt) (*State, error) {
 			Exec:  exec,
 			Kube:  kc,
 			Log:   lgr,
+			KV:    db,
 			Paths: platf,
 			Stamp: stamps,
 		},

pkg/core/api.go

@@ -3,6 +3,7 @@ package core
 import (
 	"github.com/fmjstudios/gopskit/pkg/fs"
 	"github.com/fmjstudios/gopskit/pkg/kube"
+	"github.com/fmjstudios/gopskit/pkg/kv"
 	"github.com/fmjstudios/gopskit/pkg/log"
 	"github.com/fmjstudios/gopskit/pkg/proc"
 	"github.com/fmjstudios/gopskit/pkg/stamp"
@@ -34,6 +35,11 @@ type API struct {
 	// Log is a wrapper object around Uber's `zap` logger
 	Log *log.Logger
 
+	// KV is the embedded BadgerDB database wrapper which we us to persist
+	// Vault tokens, unseal keys and recovery keys, e.g. after Vault initialization.
+	// These values may or may not be made accessible via the CLIs via a subcommand.
+	KV *kv.Database
+
 	// Stamp is build-time information that is linked into the final executable
 	// by LD. Our Bazel builds stamps builds via LD using the 'x_defs' attribute
 	// on the 'go_library' rule

pkg/kv/op.go

@@ -190,6 +190,10 @@ func (d *Database) delete(key []byte) error {
 	return nil
 }
 
+// Close closes an active connection to a database. This method must be called
+// during program shutdown or else you risk corrupting the data. Additionally,
+// we run garbage collection across the entire database before finally shutting
+// down.
 func (d *Database) Close() error {
 	d.lock.Lock()
 	defer d.lock.Unlock()
@@ -201,13 +205,15 @@ func (d *Database) Close() error {
 	return d.kv.Close()
 }
 
+// Path returns the filesystem path to the database
 func (d *Database) Path() string {
 	d.lock.Lock()
 	defer d.lock.Unlock()
 
 	return d.path
 }
 
+// Config returns the badger.Options the database was initialized with
 func (d *Database) Config() badger.Options {
 	d.lock.Lock()
 	defer d.lock.Unlock()