backup: rename BackupManifestName DeprecatedBackupManifestName

Informs #139159

Release note: none

Author: msbutler

pkg/backup/backup_job.go

@@ -429,7 +429,7 @@ func backup(
 
 	// TODO(msbutler): version gate writing the old manifest once we can guarantee
 	// a cluster version that will not read the old manifest.
-	if err := backupinfo.WriteBackupManifest(ctx, defaultStore, backupbase.BackupManifestName,
+	if err := backupinfo.WriteBackupManifest(ctx, defaultStore, backupbase.DeprecatedBackupManifestName,
 		encryption, &kmsEnv, backupManifest); err != nil {
 		return roachpb.RowCount{}, 0, err
 	}

pkg/backup/backup_test.go

@@ -144,7 +144,7 @@ func TestBackupRestoreStatementResult(t *testing.T) {
 	// have been stored in the GZip compressed format.
 	t.Run("GZipBackupManifest", func(t *testing.T) {
 		backupDir := fmt.Sprintf("%s/foo", dir)
-		backupManifestFile := backupDir + backupPath + "/" + backupbase.BackupManifestName
+		backupManifestFile := backupDir + backupPath + "/" + backupbase.DeprecatedBackupManifestName
 		backupManifestBytes, err := os.ReadFile(backupManifestFile)
 		if err != nil {
 			t.Fatal(err)
@@ -668,7 +668,7 @@ func TestBackupRestoreAppend(t *testing.T) {
 	// Find the backup times in the collection and try RESTORE'ing to each, and
 	// within each also check if we can restore to individual times captured with
 	// incremental backups that were appended to that backup.
-	fullBackup1, fullBackup2 := findFullBackupPaths(tmpDir, path.Join(tmpDir, "*/*/*/"+backupbase.BackupManifestName))
+	fullBackup1, fullBackup2 := findFullBackupPaths(tmpDir, path.Join(tmpDir, "*/*/*/"+backupbase.DeprecatedBackupManifestName))
 
 	sqlDB.Exec(t, "DROP DATABASE data CASCADE")
 	sqlDB.Exec(t, "RESTORE DATABASE data FROM $4 IN ($1, $2, $3) AS OF SYSTEM TIME "+tsBefore,
@@ -740,7 +740,7 @@ func TestBackupAndRestoreJobDescription(t *testing.T) {
 	sqlDB.Exec(t, "BACKUP INTO ($1, $2, $3) AS OF SYSTEM TIME '-1s'", collections...)
 
 	// Find the subdirectory created by the full BACKUP INTO statement.
-	matches, err := filepath.Glob(path.Join(tmpDir, "full/*/*/*/"+backupbase.BackupManifestName))
+	matches, err := filepath.Glob(path.Join(tmpDir, "full/*/*/*/"+backupbase.DeprecatedBackupManifestName))
 	require.NoError(t, err)
 	require.Equal(t, 2, len(matches))
 	for i := range matches {
@@ -1786,7 +1786,7 @@ func TestBackupRestoreResume(t *testing.T) {
 
 				// If the backup properly took the (incorrect) checkpoint into account, it
 				// won't have tried to re-export any keys within backupCompletedSpan.
-				backupManifestFile := path.Join(dir, item.testName, subdir, backupbase.BackupManifestName)
+				backupManifestFile := path.Join(dir, item.testName, subdir, backupbase.DeprecatedBackupManifestName)
 				backupManifestBytes, err := os.ReadFile(backupManifestFile)
 				if err != nil {
 					t.Fatal(err)
@@ -4000,7 +4000,7 @@ func TestBackupRestoreChecksum(t *testing.T) {
 
 	var backupManifest backuppb.BackupManifest
 	{
-		backupManifestBytes, err := os.ReadFile(filepath.Join(dir, backupPath, backupbase.BackupManifestName))
+		backupManifestBytes, err := os.ReadFile(filepath.Join(dir, backupPath, backupbase.DeprecatedBackupManifestName))
 		if err != nil {
 			t.Fatalf("%+v", err)
 		}
@@ -10419,7 +10419,7 @@ func TestBackupDoNotIncludeViewSpans(t *testing.T) {
 	// Read the backup manifest.
 	var backupManifest backuppb.BackupManifest
 	{
-		backupManifestBytes, err := os.ReadFile(filepath.Join(dir, "foo", res[0][0], backupbase.BackupManifestName))
+		backupManifestBytes, err := os.ReadFile(filepath.Join(dir, "foo", res[0][0], backupbase.DeprecatedBackupManifestName))
 		if err != nil {
 			t.Fatalf("%+v", err)
 		}

pkg/backup/backupbase/constants.go

@@ -35,12 +35,12 @@ const (
 	// Also exported for testing backup inspection tooling.
 	DateBasedIntoFolderName = "/2006/01/02-150405.00"
 
-	// BackupManifestName is the file name used for serialized BackupManifest
-	// protos.
+	// DeprecatedBackupManifestName is the file name used for serialized
+	// BackupManifest protos.
 	//
 	// TODO(msbutler): Remove 26.3 when we're guaranteed that no backup wrote
 	// exclusively the backup_manifest, and not the slim manifest.
-	BackupManifestName = "BACKUP_MANIFEST"
+	DeprecatedBackupManifestName = "BACKUP_MANIFEST"
 
 	// BackupMetadataName is the file name used for serialized BackupManifest
 	// protos written by 23.1 nodes and later. This manifest has the alloc heavy

pkg/backup/backupdest/backup_destination.go

@@ -53,7 +53,7 @@ const (
 // On some cloud storage platforms (i.e. GS, S3), backups in a base bucket may
 // omit a leading slash. However, backups in a subdirectory of a base bucket
 // will contain one.
-var backupPathRE = regexp.MustCompile("^/?[^\\/]+/[^\\/]+/[^\\/]+/" + backupbase.BackupManifestName + "$")
+var backupPathRE = regexp.MustCompile("^/?[^\\/]+/[^\\/]+/[^\\/]+/" + backupbase.DeprecatedBackupManifestName + "$")
 
 // featureFullBackupUserSubdir, when true, will create a full backup at a user
 // specified subdirectory if no backup already exists at that subdirectory. As
@@ -68,7 +68,7 @@ var featureFullBackupUserSubdir = settings.RegisterBoolSetting(
 
 // TODO(adityamaru): Move this to the soon to be `backupinfo` package.
 func containsManifest(ctx context.Context, exportStore cloud.ExternalStorage) (bool, error) {
-	r, _, err := exportStore.ReadFile(ctx, backupbase.BackupManifestName, cloud.ReadOptions{NoFileSize: true})
+	r, _, err := exportStore.ReadFile(ctx, backupbase.DeprecatedBackupManifestName, cloud.ReadOptions{NoFileSize: true})
 	if err != nil {
 		if errors.Is(err, cloud.ErrFileDoesNotExist) {
 			return false, nil
@@ -534,7 +534,7 @@ func ListFullBackupsInCollection(
 		return nil, err
 	}
 	for i, backupPath := range backupPaths {
-		backupPaths[i] = strings.TrimSuffix(backupPath, "/"+backupbase.BackupManifestName)
+		backupPaths[i] = strings.TrimSuffix(backupPath, "/"+backupbase.DeprecatedBackupManifestName)
 	}
 	return backupPaths, nil
 }

pkg/backup/backupdest/backup_destination_test.go

@@ -56,7 +56,7 @@ func TestBackupRestoreResolveDestination(t *testing.T) {
 		require.NoError(t, err)
 		reader := bytes.NewReader(manifestBytes)
 		require.NoError(t, err)
-		require.NoError(t, cloud.WriteFile(ctx, storage, backupbase.BackupManifestName, reader))
+		require.NoError(t, cloud.WriteFile(ctx, storage, backupbase.DeprecatedBackupManifestName, reader))
 	}
 
 	// writeLatest writes latestBackupSuffix to the LATEST file in the given

pkg/backup/backupdest/incrementals.go

@@ -120,7 +120,7 @@ func FindAllIncrementalPaths(
 
 	if includeManifest {
 		paths = util.Map(paths, func(p string) string {
-			return path.Join(p, backupbase.BackupManifestName)
+			return path.Join(p, backupbase.DeprecatedBackupManifestName)
 		})
 	}
 	return paths, nil
@@ -141,19 +141,19 @@ func LegacyFindPriorBackups(
 
 	var prev []string
 	if err := store.List(ctx, "", backupbase.ListingDelimDataSlash, func(p string) error {
-		matchesGlob, err := path.Match(incBackupSubdirGlob+backupbase.BackupManifestName, p)
+		matchesGlob, err := path.Match(incBackupSubdirGlob+backupbase.DeprecatedBackupManifestName, p)
 		if err != nil {
 			return err
 		} else if !matchesGlob {
-			matchesGlob, err = path.Match(incBackupSubdirGlobWithSuffix+backupbase.BackupManifestName, p)
+			matchesGlob, err = path.Match(incBackupSubdirGlobWithSuffix+backupbase.DeprecatedBackupManifestName, p)
 			if err != nil {
 				return err
 			}
 		}
 
 		if matchesGlob {
 			if !includeManifest {
-				p = strings.TrimSuffix(p, "/"+backupbase.BackupManifestName)
+				p = strings.TrimSuffix(p, "/"+backupbase.DeprecatedBackupManifestName)
 			}
 			prev = append(prev, p)
 			return nil

pkg/backup/backupdest/incrementals_test.go

@@ -458,7 +458,7 @@ func writeEmptyBackupManifest(
 	)
 	require.NoError(
 		t,
-		cloud.WriteFile(context.Background(), backupStore, backupbase.BackupManifestName, emptyReader),
+		cloud.WriteFile(context.Background(), backupStore, backupbase.DeprecatedBackupManifestName, emptyReader),
 	)
 
 	if !indexed {
@@ -505,7 +505,7 @@ func TestLegacyFindPriorBackups(t *testing.T) {
 	emptyReader := bytes.NewReader(nil)
 
 	writeManifest := func(t *testing.T, store cloud.ExternalStorage, path string) {
-		manifestName := backupbase.BackupManifestName
+		manifestName := backupbase.DeprecatedBackupManifestName
 		err := cloud.WriteFile(ctx, store, backuputils.JoinURLPath(path, manifestName), emptyReader)
 		require.NoError(t, err)
 	}

pkg/backup/backupinfo/manifest_handling.go

@@ -156,7 +156,7 @@ func ReadBackupManifestFromStore(
 		// pre-23.1 node.
 		log.Dev.VInfof(ctx, 2, "could not find BACKUP_METADATA, falling back to BACKUP_MANIFEST")
 		backupManifest, backupManifestMemSize, backupManifestErr := ReadBackupManifest(ctx, mem, exportStore,
-			backupbase.BackupManifestName, encryption, kmsEnv)
+			backupbase.DeprecatedBackupManifestName, encryption, kmsEnv)
 		if backupManifestErr != nil {
 			return backuppb.BackupManifest{}, 0, backupManifestErr
 		}
@@ -1305,18 +1305,18 @@ func CheckForPreviousBackup(
 	defer defaultStore.Close()
 
 	redactedURI := backuputils.RedactURIForErrorMessage(defaultURI)
-	r, _, err := defaultStore.ReadFile(ctx, backupbase.BackupManifestName, cloud.ReadOptions{NoFileSize: true})
+	r, _, err := defaultStore.ReadFile(ctx, backupbase.DeprecatedBackupManifestName, cloud.ReadOptions{NoFileSize: true})
 	if err == nil {
 		r.Close(ctx)
 		return pgerror.Newf(pgcode.FileAlreadyExists,
 			"%s already contains a %s file",
-			redactedURI, backupbase.BackupManifestName)
+			redactedURI, backupbase.DeprecatedBackupManifestName)
 	}
 
 	if !errors.Is(err, cloud.ErrFileDoesNotExist) {
 		return errors.Wrapf(err,
 			"%s returned an unexpected error when checking for the existence of %s file",
-			redactedURI, backupbase.BackupManifestName)
+			redactedURI, backupbase.DeprecatedBackupManifestName)
 	}
 
 	// Check for the presence of a BACKUP-LOCK file with a job ID different from

pkg/backup/compaction_job.go

@@ -793,7 +793,7 @@ func concludeBackupCompaction(
 	backupID := uuid.MakeV4()
 	backupManifest.ID = backupID
 
-	if err := backupinfo.WriteBackupManifest(ctx, store, backupbase.BackupManifestName,
+	if err := backupinfo.WriteBackupManifest(ctx, store, backupbase.DeprecatedBackupManifestName,
 		details.EncryptionOptions, kmsEnv, backupManifest); err != nil {
 		return err
 	}

pkg/backup/full_cluster_backup_restore_test.go

@@ -670,7 +670,7 @@ func TestClusterRestoreFailCleanup(t *testing.T) {
 		if err != nil {
 			t.Fatal(err)
 		}
-		if d.Name() == backupbase.BackupManifestName ||
+		if d.Name() == backupbase.DeprecatedBackupManifestName ||
 			!strings.HasSuffix(path, ".sst") ||
 			d.Name() == backupinfo.BackupMetadataDescriptorsListPath ||
 			d.Name() == backupinfo.BackupMetadataFilesListPath {