Restructure code to have better readability

Signed-off-by: Aniruddha Basak <aniruddha.basak@syself.com>

Author: Aniruddha Basak

go.mod

@@ -9,7 +9,7 @@ require (
 	github.com/valyala/fasttemplate v1.2.2
 	golang.org/x/mod v0.14.0
 	golang.org/x/oauth2 v0.16.0
-	gopkg.in/src-d/go-git.v4 v4.13.1
+	gopkg.in/yaml.v2 v2.4.0
 	gopkg.in/yaml.v3 v3.0.1
 	helm.sh/helm/v3 v3.13.3
 )
@@ -39,7 +39,6 @@ require (
 	github.com/docker/go-metrics v0.0.1 // indirect
 	github.com/docker/go-units v0.5.0 // indirect
 	github.com/emicklei/go-restful/v3 v3.10.2 // indirect
-	github.com/emirpasic/gods v1.12.0 // indirect
 	github.com/evanphx/json-patch v5.6.0+incompatible // indirect
 	github.com/exponent-io/jsonpath v0.0.0-20151013193312-d6023ce2651d // indirect
 	github.com/fatih/color v1.13.0 // indirect
@@ -68,11 +67,9 @@ require (
 	github.com/huandu/xstrings v1.4.0 // indirect
 	github.com/imdario/mergo v0.3.13 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
-	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
 	github.com/jmoiron/sqlx v1.3.5 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
-	github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd // indirect
 	github.com/klauspost/compress v1.16.0 // indirect
 	github.com/lann/builder v0.0.0-20180802200727-47ae307949d0 // indirect
 	github.com/lann/ps v0.0.0-20150810152359-62de8c46ede0 // indirect
@@ -84,7 +81,6 @@ require (
 	github.com/mattn/go-runewidth v0.0.9 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
 	github.com/mitchellh/copystructure v1.2.0 // indirect
-	github.com/mitchellh/go-homedir v1.1.0 // indirect
 	github.com/mitchellh/go-wordwrap v1.0.1 // indirect
 	github.com/mitchellh/reflectwalk v1.0.2 // indirect
 	github.com/moby/locker v1.0.1 // indirect
@@ -105,14 +101,11 @@ require (
 	github.com/prometheus/procfs v0.10.1 // indirect
 	github.com/rubenv/sql-migrate v1.5.2 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
-	github.com/sergi/go-diff v1.1.0 // indirect
 	github.com/shopspring/decimal v1.3.1 // indirect
 	github.com/sirupsen/logrus v1.9.3 // indirect
 	github.com/spf13/cast v1.5.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
-	github.com/src-d/gcfg v1.4.0 // indirect
 	github.com/valyala/bytebufferpool v1.0.0 // indirect
-	github.com/xanzy/ssh-agent v0.2.1 // indirect
 	github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb // indirect
 	github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
 	github.com/xeipuuv/gojsonschema v1.2.0 // indirect
@@ -132,9 +125,6 @@ require (
 	google.golang.org/grpc v1.56.3 // indirect
 	google.golang.org/protobuf v1.31.0 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
-	gopkg.in/src-d/go-billy.v4 v4.3.2 // indirect
-	gopkg.in/warnings.v0 v0.1.2 // indirect
-	gopkg.in/yaml.v2 v2.4.0 // indirect
 	k8s.io/api v0.28.4 // indirect
 	k8s.io/apiextensions-apiserver v0.28.4 // indirect
 	k8s.io/apimachinery v0.28.4 // indirect

go.sum

@@ -26,6 +26,7 @@ import (
 	"strings"
 
 	"github.com/SovereignCloudStack/cluster-stack-operator/pkg/kubernetesversion"
+	"github.com/SovereignCloudStack/cluster-stack-operator/pkg/version"
 	"gopkg.in/yaml.v3"
 )
 
@@ -44,45 +45,45 @@ type CsmctlConfig struct {
 }
 
 // GetCsmctlConfig returns CsmctlConfig.
-func GetCsmctlConfig(path string) (*CsmctlConfig, error) {
+func GetCsmctlConfig(path string) (CsmctlConfig, error) {
 	configPath := filepath.Join(path, "csmctl.yaml")
 	configFileData, err := os.ReadFile(filepath.Clean(configPath))
 	if err != nil {
-		return nil, fmt.Errorf("failed to read csmctl config: %w", err)
+		return CsmctlConfig{}, fmt.Errorf("failed to read csmctl config: %w", err)
 	}
 
-	cs := &CsmctlConfig{}
+	cs := CsmctlConfig{}
 	if err := yaml.Unmarshal(configFileData, &cs); err != nil {
-		return nil, fmt.Errorf("failed to unmarshal csmctl yaml: %w", err)
+		return CsmctlConfig{}, fmt.Errorf("failed to unmarshal csmctl yaml: %w", err)
 	}
 
 	if cs.Config.Provider.Type == "" {
-		return nil, fmt.Errorf("provider type must not be empty")
+		return CsmctlConfig{}, fmt.Errorf("provider type must not be empty")
 	}
 
 	if len(cs.Config.Provider.Type) > 253 {
-		return nil, fmt.Errorf("provider name must not be greater than 253")
+		return CsmctlConfig{}, fmt.Errorf("provider name must not be greater than 253")
 	}
 
 	match, err := regexp.MatchString(`^[a-z0-9]([-a-z0-9]*[a-z0-9])?$`, cs.Config.Provider.Type)
 	if err != nil {
-		return nil, fmt.Errorf("failed to provider name match regex: %w", err)
+		return CsmctlConfig{}, fmt.Errorf("failed to provider name match regex: %w", err)
 	}
 	if !match {
-		return nil, fmt.Errorf("invalid provider type: %q", cs.Config.Provider.Type)
+		return CsmctlConfig{}, fmt.Errorf("invalid provider type: %q", cs.Config.Provider.Type)
 	}
 
 	if cs.Config.ClusterStackName == "" {
-		return nil, fmt.Errorf("cluster stack name must not be empty")
+		return CsmctlConfig{}, fmt.Errorf("cluster stack name must not be empty")
 	}
 
 	// Validate kubernetes version
 	matched, err := regexp.MatchString(`^v\d+\.\d+\.\d+$`, cs.Config.KubernetesVersion)
 	if err != nil {
-		return nil, fmt.Errorf("failed to kubernetes match regex: %w", err)
+		return CsmctlConfig{}, fmt.Errorf("failed to kubernetes match regex: %w", err)
 	}
 	if !matched {
-		return nil, fmt.Errorf("invalid kubernetes version: %q", cs.Config.KubernetesVersion)
+		return CsmctlConfig{}, fmt.Errorf("invalid kubernetes version: %q", cs.Config.KubernetesVersion)
 	}
 
 	return cs, nil
@@ -111,3 +112,22 @@ func (c *CsmctlConfig) ParseKubernetesVersion() (kubernetesversion.KubernetesVer
 		Minor: minor,
 	}, nil
 }
+
+// GetClusterStackReleaseDirectoryName returns cluster stack release directory.
+// e.g. - docker-ferrol-1-27-v1/ .
+func GetClusterStackReleaseDirectoryName(metadata *MetaData, config *CsmctlConfig) (string, error) {
+	// Parse the cluster stack version from dot format `v1-alpha.0` to a version way of struct
+	// and parse the kubernetes version from `v1.27.3` to a major minor way
+	// and create the release directory at the end.
+	clusterStackVersion, err := version.New(metadata.Versions.ClusterStack)
+	if err != nil {
+		return "", fmt.Errorf("failed to parse cluster stack version: %w", err)
+	}
+	kubernetesVerion, err := config.ParseKubernetesVersion()
+	if err != nil {
+		return "", fmt.Errorf("failed to parse kubernetes version: %w", err)
+	}
+	clusterStackReleaseDirName := fmt.Sprintf("%s-%s-%s-%s", config.Config.Provider.Type, config.Config.ClusterStackName, kubernetesVerion.String(), clusterStackVersion.String())
+
+	return clusterStackReleaseDirName, nil
+}

pkg/clusterstack/config.go

@@ -24,40 +24,46 @@ import (
 	"gopkg.in/yaml.v3"
 )
 
-// MetaData contains information of the metadata.yaml.
+// Component contains component.
+type Component struct {
+	ClusterAddon string `yaml:"clusterAddon"`
+	NodeImage    string `yaml:"nodeImage"`
+}
+
+// Versions contains version information.
+type Versions struct {
+	ClusterStack string    `yaml:"clusterStack"`
+	Kubernetes   string    `yaml:"kubernetes"`
+	Components   Component `yaml:"components"`
+}
+
+// MetaData contains metadata.
 type MetaData struct {
-	APIVersion string `yaml:"apiVersion"`
-	Versions   struct {
-		ClusterStack string `yaml:"clusterStack"`
-		Kubernetes   string `yaml:"kubernetes"`
-		Components   struct {
-			ClusterAddon string `yaml:"clusterAddon"`
-			NodeImage    string `yaml:"nodeImage,omitempty"`
-		} `yaml:"components"`
-	} `yaml:"versions"`
+	APIVersion string   `yaml:"apiVersion"`
+	Versions   Versions `yaml:"versions"`
 }
 
 // ParseMetaData parse the metadata file.
-func ParseMetaData(path string) (*MetaData, error) {
+func ParseMetaData(path string) (MetaData, error) {
 	entries, err := os.ReadDir(path)
 	if err != nil {
-		return nil, fmt.Errorf("failed to read metadata directory: %w", err)
+		return MetaData{}, fmt.Errorf("failed to read metadata directory: %w", err)
 	}
 
 	if len(entries) != 1 {
-		return nil, fmt.Errorf("ambiguous release found")
+		return MetaData{}, fmt.Errorf("ambiguous release found")
 	}
 
 	metadataPath := filepath.Join(path, entries[0].Name(), "metadata.yaml")
 	fileInfo, err := os.ReadFile(filepath.Clean(metadataPath))
 	if err != nil {
-		return nil, fmt.Errorf("failed to read metadata file: %w", err)
+		return MetaData{}, fmt.Errorf("failed to read metadata file: %w", err)
 	}
 
-	metaData := &MetaData{}
+	metaData := MetaData{}
 
 	if err := yaml.Unmarshal(fileInfo, &metaData); err != nil {
-		return nil, fmt.Errorf("failed to unmarshal metadata yaml: %w", err)
+		return MetaData{}, fmt.Errorf("failed to unmarshal metadata yaml: %w", err)
 	}
 
 	return metaData, nil

pkg/clusterstack/metadata.go

@@ -0,0 +1,61 @@
+package clusterstack
+
+import (
+	"fmt"
+
+	"github.com/SovereignCloudStack/csmctl/pkg/hash"
+)
+
+// HandleStableMode returns metadata for the stable mode.
+func HandleStableMode(gitHubReleasePath string, currentReleaseHash, latestReleaseHash hash.ReleaseHash) (MetaData, error) {
+	metadata, err := ParseMetaData(gitHubReleasePath)
+	if err != nil {
+		return MetaData{}, fmt.Errorf("failed to parse metadata: %w", err)
+	}
+
+	metadata.Versions.ClusterStack, err = BumpVersion(metadata.Versions.ClusterStack)
+	if err != nil {
+		return MetaData{}, fmt.Errorf("failed to bump cluster stack: %w", err)
+	}
+	fmt.Printf("Bumped ClusterStack Version: %s\n", metadata.Versions.ClusterStack)
+
+	if currentReleaseHash.ClusterAddonDir != latestReleaseHash.ClusterAddonDir || currentReleaseHash.ClusterAddonValues != latestReleaseHash.ClusterAddonValues {
+		metadata.Versions.Components.ClusterAddon, err = BumpVersion(metadata.Versions.Components.ClusterAddon)
+		if err != nil {
+			return MetaData{}, fmt.Errorf("failed to bump cluster addon: %w", err)
+		}
+		fmt.Printf("Bumped ClusterAddon Version: %s\n", metadata.Versions.Components.ClusterAddon)
+	} else {
+		fmt.Printf("ClusterAddon Version unchanged: %s\n", metadata.Versions.Components.ClusterAddon)
+	}
+
+	if currentReleaseHash.NodeImageDir != latestReleaseHash.NodeImageDir {
+		metadata.Versions.Components.NodeImage, err = BumpVersion(metadata.Versions.Components.NodeImage)
+		if err != nil {
+			return MetaData{}, fmt.Errorf("failed to bump node image: %w", err)
+		}
+		fmt.Printf("Bumped NodeImage Version: %s\n", metadata.Versions.Components.NodeImage)
+	} else {
+		fmt.Printf("NodeImage Version unchanged: %s\n", metadata.Versions.Components.NodeImage)
+	}
+
+	return metadata, nil
+}
+
+// HandleHashMode returns metadata of Hash mode.
+func HandleHashMode(currentRelease hash.ReleaseHash, kubernetesVersion string) MetaData {
+	clusterStackHash := currentRelease.GetClusterStackHash()
+	clusterStackHash = fmt.Sprintf("v0-sha.%s", clusterStackHash)
+
+	return MetaData{
+		APIVersion: "metadata.clusterstack.x-k8s.io/v1alpha1",
+		Versions: Versions{
+			Kubernetes:   kubernetesVersion,
+			ClusterStack: clusterStackHash,
+			Components: Component{
+				ClusterAddon: clusterStackHash,
+				NodeImage:    clusterStackHash,
+			},
+		},
+	}
+}