github.com/fastly/cli@v1.7.2-0.20240304164155-9d0f1d77c3bf/pkg/commands/vcl/custom/describe.go (about)

     1  package custom
     2  
     3  import (
     4  	"fmt"
     5  	"io"
     6  
     7  	"github.com/fastly/go-fastly/v9/fastly"
     8  
     9  	"github.com/fastly/cli/pkg/argparser"
    10  	fsterr "github.com/fastly/cli/pkg/errors"
    11  	"github.com/fastly/cli/pkg/global"
    12  )
    13  
    14  // NewDescribeCommand returns a usable command registered under the parent.
    15  func NewDescribeCommand(parent argparser.Registerer, g *global.Data) *DescribeCommand {
    16  	c := DescribeCommand{
    17  		Base: argparser.Base{
    18  			Globals: g,
    19  		},
    20  	}
    21  	c.CmdClause = parent.Command("describe", "Get the uploaded VCL for a particular service and version").Alias("get")
    22  
    23  	// Required.
    24  	c.CmdClause.Flag("name", "The name of the VCL").Required().StringVar(&c.name)
    25  	c.RegisterFlag(argparser.StringFlagOpts{
    26  		Name:        argparser.FlagVersionName,
    27  		Description: argparser.FlagVersionDesc,
    28  		Dst:         &c.serviceVersion.Value,
    29  		Required:    true,
    30  	})
    31  
    32  	// Optional.
    33  	c.RegisterFlagBool(c.JSONFlag()) // --json
    34  	c.RegisterFlag(argparser.StringFlagOpts{
    35  		Name:        argparser.FlagServiceIDName,
    36  		Description: argparser.FlagServiceIDDesc,
    37  		Dst:         &g.Manifest.Flag.ServiceID,
    38  		Short:       's',
    39  	})
    40  	c.RegisterFlag(argparser.StringFlagOpts{
    41  		Action:      c.serviceName.Set,
    42  		Name:        argparser.FlagServiceName,
    43  		Description: argparser.FlagServiceDesc,
    44  		Dst:         &c.serviceName.Value,
    45  	})
    46  
    47  	return &c
    48  }
    49  
    50  // DescribeCommand calls the Fastly API to describe an appropriate resource.
    51  type DescribeCommand struct {
    52  	argparser.Base
    53  	argparser.JSONOutput
    54  
    55  	name           string
    56  	serviceName    argparser.OptionalServiceNameID
    57  	serviceVersion argparser.OptionalServiceVersion
    58  }
    59  
    60  // Exec invokes the application logic for the command.
    61  func (c *DescribeCommand) Exec(_ io.Reader, out io.Writer) error {
    62  	if c.Globals.Verbose() && c.JSONOutput.Enabled {
    63  		return fsterr.ErrInvalidVerboseJSONCombo
    64  	}
    65  
    66  	serviceID, serviceVersion, err := argparser.ServiceDetails(argparser.ServiceDetailsOpts{
    67  		AllowActiveLocked:  true,
    68  		APIClient:          c.Globals.APIClient,
    69  		Manifest:           *c.Globals.Manifest,
    70  		Out:                out,
    71  		ServiceNameFlag:    c.serviceName,
    72  		ServiceVersionFlag: c.serviceVersion,
    73  		VerboseMode:        c.Globals.Flags.Verbose,
    74  	})
    75  	if err != nil {
    76  		c.Globals.ErrLog.AddWithContext(err, map[string]any{
    77  			"Service ID":      serviceID,
    78  			"Service Version": fsterr.ServiceVersion(serviceVersion),
    79  		})
    80  		return err
    81  	}
    82  
    83  	input := c.constructInput(serviceID, fastly.ToValue(serviceVersion.Number))
    84  
    85  	o, err := c.Globals.APIClient.GetVCL(input)
    86  	if err != nil {
    87  		c.Globals.ErrLog.AddWithContext(err, map[string]any{
    88  			"Service ID":      serviceID,
    89  			"Service Version": fastly.ToValue(serviceVersion.Number),
    90  		})
    91  		return err
    92  	}
    93  
    94  	if ok, err := c.WriteJSON(out, o); ok {
    95  		return err
    96  	}
    97  
    98  	return c.print(out, o)
    99  }
   100  
   101  // constructInput transforms values parsed from CLI flags into an object to be used by the API client library.
   102  func (c *DescribeCommand) constructInput(serviceID string, serviceVersion int) *fastly.GetVCLInput {
   103  	var input fastly.GetVCLInput
   104  
   105  	input.Name = c.name
   106  	input.ServiceID = serviceID
   107  	input.ServiceVersion = serviceVersion
   108  
   109  	return &input
   110  }
   111  
   112  // print displays the information returned from the API.
   113  func (c *DescribeCommand) print(out io.Writer, v *fastly.VCL) error {
   114  	if !c.Globals.Verbose() {
   115  		fmt.Fprintf(out, "\nService ID: %s\n", fastly.ToValue(v.ServiceID))
   116  	}
   117  	fmt.Fprintf(out, "Service Version: %d\n\n", fastly.ToValue(v.ServiceVersion))
   118  	fmt.Fprintf(out, "Name: %s\n", fastly.ToValue(v.Name))
   119  	fmt.Fprintf(out, "Main: %t\n", fastly.ToValue(v.Main))
   120  	fmt.Fprintf(out, "Content: \n%s\n\n", fastly.ToValue(v.Content))
   121  	if v.CreatedAt != nil {
   122  		fmt.Fprintf(out, "Created at: %s\n", v.CreatedAt)
   123  	}
   124  	if v.UpdatedAt != nil {
   125  		fmt.Fprintf(out, "Updated at: %s\n", v.UpdatedAt)
   126  	}
   127  	if v.DeletedAt != nil {
   128  		fmt.Fprintf(out, "Deleted at: %s\n", v.DeletedAt)
   129  	}
   130  	return nil
   131  }