feat: VRF support

cmd/cli.go

@@ -27,6 +27,7 @@
 	"github.com/equinix/metal-cli/internal/twofa"
 	"github.com/equinix/metal-cli/internal/users"
 	"github.com/equinix/metal-cli/internal/vlan"
+	"github.com/equinix/metal-cli/internal/vrf"
 )
 
 // Cli struct
@@ -93,5 +94,6 @@
 		twofa.NewClient(client, cli.Outputer).NewCommand(),
 		gateway.NewClient(client, cli.Outputer).NewCommand(),
 		ports.NewClient(client, cli.Outputer).NewCommand(),
+		vrf.NewClient(client, cli.Outputer).NewCommand(),
 	)
 }

go.sum

@@ -257,6 +257,8 @@ golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.4.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.4.1/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
+golang.org/x/mod v0.12.0 h1:rmsUpXtvNzj340zd98LZ4KntptpfRHwpFOHG188oHXc=
+golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
 golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20190108225652-1e06a53dbb7e/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
@@ -410,6 +412,8 @@ golang.org/x/tools v0.0.0-20201208233053-a543418bbed2/go.mod h1:emZCQorbCU4vsT4f
 golang.org/x/tools v0.0.0-20210105154028-b0ab187a4818/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
 golang.org/x/tools v0.0.0-20210108195828-e2f9c7f1fc8e/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
 golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0=
+golang.org/x/tools v0.13.0 h1:Iey4qkscZuv0VvIt8E0neZjtPVQFSc870HQ448QgEmQ=
+golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

internal/vrf/create.go

@@ -0,0 +1,83 @@
+package vrf
+
+import (
+	"context"
+	"fmt"
+	"strconv"
+	"strings"
+
+	metal "github.com/equinix-labs/metal-go/metal/v1"
+	"github.com/spf13/cobra"
+)
+
+func (c *Client) Create() *cobra.Command {
+	var (
+		projectID   string
+		metro       string
+		name        string
+		description string
+		ipRanges    []string
+		localASN    int32
+		tags        []string
+	)
+
+	// createVRFCmd represents the creatVRF command
+	createVRFCmd := &cobra.Command{
+		Use:     `create vrf <my_vrf> [-m <metro_code>] [-AS int] [-I str] [-d <description>]`,
+		Short:   "Creates a virtual network.",
+		Long:    "Creates a VRF",
+		Example: `# Creates a VRF, metal vrf create `,
+
+		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
+
+			req := metal.VrfCreateInput{
+				Metro:       metro,
+				Name:        name,
+				IpRanges:    ipRanges,
+				LocalAsn:    &localASN,
+				Tags:        tags,
+				Description: &description,
+			}
+			// Retreived these params from packetngo based on the VRF function there, assuming vrfs need these to work
+			// From Packetngo >>>>
+			// IPRanges is a list of all IPv4 and IPv6 Ranges that will be available to
+			// BGP Peers. IPv4 addresses must be /8 or smaller with a minimum size of
+			// /29. IPv6 must be /56 or smaller with a minimum size of /64. Ranges must
+			// not overlap other ranges within the VRF.
+			// >>>>>>>>>>>>>>>>>>>
+			// Not quite sure if a CIDR can be specified here using a "/" or how it works exactly in tandem with VRFs
+			// may also need some logic for processing errors on local asn, also not sure about this
+			request := c.Service.CreateVrf(context.Background(), projectID).VrfCreateInput(req).Exclude(nil).Include(nil)
+			n, _, err := request.Execute()
+			if err != nil {
+				return fmt.Errorf("Could not create VRF: %w", err)
+			}
+
+			data := make([][]string, 1)
+
+			// This output block below is probably incorrect but leaving it for now for testing later.
+			data[0] = []string{n.GetName(), *n.GetMetro().Code, n.GetDescription(), strconv.Itoa(int(n.GetLocalAsn())), strings.Join(n.GetIpRanges(), ","), n.GetCreatedAt().String()}
+			header := []string{"Name", "Metro", "Description", "LocalASN", "IPrange", "Created"}
+
+			return c.Out.Output(n, header, &data)
+		},
+	}
+
+	createVRFCmd.Flags().StringVarP(&projectID, "project-id", "p", "", "The project's UUID. This flag is required, unless specified in the config created by metal init or set as METAL_PROJECT_ID environment variable.")
+	createVRFCmd.Flags().StringSliceVarP(&tags, "tags", "t", []string{}, `Tag or list of tags for the VRF: --tags="tag1,tag2".`)
+	createVRFCmd.Flags().StringVarP(&name, "name", "n", "", "Name of the VRF")
+	createVRFCmd.Flags().StringVarP(&description, "description", "d", "", "Description of the VRF.")
+
+	createVRFCmd.Flags().StringVarP(&metro, "metro", "m", "", "Code of the metro where the VRF will be created")
+	createVRFCmd.Flags().Int32VarP(&localASN, "local-asn", "a", 0, "Local ASN for the VRF")
+	createVRFCmd.Flags().StringSliceVarP(&ipRanges, "ip-ranges", "r", []string{}, "IP range or list of IP ranges for the VRF")
+
+	// making them all required here
+	_ = createVRFCmd.MarkFlagRequired("name")
+	_ = createVRFCmd.MarkFlagRequired("metro")
+	_ = createVRFCmd.MarkFlagRequired("local-asn")
+	_ = createVRFCmd.MarkFlagRequired("IPrange")
+
+	return createVRFCmd
+}

internal/vrf/delete.go

