From 4ebb2d3bfb6023b360ec14e36607dd284056de5e Mon Sep 17 00:00:00 2001
From: ashmrtn <3891298+ashmrtn@users.noreply.github.com>
Date: Tue, 8 Aug 2023 11:06:15 -0700
Subject: [PATCH] Common structs/mocks/consts for assist backups (#3985)

Pull into separate PR so we can start merging things separately.

`BackupBases` sourced from branch `backup_bases_changes`
`model.go` sourced from branch `partial_bup`
mock backup bases sourced from branch `backup-details-merge`

---

#### Does this PR need a docs update or release note?

- [ ] :white_check_mark: Yes, it's included
- [ ] :clock1: Yes, but in a later PR
- [x] :no_entry: No

#### Type of change

- [x] :sunflower: Feature
- [ ] :bug: Bugfix
- [ ] :world_map: Documentation
- [ ] :robot: Supportability/Tests
- [ ] :computer: CI/Deployment
- [ ] :broom: Tech Debt/Cleanup

#### Test Plan

- [ ] :muscle: Manual
- [ ] :zap: Unit test
- [ ] :green_heart: E2E
---
 src/internal/kopia/backup_bases.go     | 12 +++++++++---
 src/internal/kopia/mock_backup_base.go | 12 +++++++++++-
 src/internal/model/model.go            |  5 ++++-
 3 files changed, 24 insertions(+), 5 deletions(-)

diff --git a/src/internal/kopia/backup_bases.go b/src/internal/kopia/backup_bases.go
index c0b8ecfaa..dcfa1fc39 100644
--- a/src/internal/kopia/backup_bases.go
+++ b/src/internal/kopia/backup_bases.go
@@ -16,6 +16,7 @@ import (
 type BackupBases interface {
 	RemoveMergeBaseByManifestID(manifestID manifest.ID)
 	Backups() []BackupEntry
+	AssistBackups() []BackupEntry
 	MinBackupVersion() int
 	MergeBases() []ManifestEntry
 	ClearMergeBases()
@@ -31,9 +32,10 @@ type BackupBases interface {
 type backupBases struct {
 	// backups and mergeBases should be modified together as they relate similar
 	// data.
-	backups     []BackupEntry
-	mergeBases  []ManifestEntry
-	assistBases []ManifestEntry
+	backups       []BackupEntry
+	mergeBases    []ManifestEntry
+	assistBases   []ManifestEntry
+	assistBackups []BackupEntry
 }
 
 func (bb *backupBases) RemoveMergeBaseByManifestID(manifestID manifest.ID) {
@@ -71,6 +73,10 @@ func (bb backupBases) Backups() []BackupEntry {
 	return slices.Clone(bb.backups)
 }
 
+func (bb backupBases) AssistBackups() []BackupEntry {
+	return slices.Clone(bb.assistBackups)
+}
+
 func (bb *backupBases) MinBackupVersion() int {
 	min := version.NoBackup
 
diff --git a/src/internal/kopia/mock_backup_base.go b/src/internal/kopia/mock_backup_base.go
index 84743486e..7edea1c39 100644
--- a/src/internal/kopia/mock_backup_base.go
+++ b/src/internal/kopia/mock_backup_base.go
@@ -14,13 +14,17 @@ func AssertBackupBasesEqual(t *testing.T, expect, got BackupBases) {
 	if expect == nil {
 		assert.Empty(t, got.Backups(), "backups")
 		assert.Empty(t, got.MergeBases(), "merge bases")
+		assert.Empty(t, got.AssistBackups(), "assist backups")
 		assert.Empty(t, got.AssistBases(), "assist bases")
 
 		return
 	}
 
 	if got == nil {
-		if len(expect.Backups()) > 0 && len(expect.MergeBases()) > 0 && len(expect.AssistBases()) > 0 {
+		if len(expect.Backups()) > 0 &&
+			len(expect.MergeBases()) > 0 &&
+			len(expect.AssistBackups()) > 0 &&
+			len(expect.AssistBases()) > 0 {
 			assert.Fail(t, "got was nil but expected non-nil result %v", expect)
 		}
 
@@ -29,6 +33,7 @@ func AssertBackupBasesEqual(t *testing.T, expect, got BackupBases) {
 
 	assert.ElementsMatch(t, expect.Backups(), got.Backups(), "backups")
 	assert.ElementsMatch(t, expect.MergeBases(), got.MergeBases(), "merge bases")
+	assert.ElementsMatch(t, expect.AssistBackups(), got.AssistBackups(), "assist backups")
 	assert.ElementsMatch(t, expect.AssistBases(), got.AssistBases(), "assist bases")
 }
 
@@ -52,6 +57,11 @@ func (bb *MockBackupBases) WithMergeBases(m ...ManifestEntry) *MockBackupBases {
 	return bb
 }
 
+func (bb *MockBackupBases) WithAssistBackups(b ...BackupEntry) *MockBackupBases {
+	bb.backupBases.assistBackups = append(bb.AssistBackups(), b...)
+	return bb
+}
+
 func (bb *MockBackupBases) WithAssistBases(m ...ManifestEntry) *MockBackupBases {
 	bb.backupBases.assistBases = append(bb.AssistBases(), m...)
 	return bb
diff --git a/src/internal/model/model.go b/src/internal/model/model.go
index b33762545..dcf0dce51 100644
--- a/src/internal/model/model.go
+++ b/src/internal/model/model.go
@@ -32,7 +32,10 @@ const (
 
 // common tags for filtering
 const (
-	ServiceTag = "service"
+	ServiceTag    = "service"
+	BackupTypeTag = "backup-type"
+	AssistBackup  = "assist-backup"
+	MergeBackup   = "merge-backup"
 )
 
 // Valid returns true if the ModelType value fits within the iota range.