refactor: add version tests to be more defensive

Author: gsdevme

Makefile

@@ -8,7 +8,7 @@ lint:
 	 golangci-lint run
 
 tests:
-	go test ./...
+	go test -v ./...
 
 coverage:
 	go test -coverprofile=coverage.out ./... && go tool cover -html=coverage.out

internal/app/gitops-commit/slackhttp/handler_test.go

@@ -13,25 +13,25 @@ func Test_handleSlackCommand(t *testing.T) {
 		s := &server{}
 		r := &NamedRepositoryRegistry{}
 
-		tests := []struct{
-			name string
+		tests := []struct {
+			name    string
 			command string
-			expect string
+			expect  string
 		}{
 			{
-				name: "when using missing bits",
+				name:    "when using missing bits",
 				command: "totally wrong",
-				expect: "Incorrect usage, expected /gitops-commit [command] [name] [tag]",
+				expect:  "Incorrect usage, expected /gitops-commit [command] [name] [tag]",
 			},
 			{
-				name: "when using an invalid command",
+				name:    "when using an invalid command",
 				command: "wrong thing v1.2.3",
-				expect: "Unknown command 'wrong', expected /gitops-commit [command] [name] [tag]",
+				expect:  "Unknown command 'wrong', expected /gitops-commit [command] [name] [tag]",
 			},
 			{
-				name: "when using a valid command ",
+				name:    "when using a valid command ",
 				command: "deploy thing v1.2.3",
-				expect: "Unknown named repository, cannot handle \"thing\", availabe options ()",
+				expect:  "Unknown named repository, cannot handle \"thing\", availabe options ()",
 			},
 		}
 
@@ -64,4 +64,4 @@ func Test_handleSlackCommand(t *testing.T) {
 			})
 		}
 	})
-}
+}

internal/pkg/gitops/version.go

@@ -15,7 +15,7 @@ func ReadCurrentVersion(f []byte, notation string) (string, error) {
 	data := make(map[string]interface{})
 	err := yaml.Unmarshal(f, &data)
 
-	if err != nil {
+	if err != nil || len(data) <= 0 {
 		return "", fmt.Errorf("unvalid valid: %w", err)
 	}
 

internal/pkg/gitops/version_test.go

@@ -0,0 +1,90 @@
+package gitops
+
+import (
+	"fmt"
+	"gopkg.in/yaml.v3"
+	"testing"
+)
+
+func TestReadCurrentVersion(t *testing.T) {
+	type args struct {
+		f        []byte
+		notation string
+	}
+
+	tests := []struct {
+		name    string
+		args    args
+		want    string
+		wantErr bool
+	}{
+		{
+			name: "empty file",
+			args: args{
+				f:        []byte(""),
+				notation: "test.test",
+			},
+			want:    "",
+			wantErr: true,
+		},
+		{
+			name: "invalid yaml",
+			args: args{
+				f:        []byte("wibble&&3..\nfff"),
+				notation: "image.tag",
+			},
+			want:    "",
+			wantErr: true,
+		},
+		{
+			name: "simple yaml",
+			args: args{
+				f:        createSimpleYaml("v1.2.99"),
+				notation: "image.tag",
+			},
+			want:    "v1.2.99",
+			wantErr: false,
+		},
+		{
+			name: "invalid notation to yaml",
+			args: args{
+				f:        createSimpleYaml("v1.2.99"),
+				notation: "image.nope",
+			},
+			want:    "",
+			wantErr: true,
+		},
+	}
+
+	fmt.Println(string(createSimpleYaml("v1.2.99")))
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, err := ReadCurrentVersion(tt.args.f, tt.args.notation)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("ReadCurrentVersion() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			if got != tt.want {
+				t.Errorf("ReadCurrentVersion() got = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
+func createSimpleYaml(t string) []byte {
+	type tag struct {
+		Tag string `yaml:"tag"`
+	}
+
+	marshal, err := yaml.Marshal(&struct {
+		Image tag `yaml:"image"`
+	}{
+		Image: tag{Tag: t},
+	})
+	if err != nil {
+		return nil
+	}
+
+	return marshal
+}