CDTOOL-1260: Introduce 'service purge' command and 'purge' alias. (#1612)

### Change summary

This PR adds the 'service purge' command as a replacement for the
'purge' command. The 'purge' command is still available as an alias, but
will issue a deprecation warning when it is used.

This involved a number of changes:

1. The existing 'pkg/commands/purge' package content was moved to
'pkg/commands/service/purge', and modified to work as expected in that
location.
2. A new 'pkg/commands/alias' package was added to hold alias-only
packages.
3. An alias was added in 'pkg/commands/alias/purge'. This alias uses
`struct` embedding to avoid duplicating any of the code from the
`pkg/commands/service/purge' package. The alias command is 'unlisted'
and issues a deprecation warning when it is used.

This PR also fixes the `make fmt` target in the `Makefile` to work
properly.

 All Submissions:

* [X] Have you followed the guidelines in our Contributing document?
* [X] Have you checked to ensure there aren't other open [Pull
Requests](https://github.com/fastly/cli/pulls) for the same
update/change?

<!-- You can erase any parts of this template not applicable to your
Pull Request. -->

### New Feature Submissions:

* [X] Does your submission pass tests?
### User Impact

<!-- What is the user impact of this change? -->

New deprecation warning for the `purge` command.

Author: kpfleming

CHANGELOG.md

@@ -7,8 +7,9 @@
 ### Enhancements:
 - feat(rust): Allow testing with prerelease Rust versions ([#1604](https://github.com/fastly/cli/pull/1604))
 - feat(compute/hashfiles): remove hashsum subcommand ([#1608](https://github.com/fastly/cli/pull/1608))
-- feat(commands/ngwaf/rules): add support for CRUD operations for NGWAF rules ([#1578](https://github.com/fastly/cli/pull/1605))
+- feat(commands/ngwaf/rules): add support for CRUD operations for NGWAF rules ([#1605](https://github.com/fastly/cli/pull/1605))
 - feat(compute/deploy): added the  `--no-default-domain` flag to allow for the skipping of automatic domain creation when  deploying a Compute service([#1610](https://github.com/fastly/cli/pull/1610))
+- feat(commands/service/purge): Add 'service purge' command as replacement for 'purge', with an unlisted and deprecated alias of 'purge'. ([#1612](https://github.com/fastly/cli/pull/1612))
 
 ### Bug fixes:
 

Makefile

@@ -74,7 +74,7 @@ tidy:
 # Run formatter.
 .PHONY: fmt
 fmt:
-	golangci-lint fmt
+	$(GOLANGCI_LINT) fmt
 
 # Run semgrep checker.
 # NOTE: We can only exclude the import-text-template rule via a semgrep CLI flag

pkg/app/run_test.go

@@ -87,7 +87,6 @@ object-storage
 pops
 products
 profile
-purge
 rate-limit
 resource-link
 secret-store

pkg/commands/alias/doc.go

@@ -0,0 +1,2 @@
+// Package alias contains aliases for commands which have been renamed/relocated and are deprecated.
+package alias

pkg/commands/alias/purge/doc.go

@@ -0,0 +1,2 @@
+// Package purge contains the 'purge' alias for the 'service purge' command.
+package purge

pkg/commands/alias/purge/purge.go

@@ -0,0 +1,29 @@
+package purge
+
+import (
+	"io"
+
+	servicepurge "github.com/fastly/cli/pkg/commands/service/purge"
+
+	"github.com/fastly/cli/pkg/argparser"
+	"github.com/fastly/cli/pkg/global"
+	"github.com/fastly/cli/pkg/text"
+)
+
+// PurgeCommand wraps the PurgeCommand from the servicepurge package.
+type Command struct {
+	*servicepurge.PurgeCommand
+}
+
+// NewCommand returns a usable command registered under the parent.
+func NewCommand(parent argparser.Registerer, g *global.Data) *Command {
+	c := Command{servicepurge.NewPurgeCommand(parent, g)}
+	c.CmdClause.Hidden()
+	return &c
+}
+
+// Exec implements the command interface.
+func (c *Command) Exec(in io.Reader, out io.Writer) error {
+	text.Deprecated(out, "Use the 'service purge' command instead.")
+	return c.PurgeCommand.Exec(in, out)
+}

pkg/commands/commands.go

@@ -7,6 +7,7 @@ import (
 	"github.com/fastly/cli/pkg/commands/acl"
 	"github.com/fastly/cli/pkg/commands/aclentry"
 	"github.com/fastly/cli/pkg/commands/alerts"
+	aliaspurge "github.com/fastly/cli/pkg/commands/alias/purge"
 	"github.com/fastly/cli/pkg/commands/authtoken"
 	"github.com/fastly/cli/pkg/commands/backend"
 	"github.com/fastly/cli/pkg/commands/compute"
@@ -88,12 +89,12 @@ import (
 	"github.com/fastly/cli/pkg/commands/pop"
 	"github.com/fastly/cli/pkg/commands/products"
 	"github.com/fastly/cli/pkg/commands/profile"
-	"github.com/fastly/cli/pkg/commands/purge"
 	"github.com/fastly/cli/pkg/commands/ratelimit"
 	"github.com/fastly/cli/pkg/commands/resourcelink"
 	"github.com/fastly/cli/pkg/commands/secretstore"
 	"github.com/fastly/cli/pkg/commands/secretstoreentry"
 	"github.com/fastly/cli/pkg/commands/service"
+	servicepurge "github.com/fastly/cli/pkg/commands/service/purge"
 	"github.com/fastly/cli/pkg/commands/serviceauth"
 	"github.com/fastly/cli/pkg/commands/serviceversion"
 	"github.com/fastly/cli/pkg/commands/shellcomplete"
@@ -593,7 +594,6 @@ func Define( // nolint:revive // function-length
 	profileSwitch := profile.NewSwitchCommand(profileCmdRoot.CmdClause, data, ssoCmdRoot)
 	profileToken := profile.NewTokenCommand(profileCmdRoot.CmdClause, data)
 	profileUpdate := profile.NewUpdateCommand(profileCmdRoot.CmdClause, data, ssoCmdRoot)
-	purgeCmdRoot := purge.NewRootCommand(app, data)
 	rateLimitCmdRoot := ratelimit.NewRootCommand(app, data)
 	rateLimitCreate := ratelimit.NewCreateCommand(rateLimitCmdRoot.CmdClause, data)
 	rateLimitDelete := ratelimit.NewDeleteCommand(rateLimitCmdRoot.CmdClause, data)
@@ -623,6 +623,7 @@ func Define( // nolint:revive // function-length
 	serviceList := service.NewListCommand(serviceCmdRoot.CmdClause, data)
 	serviceSearch := service.NewSearchCommand(serviceCmdRoot.CmdClause, data)
 	serviceUpdate := service.NewUpdateCommand(serviceCmdRoot.CmdClause, data)
+	servicePurge := servicepurge.NewPurgeCommand(serviceCmdRoot.CmdClause, data)
 	serviceauthCmdRoot := serviceauth.NewRootCommand(app, data)
 	serviceauthCreate := serviceauth.NewCreateCommand(serviceauthCmdRoot.CmdClause, data)
 	serviceauthDelete := serviceauth.NewDeleteCommand(serviceauthCmdRoot.CmdClause, data)
@@ -712,6 +713,9 @@ func Define( // nolint:revive // function-length
 	versionCmdRoot := version.NewRootCommand(app, data)
 	whoamiCmdRoot := whoami.NewRootCommand(app, data)
 
+	// Aliases for deprecated commands
+	aliasPurge := aliaspurge.NewCommand(app, data)
+
 	return []argparser.Command{
 		shellcompleteCmdRoot,
 		aclCmdRoot,
@@ -1167,7 +1171,6 @@ func Define( // nolint:revive // function-length
 		profileSwitch,
 		profileToken,
 		profileUpdate,
-		purgeCmdRoot,
 		rateLimitCmdRoot,
 		rateLimitCreate,
 		rateLimitDelete,
@@ -1195,6 +1198,7 @@ func Define( // nolint:revive // function-length
 		serviceList,
 		serviceSearch,
 		serviceUpdate,
+		servicePurge,
 		serviceauthCmdRoot,
 		serviceauthCreate,
 		serviceauthDelete,
@@ -1284,5 +1288,6 @@ func Define( // nolint:revive // function-length
 		vclSnippetUpdate,
 		versionCmdRoot,
 		whoamiCmdRoot,
+		aliasPurge,
 	}
 }

pkg/commands/purge/doc.go pkg/commands/service/purge/doc.gopkg/commands/purge/doc.go renamed to pkg/commands/service/purge/doc.go

@@ -21,9 +21,22 @@ import (
 // CommandName is the string to be used to invoke this command.
 const CommandName = "purge"
 
-// NewRootCommand returns a new command registered in the parent.
-func NewRootCommand(parent argparser.Registerer, g *global.Data) *RootCommand {
-	var c RootCommand
+// PurgeCommand calls the Fastly API to purge items from the cache.
+type PurgeCommand struct { //revive:disable:exported
+	argparser.Base
+
+	all         bool
+	file        string
+	key         string
+	serviceName argparser.OptionalServiceNameID
+	soft        bool
+	url         string
+}
+
+// NewPurgeCommand returns a usable command registered under the parent.
+func NewPurgeCommand(parent argparser.Registerer, g *global.Data) *PurgeCommand {
+	var c PurgeCommand
+
 	c.CmdClause = parent.Command(CommandName, "Invalidate objects in the Fastly cache")
 	c.Globals = g
 
@@ -49,21 +62,8 @@ func NewRootCommand(parent argparser.Registerer, g *global.Data) *RootCommand {
 	return &c
 }
 
-// RootCommand is the parent command for all subcommands in this package.
-// It should be installed under the primary root command.
-type RootCommand struct {
-	argparser.Base
-
-	all         bool
-	file        string
-	key         string
-	serviceName argparser.OptionalServiceNameID
-	soft        bool
-	url         string
-}
-
 // Exec implements the command interface.
-func (c *RootCommand) Exec(_ io.Reader, out io.Writer) error {
+func (c *PurgeCommand) Exec(_ io.Reader, out io.Writer) error {
 	serviceID, source, flag, err := argparser.ServiceID(c.serviceName, *c.Globals.Manifest, c.Globals.APIClient, c.Globals.ErrLog)
 	if err != nil {
 		return err
@@ -135,7 +135,7 @@ func (c *RootCommand) Exec(_ io.Reader, out io.Writer) error {
 	return nil
 }
 
-func (c *RootCommand) purgeAll(serviceID string, out io.Writer) error {
+func (c *PurgeCommand) purgeAll(serviceID string, out io.Writer) error {
 	p, err := c.Globals.APIClient.PurgeAll(context.TODO(), &fastly.PurgeAllInput{
 		ServiceID: serviceID,
 	})
@@ -152,7 +152,7 @@ func (c *RootCommand) purgeAll(serviceID string, out io.Writer) error {
 // purgeKey now uses the bulk purge endpoint to avoid serialization of the 'key' field values.
 // This serialization occurs due to the nature of the POST /service/{service_id}/purge/{surrogate_key}
 // endpoint storing the 'key' as part of the URL.
-func (c *RootCommand) purgeKey(serviceID string, out io.Writer) error {
+func (c *PurgeCommand) purgeKey(serviceID string, out io.Writer) error {
 	m, err := c.Globals.APIClient.PurgeKeys(context.TODO(), &fastly.PurgeKeysInput{
 		ServiceID: serviceID,
 		Keys:      []string{c.key},
@@ -177,7 +177,7 @@ func (c *RootCommand) purgeKey(serviceID string, out io.Writer) error {
 	return nil
 }
 
-func (c *RootCommand) purgeKeys(serviceID string, out io.Writer) error {
+func (c *PurgeCommand) purgeKeys(serviceID string, out io.Writer) error {
 	keys, err := populateKeys(c.file, c.Globals.ErrLog)
 	if err != nil {
 		c.Globals.ErrLog.AddWithContext(err, map[string]any{
@@ -189,7 +189,7 @@ func (c *RootCommand) purgeKeys(serviceID string, out io.Writer) error {
 	return c.purgeBulkKeys(serviceID, keys, out)
 }
 
-func (c *RootCommand) purgeBulkKeys(serviceID string, keys []string, out io.Writer) error {
+func (c *PurgeCommand) purgeBulkKeys(serviceID string, keys []string, out io.Writer) error {
 	m, err := c.Globals.APIClient.PurgeKeys(context.TODO(), &fastly.PurgeKeysInput{
 		ServiceID: serviceID,
 		Keys:      keys,
@@ -220,7 +220,7 @@ func (c *RootCommand) purgeBulkKeys(serviceID string, keys []string, out io.Writ
 	return nil
 }
 
-func (c *RootCommand) purgeURL(out io.Writer) error {
+func (c *PurgeCommand) purgeURL(out io.Writer) error {
 	p, err := c.Globals.APIClient.Purge(context.TODO(), &fastly.PurgeInput{
 		URL:  c.url,
 		Soft: c.soft,

pkg/commands/purge/root.go pkg/commands/service/purge/purge.gopkg/commands/purge/root.go renamed to pkg/commands/service/purge/purge.go

@@ -7,7 +7,8 @@ import (
 
 	"github.com/fastly/go-fastly/v12/fastly"
 
-	root "github.com/fastly/cli/pkg/commands/purge"
+	root "github.com/fastly/cli/pkg/commands/service"
+	purge "github.com/fastly/cli/pkg/commands/service/purge"
 	"github.com/fastly/cli/pkg/mock"
 	"github.com/fastly/cli/pkg/testutil"
 )
@@ -53,7 +54,7 @@ func TestPurgeAll(t *testing.T) {
 		},
 	}
 
-	testutil.RunCLIScenarios(t, []string{root.CommandName}, scenarios)
+	testutil.RunCLIScenarios(t, []string{root.CommandName, purge.CommandName}, scenarios)
 }
 
 func TestPurgeKeys(t *testing.T) {
@@ -103,7 +104,7 @@ func TestPurgeKeys(t *testing.T) {
 		},
 	}
 
-	testutil.RunCLIScenarios(t, []string{root.CommandName}, scenarios)
+	testutil.RunCLIScenarios(t, []string{root.CommandName, purge.CommandName}, scenarios)
 	assertKeys(keys, t)
 }
 
@@ -167,7 +168,7 @@ func TestPurgeKey(t *testing.T) {
 		},
 	}
 
-	testutil.RunCLIScenarios(t, []string{root.CommandName}, scenarios)
+	testutil.RunCLIScenarios(t, []string{root.CommandName, purge.CommandName}, scenarios)
 }
 
 func TestPurgeURL(t *testing.T) {
@@ -217,5 +218,5 @@ func TestPurgeURL(t *testing.T) {
 		},
 	}
 
-	testutil.RunCLIScenarios(t, []string{root.CommandName}, scenarios)
+	testutil.RunCLIScenarios(t, []string{root.CommandName, purge.CommandName}, scenarios)
 }