@@ -0,0 +1,63 @@
+package main // or your appropriate package name
+
+import (
+	"fmt"
+
+	"github.com/manifoldco/promptui"
+	"github.com/spf13/cobra"
+)
+
+func (c *Client) Delete() *cobra.Command {
+	var (
+		vrfID string
+		force  bool
+	)
+
+	deleteVrf := func(id string) error {
+		_, err := c.Service.Delete(id)
+		if err != nil {
+			return err
+		}
+		fmt.Println("VRF", id, "successfully deleted.")
+		return nil // No need to return 'err' here; it's always nil.
+	}
+
+	deleteMetalVrfCmd := &cobra.Command{
+		Use:   "delete vrf -i <metal_vrf_UUID> [-f]",
+		Short: "Deletes a VRF.",
+		Long:  "Deletes the specified VRF with a confirmation prompt. To skip the confirmation, use --force.",
+		Example: `# Deletes a VRF, with confirmation.
+  metal delete vrf -i 77e6d57a-d7a4-4816-b451-cf9b043444e2
+
+  # Deletes a VRF, skipping confirmation.
+  metal delete vrf -f -i 77e6d57a-d7a4-4816-b451-cf9b043444e2`,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
+
+			if !force {
+				prompt := promptui.Prompt{
+					Label:     fmt.Sprintf("Are you sure you want to delete VRF %s: ", vrfID),
+					IsConfirm: true,
+				}
+
+				result, err := prompt.Run()
+				if err != nil || result != "y" {
+					fmt.Println("VRF deletion aborted.")
+					return nil
+				}
+			}
+
+			if err := deleteVrf(vrfID); err != nil {
+				return fmt.Errorf("Could not delete VRF: %w", err)
+			}
+
+			return nil
+		},
+	}
+
+	deleteMetalVrfCmd.Flags().StringVarP(&vrfID, "id", "i", "", "UUID of the VRF.")
+	_ = deleteMetalVrfCmd.MarkFlagRequired("id")
+	deleteMetalVrfCmd.Flags().BoolVarP(&force, "force", "f", false, "Skips confirmation for the removal of the VRF.")
+
+	return deleteMetalVrfCmd
+}

internal/vrf/list.go

@@ -0,0 +1,52 @@
+package vrf
+
+import (
+	metal "github.com/equinix-labs/metal-go/metal/v1"
+	"github.com/equinix/metal-cli/internal/outputs"
+	"github.com/spf13/cobra"
+	"fmt"
+)
+
+type Client struct {
+	Servicer Servicer
+	Service  metal.VRFsApiService
+	Out      outputs.Outputer
+}
+
+
+func (c *Client) Retrieve() *cobra.Command {
+	var projectID string
+
+	// retrieveVrfsCmd represents the retrieveMetalGateways command
+	retrieveVrfsCmd := &cobra.Command{
+		Use:     `get -p <project_UUID>`,
+		Aliases: []string{"list"},
+		Short:   "Lists VRFs.",
+		Long:    "Retrieves a list of all VRFs for the specified project.",
+		Example: `
+  # Lists VRFs for project 3b0795ba-ec9a-4a9e-83a7-043e7e11407c:
+  metal vrf list -p 3b0795ba-ec9a-4a9e-83a7-043e7e11407c`,
+
+  RunE: func(cmd *cobra.Command, args []string) error {
+	cmd.SilenceUsage = true
+	vrfs, _, err := c.Service.Get(ProjectID, c.Servicer.GetOptions(nil, nil))  // <- Not sure about the correct service to call Im assuming its this? https://github.com/packethost/packngo/blob/master/vrf.go
+	if err != nil {																
+		return fmt.Errorf("Could not list VRFs: %w", err)
+	}
+
+	data := make([][]string, len(vrfs.VirtualRoutingFunctions))
+
+		for i, n := range vnets.VirtualRoutingFunctions {
+			data[i] = []string{n.ID, n.Description, n.IPranges, n.LocalASN n.Metro, n.CreatedAt}  //Data should contain all info about VRF not sure where the formatting comes from, going with this.
+		}
+		header := []string{"ID", "Description", "VXLAN", "Facility", "Created"}
+
+		return c.Out.Output(vrfs, header, &data)
+	},
+} 	
+retrieveVrfsCmd.Flags().StringVarP(&projectID, "project-id", "p", "", "The project's UUID. This flag is required, unless specified in the config created by metal init or set as METAL_PROJECT_ID environment variable.")
+_ = retrieveVrfsCmd.MarkFlagRequired("project-id")
+
+return retrieveVrfsCmd
+}
+

internal/vrf/vrf.go

@@ -0,0 +1,47 @@
+package vrf
+
+import (
+	metal "github.com/equinix-labs/metal-go/metal/v1"
+	"github.com/equinix/metal-cli/internal/outputs"
+	"github.com/spf13/cobra"
+)
+
+type Client struct {
+	Servicer Servicer
+	Service  metal.VRFsApiService
+	Out      outputs.Outputer
+}
+
+func (c *Client) NewCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     `vrf`,
+		Aliases: []string{"vrf"},
+		Short:   "VRF operations : create, TODO: make other commands.",
+		Long:    "Experimental VRF function",
+
+		PersistentPreRun: func(cmd *cobra.Command, args []string) {
+			if root := cmd.Root(); root != nil {
+				if root.PersistentPreRun != nil {
+					root.PersistentPreRun(cmd, args)
+				}
+			}
+			c.Service = *c.Servicer.MetalAPI(cmd).VRFsApi
+		},
+	}
+
+	cmd.AddCommand(
+		c.Create(),
+	)
+	return cmd
+}
+
+type Servicer interface {
+	MetalAPI(*cobra.Command) *metal.APIClient
+}
+
+func NewClient(s Servicer, out outputs.Outputer) *Client {
+	return &Client{
+		Servicer: s,
+		Out:      out,
+	}
+}