Merge pull request #703 from Brian-Flores/issue701

Add options in `ibmcloud sl account billing-items`

Author: allmightyspiff

plugin/commands/account/billing-items.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 
 	"github.com/softlayer/softlayer-go/datatypes"
+	"github.com/softlayer/softlayer-go/filter"
 
 	"github.com/IBM-Cloud/ibm-cloud-cli-sdk/bluemix/terminal"
 	"github.com/spf13/cobra"
@@ -20,6 +21,9 @@ type BillingItemsCommand struct {
 	*metadata.SoftlayerCommand
 	AccountManager managers.AccountManager
 	Command        *cobra.Command
+	Category       string
+	Create         string
+	Ordered        string
 }
 
 func NewBillingItemsCommand(sl *metadata.SoftlayerCommand) *BillingItemsCommand {
@@ -35,6 +39,9 @@ func NewBillingItemsCommand(sl *metadata.SoftlayerCommand) *BillingItemsCommand
 			return thisCmd.Run(args)
 		},
 	}
+	cobraCmd.Flags().StringVar(&thisCmd.Category, "category", "", T("Category name."))
+	cobraCmd.Flags().StringVar(&thisCmd.Create, "create", "", T("The date the billing item was created (YYYY-MM-DD)."))
+	cobraCmd.Flags().StringVar(&thisCmd.Ordered, "ordered", "", T("Name that ordered the item."))
 	thisCmd.Command = cobraCmd
 	return thisCmd
 }
@@ -43,16 +50,27 @@ func (cmd *BillingItemsCommand) Run(args []string) error {
 
 	outputFormat := cmd.GetOutputFlag()
 
-	mask := "mask[orderItem[id,order[id,userRecord[id,email,displayName,userStatus]]],nextInvoiceTotalRecurringAmount,location, hourlyFlag]"
-	billingItems, err := cmd.AccountManager.GetBillingItems(mask)
+	objectMask := "mask[orderItem[id,order[id,userRecord[id,email,displayName,userStatus]]],nextInvoiceTotalRecurringAmount,location, hourlyFlag]"
+
+	objectFilter := filter.New()
+	objectFilter = append(objectFilter, filter.Path("allTopLevelBillingItems.id").OrderBy("ASC"))
+	objectFilter = append(objectFilter, filter.Path("allTopLevelBillingItems.cancellationDate").IsNull())
+	if cmd.Category != "" {
+		objectFilter = append(objectFilter, filter.Path("allTopLevelBillingItems.categoryCode").Eq(cmd.Category))
+	}
+	if cmd.Create != "" {
+		objectFilter = append(objectFilter, filter.Path("allTopLevelBillingItems.createDate").Contains(cmd.Create))
+	}
+
+	billingItems, err := cmd.AccountManager.GetBillingItems(objectMask, objectFilter.Build())
 	if err != nil {
 		return errors.NewAPIError(T("Failed to get billing items."), err.Error(), 2)
 	}
-	PrintBillingItems(billingItems, cmd.UI, outputFormat)
+	PrintBillingItems(billingItems, cmd.UI, cmd.Ordered, outputFormat)
 	return nil
 }
 
-func PrintBillingItems(billingItems []datatypes.Billing_Item, ui terminal.UI, outputFormat string) {
+func PrintBillingItems(billingItems []datatypes.Billing_Item, ui terminal.UI, orderedFilter string, outputFormat string) {
 	bufEvent := new(bytes.Buffer)
 	table := terminal.NewTable(bufEvent, []string{
 		T("Id"),
@@ -74,6 +92,11 @@ func PrintBillingItems(billingItems []datatypes.Billing_Item, ui terminal.UI, ou
 		if billingItems.OrderItem != nil {
 			OrderedBy = utils.FormatStringPointer(billingItems.OrderItem.Order.UserRecord.DisplayName)
 		}
+
+		if orderedFilter != "" && orderedFilter != OrderedBy {
+			continue
+		}
+
 		table.Add(
 			utils.FormatIntPointer(billingItems.Id),
 			utils.FormatSLTimePointer(billingItems.CreateDate),

plugin/commands/account/billing-items_test.go

@@ -37,12 +37,15 @@ var _ = Describe("Account list BillingItems", func() {
 
 		Context("Account events, correct use", func() {
 			It("return account events", func() {
-				err := testhelpers.RunCobraCommand(cliCommand.Command)
+				err := testhelpers.RunCobraCommand(cliCommand.Command, "--category=ssl_certificate", "--create=2016-01-20", "--ordered=TestName")
 				Expect(err).NotTo(HaveOccurred())
-				Expect(fakeUI.Outputs()).To(ContainSubstring("Billing Items"))
-				Expect(fakeUI.Outputs()).To(ContainSubstring("Id          Create Date            Cost   Category Code             Ordered By   Description                                             Notes"))
-				Expect(fakeUI.Outputs()).To(ContainSubstring("81336973    2016-01-20T17:00:19Z   0.00   ssl_certificate           TestName     RapidSSL - 1 year                                       techbabble.xyz"))
-				Expect(fakeUI.Outputs()).To(ContainSubstring("933002170   2022-02-18T18:47:32Z   0.00   dedicated_virtual_hosts   testName2    virtualserver01-0c56.softlayer-internal-developmen...   -"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("81336973"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("2016-01-20T17:00:19Z"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("0.00"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("ssl_certificate"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("TestName"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("RapidSSL - 1 year"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("techbabble.xyz"))
 
 			})
 			It("return account events in format json", func() {

plugin/managers/account.go

@@ -15,7 +15,7 @@ type AccountManager interface {
 	SummaryByDatacenter() (map[string]map[string]int, error)
 	GetBandwidthPools() ([]datatypes.Network_Bandwidth_Version1_Allotment, error)
 	GetBandwidthPoolServers(identifier int) (int, error)
-	GetBillingItems(mask string) ([]datatypes.Billing_Item, error)
+	GetBillingItems(objectMask string, objectFilter string) ([]datatypes.Billing_Item, error)
 	GetEvents(typeEvent string, mask string, dateFilter string) ([]datatypes.Notification_Occurrence_Event, error)
 	GetEventDetail(identifier int, mask string) (datatypes.Notification_Occurrence_Event, error)
 	AckEvent(identifier int) (bool, error)
@@ -112,15 +112,12 @@ func (a accountManager) GetBandwidthPoolServers(identifier int) (int, error) {
 Gets All billing items of an account.
 https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAllTopLevelBillingItems/
 */
-func (a accountManager) GetBillingItems(mask string) ([]datatypes.Billing_Item, error) {
-	filters := filter.New()
-	filters = append(filters, filter.Path("allTopLevelBillingItems.id").OrderBy("ASC"))
-	filters = append(filters, filter.Path("allTopLevelBillingItems.cancellationDate").IsNull())
+func (a accountManager) GetBillingItems(objectMask string, objectFilter string) ([]datatypes.Billing_Item, error) {
 
 	i := 0
 	resourceList := []datatypes.Billing_Item{}
 	for {
-		resp, err := a.AccountService.Mask(mask).Filter(filters.Build()).Limit(metadata.LIMIT).Offset(i * metadata.LIMIT).GetAllTopLevelBillingItems()
+		resp, err := a.AccountService.Mask(objectMask).Filter(objectFilter).Limit(metadata.LIMIT).Offset(i * metadata.LIMIT).GetAllTopLevelBillingItems()
 		i++
 		if err != nil {
 			return []datatypes.Billing_Item{}, err