Build: Add github release command to build/cmd (#56349)

* Add github release command to build/cmd * Use go-github library and implement dry-run * Make tag optional and default to metadata * Fix minor bug with tag default * Make some refactors to ease testing * Add tests for publish github command * Refactor publish github tests * Refactor test helper function name * Isolate local test
2022-10-20 11:11:53 -03:00
parent 4b68918b0b
commit 96a97f9827
5 changed files with 409 additions and 0 deletions
@@ -0,0 +1,157 @@
+package main
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"os"
+	"path"
+	"strings"
+
+	"github.com/google/go-github/github"
+	"github.com/urfave/cli/v2"
+	"golang.org/x/oauth2"
+)
+
+type githubRepositoryService interface {
+	GetReleaseByTag(ctx context.Context, owner string, repo string, tag string) (*github.RepositoryRelease, *github.Response, error)
+	CreateRelease(ctx context.Context, owner string, repo string, release *github.RepositoryRelease) (*github.RepositoryRelease, *github.Response, error)
+	UploadReleaseAsset(ctx context.Context, owner string, repo string, id int64, opt *github.UploadOptions, file *os.File) (*github.ReleaseAsset, *github.Response, error)
+}
+
+type githubRepo struct {
+	owner string
+	name  string
+}
+
+type publishGithubFlags struct {
+	create       bool
+	dryRun       bool
+	tag          string
+	repo         *githubRepo
+	artifactPath string
+}
+
+var (
+	newGithubClient    = githubRepositoryClient
+	errTokenIsEmpty    = errors.New("the environment variable GH_TOKEN must be set")
+	errTagIsEmpty      = errors.New(`failed to retrieve release tag from metadata, use "--tag" to set it manually`)
+	errReleaseNotFound = errors.New(`release not found, use "--create" to create the release`)
+)
+
+func PublishGitHub(ctx *cli.Context) error {
+	token := os.Getenv("GH_TOKEN")
+	f, err := getFlags(ctx)
+	if err != nil {
+		return err
+	}
+
+	if f.tag == "" {
+		return errTagIsEmpty
+	}
+
+	if token == "" {
+		return errTokenIsEmpty
+	}
+
+	if f.dryRun {
+		return runDryRun(f, token, ctx)
+	}
+
+	client := newGithubClient(ctx.Context, token)
+	release, res, err := client.GetReleaseByTag(ctx.Context, f.repo.owner, f.repo.name, f.tag)
+	if err != nil && res.StatusCode != 404 {
+		return err
+	}
+
+	if release == nil {
+		if f.create {
+			release, _, err = client.CreateRelease(ctx.Context, f.repo.owner, f.repo.name, &github.RepositoryRelease{TagName: &f.tag})
+			if err != nil {
+				return err
+			}
+		} else {
+			return errReleaseNotFound
+		}
+	}
+
+	artifactName := path.Base(f.artifactPath)
+	file, err := os.Open(f.artifactPath)
+	if err != nil {
+		return err
+	}
+
+	asset, _, err := client.UploadReleaseAsset(ctx.Context, f.repo.owner, f.repo.name, *release.ID, &github.UploadOptions{Name: artifactName}, file)
+	if err != nil {
+		return err
+	}
+	fmt.Printf("Asset '%s' uploaded to release '%s' on repository '%s/%s'\nDownload: %s\n", *asset.Name, f.tag, f.repo.owner, f.repo.name, *asset.BrowserDownloadURL)
+	return nil
+}
+
+func githubRepositoryClient(ctx context.Context, token string) githubRepositoryService {
+	ts := oauth2.StaticTokenSource(
+		&oauth2.Token{AccessToken: token},
+	)
+	tc := oauth2.NewClient(ctx, ts)
+
+	client := github.NewClient(tc)
+	return client.Repositories
+}
+
+func getFlags(ctx *cli.Context) (*publishGithubFlags, error) {
+	metadata, err := GenerateMetadata(ctx)
+	if err != nil {
+		return nil, err
+	}
+	tag := ctx.Value("tag").(string)
+	if tag == "" && metadata.GrafanaVersion != "" {
+		tag = fmt.Sprintf("v%s", metadata.GrafanaVersion)
+	}
+	fullRepo := ctx.Value("repo").(string)
+	dryRun := ctx.Value("dry-run").(bool)
+	owner := strings.Split(fullRepo, "/")[0]
+	name := strings.Split(fullRepo, "/")[1]
+	create := ctx.Value("create").(bool)
+	artifactPath := ctx.Value("path").(string)
+	return &publishGithubFlags{
+		artifactPath: artifactPath,
+		create:       create,
+		dryRun:       dryRun,
+		tag:          tag,
+		repo: &githubRepo{
+			owner: owner,
+			name:  name,
+		},
+	}, nil
+}
+
+func runDryRun(f *publishGithubFlags, token string, ctx *cli.Context) error {
+	client := newGithubClient(ctx.Context, token)
+	fmt.Println("Dry-Run: Retrieving release on repository by tag")
+	release, res, err := client.GetReleaseByTag(ctx.Context, f.repo.owner, f.repo.name, f.tag)
+	if err != nil && res.StatusCode != 404 {
+		fmt.Println("Dry-Run: GitHub communication error:\n", err)
+		return nil
+	}
+
+	if release == nil {
+		if f.create {
+			fmt.Println("Dry-Run: Release doesn't exist and --create is enabled, so it would try to create the release")
+		} else {
+			fmt.Println("Dry-Run: Release doesn't exist and --create is disabled, so it would fail with error")
+			return nil
+		}
+	}
+
+	artifactName := path.Base(f.artifactPath)
+	fmt.Printf("Dry-Run: Opening file for release: %s\n", f.artifactPath)
+	_, err = os.Open(f.artifactPath)
+	if err != nil {
+		fmt.Println("Dry-Run: Error opening file\n", err)
+		return nil
+	}
+
+	fmt.Printf("Dry-Run: Would upload asset '%s' to release '%s' on repo '%s/%s' and return download URL if successful\n", artifactName, f.tag, f.repo.owner, f.repo.name)
+	return nil
+}