Add github client support (#51)

Signed-off-by: Aniruddha Basak <[email protected]>

Author: Aniruddha Basak

.gitignore

@@ -1,4 +1,4 @@
-
+.envrc
 # Binaries for programs and plugins
 *.exe
 *.exe~

github-release/docker-ferrol-1-27-v2/hashes.json

@@ -27,7 +27,7 @@ import (
 // Component contains component.
 type Component struct {
 	ClusterAddon string `yaml:"clusterAddon"`
-	NodeImage    string `yaml:"nodeImage"`
+	NodeImage    string `yaml:"nodeImage,omitempty"`
 }
 
 // Versions contains version information.
@@ -45,16 +45,7 @@ type MetaData struct {
 
 // ParseMetaData parse the metadata file.
 func ParseMetaData(path string) (MetaData, error) {
-	entries, err := os.ReadDir(path)
-	if err != nil {
-		return MetaData{}, fmt.Errorf("failed to read metadata directory: %w", err)
-	}
-
-	if len(entries) != 1 {
-		return MetaData{}, fmt.Errorf("ambiguous release found")
-	}
-
-	metadataPath := filepath.Join(path, entries[0].Name(), "metadata.yaml")
+	metadataPath := filepath.Join(path, "metadata.yaml")
 	fileInfo, err := os.ReadFile(filepath.Clean(metadataPath))
 	if err != nil {
 		return MetaData{}, fmt.Errorf("failed to read metadata file: %w", err)

github-release/docker-ferrol-1-27-v2/metadata.yaml

@@ -17,13 +17,15 @@ limitations under the License.
 package cmd
 
 import (
+	"context"
 	"encoding/json"
 	"fmt"
 	"os"
 	"path/filepath"
 
 	"github.com/SovereignCloudStack/csctl/pkg/clusterstack"
 	"github.com/SovereignCloudStack/csctl/pkg/github"
+	"github.com/SovereignCloudStack/csctl/pkg/github/client"
 	"github.com/SovereignCloudStack/csctl/pkg/hash"
 	"github.com/SovereignCloudStack/csctl/pkg/template"
 	"github.com/spf13/cobra"
@@ -50,8 +52,6 @@ var (
 var (
 	mode            string
 	outputDirectory string
-	// TODO: remove this later.
-	githubReleasePath string
 )
 
 // CreateOptions contains config for creating a release.
@@ -77,12 +77,10 @@ var createCmd = &cobra.Command{
 func init() {
 	createCmd.Flags().StringVarP(&mode, "mode", "m", "stable", "It defines the mode of the cluster stack manager")
 	createCmd.Flags().StringVarP(&outputDirectory, "output", "o", "./releases", "It defines the output directory in which the release artifacts will be generated")
-	// TODO: remove this later
-	createCmd.Flags().StringVar(&githubReleasePath, "github-release", "github-release", "It is used to get the path to local github release (for stable mode only)")
 }
 
 // GetCreateOptions create a Create Option for create command.
-func GetCreateOptions(clusterStackPath string) (*CreateOptions, error) {
+func GetCreateOptions(ctx context.Context, clusterStackPath string) (*CreateOptions, error) {
 	createOption := &CreateOptions{}
 
 	// ClusterAddon config
@@ -106,20 +104,35 @@ func GetCreateOptions(clusterStackPath string) (*CreateOptions, error) {
 			return nil, fmt.Errorf("failed to handle hash mode: %w", err)
 		}
 	case stableMode:
-		createOption.Metadata, err = clusterstack.HandleStableMode(githubReleasePath, createOption.CurrentReleaseHash, createOption.LatestReleaseHash)
+		gc, err := client.NewFactory().NewClient(ctx)
 		if err != nil {
-			return nil, fmt.Errorf("failed to handle stable mode: %w", err)
+			return nil, fmt.Errorf("failed to create new github client: %w", err)
 		}
 
 		// update the metadata kubernetes version with the csmctl.yaml config
 		createOption.Metadata.Versions.Kubernetes = config.Config.KubernetesVersion
 
-		// TODO: remove
-		latestReleaseInfoWithHash, err := github.GetLocalReleaseInfoWithHash(githubReleasePath)
+		latestRepoRelease, err := github.GetLatestReleaseFromRemoteRepository(ctx, mode, &config, gc)
 		if err != nil {
-			return nil, fmt.Errorf("failed to get latest github local release: %w", err)
+			return nil, fmt.Errorf("failed to get latest release form remote repository: %w", err)
+		}
+		fmt.Printf("latest release found: %q\n", latestRepoRelease)
+
+		if latestRepoRelease == "" {
+			createOption.Metadata.APIVersion = "metadata.clusterstack.x-k8s.io/v1alpha1"
+			createOption.Metadata.Versions.Kubernetes = config.Config.KubernetesVersion
+			createOption.Metadata.Versions.ClusterStack = "v1"
+			createOption.Metadata.Versions.Components.ClusterAddon = "v1"
+		} else {
+			if err := github.DownloadReleaseAssets(ctx, latestRepoRelease, "./tmp/releases/", gc); err != nil {
+				return nil, fmt.Errorf("failed to download release asset: %w", err)
+			}
+
+			createOption.Metadata, err = clusterstack.HandleStableMode("./tmp/releases/", createOption.CurrentReleaseHash, createOption.LatestReleaseHash)
+			if err != nil {
+				return nil, fmt.Errorf("failed to handle stable mode: %w", err)
+			}
 		}
-		createOption.LatestReleaseHash = latestReleaseInfoWithHash.Hash
 	}
 
 	releaseDirName, err := clusterstack.GetClusterStackReleaseDirectoryName(&createOption.Metadata, &createOption.Config)
@@ -132,7 +145,7 @@ func GetCreateOptions(clusterStackPath string) (*CreateOptions, error) {
 	return createOption, nil
 }
 
-func createAction(_ *cobra.Command, args []string) error {
+func createAction(cmd *cobra.Command, args []string) error {
 	if len(args) != 1 {
 		return fmt.Errorf("please provide a valid command, create only accept one argument to path to the cluster stacks")
 	}
@@ -143,7 +156,7 @@ func createAction(_ *cobra.Command, args []string) error {
 		return fmt.Errorf("mode is not supported please choose from - stable, hash")
 	}
 
-	createOpts, err := GetCreateOptions(clusterStackPath)
+	createOpts, err := GetCreateOptions(cmd.Context(), clusterStackPath)
 	if err != nil {
 		return fmt.Errorf("failed to create create options: %w", err)
 	}

pkg/clusterstack/metadata.go

@@ -0,0 +1,62 @@
+package github
+
+import (
+	"context"
+	"fmt"
+	"sort"
+
+	csoclusterstack "github.com/SovereignCloudStack/cluster-stack-operator/pkg/clusterstack"
+	"github.com/SovereignCloudStack/cluster-stack-operator/pkg/version"
+	"github.com/SovereignCloudStack/csctl/pkg/clusterstack"
+	githubclient "github.com/SovereignCloudStack/csctl/pkg/github/client"
+)
+
+// GetLatestReleaseFromRemoteRepository returns the latest release from the github repository.
+func GetLatestReleaseFromRemoteRepository(ctx context.Context, mode string, config *clusterstack.CsctlConfig, gc githubclient.Client) (string, error) {
+	ghReleases, resp, err := gc.ListRelease(ctx)
+	if err != nil {
+		return "", fmt.Errorf("failed to list releases on remote Git repository: %w", err)
+	}
+	if resp != nil && resp.StatusCode != 200 {
+		return "", fmt.Errorf("got unexpected status from call to remote Git repository: %s", resp.Status)
+	}
+
+	var clusterStacks csoclusterstack.ClusterStacks
+
+	for _, ghRelease := range ghReleases {
+		clusterStackObject, matches, err := matchesSpec(ghRelease.GetTagName(), mode, config)
+		if err != nil {
+			return "", fmt.Errorf("failed to get match release tag %q with spec of ClusterStack: %w", ghRelease.GetTagName(), err)
+		}
+
+		if matches {
+			clusterStacks = append(clusterStacks, clusterStackObject)
+		}
+	}
+
+	if len(clusterStacks) == 0 {
+		return "", nil
+	}
+
+	sort.Sort(clusterStacks)
+
+	str := clusterStacks.Latest().String()
+	return str, nil
+}
+
+func matchesSpec(releaseTagName, mode string, cs *clusterstack.CsctlConfig) (csoclusterstack.ClusterStack, bool, error) {
+	csObject, err := csoclusterstack.NewFromClusterStackReleaseProperties(releaseTagName)
+	if err != nil {
+		return csoclusterstack.ClusterStack{}, false, fmt.Errorf("failed to get clusterstack object from string %q: %w", releaseTagName, err)
+	}
+
+	kubernetesVersion, err := cs.ParseKubernetesVersion()
+	if err != nil {
+		return csoclusterstack.ClusterStack{}, false, fmt.Errorf("failed to parse kubernetes version %q: %w", cs.Config.ClusterStackName, err)
+	}
+
+	return csObject, csObject.Version.Channel == version.Channel(mode) &&
+		csObject.KubernetesVersion.StringWithDot() == kubernetesVersion.StringWithDot() &&
+		csObject.Name == cs.Config.ClusterStackName &&
+		csObject.Provider == cs.Config.Provider.Type, nil
+}

pkg/cmd/create.go

@@ -18,63 +18,33 @@ limitations under the License.
 package github
 
 import (
-	"encoding/json"
+	"context"
 	"fmt"
+	"net/http"
 	"os"
-	"path/filepath"
-	"strings"
 
-	"github.com/SovereignCloudStack/csctl/pkg/hash"
+	githubclient "github.com/SovereignCloudStack/csctl/pkg/github/client"
 )
 
-// GHRelease contains fields for a release.
-type GHRelease struct {
-	Provider               string
-	ClusterStackName       string
-	KubernetesVersionMajor string
-	KubernetesVersionMinor string
-	ClusterStackVersion    string
-
-	Hash hash.ReleaseHash
-}
-
-// GetLocalReleaseInfoWithHash gets the local release info.
-// TODO: Later replaced by the original github release fetching code.
-func GetLocalReleaseInfoWithHash(path string) (GHRelease, error) {
-	entries, err := os.ReadDir(path)
+// DownloadReleaseAssets downloads the specified release in the specified download path.
+func DownloadReleaseAssets(ctx context.Context, releaseTag, downloadPath string, gc githubclient.Client) error {
+	repoRelease, resp, err := gc.GetReleaseByTag(ctx, releaseTag)
 	if err != nil {
-		return GHRelease{}, fmt.Errorf("failed to read github release path: %w", err)
+		return fmt.Errorf("failed to fetch release tag %q: %w", releaseTag, err)
 	}
-
-	if len(entries) != 1 {
-		return GHRelease{}, fmt.Errorf("ambiguous release found")
+	if resp.StatusCode != http.StatusOK {
+		return fmt.Errorf("failed to fetch release tag %s with status code %d", releaseTag, resp.StatusCode)
 	}
 
-	splittedReleaseName := strings.Split(entries[0].Name(), "-")
-
-	if len(splittedReleaseName) != 5 {
-		return GHRelease{}, fmt.Errorf("wrong release found")
-	}
-
-	ghRelease := GHRelease{
-		Provider:               splittedReleaseName[0],
-		ClusterStackName:       splittedReleaseName[1],
-		KubernetesVersionMajor: splittedReleaseName[2],
-		KubernetesVersionMinor: splittedReleaseName[3],
-		ClusterStackVersion:    splittedReleaseName[4],
-	}
-
-	hashPath := filepath.Join(path, entries[0].Name(), "hashes.json")
-	hashFile, err := os.ReadFile(filepath.Clean(hashPath))
-	if err != nil {
-		return GHRelease{}, fmt.Errorf("failed to read hash.json: %w", err)
-	}
+	assetlist := []string{"metadata.yaml", "cluster-addon-values.yaml", "cluster-addon", "cluster-class"}
 
-	var data hash.ReleaseHash
-	if err := json.Unmarshal(hashFile, &data); err != nil {
-		return GHRelease{}, fmt.Errorf("failed to unmarshal release hash: %w", err)
+	if err := gc.DownloadReleaseAssets(ctx, repoRelease, downloadPath, assetlist); err != nil {
+		// if download failed for some reason, delete the release directory so that it can be retried in the next reconciliation
+		if err := os.RemoveAll(downloadPath); err != nil {
+			return fmt.Errorf("failed to remove release: %w", err)
+		}
+		return fmt.Errorf("failed to download release assets: %w", err)
 	}
-	ghRelease.Hash = data
 
-	return ghRelease, nil
+	return nil
 }