refactor(cli): extract options and output packages (#2440)

Signed-off-by: Miguel Martinez <[email protected]>

Author: migmartri

app/cli/cmd/attached_integration_add.go

@@ -16,6 +16,7 @@
 package cmd
 
 import (
+	"github.com/chainloop-dev/chainloop/app/cli/cmd/output"
 	"github.com/chainloop-dev/chainloop/app/cli/internal/action"
 	"github.com/spf13/cobra"
 )
@@ -61,7 +62,7 @@ func newAttachedIntegrationAttachCmd() *cobra.Command {
 				return err
 			}
 
-			return encodeOutput([]*action.AttachedIntegrationItem{res}, attachedIntegrationListTableOutput)
+			return output.EncodeOutput(flagOutputFormat, []*action.AttachedIntegrationItem{res}, attachedIntegrationListTableOutput)
 		},
 	}
 

app/cli/cmd/attached_integration_list.go

@@ -20,6 +20,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/chainloop-dev/chainloop/app/cli/cmd/output"
 	"github.com/chainloop-dev/chainloop/app/cli/internal/action"
 	"github.com/jedib0t/go-pretty/v6/table"
 	"github.com/spf13/cobra"
@@ -38,7 +39,7 @@ func newAttachedIntegrationListCmd() *cobra.Command {
 				return err
 			}
 
-			return encodeOutput(res, attachedIntegrationListTableOutput)
+			return output.EncodeOutput(flagOutputFormat, res, attachedIntegrationListTableOutput)
 		},
 	}
 
@@ -58,7 +59,7 @@ func attachedIntegrationListTableOutput(attachments []*action.AttachedIntegratio
 		fmt.Println("Integrations attached to workflows")
 	}
 
