Merge pull request #1163 from Scalingo/feat/STORY-2400/command-get-project-info

feat(projects): add command to get project info and private network details

Author: sc-zenokerr

CHANGELOG.md

@@ -5,6 +5,7 @@
 Some features listed in this changelog, like databases next generation, are currently only available in preview to
 selected users.
 
+* feat(projects): add command to get project and private network information
 * fix(privatenetworks): default format should be `table`
 * feat(databases next generation): create all commands to handle next generation `databases`.
 * feat(databases next generation): add the support of `--database` flag for several commands:

README.md

@@ -224,7 +224,8 @@ COMMANDS:
      projects-add     Create a project
      projects-update  Update a project
      projects-remove  Remove a project
-
+     projects-details Get details about a project
+     
    Public SSH Keys:
      keys         List your SSH public keys
      keys-add     Add a public SSH key to deploy your apps

cmd/commands.go

@@ -308,6 +308,7 @@ var (
 		&projectsAddCommand,
 		&projectsUpdateCommand,
 		&projectsRemoveCommand,
+		&projectsDetailsCommand,
 
 		// Private Networks
 		&privateNetworksApplicationDomainsListCommand,

cmd/projects.go

@@ -139,4 +139,32 @@ var (
 			_ = autocomplete.ProjectsGenericListAutoComplete(ctx)
 		},
 	}
+
+	projectsDetailsCommand = cli.Command{
+		Name:      "projects-details",
+		Category:  "Projects",
+		Usage:     "Get details about a project",
+		ArgsUsage: "project-id",
+		Description: CommandDescription{
+			Description: "Get details about a project",
+			Examples:    []string{"scalingo projects-details prj-00000000-0000-0000-0000-000000000000"},
+		}.Render(),
+		Action: func(ctx context.Context, c *cli.Command) error {
+			projectID := c.Args().First()
+			if projectID == "" {
+				errorQuitWithHelpMessage(ctx, errors.New(ctx, "missing project ID parameter"), c, "projects-details")
+			}
+
+			err := projects.Get(ctx, projectID)
+			if err != nil {
+				errorQuit(ctx, err)
+			}
+
+			return nil
+		},
+		ShellComplete: func(ctx context.Context, c *cli.Command) {
+			_ = autocomplete.CmdFlagsAutoComplete(c, "projects-details")
+			_ = autocomplete.ProjectsGenericListAutoComplete(ctx)
+		},
+	}
 )

go.mod

