Merge pull request #696 from Edson-Rios/issue694

New command `ibmcloud sl order cancelation`

Author: allmightyspiff

plugin/commands/order/cancelation.go

@@ -0,0 +1,72 @@
+package order
+
+import (
+	"github.com/IBM-Cloud/ibm-cloud-cli-sdk/bluemix/terminal"
+	"github.com/softlayer/softlayer-go/datatypes"
+	"github.com/spf13/cobra"
+	"github.ibm.com/SoftLayer/softlayer-cli/plugin/errors"
+	. "github.ibm.com/SoftLayer/softlayer-cli/plugin/i18n"
+	"github.ibm.com/SoftLayer/softlayer-cli/plugin/managers"
+	"github.ibm.com/SoftLayer/softlayer-cli/plugin/metadata"
+	"github.ibm.com/SoftLayer/softlayer-cli/plugin/utils"
+)
+
+type CancelationCommand struct {
+	*metadata.SoftlayerCommand
+	OrderManager managers.OrderManager
+	Command      *cobra.Command
+}
+
+func NewCancelationCommand(sl *metadata.SoftlayerCommand) (cmd *CancelationCommand) {
+	thisCmd := &CancelationCommand{
+		SoftlayerCommand: sl,
+		OrderManager:     managers.NewOrderManager(sl.Session),
+	}
+
+	cobraCmd := &cobra.Command{
+		Use:   "cancelation",
+		Short: T("List cancelations."),
+		Args:  metadata.NoArgs,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return thisCmd.Run(args)
+		},
+	}
+
+	thisCmd.Command = cobraCmd
+	return thisCmd
+}
+
+func (cmd *CancelationCommand) Run(args []string) error {
+	outputFormat := cmd.GetOutputFlag()
+
+	mask := ""
+	items, err := cmd.OrderManager.GetAllCancelation(mask)
+	if err != nil {
+		return errors.NewAPIError(T("Failed to list all item cancelations."), err.Error(), 2)
+	}
+
+	PrintItemsCancelation(items, cmd.UI, outputFormat)
+	return nil
+}
+
+func PrintItemsCancelation(items []datatypes.Billing_Item_Cancellation_Request, ui terminal.UI, outputFormat string) {
+	table := ui.Table([]string{
+		T("Case Number"),
+		T("Number Of Items Cancelled"),
+		T("Created"),
+		T("Status"),
+		T("Requested by"),
+	})
+
+	for _, item := range items {
+		requestedBy := utils.FormatStringPointer(item.User.FirstName) + " " + utils.FormatStringPointer(item.User.LastName)
+		table.Add(
+			utils.FormatIntPointer(item.TicketId),
+			utils.FormatUIntPointer(item.ItemCount),
+			utils.FormatSLTimePointer(item.CreateDate),
+			utils.FormatStringPointer(item.Status.Name),
+			requestedBy,
+		)
+	}
+	utils.PrintTable(ui, table, outputFormat)
+}

plugin/commands/order/cancelation_test.go

