Add k6 cloud project and k6 cloud project list commands

internal/cloudapi/v6/api.go

@@ -5,11 +5,47 @@ import (
 	"errors"
 	"fmt"
 	"io"
+	"math"
 	"net/url"
 
 	k6cloud "github.com/grafana/k6-cloud-openapi-client-go/k6"
 )
 
+// ListProjects retrieves the list of projects for the configured stack.
+func (c *Client) ListProjects() (*k6cloud.ProjectListResponse, error) {
+	// Bound checking stackID (int64) to support using it as an int32 in calls
+	// to the API.
+	if c.stackID < math.MinInt32 || c.stackID > math.MaxInt32 {
+		return nil, fmt.Errorf("stack ID %d overflows int32", c.stackID)
+	}
+
+	ctx := context.WithValue(context.Background(), k6cloud.ContextAccessToken, c.token)
+	req := c.apiClient.ProjectsAPI.
+		ProjectsList(ctx).
+		XStackId(int32(c.stackID))
+
+	resp, httpRes, rerr := req.Execute()
+	defer func() {
+		if httpRes != nil {
+			_, _ = io.Copy(io.Discard, httpRes.Body)
+			_ = httpRes.Body.Close()
+		}
+	}()
+
+	if rerr != nil {
+		var apiErr *k6cloud.GenericOpenAPIError
+		if !errors.As(rerr, &apiErr) {
+			return nil, fmt.Errorf("failed to list projects: %w", rerr)
+		}
+	}
+
+	if err := CheckResponse(httpRes); err != nil {
+		return nil, fmt.Errorf("failed to list projects: %w", err)
+	}
+
+	return resp, nil
+}
+
 // ValidateToken calls the endpoint to validate the Client's token and returns the result.
 func (c *Client) ValidateToken(stackURL string) (_ *k6cloud.AuthenticationResponse, err error) {
 	if stackURL == "" {

internal/cmd/cloud.go

@@ -410,6 +410,9 @@ func getCmdCloud(gs *state.GlobalState) *cobra.Command {
 	uploadCmd.SetUsageTemplate(defaultUsageTemplate)
 	cloudCmd.AddCommand(uploadCmd)
 
+	projectCmd := getCmdCloudProject(c)
+	cloudCmd.AddCommand(projectCmd)
+
 	cloudCmd.Flags().SortFlags = false
 	cloudCmd.Flags().AddFlagSet(c.flagSet())
 

internal/cmd/cloud_project.go

@@ -0,0 +1,57 @@
+package cmd
+
+import (
+	"strings"
+
+	"github.com/spf13/cobra"
+	"go.k6.io/k6/cmd/state"
+)
+
+type cmdCloudProject struct {
+	globalState *state.GlobalState
+}
+
+func getCmdCloudProject(cloudCmd *cmdCloud) *cobra.Command {
+	c := &cmdCloudProject{
+		globalState: cloudCmd.gs,
+	}
+
+	exampleText := getExampleText(cloudCmd.gs, `
+  # List all projects in the configured stack
+  $ {{.}} cloud project list
+
+  # List projects in JSON format
+  $ {{.}} cloud project list --json`[1:])
+
+	cloudProjectCommand := &cobra.Command{
+		Use:   "project",
+		Short: "Work with Grafana Cloud k6 projects",
+		Long:  `Work with Grafana Cloud k6 projects.`,
+
+		Example: exampleText,
+	}
+
+	defaultUsageTemplate := (&cobra.Command{}).UsageTemplate()
+	defaultUsageTemplate = strings.ReplaceAll(defaultUsageTemplate, "FlagUsages", "FlagUsagesWrapped 120")
+
+	listCmd := getCmdCloudProjectList(c)
+	listCmd.SetUsageTemplate(defaultUsageTemplate)
+	cloudProjectCommand.AddCommand(listCmd)
+
+	cloudProjectCommand.SetUsageTemplate(`Usage:
+  {{.CommandPath}} <command> [flags]
+
+Available Commands:{{range .Commands}}{{if .IsAvailableCommand}}
+  {{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}
+
+Examples:
+{{.Example}}
+Flags:
+  -h, --help   Show help
+{{if .HasExample}}
+{{end}}
+Use "{{.CommandPath}} <command> --help" for more information about a command.
+`)
+
+	return cloudProjectCommand
+}

internal/cmd/cloud_project_list.go

@@ -0,0 +1,141 @@
+package cmd
+
+import (
+	"bytes"
+	"encoding/json"
+	"errors"
+	"fmt"
+	"strings"
+	"text/tabwriter"
+
+	k6cloud "github.com/grafana/k6-cloud-openapi-client-go/k6"
+	"github.com/spf13/cobra"
+
+	"go.k6.io/k6/cloudapi"
+	"go.k6.io/k6/cmd/state"
+	"go.k6.io/k6/internal/build"
+	v6cloudapi "go.k6.io/k6/internal/cloudapi/v6"
+)
+
+type cmdCloudProjectList struct {
+	globalState *state.GlobalState
+	isJSON      bool
+}
+
+func getCmdCloudProjectList(projectCmd *cmdCloudProject) *cobra.Command {
+	c := &cmdCloudProjectList{
+		globalState: projectCmd.globalState,
+	}
+
+	exampleText := getExampleText(projectCmd.globalState, `
+  # List all projects in the configured stack
+  $ {{.}} cloud project list`[1:])
+
+	listCmd := &cobra.Command{
+		Use:     "list",
+		Short:   "List Grafana Cloud k6 projects",
+		Long:    `List all projects in the configured Grafana Cloud k6 stack.`,
+		Example: exampleText,
+		Args:    cobra.NoArgs,
+		RunE:    c.run,
+	}
+
+	listCmd.Flags().BoolVar(&c.isJSON, "json", false, "output project list in JSON format")
+
+	return listCmd
+}
+
+func (c *cmdCloudProjectList) run(_ *cobra.Command, _ []string) error {
+	if !checkIfMigrationCompleted(c.globalState) {
+		if err := migrateLegacyConfigFileIfAny(c.globalState); err != nil {
+			return err
+		}
+	}
+
+	currentDiskConf, err := readDiskConfig(c.globalState)
+	if err != nil {
+		return err
+	}
+
+	currentJSONConfigRaw := currentDiskConf.Collectors["cloud"]
+
+	cloudConfig, warn, err := cloudapi.GetConsolidatedConfig(
+		currentJSONConfigRaw, c.globalState.Env, "", nil, nil)
+	if err != nil {
+		return err
+	}
+	if warn != "" {
+		c.globalState.Logger.Warn(warn)
+	}
+
+	if !cloudConfig.Token.Valid || cloudConfig.Token.String == "" {
+		return errUserUnauthenticated
+	}
+
+	if !cloudConfig.StackID.Valid || cloudConfig.StackID.Int64 == 0 {
+		return errors.New(
+			"no stack configured. Please run `k6 cloud login --stack <your-stack>` to set a default stack",
+		)
+	}
+
+	client, err := v6cloudapi.NewClient(
+		c.globalState.Logger,
+		cloudConfig.Token.String,
+		cloudConfig.Hostv6.String,
+		build.Version,
+		cloudConfig.Timeout.TimeDuration(),
+	)
+	if err != nil {
+		return err
+	}
+	client.SetStackID(cloudConfig.StackID.Int64)
+
+	resp, err := client.ListProjects()
+	if err != nil {
+		return err
+	}
+
+	if c.isJSON {
+		return c.outputJSON(resp.Value)
+	}
+
+	stackHeader := fmt.Sprintf("Projects for stack %d:\n\n", cloudConfig.StackID.Int64)
+
+	if len(resp.Value) == 0 {
+		printToStdout(c.globalState, stackHeader+
+			"No projects found.\n"+
+			"To create a project, visit https://grafana.com/docs/grafana-cloud/testing/k6/projects/\n")
+		return nil
+	}
+
+	printToStdout(c.globalState, stackHeader+formatProjectTable(resp.Value))
+	return nil
+}
+
+func (c *cmdCloudProjectList) outputJSON(projects []k6cloud.ProjectApiModel) error {
+	buf := &bytes.Buffer{}
+	enc := json.NewEncoder(buf)
+	enc.SetEscapeHTML(false)
+	enc.SetIndent("", "  ")
+	if err := enc.Encode(projects); err != nil {
+		return fmt.Errorf("failed to encode project list: %w", err)
+	}
+
+	printToStdout(c.globalState, buf.String())
+	return nil
+}
+
+func formatProjectTable(projects []k6cloud.ProjectApiModel) string {
+	var buf strings.Builder
+	w := tabwriter.NewWriter(&buf, 0, 0, 3, ' ', 0)
+	_, _ = fmt.Fprintln(w, "ID\tNAME\tDEFAULT")
+	for _, p := range projects {
+		def := "no"
+		if p.IsDefault {
+			def = "yes"
+		}
+		_, _ = fmt.Fprintf(w, "%d\t%s\t%s\n", p.Id, p.Name, def)
+	}
+	_ = w.Flush()
+	return buf.String()
+}