vault testing (#3)

fix kvv2 engine enabling bug, introduce printer package

.github/workflows/lint.yml

@@ -13,8 +13,21 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+
+      - uses: actions/setup-go@v2
+        with:
+          go-version: '1.17'
+
+      - name: go get
+        run: go get ./...
+
+      - name: go mod tidy
+        run: go mod tidy
+
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v2
         with:
           version: v1.43.0
-          args: -c .golang-ci.yml
+          args: -c .golang-ci.yml -v --timeout=5m
+        env:
+          GO111MODULES: off

.github/workflows/release.yml

@@ -21,7 +21,7 @@ jobs:
         name: Set up Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.16
+          go-version: 1.17
       -
         name: Run GoReleaser
         uses: goreleaser/goreleaser-action@v2

.github/workflows/test.yml

@@ -9,12 +9,17 @@ jobs:
       - uses: actions/checkout@v2
         with:
           fetch-depth: 2
+
       - uses: actions/setup-go@v2
         with:
-          go-version: '1.16'
+          go-version: '1.17'
 
       - name: go get
         run: go get ./...
+
+      - name: go mod tidy
+        run: go mod tidy
+
       - name: Run coverage
         run: go test -race -coverprofile=coverage.out -covermode=atomic ./...
       - name: Upload coverage to Codecov

.gitignore

@@ -1,24 +1,14 @@
 vkv
 /.idea
-# Binaries for programs and plugins
 *.exe
 *.exe~
 *.dll
 *.so
 *.dylib
-
-# Test binary, built with `go test -c`
 *.test
-
-# Output of the go coverage tool, specifically when used with LiteIDE
 *.out
-
-# Dependency directories (remove the comment below to include it)
 vendor/
-
 coverage.out
-
-# goreleaser
 /dist
-
-.envrc
+.envrc
+format.yaml

.golang-ci.yml

@@ -15,4 +15,5 @@ linters:
     - goerr113
     - wrapcheck
     - gochecknoglobals
-    - varnamelen
+    - varnamelen
+    - funlen

README.md

@@ -33,7 +33,7 @@ Flags:
   -h, --help               help for vkv
       --only-keys          print only keys
       --only-paths         print only paths
-  -p, --root-path string   root path (default "kv2")
+  -p, --root-path string   root path (default "kv")
       --show-secrets       print out secrets
   -s, --sub-path string    sub path
   -j, --to-json            print secrets in json format
@@ -52,7 +52,7 @@ secret/sub/demo
 secret/sub/sub2/demo
 ```
 
-## list secrets `--root-paths | -p (default kv2)`
+## list secrets `--root-path | -p (default kv)`
 You can list all secrets recursively by running:
 
 ```bash
@@ -151,3 +151,10 @@ secret/sub/sub2/demo:
   password: password
   user: user
 ```
+
+# Acknowledgements / Similar tools
+`vkv` is inspired by:
+* https://github.com/jonasvinther/medusa
+
+Similar tools are:
+* https://github.com/kir4h/rvault

cmd/root.go

@@ -1,35 +1,19 @@
 package cmd
 
 import (
-	"encoding/json"
 	"fmt"
 	"io"
-	"log"
 	"os"
-	"sort"
-	"strings"
-	"text/tabwriter"
 
+	"github.com/FalcoSuessgott/vkv/pkg/printer"
 	"github.com/FalcoSuessgott/vkv/pkg/vault"
-	"github.com/ghodss/yaml"
 	"github.com/spf13/cobra"
 )
 
-const (
-	delimiter     = "/"
-	separator     = " "
-	newLine       = "\n"
-	maskChar      = "*"
-	defaultKVPath = "kv2"
-)
+const defaultKVPath = "kv"
 
 var defaultWriter = os.Stdout
 
-type (
-	secrets map[string]interface{}
-	keys    []string
-)
-
 // Options holds all available commandline options.
 type Options struct {
 	rootPath    string
@@ -51,10 +35,8 @@ func defaultOptions() *Options {
 	}
 }
 
-//nolint: funlen
 func newRootCmd(version string) *cobra.Command {
 	o := defaultOptions()
-	s := secrets{}
 
 	cmd := &cobra.Command{
 		Use:           "vkv",
@@ -67,32 +49,30 @@ func newRootCmd(version string) *cobra.Command {
 
 				return nil
 			}
+
 			if err := o.validateFlags(); err != nil {
 				return err
 			}
 
-			// READ
 			v, err := vault.NewClient()
 			if err != nil {
 				return err
 			}
 
-			s.listRecursive(v, o.rootPath, o.subPath)
-
-			// MODIFY
-			o.evalModifyFlags(s)
-
-			// PRINT
-			if !o.json && !o.yaml {
-				o.print(s)
+			if err := v.ListRecursive(o.rootPath, o.subPath); err != nil {
+				return err
 			}
 
-			if o.json {
-				fmt.Println(s.toJSON())
-			}
+			printer := printer.NewPrinter(v.Secrets,
+				printer.OnlyKeys(o.onlyKeys),
+				printer.OnlyPaths(o.onlyPaths),
+				printer.ShowSecrets(o.showSecrets),
+				printer.ToJSON(o.json),
+				printer.ToYAML(o.yaml),
+			)
 
-			if o.yaml {
-				fmt.Println(s.toYAML())
+			if err := printer.Out(); err != nil {
+				return err
 			}
 
 			return nil
@@ -145,175 +125,3 @@ func (o *Options) validateFlags() error {
 
 	return nil
 }
-
-func (o *Options) evalModifyFlags(s secrets) {
-	if o.onlyKeys {
-		s.onlykeys()
-	}
-
-	if o.onlyPaths {
-		s.onlyPaths()
-	}
-
-	if !o.showSecrets {
-		s.maskSecrets()
-	}
-}
-
-func (s *secrets) listRecursive(v *vault.Vault, rootPath, subPath string) {
-	keys, err := v.ListPath(rootPath, subPath)
-	if err != nil {
-		log.Fatalf("error listing secrets at %s/%s: %v.\n", rootPath, subPath, err)
-	}
-
-	for _, k := range keys {
-		if strings.HasSuffix(k, delimiter) {
-			s.listRecursive(v, rootPath, buildPath(subPath, k))
-		} else {
-			secrets, err := v.ReadSecrets(rootPath, buildPath(subPath, k))
-			if err != nil {
-				log.Fatalf("error reading secret at %s/%s/%s: %v.\n", rootPath, subPath, k, err)
-			}
-
-			(*s)[buildPath(rootPath, subPath, k)] = secrets
-		}
-	}
-}
-
-func (s secrets) toJSON() string {
-	out, err := json.Marshal(s)
-	if err != nil {
-		log.Fatalf("error while marshalling map: %v\n", err)
-	}
-
-	return string(out)
-}
-
-func (s *secrets) toYAML() string {
-	out, err := yaml.JSONToYAML([]byte(s.toJSON()))
-	if err != nil {
-		log.Fatalf("error while marshalling from json: %v\n", err)
-	}
-
-	return string(out)
-}
-
-func sortMapKeys(m map[string]interface{}) []string {
-	keys := make(keys, 0, len(m))
-	for k := range m {
-		keys = append(keys, k)
-	}
-
-	sort.Sort(keys)
-
-	return keys
-}
-
-func (k keys) Len() int {
-	return len(k)
-}
-
-func (k keys) Swap(i, j int) {
-	k[i], k[j] = k[j], k[i]
-}
-
-func (k keys) Less(i, j int) bool {
-	k1 := strings.ReplaceAll(k[i], "/", "\x00")
-	k2 := strings.ReplaceAll(k[j], "/", "\x00")
-
-	return k1 < k2
-}
-
-func (o *Options) print(s secrets) {
-	//nolint: gomnd
-	w := tabwriter.NewWriter(o.writer, 0, 8, 1, '\t', tabwriter.AlignRight)
-
-	fmt.Fprintf(w, "%s%s%s", buildPath(o.rootPath, o.subPath), delimiter, newLine)
-
-	for _, k := range sortMapKeys(s) {
-		// nolint
-		if o.onlyKeys {
-			fmt.Fprintf(w, "%s\t%v\n", k, printMap(s[k]))
-		} else if o.onlyPaths {
-			fmt.Fprintln(w, k)
-		} else {
-			fmt.Fprintf(w, "%s\t%v\n", k, printMap(s[k]))
-		}
-	}
-
-	w.Flush()
-}
-
-func (s secrets) onlykeys() {
-	for k := range s {
-		m, ok := s[k].(map[string]interface{})
-		if !ok {
-			continue
-		}
-
-		for k := range m {
-			m[k] = ""
-		}
-	}
-}
-
-func (s secrets) onlyPaths() {
-	for k := range s {
-		s[k] = nil
-	}
-}
-
-func (s secrets) maskSecrets() {
-	for k := range s {
-		m, ok := s[k].(map[string]interface{})
-		if !ok {
-			continue
-		}
-
-		for k := range m {
-			secret := fmt.Sprintf("%v", m[k])
-			m[k] = strings.Repeat(maskChar, len(secret))
-		}
-	}
-}
-
-func buildPath(elements ...string) string {
-	p := ""
-
-	for i, e := range elements {
-		e = strings.TrimSuffix(e, delimiter)
-
-		if e == "" {
-			continue
-		}
-
-		p += e
-
-		if i < len(elements) {
-			p += delimiter
-		}
-	}
-
-	return strings.TrimSuffix(p, delimiter)
-}
-
-func printMap(m interface{}) string {
-	out := ""
-
-	secrets, ok := m.(map[string]interface{})
-	if !ok {
-		return ""
-	}
-
-	for _, k := range sortMapKeys(secrets) {
-		out += k
-
-		if secrets[k] == "" {
-			out += separator
-		} else {
-			out += fmt.Sprintf("=%v ", secrets[k])
-		}
-	}
-
-	return strings.TrimSuffix(out, separator)
-}