feat: add unit tests (#5)

Co-authored-by: Jorge Turrado Ferrero <jorge.turrado@docplanner.com>
Co-authored-by: MatteoManzoni <manzoni.matteo@mailfence.com>

Author: 3 people

.github/workflows/pull_request_tests.yml

@@ -17,3 +17,25 @@ jobs:
       - uses: golangci/golangci-lint-action@v2
         with:
           version: v1.40.1
+  
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-go@v2
+        with:
+          go-version: 1.17
+        
+      - name: Launch git-server
+        run: make launch-test-deps
+      - name: Configure test known_hosts
+        run: |
+          chmod 600 test-git-server/private_keys/helm-repo-updater-test
+          mkdir -p ~/.ssh/
+          ssh-keyscan -p 2222 localhost >> ~/.ssh/known_hosts
+
+      - run: make build
+
+      - run: make test

.gitignore

@@ -19,3 +19,6 @@
 
 ### Intellij ###
 .idea
+
+# Generated binary files
+bin

Makefile

@@ -0,0 +1,56 @@
+GO                          = $(shell which go)
+GOBIN_TOOL                  = $(shell which gobin || echo $(GOPATH)/gobin)
+GO_INPUT                    = $(CURDIR)/main.go
+GO_OUTPUT                   = $(CURDIR)/bin/$(APP_NAME)
+APP_NAME                    ?= helm-repo-updater
+GO_TEST_DEFAULT_ARG         = -v ./internal/...
+
+.PHONY: build
+build: clean
+	@echo "`date +'%d.%m.%Y %H:%M:%S'` Building $(GO_INPUT)"
+	$(GO) build \
+    	-ldflags "-s -w" \
+    	-o $(GO_OUTPUT) $(GO_INPUT)
+
+.PHONY: clean
+clean:
+	rm -f $(GO_OUTPUT)
+
+.PHONY: launch-test-deps
+launch-test-deps:
+	docker-compose -f test-git-server/docker-compose.yaml up -d
+
+.PHONY: clean-test-deps
+clean-test-deps:
+	docker-compose -f test-git-server/docker-compose.yaml down
+	docker volume prune -f && docker system prune -f
+
+.PHONY: test
+test: test-unit
+
+.PHONY: test-benchmark
+test-benchmark: launch-test-deps
+	$(GO) test ${GO_TEST_DEFAULT_ARG} -cpu 1,2,4,8 -benchmem -bench .
+
+.PHONY: test-unit
+test-unit: launch-test-deps
+	$(GO) test ${GO_TEST_DEFAULT_ARG}
+
+.PHONY: test-coverage
+test-coverage: launch-test-deps
+	$(GO) test ${GO_TEST_DEFAULT_ARG} -cover
+
+.PHONY: lint
+lint: golangci-lint
+
+.PHONY: golangci-lint
+golangci-lint: $(GOBIN_TOOL)
+	GOOS=linux $(GOBIN_TOOL) -run github.com/golangci/golangci-lint/cmd/golangci-lint@v1.40.1 run
+
+.PHONY: gofumpt
+gofumpt: $(GOBIN_TOOL)
+	GOOS=linux $(GOBIN_TOOL) -run mvdan.cc/gofumpt -l -w .
+
+$(GOBIN_TOOL):
+	go get github.com/myitcv/gobin
+	go install github.com/myitcv/gobin

cmd/run.go

@@ -103,8 +103,9 @@ func runImageUpdater(cfg updater.HelmUpdaterConfig) error {
 	err := func(cfg updater.HelmUpdaterConfig) error {
 		log.Debugf("Processing application %s in directory %s", cfg.AppName, cfg.File)
 
-		err := updater.UpdateApplication(cfg, syncState)
+		_, err := updater.UpdateApplication(cfg, syncState)
 		if err != nil {
+			fmt.Printf("err is %v\n", err)
 			return err
 		}
 

go.mod

@@ -4,12 +4,14 @@ go 1.17
 
 require (
 	github.com/argoproj-labs/argocd-image-updater v0.11.0
+	github.com/google/go-cmp v0.5.6
 	github.com/mikefarah/yq/v4 v4.16.2
 	github.com/pkg/errors v0.9.1
 	github.com/spf13/cobra v1.3.0
 	github.com/spf13/viper v1.10.0
 	gopkg.in/op/go-logging.v1 v1.0.0-20160211212156-b2cb9fa56473
 	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b
+	gotest.tools v2.2.0+incompatible
 )
 
 require (
@@ -54,13 +56,14 @@ require (
 	github.com/timtadh/lexmachine v0.2.2 // indirect
 	github.com/xanzy/ssh-agent v0.2.1 // indirect
 	golang.org/x/crypto v0.0.0-20210817164053-32db794688a5 // indirect
-	golang.org/x/net v0.0.0-20210813160813-60bc85c4be6d // indirect
+	golang.org/x/net v0.0.0-20211015210444-4f30a5c0130f // indirect
 	golang.org/x/sys v0.0.0-20211205182925-97ca703d548d // indirect
 	golang.org/x/text v0.3.7 // indirect
 	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
 	gopkg.in/ini.v1 v1.66.2 // indirect
 	gopkg.in/warnings.v0 v0.1.2 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gotest.tools/v3 v3.0.3
 )
 
 replace (

go.sum

@@ -991,8 +991,9 @@ golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96b
 golang.org/x/net v0.0.0-20210410081132-afb366fc7cd1/go.mod h1:9tjilg8BloeKEkVJvy7fQ90B1CfIiPueXVOjqfkSzI8=
 golang.org/x/net v0.0.0-20210503060351-7fd8e65b6420/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
 golang.org/x/net v0.0.0-20210614182718-04defd469f4e/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
-golang.org/x/net v0.0.0-20210813160813-60bc85c4be6d h1:LO7XpTYMwTqxjLcGWPijK3vRXg1aWdlNOVOHRq45d7c=
 golang.org/x/net v0.0.0-20210813160813-60bc85c4be6d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
+golang.org/x/net v0.0.0-20211015210444-4f30a5c0130f h1:OfiFi4JbukWwe3lzw+xunroH1mnC1e2Gy5cxNJApiSY=
+golang.org/x/net v0.0.0-20211015210444-4f30a5c0130f/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
 golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
 golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
 golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
@@ -1378,8 +1379,10 @@ gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C
 gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo=
 gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gotest.tools v2.2.0+incompatible h1:VsBPFP1AI068pPrMxtb/S8Zkgf9xEmTLJjfM+P5UIEo=
 gotest.tools v2.2.0+incompatible/go.mod h1:DsYFclhRJ6vuDpmuTbkuFWG+y2sxOXAzmJt81HFBacw=
 gotest.tools/v3 v3.0.2/go.mod h1:3SzNCllyD9/Y+b5r9JIKQ474KzkZyqLqEfYqMsX94Bk=
+gotest.tools/v3 v3.0.3 h1:4AuOwCGf4lLR9u3YOe2awrHygurzhO/HeQ6laiA6Sx0=
 gotest.tools/v3 v3.0.3/go.mod h1:Z7Lb0S5l+klDB31fvDQX8ss/FlKDxtlFlw3Oa8Ymbl8=
 honnef.co/go/tools v0.0.0-20180728063816-88497007e858/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=

internal/app/decoder/decoder_yaml.go

@@ -24,4 +24,4 @@ func (dec *yamlDecoder) Init(reader io.Reader) {
 
 func (dec *yamlDecoder) Decode(rootYamlNode *yaml.Node) error {
 	return dec.decoder.Decode(rootYamlNode)
-}
+}

internal/app/git/creds.go

@@ -2,6 +2,7 @@ package git
 
 import (
 	"fmt"
+
 	"github.com/argoproj-labs/argocd-image-updater/ext/git"
 )
 
@@ -14,18 +15,24 @@ type Credentials struct {
 }
 
 // NewCreds returns the credentials for the given repo url.
-func (g Credentials) NewCreds(repoURL string) (git.Creds, error) {
+func (g Credentials) NewGitCreds(repoURL string) (git.Creds, error) {
 	if ok, _ := git.IsSSHURL(repoURL); ok {
 		if g.SSHPrivKey != "" {
-
 			return git.NewSSHCreds(g.SSHPrivKey, "", true), nil
 		}
+		return nil, fmt.Errorf(
+			"sshPrivKey not provided for authenticatication to repository %s",
+			repoURL,
+		)
 	} else if git.IsHTTPSURL(repoURL) {
 		if g.Username != "" && g.Password != "" {
-
 			return git.NewHTTPSCreds(g.Username, g.Password, "", "", true, ""), nil
 		}
+		return nil, fmt.Errorf(
+			"no value provided for username and password for authentication to repository %s",
+			repoURL,
+		)
 	}
 
-	return nil, fmt.Errorf("unknown repository type")
+	return nil, fmt.Errorf("unknown repository type for git repository URL %s", repoURL)
 }

internal/app/git/creds_test.go

@@ -0,0 +1,143 @@
+package git
+
+import (
+	"fmt"
+	"log"
+	"testing"
+
+	"github.com/argoproj-labs/argocd-image-updater/ext/git"
+	app_utils "github.com/docplanner/helm-repo-updater/internal/app/utils"
+	"github.com/google/go-cmp/cmp"
+	"gotest.tools/v3/assert"
+)
+
+const validGitCredentialsEmail = "test-user@docplanner.com"
+const validGitCredentialsUsername = "test-user"
+const validGitCredentialsPassword = "test-password"
+const validSSHPrivKeyRelativeRoute = "/test-git-server/private_keys/helm-repo-updater-test"
+const validGitRepoSSHURL = "git@github.com:kubernetes/kubernetes.git"
+const validGitRepoHTTPSURL = "https://github.com/kubernetes/kubernetes.git"
+const invalidGitRepoURL = "github.com/kubernetes/kubernetes.git"
+
+func TestNewCredsSSHURLSShPrivKey(t *testing.T) {
+
+	sshPrivKeyRoute, err := app_utils.GetRouteRelativePath(2, validSSHPrivKeyRelativeRoute)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	g := Credentials{
+		Email:      validGitCredentialsEmail,
+		SSHPrivKey: *sshPrivKeyRoute,
+	}
+
+	repoURL := validGitRepoSSHURL
+
+	creds, err := g.NewGitCreds(repoURL)
+
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	expectedCreds := git.NewSSHCreds(*sshPrivKeyRoute, "", true)
+
+	assert.DeepEqual(t, creds, expectedCreds, cmp.AllowUnexported(git.SSHCreds{}))
+}
+
+func TestNewCredsHTPPSURLUsernamePassword(t *testing.T) {
+
+	g := Credentials{
+		Email:    validGitCredentialsEmail,
+		Username: validGitCredentialsUsername,
+		Password: validGitCredentialsPassword,
+	}
+
+	creds, err := g.NewGitCreds(validGitRepoHTTPSURL)
+
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	expectedCreds := git.NewHTTPSCreds(g.Username, g.Password, "", "", true, "")
+
+	assert.DeepEqual(t, creds, expectedCreds, cmp.AllowUnexported(git.HTTPSCreds{}))
+}
+
+func TestNewCredsSSHURLWithoutSShPrivKey(t *testing.T) {
+
+	g := Credentials{
+		Email:      validGitCredentialsEmail,
+		SSHPrivKey: "",
+	}
+
+	repoURL := validGitRepoSSHURL
+
+	_, err := g.NewGitCreds(repoURL)
+
+	expectedErrorMessage := fmt.Sprintf(
+		"sshPrivKey not provided for authenticatication to repository %s",
+		repoURL,
+	)
+
+	assert.Error(t, err, expectedErrorMessage)
+}
+
+func TestNewCredsHTPPSURLWithoutUsernameWithPassword(t *testing.T) {
+
+	g := Credentials{
+		Email:    validGitCredentialsEmail,
+		Username: "",
+		Password: validGitCredentialsPassword,
+	}
+
+	repoURL := validGitRepoHTTPSURL
+
+	_, err := g.NewGitCreds(repoURL)
+
+	expectedErrorMessage := fmt.Sprintf(
+		"no value provided for username and password for authentication to repository %s",
+		repoURL,
+	)
+
+	assert.Error(t, err, expectedErrorMessage)
+}
+
+func TestNewCredsHTPPSURLWitUsernameWithoutPassword(t *testing.T) {
+
+	g := Credentials{
+		Email:    validGitCredentialsEmail,
+		Username: validGitCredentialsUsername,
+		Password: "",
+	}
+
+	repoURL := validGitRepoHTTPSURL
+
+	_, err := g.NewGitCreds(repoURL)
+
+	expectedErrorMessage := fmt.Sprintf(
+		"no value provided for username and password for authentication to repository %s",
+		repoURL,
+	)
+
+	assert.Error(t, err, expectedErrorMessage)
+}
+
+func TestNewCredsInvalidURL(t *testing.T) {
+
+	g := Credentials{
+		Email:    validGitCredentialsEmail,
+		Username: validGitCredentialsUsername,
+		Password: validGitCredentialsPassword,
+	}
+
+	repoURL := invalidGitRepoURL
+
+	_, err := g.NewGitCreds(repoURL)
+
+	expectedErrorMessage := fmt.Sprintf(
+		"unknown repository type for git repository URL %s",
+		repoURL,
+	)
+
+	assert.Error(t, err, expectedErrorMessage)
+}