hack: implement new api for add-version script

Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>

internal/versionsapi/versionsapi.go

@@ -14,6 +14,7 @@ import (
 	"net/http"
 	"net/url"
 	"path"
+	"regexp"
 	"strings"
 
 	"github.com/edgelesssys/constellation/v2/internal/constants"
@@ -28,23 +29,26 @@ import (
 // A List with granularity "minor" could contain the base version
 // "v1.0" and a list of patch versions "v1.0.0", "v1.0.1", "v1.0.2" etc.
 type List struct {
+	// Ref is the branch name the list belongs to.
+	Ref string `json:"ref,omitempty"`
 	// Stream is the update stream of the list.
 	// Currently, only "stable" and "debug" are supported.
-	Stream string `json:"stream"`
+	Stream string `json:"stream,omitempty"`
 	// Granularity is the granularity of the base version of this list.
 	// It can be either "major" or "minor".
-	Granularity string `json:"granularity"`
+	Granularity string `json:"granularity,omitempty"`
 	// Base is the base version of the list.
 	// Every version in the list is a finer-grained version of this base version.
-	Base string `json:"base"`
+	Base string `json:"base,omitempty"`
 	// Kind is the kind of resource this list is for.
-	Kind string `json:"kind"`
+	Kind string `json:"kind,omitempty"`
 	// Versions is a list of all versions in this list.
-	Versions []string `json:"versions"`
+	Versions []string `json:"versions,omitempty"`
 }
 
 // Validate checks if the list is valid.
 // This performs the following checks:
+// - The ref is set.
 // - The stream is supported.
 // - The granularity is "major" or "minor".
 // - The kind is supported.
@@ -52,8 +56,11 @@ type List struct {
 // - All versions in the list are valid semantic versions that are finer-grained than the base version.
 func (l *List) Validate() error {
 	var issues []string
-	if !IsValidStream(l.Stream) {
-		issues = append(issues, fmt.Sprintf("stream %q is not supported", l.Stream))
+	if !IsValidRef(l.Ref) {
+		issues = append(issues, "ref is empty")
+	}
+	if !IsValidStream(l.Ref, l.Stream) {
+		issues = append(issues, fmt.Sprintf("stream %q is not supported on ref %q", l.Stream, l.Ref))
 	}
 	if l.Granularity != "major" && l.Granularity != "minor" {
 		issues = append(issues, fmt.Sprintf("granularity %q is not supported", l.Granularity))
@@ -113,18 +120,18 @@ func New() *Fetcher {
 }
 
 // MinorVersionsOf fetches the list of minor versions for a given stream, major version and kind.
-func (f *Fetcher) MinorVersionsOf(ctx context.Context, stream, major, kind string) (*List, error) {
-	return f.list(ctx, stream, "major", major, kind)
+func (f *Fetcher) MinorVersionsOf(ctx context.Context, ref, stream, major, kind string) (*List, error) {
+	return f.list(ctx, stream, "major", major, ref, kind)
 }
 
 // PatchVersionsOf fetches the list of patch versions for a given stream, minor version and kind.
-func (f *Fetcher) PatchVersionsOf(ctx context.Context, stream, minor, kind string) (*List, error) {
-	return f.list(ctx, stream, "minor", minor, kind)
+func (f *Fetcher) PatchVersionsOf(ctx context.Context, ref, stream, minor, kind string) (*List, error) {
+	return f.list(ctx, stream, "minor", minor, ref, kind)
 }
 
 // list fetches the list of versions for a given stream, granularity, base and kind.
-func (f *Fetcher) list(ctx context.Context, stream, granularity, base, kind string) (*List, error) {
-	raw, err := getFromURL(ctx, f.httpc, stream, granularity, base, kind)
+func (f *Fetcher) list(ctx context.Context, ref, stream, granularity, base, kind string) (*List, error) {
+	raw, err := getFromURL(ctx, f.httpc, ref, stream, granularity, base, kind)
 	if err != nil {
 		return nil, fmt.Errorf("fetching versions list: %w", err)
 	}
@@ -146,13 +153,13 @@ func (f *Fetcher) listMatchesRequest(list *List, stream, granularity, base, kind
 }
 
 // getFromURL fetches the versions list from a URL.
-func getFromURL(ctx context.Context, client httpc, stream, granularity, base, kind string) ([]byte, error) {
+func getFromURL(ctx context.Context, client httpc, ref, stream, granularity, base, kind string) ([]byte, error) {
 	url, err := url.Parse(constants.CDNRepositoryURL)
 	if err != nil {
 		return nil, fmt.Errorf("parsing image version repository URL: %w", err)
 	}
 	kindFilename := path.Base(kind) + ".json"
-	url.Path = path.Join(constants.CDNVersionsPath, "stream", stream, granularity, base, kindFilename)
+	url.Path = path.Join(constants.CDNAPIPrefix, "ref", ref, "stream", stream, "versions", granularity, base, kindFilename)
 	req, err := http.NewRequestWithContext(ctx, http.MethodGet, url.String(), http.NoBody)
 	if err != nil {
 		return nil, err
@@ -179,8 +186,13 @@ func getFromURL(ctx context.Context, client httpc, stream, granularity, base, ki
 }
 
 // IsValidStream returns true if the given stream is a valid stream.
-func IsValidStream(stream string) bool {
-	validStreams := []string{"stable", "debug"}
+func IsValidStream(ref, stream string) bool {
+	validReleaseStreams := []string{"stable", "console", "debug"}
+	validStreams := []string{"nightly", "console", "debug"}
+
+	if isReleaseRef(ref) {
+		validStreams = validReleaseStreams
+	}
 
 	for _, validStream := range validStreams {
 		if stream == validStream {
@@ -191,6 +203,34 @@ func IsValidStream(stream string) bool {
 	return false
 }
 
+var notAZ09Regexp = regexp.MustCompile("[^a-zA-Z0-9-]+")
+
+// CanonicalRef returns the canonicalized ref for the given ref.
+func CanonicalRef(ref string) string {
+	return notAZ09Regexp.ReplaceAllString(ref, "-")
+}
+
+// IsValidRef returns true if the given ref is a valid ref.
+func IsValidRef(ref string) bool {
+	if ref == "" {
+		return false
+	}
+
+	if notAZ09Regexp.FindString(ref) != "" {
+		return false
+	}
+
+	if strings.HasPrefix(ref, "refs-heads") {
+		return false
+	}
+
+	return true
+}
+
+func isReleaseRef(ref string) bool {
+	return ref == "-"
+}
+
 type httpc interface {
 	Do(req *http.Request) (*http.Response, error)
 }