Merge pull request #879 from SoftLayer/issues740

Adds dedicatedhost cancel command

Author: allmightyspiff

README.md

@@ -156,6 +156,25 @@ Expect(slOptions.Filter).To(ContainSubstring(`"id":{"operation":"orderBy","optio
 Check testhelpers/fake_softlayer_session.go for all the fields that get recorded with an API call.
 
 
+Heres a fancy way to test an API call matches a few different properties at the same time:
+
+```go
+// This is where the MatchFields/PointTo come from
+. "github.com/onsi/gomega/gstruct"
+
+It("it returns dedicatedhost verify response", func() {
+    err := dedicatedhostManager.DeleteHost(12345)
+    Expect(err).NotTo(HaveOccurred())
+    apiCalls := fakeHandler.ApiCallLogs
+    Expect(len(apiCalls)).To(Equal(1))
+    Expect(apiCalls[0]).To(MatchFields(IgnoreExtras, Fields{
+        "Service": Equal("SoftLayer_Virtual_DedicatedHost"),
+        "Method":  Equal("deleteObject"),
+        "Options": PointTo(MatchFields(IgnoreExtras, Fields{"Id": PointTo(Equal(12345))})),
+    }))
+})
+
+```
 
 ### Test Fakes
 

bin/buildAndDeploy.py

@@ -102,6 +102,7 @@ def runTests() -> None:
     except FileNotFoundError:
         gosec_instal = "curl -sfL https://raw.githubusercontent.com/securego/gosec/master/install.sh | sh -s -- -b $GOPATH/bin"
         print(f"[red]gosec not found. Try running:\n{gosec_instal}")
+    print('[turquoise2] go sec OK.')
 
 ### Section for i18n4go stuff ###
 def runI18n4go(path: str) -> None:

plugin/commands/dedicatedhost/cancel.go

@@ -0,0 +1,51 @@
+package dedicatedhost
+
+import (
+	"strconv"
+	"github.com/spf13/cobra"
+
+	. "github.ibm.com/SoftLayer/softlayer-cli/plugin/i18n"
+	slErr "github.ibm.com/SoftLayer/softlayer-cli/plugin/errors"
+	"github.ibm.com/SoftLayer/softlayer-cli/plugin/managers"
+	"github.ibm.com/SoftLayer/softlayer-cli/plugin/metadata"
+)
+
+type CancellHostCommand struct {
+	*metadata.SoftlayerCommand
+	DedicatedHostManager managers.DedicatedHostManager
+	Command              *cobra.Command
+}
+
+func NewCancelHostCommand(sl *metadata.SoftlayerCommand) *CancellHostCommand {
+	thisCmd := &CancellHostCommand{
+		SoftlayerCommand:     sl,
+		DedicatedHostManager: managers.NewDedicatedhostManager(sl.Session),
+	}
+	cobraCmd := &cobra.Command{
+		Use:   "cancel " + T("IDENTIFIER"),
+		Short: T("Cancel a dedicated host server immediately."),
+		Long: T(`If there are any guests on this Dedicated Host, this command will fail until those guests are deleted.
+Use 'sl dedicatedhost cancel-guests [IDENTIFIER]' to remove all guests from a host.
+Use 'sl vs delete' to remove a specific guest.`),
+		Args:  metadata.OneArgs,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return thisCmd.Run(args)
+		},
+	}
+
+	thisCmd.Command = cobraCmd
+	return thisCmd
+}
+
+func (cmd *CancellHostCommand) Run(args []string) error {
+	hardwareID, err := strconv.Atoi(args[0])
+	if err != nil {
+		return slErr.NewInvalidSoftlayerIdInputError("IDENTIFIER")
+	}
+	err = cmd.DedicatedHostManager.DeleteHost(hardwareID)
+	if err != nil {
+		return err
+	}
+	cmd.UI.Print(T("Dedicated Host {{.ID}} was cancelled", map[string]interface{}{"ID": hardwareID}))
+	return nil
+}

plugin/commands/dedicatedhost/cancel_test.go

@@ -0,0 +1,60 @@
+package dedicatedhost_test
+
+import (
+	"errors"
+	"github.com/IBM-Cloud/ibm-cloud-cli-sdk/testhelpers/terminal"
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	"github.com/softlayer/softlayer-go/session"
+	"github.ibm.com/SoftLayer/softlayer-cli/plugin/commands/dedicatedhost"
+	"github.ibm.com/SoftLayer/softlayer-cli/plugin/metadata"
+	"github.ibm.com/SoftLayer/softlayer-cli/plugin/testhelpers"
+)
+
+var _ = Describe("Dedicated host cancel", func() {
+	var (
+		fakeUI                   *terminal.FakeUI
+		cliCommand               *dedicatedhost.CancellHostCommand
+		fakeSession              *session.Session
+		slCommand                *metadata.SoftlayerCommand
+		FakeDedicatedhostManager *testhelpers.FakeDedicatedHostManager
+	)
+	BeforeEach(func() {
+		fakeUI = terminal.NewFakeUI()
+		fakeSession = testhelpers.NewFakeSoftlayerSession([]string{})
+		slCommand = metadata.NewSoftlayerCommand(fakeUI, fakeSession)
+		cliCommand = dedicatedhost.NewCancelHostCommand(slCommand)
+		cliCommand.Command.PersistentFlags().Var(cliCommand.OutputFlag, "output", "--output=JSON for json output.")
+		FakeDedicatedhostManager = new(testhelpers.FakeDedicatedHostManager)
+		cliCommand.DedicatedHostManager = FakeDedicatedhostManager
+	})
+
+	Describe("Dedicatedhost cancel usage errors", func() {
+		Context("Dedicatedhost cancel without ID", func() {
+			It("return error", func() {
+				err := testhelpers.RunCobraCommand(cliCommand.Command)
+				Expect(err).To(HaveOccurred())
+				Expect(err.Error()).To(ContainSubstring("Incorrect Usage: This command requires one argument"))
+			})
+		})
+	})
+	Describe("Dedicatedhost cancel usage", func() {
+		Context("Dedicatedhost cancel Happy Path", func() {
+			It("Succss", func() {
+				err := testhelpers.RunCobraCommand(cliCommand.Command, "12345")
+				Expect(err).NotTo(HaveOccurred())
+				Expect(fakeUI.Outputs()).To(ContainSubstring("Dedicated Host 12345 was cancelled"))
+			})
+		})
+		Context("Dedicatedhost cancel API errors", func() {
+			BeforeEach(func() {
+				FakeDedicatedhostManager.DeleteHostReturns(errors.New("API ERROR"))
+			})
+			It("Handle API error", func() {
+				err := testhelpers.RunCobraCommand(cliCommand.Command, "12345")
+				Expect(err).To(HaveOccurred())
+				Expect(err.Error()).To(ContainSubstring("API ERROR"))
+			})
+		})
+	})
+})

plugin/commands/dedicatedhost/detail_test.go

@@ -4,7 +4,6 @@ import (
 	"errors"
 	"time"
 
-	. "github.com/IBM-Cloud/ibm-cloud-cli-sdk/testhelpers/matchers"
 	"github.com/IBM-Cloud/ibm-cloud-cli-sdk/testhelpers/terminal"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
@@ -26,7 +25,7 @@ var _ = Describe("Dedicated host detail", func() {
 	)
 	BeforeEach(func() {
 		fakeUI = terminal.NewFakeUI()
-		fakeSession = testhelpers.NewFakeSoftlayerSession([]string{})
+		fakeSession = testhelpers.NewFakeSoftlayerSession(nil)
 		slCommand = metadata.NewSoftlayerCommand(fakeUI, fakeSession)
 		cliCommand = dedicatedhost.NewDetailCommand(slCommand)
 		cliCommand.Command.PersistentFlags().Var(cliCommand.OutputFlag, "output", "--output=JSON for json output.")
@@ -111,35 +110,18 @@ var _ = Describe("Dedicated host detail", func() {
 			It("return no error", func() {
 				err := testhelpers.RunCobraCommand(cliCommand.Command, "1234")
 				Expect(err).NotTo(HaveOccurred())
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"1234"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"dedicatedhost"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"56"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"1200"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"242"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"2022-02-01T00:00:00Z"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"2022-02-01T00:00:00Z"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"3"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"dal13"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"wilmawang"}))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("1234"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("dedicatedhost"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("dal13"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("wilmawang"))
 			})
 			It("return no error", func() {
 				err := testhelpers.RunCobraCommand(cliCommand.Command, "1234", "--guests", "--price")
 				Expect(err).NotTo(HaveOccurred())
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"1234"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"dedicatedhost"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"56"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"1200"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"242"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"2022-02-01T00:00:00Z"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"2022-02-01T00:00:00Z"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"3"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"dal13"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"10"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"wilmawang"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"test.com"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"test"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"9131111-2222-6a10-3333-992c544444"}))
-				Expect(fakeUI.Outputs()).To(ContainSubstrings([]string{"1234567"}))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("1234"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("dedicatedhost"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("9131111-2222-6a10-3333-992c544444"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("1234567"))
 			})
 		})
 	})

plugin/managers/dedicatedhost.go

@@ -45,6 +45,7 @@ type DedicatedHostManager interface {
 	GetCreateOptions(productPackage datatypes.Product_Package) map[string]map[string]string
 	GetVlansOptions(datacenter string, flavor string, productPackage datatypes.Product_Package) ([]datatypes.Network_Vlan, error)
 	ListDedicatedHost(name, datacenter, owner string, orderId int) ([]datatypes.Virtual_DedicatedHost, error)
+	DeleteHost(identifier int) error
 }
 
 type dedicatedhostManager struct {
@@ -302,3 +303,9 @@ func (d dedicatedhostManager) ListDedicatedHost(name, datacenter, owner string,
 	}
 	return resourceList, nil
 }
+
+// Calls https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_DedicatedHost/deleteObject/
+func (d dedicatedhostManager) DeleteHost(identifier int) error {
+	_, err := d.VirtualDedicatedHost.Id(identifier).DeleteObject()
+	return err
+}

plugin/managers/dedicatedhost_test.go

@@ -3,6 +3,7 @@ package managers_test
 import (
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
+	. "github.com/onsi/gomega/gstruct"
 	"github.com/softlayer/softlayer-go/session"
 	"github.ibm.com/SoftLayer/softlayer-cli/plugin/managers"
 	"github.ibm.com/SoftLayer/softlayer-cli/plugin/testhelpers"
@@ -11,13 +12,19 @@ import (
 var _ = Describe("DedicatedhostManager", func() {
 	var (
 		fakeSLSession        *session.Session
+		fakeHandler    		*testhelpers.FakeTransportHandler
 		dedicatedhostManager managers.DedicatedHostManager
 	)
 
 	BeforeEach(func() {
 		fakeSLSession = testhelpers.NewFakeSoftlayerSession(nil)
+		fakeHandler = testhelpers.GetSessionHandler(fakeSLSession)
 		dedicatedhostManager = managers.NewDedicatedhostManager(fakeSLSession)
 	})
+	AfterEach(func() {
+		fakeHandler.ClearApiCallLogs()
+		fakeHandler.ClearErrors()
+	})
 
 	Describe("Genereate a dedicatedhost order template", func() {
 		Context("not found Package", func() {
@@ -80,4 +87,19 @@ var _ = Describe("DedicatedhostManager", func() {
 			})
 		})
 	})
+	Describe("Dedicated Host Manager Simple functions", func() {
+		Context("DeleteHost", func() {
+			It("it returns dedicatedhost verify response", func() {
+				err := dedicatedhostManager.DeleteHost(12345)
+				Expect(err).NotTo(HaveOccurred())
+				apiCalls := fakeHandler.ApiCallLogs
+				Expect(len(apiCalls)).To(Equal(1))
+				Expect(apiCalls[0]).To(MatchFields(IgnoreExtras, Fields{
+					"Service": Equal("SoftLayer_Virtual_DedicatedHost"),
+					"Method":  Equal("deleteObject"),
+					"Options": PointTo(MatchFields(IgnoreExtras, Fields{"Id": PointTo(Equal(12345))})),
+				}))
+			})
+		})
+	})
 })

plugin/testfixtures/SoftLayer_Virtual_DedicatedHost/deleteObject.json

@@ -0,0 +1 @@
+true