mirror/kopia
1
0
Fork 0
mirror of https://github.com/kopia/kopia.git synced 2026-03-24 09:04:04 -04:00
Code Issues Packages Projects Releases Wiki Activity

repo: refactored read/write methods of repo.Repository (#749)

Browse Source 
Reader methods go to repo.Reader and write methods go to repo.Writer
Switched usage to new interfaces based on linter errors.
This commit is contained in:
Jarek Kowalski
2021-01-04 21:33:12 -08:00
committed by GitHub
parent d947f795f4
commit 5e8e175cfa
48 changed files with 164 additions and 146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
cli/app.go
View File

@@ -106,6 +106,18 @@ func repositoryAction(act func(ctx context.Context, rep repo.Repository) error)
return maybeRepositoryAction(act, true)
}
func repositoryReaderAction(act func(ctx context.Context, rep repo.Reader) error) func(ctx *kingpin.ParseContext) error {
return maybeRepositoryAction(func(ctx context.Context, rep repo.Repository) error {
return act(ctx, rep)
}, true)
}
func repositoryWriterAction(act func(ctx context.Context, rep repo.Writer) error) func(ctx *kingpin.ParseContext) error {
return maybeRepositoryAction(func(ctx context.Context, rep repo.Repository) error {
return act(ctx, rep)
}, true)
}
func rootContext() context.Context {
ctx := context.Background()
ctx = content.UsingContentCache(ctx, *enableCaching)
@@ -162,7 +174,7 @@ func maybeRepositoryAction(act func(ctx context.Context, rep repo.Repository) er
}
}
func maybeRunMaintenance(ctx context.Context, rep repo.Repository) error {
func maybeRunMaintenance(ctx context.Context, rep repo.Writer) error {
if !*enableAutomaticMaintenance {
return nil
}

2
cli/auto_upgrade.go
View File

@@ -9,7 +9,7 @@
"github.com/kopia/kopia/repo/maintenance"
)
func maybeAutoUpgradeRepository(ctx context.Context, r repo.Repository) {
func maybeAutoUpgradeRepository(ctx context.Context, r repo.Writer) {
if r == nil {
return
}

5
cli/command_benchmark_compression.go
View File

@@ -11,7 +11,6 @@
"github.com/kopia/kopia/internal/clock"
"github.com/kopia/kopia/internal/units"
"github.com/kopia/kopia/repo"
"github.com/kopia/kopia/repo/compression"
)
@@ -24,7 +23,7 @@
benchmarkCompressionVerifyStable = benchmarkCompressionCommand.Flag("verify-stable", "Verify that compression is stable").Bool()
)
func runBenchmarkCompressionAction(ctx context.Context, rep repo.Repository) error {
func runBenchmarkCompressionAction(ctx context.Context) error {
type benchResult struct {
compression compression.Name
throughput float64
@@ -106,7 +105,7 @@ type benchResult struct {
}
func init() {
benchmarkCompressionCommand.Action(maybeRepositoryAction(runBenchmarkCompressionAction, false))
benchmarkCompressionCommand.Action(noRepositoryAction(runBenchmarkCompressionAction))
}
func hashOf(b []byte) uint64 {

5
cli/command_benchmark_crypto.go
View File

@@ -6,7 +6,6 @@
"github.com/kopia/kopia/internal/clock"
"github.com/kopia/kopia/internal/units"
"github.com/kopia/kopia/repo"
"github.com/kopia/kopia/repo/content"
"github.com/kopia/kopia/repo/encryption"
"github.com/kopia/kopia/repo/hashing"
@@ -19,7 +18,7 @@
benchmarkCryptoDeprecatedAlgorithms = benchmarkCryptoCommand.Flag("deprecated", "Include deprecated algorithms").Bool()
)
func runBenchmarkCryptoAction(ctx context.Context, rep repo.Repository) error {
func runBenchmarkCryptoAction(ctx context.Context) error {
type benchResult struct {
hash string
encryption string
@@ -86,5 +85,5 @@ type benchResult struct {
}
func init() {
benchmarkCryptoCommand.Action(maybeRepositoryAction(runBenchmarkCryptoAction, false))
benchmarkCryptoCommand.Action(noRepositoryAction(runBenchmarkCryptoAction))
}

5
cli/command_benchmark_splitters.go
View File

@@ -9,7 +9,6 @@
"github.com/pkg/errors"
"github.com/kopia/kopia/internal/clock"
"github.com/kopia/kopia/repo"
"github.com/kopia/kopia/repo/splitter"
)
@@ -20,7 +19,7 @@
benchmarkSplitterBlockCount = benchmarkSplitterCommand.Flag("block-count", "Number of data blocks to split").Default("16").Int()
)
func runBenchmarkSplitterAction(ctx context.Context, rep repo.Repository) error {
func runBenchmarkSplitterAction(ctx context.Context) error {
type benchResult struct {
splitter string
duration time.Duration
@@ -119,5 +118,5 @@ type benchResult struct {
}
func init() {
benchmarkSplitterCommand.Action(maybeRepositoryAction(runBenchmarkSplitterAction, false))
benchmarkSplitterCommand.Action(noRepositoryAction(runBenchmarkSplitterAction))
}

4
cli/command_diff.go
View File

@@ -21,7 +21,7 @@
diffCommandCommand = diffCommand.Flag("diff-command", "Displays differences between two repository objects (files or directories)").Default(defaultDiffCommand()).Envar("KOPIA_DIFF").String()
)
func runDiffCommand(ctx context.Context, rep repo.Repository) error {
func runDiffCommand(ctx context.Context, rep repo.Reader) error {
ent1, err := snapshotfs.FilesystemEntryFromIDWithPath(ctx, rep, *diffFirstObjectPath, false)
if err != nil {
return errors.Wrapf(err, "error getting filesystem entry for %v", *diffFirstObjectPath)
@@ -67,5 +67,5 @@ func defaultDiffCommand() string {
}
func init() {
diffCommand.Action(repositoryAction(runDiffCommand))
diffCommand.Action(repositoryReaderAction(runDiffCommand))
}

4
cli/command_ls.go
View File

@@ -24,7 +24,7 @@
lsCommandPath = lsCommand.Arg("object-path", "Path").Required().String()
)
func runLSCommand(ctx context.Context, rep repo.Repository) error {
func runLSCommand(ctx context.Context, rep repo.Reader) error {
dir, err := snapshotfs.FilesystemDirectoryFromIDWithPath(ctx, rep, *lsCommandPath, false)
if err != nil {
return errors.Wrap(err, "unable to get filesystem directory entry")
@@ -42,7 +42,7 @@ func runLSCommand(ctx context.Context, rep repo.Repository) error {
}
func init() {
lsCommand.Action(repositoryAction(runLSCommand))
lsCommand.Action(repositoryReaderAction(runLSCommand))
}
func listDirectory(ctx context.Context, d fs.Directory, prefix, indent string) error {

4
cli/command_manifest_ls.go
View File

@@ -18,10 +18,10 @@
)
func init() {
manifestListCommand.Action(repositoryAction(listManifestItems))
manifestListCommand.Action(repositoryReaderAction(listManifestItems))
}
func listManifestItems(ctx context.Context, rep repo.Repository) error {
func listManifestItems(ctx context.Context, rep repo.Reader) error {
filter := map[string]string{}
for _, kv := range *manifestListFilter {

4
cli/command_manifest_rm.go
View File

@@ -13,7 +13,7 @@
manifestRemoveItems = manifestRemoveCommand.Arg("item", "Items to remove").Required().Strings()
)
func runManifestRemoveCommand(ctx context.Context, rep repo.Repository) error {
func runManifestRemoveCommand(ctx context.Context, rep repo.Writer) error {
advancedCommand(ctx)
for _, it := range toManifestIDs(*manifestRemoveItems) {
@@ -26,5 +26,5 @@ func runManifestRemoveCommand(ctx context.Context, rep repo.Repository) error {
}
func init() {
manifestRemoveCommand.Action(repositoryAction(runManifestRemoveCommand))
manifestRemoveCommand.Action(repositoryWriterAction(runManifestRemoveCommand))
}

4
cli/command_manifest_show.go
View File

@@ -17,7 +17,7 @@
)
func init() {
manifestShowCommand.Action(repositoryAction(showManifestItems))
manifestShowCommand.Action(repositoryReaderAction(showManifestItems))
}
func toManifestIDs(s []string) []manifest.ID {
@@ -30,7 +30,7 @@ func toManifestIDs(s []string) []manifest.ID {
return result
}
func showManifestItems(ctx context.Context, rep repo.Repository) error {
func showManifestItems(ctx context.Context, rep repo.Reader) error {
for _, it := range toManifestIDs(*manifestShowItems) {
var b json.RawMessage

4
cli/command_mount.go
View File

@@ -26,7 +26,7 @@
mountFuseAllowNonEmptyMount = mountCommand.Flag("fuse-allow-non-empty-mount", "Allows the mounting over a non-empty directory. The files in it will be shadowed by the freshly created mount.").Bool()
)
func runMountCommand(ctx context.Context, rep repo.Repository) error {
func runMountCommand(ctx context.Context, rep repo.Reader) error {
var entry fs.Directory
if *mountObjectID == "all" {
@@ -100,5 +100,5 @@ func runMountCommand(ctx context.Context, rep repo.Repository) error {
func init() {
setupFSCacheFlags(mountCommand)
mountCommand.Action(repositoryAction(runMountCommand))
mountCommand.Action(repositoryReaderAction(runMountCommand))
}

2
cli/command_policy.go
View File

@@ -11,7 +11,7 @@
"github.com/kopia/kopia/snapshot/policy"
)
func policyTargets(ctx context.Context, rep repo.Repository, globalFlag *bool, targetsFlag *[]string) ([]snapshot.SourceInfo, error) {
func policyTargets(ctx context.Context, rep repo.Reader, globalFlag *bool, targetsFlag *[]string) ([]snapshot.SourceInfo, error) {
if *globalFlag == (len(*targetsFlag) > 0) {
return nil, errors.New("must pass either '--global' or a list of path targets")
}

4
cli/command_policy_edit.go
View File

@@ -56,10 +56,10 @@
)
func init() {
policyEditCommand.Action(repositoryAction(editPolicy))
policyEditCommand.Action(repositoryWriterAction(editPolicy))
}
func editPolicy(ctx context.Context, rep repo.Repository) error {
func editPolicy(ctx context.Context, rep repo.Writer) error {
targets, err := policyTargets(ctx, rep, policyEditGlobal, policyEditTargets)
if err != nil {
return err

4
cli/command_policy_ls.go
View File

@@ -14,10 +14,10 @@
var policyListCommand = policyCommands.Command("list", "List policies.").Alias("ls")
func init() {
policyListCommand.Action(repositoryAction(listPolicies))
policyListCommand.Action(repositoryReaderAction(listPolicies))
}
func listPolicies(ctx context.Context, rep repo.Repository) error {
func listPolicies(ctx context.Context, rep repo.Reader) error {
policies, err := policy.ListPolicies(ctx, rep)
if err != nil {
return errors.Wrap(err, "error listing policies")

4
cli/command_policy_remove.go
View File

@@ -17,10 +17,10 @@
)
func init() {
policyRemoveCommand.Action(repositoryAction(removePolicy))
policyRemoveCommand.Action(repositoryWriterAction(removePolicy))
}
func removePolicy(ctx context.Context, rep repo.Repository) error {
func removePolicy(ctx context.Context, rep repo.Writer) error {
targets, err := policyTargets(ctx, rep, policyRemoveGlobal, policyRemoveTargets)
if err != nil {
return err

4
cli/command_policy_set.go
View File

@@ -27,10 +27,10 @@
)
func init() {
policySetCommand.Action(repositoryAction(setPolicy))
policySetCommand.Action(repositoryWriterAction(setPolicy))
}
func setPolicy(ctx context.Context, rep repo.Repository) error {
func setPolicy(ctx context.Context, rep repo.Writer) error {
targets, err := policyTargets(ctx, rep, policySetGlobal, policySetTargets)
if err != nil {
return err

4
cli/command_policy_show.go
View File

@@ -21,10 +21,10 @@
)
func init() {
policyShowCommand.Action(repositoryAction(showPolicy))
policyShowCommand.Action(repositoryReaderAction(showPolicy))
}
func showPolicy(ctx context.Context, rep repo.Repository) error {
func showPolicy(ctx context.Context, rep repo.Reader) error {
targets, err := policyTargets(ctx, rep, policyShowGlobal, policyShowTargets)
if err != nil {
return err

4
cli/command_repository_status.go
View File

@@ -21,7 +21,7 @@
statusReconnectTokenIncludePassword = statusCommand.Flag("reconnect-token-with-password", "Include password in reconnect token").Short('s').Bool()
)
func runStatusCommand(ctx context.Context, rep repo.Repository) error {
func runStatusCommand(ctx context.Context, rep repo.Reader) error {
fmt.Printf("Config file: %v\n", repositoryConfigFileName())
fmt.Println()
fmt.Printf("Description: %v\n", rep.ClientOptions().Description)
@@ -110,5 +110,5 @@ func scanCacheDir(dirname string) (fileCount int, totalFileLength int64, err err
}
func init() {
statusCommand.Action(repositoryAction(runStatusCommand))
statusCommand.Action(repositoryReaderAction(runStatusCommand))
}

4
cli/command_restore.go
View File

@@ -169,7 +169,7 @@ func printRestoreStats(ctx context.Context, st restore.Stats) {
log(ctx).Infof("Restored %v files, %v directories and %v symbolic links (%v)\n", st.RestoredFileCount, st.RestoredDirCount, st.RestoredSymlinkCount, units.BytesStringBase10(st.RestoredTotalFileSize))
}
func runRestoreCommand(ctx context.Context, rep repo.Repository) error {
func runRestoreCommand(ctx context.Context, rep repo.Reader) error {
output, err := restoreOutput(ctx)
if err != nil {
return errors.Wrap(err, "unable to initialize output")
@@ -224,5 +224,5 @@ func runRestoreCommand(ctx context.Context, rep repo.Repository) error {
func init() {
addRestoreFlags(restoreCommand)
restoreCommand.Action(repositoryAction(runRestoreCommand))
restoreCommand.Action(repositoryReaderAction(runRestoreCommand))
}

4
cli/command_show.go
View File

@@ -16,7 +16,7 @@
catCommandPath = catCommand.Arg("object-path", "Path").Required().String()
)
func runCatCommand(ctx context.Context, rep repo.Repository) error {
func runCatCommand(ctx context.Context, rep repo.Reader) error {
oid, err := snapshotfs.ParseObjectIDWithPath(ctx, rep, *catCommandPath)
if err != nil {
return errors.Wrapf(err, "unable to parse ID: %v", *catCommandPath)
@@ -35,5 +35,5 @@ func runCatCommand(ctx context.Context, rep repo.Repository) error {
}
func init() {
catCommand.Action(repositoryAction(runCatCommand))
catCommand.Action(repositoryReaderAction(runCatCommand))
}

8
cli/command_snapshot_copy_move_history.go
View File

@@ -71,7 +71,7 @@ func registerSnapshotCopyFlags(cmd *kingpin.CmdClause) {
// user1@host1:/path1 @host2 copy to user1@host2:/path1
// user1@host1:/path1 user2@host2 copy to user2@host2:/path1
// user1@host1:/path1 user2@host2:/path2 copy snapshots from single path.
func runSnapshotCopyCommand(ctx context.Context, rep repo.Repository, isMoveCommand bool) error {
func runSnapshotCopyCommand(ctx context.Context, rep repo.Writer, isMoveCommand bool) error {
si, di, err := getCopySourceAndDestination(rep)
if err != nil {
return err
@@ -150,7 +150,7 @@ func getCopySnapshotAction(isMoveCommand bool) string {
return action
}
func getCopySourceAndDestination(rep repo.Repository) (si, di snapshot.SourceInfo, err error) {
func getCopySourceAndDestination(rep repo.Writer) (si, di snapshot.SourceInfo, err error) {
si, err = snapshot.ParseSourceInfo(snapshotCopyOrMoveSource, rep.ClientOptions().Hostname, rep.ClientOptions().Username)
if err != nil {
return si, di, errors.Wrap(err, "invalid source")
@@ -231,12 +231,12 @@ func getCopyDestination(source, overrides snapshot.SourceInfo) snapshot.SourceIn
func init() {
registerSnapshotCopyFlags(snapshotCopyCommand)
snapshotCopyCommand.Action(repositoryAction(func(ctx context.Context, rep repo.Repository) error {
snapshotCopyCommand.Action(repositoryWriterAction(func(ctx context.Context, rep repo.Writer) error {
return runSnapshotCopyCommand(ctx, rep, false)
}))
registerSnapshotCopyFlags(snapshotMoveCommand)
snapshotMoveCommand.Action(repositoryAction(func(ctx context.Context, rep repo.Repository) error {
snapshotMoveCommand.Action(repositoryWriterAction(func(ctx context.Context, rep repo.Writer) error {
return runSnapshotCopyCommand(ctx, rep, true)
}))
}

12
cli/command_snapshot_create.go
View File

@@ -36,7 +36,7 @@
snapshotCreateForceDisableActions = snapshotCreateCommand.Flag("force-disable-actions", "Disable snapshot actions even if globally enabled on this client").Hidden().Bool()
)
func runSnapshotCommand(ctx context.Context, rep repo.Repository) error {
func runSnapshotCommand(ctx context.Context, rep repo.Writer) error {
sources := *snapshotCreateSources
maybeAutoUpgradeRepository(ctx, rep)
@@ -113,7 +113,7 @@ func validateStartEndTime(st, et string) error {
return nil
}
func setupUploader(rep repo.Repository) *snapshotfs.Uploader {
func setupUploader(rep repo.Writer) *snapshotfs.Uploader {
u := snapshotfs.NewUploader(rep)
u.MaxUploadBytes = *snapshotCreateCheckpointUploadLimitMB << 20 //nolint:gomnd
@@ -152,7 +152,7 @@ func startTimeAfterEndTime(startTime, endTime time.Time) bool {
startTime.After(endTime)
}
func snapshotSingleSource(ctx context.Context, rep repo.Repository, u *snapshotfs.Uploader, sourceInfo snapshot.SourceInfo) error {
func snapshotSingleSource(ctx context.Context, rep repo.Writer, u *snapshotfs.Uploader, sourceInfo snapshot.SourceInfo) error {
log(ctx).Infof("Snapshotting %v ...", sourceInfo)
t0 := clock.Now()
@@ -235,7 +235,7 @@ func snapshotSingleSource(ctx context.Context, rep repo.Repository, u *snapshotf
// findPreviousSnapshotManifest returns the list of previous snapshots for a given source, including
// last complete snapshot and possibly some number of incomplete snapshots following it.
func findPreviousSnapshotManifest(ctx context.Context, rep repo.Repository, sourceInfo snapshot.SourceInfo, noLaterThan *time.Time) ([]*snapshot.Manifest, error) {
func findPreviousSnapshotManifest(ctx context.Context, rep repo.Reader, sourceInfo snapshot.SourceInfo, noLaterThan *time.Time) ([]*snapshot.Manifest, error) {
man, err := snapshot.ListSnapshots(ctx, rep, sourceInfo)
if err != nil {
return nil, errors.Wrap(err, "error listing previous snapshots")
@@ -277,7 +277,7 @@ func findPreviousSnapshotManifest(ctx context.Context, rep repo.Repository, sour
return result, nil
}
func getLocalBackupPaths(ctx context.Context, rep repo.Repository) ([]string, error) {
func getLocalBackupPaths(ctx context.Context, rep repo.Reader) ([]string, error) {
log(ctx).Debugf("Looking for previous backups of '%v@%v'...", rep.ClientOptions().Hostname, rep.ClientOptions().Username)
sources, err := snapshot.ListSources(ctx, rep)
@@ -297,5 +297,5 @@ func getLocalBackupPaths(ctx context.Context, rep repo.Repository) ([]string, er
}
func init() {
snapshotCreateCommand.Action(repositoryAction(runSnapshotCommand))
snapshotCreateCommand.Action(repositoryWriterAction(runSnapshotCommand))
}

8
cli/command_snapshot_delete.go
View File

@@ -18,7 +18,7 @@
snapshotDeleteConfirm = snapshotDeleteCommand.Flag("delete", "Confirm deletion").Bool()
)
func runDeleteCommand(ctx context.Context, rep repo.Repository) error {
func runDeleteCommand(ctx context.Context, rep repo.Writer) error {
for _, id := range *snapshotDeleteIDs {
m, err := snapshot.LoadSnapshot(ctx, rep, manifest.ID(id))
if err == nil {
@@ -36,7 +36,7 @@ func runDeleteCommand(ctx context.Context, rep repo.Repository) error {
return nil
}
func deleteSnapshot(ctx context.Context, rep repo.Repository, m *snapshot.Manifest) error {
func deleteSnapshot(ctx context.Context, rep repo.Writer, m *snapshot.Manifest) error {
desc := fmt.Sprintf("snapshot %v of %v at %v", m.ID, m.Source, formatTimestamp(m.StartTime))
if !*snapshotDeleteConfirm {
@@ -49,7 +49,7 @@ func deleteSnapshot(ctx context.Context, rep repo.Repository, m *snapshot.Manife
return rep.DeleteManifest(ctx, m.ID)
}
func deleteSnapshotsByRootObjectID(ctx context.Context, rep repo.Repository, rootID object.ID) error {
func deleteSnapshotsByRootObjectID(ctx context.Context, rep repo.Writer, rootID object.ID) error {
manifests, err := snapshot.FindSnapshotsByRootObjectID(ctx, rep, rootID)
if err != nil {
return errors.Wrapf(err, "unable to find snapshots by root %v", rootID)
@@ -69,7 +69,7 @@ func deleteSnapshotsByRootObjectID(ctx context.Context, rep repo.Repository, roo
}
func init() {
snapshotDeleteCommand.Action(repositoryAction(runDeleteCommand))
snapshotDeleteCommand.Action(repositoryWriterAction(runDeleteCommand))
// hidden flag for backwards compatibility
snapshotDeleteCommand.Flag("unsafe-ignore-source", "Alias for --delete").Hidden().BoolVar(snapshotDeleteConfirm)

4
cli/command_snapshot_estimate.go
View File

@@ -64,7 +64,7 @@ func makeBuckets() buckets {
}
}
func runSnapshotEstimateCommand(ctx context.Context, rep repo.Repository) error {
func runSnapshotEstimateCommand(ctx context.Context, rep repo.Reader) error {
path, err := filepath.Abs(*snapshotEstimateSource)
if err != nil {
return errors.Errorf("invalid path: '%s': %s", path, err)
@@ -173,5 +173,5 @@ func estimate(ctx context.Context, relativePath string, entry fs.Entry, stats *s
}
func init() {
snapshotEstimate.Action(repositoryAction(runSnapshotEstimateCommand))
snapshotEstimate.Action(repositoryReaderAction(runSnapshotEstimateCommand))
}

6
cli/command_snapshot_expire.go
View File

@@ -19,7 +19,7 @@
snapshotExpireDelete = snapshotExpireCommand.Flag("delete", "Whether to actually delete snapshots").Bool()
)
func getSnapshotSourcesToExpire(ctx context.Context, rep repo.Repository) ([]snapshot.SourceInfo, error) {
func getSnapshotSourcesToExpire(ctx context.Context, rep repo.Reader) ([]snapshot.SourceInfo, error) {
if *snapshotExpireAll {
return snapshot.ListSources(ctx, rep)
}
@@ -38,7 +38,7 @@ func getSnapshotSourcesToExpire(ctx context.Context, rep repo.Repository) ([]sna
return result, nil
}
func runExpireCommand(ctx context.Context, rep repo.Repository) error {
func runExpireCommand(ctx context.Context, rep repo.Writer) error {
sources, err := getSnapshotSourcesToExpire(ctx, rep)
if err != nil {
return err
@@ -74,5 +74,5 @@ func runExpireCommand(ctx context.Context, rep repo.Repository) error {
}
func init() {
snapshotExpireCommand.Action(repositoryAction(runExpireCommand))
snapshotExpireCommand.Action(repositoryWriterAction(runExpireCommand))
}

14
cli/command_snapshot_list.go
View File

@@ -35,7 +35,7 @@
maxResultsPerPath = snapshotListCommand.Flag("max-results", "Maximum number of entries per source.").Short('n').Int()
)
func findSnapshotsForSource(ctx context.Context, rep repo.Repository, sourceInfo snapshot.SourceInfo) (manifestIDs []manifest.ID, relPath string, err error) {
func findSnapshotsForSource(ctx context.Context, rep repo.Reader, sourceInfo snapshot.SourceInfo) (manifestIDs []manifest.ID, relPath string, err error) {
for len(sourceInfo.Path) > 0 {
list, err := snapshot.ListSnapshotManifests(ctx, rep, &sourceInfo)
if err != nil {
@@ -65,7 +65,7 @@ func findSnapshotsForSource(ctx context.Context, rep repo.Repository, sourceInfo
return nil, "", nil
}
func findManifestIDs(ctx context.Context, rep repo.Repository, source string) ([]manifest.ID, string, error) {
func findManifestIDs(ctx context.Context, rep repo.Reader, source string) ([]manifest.ID, string, error) {
if source == "" {
man, err := snapshot.ListSnapshotManifests(ctx, rep, nil)
return man, "", errors.Wrap(err, "error listing all snapshot manifests")
@@ -84,7 +84,7 @@ func findManifestIDs(ctx context.Context, rep repo.Repository, source string) ([
return manifestIDs, relPath, err
}
func runSnapshotsCommand(ctx context.Context, rep repo.Repository) error {
func runSnapshotsCommand(ctx context.Context, rep repo.Reader) error {
manifestIDs, relPath, err := findManifestIDs(ctx, rep, *snapshotListPath)
if err != nil {
return err
@@ -98,7 +98,7 @@ func runSnapshotsCommand(ctx context.Context, rep repo.Repository) error {
return outputManifestGroups(ctx, rep, manifests, strings.Split(relPath, "/"))
}
func shouldOutputSnapshotSource(rep repo.Repository, src snapshot.SourceInfo) bool {
func shouldOutputSnapshotSource(rep repo.Reader, src snapshot.SourceInfo) bool {
if *snapshotListShowAll {
return true
}
@@ -112,7 +112,7 @@ func shouldOutputSnapshotSource(rep repo.Repository, src snapshot.SourceInfo) bo
return src.UserName == co.Username
}
func outputManifestGroups(ctx context.Context, rep repo.Repository, manifests []*snapshot.Manifest, relPathParts []string) error {
func outputManifestGroups(ctx context.Context, rep repo.Reader, manifests []*snapshot.Manifest, relPathParts []string) error {
separator := ""
var anyOutput bool
@@ -148,7 +148,7 @@ func outputManifestGroups(ctx context.Context, rep repo.Repository, manifests []
return nil
}
func outputManifestFromSingleSource(ctx context.Context, rep repo.Repository, manifests []*snapshot.Manifest, parts []string) error {
func outputManifestFromSingleSource(ctx context.Context, rep repo.Reader, manifests []*snapshot.Manifest, parts []string) error {
var (
count int
lastTotalFileSize int64
@@ -282,5 +282,5 @@ func deltaBytes(b int64) string {
}
func init() {
snapshotListCommand.Action(repositoryAction(runSnapshotsCommand))
snapshotListCommand.Action(repositoryReaderAction(runSnapshotsCommand))
}

20
cli/command_snapshot_migrate.go
View File

@@ -26,7 +26,7 @@
migrateParallel = migrateCommand.Flag("parallel", "Number of sources to migrate in parallel").Default("1").Int()
)
func runMigrateCommand(ctx context.Context, destRepo repo.Repository) error {
func runMigrateCommand(ctx context.Context, destRepo repo.Writer) error {
sourceRepo, err := openSourceRepo(ctx)
if err != nil {
return errors.Wrap(err, "can't open source repository")
@@ -114,7 +114,7 @@ func runMigrateCommand(ctx context.Context, destRepo repo.Repository) error {
return nil
}
func openSourceRepo(ctx context.Context) (repo.Repository, error) {
func openSourceRepo(ctx context.Context) (repo.Reader, error) {
pass, ok := repo.GetPersistedPassword(ctx, *migrateSourceConfig)
if !ok {
var err error
@@ -132,7 +132,7 @@ func openSourceRepo(ctx context.Context) (repo.Repository, error) {
return sourceRepo, nil
}
func migratePoliciesForSources(ctx context.Context, sourceRepo, destRepo repo.Repository, sources []snapshot.SourceInfo) error {
func migratePoliciesForSources(ctx context.Context, sourceRepo repo.Reader, destRepo repo.Writer, sources []snapshot.SourceInfo) error {
for _, si := range sources {
if err := migrateSinglePolicy(ctx, sourceRepo, destRepo, si); err != nil {
return errors.Wrapf(err, "unable to migrate policy for %v", si)
@@ -142,7 +142,7 @@ func migratePoliciesForSources(ctx context.Context, sourceRepo, destRepo repo.Re
return nil
}
func migrateAllPolicies(ctx context.Context, sourceRepo, destRepo repo.Repository) error {
func migrateAllPolicies(ctx context.Context, sourceRepo repo.Reader, destRepo repo.Writer) error {
policies, err := policy.ListPolicies(ctx, sourceRepo)
if err != nil {
return errors.Wrap(err, "unable to list source policies")
@@ -157,7 +157,7 @@ func migrateAllPolicies(ctx context.Context, sourceRepo, destRepo repo.Repositor
return nil
}
func migrateSinglePolicy(ctx context.Context, sourceRepo, destRepo repo.Repository, si snapshot.SourceInfo) error {
func migrateSinglePolicy(ctx context.Context, sourceRepo repo.Reader, destRepo repo.Writer, si snapshot.SourceInfo) error {
pol, err := policy.GetDefinedPolicy(ctx, sourceRepo, si)
if errors.Is(err, policy.ErrPolicyNotFound) {
return nil
@@ -183,7 +183,7 @@ func migrateSinglePolicy(ctx context.Context, sourceRepo, destRepo repo.Reposito
return policy.SetPolicy(ctx, destRepo, si, pol)
}
func findPreviousSnapshotManifestWithStartTime(ctx context.Context, rep repo.Repository, sourceInfo snapshot.SourceInfo, startTime time.Time) (*snapshot.Manifest, error) {
func findPreviousSnapshotManifestWithStartTime(ctx context.Context, rep repo.Reader, sourceInfo snapshot.SourceInfo, startTime time.Time) (*snapshot.Manifest, error) {
previous, err := snapshot.ListSnapshots(ctx, rep, sourceInfo)
if err != nil {
return nil, errors.Wrap(err, "error listing previous snapshots")
@@ -198,7 +198,7 @@ func findPreviousSnapshotManifestWithStartTime(ctx context.Context, rep repo.Rep
return nil, nil
}
func migrateSingleSource(ctx context.Context, uploader *snapshotfs.Uploader, sourceRepo, destRepo repo.Repository, s snapshot.SourceInfo) error {
func migrateSingleSource(ctx context.Context, uploader *snapshotfs.Uploader, sourceRepo repo.Reader, destRepo repo.Writer, s snapshot.SourceInfo) error {
manifests, err := snapshot.ListSnapshotManifests(ctx, sourceRepo, &s)
if err != nil {
return errors.Wrapf(err, "error listing snapshot manifests for %v", s)
@@ -226,7 +226,7 @@ func migrateSingleSource(ctx context.Context, uploader *snapshotfs.Uploader, sou
return nil
}
func migrateSingleSourceSnapshot(ctx context.Context, uploader *snapshotfs.Uploader, sourceRepo, destRepo repo.Repository, s snapshot.SourceInfo, m *snapshot.Manifest) error {
func migrateSingleSourceSnapshot(ctx context.Context, uploader *snapshotfs.Uploader, sourceRepo repo.Reader, destRepo repo.Writer, s snapshot.SourceInfo, m *snapshot.Manifest) error {
if m.IncompleteReason != "" {
log(ctx).Debugf("ignoring incomplete %v at %v", s, formatTimestamp(m.StartTime))
return nil
@@ -282,7 +282,7 @@ func filterSnapshotsToMigrate(s []*snapshot.Manifest) []*snapshot.Manifest {
return s
}
func getSourcesToMigrate(ctx context.Context, rep repo.Repository) ([]snapshot.SourceInfo, error) {
func getSourcesToMigrate(ctx context.Context, rep repo.Reader) ([]snapshot.SourceInfo, error) {
if len(*migrateSources) > 0 {
var result []snapshot.SourceInfo
@@ -306,5 +306,5 @@ func getSourcesToMigrate(ctx context.Context, rep repo.Repository) ([]snapshot.S
}
func init() {
migrateCommand.Action(repositoryAction(runMigrateCommand))
migrateCommand.Action(repositoryWriterAction(runMigrateCommand))
}

2
cli/command_snapshot_restore.go
View File

@@ -4,5 +4,5 @@
func init() {
addRestoreFlags(snapshotRestoreCommand)
snapshotRestoreCommand.Action(repositoryAction(runRestoreCommand))
snapshotRestoreCommand.Action(repositoryReaderAction(runRestoreCommand))
}

10
cli/command_snapshot_verify.go
View File

@@ -34,7 +34,7 @@
)
type verifier struct {
rep repo.Repository
rep repo.Reader
workQueue *parallelwork.Queue
startTime time.Time
@@ -197,7 +197,7 @@ func (v *verifier) readEntireObject(ctx context.Context, oid object.ID, path str
return errors.Wrap(err, "unable to read data")
}
func runVerifyCommand(ctx context.Context, rep repo.Repository) error {
func runVerifyCommand(ctx context.Context, rep repo.Reader) error {
if *verifyCommandAllSources {
log(ctx).Noticef("DEPRECATED: --all-sources flag has no effect and is the default when no sources are provided.")
}
@@ -234,7 +234,7 @@ func runVerifyCommand(ctx context.Context, rep repo.Repository) error {
return errors.Errorf("encountered %v errors", len(v.errors))
}
func enqueueRootsToVerify(ctx context.Context, v *verifier, rep repo.Repository) error {
func enqueueRootsToVerify(ctx context.Context, v *verifier, rep repo.Reader) error {
manifests, err := loadSourceManifests(ctx, rep, *verifyCommandSources)
if err != nil {
return err
@@ -275,7 +275,7 @@ func enqueueRootsToVerify(ctx context.Context, v *verifier, rep repo.Repository)
return nil
}
func loadSourceManifests(ctx context.Context, rep repo.Repository, sources []string) ([]*snapshot.Manifest, error) {
func loadSourceManifests(ctx context.Context, rep repo.Reader, sources []string) ([]*snapshot.Manifest, error) {
var manifestIDs []manifest.ID
if len(sources)+len(*verifyCommandDirObjectIDs)+len(*verifyCommandFileObjectIDs) == 0 {
@@ -303,5 +303,5 @@ func loadSourceManifests(ctx context.Context, rep repo.Repository, sources []str
}
func init() {
verifyCommand.Action(repositoryAction(runVerifyCommand))
verifyCommand.Action(repositoryReaderAction(runVerifyCommand))
}

2
internal/server/server.go
View File

@@ -291,7 +291,7 @@ func (s *Server) refreshPeriodically(ctx context.Context, r repo.Repository) {
}
}
func (s *Server) periodicMaintenance(ctx context.Context, r repo.Repository) {
func (s *Server) periodicMaintenance(ctx context.Context, r repo.Writer) {
for {
select {
case <-ctx.Done():

8
repo/maintenance/maintenance_run.go
View File

@@ -9,10 +9,10 @@
"github.com/gofrs/flock"
"github.com/pkg/errors"
"github.com/kopia/kopia/repo"
"github.com/kopia/kopia/repo/blob"
"github.com/kopia/kopia/repo/content"
"github.com/kopia/kopia/repo/logging"
"github.com/kopia/kopia/repo/manifest"
)
// safetyMarginBetweenSnapshotGC is the minimal amount of time that must pass between snapshot
@@ -34,16 +34,12 @@
type MaintainableRepository interface {
Username() string
Hostname() string
Time() time.Time
ConfigFilename() string
BlobStorage() blob.Storage
ContentManager() *content.Manager
GetManifest(ctx context.Context, id manifest.ID, data interface{}) (*manifest.EntryMetadata, error)
PutManifest(ctx context.Context, labels map[string]string, payload interface{}) (manifest.ID, error)
FindManifests(ctx context.Context, labels map[string]string) ([]*manifest.EntryMetadata, error)
DeleteManifest(ctx context.Context, id manifest.ID) error
repo.Writer
DeriveKey(purpose []byte, keyLength int) []byte
}

31
repo/repository.go
View File

@@ -13,24 +13,37 @@
"github.com/kopia/kopia/repo/object"
)
// Repository exposes public API of Kopia repository, including objects and manifests.
type Repository interface {
// Reader provides methods to read from a repository.
type Reader interface {
OpenObject(ctx context.Context, id object.ID) (object.Reader, error)
NewObjectWriter(ctx context.Context, opt object.WriterOptions) object.Writer
VerifyObject(ctx context.Context, id object.ID) ([]content.ID, error)
GetManifest(ctx context.Context, id manifest.ID, data interface{}) (*manifest.EntryMetadata, error)
PutManifest(ctx context.Context, labels map[string]string, payload interface{}) (manifest.ID, error)
FindManifests(ctx context.Context, labels map[string]string) ([]*manifest.EntryMetadata, error)
DeleteManifest(ctx context.Context, id manifest.ID) error
ClientOptions() ClientOptions
UpdateDescription(d string)
Time() time.Time
ClientOptions() ClientOptions
}
// Writer provides methods to write to a repository.
type Writer interface {
Reader
NewObjectWriter(ctx context.Context, opt object.WriterOptions) object.Writer
PutManifest(ctx context.Context, labels map[string]string, payload interface{}) (manifest.ID, error)
DeleteManifest(ctx context.Context, id manifest.ID) error
Flush(ctx context.Context) error
}
// Repository exposes public API of Kopia repository, including objects and manifests.
type Repository interface {
Reader
Writer
UpdateDescription(d string)
Refresh(ctx context.Context) error
Flush(ctx context.Context) error
Close(ctx context.Context) error
}

14
snapshot/manager.go
View File

@@ -27,7 +27,7 @@
var log = logging.GetContextLoggerFunc("kopia/snapshot")
// ListSources lists all snapshot sources in a given repository.
func ListSources(ctx context.Context, rep repo.Repository) ([]SourceInfo, error) {
func ListSources(ctx context.Context, rep repo.Reader) ([]SourceInfo, error) {
items, err := rep.FindManifests(ctx, map[string]string{
typeKey: ManifestType,
})
@@ -70,7 +70,7 @@ func sourceInfoToLabels(si SourceInfo) map[string]string {
}
// ListSnapshots lists all snapshots for a given source.
func ListSnapshots(ctx context.Context, rep repo.Repository, si SourceInfo) ([]*Manifest, error) {
func ListSnapshots(ctx context.Context, rep repo.Reader, si SourceInfo) ([]*Manifest, error) {
entries, err := rep.FindManifests(ctx, sourceInfoToLabels(si))
if err != nil {
return nil, errors.Wrap(err, "unable to find manifest entries")
@@ -80,7 +80,7 @@ func ListSnapshots(ctx context.Context, rep repo.Repository, si SourceInfo) ([]*
}
// LoadSnapshot loads and parses a snapshot with a given ID.
func LoadSnapshot(ctx context.Context, rep repo.Repository, manifestID manifest.ID) (*Manifest, error) {
func LoadSnapshot(ctx context.Context, rep repo.Reader, manifestID manifest.ID) (*Manifest, error) {
sm := &Manifest{}
em, err := rep.GetManifest(ctx, manifestID, sm)
@@ -103,7 +103,7 @@ func LoadSnapshot(ctx context.Context, rep repo.Repository, manifestID manifest.
}
// SaveSnapshot persists given snapshot manifest and returns manifest ID.
func SaveSnapshot(ctx context.Context, rep repo.Repository, man *Manifest) (manifest.ID, error) {
func SaveSnapshot(ctx context.Context, rep repo.Writer, man *Manifest) (manifest.ID, error) {
if man.Source.Host == "" {
return "", errors.New("missing host")
}
@@ -127,7 +127,7 @@ func SaveSnapshot(ctx context.Context, rep repo.Repository, man *Manifest) (mani
}
// LoadSnapshots efficiently loads and parses a given list of snapshot IDs.
func LoadSnapshots(ctx context.Context, rep repo.Repository, manifestIDs []manifest.ID) ([]*Manifest, error) {
func LoadSnapshots(ctx context.Context, rep repo.Reader, manifestIDs []manifest.ID) ([]*Manifest, error) {
result := make([]*Manifest, len(manifestIDs))
sem := make(chan bool, loadSnapshotsConcurrency)
@@ -164,7 +164,7 @@ func LoadSnapshots(ctx context.Context, rep repo.Repository, manifestIDs []manif
}
// ListSnapshotManifests returns the list of snapshot manifests for a given source or all sources if nil.
func ListSnapshotManifests(ctx context.Context, rep repo.Repository, src *SourceInfo) ([]manifest.ID, error) {
func ListSnapshotManifests(ctx context.Context, rep repo.Reader, src *SourceInfo) ([]manifest.ID, error) {
labels := map[string]string{
typeKey: ManifestType,
}
@@ -182,7 +182,7 @@ func ListSnapshotManifests(ctx context.Context, rep repo.Repository, src *Source
}
// FindSnapshotsByRootObjectID returns the list of matching snapshots for a given rootID.
func FindSnapshotsByRootObjectID(ctx context.Context, rep repo.Repository, rootID object.ID) ([]*Manifest, error) {
func FindSnapshotsByRootObjectID(ctx context.Context, rep repo.Reader, rootID object.ID) ([]*Manifest, error) {
ids, err := ListSnapshotManifests(ctx, rep, nil)
if err != nil {
return nil, errors.Wrap(err, "error listing snapshot manifests")

6
snapshot/policy/expire.go
View File

@@ -11,7 +11,7 @@
)
// ApplyRetentionPolicy applies retention policy to a given source by deleting expired snapshots.
func ApplyRetentionPolicy(ctx context.Context, rep repo.Repository, sourceInfo snapshot.SourceInfo, reallyDelete bool) ([]*snapshot.Manifest, error) {
func ApplyRetentionPolicy(ctx context.Context, rep repo.Writer, sourceInfo snapshot.SourceInfo, reallyDelete bool) ([]*snapshot.Manifest, error) {
snapshots, err := snapshot.ListSnapshots(ctx, rep, sourceInfo)
if err != nil {
return nil, errors.Wrap(err, "error listing snapshots")
@@ -33,7 +33,7 @@ func ApplyRetentionPolicy(ctx context.Context, rep repo.Repository, sourceInfo s
return toDelete, nil
}
func getExpiredSnapshots(ctx context.Context, rep repo.Repository, snapshots []*snapshot.Manifest) ([]*snapshot.Manifest, error) {
func getExpiredSnapshots(ctx context.Context, rep repo.Reader, snapshots []*snapshot.Manifest) ([]*snapshot.Manifest, error) {
var toDelete []*snapshot.Manifest
for _, snapshotGroup := range snapshot.GroupBySource(snapshots) {
@@ -48,7 +48,7 @@ func getExpiredSnapshots(ctx context.Context, rep repo.Repository, snapshots []*
return toDelete, nil
}
func getExpiredSnapshotsForSource(ctx context.Context, rep repo.Repository, snapshots []*snapshot.Manifest) ([]*snapshot.Manifest, error) {
func getExpiredSnapshotsForSource(ctx context.Context, rep repo.Reader, snapshots []*snapshot.Manifest) ([]*snapshot.Manifest, error) {
src := snapshots[0].Source
pol, _, err := GetEffectivePolicy(ctx, rep, src)

18
snapshot/policy/policy_manager.go
View File

@@ -23,7 +23,7 @@
// GetEffectivePolicy calculates effective snapshot policy for a given source by combining the source-specifc policy (if any)
// with parent policies. The source must contain a path.
// Returns the effective policies and all source policies that contributed to that (most specific first).
func GetEffectivePolicy(ctx context.Context, rep repo.Repository, si snapshot.SourceInfo) (effective *Policy, sources []*Policy, e error) {
func GetEffectivePolicy(ctx context.Context, rep repo.Reader, si snapshot.SourceInfo) (effective *Policy, sources []*Policy, e error) {
var md []*manifest.EntryMetadata
// Find policies applying to paths all the way up to the root.
@@ -86,7 +86,7 @@ func GetEffectivePolicy(ctx context.Context, rep repo.Repository, si snapshot.So
}
// GetDefinedPolicy returns the policy defined on the provided snapshot.SourceInfo or ErrPolicyNotFound if not present.
func GetDefinedPolicy(ctx context.Context, rep repo.Repository, si snapshot.SourceInfo) (*Policy, error) {
func GetDefinedPolicy(ctx context.Context, rep repo.Reader, si snapshot.SourceInfo) (*Policy, error) {
md, err := rep.FindManifests(ctx, labelsForSource(si))
if err != nil {
return nil, errors.Wrap(err, "unable to find policy for source")
@@ -112,7 +112,7 @@ func GetDefinedPolicy(ctx context.Context, rep repo.Repository, si snapshot.Sour
}
// SetPolicy sets the policy on a given source.
func SetPolicy(ctx context.Context, rep repo.Repository, si snapshot.SourceInfo, pol *Policy) error {
func SetPolicy(ctx context.Context, rep repo.Writer, si snapshot.SourceInfo, pol *Policy) error {
md, err := rep.FindManifests(ctx, labelsForSource(si))
if err != nil {
return errors.Wrapf(err, "unable to load manifests for %v", si)
@@ -132,7 +132,7 @@ func SetPolicy(ctx context.Context, rep repo.Repository, si snapshot.SourceInfo,
}
// RemovePolicy removes the policy for a given source.
func RemovePolicy(ctx context.Context, rep repo.Repository, si snapshot.SourceInfo) error {
func RemovePolicy(ctx context.Context, rep repo.Writer, si snapshot.SourceInfo) error {
md, err := rep.FindManifests(ctx, labelsForSource(si))
if err != nil {
return errors.Wrapf(err, "unable to load manifests for %v", si)
@@ -148,7 +148,7 @@ func RemovePolicy(ctx context.Context, rep repo.Repository, si snapshot.SourceIn
}
// GetPolicyByID gets the policy for a given unique ID or ErrPolicyNotFound if not found.
func GetPolicyByID(ctx context.Context, rep repo.Repository, id manifest.ID) (*Policy, error) {
func GetPolicyByID(ctx context.Context, rep repo.Reader, id manifest.ID) (*Policy, error) {
p := &Policy{}
if err := loadPolicyFromManifest(ctx, rep, id, p); err != nil {
return nil, err
@@ -158,7 +158,7 @@ func GetPolicyByID(ctx context.Context, rep repo.Repository, id manifest.ID) (*P
}
// ListPolicies returns a list of all policies.
func ListPolicies(ctx context.Context, rep repo.Repository) ([]*Policy, error) {
func ListPolicies(ctx context.Context, rep repo.Reader) ([]*Policy, error) {
ids, err := rep.FindManifests(ctx, map[string]string{
typeKey: "policy",
})
@@ -190,7 +190,7 @@ func (m SubdirectoryPolicyMap) GetPolicyForPath(relativePath string) (*Policy, e
}
// TreeForSource returns policy Tree for a given source.
func TreeForSource(ctx context.Context, rep repo.Repository, si snapshot.SourceInfo) (*Tree, error) {
func TreeForSource(ctx context.Context, rep repo.Reader, si snapshot.SourceInfo) (*Tree, error) {
pols, err := applicablePoliciesForSource(ctx, rep, si)
if err != nil {
return nil, errors.Wrap(err, "unable to get policies")
@@ -199,7 +199,7 @@ func TreeForSource(ctx context.Context, rep repo.Repository, si snapshot.SourceI
return BuildTree(pols, DefaultPolicy), nil
}
func applicablePoliciesForSource(ctx context.Context, rep repo.Repository, si snapshot.SourceInfo) (map[string]*Policy, error) {
func applicablePoliciesForSource(ctx context.Context, rep repo.Reader, si snapshot.SourceInfo) (map[string]*Policy, error) {
result := map[string]*Policy{}
pol, _, err := GetEffectivePolicy(ctx, rep, si)
@@ -247,7 +247,7 @@ func applicablePoliciesForSource(ctx context.Context, rep repo.Repository, si sn
return result, nil
}
func loadPolicyFromManifest(ctx context.Context, rep repo.Repository, id manifest.ID, pol *Policy) error {
func loadPolicyFromManifest(ctx context.Context, rep repo.Reader, id manifest.ID, pol *Policy) error {
md, err := rep.GetManifest(ctx, id, pol)
if err != nil {
if errors.Is(err, manifest.ErrNotFound) {

2
snapshot/restore/restore.go
View File

@@ -59,7 +59,7 @@ type Options struct {
}
// Entry walks a snapshot root with given root entry and restores it to the provided output.
func Entry(ctx context.Context, rep repo.Repository, output Output, rootEntry fs.Entry, options Options) (Stats, error) {
func Entry(ctx context.Context, rep repo.Reader, output Output, rootEntry fs.Entry, options Options) (Stats, error) {
c := copier{output: output, q: parallelwork.NewQueue()}
c.q.ProgressCallback = func(ctx context.Context, enqueued, active, completed int64) {

10
snapshot/snapshot_test.go
View File

@@ -81,7 +81,7 @@ func TestSnapshotsAPI(t *testing.T) {
verifyLoadSnapshots(t, env.Repository, []manifest.ID{id1, id2, id3}, []*snapshot.Manifest{manifest1, manifest2, manifest3})
}
func verifySnapshotManifestIDs(t *testing.T, rep repo.Repository, src *snapshot.SourceInfo, expected []manifest.ID) {
func verifySnapshotManifestIDs(t *testing.T, rep repo.Reader, src *snapshot.SourceInfo, expected []manifest.ID) {
t.Helper()
res, err := snapshot.ListSnapshotManifests(testlogging.Context(t), rep, src)
@@ -103,7 +103,7 @@ func sortManifestIDs(s []manifest.ID) {
})
}
func mustSaveSnapshot(t *testing.T, rep repo.Repository, man *snapshot.Manifest) manifest.ID {
func mustSaveSnapshot(t *testing.T, rep repo.Writer, man *snapshot.Manifest) manifest.ID {
t.Helper()
id, err := snapshot.SaveSnapshot(testlogging.Context(t), rep, man)
@@ -114,7 +114,7 @@ func mustSaveSnapshot(t *testing.T, rep repo.Repository, man *snapshot.Manifest)
return id
}
func verifySources(t *testing.T, rep repo.Repository, sources ...snapshot.SourceInfo) {
func verifySources(t *testing.T, rep repo.Reader, sources ...snapshot.SourceInfo) {
actualSources, err := snapshot.ListSources(testlogging.Context(t), rep)
if err != nil {
t.Errorf("error listing sources: %v", err)
@@ -125,7 +125,7 @@ func verifySources(t *testing.T, rep repo.Repository, sources ...snapshot.Source
}
}
func verifyListSnapshots(t *testing.T, rep repo.Repository, src snapshot.SourceInfo, expected []*snapshot.Manifest) {
func verifyListSnapshots(t *testing.T, rep repo.Reader, src snapshot.SourceInfo, expected []*snapshot.Manifest) {
t.Helper()
got, err := snapshot.ListSnapshots(testlogging.Context(t), rep, src)
@@ -147,7 +147,7 @@ func verifyListSnapshots(t *testing.T, rep repo.Repository, src snapshot.SourceI
}
}
func verifyLoadSnapshots(t *testing.T, rep repo.Repository, ids []manifest.ID, expected []*snapshot.Manifest) {
func verifyLoadSnapshots(t *testing.T, rep repo.Reader, ids []manifest.ID, expected []*snapshot.Manifest) {
got, err := snapshot.LoadSnapshots(testlogging.Context(t), rep, ids)
if err != nil {
t.Errorf("error loading manifests: %v", err)

4
snapshot/snapshotfs/all_sources.go
View File

@@ -14,7 +14,7 @@
)
type repositoryAllSources struct {
rep repo.Repository
rep repo.Reader
}
func (s *repositoryAllSources) IsDir() bool {
@@ -82,6 +82,6 @@ func (s *repositoryAllSources) Readdir(ctx context.Context) (fs.Entries, error)
}
// AllSourcesEntry returns fs.Directory that contains the list of all snapshot sources found in the repository.
func AllSourcesEntry(rep repo.Repository) fs.Directory {
func AllSourcesEntry(rep repo.Reader) fs.Directory {
return &repositoryAllSources{rep: rep}
}

8
snapshot/snapshotfs/objref.go
View File

@@ -16,7 +16,7 @@
// ParseObjectIDWithPath interprets the given ID string (which could be an object ID optionally followed by
// nested path specification) and returns corresponding object.ID.
func ParseObjectIDWithPath(ctx context.Context, rep repo.Repository, objectIDWithPath string) (object.ID, error) {
func ParseObjectIDWithPath(ctx context.Context, rep repo.Reader, objectIDWithPath string) (object.ID, error) {
parts := strings.Split(objectIDWithPath, "/")
oid, err := object.ParseID(parts[0])
@@ -75,7 +75,7 @@ func parseNestedObjectID(ctx context.Context, startingDir fs.Entry, parts []stri
// or the root object ID (which can match arbitrary number of snapshots).
// If multiple snapshots match and they don't agree on root object attributes and consistentAttributes==true
// the function fails, otherwise it returns the latest of the snapshots.
func findSnapshotByRootObjectIDOrManifestID(ctx context.Context, rep repo.Repository, rootID string, consistentAttributes bool) (*snapshot.Manifest, error) {
func findSnapshotByRootObjectIDOrManifestID(ctx context.Context, rep repo.Reader, rootID string, consistentAttributes bool) (*snapshot.Manifest, error) {
m, err := snapshot.LoadSnapshot(ctx, rep, manifest.ID(rootID))
if err == nil {
return m, nil
@@ -133,7 +133,7 @@ func latestManifest(mans []*snapshot.Manifest) *snapshot.Manifest {
// can be a snapshot manifest ID or an object ID with path.
// If multiple snapshots match and they don't agree on root object attributes and consistentAttributes==true
// the function fails, otherwise it returns the latest of the snapshots.
func FilesystemEntryFromIDWithPath(ctx context.Context, rep repo.Repository, rootID string, consistentAttributes bool) (fs.Entry, error) {
func FilesystemEntryFromIDWithPath(ctx context.Context, rep repo.Reader, rootID string, consistentAttributes bool) (fs.Entry, error) {
pathElements := strings.Split(rootID, "/")
if len(pathElements) > 1 {
@@ -169,7 +169,7 @@ func FilesystemEntryFromIDWithPath(ctx context.Context, rep repo.Repository, roo
// FilesystemDirectoryFromIDWithPath returns a filesystem directory entry for the provided object ID, which
// can be a snapshot manifest ID or an object ID with path.
func FilesystemDirectoryFromIDWithPath(ctx context.Context, rep repo.Repository, rootID string, consistentAttributes bool) (fs.Directory, error) {
func FilesystemDirectoryFromIDWithPath(ctx context.Context, rep repo.Reader, rootID string, consistentAttributes bool) (fs.Directory, error) {
e, err := FilesystemEntryFromIDWithPath(ctx, rep, rootID, consistentAttributes)
if err != nil {
return nil, err

12
snapshot/snapshotfs/repofs.go
View File

@@ -1,4 +1,4 @@
// Package snapshotfs implements virtual filesystem on top of snapshots in repo.Repository.
// Package snapshotfs implements virtual filesystem on top of snapshots in repo.Reader.
package snapshotfs
import (
@@ -22,7 +22,7 @@
type repositoryEntry struct {
metadata *snapshot.DirEntry
repo repo.Repository
repo repo.Reader
}
func (e *repositoryEntry) IsDir() bool {
@@ -170,7 +170,7 @@ func (rsl *repositorySymlink) Readlink(ctx context.Context) (string, error) {
}
// EntryFromDirEntry returns a filesystem entry based on the directory entry.
func EntryFromDirEntry(r repo.Repository, md *snapshot.DirEntry) (fs.Entry, error) {
func EntryFromDirEntry(r repo.Reader, md *snapshot.DirEntry) (fs.Entry, error) {
re := repositoryEntry{
metadata: md,
repo: r,
@@ -214,7 +214,7 @@ func withFileInfo(r object.Reader, e fs.Entry) fs.Reader {
// DirectoryEntry returns fs.Directory based on repository object with the specified ID.
// The existence or validity of the directory object is not validated until its contents are read.
func DirectoryEntry(rep repo.Repository, objectID object.ID, dirSummary *fs.DirectorySummary) fs.Directory {
func DirectoryEntry(rep repo.Reader, objectID object.ID, dirSummary *fs.DirectorySummary) fs.Directory {
d, _ := EntryFromDirEntry(rep, &snapshot.DirEntry{
Name: "/",
Permissions: 0o555, //nolint:gomnd
@@ -227,7 +227,7 @@ func DirectoryEntry(rep repo.Repository, objectID object.ID, dirSummary *fs.Dire
}
// SnapshotRoot returns fs.Entry representing the root of a snapshot.
func SnapshotRoot(rep repo.Repository, man *snapshot.Manifest) (fs.Entry, error) {
func SnapshotRoot(rep repo.Reader, man *snapshot.Manifest) (fs.Entry, error) {
oid := man.RootObjectID()
if oid == "" {
return nil, errors.New("manifest root object ID")
@@ -238,7 +238,7 @@ func SnapshotRoot(rep repo.Repository, man *snapshot.Manifest) (fs.Entry, error)
// AutoDetectEntryFromObjectID returns fs.Entry (either file or directory) for the provided object ID.
// It uses heuristics to determine whether object ID is possibly a directory and treats it as such.
func AutoDetectEntryFromObjectID(ctx context.Context, rep repo.Repository, oid object.ID, maybeName string) fs.Entry {
func AutoDetectEntryFromObjectID(ctx context.Context, rep repo.Reader, oid object.ID, maybeName string) fs.Entry {
if IsDirectoryID(oid) {
dirEntry := DirectoryEntry(rep, oid, nil)
if _, err := dirEntry.Readdir(ctx); err == nil {

2
snapshot/snapshotfs/source_directories.go
View File

@@ -13,7 +13,7 @@
)
type sourceDirectories struct {
rep repo.Repository
rep repo.Reader
userHost string
}

2
snapshot/snapshotfs/source_snapshots.go
View File

@@ -15,7 +15,7 @@
)
type sourceSnapshots struct {
rep repo.Repository
rep repo.Reader
src snapshot.SourceInfo
}

4
snapshot/snapshotfs/upload.go
View File

@@ -70,7 +70,7 @@ type Uploader struct {
// How frequently to create checkpoint snapshot entries.
CheckpointInterval time.Duration
repo repo.Repository
repo repo.Writer
// stats must be allocated on heap to enforce 64-bit alignment due to atomic access on ARM.
stats *snapshot.Stats
@@ -967,7 +967,7 @@ func (u *Uploader) shouldIgnoreDirectoryReadErrors(policyTree *policy.Tree) bool
}
// NewUploader creates new Uploader object for a given repository.
func NewUploader(r repo.Repository) *Uploader {
func NewUploader(r repo.Writer) *Uploader {
return &Uploader{
repo: r,
Progress: &NullUploadProgress{},

2
snapshot/snapshotfs/upload_test.go
View File

@@ -32,7 +32,7 @@
type uploadTestHarness struct {
sourceDir *mockfs.Directory
repoDir string
repo repo.Repository
repo repo.Writer
ft *faketime.TimeAdvance
}

2
snapshot/snapshotgc/gc.go
View File

@@ -26,7 +26,7 @@ func oidOf(entry fs.Entry) object.ID {
return entry.(object.HasObjectID).ObjectID()
}
func findInUseContentIDs(ctx context.Context, rep repo.Repository, used *sync.Map) error {
func findInUseContentIDs(ctx context.Context, rep repo.Reader, used *sync.Map) error {
ids, err := snapshot.ListSnapshotManifests(ctx, rep, nil)
if err != nil {
return errors.Wrap(err, "unable to list snapshot manifest IDs")

4
snapshot/snapshotmaintenance/helper_test.go
View File

@@ -14,7 +14,7 @@
)
// Create snapshots an FS entry.
func createSnapshot(ctx context.Context, rep repo.Repository, e fs.Entry, si snapshot.SourceInfo, description string) (*snapshot.Manifest, error) {
func createSnapshot(ctx context.Context, rep repo.Writer, e fs.Entry, si snapshot.SourceInfo, description string) (*snapshot.Manifest, error) {
// sanitize source path
si.Path = filepath.Clean(si.Path)
@@ -46,7 +46,7 @@ func createSnapshot(ctx context.Context, rep repo.Repository, e fs.Entry, si sna
// findPreviousSnapshotManifest returns the list of previous snapshots for a given source, including
// last complete snapshot and possibly some number of incomplete snapshots following it.
// this would belong in the snapshot package.
func findPreviousSnapshotManifest(ctx context.Context, rep repo.Repository, sourceInfo snapshot.SourceInfo) ([]*snapshot.Manifest, error) {
func findPreviousSnapshotManifest(ctx context.Context, rep repo.Reader, sourceInfo snapshot.SourceInfo) ([]*snapshot.Manifest, error) {
man, err := snapshot.ListSnapshots(ctx, rep, sourceInfo)
if err != nil {
return nil, errors.Wrap(err, "error listing previous snapshots")

2
snapshot/snapshotmaintenance/snapshotmaintenance.go
View File

@@ -12,7 +12,7 @@
)
// Run runs the complete snapshot and repository maintenance.
func Run(ctx context.Context, rep repo.Repository, mode maintenance.Mode, force bool) error {
func Run(ctx context.Context, rep repo.Writer, mode maintenance.Mode, force bool) error {
dr, ok := rep.(*repo.DirectRepository)
if !ok {
return nil

4
snapshot/snapshotmaintenance/snapshotmaintenance_test.go
View File

@@ -195,13 +195,13 @@ func (th *testHarness) openAnother(t *testing.T) repo.Repository {
return r
}
func mustFlush(t *testing.T, r repo.Repository) {
func mustFlush(t *testing.T, r repo.Writer) {
t.Helper()
require.NotNil(t, r, "nil repository")
require.NoError(t, r.Flush(testlogging.Context(t)))
}
func mustSnapshot(t *testing.T, r repo.Repository, source fs.Entry, si snapshot.SourceInfo) *snapshot.Manifest {
func mustSnapshot(t *testing.T, r repo.Writer, source fs.Entry, si snapshot.SourceInfo) *snapshot.Manifest {
t.Helper()
s1, err := createSnapshot(testlogging.Context(t), r, source, si, "")