fix(gittag) ensure gittag targets does not fail due to (unspecified) version filters (updatecli#1407)

* Ensure that the gittag end-to-end test is valid and covers all cases

Signed-off-by: Damien Duportal <damien.duportal@gmail.com>

* chore(versionFilter) export errors as reusable types

Signed-off-by: Damien Duportal <damien.duportal@gmail.com>

* fix(gittag) ensure gittag target does not errors with default versionFilters

Signed-off-by: Damien Duportal <damien.duportal@gmail.com>

* fixup

Signed-off-by: Damien Duportal <damien.duportal@gmail.com>

---------

Signed-off-by: Damien Duportal <damien.duportal@gmail.com>

Author: dduportal

.gitignore

@@ -33,3 +33,5 @@ coverage.txt
 
 manpages/*
 completions/*
+*.log
+e2e/test_results_e2e*yaml

e2e/updatecli.d/success.d/gitTag.yaml

@@ -0,0 +1,73 @@
+name: End to end test of the gittag resource
+
+scms:
+  github-repo:
+    kind: github
+    spec:
+      branch: main
+      owner: updatecli
+      repository: updatecli
+      token: '{{ requiredEnv "GITHUB_TOKEN" }}'
+      username: '{{ requiredEnv "GITHUB_ACTOR" }}'
+  git-repo:
+    kind: git
+    spec:
+      branch: main
+      url: https://github.com/updatecli/updatecli.git
+
+sources:
+  src-git:
+    name: Get the latest git tag through git
+    kind: gittag
+    scmid: git-repo
+  src-github:
+    name: Get the latest git tag through GitHub
+    kind: gittag
+    scmid: github-repo
+  echo-version:
+    name: Returns a (SemVer) valid version to be used with the gittag targets, which must not exist in the repositories
+    kind: shell
+    spec:
+      command: echo "0.0.1"
+
+
+conditions:
+  check-git:
+    name: Check the tag 'v0.30.0' exists in the git repository
+    kind: gittag
+    scmid: git-repo
+    disablesourceinput: true
+    spec:
+      versionfilter:
+        pattern: 'v0.30.0'
+  check-github:
+    name: Check the tag 'v0.30.0' exists in the GitHub repository
+    kind: gittag
+    scmid: github-repo
+    disablesourceinput: true
+    spec:
+      versionfilter:
+        pattern: 'v0.30.0'
+
+targets:
+  create-git-tag:
+    name: Create the git tag 'v0.0.1' in the git repository
+    kind: gittag
+    scmid: git-repo
+    sourceid: echo-version
+    spec:
+      message: "Created by Updatecli"
+  create-git-tag-already-exist:
+    name: Create the (already existing) latest tag in the git repository
+    kind: gittag
+    scmid: git-repo
+    sourceid: src-git
+    spec:
+      message: "Created by Updatecli"
+  create-github-tag:
+    name: Create the git tag 'v0.0.1' in the GitHub repository
+    kind: gittag
+    scmid: github-repo
+    sourceid: echo-version
+    spec:
+      message: "Created by Updatecli"

e2e/updatecli.d/success.d/gittag.yaml

@@ -6,6 +6,7 @@ import (
 	"github.com/sirupsen/logrus"
 	"github.com/updatecli/updatecli/pkg/core/pipeline/scm"
 	"github.com/updatecli/updatecli/pkg/core/result"
+	"github.com/updatecli/updatecli/pkg/plugins/utils/version"
 )
 
 // Target creates a tag if needed from a local git repository, without pushing the tag
@@ -55,7 +56,7 @@ func (gt *GitTag) target(source string, dryRun bool, resultTarget *result.Target
 	resultTarget.Files = []string{""}
 
 	// Fail if a pattern is specified
-	if gt.versionFilter.Pattern != "" {
+	if gt.spec.VersionFilter.Pattern != "" {
 		return fmt.Errorf("target validation error: spec.versionfilter.pattern is not allowed for targets of type gittag")
 	}
 
@@ -73,7 +74,8 @@ func (gt *GitTag) target(source string, dryRun bool, resultTarget *result.Target
 	}
 
 	gt.foundVersion, err = gt.versionFilter.Search(tags)
-	if err != nil && err.Error() != fmt.Sprintf("No version found matching pattern %q", source) {
+	notFoundError := &version.ErrNoVersionFoundForPattern{Pattern: source}
+	if err != nil && err.Error() != notFoundError.Error() {
 		return err
 	}
 

pkg/plugins/resources/gittag/target.go

@@ -0,0 +1,52 @@
+package version
+
+import (
+	"errors"
+	"fmt"
+)
+
+var (
+	// ErrNoVersionFound return a error when no version couldn't be found
+	ErrNoVersionFound error = errors.New("no version found")
+	// ErrNoVersionsFound return a error when the versions list is empty
+	ErrNoVersionsFound error = errors.New("versions list empty")
+	// ErrNoValidSemVerFound return a error when the versions list is empty
+	ErrNoValidSemVerFound error = errors.New("no valid semantic version found")
+)
+
+// ErrNoVersionFoundForPattern returns when a given pattern does not find any version
+type ErrNoVersionFoundForPattern struct {
+	Pattern string
+}
+
+func (e *ErrNoVersionFoundForPattern) Error() string {
+	return fmt.Sprintf("no version found matching pattern %q", e.Pattern)
+}
+
+// ErrUnsupportedVersionKind returns when the provided version filter is unsupported
+type ErrUnsupportedVersionKind struct {
+	Kind string
+}
+
+func (e *ErrUnsupportedVersionKind) Error() string {
+	return fmt.Sprintf("unsupported version kind %q", e.Kind)
+}
+
+// ErrUnsupportedVersionKind returns when the provided combination of version and pattern filter is unsupported
+type ErrUnsupportedVersionKindPattern struct {
+	Kind    string
+	Pattern string
+}
+
+func (e *ErrUnsupportedVersionKindPattern) Error() string {
+	return fmt.Sprintf("unsupported version kind %q with pattern %q", e.Kind, e.Pattern)
+}
+
+// ErrUnsupportedVersionKind returns when the provided combination of version and pattern filter is unsupported
+type ErrIncorrectSemVerConstraint struct {
+	SemVerConstraint string
+}
+
+func (e *ErrIncorrectSemVerConstraint) Error() string {
+	return fmt.Sprintf("wrong semantic versioning constraint %q", e.SemVerConstraint)
+}

pkg/plugins/utils/version/errors.go

@@ -68,7 +68,7 @@ func (f Filter) Validate() error {
 		}
 	}
 	if !ok {
-		return fmt.Errorf("unsupported version kind %q", f.Kind)
+		return &ErrUnsupportedVersionKind{Kind: f.Kind}
 	}
 	return nil
 }
@@ -124,10 +124,10 @@ func (f *Filter) Search(versions []string) (Version, error) {
 
 		return s.FoundVersion, nil
 	default:
-		return foundVersion, fmt.Errorf("unsupported version kind %q with pattern %q", f.Kind, f.Pattern)
+		return foundVersion, &ErrUnsupportedVersionKindPattern{Pattern: f.Pattern, Kind: f.Kind}
 	}
 
-	return foundVersion, fmt.Errorf("no version found matching pattern %q", f.Pattern)
+	return foundVersion, &ErrNoVersionFoundForPattern{Pattern: f.Pattern}
 }
 
 // IsZero return true if filter is not initialized
@@ -218,13 +218,13 @@ func (f *Filter) GreaterThanPattern(version string) (string, error) {
 			fmt.Println(version)
 			_, err = sv.NewConstraint(version)
 			if err != nil {
-				return "", fmt.Errorf("wrong semantic versioning constraint %q", version)
+				return "", &ErrIncorrectSemVerConstraint{SemVerConstraint: version}
 			}
 			return version, nil
 
 		default:
 			return f.Pattern, nil
 		}
 	}
-	return "", fmt.Errorf("kind %q not supported", f.Kind)
+	return "", &ErrUnsupportedVersionKind{Kind: f.Kind}
 }

pkg/plugins/utils/version/filter.go

@@ -2,7 +2,6 @@ package version
 
 import (
 	"errors"
-	"fmt"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -105,7 +104,7 @@ func TestSearch(t *testing.T) {
 			},
 			versions: []string{"updatecli-1.0", "updatecli-2.0", "updatecli-3.0"},
 			want:     Version{},
-			wantErr:  fmt.Errorf(`no version found matching pattern "^updatecli-4.(\\d*)$"`),
+			wantErr:  &ErrNoVersionFoundForPattern{Pattern: "^updatecli-4.(\\d*)$"},
 		},
 	}
 	for _, tt := range tests {
@@ -152,7 +151,7 @@ func TestValidate(t *testing.T) {
 				Kind:    "noExist",
 				Pattern: "~2",
 			},
-			wantErr: errors.New(`unsupported version kind "noExist"`),
+			wantErr: &ErrUnsupportedVersionKind{Kind: "noExist"},
 		},
 	}
 	for _, tt := range tests {
@@ -306,23 +305,28 @@ func TestGreaterThanPattern(t *testing.T) {
 				Kind:    SEMVERVERSIONKIND,
 				Pattern: "*",
 			},
-			version: "v0.0.0-20220606043923-3cf50f8a0a29", want: ">=0.0.0-20220606043923-3cf50f8a0a29",
+			version: "v0.0.0-20220606043923-3cf50f8a0a29",
+			want:    ">=0.0.0-20220606043923-3cf50f8a0a29",
 		},
 		{
 			name: "Wrong Semver Version",
 			filter: Filter{
 				Kind:    SEMVERVERSIONKIND,
 				Pattern: "*",
 			},
-			version: "v0.0.0_20220606043923-3cf50f8a0a29", want: "", wantErr: errors.New("wrong semantic versioning constraint \"v0.0.0_20220606043923-3cf50f8a0a29\""),
+			version: "v0.0.0_20220606043923-3cf50f8a0a29",
+			want:    "",
+			wantErr: &ErrIncorrectSemVerConstraint{SemVerConstraint: "v0.0.0_20220606043923-3cf50f8a0a29"},
 		},
 		{
 			name: "Wrong Semver Constraint",
 			filter: Filter{
 				Kind:    SEMVERVERSIONKIND,
 				Pattern: "*",
 			},
-			version: "1.0 - 2.0 !!!", want: "", wantErr: errors.New("wrong semantic versioning constraint \"1.0 - 2.0 !!!\""),
+			version: "1.0 - 2.0 !!!",
+			want:    "",
+			wantErr: &ErrIncorrectSemVerConstraint{SemVerConstraint: "1.0 - 2.0 !!!"},
 		},
 	}
 	for _, tt := range tests {

pkg/plugins/utils/version/filter_test.go

@@ -1,8 +1,6 @@
 package version
 
 import (
-	"errors"
-	"fmt"
 	"sort"
 
 	sv "github.com/Masterminds/semver/v3"
@@ -17,13 +15,6 @@ type Semver struct {
 	Strict       bool
 }
 
-var (
-	// ErrNoVersionFound return a error when no version couldn't be found
-	ErrNoVersionFound error = errors.New("no version found")
-	// ErrNoVersionsFound return a error when the versions list is empty
-	ErrNoVersionsFound error = errors.New("versions list empty")
-)
-
 // Init creates a new semver object
 func (s *Semver) Init(versions []string) error {
 
@@ -49,7 +40,7 @@ func (s *Semver) Init(versions []string) error {
 		return nil
 	}
 
-	return fmt.Errorf("no valid semantic version found")
+	return ErrNoValidSemVerFound
 }
 
 // Sort re-order a list of versions with the newest version first