@@ -4,7 +4,7 @@ go 1.24.0
 
 require (
 	github.com/AlecAivazis/survey/v2 v2.3.7
-	github.com/Scalingo/go-scalingo/v8 v8.7.1
+	github.com/Scalingo/go-scalingo/v8 v8.8.0
 	github.com/Scalingo/go-utils/errors/v2 v2.5.1
 	github.com/Scalingo/go-utils/logger v1.11.0
 	github.com/Scalingo/gopassword v1.1.0

go.sum

@@ -9,8 +9,8 @@ github.com/Netflix/go-expect v0.0.0-20220104043353-73e0943537d2 h1:+vx7roKuyA63n
 github.com/Netflix/go-expect v0.0.0-20220104043353-73e0943537d2/go.mod h1:HBCaDeC1lPdgDeDbhX8XFpy1jqjK0IBG8W5K+xYqA0w=
 github.com/ProtonMail/go-crypto v1.3.0 h1:ILq8+Sf5If5DCpHQp4PbZdS1J7HDFRXz/+xKBiRGFrw=
 github.com/ProtonMail/go-crypto v1.3.0/go.mod h1:9whxjD8Rbs29b4XWbB8irEcE8KHMqaR2e7GWU1R+/PE=
-github.com/Scalingo/go-scalingo/v8 v8.7.1 h1:Sqos+T77pVBR6iTQenG/7yafQoWMCNurBtdQD8Vg+MQ=
-github.com/Scalingo/go-scalingo/v8 v8.7.1/go.mod h1:C87ufsz8H4/tUutK6cAmUaLpM4HwV8QOGAyfZyRgFAA=
+github.com/Scalingo/go-scalingo/v8 v8.8.0 h1:OY14XbEEdZabwImRgXGL0txjesdhW8fX5/GrlAsxlBg=
+github.com/Scalingo/go-scalingo/v8 v8.8.0/go.mod h1:C87ufsz8H4/tUutK6cAmUaLpM4HwV8QOGAyfZyRgFAA=
 github.com/Scalingo/go-utils/errors/v2 v2.5.1 h1:1tfJW6/ZxTgrRmFTlKQCOtArQquOW0/XdZQzx8wMHoM=
 github.com/Scalingo/go-utils/errors/v2 v2.5.1/go.mod h1:SbR1JuMtfAl+gpM7ahUW/c3Jm5MMzMAwJBk1pEHkVd8=
 github.com/Scalingo/go-utils/logger v1.11.0 h1:QUsGgZIv6LWUCyKKy06DuW67FLmzSmWPmnhD/3YlxeM=

projects/details.go

@@ -0,0 +1,64 @@
+package projects
+
+import (
+	"context"
+	"os"
+	"strconv"
+
+	"github.com/olekukonko/tablewriter"
+
+	"github.com/Scalingo/cli/config"
+	"github.com/Scalingo/go-utils/errors/v2"
+	"github.com/Scalingo/go-utils/logger"
+)
+
+func Get(ctx context.Context, projectID string) error {
+	log := logger.Get(ctx)
+	client, err := config.ScalingoClient(ctx)
+	if err != nil {
+		return errors.Wrap(ctx, err, "get Scalingo client")
+	}
+
+	project, err := client.ProjectGet(ctx, projectID)
+	if err != nil {
+		return errors.Wrap(ctx, err, "get project")
+	}
+
+	t := tablewriter.NewWriter(os.Stdout)
+	t.Header([]string{"Project Field", "Value"})
+
+	_ = t.Append([]string{"Name", project.Name})
+	_ = t.Append([]string{"ID", project.ID})
+	_ = t.Append([]string{"Default", strconv.FormatBool(project.Default)})
+	_ = t.Append([]string{"Owner", project.Owner.Username})
+
+	if project.Flags["private-network"] {
+		_ = t.Append([]string{"", ""})
+		_ = t.Append([]string{"Private Network", "true"})
+
+		privateNetworkInfo, err := client.ProjectPrivateNetworkGet(ctx, projectID)
+		if err != nil {
+			log.WithError(err).Error("Failed to fetch private network info")
+			_ = t.Append([]string{"", "Failed to fetch private network info"})
+		} else {
+			_ = t.Append([]string{" - ID", privateNetworkInfo.ID})
+			_ = t.Append([]string{" - Subnet", privateNetworkInfo.Subnet})
+			_ = t.Append([]string{" - Gateway IP", privateNetworkInfo.Gateway})
+			_ = t.Append([]string{" - Total number of assignable IPs", strconv.Itoa(privateNetworkInfo.MaxIPsCount)})
+			_ = t.Append([]string{" - Used IPs count", strconv.Itoa(privateNetworkInfo.UsedIPsCount)})
+
+			if len(privateNetworkInfo.UsedIPs) == 0 {
+				_ = t.Append([]string{" - Used IPs", "None"})
+			} else {
+				_ = t.Append([]string{" - Used IPs", privateNetworkInfo.UsedIPs[0]})
+			}
+			for _, usedIP := range privateNetworkInfo.UsedIPs[1:] {
+				_ = t.Append([]string{"", usedIP})
+			}
+		}
+	}
+
+	_ = t.Render()
+
+	return nil
+}

projects/list.go

@@ -2,6 +2,7 @@ package projects
 
 import (
 	"context"
+	"fmt"
 	"os"
 	"strconv"
 
@@ -26,10 +27,15 @@ func List(ctx context.Context) error {
 	io.Warning("This command only displays projects where you are the owner")
 
 	t := tablewriter.NewWriter(os.Stdout)
-	t.Header([]string{"Name", "Default", "ID"})
+	t.Header([]string{"Name", "Default", "ID", "Private Network"})
 
 	for _, project := range projects {
-		_ = t.Append([]string{project.Name, strconv.FormatBool(project.Default), project.ID})
+		hasPrivateNetwork := ""
+		if project.Flags["private-network"] {
+			hasPrivateNetwork = "true"
+		}
+		fmt.Print(project.Flags)
+		_ = t.Append([]string{project.Name, strconv.FormatBool(project.Default), project.ID, hasPrivateNetwork})
 	}
 	_ = t.Render()