refactor: use Storage interface instead of direct struct

It can get quiet hard to test structs in Go and functions using them. With this, the rest of the code can be mocked easier with a TestBackend which is just sits in memory and no encryption. The encryption should be tested on storage layer, but the rest of the application should care only about the exposed functions. related to #8 and #37 References: - #8 - #37 Signed-off-by: Victoria Nadasdi <victoria@efertone.me>
yitsushi · Jan 28, 2024 · 28cd785 · 28cd785
1 parent 5067ad0
commit 28cd785
Show file tree

Hide file tree

Showing 14 changed files with 455 additions and 427 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -66,6 +66,10 @@ issues:
   - path: internal/info
     linters:
     - gochecknoglobals
+  - source: "// .* #\\d+"
+    # Ignore TODO lines if they have a GitHub Issue reference.
+    linters:
+    - godox
 
 linters:
   enable-all: true

diff --git a/internal/cmd/add_token.go b/internal/cmd/add_token.go
@@ -41,16 +41,12 @@ func AddTokenCommand() *cli.Command {
 				ctx.Args().Get(argSetPrefixPositionAccount),
 			)
 
-			storage, err := s.PrepareStorage()
-			if err != nil {
+			storage := s.NewFileStorage()
+			if err = storage.Prepare(); err != nil {
 				return err
 			}
 
-			namespace, err = storage.FindNamespace(nsName)
-			if err != nil {
-				namespace = &s.Namespace{Name: nsName}
-				storage.Namespaces = append(storage.Namespaces, namespace)
-			}
+			namespace, _ = storage.AddNamespace(&s.Namespace{Name: nsName})
 
 			account, err = namespace.FindAccount(accName)
 			if err == nil {

diff --git a/internal/cmd/change_password.go b/internal/cmd/change_password.go
@@ -19,12 +19,12 @@ func ChangePasswordCommand() *cli.Command {
 		Action: func(_ *cli.Context) error {
 			var (
 				err                  error
-				storage              *s.Storage
 				newPasswordIn        string
 				newPasswordConfirmIn string
 			)
 
-			if storage, err = s.PrepareStorage(); err != nil {
+			storage := s.NewFileStorage()
+			if err = storage.Prepare(); err != nil {
 				return err
 			}
 
@@ -42,7 +42,7 @@ func ChangePasswordCommand() *cli.Command {
 				return CommandError{Message: "new password and the confirm mismatch"}
 			}
 
-			storage.Password = newPasswordIn
+			storage.SetPassword(newPasswordIn)
 
 			return storage.Save()
 		},

diff --git a/internal/cmd/delete.go b/internal/cmd/delete.go
@@ -22,9 +22,9 @@ func DeleteCommand() *cli.Command {
 				return CommandError{Message: "namespace is not defined"}
 			}
 
-			storage, err := s.PrepareStorage()
-			if err != nil {
-				return
+			storage := s.NewFileStorage()
+			if err = storage.Prepare(); err != nil {
+				return err
 			}
 
 			defer func() {

diff --git a/internal/cmd/dump.go b/internal/cmd/dump.go
@@ -37,12 +37,12 @@ func DumpCommand() *cli.Command {
 				}
 			}
 
-			storage, err := s.PrepareStorage()
-			if err != nil {
+			storage := s.NewFileStorage()
+			if err := storage.Prepare(); err != nil {
 				return err
 			}
 
-			out, err := yaml.Marshal(storage.Namespaces)
+			out, err := yaml.Marshal(storage.ListNamespaces())
 			if err != nil {
 				return fmt.Errorf("failed to marshal storage: %w", err)
 			}

diff --git a/internal/cmd/generate.go b/internal/cmd/generate.go
@@ -41,8 +41,8 @@ func GenerateCommand() *cli.Command {
 
 			follow := ctx.Bool("follow")
 
-			storage, err := s.PrepareStorage()
-			if err != nil {
+			storage := s.NewFileStorage()
+			if err := storage.Prepare(); err != nil {
 				return err
 			}
 
@@ -73,7 +73,7 @@ func GenerateCommand() *cli.Command {
 	}
 }
 
-func getAccount(storage *s.Storage, namespaceName, accountName string) (*s.Account, error) {
+func getAccount(storage s.Storage, namespaceName, accountName string) (*s.Account, error) {
 	namespace, err := storage.FindNamespace(namespaceName)
 	if err != nil {
 		return nil, err

diff --git a/internal/cmd/import.go b/internal/cmd/import.go
@@ -24,10 +24,7 @@ func ImportCommand() *cli.Command {
 			},
 		},
 		Action: func(ctx *cli.Context) (err error) {
-			var (
-				file    []byte
-				storage *s.Storage
-			)
+			var file []byte
 
 			if file, err = os.ReadFile(ctx.String("input")); err != nil {
 				return
@@ -41,8 +38,9 @@ func ImportCommand() *cli.Command {
 				return
 			}
 
-			if storage, err = s.PrepareStorage(); err != nil {
-				return
+			storage := s.NewFileStorage()
+			if err = storage.Prepare(); err != nil {
+				return err
 			}
 
 			defer func() {
@@ -60,16 +58,11 @@ func ImportCommand() *cli.Command {
 	}
 }
 
-func importNamespaces(storage *s.Storage, nsList []*s.Namespace) {
+func importNamespaces(storage s.Storage, nsList []*s.Namespace) {
 	term := terminal.New(os.Stdin, os.Stdout, os.Stderr)
 
 	for _, ns := range nsList {
-		internalNS, err := storage.FindNamespace(ns.Name)
-		if err != nil {
-			storage.Namespaces = append(storage.Namespaces, ns)
-
-			continue
-		}
+		internalNS, _ := storage.AddNamespace(ns)
 
 		for _, acc := range ns.Accounts {
 			internalAcc, err := internalNS.FindAccount(acc.Name)

diff --git a/internal/cmd/list.go b/internal/cmd/list.go
@@ -16,14 +16,14 @@ func ListCommand() *cli.Command {
 		Usage:     "List all available namespaces or accounts under a namespace.",
 		ArgsUsage: "[namespace]",
 		Action: func(ctx *cli.Context) error {
-			storage, err := s.PrepareStorage()
-			if err != nil {
+			storage := s.NewFileStorage()
+			if err := storage.Prepare(); err != nil {
 				return err
 			}
 
 			ns := ctx.Args().Get(argSetPrefixPositionNamespace)
 			if len(ns) < 1 {
-				for _, namespace := range storage.Namespaces {
+				for _, namespace := range storage.ListNamespaces() {
 					fmt.Printf("%s (Number of accounts: %d)\n", namespace.Name, len(namespace.Accounts))
 				}
 

diff --git a/internal/cmd/rename.go b/internal/cmd/rename.go
@@ -40,9 +40,9 @@ func renameNamespaceCommand() *cli.Command {
 				ctx.Args().Get(argRenameNamespacePositionNewName),
 			)
 
-			storage, err := s.PrepareStorage()
-			if err != nil {
-				return
+			storage := s.NewFileStorage()
+			if err = storage.Prepare(); err != nil {
+				return err
 			}
 
 			defer func() {
@@ -76,9 +76,9 @@ func renameAccountCommand() *cli.Command {
 				ctx.Args().Get(argRenameAccountPositionNewName),
 			)
 
-			storage, err := s.PrepareStorage()
-			if err != nil {
-				return
+			storage := s.NewFileStorage()
+			if err = storage.Prepare(); err != nil {
+				return err
 			}
 
 			defer func() {

diff --git a/internal/cmd/set_length.go b/internal/cmd/set_length.go
@@ -29,9 +29,9 @@ func SetLengthCommand() *cli.Command {
 				ctx.Args().Get(argSetLengthPositionPrefix),
 			)
 
-			storage, err := s.PrepareStorage()
-			if err != nil {
-				return
+			storage := s.NewFileStorage()
+			if err = storage.Prepare(); err != nil {
+				return err
 			}
 
 			defer func() {

diff --git a/internal/cmd/set_prefix.go b/internal/cmd/set_prefix.go
@@ -36,9 +36,9 @@ func SetPrefixCommand() *cli.Command {
 				ctx.Bool("clear"),
 			)
 
-			storage, err := s.PrepareStorage()
-			if err != nil {
-				return
+			storage := s.NewFileStorage()
+			if err = storage.Prepare(); err != nil {
+				return err
 			}
 
 			defer func() {