feat(usage-view): download usage data in csv format (#214)

* feat(usage-view): download usage data in csv format

Signed-off-by: Michal Wasilewski <[email protected]>

.gitignore

@@ -17,3 +17,5 @@ key.*
 *.asc
 
 completions
+
+*.csv

client/client.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"net/http"
 	"net/url"
+	"strings"
 
 	"github.com/shurcooL/graphql"
 	"golang.org/x/oauth2"
@@ -66,14 +67,50 @@ func (c *client) URL(format string, a ...interface{}) string {
 }
 
 func (c *client) apiClient(ctx context.Context) (*graphql.Client, error) {
+	httpC, err := c.httpClient(ctx)
+	if err != nil {
+		return nil, fmt.Errorf("graphql client creation failed at http client creation: %w", err)
+	}
+
+	return graphql.NewClient(c.session.Endpoint(), httpC), nil
+}
+
+func (c *client) Do(req *http.Request) (*http.Response, error) {
+	// get http client
+	httpC, err := c.httpClient(req.Context())
+	if err != nil {
+		return nil, fmt.Errorf("http client creation failed: %w", err)
+	}
+
+	// prepend request URL with spacelift endpoint
+	endpoint := strings.TrimRight(c.session.Endpoint(), "/graphql")
+	u, err := url.Parse(endpoint)
+	if err != nil {
+		return nil, fmt.Errorf("failed to parse endpoint: %w", err)
+	}
+	req.URL.Scheme = u.Scheme
+	req.URL.Host = u.Host
+
+	// execute request
+	resp, err := httpC.Do(req)
+	if err != nil {
+		return nil, fmt.Errorf("error executing request: %w", err)
+	}
+	if resp.StatusCode == http.StatusUnauthorized {
+		return nil, fmt.Errorf("unauthorized: you can re-login using `spacectl profile login`")
+	}
+	return resp, err
+}
+
+func (c *client) httpClient(ctx context.Context) (*http.Client, error) {
 	bearerToken, err := c.session.BearerToken(ctx)
 	if err != nil {
 		return nil, err
 	}
 
-	return graphql.NewClient(c.session.Endpoint(), oauth2.NewClient(
+	return oauth2.NewClient(
 		context.WithValue(ctx, oauth2.HTTPClient, c.wraps), oauth2.StaticTokenSource(
 			&oauth2.Token{AccessToken: bearerToken},
 		),
-	)), nil
+	), nil
 }

client/interface.go

@@ -2,6 +2,7 @@ package client
 
 import (
 	"context"
+	"net/http"
 
 	"github.com/shurcooL/graphql"
 )
@@ -16,4 +17,7 @@ type Client interface {
 
 	// URL returns a full URL given a formatted path.
 	URL(string, ...interface{}) string
+
+	// Do executes an authenticated http request to the Spacelift API
+	Do(r *http.Request) (*http.Response, error)
 }

internal/cmd/profile/flags.go

@@ -2,6 +2,7 @@ package profile
 
 import (
 	"fmt"
+	"time"
 
 	"github.com/urfave/cli/v2"
 
@@ -65,3 +66,93 @@ var flagEndpoint = &cli.StringFlag{
 	Required: false,
 	EnvVars:  []string{"SPACECTL_LOGIN_ENDPOINT"},
 }
+
+const (
+	usageViewCSVTimeFormat   = "2006-01-02"
+	usageViewCSVDefaultRange = time.Duration(-1*30*24) * time.Hour
+)
+
+var flagUsageViewCSVSince = &cli.StringFlag{
+	Name:     "since",
+	Usage:    "[Optional] the start of the time range to query for usage data in format YYYY-MM-DD",
+	Required: false,
+	EnvVars:  []string{"SPACECTL_USAGE_VIEW_CSV_SINCE"},
+	Value:    time.Now().Add(usageViewCSVDefaultRange).Format(usageViewCSVTimeFormat),
+	Action: func(context *cli.Context, s string) error {
+		_, err := time.Parse(usageViewCSVTimeFormat, s)
+		if err != nil {
+			return err
+		}
+		return nil
+	},
+}
+
+var flagUsageViewCSVUntil = &cli.StringFlag{
+	Name:     "until",
+	Usage:    "[Optional] the end of the time range to query for usage data in format YYYY-MM-DD",
+	Required: false,
+	EnvVars:  []string{"SPACECTL_USAGE_VIEW_CSV_UNTIL"},
+	Value:    time.Now().Format(usageViewCSVTimeFormat),
+	Action: func(context *cli.Context, s string) error {
+		_, err := time.Parse(usageViewCSVTimeFormat, s)
+		if err != nil {
+			return err
+		}
+		return nil
+	},
+}
+
+const (
+	aspectRunMinutes  = "run-minutes"
+	aspectWorkerCount = "worker-count"
+)
+
+var aspects = map[string]struct{}{
+	aspectRunMinutes:  {},
+	aspectWorkerCount: {},
+}
+
+var flagUsageViewCSVAspect = &cli.StringFlag{
+	Name:     "aspect",
+	Usage:    "[Optional] the aspect to query for usage data",
+	Required: false,
+	EnvVars:  []string{"SPACECTL_USAGE_VIEW_CSV_ASPECT"},
+	Value:    aspectWorkerCount,
+	Action: func(context *cli.Context, s string) error {
+		if _, isValidAspect := aspects[s]; !isValidAspect {
+			return fmt.Errorf("invalid aspect: %s", s)
+		}
+		return nil
+	},
+}
+
+const (
+	groupByRunState = "run-state"
+	groupByRunType  = "run-type"
+)
+
+var groupBys = map[string]struct{}{
+	groupByRunState: {},
+	groupByRunType:  {},
+}
+
+var flagUsageViewCSVGroupBy = &cli.StringFlag{
+	Name:     "group-by",
+	Usage:    "[Optional] the aspect to group run minutes by",
+	Required: false,
+	EnvVars:  []string{"SPACECTL_USAGE_VIEW_CSV_GROUP_BY"},
+	Value:    groupByRunType,
+	Action: func(context *cli.Context, s string) error {
+		if _, isValidGroupBy := groupBys[s]; !isValidGroupBy {
+			return fmt.Errorf("invalid group-by: %s", s)
+		}
+		return nil
+	},
+}
+
+var flagUsageViewCSVFile = &cli.StringFlag{
+	Name:     "file",
+	Usage:    "[Optional] the file to save the CSV to",
+	Required: false,
+	EnvVars:  []string{"SPACECTL_USAGE_VIEW_CSV_FILE"},
+}

internal/cmd/profile/profile.go

@@ -27,6 +27,7 @@ func Command() *cli.Command {
 		Subcommands: []*cli.Command{
 			currentCommand(),
 			exportTokenCommand(),
+			usageViewCSVCommand(),
 			listCommand(),
 			loginCommand(),
 			logoutCommand(),

internal/cmd/profile/usage_view_csv_command.go

@@ -0,0 +1,96 @@
+package profile
+
+import (
+	"bufio"
+	"fmt"
+	"io"
+	"net/http"
+	"os"
+	"path/filepath"
+
+	"github.com/urfave/cli/v2"
+
+	"github.com/spacelift-io/spacectl/internal/cmd"
+	"github.com/spacelift-io/spacectl/internal/cmd/authenticated"
+)
+
+func usageViewCSVCommand() *cli.Command {
+	return &cli.Command{
+		Name:      "usage-csv",
+		Usage:     "Prints CSV with usage data for the current account",
+		ArgsUsage: cmd.EmptyArgsUsage,
+		Flags: []cli.Flag{
+			flagUsageViewCSVSince,
+			flagUsageViewCSVUntil,
+			flagUsageViewCSVAspect,
+			flagUsageViewCSVGroupBy,
+			flagUsageViewCSVFile,
+		},
+		Before: authenticated.Ensure,
+		Action: usageViewCsv,
+	}
+}
+
+func usageViewCsv(ctx *cli.Context) error {
+	// prep http query
+	params := buildQueryParams(ctx)
+	req, err := http.NewRequestWithContext(ctx.Context, http.MethodGet, "/usageanalytics/csv", nil)
+	if err != nil {
+		return fmt.Errorf("failed to create an HTTP request: %w", err)
+	}
+	q := req.URL.Query()
+	for k, v := range params {
+		q.Add(k, v)
+	}
+	req.URL.RawQuery = q.Encode()
+
+	// execute http query
+	fmt.Fprint(os.Stderr, "Querying Spacelift for usage data...\n")
+	resp, err := authenticated.Client.Do(req)
+	if err != nil {
+		return err
+	}
+	defer resp.Body.Close()
+	if resp.StatusCode != http.StatusOK {
+		return fmt.Errorf("unexpected status code: %d", resp.StatusCode)
+	}
+
+	// process a response
+	var filePath string
+	if ctx.IsSet(flagUsageViewCSVFile.Name) {
+		filePath = ctx.String(flagUsageViewCSVFile.Name)
+		fd, err := os.OpenFile(filepath.Clean(filePath), os.O_CREATE|os.O_WRONLY|os.O_EXCL, 0600)
+		if err != nil {
+			return fmt.Errorf("failed to open a file descriptor: %w", err)
+		}
+		defer fd.Close()
+		bfd := bufio.NewWriter(fd)
+		defer bfd.Flush()
+		_, err = io.Copy(bfd, resp.Body)
+		if err != nil {
+			return fmt.Errorf("failed to write the response to a file: %w", err)
+		}
+	} else {
+		_, err = io.Copy(os.Stdout, resp.Body)
+		if err != nil {
+			return fmt.Errorf("failed to write the response to stdout: %w", err)
+		}
+	}
+
+	fmt.Fprint(os.Stderr, "Usage data downloaded successfully.\n")
+	return nil
+}
+
+func buildQueryParams(ctx *cli.Context) map[string]string {
+	params := make(map[string]string)
+
+	params["since"] = ctx.String(flagUsageViewCSVSince.Name)
+	params["until"] = ctx.String(flagUsageViewCSVUntil.Name)
+	params["aspect"] = ctx.String(flagUsageViewCSVAspect.Name)
+
+	if ctx.String(flagUsageViewCSVAspect.Name) == "run-minutes" {
+		params["groupBy"] = ctx.String(flagUsageViewCSVGroupBy.Name)
+	}
+
+	return params
+}