-	t := newTableWriter()
+	t := output.NewTableWriter()
 	t.AppendHeader(table.Row{"ID", "Kind", "Config", "Workflow", "Attached At"})
 	for _, attachment := range attachments {
 		wf := attachment.Workflow

app/cli/cmd/attestation_add.go

@@ -26,6 +26,7 @@ import (
 	"github.com/spf13/viper"
 	"google.golang.org/grpc"
 
+	"github.com/chainloop-dev/chainloop/app/cli/cmd/output"
 	"github.com/chainloop-dev/chainloop/app/cli/internal/action"
 	schemaapi "github.com/chainloop-dev/chainloop/app/controlplane/api/workflowcontract/v1"
 	"github.com/chainloop-dev/chainloop/pkg/resourceloader"
@@ -118,7 +119,7 @@ func newAttestationAddCmd() *cobra.Command {
 						return err
 					}
 
-					return encodeOutput(resp, func(s *action.AttestationStatusMaterial) error {
+					return output.EncodeOutput(flagOutputFormat, resp, func(s *action.AttestationStatusMaterial) error {
 						return displayMaterialInfo(s, policies[resp.Name])
 					})
 				},
@@ -168,7 +169,7 @@ func displayMaterialInfo(status *action.AttestationStatusMaterial, policyEvaluat
 		return nil
 	}
 
-	mt := newTableWriter()
+	mt := output.NewTableWriter()
 
 	mt.AppendRow(table.Row{"Name", status.Material.Name})
 	mt.AppendRow(table.Row{"Type", status.Material.Type})

app/cli/cmd/attestation_init.go

@@ -19,6 +19,7 @@ import (
 	"errors"
 	"fmt"
 
+	"github.com/chainloop-dev/chainloop/app/cli/cmd/output"
 	"github.com/chainloop-dev/chainloop/app/cli/internal/action"
 	"github.com/spf13/cobra"
 )
@@ -129,7 +130,7 @@ func newAttestationInitCmd() *cobra.Command {
 				logger.Warn().Msg("DEPRECATION WARNING: --project not set, this will be required in the near future")
 			}
 
-			return encodeOutput(res, fullStatusTable)
+			return output.EncodeOutput(flagOutputFormat, res, fullStatusTable)
 		}}
 
 	// This option is only useful for local-based attestation states

app/cli/cmd/attestation_push.go

@@ -24,6 +24,7 @@ import (
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 
+	"github.com/chainloop-dev/chainloop/app/cli/cmd/output"
 	"github.com/chainloop-dev/chainloop/app/cli/internal/action"
 )
 
@@ -106,7 +107,7 @@ func newAttestationPushCmd() *cobra.Command {
 			res.Status.Digest = res.Digest
 
 			// If we are returning the json format, we also want to render the attestation table as one property so it can also be consumed
-			if flagOutputFormat == formatJSON {
+			if flagOutputFormat == output.FormatJSON {
 				// Render the attestation status to a string
 				buf := &bytes.Buffer{}
 				if err := fullStatusTableWithWriter(res.Status, buf); err != nil {
@@ -117,7 +118,7 @@ func newAttestationPushCmd() *cobra.Command {
 			}
 
 			// In TABLE format, we render the attestation status
-			if err := encodeOutput(res.Status, fullStatusTable); err != nil {
+			if err := output.EncodeOutput(flagOutputFormat, res.Status, fullStatusTable); err != nil {
 				return fmt.Errorf("failed to render output: %w", err)
 			}
 

app/cli/cmd/attestation_status.go

@@ -28,6 +28,7 @@ import (
 	"github.com/muesli/reflow/wrap"
 	"github.com/spf13/cobra"
 
+	"github.com/chainloop-dev/chainloop/app/cli/cmd/output"
 	"github.com/chainloop-dev/chainloop/app/cli/internal/action"
 	"github.com/chainloop-dev/chainloop/pkg/attestation/renderer/chainloop"
 )
@@ -58,12 +59,12 @@ func newAttestationStatusCmd() *cobra.Command {
 				return err
 			}
 
-			output := simpleStatusTable
+			outputF := simpleStatusTable
 			if full {
-				output = fullStatusTable
+				outputF = fullStatusTable
 			}
 
-			return encodeOutput(res, output)
+			return output.EncodeOutput(flagOutputFormat, res, outputF)
 		},
 	}
 
@@ -87,7 +88,7 @@ func fullStatusTableWithWriter(status *action.AttestationStatusResult, w io.Writ
 
 func attestationStatusTableOutput(status *action.AttestationStatusResult, w io.Writer, full bool) error {
 	// General info table
-	gt := newTableWriterWithWriter(w)
+	gt := output.NewTableWriterWithWriter(w)
 	gt.AppendRow(table.Row{"Initialized At", status.InitializedAt.Format(time.RFC822)})
 	gt.AppendSeparator()
 	meta := status.WorkflowMeta
@@ -154,7 +155,7 @@ func envVarsTable(status *action.AttestationStatusResult, w io.Writer, full bool
 
 	if len(status.EnvVars) > 0 {
 		// Env Variables table
-		evt := newTableWriterWithWriter(w)
+		evt := output.NewTableWriterWithWriter(w)
 		evt.SetTitle("Env Variables")
 		for k, v := range status.EnvVars {
 			if v == "" {
@@ -167,7 +168,7 @@ func envVarsTable(status *action.AttestationStatusResult, w io.Writer, full bool
 
 	runnerVars := status.RunnerContext.EnvVars
 	if len(runnerVars) > 0 && full {
-		evt := newTableWriterWithWriter(w)
+		evt := output.NewTableWriterWithWriter(w)
 		evt.SetTitle("Runner context")
 		for k, v := range runnerVars {
 			if v == "" {
@@ -190,7 +191,7 @@ func materialsTable(status *action.AttestationStatusResult, w io.Writer, full bo
 		return strings.Compare(a.Name, b.Name)
 	})
 
-	mt := newTableWriterWithWriter(w)
+	mt := output.NewTableWriterWithWriter(w)
 	mt.SetTitle("Materials")
 
 	for _, m := range status.Materials {

app/cli/cmd/available_integration_describe.go

@@ -21,6 +21,7 @@ import (
 	"fmt"
 	"sort"
 
+	"github.com/chainloop-dev/chainloop/app/cli/cmd/output"
 	"github.com/chainloop-dev/chainloop/app/cli/internal/action"
 	"github.com/chainloop-dev/chainloop/app/controlplane/plugins/sdk/v1"
 	"github.com/jedib0t/go-pretty/v6/table"
@@ -44,7 +45,7 @@ func newAvailableIntegrationDescribeCmd() *cobra.Command {
 				return fmt.Errorf("integration %q not found", integrationName)
 			}
 
-			return encodeOutput([]*action.AvailableIntegrationItem{item}, availableIntegrationDescribeTableOutput)
+			return output.EncodeOutput(flagOutputFormat, []*action.AvailableIntegrationItem{item}, availableIntegrationDescribeTableOutput)
 		},
 	}
 
@@ -97,7 +98,7 @@ func renderSchemaTable(tableTitle string, properties sdk.SchemaPropertiesMap) er
 		return nil
 	}
 
-	t := newTableWriter()
+	t := output.NewTableWriter()
 	t.SetTitle(tableTitle)
 	t.AppendHeader(table.Row{"Field", "Type", "Required", "Description"})
 
@@ -143,7 +144,7 @@ func renderSchemaRaw(tableTitle string, s string) error {
 		return err
 	}
 
-	rt := newTableWriter()
+	rt := output.NewTableWriter()
 	rt.SetTitle(tableTitle)
 	rt.AppendRow(table.Row{prettyAttachmentJSON.String()})
 	rt.Render()

app/cli/cmd/available_integration_list.go

@@ -19,6 +19,7 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/chainloop-dev/chainloop/app/cli/cmd/output"
 	"github.com/chainloop-dev/chainloop/app/cli/internal/action"
 	"github.com/jedib0t/go-pretty/v6/table"
 	"github.com/spf13/cobra"
@@ -35,7 +36,7 @@ func newAvailableIntegrationListCmd() *cobra.Command {
 				return err
 			}
 
-			return encodeOutput(res, availableIntegrationListTableOutput)
+			return output.EncodeOutput(flagOutputFormat, res, availableIntegrationListTableOutput)
 		},
 	}
 
@@ -48,7 +49,7 @@ func availableIntegrationListTableOutput(items []*action.AvailableIntegrationIte
 		return nil
 	}
 
-	t := newTableWriter()
+	t := output.NewTableWriter()
 	t.AppendHeader(table.Row{"Name", "Version", "Material Requirement", "Description"})
 	for _, i := range items {
 		t.AppendRow(table.Row{i.Name, i.Version, strings.Join(i.SubscribedInputs, ", "), i.Description})

app/cli/cmd/casbackend_add_azureblob.go

@@ -18,6 +18,7 @@ package cmd
 import (
 	"fmt"
 
+	"github.com/chainloop-dev/chainloop/app/cli/cmd/output"
 	"github.com/chainloop-dev/chainloop/app/cli/internal/action"
 	"github.com/chainloop-dev/chainloop/pkg/blobmanager/azureblob"
 	"github.com/go-kratos/kratos/v2/log"
@@ -70,7 +71,7 @@ func newCASBackendAddAzureBlobStorageCmd() *cobra.Command {
 				return nil
 			}
 
-			return encodeOutput(res, casBackendItemTableOutput)
+			return output.EncodeOutput(flagOutputFormat, res, casBackendItemTableOutput)
 		},
 	}
 

app/cli/cmd/casbackend_add_oci.go

@@ -16,6 +16,7 @@
 package cmd
 
 import (
+	"github.com/chainloop-dev/chainloop/app/cli/cmd/output"
 	"github.com/chainloop-dev/chainloop/app/cli/internal/action"
 	"github.com/go-kratos/kratos/v2/log"
 	"github.com/spf13/cobra"
@@ -65,7 +66,7 @@ func newCASBackendAddOCICmd() *cobra.Command {
 				return nil
 			}
 
-			return encodeOutput(res, casBackendItemTableOutput)
+			return output.EncodeOutput(flagOutputFormat, res, casBackendItemTableOutput)
 		},
 	}