@@ -0,0 +1,68 @@
+package order_test
+
+import (
+	"github.com/IBM-Cloud/ibm-cloud-cli-sdk/testhelpers/terminal"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+
+	"github.com/softlayer/softlayer-go/session"
+
+	"github.ibm.com/SoftLayer/softlayer-cli/plugin/commands/order"
+	"github.ibm.com/SoftLayer/softlayer-cli/plugin/metadata"
+	"github.ibm.com/SoftLayer/softlayer-cli/plugin/testhelpers"
+)
+
+var _ = Describe("order cancelation", func() {
+	var (
+		fakeUI      *terminal.FakeUI
+		cliCommand  *order.CancelationCommand
+		fakeSession *session.Session
+		slCommand   *metadata.SoftlayerCommand
+	)
+	BeforeEach(func() {
+		fakeUI = terminal.NewFakeUI()
+		fakeSession = testhelpers.NewFakeSoftlayerSession([]string{})
+		slCommand = metadata.NewSoftlayerCommand(fakeUI, fakeSession)
+		cliCommand = order.NewCancelationCommand(slCommand)
+		cliCommand.Command.PersistentFlags().Var(cliCommand.OutputFlag, "output", "--output=JSON for json output.")
+	})
+
+	Describe("order cancelation", func() {
+		Context("Return error", func() {
+			It("Set invalid output", func() {
+				err := testhelpers.RunCobraCommand(cliCommand.Command, "--output=xml")
+				Expect(err).To(HaveOccurred())
+				Expect(err.Error()).To(ContainSubstring("Incorrect Usage: Invalid output format, only JSON is supported now."))
+			})
+		})
+
+		Context("Return no error", func() {
+			It("List order cancelations", func() {
+				err := testhelpers.RunCobraCommand(cliCommand.Command)
+				Expect(err).NotTo(HaveOccurred())
+				Expect(fakeUI.Outputs()).To(ContainSubstring("Case Number"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("153572280"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("Number"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("1"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("Status"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("Approved"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("Requested by"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("UserTest UserLastName"))
+			})
+
+			It("List order cancelations in json format", func() {
+				err := testhelpers.RunCobraCommand(cliCommand.Command, "--output=json")
+				Expect(err).NotTo(HaveOccurred())
+				Expect(fakeUI.Outputs()).To(ContainSubstring(`"Case Number": "153572280",`))
+				Expect(fakeUI.Outputs()).To(ContainSubstring(`"Number Of Items Cancelled": "1",`))
+				Expect(fakeUI.Outputs()).To(ContainSubstring(`"Status": "Approved",`))
+				Expect(fakeUI.Outputs()).To(ContainSubstring(`"Requested by": "UserTest UserLastName"`))
+				Expect(fakeUI.Outputs()).To(ContainSubstring(`[`))
+				Expect(fakeUI.Outputs()).To(ContainSubstring(`{`))
+				Expect(fakeUI.Outputs()).To(ContainSubstring(`}`))
+				Expect(fakeUI.Outputs()).To(ContainSubstring(`]`))
+			})
+		})
+
+	})
+})

plugin/commands/order/order.go

@@ -28,6 +28,7 @@ func SetupCobraCommands(sl *metadata.SoftlayerCommand) *cobra.Command {
 	cobraCmd.AddCommand(NewQuoteCommand(sl).Command)
 	cobraCmd.AddCommand(NewQuoteDeleteCommand(sl).Command)
 	cobraCmd.AddCommand(NewLookupCommand(sl).Command)
+	cobraCmd.AddCommand(NewCancelationCommand(sl).Command)
 	return cobraCmd
 }
 

plugin/commands/order/order_suite_test.go

@@ -31,6 +31,7 @@ var availableCommands = []string{
 	"quote-detail",
 	"quote-list",
 	"quote-save",
+	"cancelation",
 }
 
 // This test suite exists to make sure commands don't get accidently removed from the actionBindings

plugin/i18n/resources/en_US.all.json

@@ -1559,6 +1559,10 @@
     "id": "Capture virtual server instance into an image",
     "translation": "Capture virtual server instance into an image"
   },
+  {
+    "id": "Case Number",
+    "translation": "Case Number"
+  },
   {
     "id": "Category",
     "translation": "Category"
@@ -3823,6 +3827,10 @@
     "id": "Failed to list VLANs on your account.\n",
     "translation": "Failed to list VLANs on your account.\n"
   },
+  {
+    "id": "Failed to list all item cancelations.",
+    "translation": "Failed to list all item cancelations."
+  },
   {
     "id": "Failed to list available OS's.",
     "translation": "Failed to list available OS's."
@@ -6231,6 +6239,10 @@
     "id": "Number",
     "translation": "Number"
   },
+  {
+    "id": "Number Of Items Cancelled",
+    "translation": "Number Of Items Cancelled"
+  },
   {
     "id": "Number of CPU cores",
     "translation": "Number of CPU cores"
@@ -7339,6 +7351,10 @@
     "id": "Request configuration of a tunnel context",
     "translation": "Request configuration of a tunnel context"
   },
+  {
+    "id": "Requested by",
+    "translation": "Requested by"
+  },
   {
     "id": "Required User",
     "translation": "Required User"

plugin/managers/order.go

@@ -44,17 +44,19 @@ type OrderManager interface {
 	OrderQuote(quoteId int, extra datatypes.Container_Product_Order) (datatypes.Container_Product_Order_Receipt, error)
 	GetRecalculatedOrderContainer(quoteId int) (datatypes.Container_Product_Order, error)
 	GetOrderDetail(orderId int, mask string) (datatypes.Billing_Order, error)
+	GetAllCancelation(mask string) ([]datatypes.Billing_Item_Cancellation_Request, error)
 	DeleteQuote(quoteId int) (datatypes.Billing_Order_Quote, error)
 }
 
 type orderManager struct {
-	PackageService           services.Product_Package
-	OrderService             services.Product_Order
-	LocationService          services.Location_Datacenter
-	PackagePreset            services.Product_Package_Preset
-	AccountService           services.Account
-	BillingOrderQuoteService services.Billing_Order_Quote
-	Session                  *session.Session
+	PackageService                        services.Product_Package
+	OrderService                          services.Product_Order
+	LocationService                       services.Location_Datacenter
+	PackagePreset                         services.Product_Package_Preset
+	AccountService                        services.Account
+	BillingOrderQuoteService              services.Billing_Order_Quote
+	BillingItemCancellationRequestService services.Billing_Item_Cancellation_Request
+	Session                               *session.Session
 }
 
 func NewOrderManager(session *session.Session) *orderManager {
@@ -65,14 +67,15 @@ func NewOrderManager(session *session.Session) *orderManager {
 		services.GetProductPackagePresetService(session),
 		services.GetAccountService(session),
 		services.GetBillingOrderQuoteService(session),
+		services.GetBillingItemCancellationRequestService(session),
 		session,
 	}
 }
 
-//Get a single package with a given key.
-//If no packages are found, returns None
-//packageKeyname: string representing the package key name we are interested in.
-//mask: Mask to specify the properties we want to retrieve
+// Get a single package with a given key.
+// If no packages are found, returns None
+// packageKeyname: string representing the package key name we are interested in.
+// mask: Mask to specify the properties we want to retrieve
 func (i orderManager) GetPackageByKey(packageKeyname, mask string) (datatypes.Product_Package, error) {
 	filters := filter.New(filter.Path("keyName").Eq(packageKeyname))
 	packages, err := i.PackageService.Filter(filters.Build()).Mask(mask).GetAllObjects()
@@ -85,8 +88,8 @@ func (i orderManager) GetPackageByKey(packageKeyname, mask string) (datatypes.Pr
 	return packages[len(packages)-1], nil
 }
 
-//Get details about an image
-//image: The ID of the image.
+// Get details about an image
+// image: The ID of the image.
 func (i orderManager) ListCategories(packageKeyname string) ([]datatypes.Product_Package_Order_Configuration, error) {
 
 	packages, err := i.GetPackageByKey(packageKeyname, "id")
@@ -399,23 +402,23 @@ func (i orderManager) GetPresetPrices(presetId int) (datatypes.Product_Package_P
 	return prices, nil
 }
 
-//Returns active quotes on your account
+// Returns active quotes on your account
 func (i orderManager) GetActiveQuotes(mask string) ([]datatypes.Billing_Order_Quote, error) {
 	if mask == "" {
 		mask = "mask[order[id,items[id,package[id,keyName]]]]"
 	}
 	return i.AccountService.Mask(mask).GetActiveQuotes()
 }
 
-//Returns active quote detail on your account
+// Returns active quote detail on your account
 func (i orderManager) GetQuote(quoteId int, mask string) (datatypes.Billing_Order_Quote, error) {
 	if mask == "" {
 		mask = "mask[order[id,items[package[id,keyName]]]]"
 	}
 	return i.BillingOrderQuoteService.Id(quoteId).Mask(mask).GetObject()
 }
 
-//Save quote
+// Save quote
 func (i orderManager) SaveQuote(quoteId int) (datatypes.Billing_Order_Quote, error) {
 	return i.BillingOrderQuoteService.Id(quoteId).SaveQuote()
 }
@@ -443,8 +446,8 @@ func (i orderManager) GetRecalculatedOrderContainer(quoteId int) (datatypes.Cont
 }
 
 // Return order detail
-//int orderId: The order identifier.
-//string mask: The object mask.
+// int orderId: The order identifier.
+// string mask: The object mask.
 func (i orderManager) GetOrderDetail(orderId int, mask string) (datatypes.Billing_Order, error) {
 	if mask == "" {
 		mask = `mask[orderTotalAmount,orderApprovalDate,
@@ -461,6 +464,17 @@ func (i orderManager) GetOrderDetail(orderId int, mask string) (datatypes.Billin
 	return billingOrderService.Id(orderId).Mask(mask).GetObject()
 }
 
+/*
+Returns all service cancellation requests
+https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getAllCancellationRequests/
+*/
+func (i orderManager) GetAllCancelation(mask string) ([]datatypes.Billing_Item_Cancellation_Request, error) {
+	if mask == "" {
+		mask = "mask[id,itemCount,modifyDate,createDate,ticketId,ticket[assignedUserId,id,attachedHardware[id,hostname,domain],attachedVirtualGuests[id,hostname,domain],attachedDedicatedHosts[id,name],serviceProviderResourceId],status[name,id],user[id,firstName,lastName],items[billingItem[cancellationDate,categoryCode,pendingCancellationFlag]]]"
+	}
+	return i.BillingItemCancellationRequestService.Mask(mask).GetAllCancellationRequests()
+}
+
 // Delete the quote of an order.
 func (i orderManager) DeleteQuote(quoteId int) (datatypes.Billing_Order_Quote, error) {
 	return i.BillingOrderQuoteService.Id(quoteId).DeleteQuote()