Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Print storage names in backup-list #1538

Merged
merged 6 commits into from
Sep 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/fdb/backup_list.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ var backupListCmd = &cobra.Command{
Run: func(cmd *cobra.Command, args []string) {
folder, err := internal.ConfigureFolder()
tracelog.ErrorLogger.FatalOnError(err)
internal.DefaultHandleBackupList(folder.GetSubFolder(utility.BaseBackupPath), false, false)
internal.HandleDefaultBackupList(folder.GetSubFolder(utility.BaseBackupPath), false, false)
},
}

Expand Down
2 changes: 1 addition & 1 deletion cmd/gp/backup_list.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ var (
if detail {
greenplum.HandleDetailedBackupList(folder, pretty, jsonOutput)
} else {
internal.DefaultHandleBackupList(folder.GetSubFolder(utility.BaseBackupPath), pretty, jsonOutput)
internal.HandleDefaultBackupList(folder.GetSubFolder(utility.BaseBackupPath), pretty, jsonOutput)
}
},
}
Expand Down
2 changes: 1 addition & 1 deletion cmd/mongo/backup_list.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ var backupListCmd = &cobra.Command{
err := mongo.HandleDetailedBackupList(backupFolder, os.Stdout, prettyPrint, jsonFormat)
tracelog.ErrorLogger.FatalOnError(err)
} else {
internal.DefaultHandleBackupList(backupFolder, prettyPrint, jsonFormat)
internal.HandleDefaultBackupList(backupFolder, prettyPrint, jsonFormat)
}
},
}
Expand Down
2 changes: 1 addition & 1 deletion cmd/mysql/backup_list.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ var (
if detail {
mysql.HandleDetailedBackupList(folder.GetSubFolder(utility.BaseBackupPath), pretty, json)
} else {
internal.DefaultHandleBackupList(folder.GetSubFolder(utility.BaseBackupPath), pretty, json)
internal.HandleDefaultBackupList(folder.GetSubFolder(utility.BaseBackupPath), pretty, json)
}
},
}
Expand Down
41 changes: 32 additions & 9 deletions cmd/pg/backup_list.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,14 @@ import (
"github.com/wal-g/tracelog"
"github.com/wal-g/wal-g/internal"
"github.com/wal-g/wal-g/internal/databases/postgres"
"github.com/wal-g/wal-g/internal/multistorage"
"github.com/wal-g/wal-g/internal/multistorage/cache"
"github.com/wal-g/wal-g/internal/multistorage/policies"
"github.com/wal-g/wal-g/utility"
)

const (
backupListShortDescription = "Prints available backups"
backupListShortDescription = "Prints full list of backups from which recovery is available"
PrettyFlag = "pretty"
JSONFlag = "json"
DetailFlag = "detail"
Expand All @@ -19,15 +22,32 @@ var (
// backupListCmd represents the backupList command
backupListCmd = &cobra.Command{
Use: "backup-list",
Short: backupListShortDescription, // TODO : improve description
Short: backupListShortDescription,
Args: cobra.NoArgs,
Run: func(cmd *cobra.Command, args []string) {
folder, err := internal.ConfigureFolder()
Run: func(cmd *cobra.Command, _ []string) {
primaryStorage, err := internal.ConfigureFolder()
tracelog.ErrorLogger.FatalOnError(err)

failoverStorages, err := internal.InitFailoverStorages()
tracelog.ErrorLogger.FatalOnError(err)

cacheLifetime, err := internal.GetDurationSetting(internal.PgFailoverStorageCacheLifetime)
tracelog.ErrorLogger.FatalOnError(err)
aliveCheckTimeout, err := internal.GetDurationSetting(internal.PgFailoverStoragesCheckTimeout)
tracelog.ErrorLogger.FatalOnError(err)
cache, err := cache.NewStatusCache(primaryStorage, failoverStorages, cacheLifetime, aliveCheckTimeout)
tracelog.ErrorLogger.FatalOnError(err)

folder := multistorage.NewFolder(cache)
folder = multistorage.SetPolicies(folder, policies.UniteAllStorages)
folder, err = multistorage.UseAllAliveStorages(folder)
tracelog.ErrorLogger.FatalOnError(err)

backupsFolder := folder.GetSubFolder(utility.BaseBackupPath)
if detail {
postgres.HandleDetailedBackupList(folder.GetSubFolder(utility.BaseBackupPath), pretty, json)
postgres.HandleDetailedBackupList(backupsFolder, pretty, json)
} else {
internal.DefaultHandleBackupList(folder.GetSubFolder(utility.BaseBackupPath), pretty, json)
internal.HandleDefaultBackupList(backupsFolder, pretty, json)
}
},
}
Expand All @@ -41,7 +61,10 @@ func init() {

// TODO: Merge similar backup-list functionality
// to avoid code duplication in command handlers
backupListCmd.Flags().BoolVar(&pretty, PrettyFlag, false, "Prints more readable output")
backupListCmd.Flags().BoolVar(&json, JSONFlag, false, "Prints output in json format")
backupListCmd.Flags().BoolVar(&detail, DetailFlag, false, "Prints extra backup details")
backupListCmd.Flags().BoolVar(&pretty, PrettyFlag, false,
"Prints more readable output in table format")
backupListCmd.Flags().BoolVar(&json, JSONFlag, false,
"Prints output in JSON format, multiline and indented if combined with --pretty flag")
backupListCmd.Flags().BoolVar(&detail, DetailFlag, false,
"Prints extra DB-specific backup details")
}
2 changes: 1 addition & 1 deletion cmd/pg/catchup_list.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ var (
if detail {
postgres.HandleDetailedBackupList(folder.GetSubFolder(utility.CatchupPath), pretty, json)
} else {
internal.DefaultHandleBackupList(folder.GetSubFolder(utility.CatchupPath), pretty, json)
internal.HandleDefaultBackupList(folder.GetSubFolder(utility.CatchupPath), pretty, json)
}
},
}
Expand Down
2 changes: 1 addition & 1 deletion cmd/redis/backup_list.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ var (
if detail {
redis.HandleDetailedBackupList(folder.GetSubFolder(utility.BaseBackupPath), pretty, json)
} else {
internal.DefaultHandleBackupList(folder.GetSubFolder(utility.BaseBackupPath), pretty, json)
internal.HandleDefaultBackupList(folder.GetSubFolder(utility.BaseBackupPath), pretty, json)
}
},
}
Expand Down
2 changes: 1 addition & 1 deletion cmd/sqlserver/backup_list.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ var backupListCmd = &cobra.Command{
folder, err := internal.ConfigureFolder()
tracelog.ErrorLogger.FatalOnError(err)
// todo: implement pretty and json logic
internal.DefaultHandleBackupList(folder.GetSubFolder(utility.BaseBackupPath), false, false)
internal.HandleDefaultBackupList(folder.GetSubFolder(utility.BaseBackupPath), false, false)
},
}

