Print deployment results as a table (#1033)

* refactor printServiceStatesAndEndpoints to print Table

* only show domains if they are present

* use Status instead of State

* use ID instead of Etag

* use Deployment instead of Id

* use state instead of status

* use Deployment instead of Id

* Revert "use state instead of status"

This reverts commit 02d350a.

* rename Etag to Deployment for internal structs (#1089)

Author: jordanstephens

src/cmd/cli/command/cd.go

@@ -200,9 +200,9 @@ var cdPreviewCmd = &cobra.Command{
 		}
 
 		tailOptions := cli.TailOptions{
-			Etag:    resp.Etag,
-			Verbose: verbose,
-			LogType: logs.LogTypeAll,
+			Deployment: resp.Etag,
+			Verbose:    verbose,
+			LogType:    logs.LogTypeAll,
 		}
 		return cli.Tail(cmd.Context(), provider, project.Name, tailOptions)
 	},

src/cmd/cli/command/commands.go

@@ -254,6 +254,8 @@ func SetupCommands(ctx context.Context, version string) {
 
 	// Debug Command
 	debugCmd.Flags().String("etag", "", "deployment ID (ETag) of the service")
+	debugCmd.Flags().MarkHidden("etag")
+	debugCmd.Flags().String("deployment", "", "deployment ID of the service")
 	debugCmd.Flags().String("since", "", "start time for logs (RFC3339 format)")
 	debugCmd.Flags().String("until", "", "end time for logs (RFC3339 format)")
 	debugCmd.Flags().StringVar(&modelId, "model", modelId, "LLM model to use for debugging (Pro users only)")
@@ -865,9 +867,14 @@ var debugCmd = &cobra.Command{
 	Short:       "Debug a build, deployment, or service failure",
 	RunE: func(cmd *cobra.Command, args []string) error {
 		etag, _ := cmd.Flags().GetString("etag")
+		deployment, _ := cmd.Flags().GetString("deployment")
 		since, _ := cmd.Flags().GetString("since")
 		until, _ := cmd.Flags().GetString("until")
 
+		if etag != "" && deployment == "" {
+			deployment = etag
+		}
+
 		loader := configureLoader(cmd)
 		provider, err := getProvider(cmd.Context(), loader)
 		if err != nil {
@@ -890,7 +897,7 @@ var debugCmd = &cobra.Command{
 		}
 
 		debugConfig := cli.DebugConfig{
-			Etag:           etag,
+			Deployment:     deployment,
 			FailedServices: args,
 			ModelId:        modelId,
 			Project:        project,
@@ -930,7 +937,7 @@ var deleteCmd = &cobra.Command{
 		}
 
 		since := time.Now()
-		etag, err := cli.Delete(cmd.Context(), projectName, client, provider, names...)
+		deployment, err := cli.Delete(cmd.Context(), projectName, client, provider, names...)
 		if err != nil {
 			if connect.CodeOf(err) == connect.CodeNotFound {
 				// Show a warning (not an error) if the service was not found
@@ -940,20 +947,20 @@ var deleteCmd = &cobra.Command{
 			return err
 		}
 
-		term.Info("Deleted service", names, "with deployment ID", etag)
+		term.Info("Deleted service", names, "with deployment ID", deployment)
 
 		if !tail {
-			printDefangHint("To track the update, do:", "tail --etag "+etag)
+			printDefangHint("To track the update, do:", "tail --deployment "+deployment)
 			return nil
 		}
 
 		term.Info("Tailing logs for update; press Ctrl+C to detach:")
 
 		tailOptions := cli.TailOptions{
-			Etag:    etag,
-			LogType: logs.LogTypeAll,
-			Since:   since,
-			Verbose: verbose,
+			Deployment: deployment,
+			LogType:    logs.LogTypeAll,
+			Since:      since,
+			Verbose:    verbose,
 		}
 		return cli.Tail(cmd.Context(), provider, projectName, tailOptions)
 	},

src/cmd/cli/command/compose.go

@@ -170,11 +170,11 @@ func makeComposeUpCmd() *cobra.Command {
 					// Tail got canceled because of deployment failure: prompt to show the debugger
 					term.Warn(errDeploymentFailed)
 					debugConfig := cli.DebugConfig{
-						Etag:     deploy.Etag,
-						ModelId:  modelId,
-						Project:  project,
-						Provider: provider,
-						Since:    since,
+						Deployment: deploy.Etag,
+						ModelId:    modelId,
+						Project:    project,
+						Provider:   provider,
+						Since:      since,
 					}
 					if errDeploymentFailed.Service != "" {
 						debugConfig.FailedServices = []string{errDeploymentFailed.Service}
@@ -196,7 +196,10 @@ func makeComposeUpCmd() *cobra.Command {
 			}
 
 			// Print the current service states of the deployment
-			printServiceStatesAndEndpoints(deploy.Services)
+			err = printServiceStatesAndEndpoints(deploy.Services)
+			if err != nil {
+				return err
+			}
 
 			term.Info("Done.")
 			return nil
@@ -289,7 +292,7 @@ func makeComposeDownCmd() *cobra.Command {
 			}
 
 			since := time.Now()
-			etag, err := cli.ComposeDown(cmd.Context(), projectName, client, provider, args...)
+			deployment, err := cli.ComposeDown(cmd.Context(), projectName, client, provider, args...)
 			if err != nil {
 				if connect.CodeOf(err) == connect.CodeNotFound {
 					// Show a warning (not an error) if the service was not found
@@ -299,10 +302,10 @@ func makeComposeDownCmd() *cobra.Command {
 				return err
 			}
 
-			term.Info("Deleted services, deployment ID", etag)
+			term.Info("Deleted services, deployment ID", deployment)
 
 			if detach {
-				printDefangHint("To track the update, do:", "tail --etag "+etag)
+				printDefangHint("To track the update, do:", "tail --deployment "+deployment)
 				return nil
 			}
 
@@ -311,7 +314,7 @@ func makeComposeDownCmd() *cobra.Command {
 				{Service: "cd", Host: "pulumi", EventLog: "Update succeeded in "},
 			}
 			tailOptions := cli.TailOptions{
-				Etag:               etag,
+				Deployment:         deployment,
 				Since:              since,
 				EndEventDetectFunc: cli.CreateEndLogEventDetectFunc(endLogConditions),
 				Verbose:            verbose,
@@ -431,13 +434,18 @@ func makeComposeLogsCmd() *cobra.Command {
 		RunE: func(cmd *cobra.Command, args []string) error {
 			var name, _ = cmd.Flags().GetString("name")
 			var etag, _ = cmd.Flags().GetString("etag")
+			var deployment, _ = cmd.Flags().GetString("deployment")
 			var raw, _ = cmd.Flags().GetBool("raw")
 			var since, _ = cmd.Flags().GetString("since")
 			var utc, _ = cmd.Flags().GetBool("utc")
 			var verbose, _ = cmd.Flags().GetBool("verbose")
 			var filter, _ = cmd.Flags().GetString("filter")
 			var until, _ = cmd.Flags().GetString("until")
 
+			if etag != "" && deployment == "" {
+				deployment = etag
+			}
+
 			if utc {
 				cli.EnableUTCMode()
 			}
@@ -484,14 +492,14 @@ func makeComposeLogsCmd() *cobra.Command {
 			}
 
 			tailOptions := cli.TailOptions{
-				Etag:     etag,
-				Filter:   filter,
-				LogType:  logType,
-				Raw:      raw,
-				Services: services,
-				Since:    sinceTs,
-				Until:    untilTs,
-				Verbose:  verbose,
+				Deployment: deployment,
+				Filter:     filter,
+				LogType:    logType,
+				Raw:        raw,
+				Services:   services,
+				Since:      sinceTs,
+				Until:      untilTs,
+				Verbose:    verbose,
 			}
 
 			return cli.Tail(cmd.Context(), provider, projectName, tailOptions)
@@ -500,6 +508,8 @@ func makeComposeLogsCmd() *cobra.Command {
 	logsCmd.Flags().StringP("name", "n", "", "name of the service (backwards compat)")
 	logsCmd.Flags().MarkHidden("name")
 	logsCmd.Flags().String("etag", "", "deployment ID (ETag) of the service")
+	logsCmd.Flags().MarkHidden("etag")
+	logsCmd.Flags().String("deployment", "", "deployment ID of the service")
 	logsCmd.Flags().Bool("follow", false, "follow log output") // NOTE: -f is already used by --file
 	logsCmd.Flags().MarkHidden("follow")                       // TODO: implement this
 	logsCmd.Flags().BoolP("raw", "r", false, "show raw (unparsed) logs")

src/cmd/cli/command/deploymentinfo.go

@@ -1,6 +1,8 @@
 package command
 
 import (
+	"strings"
+
 	"github.com/DefangLabs/defang/src/pkg/cli"
 	cliClient "github.com/DefangLabs/defang/src/pkg/cli/client"
 	"github.com/DefangLabs/defang/src/pkg/term"
@@ -20,31 +22,50 @@ func printPlaygroundPortalServiceURLs(serviceInfos []*defangv1.ServiceInfo) {
 	}
 }
 
-func printServiceStatesAndEndpoints(serviceInfos []*defangv1.ServiceInfo) {
-	for _, serviceInfo := range serviceInfos {
-		andEndpoints := ""
-		if len(serviceInfo.Endpoints) > 0 {
-			andEndpoints = "and will be available at:"
-		}
+type ServiceTableItem struct {
+	Deployment string `json:"Deployment"`
+	Status     string `json:"Status"`
+	Name       string `json:"Name"`
+	DomainName string `json:"DomainName"`
+	Endpoints  string `json:"Endpoints"`
+}
 
-		serviceConditionText := "has status " + serviceInfo.Status
-		if serviceInfo.State != defangv1.ServiceState_NOT_SPECIFIED {
-			serviceConditionText = "is in state " + serviceInfo.State.String()
-		}
+func printServiceStatesAndEndpoints(serviceInfos []*defangv1.ServiceInfo) error {
+	serviceTableItems := make([]ServiceTableItem, 0, len(serviceInfos))
 
-		term.Info("Service", serviceInfo.Service.Name, serviceConditionText, andEndpoints)
-		for i, endpoint := range serviceInfo.Endpoints {
-			if serviceInfo.Service.Ports[i].Mode == defangv1.Mode_INGRESS {
-				endpoint = "https://" + endpoint
-			}
-			term.Println("   -", endpoint)
-		}
+	showDomainNameColumn := false
+	showCertGenerateHint := false
+	for _, serviceInfo := range serviceInfos {
+		var domainname string
 		if serviceInfo.Domainname != "" {
-			if serviceInfo.ZoneId != "" {
-				term.Println("   -", "https://"+serviceInfo.Domainname)
-			} else {
-				term.Println("   -", "https://"+serviceInfo.Domainname+" (after `defang cert generate` to get a TLS certificate)")
+			showDomainNameColumn = true
+			domainname = "https://" + serviceInfo.Domainname
+			if serviceInfo.ZoneId == "" {
+				showCertGenerateHint = true
 			}
 		}
+		serviceTableItems = append(serviceTableItems, ServiceTableItem{
+			Deployment: serviceInfo.Etag,
+			Name:       serviceInfo.Service.Name,
+			Status:     serviceInfo.State.String(),
+			DomainName: domainname,
+			Endpoints:  strings.Join(serviceInfo.Endpoints, ", "),
+		})
 	}
+
+	attrs := []string{"Deployment", "Name", "Status", "Endpoints"}
+	if showDomainNameColumn {
+		attrs = append(attrs, "DomainName")
+	}
+
+	err := term.Table(serviceTableItems, attrs)
+	if err != nil {
+		return err
+	}
+
+	if showCertGenerateHint {
+		term.Info("Run `defang cert generate` to get a TLS certificate for your service(s)")
+	}
+
+	return nil
 }

src/cmd/cli/command/deploymentinfo_test.go

@@ -3,6 +3,7 @@ package command
 import (
 	"bytes"
 	"os"
+	"strings"
 	"testing"
 
 	"github.com/DefangLabs/defang/src/pkg/cli"
@@ -43,7 +44,7 @@ func TestPrintServiceStatesAndEndpoints(t *testing.T) {
 	var stdout, stderr bytes.Buffer
 	term.DefaultTerm = term.NewTerm(os.Stdin, &stdout, &stderr)
 
-	printServiceStatesAndEndpoints([]*defangv1.ServiceInfo{
+	_ = printServiceStatesAndEndpoints([]*defangv1.ServiceInfo{
 		{
 			Service: &defangv1.Service{
 				Name: "service1",
@@ -58,11 +59,65 @@ func TestPrintServiceStatesAndEndpoints(t *testing.T) {
 				"service1.internal",
 			},
 		}})
-	const want = ` * Service service1 has status UNKNOWN and will be available at:
-   - https://example.com
-   - service1.internal
+	const expectedOutput = `Deployment  Name      Status         Endpoints
+            service1  NOT_SPECIFIED  example.com, service1.internal
 `
-	if got := stdout.String(); got != want {
-		t.Errorf("got %q, want %q", got, want)
+	receivedLines := strings.Split(stdout.String(), "\n")
+	expectedLines := strings.Split(expectedOutput, "\n")
+
+	if len(receivedLines) != len(expectedLines) {
+		t.Errorf("Expected %v lines, received %v", len(expectedLines), len(receivedLines))
+	}
+
+	for i, receivedLine := range receivedLines {
+		receivedLine = strings.TrimRight(receivedLine, " ")
+		if receivedLine != expectedLines[i] {
+			t.Errorf("\n-%v\n+%v", expectedLines[i], receivedLine)
+		}
+	}
+}
+
+func TestPrintServiceStatesAndEndpointsAndDomainname(t *testing.T) {
+	defaultTerm := term.DefaultTerm
+	t.Cleanup(func() {
+		term.DefaultTerm = defaultTerm
+	})
+
+	var stdout, stderr bytes.Buffer
+	term.DefaultTerm = term.NewTerm(os.Stdin, &stdout, &stderr)
+
+	_ = printServiceStatesAndEndpoints([]*defangv1.ServiceInfo{
+		{
+			Service: &defangv1.Service{
+				Name: "service1",
+				Ports: []*defangv1.Port{
+					{Mode: defangv1.Mode_INGRESS},
+					{Mode: defangv1.Mode_HOST},
+				},
+			},
+			Status:     "UNKNOWN",
+			Domainname: "example.com",
+			Endpoints: []string{
+				"example.com",
+				"service1.internal",
+			},
+		}})
+	expectedLines := []string{
+		"Deployment  Name      Status         Endpoints                       DomainName",
+		"            service1  NOT_SPECIFIED  example.com, service1.internal  https://example.com",
+		" * Run `defang cert generate` to get a TLS certificate for your service(s)",
+		"",
+	}
+	receivedLines := strings.Split(stdout.String(), "\n")
+
+	if len(receivedLines) != len(expectedLines) {
+		t.Errorf("Expected %v lines, received %v", len(expectedLines), len(receivedLines))
+	}
+
+	for i, receivedLine := range receivedLines {
+		receivedLine = strings.TrimRight(receivedLine, " ")
+		if receivedLine != expectedLines[i] {
+			t.Errorf("\n-%v\n+%v", expectedLines[i], receivedLine)
+		}
 	}
 }

src/pkg/cli/bootstrap.go

@@ -23,7 +23,7 @@ func BootstrapCommand(ctx context.Context, projectName string, verbose bool, p c
 		return err
 	}
 
-	return tail(ctx, p, projectName, TailOptions{Etag: etag, Since: since, LogType: logs.LogTypeBuild, Verbose: verbose})
+	return tail(ctx, p, projectName, TailOptions{Deployment: etag, Since: since, LogType: logs.LogTypeBuild, Verbose: verbose})
 }
 
 func SplitProjectStack(name string) (projectName string, stackName string) {

src/pkg/cli/composeUp.go

@@ -145,8 +145,8 @@ func ComposeUp(ctx context.Context, project *compose.Project, c client.FabricCli
 }
 
 func TailUp(ctx context.Context, provider client.Provider, project *compose.Project, deploy *defangv1.DeployResponse, tailOptions TailOptions) error {
-	if tailOptions.Etag == "" {
-		tailOptions.Etag = deploy.Etag
+	if tailOptions.Deployment == "" {
+		tailOptions.Deployment = deploy.Etag
 	}
 	if tailOptions.Since.IsZero() {
 		tailOptions.Since = time.Now()
@@ -232,11 +232,11 @@ func WaitAndTail(ctx context.Context, project *compose.Project, client client.Fa
 
 func NewTailOptionsForDeploy(deploy *defangv1.DeployResponse, since time.Time, verbose bool) TailOptions {
 	return TailOptions{
-		Etag:    deploy.Etag,
-		Since:   since,
-		Raw:     false,
-		Verbose: verbose,
-		LogType: logs.LogTypeAll,
+		Deployment: deploy.Etag,
+		Since:      since,
+		Raw:        false,
+		Verbose:    verbose,
+		LogType:    logs.LogTypeAll,
 	}
 }