feat(cmx): Refactor network update, add collect-report bool (#558)

* feat(cmx): Refactor network update, add collect-report bool

This PR refactors network update to no longer accept subcommands
and instead accept the '--policy' flag to modify policies.

It also removes the 'network outbound' subcommand which has
long been deprecated.

Finally, the --collect-report bool has been added to the
network update command to allow enabling/disabling network
reporting on a network.  If a network has the collect-report
bool set to true the REPORTING column will show either on/off.

Signed-off-by: Kyle Squizzato <[email protected]>

* Unhide the network report subcommand

Signed-off-by: Kyle Squizzato <[email protected]>

---------

Signed-off-by: Kyle Squizzato <[email protected]>

Author: squizzi

cli/cmd/network_report.go

@@ -26,7 +26,6 @@ replicated network report --id abc123 --watch --output table
 replicated network report --id abc123 --watch --output json`,
 		RunE:              r.getNetworkReport,
 		ValidArgsFunction: r.completeNetworkIDs,
-		Hidden:            true,
 	}
 	parent.AddCommand(cmd)
 

cli/cmd/network_update.go

@@ -2,22 +2,40 @@ package cmd
 
 import (
 	"github.com/pkg/errors"
+	"github.com/replicatedhq/replicated/cli/print"
+	"github.com/replicatedhq/replicated/pkg/kotsclient"
 	"github.com/replicatedhq/replicated/pkg/platformclient"
 	"github.com/spf13/cobra"
 )
 
 func (r *runners) InitNetworkUpdateCommand(parent *cobra.Command) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "update",
+		Use:   "update [ID_OR_NAME]",
 		Short: "Update network settings.",
 		Long: `The 'update' command allows you to update various settings of a test network.
 
 You can either specify the network ID directly or provide the network name, and the command will resolve the corresponding network ID.`,
 		Example: `# Update a network using its ID
-replicated network update --id <network-id> [subcommand]
+replicated network update <network-id> --policy airgap
 
 # Update a network using its name
-replicated network update --name <network-name> [subcommand]`,
+replicated network update <network-name> --policy airgap
+
+# Update using --id or --name flags
+replicated network update --id <network-id> --policy airgap
+replicated network update --name <network-name> --policy airgap
+
+# Enable report collection on a network
+replicated network update <network-id> --collect-report
+
+# Disable report collection on a network
+replicated network update <network-id> --collect-report=false
+
+# Update both policy and report collection on a network
+replicated network update <network-id> --policy airgap --collect-report`,
+		RunE:              r.updateNetwork,
+		SilenceUsage:      true,
+		ValidArgsFunction: r.completeNetworkIDsAndNames,
 	}
 	parent.AddCommand(cmd)
 
