Rework the printer output code (#355)

* Rework printer logic for effeciency and consistency * Amend some golangci-lint rules * Resolve more linting/formatting errors on printer
vultr · Oct 18, 2023 · c0eb9ba · c0eb9ba
1 parent 20f4990
commit c0eb9ba
Show file tree

Hide file tree

Showing 31 changed files with 1,282 additions and 434 deletions.
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -119,17 +119,11 @@ issues:
   # Default: https://golangci-lint.run/usage/false-positives/#default-exclusions
   exclude:
     - abcdef
+    - ST1023
   exclude-rules:
     # Exclude some linters from running on tests files.
     - path: cmd/printer/
       linters:
-        - funlen
-        - gocyclo
         - dupl
-        - lll
-        - gomnd
-        - gocritic
-        - stylecheck
-
 run:
   timeout: 5m
diff --git a/cmd/dnsRecord.go b/cmd/dnsRecord.go
@@ -115,7 +115,7 @@ var recordCreate = &cobra.Command{
 			os.Exit(1)
 		}
 
-		printer.DnsRecord(record)
+		printer.DNSRecord(record)
 	},
 }
 
@@ -139,7 +139,7 @@ var recordGet = &cobra.Command{
 			os.Exit(1)
 		}
 
-		printer.DnsRecord(record)
+		printer.DNSRecord(record)
 	},
 }
 
@@ -163,7 +163,7 @@ var recordList = &cobra.Command{
 			os.Exit(1)
 		}
 
-		printer.DnsRecordsList(records, meta)
+		printer.DNSRecordsList(records, meta)
 	},
 }
 

diff --git a/cmd/printer/account.go b/cmd/printer/account.go
@@ -5,8 +5,15 @@ import (
 )
 
 func Account(account *govultr.Account) {
-	col := columns{"BALANCE", "PENDING CHARGES", "LAST PAYMENT DATE", "LAST PAYMENT AMOUNT", "NAME", "EMAIL", "ACLS"}
-	display(col)
-	display(columns{account.Balance, account.PendingCharges, account.LastPaymentDate, account.LastPaymentAmount, account.Name, account.Email, account.ACL})
-	flush()
+	defer flush()
+	display(columns{"BALANCE", "PENDING CHARGES", "LAST PAYMENT DATE", "LAST PAYMENT AMOUNT", "NAME", "EMAIL", "ACLS"})
+	display(columns{
+		account.Balance,
+		account.PendingCharges,
+		account.LastPaymentDate,
+		account.LastPaymentAmount,
+		account.Name,
+		account.Email,
+		account.ACL,
+	})
 }
