add(sctool CLI): add BackupPurge support

Author: dkropachev

pkg/cmd/sctool/sctool.go

@@ -10,6 +10,7 @@ import (
 	"github.com/scylladb/scylla-manager/v3/pkg/command/backup"
 	"github.com/scylladb/scylla-manager/v3/pkg/command/backup/backupdelete"
 	"github.com/scylladb/scylla-manager/v3/pkg/command/backup/backuplist"
+	"github.com/scylladb/scylla-manager/v3/pkg/command/backup/backuppurge"
 	"github.com/scylladb/scylla-manager/v3/pkg/command/backup/backupvalidate"
 	"github.com/scylladb/scylla-manager/v3/pkg/command/cluster/clusteradd"
 	"github.com/scylladb/scylla-manager/v3/pkg/command/cluster/clusterdelete"
@@ -56,6 +57,7 @@ func buildCommand() *cobra.Command {
 
 	backupCmd := backup.NewCommand(&client)
 	backupCmd.AddCommand(
+		backuppurge.NewCommand(&client),
 		backupdelete.NewCommand(&client),
 		backupfiles.NewCommand(&client),
 		backuplist.NewCommand(&client),

pkg/command/backup/backuppurge/cmd.go

@@ -0,0 +1,64 @@
+// Copyright (C) 2017 ScyllaDB
+
+package backuppurge
+
+import (
+	_ "embed"
+	"fmt"
+	"time"
+
+	"github.com/spf13/cobra"
+	"go.uber.org/atomic"
+	"gopkg.in/yaml.v2"
+
+	"github.com/scylladb/scylla-manager/v3/pkg/command/flag"
+	"github.com/scylladb/scylla-manager/v3/pkg/managerclient"
+)
+
+//go:embed res.yaml
+var res []byte
+
+type command struct {
+	cobra.Command
+	client   *managerclient.Client
+	dryRun   bool
+	cluster  string
+	location []string
+}
+
+func NewCommand(client *managerclient.Client) *cobra.Command {
+	cmd := &command{
+		client: client,
+	}
+	if err := yaml.Unmarshal(res, &cmd.Command); err != nil {
+		panic(err)
+	}
+
+	defer flag.MustSetUsages(&cmd.Command, res, "cluster")
+	cmd.init()
+	cmd.RunE = func(_ *cobra.Command, args []string) error {
+		return cmd.run()
+	}
+	return &cmd.Command
+}
+
+func (cmd *command) init() {
+	w := flag.Wrap(cmd.Flags())
+	w.Cluster(&cmd.cluster)
+	w.Location(&cmd.location)
+	w.DryRun(&cmd.dryRun)
+}
+
+func (cmd *command) run() error {
+	stillWaiting := atomic.NewBool(true)
+	time.AfterFunc(5*time.Second, func() {
+		if stillWaiting.Load() {
+			fmt.Fprintf(cmd.OutOrStderr(), "NOTICE: this may take a while, we are reading metadata from backup location(s)\n")
+		}
+	})
+	resp, err := cmd.client.PurgeBackups(cmd.Context(), cmd.cluster, cmd.location, cmd.dryRun)
+	if err != nil {
+		return err
+	}
+	return resp.Render(cmd.OutOrStdout())
+}

pkg/command/backup/backuppurge/res.yaml

@@ -0,0 +1,15 @@
+use: purge --cluster <id|name> [--location [<dc>:]<provider>:<bucket>] [--dry-run] [flags]
+
+short: Purge backup files in remote locations
+
+long: |
+  Purge stale backup data and meta files in remote locations for provided cluster.
+  That is data and files of:
+  - temporary manifests,
+  - manifests over task days retention days policy,
+  - manifests over task retention policy,
+  - manifests of deleted tasks.
+  It`s return information from manifests of deleted files.
+
+location: |
+  If no location provided - locations gets from all tasks

pkg/command/flag/flag.go

@@ -115,6 +115,10 @@ func (w Wrapper) Location(p *[]string) {
 	w.fs.StringSliceVarP(p, "location", "L", nil, usage["location"])
 }
 
+func (w Wrapper) DryRun(p *bool) {
+	w.fs.BoolVarP(p, "dry-run", "d", false, usage["dry-run"])
+}
+
 //
 // Task schedule flags
 //

pkg/command/flag/usage.yaml

@@ -19,6 +19,9 @@ dc: |
 fail-fast: |
   Stops the task run on the first error.
 
+dry-run: |
+  In dry-run mode no any changes will be done, result be returned like with changes.
+
 keyspace: |
   A list of `glob` patterns separated by a comma used to include or exclude tables.
   The patterns match keyspaces and tables, separate the keyspace name from the table name with a dot e.g. ``keyspace,!keyspace.table_prefix_*``.