@@ -27,9 +45,47 @@ replicated network update --name <network-name> [subcommand]`,
 	cmd.PersistentFlags().StringVar(&r.args.updateNetworkID, "id", "", "id of the network to update (when name is not provided)")
 	cmd.RegisterFlagCompletionFunc("id", r.completeNetworkIDs)
 
+	cmd.Flags().StringVar(&r.args.updateNetworkPolicy, "policy", "", "Update network policy setting")
+	cmd.Flags().BoolVar(&r.args.updateNetworkCollectReport, "collect-report", false, "Enable report collection on this network (use --collect-report=false to disable)")
+	cmd.Flags().StringVar(&r.outputFormat, "output", "table", "The output format to use. One of: json|table|wide")
+
 	return cmd
 }
 
+func (r *runners) updateNetwork(cmd *cobra.Command, args []string) error {
+	if err := r.ensureUpdateNetworkIDArg(args); err != nil {
+		return errors.Wrap(err, "must provide network id or name")
+	}
+
+	// Check if any update flags are provided
+	if r.args.updateNetworkPolicy == "" && !cmd.Flags().Changed("collect-report") {
+		// If no specific update flags are provided, show help
+		return cmd.Help()
+	}
+
+	// Prepare update options
+	opts := kotsclient.UpdateNetworkOpts{}
+
+	if r.args.updateNetworkPolicy != "" {
+		opts.Policy = r.args.updateNetworkPolicy
+	}
+
+	if cmd.Flags().Changed("collect-report") {
+		opts.CollectReport = r.args.updateNetworkCollectReport
+	}
+
+	// Update the network
+	network, err := r.kotsAPI.UpdateNetwork(r.args.updateNetworkID, opts)
+	if errors.Cause(err) == platformclient.ErrForbidden {
+		return ErrCompatibilityMatrixTermsNotAccepted
+	}
+	if err != nil {
+		return errors.Wrap(err, "update network")
+	}
+
+	return print.Network(r.outputFormat, r.w, network)
+}
+
 func (r *runners) ensureUpdateNetworkIDArg(args []string) error {
 	if len(args) > 0 {
 		networkID, err := r.getNetworkIDFromArg(args[0])

cli/cmd/network_update_outbound.go

@@ -287,9 +287,7 @@ func Execute(rootCmd *cobra.Command, stdin io.Reader, stdout io.Writer, stderr i
 	runCmds.InitNetworkJoin(networkCmd)
 	runCmds.InitNetworkReport(networkCmd)
 
-	networkUpdateCmd := runCmds.InitNetworkUpdateCommand(networkCmd)
-	runCmds.InitNetworkUpdateOutbound(networkUpdateCmd)
-	runCmds.InitNetworkUpdatePolicy(networkUpdateCmd)
+	runCmds.InitNetworkUpdateCommand(networkCmd)
 
 	runCmds.InitLoginCommand(runCmds.rootCmd)
 	runCmds.InitLogoutCommand(runCmds.rootCmd)

cli/cmd/network_update_policy.go

@@ -248,10 +248,10 @@ type runnerArgs struct {
 	networkReportID    string
 	networkReportWatch bool
 
-	updateNetworkOutbound string
-	updateNetworkPolicy   string
-	updateNetworkName     string
-	updateNetworkID       string
+	updateNetworkPolicy        string
+	updateNetworkCollectReport bool
+	updateNetworkName          string
+	updateNetworkID            string
 
 	removeNetworkAll    bool
 	removeNetworkNames  []string

cli/cmd/root.go

@@ -10,22 +10,32 @@ import (
 )
 
 // Table formatting
-var networksTmplTableHeaderSrc = `ID	NAME	STATUS	CREATED	EXPIRES	POLICY`
-var networksTmplTableRowSrc = `{{ range . -}}
-{{ .ID }}	{{ padding .Name 27	}}	{{ padding (printf "%s" .Status) 12 }}	{{ padding (printf "%s" (localeTime .CreatedAt)) 30 }}	{{if .ExpiresAt.IsZero}}{{ padding "-" 30 }}{{else}}{{ padding (printf "%s" (localeTime .ExpiresAt)) 30 }}{{end}}	{{if eq .Policy ""}}{{ padding "open" 30 }}{{else}}{{ padding (printf "%s" (.Policy)) 30 }}{{end}}
+var (
+	networksTmplTableHeaderSrc = `ID	NAME	STATUS	CREATED	EXPIRES	POLICY	REPORTING`
+	networksTmplTableRowSrc    = `{{ range . -}}
+{{ .ID }}	{{ padding .Name 27	}}	{{ padding (printf "%s" .Status) 12 }}	{{ padding (printf "%s" (localeTime .CreatedAt)) 30 }}	{{if .ExpiresAt.IsZero}}{{ padding "-" 30 }}{{else}}{{ padding (printf "%s" (localeTime .ExpiresAt)) 30 }}{{end}}	{{if eq .Policy ""}}{{ padding "open" 30 }}{{else}}{{ padding (printf "%s" (.Policy)) 30 }}{{end}}	{{if .CollectReport}}{{ padding "on" 30 }}{{else}}{{ padding "off" 30 }}{{end}}
 {{ end }}`
-var networksTmplTableSrc = fmt.Sprintln(networksTmplTableHeaderSrc) + networksTmplTableRowSrc
-var networksTmplTable = template.Must(template.New("networks").Funcs(funcs).Parse(networksTmplTableSrc))
-var networksTmplTableNoHeader = template.Must(template.New("networks").Funcs(funcs).Parse(networksTmplTableRowSrc))
+)
+
+var (
+	networksTmplTableSrc      = fmt.Sprintln(networksTmplTableHeaderSrc) + networksTmplTableRowSrc
+	networksTmplTable         = template.Must(template.New("networks").Funcs(funcs).Parse(networksTmplTableSrc))
+	networksTmplTableNoHeader = template.Must(template.New("networks").Funcs(funcs).Parse(networksTmplTableRowSrc))
+)
 
 // Wide table formatting
