feat(plugins): add support for latest version, fix version preference for duplicate plugins (#2158)

* chore(plugins): remove unused functions

* chore(plugins): rename test functions

* chore(plugins): add test for SomeVersionOf

* chore(plugins): add test for HasExactVersionOf

* chore(plugins): add test for HasNewerVersionOf

* chore(plugins): extend TestPluginListString to cover string generation

* chore(plugins): refactor TestPluginListSanitize

* chore(plugins): extend TestPluginListSanitize to cover incorrect versions

* feat(plugins): add support for latest version

* chore(plugins): deprecate unused Hash method

* fix(plugins): correctly update plugin version and add tests

* chore(grafana): deprecate unused PLUGINS_HASH env

* chore(plugins): update docs

* feat(plugins): add String method to GrafanaPlugin

* feat(plugins): add HasValidVersion and HasInvalidVersion to GrafanaPlugin

Author: weisdd

api/v1beta1/grafana_types.go

@@ -27,6 +27,10 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
+const (
+	PluginVersionLatest string = "latest"
+)
+
 type OperatorStageName string
 
 type OperatorStageStatus string

api/v1beta1/plugin_list.go

@@ -1,9 +1,7 @@
 package v1beta1
 
 import (
-	"crypto/sha256"
 	"fmt"
-	"io"
 	"sort"
 	"strings"
 
@@ -15,26 +13,37 @@ type GrafanaPlugin struct {
 	Version string `json:"version"`
 }
 
-type PluginList []GrafanaPlugin
+func (p GrafanaPlugin) HasValidVersion() bool {
+	if p.Version == PluginVersionLatest {
+		return true
+	}
 
-type PluginMap map[string]PluginList
+	_, err := semver.Parse(p.Version)
 
-func (l PluginList) Hash() string {
-	sb := strings.Builder{}
-	for _, plugin := range l {
-		sb.WriteString(plugin.Name)
-		sb.WriteString(plugin.Version)
+	return err == nil
+}
+
+func (p GrafanaPlugin) HasInvalidVersion() bool {
+	return !p.HasValidVersion()
+}
+
+func (p GrafanaPlugin) String() string {
+	if p.Version == PluginVersionLatest {
+		return p.Name
 	}
 
-	hash := sha256.New()
-	io.WriteString(hash, sb.String()) //nolint
-	return fmt.Sprintf("%x", hash.Sum(nil))
+	return fmt.Sprintf("%s %s", p.Name, p.Version)
 }
 
+type PluginList []GrafanaPlugin
+
+type PluginMap map[string]PluginList
+
 func (l PluginList) String() string {
 	plugins := make(sort.StringSlice, 0, len(l))
+
 	for _, plugin := range l {
-		plugins = append(plugins, fmt.Sprintf("%s %s", plugin.Name, plugin.Version))
+		plugins = append(plugins, plugin.String())
 	}
 
 	sort.Sort(plugins)
@@ -44,9 +53,9 @@ func (l PluginList) String() string {
 
 // Update update plugin version
 func (l PluginList) Update(plugin *GrafanaPlugin) {
-	for _, installedPlugin := range l {
+	for i, installedPlugin := range l {
 		if installedPlugin.Name == plugin.Name {
-			installedPlugin.Version = plugin.Version
+			l[i].Version = plugin.Version
 			break
 		}
 	}
@@ -57,8 +66,7 @@ func (l PluginList) Sanitize() PluginList {
 	var sanitized PluginList
 
 	for _, plugin := range l {
-		_, err := semver.Parse(plugin.Version)
-		if err != nil {
+		if plugin.HasInvalidVersion() {
 			continue
 		}
 
@@ -81,17 +89,6 @@ func (l PluginList) HasSomeVersionOf(plugin *GrafanaPlugin) bool {
 	return false
 }
 
-// GetInstalledVersionOf gets the plugin from the list regardless of the version
-func (l PluginList) GetInstalledVersionOf(plugin *GrafanaPlugin) *GrafanaPlugin {
-	for _, listedPlugin := range l {
-		if listedPlugin.Name == plugin.Name {
-			return &listedPlugin
-		}
-	}
-
-	return nil
-}
-
 // HasExactVersionOf returns true if the list contains the same plugin in the same version
 func (l PluginList) HasExactVersionOf(plugin *GrafanaPlugin) bool {
 	for _, listedPlugin := range l {
@@ -110,6 +107,14 @@ func (l PluginList) HasNewerVersionOf(plugin *GrafanaPlugin) (bool, error) {
 			continue
 		}
 
+		if listedPlugin.Version == PluginVersionLatest && plugin.Version != PluginVersionLatest {
+			return true, nil
+		}
+
+		if plugin.Version == PluginVersionLatest {
+			return false, nil
+		}
+
 		listedVersion, err := semver.Parse(listedPlugin.Version)
 		if err != nil {
 			return false, err
@@ -127,16 +132,3 @@ func (l PluginList) HasNewerVersionOf(plugin *GrafanaPlugin) (bool, error) {
 
 	return false, nil
 }
-
-// VersionsOf returns the number of different versions of a given plugin in the list
-func (l PluginList) VersionsOf(plugin *GrafanaPlugin) int {
-	i := 0
-
-	for _, listedPlugin := range l {
-		if listedPlugin.Name == plugin.Name {
-			i++
-		}
-	}
-
-	return i
-}