Expand Down
102 changes: 13 additions & 89 deletions internal/backup_list_handler.go
Original file line number Diff line number Diff line change
@@ -1,104 +1,28 @@
package internal

import (
"encoding/json"
"fmt"
"io"
"os"
"text/tabwriter"

"github.com/jedib0t/go-pretty/table"
"github.com/wal-g/tracelog"
"github.com/wal-g/wal-g/internal/printlist"
"github.com/wal-g/wal-g/pkg/storages/storage"
)

type InfoLogger interface {
Println(v ...interface{})
}

type ErrorLogger interface {
FatalOnError(err error)
}

type Logging struct {
InfoLogger InfoLogger
ErrorLogger ErrorLogger
}

func DefaultHandleBackupList(folder storage.Folder, pretty, json bool) {
getBackupsFunc := func() ([]BackupTime, error) {
res, err := GetBackups(folder)
if _, ok := err.(NoBackupsFoundError); ok {
err = nil
}
return res, err
}
writeBackupListFunc := func(backups []BackupTime) {
SortBackupTimeSlices(backups)
switch {
case json:
err := WriteAsJSON(backups, os.Stdout, pretty)
tracelog.ErrorLogger.FatalOnError(err)
case pretty:
WritePrettyBackupList(backups, os.Stdout)
default:
WriteBackupList(backups, os.Stdout)
}
}
logging := Logging{
InfoLogger: tracelog.InfoLogger,
ErrorLogger: tracelog.ErrorLogger,
}

HandleBackupList(getBackupsFunc, writeBackupListFunc, logging)
}

func HandleBackupList(
getBackupsFunc func() ([]BackupTime, error),
writeBackupListFunc func([]BackupTime),
logging Logging,
) {
backups, err := getBackupsFunc()
logging.ErrorLogger.FatalOnError(err)

if len(backups) == 0 {
logging.InfoLogger.Println("No backups found")
func HandleDefaultBackupList(folder storage.Folder, pretty, json bool) {
backupTimes, err := GetBackups(folder)
_, noBackupsErr := err.(NoBackupsFoundError)
if noBackupsErr {
tracelog.InfoLogger.Println("No backups found")
return
}
tracelog.ErrorLogger.FatalfOnError("Get backups from folder: %v", err)

writeBackupListFunc(backups)
}

func WriteBackupList(backups []BackupTime, output io.Writer) {
writer := tabwriter.NewWriter(output, 0, 0, 1, ' ', 0)
defer writer.Flush()
fmt.Fprintln(writer, "name\tmodified\twal_segment_backup_start")
for _, b := range backups {
fmt.Fprintf(writer, "%v\t%v\t%v\n", b.BackupName, FormatTime(b.Time), b.WalFileName)
}
}

func WritePrettyBackupList(backups []BackupTime, output io.Writer) {
writer := table.NewWriter()
writer.SetOutputMirror(output)
defer writer.Render()
writer.AppendHeader(table.Row{"#", "Name", "Modified", "WAL segment backup start"})
for i, b := range backups {
writer.AppendRow(table.Row{i, b.BackupName, PrettyFormatTime(b.Time), b.WalFileName})
}
}
SortBackupTimeSlices(backupTimes)

func WriteAsJSON(data interface{}, output io.Writer, pretty bool) error {
var bytes []byte
var err error
if pretty {
bytes, err = json.MarshalIndent(data, "", " ")
} else {
bytes, err = json.Marshal(data)
}
if err != nil {
return err
printableEntities := make([]printlist.Entity, len(backupTimes))
for i := range backupTimes {
printableEntities[i] = backupTimes[i]
}
_, err = output.Write(bytes)
return err
err = printlist.List(printableEntities, os.Stdout, pretty, json)
tracelog.ErrorLogger.FatalfOnError("Print backups: %v", err)
}