-var networksTmplWideHeaderSrc = `ID	NAME	STATUS	CREATED	EXPIRES	POLICY`
-var networksTmplWideRowSrc = `{{ range . -}}
-{{ .ID }}	{{ padding .Name 27	}}	{{ padding (printf "%s" .Status) 12 }}	{{ padding (printf "%s" (localeTime .CreatedAt)) 30 }}	{{if .ExpiresAt.IsZero}}{{ padding "-" 30 }}{{else}}{{ padding (printf "%s" (localeTime .ExpiresAt)) 30 }}{{end}}	{{if eq .Policy ""}}{{ padding "open" 30 }}{{else}}{{ padding (printf "%s" (.Policy)) 30 }}{{end}}
+var (
+	networksTmplWideHeaderSrc = `ID	NAME	STATUS	CREATED	EXPIRES	POLICY	REPORTING`
+	networksTmplWideRowSrc    = `{{ range . -}}
+{{ .ID }}	{{ padding .Name 27	}}	{{ padding (printf "%s" .Status) 12 }}	{{ padding (printf "%s" (localeTime .CreatedAt)) 30 }}	{{if .ExpiresAt.IsZero}}{{ padding "-" 30 }}{{else}}{{ padding (printf "%s" (localeTime .ExpiresAt)) 30 }}{{end}}	{{if eq .Policy ""}}{{ padding "open" 30 }}{{else}}{{ padding (printf "%s" (.Policy)) 30 }}{{end}}	{{if .CollectReport}}{{ padding "on" 30 }}{{else}}{{ padding "off" 30 }}{{end}}
 {{ end }}`
-var networksTmplWideSrc = fmt.Sprintln(networksTmplWideHeaderSrc) + networksTmplWideRowSrc
-var networksTmplWide = template.Must(template.New("networks").Funcs(funcs).Parse(networksTmplWideSrc))
-var networksTmplWideNoHeader = template.Must(template.New("networks").Funcs(funcs).Parse(networksTmplWideRowSrc))
+)
+
+var (
+	networksTmplWideSrc      = fmt.Sprintln(networksTmplWideHeaderSrc) + networksTmplWideRowSrc
+	networksTmplWide         = template.Must(template.New("networks").Funcs(funcs).Parse(networksTmplWideSrc))
+	networksTmplWideNoHeader = template.Must(template.New("networks").Funcs(funcs).Parse(networksTmplWideRowSrc))
+)
 
 func Networks(outputFormat string, w *tabwriter.Writer, networks []*types.Network, header bool) error {
 	switch outputFormat {

cli/cmd/runner.go

@@ -11,42 +11,41 @@ import (
 	"github.com/replicatedhq/replicated/pkg/types"
 )
 
-type UpdateNetworkPolicyRequest struct {
-	Policy string `json:"policy"`
+type UpdateNetworkRequest struct {
+	Policy        string `json:"policy"`
+	CollectReport bool   `json:"collect_report"`
 }
 
-type UpdateNetworkPolicyResponse struct {
+type UpdateNetworkResponse struct {
 	Network *types.Network `json:"network"`
 	Errors  []string       `json:"errors"`
 }
 
-type UpdateNetworkPolicyOpts struct {
-	Policy string `json:"policy"`
+type UpdateNetworkOpts struct {
+	Policy        string `json:"policy"`
+	CollectReport bool   `json:"collect_report"`
 }
 
-type UpdateNetworkPolicyErrorResponse struct {
+type UpdateNetworkErrorResponse struct {
 	Error struct {
 		Message string `json:"message"`
 	}
 }
 
 // UpdateNetworkPolicy updates a network's policy setting
-func (c *VendorV3Client) UpdateNetworkPolicy(networkID string, opts UpdateNetworkPolicyOpts) (*types.Network, error) {
-	req := UpdateNetworkPolicyRequest{
-		Policy: opts.Policy,
-	}
-
-	return c.doUpdateNetworkPolicyRequest(networkID, req)
+func (c *VendorV3Client) UpdateNetwork(networkID string, opts UpdateNetworkOpts) (*types.Network, error) {
+	req := UpdateNetworkRequest(opts)
+	return c.doUpdateNetworkRequest(networkID, req)
 }
 
-func (c *VendorV3Client) doUpdateNetworkPolicyRequest(networkID string, req UpdateNetworkPolicyRequest) (*types.Network, error) {
-	resp := UpdateNetworkPolicyResponse{}
-	endpoint := fmt.Sprintf("/v3/network/%s/policy", networkID)
+func (c *VendorV3Client) doUpdateNetworkRequest(networkID string, req UpdateNetworkRequest) (*types.Network, error) {
+	resp := UpdateNetworkResponse{}
+	endpoint := fmt.Sprintf("/v3/network/%s/update", networkID)
 	err := c.DoJSON(context.TODO(), "PUT", endpoint, http.StatusOK, req, &resp)
 	if err != nil {
 		if apiErr, ok := errors.Cause(err).(platformclient.APIError); ok {
 			if apiErr.StatusCode == http.StatusBadRequest {
-				errResp := &UpdateNetworkPolicyErrorResponse{}
+				errResp := &UpdateNetworkErrorResponse{}
 				if jsonErr := json.Unmarshal(apiErr.Body, errResp); jsonErr != nil {
 					return nil, fmt.Errorf("unmarshal error response: %w", err)
 				}

cli/print/networks.go

@@ -17,8 +17,8 @@ type Network struct {
 	OverlayEndpoint string `json:"overlay_endpoint,omitempty"`
 	OverlayToken    string `json:"overlay_token,omitempty"`
 
-	Outbound string `json:"outbound,omitempty"`
-	Policy   string `json:"policy,omitempty"`
+	Policy        string `json:"policy,omitempty"`
+	CollectReport bool   `json:"collect_report,omitempty"`
 }
 
 type NetworkStatus string