Sdk get releases from revision

sdk/CHANGELOG.md

@@ -9,6 +9,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- `Client`
+  - `GetReleasesForGitReference` returns all releases for the specified provider and from the specified git reference.
+  - `GetReleaseForGitReference` returns a release with the specified release version for the specified provider and from
+    the specified git reference.
+
 ## [0.3.0] - 2024-06-12
 
 ### Added

sdk/client.go

@@ -5,14 +5,12 @@ import (
 	"fmt"
 	"io"
 	"net/http"
+	"path"
 	"strings"
 
-	"sigs.k8s.io/yaml"
-
-	. "github.com/giantswarm/releases/sdk/api/v1alpha1"
-
 	"github.com/giantswarm/microerror"
 	"github.com/google/go-github/v62/github"
+	"sigs.k8s.io/yaml"
 )
 
 type Client struct {
@@ -76,6 +74,83 @@ func (c *Client) GetRelease(ctx context.Context, provider Provider, releaseVersi
 	return release, nil
 }
 
+// GetReleasesForGitReference returns all releases for the specified provider and from the specified git reference.
+//
+// Currently, the only supported provider is "aws". Git reference can be any commit, branch or tag.
+func (c *Client) GetReleasesForGitReference(ctx context.Context, provider Provider, gitReference string) ([]Release, error) {
+	providerDirectory, err := getProviderDirectory(provider)
+	if err != nil {
+		return nil, microerror.Mask(err)
+	}
+	opts := &github.RepositoryContentGetOptions{
+		Ref: gitReference,
+	}
+	_, directoryContent, _, err := c.gitHubClient.Repositories.GetContents(ctx, GiantSwarmGitHubOrg, ReleasesRepo, providerDirectory, opts)
+	if err != nil {
+		return nil, microerror.Mask(err)
+	}
+
+	var releases []Release
+	for _, item := range directoryContent {
+		if item == nil || item.GetType() != "dir" {
+			continue
+		}
+		releaseDirectoryName := item.GetName()
+		if releaseDirectoryName == "" || releaseDirectoryName == archivedDirectory {
+			continue
+		}
+		_, err = semver.NewVersion(releaseDirectoryName)
+		if err != nil {
+			// directory name is not a valid semver version, so treating as unknown directory and skipping
+			continue
+		}
+		release, err := c.GetReleaseForGitReference(ctx, provider, releaseDirectoryName, gitReference)
+		if err != nil {
+			return nil, microerror.Mask(err)
+		}
+		releases = append(releases, *release)
+	}
+
+	return releases, nil
+}
+
+// GetReleaseForGitReference returns a release with the specified release version for the specified provider and from
+// the specified git reference.
+//
+// Currently, the only supported provider is "aws". Release version can contain the 'v' prefix, but it doesn't have to.
+// Git reference can be any commit, branch or tag.
+func (c *Client) GetReleaseForGitReference(ctx context.Context, provider Provider, releaseVersion, gitReference string) (*Release, error) {
+	// First we get GitHub release for the specified provider and release version.
+	releaseVersion = strings.TrimPrefix(releaseVersion, "v")
+	providerDirectory, err := getProviderDirectory(provider)
+	if err != nil {
+		return nil, microerror.Mask(err)
+	}
+	releaseManifestPath := path.Join(providerDirectory, fmt.Sprintf("v%s", releaseVersion), ReleaseManifestFileName)
+	opts := &github.RepositoryContentGetOptions{
+		Ref: gitReference,
+	}
+	fileContentObject, _, _, err := c.gitHubClient.Repositories.GetContents(ctx, GiantSwarmGitHubOrg, ReleasesRepo, releaseManifestPath, opts)
+	if err != nil {
+		return nil, microerror.Mask(err)
+	}
+	fileContent, err := fileContentObject.GetContent()
+	if err != nil {
+		return nil, microerror.Mask(err)
+	}
+	if fileContent == "" {
+		return nil, microerror.Maskf(MissingReleaseManifestError, "release manifest contents not found at path '%s' for git reference '%s'", releaseManifestPath, gitReference)
+	}
+
+	release := &Release{}
+	err = yaml.Unmarshal([]byte(fileContent), release)
+	if err != nil {
+		return nil, microerror.Mask(err)
+	}
+
+	return release, nil
+}
+
 // GetLatestRelease returns the latest release for the specified provider.
 func (c *Client) GetLatestRelease(ctx context.Context, provider Provider) (*Release, error) {
 	const releasesPerRequest = 30

sdk/client_test.go

@@ -32,6 +32,15 @@ var (
 
 	//go:embed testdata/capa/v25.1.0-demo.0/release.yaml
 	v2510ReleaseManifest string
+
+	//go:embed testdata/capa/github_get_capa_for_git.json
+	capaDirectoryResponse string
+
+	//go:embed testdata/capa/v25.0.0/release_yaml_content_response.json
+	v25ReleaseManifestContentResponse string
+
+	//go:embed testdata/capa/v25.0.0-alpha.3/release_yaml_content_response.json
+	v25Alpha3ReleaseManifestContentResponse string
 )
 
 var _ = Describe("Client", func() {
@@ -117,6 +126,23 @@ var _ = Describe("Client", func() {
 		Expect(resultReleaseVersion).To(Equal(expectedLatestReleaseVersion))
 	})
 
+	It("Gets all releases for the specified provider and git reference", func() {
+		ctx := context.Background()
+		releases, err := releasesClient.GetReleasesForGitReference(ctx, ProviderAws, "add-capa-v25.0.0")
+		Expect(err).NotTo(HaveOccurred())
+
+		expectedReleases := []string{
+			"25.0.0-alpha.3",
+			"25.0.0",
+		}
+
+		for i, release := range releases {
+			resultReleaseVersion, err := release.GetVersion()
+			Expect(err).NotTo(HaveOccurred())
+			Expect(resultReleaseVersion).To(Equal(expectedReleases[i]))
+		}
+	})
+
 	AfterEach(func() {
 		server.Close()
 	})
@@ -144,6 +170,21 @@ func createAndStartTestServer() *httptest.Server {
 		_, err := rw.Write([]byte(v2510ReleaseManifest))
 		Expect(err).NotTo(HaveOccurred())
 	})
+	mux.HandleFunc("/api/v3/repos/giantswarm/releases/contents/capa", func(rw http.ResponseWriter, req *http.Request) {
+		// return GitHub response JSON
+		_, err := rw.Write([]byte(capaDirectoryResponse))
+		Expect(err).NotTo(HaveOccurred())
+	})
+	mux.HandleFunc("/api/v3/repos/giantswarm/releases/contents/capa/v25.0.0/release.yaml", func(rw http.ResponseWriter, req *http.Request) {
+		// return GitHub response JSON
+		_, err := rw.Write([]byte(v25ReleaseManifestContentResponse))
+		Expect(err).NotTo(HaveOccurred())
+	})
+	mux.HandleFunc("/api/v3/repos/giantswarm/releases/contents/capa/v25.0.0-alpha.3/release.yaml", func(rw http.ResponseWriter, req *http.Request) {
+		// return GitHub response JSON
+		_, err := rw.Write([]byte(v25Alpha3ReleaseManifestContentResponse))
+		Expect(err).NotTo(HaveOccurred())
+	})
 
 	// create test server
 	server := httptest.NewUnstartedServer(mux)

sdk/error.go

@@ -8,6 +8,10 @@ var InvalidConfigError = &microerror.Error{
 	Kind: "InvalidConfigError",
 }
 
+var InvalidProviderError = &microerror.Error{
+	Kind: "InvalidProviderError",
+}
+
 var ReleaseNotFoundError = &microerror.Error{
 	Kind: "ReleaseNotFoundError",
 }

sdk/repo.go

@@ -0,0 +1,20 @@
+package sdk
+
+import (
+	"github.com/giantswarm/microerror"
+
+	. "github.com/giantswarm/releases/sdk/api/v1alpha1"
+)
+
+const (
+	archivedDirectory = "archived"
+)
+
+func getProviderDirectory(provider Provider) (string, error) {
+	switch provider {
+	case ProviderAws:
+		return "capa", nil
+	}
+
+	return "", microerror.Maskf(InvalidProviderError, "unknown provider: %s", provider)
+}

sdk/testdata/capa/github_get_capa_for_git.json

@@ -0,0 +1,66 @@
+[
+    {
+        "name": "kustomization.yaml",
+        "path": "capa/kustomization.yaml",
+        "sha": "94632e6938d4b0558f44ae503ab9d27ba7660d64",
+        "size": 246,
+        "url": "https://api.github.com/repos/giantswarm/releases/contents/capa/kustomization.yaml?ref=add-capa-v25.0.0",
+        "html_url": "https://github.com/giantswarm/releases/blob/add-capa-v25.0.0/capa/kustomization.yaml",
+        "git_url": "https://api.github.com/repos/giantswarm/releases/git/blobs/94632e6938d4b0558f44ae503ab9d27ba7660d64",
+        "download_url": "https://raw.githubusercontent.com/giantswarm/releases/add-capa-v25.0.0/capa/kustomization.yaml",
+        "type": "file",
+        "_links": {
+            "self": "https://api.github.com/repos/giantswarm/releases/contents/capa/kustomization.yaml?ref=add-capa-v25.0.0",
+            "git": "https://api.github.com/repos/giantswarm/releases/git/blobs/94632e6938d4b0558f44ae503ab9d27ba7660d64",
+            "html": "https://github.com/giantswarm/releases/blob/add-capa-v25.0.0/capa/kustomization.yaml"
+        }
+    },
+    {
+        "name": "releaseNotesTransformer.yaml",
+        "path": "capa/releaseNotesTransformer.yaml",
+        "sha": "bf03d340e5c4aefa7da96bb36d45387bc6c4ebfa",
+        "size": 203,
+        "url": "https://api.github.com/repos/giantswarm/releases/contents/capa/releaseNotesTransformer.yaml?ref=add-capa-v25.0.0",
+        "html_url": "https://github.com/giantswarm/releases/blob/add-capa-v25.0.0/capa/releaseNotesTransformer.yaml",
+        "git_url": "https://api.github.com/repos/giantswarm/releases/git/blobs/bf03d340e5c4aefa7da96bb36d45387bc6c4ebfa",
+        "download_url": "https://raw.githubusercontent.com/giantswarm/releases/add-capa-v25.0.0/capa/releaseNotesTransformer.yaml",
+        "type": "file",
+        "_links": {
+            "self": "https://api.github.com/repos/giantswarm/releases/contents/capa/releaseNotesTransformer.yaml?ref=add-capa-v25.0.0",
+            "git": "https://api.github.com/repos/giantswarm/releases/git/blobs/bf03d340e5c4aefa7da96bb36d45387bc6c4ebfa",
+            "html": "https://github.com/giantswarm/releases/blob/add-capa-v25.0.0/capa/releaseNotesTransformer.yaml"
+        }
+    },
+    {
+        "name": "v25.0.0-alpha.3",
+        "path": "capa/v25.0.0-alpha.3",
+        "sha": "9991adcdbea991e6fd68bbf137722511942840ee",
+        "size": 0,
+        "url": "https://api.github.com/repos/giantswarm/releases/contents/capa/v25.0.0-alpha.3?ref=add-capa-v25.0.0",
+        "html_url": "https://github.com/giantswarm/releases/tree/add-capa-v25.0.0/capa/v25.0.0-alpha.3",
+        "git_url": "https://api.github.com/repos/giantswarm/releases/git/trees/9991adcdbea991e6fd68bbf137722511942840ee",
+        "download_url": null,
+        "type": "dir",
+        "_links": {
+            "self": "https://api.github.com/repos/giantswarm/releases/contents/capa/v25.0.0-alpha.3?ref=add-capa-v25.0.0",
+            "git": "https://api.github.com/repos/giantswarm/releases/git/trees/9991adcdbea991e6fd68bbf137722511942840ee",
+            "html": "https://github.com/giantswarm/releases/tree/add-capa-v25.0.0/capa/v25.0.0-alpha.3"
+        }
+    },
+    {
+        "name": "v25.0.0",
+        "path": "capa/v25.0.0",
+        "sha": "ced6727c2b8c72ccbecf1560d467d80142d3f6a6",
+        "size": 0,
+        "url": "https://api.github.com/repos/giantswarm/releases/contents/capa/v25.0.0?ref=add-capa-v25.0.0",
+        "html_url": "https://github.com/giantswarm/releases/tree/add-capa-v25.0.0/capa/v25.0.0",
+        "git_url": "https://api.github.com/repos/giantswarm/releases/git/trees/ced6727c2b8c72ccbecf1560d467d80142d3f6a6",
+        "download_url": null,
+        "type": "dir",
+        "_links": {
+            "self": "https://api.github.com/repos/giantswarm/releases/contents/capa/v25.0.0?ref=add-capa-v25.0.0",
+            "git": "https://api.github.com/repos/giantswarm/releases/git/trees/ced6727c2b8c72ccbecf1560d467d80142d3f6a6",
+            "html": "https://github.com/giantswarm/releases/tree/add-capa-v25.0.0/capa/v25.0.0"
+        }
+    }
+]

sdk/testdata/capa/v25.0.0-alpha.3/release_yaml_content_response.json

@@ -0,0 +1,18 @@
+{
+    "name": "release.yaml",
+    "path": "capa/v25.0.0-alpha.3/release.yaml",
+    "sha": "5f186e1cb0df528c689cc6e3356527882f44c3c3",
+    "size": 2669,
+    "url": "https://api.github.com/repos/giantswarm/releases/contents/capa/v25.0.0-alpha.3/release.yaml?ref=add-capa-v25.0.0",
+    "html_url": "https://github.com/giantswarm/releases/blob/add-capa-v25.0.0/capa/v25.0.0-alpha.3/release.yaml",
+    "git_url": "https://api.github.com/repos/giantswarm/releases/git/blobs/5f186e1cb0df528c689cc6e3356527882f44c3c3",
+    "download_url": "https://raw.githubusercontent.com/giantswarm/releases/add-capa-v25.0.0/capa/v25.0.0-alpha.3/release.yaml",
+    "type": "file",
+    "content": "YXBpVmVyc2lvbjogcmVsZWFzZS5naWFudHN3YXJtLmlvL3YxYWxwaGExCmtp\nbmQ6IFJlbGVhc2UKbWV0YWRhdGE6CiAgbmFtZTogYXdzLTI1LjAuMC1hbHBo\nYS4zCnNwZWM6CiAgYXBwczoKICAtIG5hbWU6IGF3cy1lYnMtY3NpLWRyaXZl\ncgogICAgdmVyc2lvbjogMi4zMC4xCiAgICBkZXBlbmRzT246CiAgICAtIGNs\nb3VkLXByb3ZpZGVyLWF3cwogIC0gbmFtZTogYXdzLWVicy1jc2ktZHJpdmVy\nLXNlcnZpY2Vtb25pdG9ycwogICAgdmVyc2lvbjogMC4xLjAKICAgIGRlcGVu\nZHNPbjoKICAgIC0gY2VydC1tYW5hZ2VyCiAgLSBuYW1lOiBhd3MtcG9kLWlk\nZW50aXR5LXdlYmhvb2sKICAgIHZlcnNpb246IDEuMTYuMAogICAgZGVwZW5k\nc09uOgogICAgLSBjZXJ0LW1hbmFnZXIKICAtIG5hbWU6IGNhcGktbm9kZS1s\nYWJlbGVyCiAgICB2ZXJzaW9uOiAwLjUuMAogIC0gbmFtZTogY2VydC1leHBv\ncnRlcgogICAgdmVyc2lvbjogMi45LjAKICAgIGRlcGVuZHNPbjoKICAgIC0g\na3l2ZXJubwogIC0gbmFtZTogY2VydC1tYW5hZ2VyCiAgICB2ZXJzaW9uOiAz\nLjcuNgogICAgZGVwZW5kc09uOgogICAgLSBwcm9tZXRoZXVzLW9wZXJhdG9y\nLWNyZAogIC0gbmFtZTogY2hhcnQtb3BlcmF0b3ItZXh0ZW5zaW9ucwogICAg\ndmVyc2lvbjogMS4xLjIKICAgIGRlcGVuZHNPbjoKICAgIC0gcHJvbWV0aGV1\ncy1vcGVyYXRvci1jcmQKICAtIG5hbWU6IGNpbGl1bQogICAgdmVyc2lvbjog\nMC4yNC4wCiAgLSBuYW1lOiBjaWxpdW0tY3Jvc3NwbGFuZS1yZXNvdXJjZXMK\nICAgIHZlcnNpb246IDAuMS4wCiAgLSBuYW1lOiBjaWxpdW0tc2VydmljZW1v\nbml0b3JzCiAgICB2ZXJzaW9uOiAwLjEuMgogICAgZGVwZW5kc09uOgogICAg\nLSBwcm9tZXRoZXVzLW9wZXJhdG9yLWNyZAogIC0gbmFtZTogY2xvdWQtcHJv\ndmlkZXItYXdzCiAgICB2ZXJzaW9uOiAxLjI1LjE0LWdzMwogICAgZGVwZW5k\nc09uOgogICAgLSB2ZXJ0aWNhbC1wb2QtYXV0b3NjYWxlci1jcmQKICAtIG5h\nbWU6IGNsdXN0ZXItYXV0b3NjYWxlcgogICAgdmVyc2lvbjogMS4yNy4zLWdz\nOQogICAgZGVwZW5kc09uOgogICAgLSBreXZlcm5vCiAgLSBuYW1lOiBjb3Jl\nZG5zCiAgICB2ZXJzaW9uOiAxLjIxLjAKICAgIGRlcGVuZHNPbjoKICAgIC0g\nY2lsaXVtCiAgLSBuYW1lOiBldGNkLWs4cy1yZXMtY291bnQtZXhwb3J0ZXIK\nICAgIHZlcnNpb246IDEuMTAuMAogICAgZGVwZW5kc09uOgogICAgLSBreXZl\ncm5vCiAgLSBuYW1lOiBleHRlcm5hbC1kbnMKICAgIHZlcnNpb246IDMuMS4w\nCiAgICBkZXBlbmRzT246CiAgICAtIHByb21ldGhldXMtb3BlcmF0b3ItY3Jk\nCiAgLSBuYW1lOiBpcnNhLXNlcnZpY2Vtb25pdG9ycwogICAgdmVyc2lvbjog\nMC4wLjEKICAgIGRlcGVuZHNPbjoKICAgIC0gY2VydC1tYW5hZ2VyCiAgLSBu\nYW1lOiBrOHMtYXVkaXQtbWV0cmljcwogICAgdmVyc2lvbjogMC45LjAKICAg\nIGRlcGVuZHNPbjoKICAgIC0ga3l2ZXJubwogIC0gbmFtZTogazhzLWRucy1u\nb2RlLWNhY2hlCiAgICB2ZXJzaW9uOiAyLjYuMgogICAgZGVwZW5kc09uOgog\nICAgLSBreXZlcm5vCiAgLSBuYW1lOiBtZXRyaWNzLXNlcnZlcgogICAgdmVy\nc2lvbjogMi40LjIKICAgIGRlcGVuZHNPbjoKICAgIC0ga3l2ZXJubwogIC0g\nbmFtZTogbmV0LWV4cG9ydGVyCiAgICB2ZXJzaW9uOiAxLjE5LjAKICAgIGRl\ncGVuZHNPbjoKICAgIC0gcHJvbWV0aGV1cy1vcGVyYXRvci1jcmQKICAtIG5h\nbWU6IG5ldHdvcmstcG9saWNpZXMKICAgIHZlcnNpb246IDAuMS4xCiAgICBj\nYXRhbG9nOiBjbHVzdGVyCiAgICBkZXBlbmRzT246CiAgICAtIGNpbGl1bQog\nIC0gbmFtZTogbm9kZS1leHBvcnRlcgogICAgdmVyc2lvbjogMS4xOS4wCiAg\nICBkZXBlbmRzT246CiAgICAtIGt5dmVybm8KICAtIG5hbWU6IG9ic2VydmFi\naWxpdHktYnVuZGxlCiAgICB2ZXJzaW9uOiAxLjMuNAogICAgZGVwZW5kc09u\nOgogICAgLSBjb3JlZG5zCiAgLSBuYW1lOiBwcm9tZXRoZXVzLWJsYWNrYm94\nLWV4cG9ydGVyCiAgICB2ZXJzaW9uOiAwLjQuMQogICAgZGVwZW5kc09uOgog\nICAgLSBwcm9tZXRoZXVzLW9wZXJhdG9yLWNyZAogIC0gbmFtZTogc2VjdXJp\ndHktYnVuZGxlCiAgICB2ZXJzaW9uOiAxLjcuMAogICAgY2F0YWxvZzogZ2lh\nbnRzd2FybQogICAgZGVwZW5kc09uOgogICAgLSBwcm9tZXRoZXVzLW9wZXJh\ndG9yLWNyZAogIC0gbmFtZTogdGVsZXBvcnQta3ViZS1hZ2VudAogICAgdmVy\nc2lvbjogMC45LjAKICAtIG5hbWU6IHZlcnRpY2FsLXBvZC1hdXRvc2NhbGVy\nCiAgICB2ZXJzaW9uOiA1LjIuMgogICAgZGVwZW5kc09uOgogICAgLSBwcm9t\nZXRoZXVzLW9wZXJhdG9yLWNyZAogIC0gbmFtZTogdmVydGljYWwtcG9kLWF1\ndG9zY2FsZXItY3JkCiAgICB2ZXJzaW9uOiAzLjEuMAogIGNvbXBvbmVudHM6\nCiAgLSBuYW1lOiBjbHVzdGVyLWF3cwogICAgY2F0YWxvZzogY2x1c3Rlci10\nZXN0CiAgICB2ZXJzaW9uOiAwLjc4LjItZGI3ZWE5YjU0Zjc3MzE5MzcwMGRm\nNmRjYzY0OGQ0YTk5YmIxOTYwMAogIC0gbmFtZTogZmxhdGNhcgogICAgdmVy\nc2lvbjogMzgxNS4yLjIKICAtIG5hbWU6IGZsYXRjYXItdmFyaWFudAogICAg\ndmVyc2lvbjogMS4wLjAKICAtIG5hbWU6IGt1YmVybmV0ZXMKICAgIHZlcnNp\nb246IDEuMjUuMTYKICBkYXRlOiAiMjAyNC0wNi0xMlQxNjowMDowMFoiCiAg\nc3RhdGU6IGFjdGl2ZQo=\n",
+    "encoding": "base64",
+    "_links": {
+        "self": "https://api.github.com/repos/giantswarm/releases/contents/capa/v25.0.0-alpha.3/release.yaml?ref=add-capa-v25.0.0",
+        "git": "https://api.github.com/repos/giantswarm/releases/git/blobs/5f186e1cb0df528c689cc6e3356527882f44c3c3",
+        "html": "https://github.com/giantswarm/releases/blob/add-capa-v25.0.0/capa/v25.0.0-alpha.3/release.yaml"
+    }
+}