CI: Move store-storybook to OSS (#55212)

* Move store-storybook to OSS

* grabpl -> build for store-storybook command

* Replace zerolog with builtin log

* Remove flags from store-storybook

* Fix lint

.drone.yml

@@ -1213,7 +1213,7 @@ steps:
   image: grafana/docker-puppeteer:1.1.0
   name: test-a11y-frontend
 - commands:
-  - ./bin/grabpl store-storybook --deployment canary --src-bucket grafana-storybook
+  - ./bin/build store-storybook --deployment canary
   depends_on:
   - build-storybook
   - end-to-end-tests-dashboards-suite
@@ -1951,10 +1951,8 @@ steps:
   image: grafana/grafana-ci-deploy:1.3.3
   name: upload-packages
 - commands:
-  - ./bin/grabpl store-storybook --deployment latest --src-bucket grafana-prerelease
-    --src-dir artifacts/storybook
-  - ./bin/grabpl store-storybook --deployment ${DRONE_TAG} --src-bucket grafana-prerelease
-    --src-dir artifacts/storybook
+  - ./bin/build store-storybook --deployment latest
+  - ./bin/build store-storybook --deployment ${DRONE_TAG}
   depends_on:
   - build-storybook
   - end-to-end-tests-dashboards-suite
@@ -5062,6 +5060,6 @@ kind: secret
 name: packages_secret_access_key
 ---
 kind: signature
-hmac: a53ea9eebb70e652a3d3165d0ee31cb6b5057bf40b6109c0d53a9d9610f4d073
+hmac: 1bbfd995ded7c2d1c0330ef2009691577a6613ec98df296fc8ec4388b9898e2d
 
 ...

pkg/build/cmd/main.go

@@ -124,6 +124,17 @@ func main() {
 			Usage:  "Exports version in dist/grafana.version",
 			Action: ExportVersion,
 		},
+		{
+			Name:   "store-storybook",
+			Usage:  "Integrity check for storybook build",
+			Action: StoreStorybook,
+			Flags: []cli.Flag{
+				&cli.StringFlag{
+					Name:  "deployment",
+					Usage: "Kind of deployment (e.g. canary/latest)",
+				},
+			},
+		},
 	}
 
 	if err := app.Run(os.Args); err != nil {

pkg/build/cmd/storestorybook.go

@@ -0,0 +1,52 @@
+package main
+
+import (
+	"log"
+	"path/filepath"
+
+	"github.com/grafana/grafana/pkg/build/config"
+	"github.com/grafana/grafana/pkg/build/gcloud/storage"
+	"github.com/urfave/cli/v2"
+)
+
+// StoreStorybook implements the sub-command "store-storybook".
+func StoreStorybook(c *cli.Context) error {
+	deployment := c.String("deployment")
+
+	metadata, err := GenerateMetadata(c)
+	if err != nil {
+		return err
+	}
+
+	verMode, err := config.GetVersion(metadata.ReleaseMode.Mode)
+	if err != nil {
+		return err
+	}
+	if err != nil {
+		return err
+	}
+
+	storybookBucket := verMode.StorybookBucket
+	srcPath := verMode.StorybookSrcDir
+	srcPath = filepath.Join(srcPath, deployment)
+
+	gcs, err := storage.New()
+	if err != nil {
+		return err
+	}
+	bucket := gcs.Bucket(storybookBucket)
+
+	if err := gcs.DeleteDir(c.Context, bucket, srcPath); err != nil {
+		return err
+	}
+
+	log.Printf("Successfully cleaned source: %s/%s\n", storybookBucket, srcPath)
+
+	if err := gcs.CopyLocalDir(c.Context, "packages/grafana-ui/dist/storybook", bucket, srcPath, true); err != nil {
+		return err
+	}
+
+	log.Printf("Successfully stored storybook to: %s/%s!\n", storybookBucket, srcPath)
+
+	return nil
+}

pkg/build/gcloud/storage/gsutil.go

@@ -0,0 +1,420 @@
+package storage
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"io"
+	"log"
+	"mime"
+	"os"
+	"path"
+	"path/filepath"
+	"strings"
+	"sync"
+	"time"
+
+	"cloud.google.com/go/storage"
+	"github.com/grafana/grafana/pkg/build/fsutil"
+	"github.com/grafana/grafana/pkg/build/gcloud"
+	"google.golang.org/api/iterator"
+	"google.golang.org/api/option"
+)
+
+var (
+	// ErrorNilBucket is returned when a function is called where a bucket argument is expected and the bucket is nil.
+	ErrorNilBucket = errors.New("a bucket must be provided")
+)
+
+const (
+	// maxThreads specify the number of max threads that can run at the same time.
+	// Set to 1000, since the maximum number of simultaneous open files for the runners is 1024.
+	maxThreads = 1000
+)
+
+// Client wraps the gcloud storage Client with convenient helper functions.
+// By using an embedded type we can still use the functions provided by storage.Client if we need to.
+type Client struct {
+	storage.Client
+}
+
+// File represents a file in Google Cloud Storage.
+type File struct {
+	FullPath    string
+	PathTrimmed string
+}
+
+// New creates a new Client by checking for the Google Cloud SDK auth key and/or environment variable.
+func New() (*Client, error) {
+	client, err := newClient()
+	if err != nil {
+		return nil, err
+	}
+
+	return &Client{
+		Client: *client,
+	}, nil
+}
+
+// newClient initializes the google-cloud-storage (GCS) client.
+// It first checks for the application-default_credentials.json file then the GCP_KEY environment variable.
+func newClient() (*storage.Client, error) {
+	ctx := context.Background()
+
+	byteKey, err := gcloud.GetDecodedKey()
+	if err != nil {
+		return nil, fmt.Errorf("failed to get gcp key, err: %w", err)
+	}
+	client, err := storage.NewClient(ctx, option.WithCredentialsJSON(byteKey))
+	if err != nil {
+		log.Println("failed to login with GCP_KEY, trying with default application credentials...")
+		client, err = storage.NewClient(ctx)
+		if err != nil {
+			return nil, fmt.Errorf("failed to open Google Cloud Storage client: %w", err)
+		}
+	}
+
+	return client, nil
+}
+
+// CopyLocalDir copies a local directory 'dir' to the bucket 'bucket' at the path 'bucketPath'.
+func (client *Client) CopyLocalDir(ctx context.Context, dir string, bucket *storage.BucketHandle, bucketPath string, trim bool) error {
+	if bucket == nil {
+		return ErrorNilBucket
+	}
+
+	files, err := ListLocalFiles(dir)
+	if err != nil {
+		return err
+	}
+	log.Printf("Number or files to be copied over: %d\n", len(files))
+
+	for _, chunk := range asChunks(files, maxThreads) {
+		var wg sync.WaitGroup
+		for _, f := range chunk {
+			wg.Add(1)
+			go func(file File) {
+				defer wg.Done()
+				err = client.Copy(ctx, file, bucket, bucketPath, trim)
+				if err != nil {
+					log.Printf("failed to copy objects, err: %s\n", err.Error())
+				}
+			}(f)
+		}
+		wg.Wait()
+	}
+
+	return nil
+}
+
+// Copy copies a single local file into the bucket at the provided path.
+// trim variable should be set to true if the full object path is needed - false otherwise.
+func (client *Client) Copy(ctx context.Context, file File, bucket *storage.BucketHandle, remote string, trim bool) error {
+	if bucket == nil {
+		return ErrorNilBucket
+	}
+
+	localFile, err := os.Open(file.FullPath)
+	if err != nil {
+		return fmt.Errorf("failed to open file %s, err: %q", file.FullPath, err)
+	}
+	defer func() {
+		if err := localFile.Close(); err != nil {
+			log.Println("failed to close localfile", "err", err)
+		}
+	}()
+
+	extension := strings.ToLower(path.Ext(file.FullPath))
+	contentType := mime.TypeByExtension(extension)
+
+	filePath := file.FullPath
+	if trim {
+		filePath = file.PathTrimmed
+	}
+
+	objectPath := path.Join(remote, filePath)
+
+	wc := bucket.Object(objectPath).NewWriter(ctx)
+	wc.ContentType = contentType
+	defer func() {
+		if err := wc.Close(); err != nil {
+			log.Println("failed to close writer", "err", err)
+		}
+	}()
+
+	if _, err = io.Copy(wc, localFile); err != nil {
+		return fmt.Errorf("failed to copy to Cloud Storage: %w", err)
+	}
+
+	log.Printf("Successfully uploaded tarball to Google Cloud Storage, path: %s/%s\n", remote, file.FullPath)
+
+	return nil
+}
+
+// CopyRemoteDir copies an entire directory 'from' from the bucket 'fromBucket' into the 'toBucket' at the path 'to'.
+func (client *Client) CopyRemoteDir(ctx context.Context, fromBucket *storage.BucketHandle, from string, toBucket *storage.BucketHandle, to string) error {
+	if toBucket == nil || fromBucket == nil {
+		return ErrorNilBucket
+	}
+
+	files, err := ListRemoteFiles(ctx, fromBucket, FilesFilter{Prefix: from})
+	if err != nil {
+		return err
+	}
+
+	var ch = make(chan File, len(files))
+	var wg sync.WaitGroup
+	wg.Add(maxThreads)
+
+	for i := 0; i < maxThreads; i++ {
+		go func() {
+			for {
+				file, ok := <-ch
+				if !ok {
+					wg.Done()
+					return
+				}
+				if err := client.RemoteCopy(ctx, file, fromBucket, toBucket, to); err != nil {
+					log.Printf("failed to copy files between buckets: err: %s\n", err.Error())
+					return
+				}
+			}
+		}()
+	}
+
+	for _, file := range files {
+		ch <- file
+	}
+
+	close(ch)
+	wg.Wait()
+
+	return nil
+}
+
+// RemoteCopy will copy the file 'file' from the 'fromBucket' to the 'toBucket' at the path 'path'.
+func (client *Client) RemoteCopy(ctx context.Context, file File, fromBucket, toBucket *storage.BucketHandle, path string) error {
+	// Should this be path.Join instead of filepath.Join? filepath.Join on Windows will produce `\\` separators instead of `/`.
+	var (
+		src       = fromBucket.Object(file.FullPath)
+		dstObject = filepath.Join(path, file.PathTrimmed)
+		dst       = toBucket.Object(dstObject)
+	)
+
+	if _, err := dst.CopierFrom(src).Run(ctx); err != nil {
+		return fmt.Errorf("failed to copy object %s, to %s, err: %w", file.FullPath, dstObject, err)
+	}
+
+	log.Printf("%s was successfully copied to %v bucket!.\n\n", file.FullPath, toBucket)
+	return nil
+}
+
+// DeleteDir deletes a directory at 'path' from the bucket.
+func (client *Client) DeleteDir(ctx context.Context, bucket *storage.BucketHandle, path string) error {
+	if bucket == nil {
+		return ErrorNilBucket
+	}
+
+	files, err := ListRemoteFiles(ctx, bucket, FilesFilter{Prefix: path})
+	if err != nil {
+		return err
+	}
+
+	var ch = make(chan string, len(files))
+	var wg sync.WaitGroup
+	wg.Add(maxThreads)
+
+	for i := 0; i < maxThreads; i++ {
+		go func() {
+			for {
+				fullPath, ok := <-ch
+				if !ok {
+					wg.Done()
+					return
+				}
+				err := client.Delete(ctx, bucket, fullPath)
+				if err != nil && !errors.Is(err, storage.ErrObjectNotExist) {
+					log.Printf("failed to delete objects, err %s\n", err.Error())
+					panic(err)
+				}
+			}
+		}()
+	}
+
+	for _, file := range files {
+		ch <- file.FullPath
+	}
+
+	close(ch)
+	wg.Wait()
+
+	return nil
+}
+
+// Delete deletes single item from the bucket at 'path'.
+func (client *Client) Delete(ctx context.Context, bucket *storage.BucketHandle, path string) error {
+	object := bucket.Object(path)
+	if err := object.Delete(ctx); err != nil {
+		return fmt.Errorf("cannot delete %s, err: %w", path, err)
+	}
+	log.Printf("Successfully deleted tarball to Google Cloud Storage, path: %s", path)
+	return nil
+}
+
+// ListLocalFiles lists files in a local filesystem.
+func ListLocalFiles(dir string) ([]File, error) {
+	var files []File
+	err := filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
+		if !info.IsDir() {
+			files = append(files, File{
+				FullPath:    path,
+				PathTrimmed: info.Name(),
+			})
+		}
+		return nil
+	})
+
+	if err != nil {
+		return nil, fmt.Errorf("error walking path: %v", err)
+	}
+
+	return files, nil
+}
+
+type FilesFilter struct {
+	Prefix   string
+	FileExts []string
+}
+
+// ListRemoteFiles lists all the files in the directory (filtering by FilesFilter) and returns a File struct for each one.
+func ListRemoteFiles(ctx context.Context, bucket *storage.BucketHandle, filter FilesFilter) ([]File, error) {
+	if bucket == nil {
+		return []File{}, ErrorNilBucket
+	}
+
+	it := bucket.Objects(ctx, &storage.Query{
+		Prefix: filter.Prefix,
+	})
+
+	var files []File
+	for {
+		attrs, err := it.Next()
+		if err != nil {
+			if errors.Is(err, iterator.Done) {
+				break
+			}
+		}
+		if err != nil {
+			return nil, fmt.Errorf("failed to iterate through bucket, err: %w", err)
+		}
+
+		extMatch := len(filter.FileExts) == 0
+		for _, ext := range filter.FileExts {
+			if ext == filepath.Ext(attrs.Name) {
+				extMatch = true
+				break
+			}
+		}
+
+		if extMatch {
+			files = append(files, File{FullPath: attrs.Name, PathTrimmed: strings.TrimPrefix(attrs.Name, filter.Prefix)})
+		}
+	}
+
+	return files, nil
+}
+
+// DownloadDirectory downloads files from bucket (filtering by FilesFilter) to destPath on disk.
+func (client *Client) DownloadDirectory(ctx context.Context, bucket *storage.BucketHandle, destPath string, filter FilesFilter) error {
+	if bucket == nil {
+		return ErrorNilBucket
+	}
+
+	files, err := ListRemoteFiles(ctx, bucket, filter)
+	if err != nil {
+		return err
+	}
+
+	// return err if dir already exists
+	exists, err := fsutil.Exists(destPath)
+	if err != nil {
+		return err
+	}
+	if exists {
+		return fmt.Errorf("destination path %q already exists", destPath)
+	}
+
+	err = os.MkdirAll(destPath, 0750)
+	if err != nil && !os.IsExist(err) {
+		return err
+	}
+
+	for _, file := range files {
+		err = client.downloadFile(ctx, bucket, file.FullPath, filepath.Join(destPath, file.PathTrimmed))
+		if err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+// downloadFile downloads an object to a file.
+func (client *Client) downloadFile(ctx context.Context, bucket *storage.BucketHandle, objectName, destFileName string) error {
+	if bucket == nil {
+		return ErrorNilBucket
+	}
+
+	ctx, cancel := context.WithTimeout(ctx, time.Second*10)
+	defer cancel()
+
+	// nolint:gosec
+	f, err := os.Create(destFileName)
+	if err != nil {
+		return fmt.Errorf("os.Create: %v", err)
+	}
+
+	rc, err := bucket.Object(objectName).NewReader(ctx)
+	if err != nil {
+		return fmt.Errorf("Object(%q).NewReader: %v", objectName, err)
+	}
+	defer func() {
+		if err := rc.Close(); err != nil {
+			log.Println("failed to close reader", "err", err)
+		}
+	}()
+
+	if _, err := io.Copy(f, rc); err != nil {
+		return fmt.Errorf("io.Copy: %v", err)
+	}
+
+	if err = f.Close(); err != nil {
+		return fmt.Errorf("f.Close: %v", err)
+	}
+
+	return nil
+}
+
+// asChunks will split the supplied []File into slices with a max size of `chunkSize`
+// []string{"a", "b", "c"}, 1 => [][]string{[]string{"a"}, []string{"b"}, []string{"c"}}
+// []string{"a", "b", "c"}, 2 => [][]string{[]string{"a", "b"}, []string{"c"}}.
+func asChunks(files []File, chunkSize int) [][]File {
+	var fileChunks [][]File
+
+	if len(files) == 0 {
+		return [][]File{}
+	}
+
+	if len(files) > chunkSize && chunkSize > 0 {
+		for i := 0; i < len(files); i += chunkSize {
+			end := i + chunkSize
+
+			if end > len(files) {
+				end = len(files)
+			}
+			fileChunks = append(fileChunks, files[i:end])
+		}
+	} else {
+		fileChunks = [][]File{files}
+	}
+	return fileChunks
+}

pkg/build/gcloud/storage/gsutil_test.go

@@ -0,0 +1,159 @@
+package storage
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func Test_asChunks(t *testing.T) {
+	type args struct {
+		files     []File
+		chunkSize int
+	}
+	tcs := []struct {
+		name     string
+		args     args
+		expected [][]File
+	}{
+		{
+			name: "Happy path #1",
+			args: args{
+				files: []File{
+					{FullPath: "/a"},
+					{FullPath: "/b"},
+					{FullPath: "/c"},
+					{FullPath: "/1"},
+					{FullPath: "/2"},
+					{FullPath: "/3"},
+				},
+				chunkSize: 5,
+			},
+			expected: [][]File{
+				{{FullPath: "/a"}, {FullPath: "/b"}, {FullPath: "/c"}, {FullPath: "/1"}, {FullPath: "/2"}},
+				{{FullPath: "/3"}},
+			},
+		},
+		{
+			name: "Happy path #2",
+			args: args{
+				files: []File{
+					{FullPath: "/a"},
+					{FullPath: "/b"},
+					{FullPath: "/c"},
+					{FullPath: "/1"},
+					{FullPath: "/2"},
+					{FullPath: "/3"},
+				},
+				chunkSize: 2,
+			},
+			expected: [][]File{
+				{{FullPath: "/a"}, {FullPath: "/b"}},
+				{{FullPath: "/c"}, {FullPath: "/1"}},
+				{{FullPath: "/2"}, {FullPath: "/3"}},
+			},
+		},
+		{
+			name: "Happy path #3",
+			args: args{
+				files: []File{
+					{FullPath: "/a"},
+					{FullPath: "/b"},
+					{FullPath: "/c"},
+				},
+				chunkSize: 1,
+			},
+			expected: [][]File{
+				{{FullPath: "/a"}},
+				{{FullPath: "/b"}},
+				{{FullPath: "/c"}},
+			},
+		},
+		{
+			name: "A chunkSize with 0 value returns the input as a single chunk",
+			args: args{
+				files: []File{
+					{FullPath: "/a"},
+					{FullPath: "/b"},
+					{FullPath: "/c"},
+				},
+				chunkSize: 0,
+			},
+			expected: [][]File{
+				{
+					{FullPath: "/a"},
+					{FullPath: "/b"},
+					{FullPath: "/c"},
+				},
+			},
+		},
+		{
+			name: "A chunkSize with negative value returns the input as a single chunk",
+			args: args{
+				files: []File{
+					{FullPath: "/a"},
+					{FullPath: "/b"},
+					{FullPath: "/c"},
+				},
+				chunkSize: -1,
+			},
+			expected: [][]File{
+				{
+					{FullPath: "/a"},
+					{FullPath: "/b"},
+					{FullPath: "/c"},
+				},
+			},
+		},
+		{
+			name: "A chunkSize greater than the size on input returns the input as a single chunk",
+			args: args{
+				files: []File{
+					{FullPath: "/a"},
+					{FullPath: "/b"},
+					{FullPath: "/c"},
+				},
+				chunkSize: 5,
+			},
+			expected: [][]File{
+				{
+					{FullPath: "/a"},
+					{FullPath: "/b"},
+					{FullPath: "/c"},
+				},
+			},
+		},
+		{
+			name: "A chunkSize equal the size on input returns the input as a single chunk",
+			args: args{
+				files: []File{
+					{FullPath: "/a"},
+					{FullPath: "/b"},
+					{FullPath: "/c"},
+				},
+				chunkSize: 3,
+			},
+			expected: [][]File{
+				{
+					{FullPath: "/a"},
+					{FullPath: "/b"},
+					{FullPath: "/c"},
+				},
+			},
+		},
+		{
+			name: "An empty input returns empty chunks",
+			args: args{
+				files:     []File{},
+				chunkSize: 3,
+			},
+			expected: [][]File{},
+		},
+	}
+	for _, tc := range tcs {
+		t.Run(tc.name, func(t *testing.T) {
+			result := asChunks(tc.args.files, tc.args.chunkSize)
+			require.Equal(t, tc.expected, result)
+		})
+	}
+}

scripts/drone/steps/lib.star

@@ -266,13 +266,13 @@ def store_storybook_step(edition, ver_mode, trigger=None):
     commands = []
     if ver_mode == 'release':
         commands.extend([
-            './bin/grabpl store-storybook --deployment latest --src-bucket grafana-prerelease --src-dir artifacts/storybook',
-            './bin/grabpl store-storybook --deployment ${DRONE_TAG} --src-bucket grafana-prerelease --src-dir artifacts/storybook',
+            './bin/build store-storybook --deployment latest',
+            './bin/build store-storybook --deployment ${DRONE_TAG}',
         ])
 
     else:
         # main pipelines should deploy storybook to grafana-storybook/canary public bucket
-        commands = ['./bin/grabpl store-storybook --deployment canary --src-bucket grafana-storybook', ]
+        commands = ['./bin/build store-storybook --deployment canary', ]
 
     step = {
         'name': 'store-storybook',