feat: add "exclude-versions" flag and do small code refactor

Author: pmoscode

README.md

@@ -5,13 +5,14 @@ Checks Docker hub for Docker images tag update. It compares the given Helm chart
 ## Usage
 
 ```text
-hcuc <flags>
+Usage of hcuc:
 
-Flags:
   --debug
         Enable debug outputs
   --docker-hub-repo string
         DockHub repo to check tag versions
+  --exclude-versions string
+        Versions to exclude from check
   --fail-on-update
         Return exit code 1, if update is available
   --helm-chart-path string
@@ -22,3 +23,5 @@ Flags `--docker-hub-repo string` and `--helm-chart-path` are required.
 
 Per default, it shows a small table with the current version and all available versions.
 When `--fail-on-update` is set, the app is exiting with code 1.
+
+`--exclude-versions` can be set, to ignore / exclude version on DockerHub from the check.

go.mod

@@ -2,6 +2,8 @@ module github.com/pmoscode/helm-chart-update-check
 
 go 1.22.3 // Update GH Action aswell
 
-require github.com/Masterminds/semver/v3 v3.3.0
-
-require gopkg.in/yaml.v3 v3.0.1
+require (
+	github.com/Masterminds/semver/v3 v3.3.0
+	gopkg.in/yaml.v3 v3.0.1
+	github.com/pmoscode/go-common v0.10.0
+)

go.sum

@@ -2,6 +2,8 @@ github.com/Masterminds/semver/v3 v3.2.1 h1:RN9w6+7QoMeJVGyfmbcgs28Br8cvmnucEXnY0
 github.com/Masterminds/semver/v3 v3.2.1/go.mod h1:qvl/7zhW3nngYb5+80sSMF+FG2BjYrf8m9wsX0PNOMQ=
 github.com/Masterminds/semver/v3 v3.3.0 h1:B8LGeaivUe71a5qox1ICM/JLl0NqZSW5CHyL+hmvYS0=
 github.com/Masterminds/semver/v3 v3.3.0/go.mod h1:4V+yj/TJE1HU9XfppCwVMZq3I84lprf4nC11bSS5beM=
+github.com/pmoscode/go-common v0.10.0 h1:yrllglzwdbozsB2NB7DNTKqrulaLkig9t50+/yZYOf4=
+github.com/pmoscode/go-common v0.10.0/go.mod h1:Me/Dh7F7F1fnUeBpmAK0qlZJ4LkVgFMOvznn7g8zcbY=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

main.go

@@ -1,110 +1,74 @@
 package main
 
 import (
-	"errors"
-	"flag"
 	"fmt"
 	"github.com/Masterminds/semver/v3"
+	"github.com/pmoscode/go-common/shutdown"
 	chart2 "github.com/pmoscode/helm-chart-update-check/pkg/chart"
+	"github.com/pmoscode/helm-chart-update-check/pkg/cli"
 	"github.com/pmoscode/helm-chart-update-check/pkg/dockerhub"
+	"github.com/pmoscode/helm-chart-update-check/pkg/utils"
 	"log"
-	"strings"
 )
 
-type CliOptions struct {
-	dockerHubRepository  *string
-	helmChartPath        *string
-	failOnExistingUpdate *bool
-	debug                *bool
-}
-
-func getCliOptionsParameters() *CliOptions {
-	dockerHubRepository := flag.String("docker-hub-repo", "", "DockHub repo to check tag versions")
-	helmChartPath := flag.String("helm-chart-path", ".", "Helm chart to check for updates")
-	failOnExistingUpdate := flag.Bool("fail-on-update", false, "Return exit code 1, if update is available")
-	debug := flag.Bool("debug", false, "Enable debug outputs")
-
-	flag.Parse()
-
-	return &CliOptions{
-		dockerHubRepository:  dockerHubRepository,
-		helmChartPath:        helmChartPath,
-		failOnExistingUpdate: failOnExistingUpdate,
-		debug:                debug,
-	}
-}
-
 func main() {
-	cliOptions := getCliOptions()
+	defer shutdown.ExitOnPanic()
 
-	dockerVersions := getDockerVersions(cliOptions)
+	cliOptions := cli.GetCliOptions()
 
-	chartVersion := getChartVersion(cliOptions)
+	dockerVersions := dockerhub.FetchDockerVersions(cliOptions)
+	chartVersion := chart2.FetchChartVersion(cliOptions)
 
 	_, err := checkVersion(chartVersion, dockerVersions, cliOptions)
 	if err != nil {
 		log.Fatalln(err)
 	}
 }
 
-func getCliOptions() *CliOptions {
-	cliOptions := getCliOptionsParameters()
-
-	if *cliOptions.dockerHubRepository == "" {
-		log.Fatal(errors.New("parameter 'docker-hub-repo' is required"))
-	}
-	if *cliOptions.helmChartPath == "" {
-		log.Fatal(errors.New("parameter 'helm-chart-path' is required"))
-	}
-
-	return cliOptions
-}
-
-func getDockerVersions(cliOptions *CliOptions) []*semver.Version {
-	dockerHub := dockerhub.CreateDockerHub(*cliOptions.dockerHubRepository, *cliOptions.debug)
-	versions := dockerHub.GetVersions()
-
-	return versions
-}
-
-func getChartVersion(cliOptions *CliOptions) *semver.Version {
-	chart := chart2.NewChart(*cliOptions.helmChartPath)
-
-	appVersion := strings.Trim(chart.AppVersion(), "\"")
-	fmt.Println("Helm chart AppVersion:")
-	fmt.Println(appVersion)
-
-	v, err := semver.NewVersion(appVersion)
-	if err != nil {
-		log.Fatal("Problem creating semver: ", err)
-	}
-	return v
-}
-
-func checkVersion(chartVersion *semver.Version, dockerVersions []*semver.Version, cliOptions *CliOptions) (int, error) {
-	constraintStr := fmt.Sprintf("<= %s-0", chartVersion.IncPatch().String())
+func checkVersion(chartVersion *semver.Version, dockerVersions []*semver.Version, cliOptions *cli.Options) (int, error) {
 	// See: https://github.com/Masterminds/semver?tab=readme-ov-file#working-with-prerelease-versions
-	constraint, err := semver.NewConstraint(constraintStr)
+	constraint, err := semver.NewConstraint(fmt.Sprintf("<= %s-0", chartVersion.IncPatch().String()))
 	if err != nil {
 		log.Fatalln(err)
 	}
 
 	newerVersions := make([]*semver.Version, 0)
+	excludeVersions := utils.GetExcludedVersionsSimple(*cliOptions.ExcludeVersions)
 
 	fmt.Printf("Checking, if some version is > %s\n", chartVersion.String())
 	for _, item := range dockerVersions {
-		if *cliOptions.debug {
+		if *cliOptions.Debug {
 			fmt.Printf("Checking if Helm chart version %v is >= DockerHub version %v: ", chartVersion.Original(), item.Original())
 		}
-		if !constraint.Check(item) {
-			newerVersions = append(newerVersions, item)
-			if *cliOptions.debug {
-				fmt.Println(false)
+
+		skipVersion := false
+		if excludeVersions != nil {
+			for _, version := range excludeVersions {
+				constraintExclude, err := semver.NewConstraint(fmt.Sprintf("%s", version))
+				if err != nil {
+					log.Fatalln(err)
+				}
+
+				if constraintExclude.Check(item) {
+					skipVersion = true
+					break
+				}
 			}
-		} else {
-			if *cliOptions.debug {
-				fmt.Println(true)
+		}
+
+		if !skipVersion {
+			if !constraint.Check(item) {
+				newerVersions = append(newerVersions, item)
+				if *cliOptions.Debug {
+					fmt.Println(false)
+				}
+			} else {
+				if *cliOptions.Debug {
+					fmt.Println(true)
+				}
 			}
+		} else {
+			fmt.Println("skipped")
 		}
 	}
 
@@ -116,7 +80,7 @@ func checkVersion(chartVersion *semver.Version, dockerVersions []*semver.Version
 			fmt.Println(item.Original())
 		}
 
-		if *cliOptions.failOnExistingUpdate {
+		if *cliOptions.FailOnExistingUpdate {
 			return newerVersionsCnt, fmt.Errorf("FAIL: Found %d new versions", newerVersionsCnt)
 		}
 	} else {

main_test.go

@@ -3,11 +3,10 @@ package main
 import (
 	"encoding/json"
 	"github.com/Masterminds/semver/v3"
+	"github.com/pmoscode/helm-chart-update-check/pkg/cli"
 	"github.com/pmoscode/helm-chart-update-check/pkg/dockerhub"
-	"log"
 	"net/http"
 	"net/http/httptest"
-	"reflect"
 	"testing"
 )
 
@@ -17,38 +16,29 @@ type Tests struct {
 	expectedResult []string
 }
 
-func TestGetDockerVersions(t *testing.T) {
-	tests := []Tests{
-		{
-			name: "one",
-			server: httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-				w.WriteHeader(http.StatusOK)
-				w.Write(getTestData())
-			})),
-			expectedResult: []string{"1.2.3", "1.2.3", "1.2.3-pre.1", "1.2.3-dev", "1.5.0-rc", "1.5.0-rc1", "1.5.0", "1.5.0-nightly.1"},
-		},
-	}
+func TestCheckVersionNormal(t *testing.T) {
+	innerTest(t, "")
+}
 
-	for _, test := range tests {
-		t.Run(test.name, func(t *testing.T) {
-			defer test.server.Close()
+func TestCheckVersionWithExcludesSimple(t *testing.T) {
+	innerTest(t, "1.2.3")
+}
 
-			hub := dockerhub.CreateDockerHubWithUri(test.server.URL, false)
-			versions := hub.GetVersions()
+func TestCheckVersionWithExcludesRangeMajor(t *testing.T) {
+	innerTest(t, "^1.0.0-0")
+}
 
-			if !reflect.DeepEqual(convertSemverToStringArray(versions), test.expectedResult) {
-				t.Errorf("FAILED: expected %v, got %v\n", test.expectedResult, versions)
-			}
-		})
-	}
+func TestCheckVersionWithExcludesRangeMinor(t *testing.T) {
+	innerTest(t, "~3.3.0-0")
 }
 
-func TestCheckVersion(t *testing.T) {
+func innerTest(t *testing.T, excludeVersions string) {
 	debug := true
 	fail := false
-	cliOptions := &CliOptions{
-		debug:                &debug,
-		failOnExistingUpdate: &fail,
+	cliOptions := &cli.Options{
+		Debug:                &debug,
+		FailOnExistingUpdate: &fail,
+		ExcludeVersions:      &excludeVersions,
 	}
 
 	test := Tests{
@@ -61,27 +51,17 @@ func TestCheckVersion(t *testing.T) {
 
 	defer test.server.Close()
 
-	hub := dockerhub.CreateDockerHubWithUri(test.server.URL, *cliOptions.debug)
+	hub := dockerhub.CreateDockerHubWithUri(test.server.URL, *cliOptions.Debug)
 	dockerVersions := hub.GetVersions()
 
 	chartVersion, _ := semver.NewVersion("v1.5.0")
 
 	_, err := checkVersion(chartVersion, dockerVersions, cliOptions)
 	if err != nil {
-		log.Fatalln(err)
+		t.Fatalf("Expected no error, got %v", err)
 	}
 }
 
-func convertSemverToStringArray(semverVersions []*semver.Version) []string {
-	versions := make([]string, len(semverVersions))
-
-	for idx, item := range semverVersions {
-		versions[idx] = item.String()
-	}
-
-	return versions
-}
-
 func getTestData() []byte {
 	var serverResponseBody = &dockerhub.ResponseBody{
 		Results: []dockerhub.Results{
@@ -109,6 +89,15 @@ func getTestData() []byte {
 			{
 				Name: "v1.5.0-nightly.1",
 			},
+			{
+				Name: "v2.2.0",
+			},
+			{
+				Name: "v3.2.1",
+			},
+			{
+				Name: "v3.3.4",
+			},
 		},
 	}
 

pkg/chart/chart.go

@@ -0,0 +1,42 @@
+package chart
+
+import (
+	"gopkg.in/yaml.v3"
+	"strings"
+)
+
+type Chart struct {
+	chartPath string
+	root      *yaml.Node
+}
+
+func (c *Chart) Version() string {
+	return strings.TrimSpace(c.searchNode("version"))
+}
+
+func (c *Chart) AppVersion() string {
+	return strings.TrimSpace(c.searchNode("appVersion"))
+}
+
+func (c *Chart) UpdateAppVersion() {
+
+}
+
+func (c *Chart) searchNode(nodeName string) string {
+	//var keyNode *yaml.Node
+	var valNode *yaml.Node
+
+	for i := 0; i < len(c.root.Content); i += 2 {
+		node := c.root.Content[i]
+		if node.Kind == yaml.ScalarNode && node.Value == nodeName {
+			//keyNode = c.root.Content[i]
+			valNode = c.root.Content[i+1]
+		}
+	}
+
+	//locationSectionKey, _ := yaml.Marshal(keyNode)
+	//fmt.Println(string(locationSectionKey))
+	locationSectionVal, _ := yaml.Marshal(valNode)
+
+	return string(locationSectionVal)
+}