Merge pull request #693 from Edson-Rios/issue692

Added new command - ibmcloud sl cdn purge

Author: allmightyspiff

plugin/commands/cdn/cdn.go

@@ -21,6 +21,7 @@ func SetupCobraCommands(sl *metadata.SoftlayerCommand) *cobra.Command {
 	cobraCmd.AddCommand(NewEditCommand(sl).Command)
 	cobraCmd.AddCommand(NewOriginListCommand(sl).Command)
 	cobraCmd.AddCommand(NewCreateCommand(sl).Command)
+	cobraCmd.AddCommand(NewPurgeCommand(sl).Command)
 	cobraCmd.AddCommand(NewOriginAddCommand(sl).Command)
 	return cobraCmd
 }

plugin/commands/cdn/cdn_test.go

@@ -25,6 +25,7 @@ var availableCommands = []string{
 	"list",
 	"origin-list",
 	"create",
+	"purge",
 	"origin-add",
 }
 

plugin/commands/cdn/purge.go

@@ -0,0 +1,66 @@
+package cdn
+
+import (
+	"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 PurgeCommand struct {
+	*metadata.SoftlayerCommand
+	CdnManager managers.CdnManager
+	Command    *cobra.Command
+}
+
+func NewPurgeCommand(sl *metadata.SoftlayerCommand) *PurgeCommand {
+	thisCmd := &PurgeCommand{
+		SoftlayerCommand: sl,
+		CdnManager:       managers.NewCdnManager(sl.Session),
+	}
+	cobraCmd := &cobra.Command{
+		Use:   "purge " + T("IDENTIFIER") + " " + T("PATH"),
+		Short: T("Creates a purge record and also initiates the purge call."),
+		Long: T(`${COMMAND_NAME} sl cdn purge
+Example:
+${COMMAND_NAME} sl cdn purge 9779455 /article/file.txt"`),
+		Args: metadata.TwoArgs,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return thisCmd.Run(args)
+		},
+	}
+	thisCmd.Command = cobraCmd
+	return thisCmd
+}
+
+func (cmd *PurgeCommand) Run(args []string) error {
+	cdnId := args[0]
+	path := args[1]
+	outputFormat := cmd.GetOutputFlag()
+
+	datas, err := cmd.CdnManager.Purge(cdnId, path)
+	if err != nil {
+		return errors.NewAPIError(T("Failed to purge."), err.Error(), 2)
+	}
+
+	table := cmd.UI.Table([]string{
+		T("Date"),
+		T("Path"),
+		T("Saved"),
+		T("Status"),
+	})
+	for _, data := range datas {
+		table.Add(
+			utils.FormatStringToTime(data.Date),
+			utils.FormatStringPointer(data.Path),
+			utils.FormatStringPointer(data.Saved),
+			utils.FormatStringPointer(data.Status),
+		)
+	}
+	utils.PrintTable(cmd.UI, table, outputFormat)
+
+	return nil
+}

plugin/commands/cdn/purge_test.go

