5d13f4e6b8
## Description Adds boilerplate backup (create, list, delete) cli commands for sharepoint. ## Type of change - [x] 🌻 Feature ## Issue(s) * #1506 ## Test Plan - [x] 💪 Manual - [x] ⚡ Unit test
285 lines
7.9 KiB
Go
285 lines
7.9 KiB
Go
package backup
|
|
|
|
import (
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/cobra"
|
|
"github.com/spf13/pflag"
|
|
|
|
"github.com/alcionai/corso/src/cli/config"
|
|
"github.com/alcionai/corso/src/cli/options"
|
|
. "github.com/alcionai/corso/src/cli/print"
|
|
"github.com/alcionai/corso/src/cli/utils"
|
|
"github.com/alcionai/corso/src/internal/kopia"
|
|
"github.com/alcionai/corso/src/internal/model"
|
|
"github.com/alcionai/corso/src/pkg/backup"
|
|
"github.com/alcionai/corso/src/pkg/path"
|
|
"github.com/alcionai/corso/src/pkg/repository"
|
|
"github.com/alcionai/corso/src/pkg/selectors"
|
|
"github.com/alcionai/corso/src/pkg/store"
|
|
)
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
|
// setup and globals
|
|
// ------------------------------------------------------------------------------------------------
|
|
|
|
var (
|
|
site []string
|
|
|
|
sharepointData []string
|
|
)
|
|
|
|
const (
|
|
dataLibraries = "libraries"
|
|
)
|
|
|
|
const (
|
|
sharePointServiceCommand = "sharepoint"
|
|
sharePointServiceCommandCreateUseSuffix = "--site <siteId> | '" + utils.Wildcard + "'"
|
|
sharePointServiceCommandDeleteUseSuffix = "--backup <backupId>"
|
|
// sharePointServiceCommandDetailsUseSuffix = "--backup <backupId>"
|
|
)
|
|
|
|
const (
|
|
sharePointServiceCommandCreateExamples = `# Backup SharePoint data for <site>
|
|
corso backup create sharepoint --site <site_id>
|
|
|
|
# Backup SharePoint for Alice and Bob
|
|
corso backup create sharepoint --site <site_id_1>,<site_id_2>
|
|
|
|
# TODO: Site IDs may contain commas. We'll need to warn the site about escaping them.
|
|
|
|
# Backup all SharePoint data for all sites
|
|
corso backup create sharepoint --site '*'`
|
|
|
|
sharePointServiceCommandDeleteExamples = `# Delete SharePoint backup with ID 1234abcd-12ab-cd34-56de-1234abcd
|
|
corso backup delete sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd`
|
|
|
|
// sharePointServiceCommandDetailsExamples = `# Explore <site>'s files from backup 1234abcd-12ab-cd34-56de-1234abcd
|
|
//
|
|
// corso backup details sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd --site <site_id>`
|
|
)
|
|
|
|
// called by backup.go to map parent subcommands to provider-specific handling.
|
|
func addSharePointCommands(parent *cobra.Command) *cobra.Command {
|
|
var (
|
|
c *cobra.Command
|
|
fs *pflag.FlagSet
|
|
)
|
|
|
|
switch parent.Use {
|
|
case createCommand:
|
|
c, fs = utils.AddCommand(parent, sharePointCreateCmd(), utils.HideCommand())
|
|
|
|
c.Use = c.Use + " " + sharePointServiceCommandCreateUseSuffix
|
|
c.Example = sharePointServiceCommandCreateExamples
|
|
|
|
fs.StringArrayVar(&site,
|
|
utils.SiteFN, nil,
|
|
"Backup SharePoint data by site ID; accepts '"+utils.Wildcard+"' to select all sites. (required)")
|
|
// TODO: implement
|
|
fs.StringSliceVar(
|
|
&sharepointData,
|
|
utils.DataFN, nil,
|
|
"Select one or more types of data to backup: "+dataLibraries)
|
|
options.AddOperationFlags(c)
|
|
|
|
case listCommand:
|
|
c, fs = utils.AddCommand(parent, sharePointListCmd(), utils.HideCommand())
|
|
|
|
fs.StringVar(&backupID,
|
|
"backup", "",
|
|
"ID of the backup to retrieve.")
|
|
|
|
// case detailsCommand:
|
|
// c, fs = utils.AddCommand(parent, sharePointDetailsCmd())
|
|
|
|
case deleteCommand:
|
|
c, fs = utils.AddCommand(parent, sharePointDeleteCmd(), utils.HideCommand())
|
|
|
|
c.Use = c.Use + " " + sharePointServiceCommandDeleteUseSuffix
|
|
c.Example = sharePointServiceCommandDeleteExamples
|
|
|
|
fs.StringVar(&backupID,
|
|
utils.BackupFN, "",
|
|
"ID of the backup to delete. (required)")
|
|
cobra.CheckErr(c.MarkFlagRequired(utils.BackupFN))
|
|
}
|
|
|
|
return c
|
|
}
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
|
// backup create
|
|
// ------------------------------------------------------------------------------------------------
|
|
|
|
// `corso backup create sharepoint [<flag>...]`
|
|
func sharePointCreateCmd() *cobra.Command {
|
|
return &cobra.Command{
|
|
Use: sharePointServiceCommand,
|
|
Short: "Backup M365 SharePoint service data",
|
|
RunE: createSharePointCmd,
|
|
Args: cobra.NoArgs,
|
|
Example: sharePointServiceCommandCreateExamples,
|
|
}
|
|
}
|
|
|
|
// processes an sharepoint service backup.
|
|
func createSharePointCmd(cmd *cobra.Command, args []string) error {
|
|
ctx := cmd.Context()
|
|
|
|
if utils.HasNoFlagsAndShownHelp(cmd) {
|
|
return nil
|
|
}
|
|
|
|
if err := validateSharePointBackupCreateFlags(site); err != nil {
|
|
return err
|
|
}
|
|
|
|
s, acct, err := config.GetStorageAndAccount(ctx, true, nil)
|
|
if err != nil {
|
|
return Only(ctx, err)
|
|
}
|
|
|
|
r, err := repository.Connect(ctx, acct, s, options.Control())
|
|
if err != nil {
|
|
return Only(ctx, errors.Wrapf(err, "Failed to connect to the %s repository", s.Provider))
|
|
}
|
|
|
|
defer utils.CloseRepo(ctx, r)
|
|
|
|
sel := sharePointBackupCreateSelectors(site)
|
|
|
|
bo, err := r.NewBackup(ctx, sel)
|
|
if err != nil {
|
|
return Only(ctx, errors.Wrap(err, "Failed to initialize SharePoint backup"))
|
|
}
|
|
|
|
err = bo.Run(ctx)
|
|
if err != nil {
|
|
return Only(ctx, errors.Wrap(err, "Failed to run SharePoint backup"))
|
|
}
|
|
|
|
bu, err := r.Backup(ctx, bo.Results.BackupID)
|
|
if err != nil {
|
|
return errors.Wrap(err, "Unable to retrieve backup results from storage")
|
|
}
|
|
|
|
bu.Print(ctx)
|
|
|
|
return nil
|
|
}
|
|
|
|
func validateSharePointBackupCreateFlags(sites []string) error {
|
|
if len(sites) == 0 {
|
|
return errors.New("requires one or more --site ids or the wildcard --site *")
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func sharePointBackupCreateSelectors(sites []string) selectors.Selector {
|
|
sel := selectors.NewSharePointBackup()
|
|
sel.Include(sel.Sites(sites))
|
|
|
|
return sel.Selector
|
|
}
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
|
// backup list
|
|
// ------------------------------------------------------------------------------------------------
|
|
|
|
// `corso backup list sharepoint [<flag>...]`
|
|
func sharePointListCmd() *cobra.Command {
|
|
return &cobra.Command{
|
|
Use: sharePointServiceCommand,
|
|
Short: "List the history of M365 SharePoint service backups",
|
|
RunE: listSharePointCmd,
|
|
Args: cobra.NoArgs,
|
|
}
|
|
}
|
|
|
|
// lists the history of backup operations
|
|
func listSharePointCmd(cmd *cobra.Command, args []string) error {
|
|
ctx := cmd.Context()
|
|
|
|
s, acct, err := config.GetStorageAndAccount(ctx, true, nil)
|
|
if err != nil {
|
|
return Only(ctx, err)
|
|
}
|
|
|
|
r, err := repository.Connect(ctx, acct, s, options.Control())
|
|
if err != nil {
|
|
return Only(ctx, errors.Wrapf(err, "Failed to connect to the %s repository", s.Provider))
|
|
}
|
|
|
|
defer utils.CloseRepo(ctx, r)
|
|
|
|
if len(backupID) > 0 {
|
|
b, err := r.Backup(ctx, model.StableID(backupID))
|
|
if err != nil {
|
|
if errors.Is(err, kopia.ErrNotFound) {
|
|
return Only(ctx, errors.Errorf("No backup exists with the id %s", backupID))
|
|
}
|
|
|
|
return Only(ctx, errors.Wrap(err, "Failed to find backup "+backupID))
|
|
}
|
|
|
|
b.Print(ctx)
|
|
|
|
return nil
|
|
}
|
|
|
|
bs, err := r.Backups(ctx, store.Service(path.SharePointService))
|
|
if err != nil {
|
|
return Only(ctx, errors.Wrap(err, "Failed to list backups in the repository"))
|
|
}
|
|
|
|
backup.PrintAll(ctx, bs)
|
|
|
|
return nil
|
|
}
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
|
// backup delete
|
|
// ------------------------------------------------------------------------------------------------
|
|
|
|
// `corso backup delete sharepoint [<flag>...]`
|
|
func sharePointDeleteCmd() *cobra.Command {
|
|
return &cobra.Command{
|
|
Use: sharePointServiceCommand,
|
|
Short: "Delete backed-up M365 SharePoint service data",
|
|
RunE: deleteSharePointCmd,
|
|
Args: cobra.NoArgs,
|
|
Example: sharePointServiceCommandDeleteExamples,
|
|
}
|
|
}
|
|
|
|
// deletes a sharePoint service backup.
|
|
func deleteSharePointCmd(cmd *cobra.Command, args []string) error {
|
|
ctx := cmd.Context()
|
|
|
|
if utils.HasNoFlagsAndShownHelp(cmd) {
|
|
return nil
|
|
}
|
|
|
|
s, acct, err := config.GetStorageAndAccount(ctx, true, nil)
|
|
if err != nil {
|
|
return Only(ctx, err)
|
|
}
|
|
|
|
r, err := repository.Connect(ctx, acct, s, options.Control())
|
|
if err != nil {
|
|
return Only(ctx, errors.Wrapf(err, "Failed to connect to the %s repository", s.Provider))
|
|
}
|
|
|
|
defer utils.CloseRepo(ctx, r)
|
|
|
|
if err := r.DeleteBackup(ctx, model.StableID(backupID)); err != nil {
|
|
return Only(ctx, errors.Wrapf(err, "Deleting backup %s", backupID))
|
|
}
|
|
|
|
Info(ctx, "Deleted SharePoint backup ", backupID)
|
|
|
|
return nil
|
|
}
|