diff --git a/cmd/printer/application.go b/cmd/printer/application.go
@@ -5,12 +5,27 @@ import (
 )
 
 func Application(apps []govultr.Application, meta *govultr.Meta) {
-	col := columns{"ID", "NAME", "SHORT NAME", "DEPLOY NAME", "TYPE", "VENDOR", "IMAGE ID"}
-	display(col)
-	for _, a := range apps {
-		display(columns{a.ID, a.Name, a.ShortName, a.DeployName, a.Type, a.Vendor, a.ImageID})
+	defer flush()
+
+	display(columns{"ID", "NAME", "SHORT NAME", "DEPLOY NAME", "TYPE", "VENDOR", "IMAGE ID"})
+
+	if len(apps) == 0 {
+		display(columns{"---", "---", "---", "---", "---", "---", "---"})
+		Meta(meta)
+		return
+	}
+
+	for i := range apps {
+		display(columns{
+			apps[i].ID,
+			apps[i].Name,
+			apps[i].ShortName,
+			apps[i].DeployName,
+			apps[i].Type,
+			apps[i].Vendor,
+			apps[i].ImageID,
+		})
 	}
 
 	Meta(meta)
-	flush()
 }
diff --git a/cmd/printer/backup.go b/cmd/printer/backup.go
@@ -5,19 +5,32 @@ import (
 )
 
 func Backups(bs []govultr.Backup, meta *govultr.Meta) {
-	col := columns{"ID", "DATE CREATED", "DESCRIPTION", "SIZE", "STATUS"}
-	display(col)
-	for _, b := range bs {
-		display(columns{b.ID, b.DateCreated, b.Description, b.Size, b.Status})
+	defer flush()
+
+	display(columns{"ID", "DATE CREATED", "DESCRIPTION", "SIZE", "STATUS"})
+
+	if len(bs) == 0 {
+		display(columns{"---", "---", "---", "---", "---"})
+		Meta(meta)
+		return
+	}
+
+	for i := range bs {
+		display(columns{
+			bs[i].ID,
+			bs[i].DateCreated,
+			bs[i].Description,
+			bs[i].Size,
+			bs[i].Status,
+		})
 	}
 
 	Meta(meta)
-	flush()
 }
 
 func Backup(bs *govultr.Backup) {
-	col := columns{"ID", "DATE CREATED", "DESCRIPTION", "SIZE", "STATUS"}
-	display(col)
+	defer flush()
 
-	flush()
+	display(columns{"ID", "DATE CREATED", "DESCRIPTION", "SIZE", "STATUS"})
+	display(columns{bs.ID, bs.DateCreated, bs.Description, bs.Size, bs.Status})
 }
diff --git a/cmd/printer/bareMetal.go b/cmd/printer/bareMetal.go
@@ -5,65 +5,130 @@ import (
 )
 
 func BareMetal(b *govultr.BareMetalServer) {
-	col := columns{"ID", "IP", "TAG", "MAC ADDRESS", "LABEL", "OS", "STATUS", "REGION", "CPU", "RAM", "DISK", "FEATURES", "TAGS"}
-	display(col)
+	defer flush()
 
+	display(columns{"ID", "IP", "TAG", "MAC ADDRESS", "LABEL", "OS", "STATUS", "REGION", "CPU", "RAM", "DISK", "FEATURES", "TAGS"})
 	display(columns{b.ID, b.MainIP, b.Tag, b.MacAddress, b.Label, b.Os, b.Status, b.Region, b.CPUCount, b.RAM, b.Disk, b.Features, b.Tags}) //nolint:all
-
-	flush()
 }
 
 func BareMetalList(bms []govultr.BareMetalServer, meta *govultr.Meta) {
-	col := columns{"ID", "IP", "TAG", "MAC ADDRESS", "LABEL", "OS", "STATUS", "REGION", "CPU", "RAM", "DISK", "FEATURES", "TAGS"}
-	display(col)
-	for _, b := range bms {
-		display(columns{b.ID, b.MainIP, b.Tag, b.MacAddress, b.Label, b.Os, b.Status, b.Region, b.CPUCount, b.RAM, b.Disk, b.Features, b.Tags}) //nolint:all
+	defer flush()
+
+	display(columns{"ID", "IP", "TAG", "MAC ADDRESS", "LABEL", "OS", "STATUS", "REGION", "CPU", "RAM", "DISK", "FEATURES", "TAGS"})
+
+	if len(bms) == 0 {
+		display(columns{"---", "---", "---", "---", "---", "---", "---", "---", "---", "---", "---", "---", "---"})
+		Meta(meta)
+		return
 	}
 
-	Meta(meta)
+	for i := range bms {
+		display(columns{
+			bms[i].ID,
+			bms[i].MainIP,
+			bms[i].MacAddress,
+			bms[i].Label,
+			bms[i].Os,
+			bms[i].Status,
+			bms[i].Region,
+			bms[i].CPUCount,
+			bms[i].RAM,
+			bms[i].Disk,
+			bms[i].Features,
+			bms[i].Tags,
+		})
+	}
 
-	flush()
+	Meta(meta)
 }
 
 func BareMetalBandwidth(bw *govultr.Bandwidth) {
+	defer flush()
+
 	display(columns{"DATE", "INCOMING BYTES", "OUTGOING BYTES"})
-	for k, b := range bw.Bandwidth {
-		display(columns{k, b.IncomingBytes, b.OutgoingBytes})
+	if len(bw.Bandwidth) == 0 {
+		display(columns{"---", "---", "---"})
+		return
+	}
+
+	for i := range bw.Bandwidth {
+		display(columns{
+			i,
+			bw.Bandwidth[i].IncomingBytes,
+			bw.Bandwidth[i].OutgoingBytes,
+		})
 	}
-	flush()
 }
 
 func BareMetalIPV4Info(info []govultr.IPv4, meta *govultr.Meta) {
+	defer flush()
+
 	display(columns{"IP", "NETMASK", "GATEWAY", "TYPE"})
-	for _, i := range info {
-		display(columns{i.IP, i.Netmask, i.Gateway, i.Type})
+
+	if len(info) == 0 {
+		display(columns{"---", "---", "---", "---"})
+		Meta(meta)
+		return
+	}
+
+	for i := range info {
+		display(columns{
+			info[i].IP,
+			info[i].Netmask,
+			info[i].Gateway,
+			info[i].Type,
+		})
 	}
 
 	Meta(meta)
-	flush()
 }
 
 func BareMetalIPV6Info(info []govultr.IPv6, meta *govultr.Meta) {
+	defer flush()
+
 	display(columns{"IP", "NETWORK", "NETWORK SIZE", "TYPE"})
-	for _, i := range info {
-		display(columns{i.IP, i.Network, i.NetworkSize, i.Type})
+
+	if len(info) == 0 {
+		display(columns{"---", "---", "---", "---"})
+		Meta(meta)
+		return
+	}
+
+	for i := range info {
+		display(columns{
+			info[i].IP,
+			info[i].Network,
+			info[i].NetworkSize,
+			info[i].Type,
+		})
 	}
 
 	Meta(meta)
-	flush()
 }
 
 func BareMetalVNCUrl(vnc *govultr.VNCUrl) {
+	defer flush()
+
 	display(columns{"VNC URL"})
 	display(columns{vnc.URL})
-	flush()
 }
 
 // BareMetalVPC2List Generate a printer display of all VPC 2.0 networks attached to a given server
 func BareMetalVPC2List(vpc2s []govultr.VPC2Info) {
+	defer flush()
+
 	display(columns{"ID", "MAC ADDRESS", "IP ADDRESS"})
-	for _, r := range vpc2s {
-		display(columns{r.ID, r.MacAddress, r.IPAddress})
+
+	if len(vpc2s) == 0 {
+		display(columns{"---", "---", "---"})
+		return
+	}
+
+	for i := range vpc2s {
+		display(columns{
+			vpc2s[i].ID,
+			vpc2s[i].MacAddress,
+			vpc2s[i].IPAddress,
+		})
 	}
-	flush()
 }
diff --git a/cmd/printer/billing.go b/cmd/printer/billing.go
@@ -5,41 +5,84 @@ import (
 )
 
 func BillingHistory(bh []govultr.History, meta *govultr.Meta) {
-	col := columns{"ID", "DATE", "TYPE", "DESCRIPTION", "AMOUNT", "BALANCE"}
-	display(col)
-	for _, b := range bh {
-		display(columns{b.ID, b.Date, b.Type, b.Description, b.Amount, b.Balance})
+	defer flush()
+
+	display(columns{"ID", "DATE", "TYPE", "DESCRIPTION", "AMOUNT", "BALANCE"})
+
+	if len(bh) == 0 {
+		display(columns{"---", "---", "---", "---", "---", "---"})
+		Meta(meta)
+		return
+	}
+
+	for i := range bh {
+		display(columns{
+			bh[i].ID,
+			bh[i].Date,
+			bh[i].Type,
+			bh[i].Description,
+			bh[i].Amount,
+			bh[i].Balance,
+		})
 	}
 
 	Meta(meta)
-	flush()
 }
 
 func Invoices(inv []govultr.Invoice, meta *govultr.Meta) {
-	col := columns{"ID", "DATE", "DESCRIPTION", "AMOUNT", "BALANCE"}
-	display(col)
-	for _, i := range inv {
-		display(columns{i.ID, i.Date, i.Description, i.Amount, i.Balance})
+	defer flush()
+
+	display(columns{"ID", "DATE", "DESCRIPTION", "AMOUNT", "BALANCE"})
+
+	if len(inv) == 0 {
+		display(columns{"---", "---", "---", "---", "---"})
+		Meta(meta)
+		return
+	}
+
+	for i := range inv {
+		display(columns{
+			inv[i].ID,
+			inv[i].Date,
+			inv[i].Description,
+			inv[i].Amount,
+			inv[i].Balance,
+		})
 	}
 
 	Meta(meta)
-	flush()
 }
 
 func Invoice(i *govultr.Invoice) {
+	defer flush()
+
 	display(columns{"ID", "DATE", "DESCRIPTION", "AMOUNT", "BALANCE"})
 	display(columns{i.ID, i.Date, i.Description, i.Amount, i.Balance})
-
-	flush()
 }
 
 func InvoiceItems(inv []govultr.InvoiceItem, meta *govultr.Meta) {
-	col := columns{"DESCRIPTION", "PRODUCT", "START DATE", "END DATE", "UNITS", "UNIT TYPE", "UNIT PRICE", "TOTAL"}
-	display(col)
-	for _, i := range inv {
-		display(columns{i.Description, i.Product, i.StartDate, i.EndDate, i.Units, i.UnitType, i.UnitPrice, i.Total})
+	defer flush()
+
+	display(columns{"DESCRIPTION", "PRODUCT", "START DATE", "END DATE", "UNITS", "UNIT TYPE", "UNIT PRICE", "TOTAL"})
+
+	if len(inv) == 0 {
+		display(columns{"---", "---", "---", "---", "---", "---", "---", "---"})
+		Meta(meta)
+		return
+	}
+
+	for i := range inv {
+		display(columns{
+			inv[i].Description,
+			inv[i].Product,
+			inv[i].StartDate,
+			inv[i].EndDate,
+			inv[i].Units,
+			inv[i].UnitType,
+			inv[i].UnitPrice,
+			inv[i].Total,
+		})
 	}
 
 	Meta(meta)
-	flush()
 }