feat(portainer): sync version with license [EE-5765] (#18)

go.mod

@@ -14,6 +14,7 @@ require (
 )
 
 require (
+	github.com/Masterminds/semver v1.5.0 // indirect
 	github.com/Microsoft/go-winio v0.5.2 // indirect
 	github.com/containerd/containerd v1.6.2 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect

go.sum

@@ -42,6 +42,8 @@ github.com/Azure/go-autorest/logger v0.2.1/go.mod h1:T9E3cAhj2VqvPOtCYAvby9aBXkZ
 github.com/Azure/go-autorest/tracing v0.6.0/go.mod h1:+vhtPC754Xsa23ID7GlGsrdKBpUA79WCAKPPZVC2DeU=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
 github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo=
+github.com/Masterminds/semver v1.5.0 h1:H65muMkzWKEuNDnfl9d70GUjFniHKHRbFPGBuZ3QEww=
+github.com/Masterminds/semver v1.5.0/go.mod h1:MB6lktGJrhw8PrUyiEoblNEGEQ+RzHPF078ddwwvV3Y=
 github.com/Microsoft/go-winio v0.5.2 h1:a9IhgEQBCUEk6QCdml9CiJGhAws+YwffDHEMp1VMrpA=
 github.com/Microsoft/go-winio v0.5.2/go.mod h1:WpS1mjBmmwHBEWmogvA2mj8546UReBk4v8QkMxJ6pZY=
 github.com/NYTimes/gziphandler v0.0.0-20170623195520-56545f4a5d46/go.mod h1:3wb06e3pkSAbeQ52E9H9iFoQsEEwGN64994WTCIhntQ=

portainer/portainer.go

@@ -30,6 +30,8 @@ type Command struct {
 func (r *Command) Run() error {
 	ctx := context.Background()
 
+	r.Image = validateImageWithLicense(r.License, r.Image)
+
 	switch r.EnvType {
 	case EnvTypeDockerStandalone:
 		return r.runStandalone(ctx)

portainer/validate_image_license.go

@@ -0,0 +1,62 @@
+package portainer
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/Masterminds/semver"
+	"github.com/rs/zerolog/log"
+)
+
+// validateImageWithLicense validates the image name and tag based on the license type
+func validateImageWithLicense(license, image string) string {
+	if !strings.HasPrefix(license, "3-") {
+		log.Debug().
+			Str("license", license).
+			Msg("License is a valid type 2 Portainer EE license, leaving it as is")
+		return image
+	}
+
+	parts := strings.Split(image, ":")
+	if len(parts) != 2 {
+		log.Debug().
+			Str("imageName", image).
+			Msg("Image name is not a standard image (image:tag), leaving it as is")
+		return image
+	}
+
+	imageName := parts[0]
+	tag := parts[1]
+
+	if !strings.HasSuffix(imageName, "portainer-ee") {
+		log.Debug().
+			Str("imageName", image).
+			Msg("Image name is not portainer-ee, leaving it as is")
+		return image
+	}
+
+	requiredVersion, err := semver.NewVersion(tag)
+	if err != nil {
+		log.Debug().
+			Err(err).
+			Str("tag", tag).
+			Msg("Tag is not a valid semver, leaving it as is")
+		return image
+	}
+
+	minVersion := "2.18.4"
+	if requiredVersion.GreaterThan(semver.MustParse(minVersion)) {
+		log.Debug().
+			Str("tag", tag).
+			Str("minVersion", minVersion).
+			Msg("Tag is higher than minimum version, leaving it as is")
+		return image
+	}
+
+	log.Info().
+		Str("tag", tag).
+		Str("minVersion", minVersion).
+		Msg("Tag is lower than minimum version for this license type, updating version to 2.18.4")
+
+	return fmt.Sprintf("%s:%s", imageName, minVersion)
+}

portainer/validate_image_license_test.go

@@ -0,0 +1,63 @@
+package portainer
+
+import "testing"
+
+func TestValidateImageWithLicense(t *testing.T) {
+	tests := []struct {
+		name    string
+		license string
+		image   string
+		want    string
+	}{
+		{
+			name:    "valid type 2 license",
+			license: "2-abc123",
+			image:   "portainer-ee:2.18.4",
+			want:    "portainer-ee:2.18.4",
+		},
+		{
+			name:    "invalid license",
+			license: "1-abc123",
+			image:   "portainer-ee:2.18.4",
+			want:    "portainer-ee:2.18.4",
+		},
+		{
+			name:    "invalid image name",
+			license: "3-abc123",
+			image:   "invalid-image",
+			want:    "invalid-image",
+		},
+		{
+			name:    "invalid semver tag",
+			license: "3-abc123",
+			image:   "portainer-ee:invalid-tag",
+			want:    "portainer-ee:invalid-tag",
+		},
+		{
+			name:    "lower than minimum version",
+			license: "3-abc123",
+			image:   "portainer-ee:2.18.3",
+			want:    "portainer-ee:2.18.4",
+		},
+		{
+			name:    "higher than minimum version",
+			license: "3-abc123",
+			image:   "portainer-ee:2.18.5",
+			want:    "portainer-ee:2.18.5",
+		},
+		{
+			name:    "with repo name",
+			license: "3-abc123",
+			image:   "portainer/portainer-ee:2.18.2",
+			want:    "portainer/portainer-ee:2.18.4",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := validateImageWithLicense(tt.license, tt.image); got != tt.want {
+				t.Errorf("validateImageWithLicense() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}