@@ -0,0 +1,64 @@
+package cdn_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/cdn"
+	"github.ibm.com/SoftLayer/softlayer-cli/plugin/metadata"
+	"github.ibm.com/SoftLayer/softlayer-cli/plugin/testhelpers"
+)
+
+var _ = Describe("Cdn purge", func() {
+	var (
+		fakeUI      *terminal.FakeUI
+		cliCommand  *cdn.PurgeCommand
+		fakeSession *session.Session
+		slCommand   *metadata.SoftlayerCommand
+	)
+	BeforeEach(func() {
+		fakeUI = terminal.NewFakeUI()
+		fakeSession = testhelpers.NewFakeSoftlayerSession([]string{})
+		slCommand = metadata.NewSoftlayerCommand(fakeUI, fakeSession)
+		cliCommand = cdn.NewPurgeCommand(slCommand)
+		cliCommand.Command.PersistentFlags().Var(cliCommand.OutputFlag, "output", "--output=JSON for json output.")
+	})
+
+	Describe("Cdn purge", func() {
+		Context("Cdn purge, Invalid Usage", func() {
+			It("Set command without id and path", func() {
+				err := testhelpers.RunCobraCommand(cliCommand.Command)
+				Expect(err).To(HaveOccurred())
+				Expect(err.Error()).To(ContainSubstring("Incorrect Usage: This command requires two arguments."))
+			})
+		})
+
+		Context("Cdn purge, correct use", func() {
+			It("return cdn purge", func() {
+				err := testhelpers.RunCobraCommand(cliCommand.Command, "123456789", "/example/")
+				Expect(err).NotTo(HaveOccurred())
+				Expect(fakeUI.Outputs()).To(ContainSubstring("Date"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("Path"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("Saved"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("Status"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("/example/"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("UNSAVED"))
+				Expect(fakeUI.Outputs()).To(ContainSubstring("SUCCESS"))
+			})
+			It("return cdn purge in format json", func() {
+				err := testhelpers.RunCobraCommand(cliCommand.Command, "123456789", "/example/", "--output", "json")
+				Expect(err).NotTo(HaveOccurred())
+				Expect(fakeUI.Outputs()).To(ContainSubstring(`"Date":`))
+				Expect(fakeUI.Outputs()).To(ContainSubstring(`"Path": "/example/",`))
+				Expect(fakeUI.Outputs()).To(ContainSubstring(`"Saved": "UNSAVED",`))
+				Expect(fakeUI.Outputs()).To(ContainSubstring(`"Status": "SUCCESS"`))
+				Expect(fakeUI.Outputs()).To(ContainSubstring(`[`))
+				Expect(fakeUI.Outputs()).To(ContainSubstring(`{`))
+				Expect(fakeUI.Outputs()).To(ContainSubstring(`}`))
+				Expect(fakeUI.Outputs()).To(ContainSubstring(`]`))
+			})
+		})
+	})
+})

plugin/managers/cdn.go

@@ -21,19 +21,22 @@ type CdnManager interface {
 	EditCDN(uniqueId int, header string, httpPort int, httpsPort int, origin string, respectHeaders string, cache string, cacheDescription string, performanceConfiguration string) (datatypes.Container_Network_CdnMarketplace_Configuration_Mapping, error)
 	CreateCdn(hostname string, originHost string, originType string, http int, https int, bucketName string, cname string, header string, path string, ssl string) ([]datatypes.Container_Network_CdnMarketplace_Configuration_Mapping, error)
 	OriginAddCdn(uniqueId string, header string, path string, originHost string, originType string, http int, https int, cacheKey string, optimize string, dynamicPath string, dynamicPrefetch bool, dynamicCompression bool, bucketName string, fileExtension string) ([]datatypes.Container_Network_CdnMarketplace_Configuration_Mapping_Path, error)
+	Purge(uniqueId string, path string) ([]datatypes.Container_Network_CdnMarketplace_Configuration_Cache_Purge, error)
 }
 
 type cdnManager struct {
-	CdnService     services.Network_CdnMarketplace_Configuration_Mapping
-	CdnPathService services.Network_CdnMarketplace_Configuration_Mapping_Path
-	Session        *session.Session
+	CdnService      services.Network_CdnMarketplace_Configuration_Mapping
+	CdnPathService  services.Network_CdnMarketplace_Configuration_Mapping_Path
+	CdnPurgeService services.Network_CdnMarketplace_Configuration_Cache_Purge
+	Session         *session.Session
 }
 
 func NewCdnManager(session *session.Session) *cdnManager {
 	return &cdnManager{
-		CdnService:     services.GetNetworkCdnMarketplaceConfigurationMappingService(session),
-		CdnPathService: services.GetNetworkCdnMarketplaceConfigurationMappingPathService(session),
-		Session:        session,
+		CdnService:      services.GetNetworkCdnMarketplaceConfigurationMappingService(session),
+		CdnPathService:  services.GetNetworkCdnMarketplaceConfigurationMappingPathService(session),
+		CdnPurgeService: services.GetNetworkCdnMarketplaceConfigurationCachePurgeService(session),
+		Session:         session,
 	}
 }
 
@@ -270,3 +273,11 @@ func (a cdnManager) OriginAddCdn(uniqueId string, header string, path string, or
 
 	return a.CdnPathService.CreateOriginPath(&NewOrigin)
 }
+
+/*
+This method creates a purge record in the purge table, and also initiates the create purge call.
+https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/createPurge/
+*/
+func (a cdnManager) Purge(uniqueId string, path string) ([]datatypes.Container_Network_CdnMarketplace_Configuration_Cache_Purge, error) {
+	return a.CdnPurgeService.CreatePurge(&uniqueId, &path)
+}

plugin/testfixtures/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/createPurge.json

@@ -0,0 +1,8 @@
+[
+	{
+		"date": "1682697987",
+		"path": "/example/",
+		"saved": "UNSAVED",
+		"status": "SUCCESS"
+	}
+]

plugin/testhelpers/fake_cdn_manager.go

@@ -417,3 +417,13 @@ func GetPodWithClosedAnnouncement(key string, pods []datatypes.Network_Pod) stri
 	}
 	return "-"
 }
+
+func FormatStringToTime(timestamp *string) string {
+	timeInt, err := strconv.ParseInt(*timestamp, 10, 64)
+	if err != nil {
+		fmt.Println("Error:", err)
+		return ""
+	}
+	t := time.Unix(timeInt, 0)
+	return t.Format("2006-01-02 15:04:05")
+}