Files
minio/cmd/restore-native-isolation_test.go
T
Feng Ruohang 7f38bf6282 fix(restore): give each native restore an owner and a private upload
A native restore (POST ?restore, issue #281) marks the version ongoing,
and a background worker rehydrates it from the tier. The worker, its
upload and every status write could be reached or confused by other
callers. A public client could write into or complete the restore
upload. POST copied a whole metadata snapshot over newer protection
changes. An old or failed attempt could act on a newer one. Restore,
expiry and heal decided on whichever drive's metadata they read.

Each POST that starts a rehydration now writes an attempt ID into the
version's internal metadata, with the identity it resolved: version
ID, ETag, size and ModTime. The worker, its upload, its part writes and
its completion carry the attempt. A worker whose attempt no longer
owns the version stops without writing, completing or resetting. Every
write uses the versioning state and explicit version ID captured by
POST, so a null target stays null.

The restore upload carries an internal marker, decided over all drives.
Public multipart calls answer NoSuchUpload and listings hide it. An
unknown marker fails closed. A completion holds a commit lock from
staging its commit in the upload until the commit ends. Stale cleanup
decides on every upload past the stale age under that lock, and keeps
it until its rename ends, also past the drive deadline. Abort of a
committing upload takes the lock and removes a failed commit's
leftover only when every copy is staged and older than one hour.

POST, the worker, the reset, the ExpireRestored recheck and heal all
decide on the authoritative revision of the exact version. That is the
revision held by max(n/2+1, read quorum) drives, identified by the
version header and the normalized metadata digest. Status writes patch
only the restore fields of that revision. They write only the drives
that hold it, and put the old revision back on failure. Heal copies
restore fields only when a quorum holds the same fields.

A failed attempt resets itself with bounded in-memory retries. A later
POST takes over a stranded marker when no attempt runs. Otherwise it
answers RestoreAlreadyInProgress within a few seconds.

Older nodes do not know the marker. A new grid capability handler lets
the serving node ask every peer. POST answers 503 ServiceUnavailable
and writes nothing until all peers support native restore, and a
queued worker asks again before it creates its upload.

The single-pool lock-domain split between DELETE/CopyObject and restore
is closed by its own fix, which this change depends on.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Feng Ruohang <rh@vonng.com>
2026-11-05 06:47:38 +08:00

1398 lines
55 KiB
Go

// Copyright (c) 2026 Feng Ruohang
//
// This file is part of Silo Object Storage stack
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package cmd
import (
"bytes"
"context"
"encoding/base64"
"errors"
"fmt"
"io"
"net/http"
"net/http/httptest"
"net/url"
"reflect"
"strings"
"sync"
"sync/atomic"
"testing"
"time"
"github.com/minio/minio/internal/bucket/lifecycle"
"github.com/minio/minio/internal/bucket/versioning"
xhttp "github.com/minio/minio/internal/http"
"github.com/minio/mux"
)
// The private metadata of a native restore, as stored. Literal names keep
// these regressions meaningful on a tree without the keys.
const (
restoreIsolationAttemptKey = "x-minio-internal-restore-attempt"
restoreIsolationUploadKey = "x-minio-internal-restore-upload"
)
// restoreIsolationLayer hooks the object layer a POST restore handler uses.
// afterRead runs once POST has read the version, before POST records its
// status. restore, when set, replaces the background restore; every
// background restore result is sent to done.
type restoreIsolationLayer struct {
ObjectLayer
afterRead func()
once sync.Once
restore func(ctx context.Context, bucket, object string, opts ObjectOptions) error
done chan error
}
func newRestoreIsolationLayer(r *restoreTest) *restoreIsolationLayer {
return &restoreIsolationLayer{ObjectLayer: r.z, done: make(chan error, 4)}
}
func (l *restoreIsolationLayer) GetObjectInfo(ctx context.Context, bucket, object string, opts ObjectOptions) (ObjectInfo, error) {
oi, err := l.ObjectLayer.GetObjectInfo(ctx, bucket, object, opts)
if err == nil && l.afterRead != nil {
l.once.Do(l.afterRead)
}
return oi, err
}
func (l *restoreIsolationLayer) RestoreTransitionedObject(ctx context.Context, bucket, object string, opts ObjectOptions) error {
var err error
if l.restore != nil {
err = l.restore(ctx, bucket, object, opts)
} else {
err = l.ObjectLayer.RestoreTransitionedObject(ctx, bucket, object, opts)
}
l.done <- err
return err
}
// wait returns the result of the next background restore.
func (l *restoreIsolationLayer) wait(t *testing.T) error {
t.Helper()
select {
case err := <-l.done:
return err
case <-time.After(10 * time.Second):
t.Fatal("background restore did not finish")
return nil
}
}
func restoreIsolationPOST(t *testing.T, r *restoreTest, layer ObjectLayer, versionID string) *httptest.ResponseRecorder {
t.Helper()
body := []byte(`<RestoreRequest xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Days>1</Days></RestoreRequest>`)
path := "/" + r.bucket + "/" + r.object + "?restore"
if versionID != "" {
path += "&versionId=" + url.QueryEscape(versionID)
}
req, err := newTestSignedRequestV4(http.MethodPost, path, int64(len(body)), bytes.NewReader(body), globalActiveCred.AccessKey, globalActiveCred.SecretKey, nil)
if err != nil {
t.Fatal(err)
}
if err := req.ParseForm(); err != nil {
t.Fatal(err)
}
req = mux.SetURLVars(req, map[string]string{"bucket": r.bucket, "object": r.object})
rec := httptest.NewRecorder()
api := objectAPIHandlers{ObjectAPI: func() ObjectLayer { return layer }}
api.PostRestoreObjectHandler(rec, req)
return rec
}
// restoreIsolationSeed is a transitioned version without the ongoing marker
// that nativeRestoreSeed leaves for direct restores: POST sets its own.
func restoreIsolationSeed(t *testing.T, r *restoreTest, pool int, null, multipart bool) (ObjectInfo, []byte) {
t.Helper()
oi, body := nativeRestoreSeed(t, r, pool, null, multipart)
opts := r.opts(oi.VersionID)
opts.MTime = oi.ModTime
opts.EvalMetadataFn = func(o *ObjectInfo, _ error) (ReplicateDecision, error) {
o.UserDefined[xhttp.AmzRestore] = ""
return ReplicateDecision{}, nil
}
if _, err := r.z.PutObjectMetadata(t.Context(), r.bucket, r.object, opts); err != nil {
t.Fatal(err)
}
return oi, body
}
// restoreIsolationSettled waits until the version is no longer ongoing.
func restoreIsolationSettled(t *testing.T, r *restoreTest, versionID string) ObjectInfo {
t.Helper()
deadline := time.Now().Add(10 * time.Second)
for {
oi, err := r.z.GetObjectInfo(t.Context(), r.bucket, r.object, r.opts(versionID))
if err == nil && !oi.RestoreOngoing {
return oi
}
if time.Now().After(deadline) {
t.Fatalf("version stays ongoing, refusing every later POST: %q, %v", oi.UserDefined[xhttp.AmzRestore], err)
}
time.Sleep(20 * time.Millisecond)
}
}
// restoreIsolationUploads returns the upload directories of the object on
// each drive of a pool, as stored, whatever listings show.
func restoreIsolationUploads(t *testing.T, r *restoreTest, pool int) map[string]int {
t.Helper()
er := r.z.serverPools[pool].getHashedSet(r.object)
found := make(map[string]int)
for _, disk := range er.getDisks() {
entries, err := disk.ListDir(t.Context(), r.bucket, minioMetaMultipartBucket, er.getMultipartSHADir(r.bucket, r.object), -1)
if errors.Is(err, errFileNotFound) || errors.Is(err, errVolumeNotFound) {
continue
}
if err != nil {
t.Fatal(err)
}
for _, entry := range entries {
found[strings.TrimSuffix(entry, SlashSeparator)]++
}
}
return found
}
// restoreIsolationUpload finds the single upload of the object in a pool on
// disk, with its first part, and returns its public upload ID.
func restoreIsolationUpload(t *testing.T, r *restoreTest, pool int) (string, ObjectPartInfo) {
t.Helper()
uploads := restoreIsolationUploads(t, r, pool)
if len(uploads) != 1 {
t.Fatalf("want one upload on disk, found %v", uploads)
}
var uploadUUID string
for uploadUUID = range uploads {
}
er := r.z.serverPools[pool].getHashedSet(r.object)
uploadPath := pathJoin(er.getMultipartSHADir(r.bucket, r.object), uploadUUID)
fi, err := er.getDisks()[0].ReadVersion(t.Context(), "", minioMetaMultipartBucket, uploadPath, "", ReadOptions{})
if err != nil {
t.Fatal(err)
}
parts, err := readParts(t.Context(), er.getDisks(), minioMetaMultipartBucket, []string{pathJoin(uploadPath, fi.DataDir, "part.1.meta")}, []int{1}, 1)
if err != nil || len(parts) != 1 || parts[0].Error != "" {
t.Fatalf("restore must have published its first part: %+v, %v", parts, err)
}
return base64.RawURLEncoding.EncodeToString(fmt.Appendf(nil, "%s.%s", globalDeploymentID(), uploadUUID)), parts[0]
}
// restoreIsolationGateTier holds a download after its first bytes and can
// fail it once released.
type restoreIsolationGateTier struct {
WarmBackend
first int
entered chan struct{}
release chan struct{}
failure error
enter sync.Once
open sync.Once
}
func newRestoreIsolationGateTier(first int, failure error) *restoreIsolationGateTier {
return &restoreIsolationGateTier{
WarmBackend: globalTierConfigMgr.drivercache["WARM"],
first: first, failure: failure,
entered: make(chan struct{}), release: make(chan struct{}),
}
}
func (b *restoreIsolationGateTier) unblock() { b.open.Do(func() { close(b.release) }) }
func (b *restoreIsolationGateTier) Get(ctx context.Context, object string, version remoteVersionID, opts WarmBackendGetOpts) (io.ReadCloser, error) {
rd, err := b.WarmBackend.Get(ctx, object, version, opts)
if err != nil {
return nil, err
}
return &restoreIsolationGateReader{ReadCloser: rd, tier: b, ctx: ctx, remaining: b.first}, nil
}
type restoreIsolationGateReader struct {
io.ReadCloser
tier *restoreIsolationGateTier
ctx context.Context
remaining int
}
func (r *restoreIsolationGateReader) Read(p []byte) (int, error) {
if r.remaining > 0 {
if len(p) > r.remaining {
p = p[:r.remaining]
}
n, err := r.ReadCloser.Read(p)
r.remaining -= n
return n, err
}
r.tier.enter.Do(func() { close(r.tier.entered) })
select {
case <-r.tier.release:
case <-r.ctx.Done():
return 0, r.ctx.Err()
}
if r.tier.failure != nil {
return 0, r.tier.failure
}
return r.ReadCloser.Read(p)
}
func restoreIsolationEntered(t *testing.T, tier *restoreIsolationGateTier) {
t.Helper()
select {
case <-tier.entered:
case <-time.After(10 * time.Second):
t.Fatal("restore never reached its download gate")
}
}
// restoreIsolationFaultDisk fails metadata reads of the object while
// failReads is set, and reports writes of its metadata as failed, after
// they were made, while failWrites is set. Toggles keep the wrapper in
// place, so no restore retry races a swap of the drives.
type restoreIsolationFaultDisk struct {
StorageAPI
bucket, object string
failReads *atomic.Bool
failWrites *atomic.Bool
}
func (d restoreIsolationFaultDisk) ReadVersion(ctx context.Context, origvolume, volume, path, version string, opts ReadOptions) (FileInfo, error) {
if d.failReads.Load() && volume == d.bucket && path == d.object {
return FileInfo{}, errDiskNotFound
}
return d.StorageAPI.ReadVersion(ctx, origvolume, volume, path, version, opts)
}
func (d restoreIsolationFaultDisk) ReadXL(ctx context.Context, volume, path string, readData bool) (RawFileInfo, error) {
if d.failReads.Load() && volume == d.bucket && path == d.object {
return RawFileInfo{}, errDiskNotFound
}
return d.StorageAPI.ReadXL(ctx, volume, path, readData)
}
func (d restoreIsolationFaultDisk) WriteMetadata(ctx context.Context, origvolume, volume, path string, fi FileInfo) error {
err := d.StorageAPI.WriteMetadata(ctx, origvolume, volume, path, fi)
if err == nil && d.failWrites != nil && d.failWrites.Load() && volume == d.bucket && path == d.object {
return errFaultyDisk
}
return err
}
// installRestoreIsolationFaults wraps the drives of the object's set in a
// pool for the rest of the test; failing marks the drives whose writes fail.
func installRestoreIsolationFaults(r *restoreTest, pool int, failing int) (reads, writes *atomic.Bool) {
reads, writes = new(atomic.Bool), new(atomic.Bool)
er := r.z.serverPools[pool].getHashedSet(r.object)
disks := er.getDisks()
wrapped := make([]StorageAPI, len(disks))
for i, disk := range disks {
d := restoreIsolationFaultDisk{StorageAPI: disk, bucket: r.bucket, object: r.object, failReads: reads}
if i < failing {
d.failWrites = writes
}
wrapped[i] = d
}
er.getDisks = func() []StorageAPI { return wrapped }
return reads, writes
}
// A public client must not replace a part of a native restore's upload,
// before or after the restore validated it: the bytes would become the
// COMPLIANCE-protected version under its original ETag.
func TestRestoreUploadIsolatedFromPublicParts(t *testing.T) {
r := newRestoreSafetyTest(t, 2, versioning.Enabled)
initConfigSubsystem(t.Context(), r.z)
enableBucketObjectLock(t, r.bucket)
previous := newObjectLayerFn()
t.Cleanup(func() { setObjectLayer(previous) })
router := initTestAPIEndPoints(r.z, []string{"PutObjectPart", "GetObject"})
oi, body := nativeRestoreSeed(t, r, 0, false, true)
if rec := nativeRestoreLockRequest(t.Context(), t, r, oi.VersionID, "retention", retentionBody("COMPLIANCE", UTCNow().Add(48*time.Hour))); rec.Code != http.StatusOK {
t.Fatalf("lock: %d %s", rec.Code, rec.Body.String())
}
// Hold completion after it validated the parts, before it commits.
er := r.z.serverPools[0].getHashedSet(r.object)
original := er.getDisks
gate := &restoreIsolationCompletionGate{entered: make(chan struct{}), release: make(chan struct{})}
defer gate.unblock()
disks := original()
wrapped := make([]StorageAPI, len(disks))
for i, d := range disks {
wrapped[i] = restoreIsolationCompletionDisk{d, gate}
}
er.getDisks = func() []StorageAPI { return wrapped }
defer func() { er.getDisks = original }()
ctx, cancel := context.WithTimeout(t.Context(), 10*time.Second)
defer cancel()
restored := make(chan error, 1)
go func() {
restored <- r.z.RestoreTransitionedObject(ctx, r.bucket, r.object, nativeRestoreOptions(r, oi.VersionID))
}()
select {
case <-gate.entered:
case err := <-restored:
t.Fatalf("restore stopped before validation: %v", err)
case <-ctx.Done():
t.Fatal("no completion gate")
}
id, _ := restoreIsolationUpload(t, r, 0)
poison := bytes.Repeat([]byte("z"), 5<<20)
// The request may wait for the upload lock that completion holds.
uploaded := make(chan *httptest.ResponseRecorder, 1)
go func() {
uploaded <- attributesPartsSignedRequest(t, router, globalActiveCred, http.MethodPut, "/"+r.bucket+"/"+r.object+"?uploadId="+url.QueryEscape(id)+"&partNumber=1", poison, nil)
}()
var rec *httptest.ResponseRecorder
select {
case rec = <-uploaded:
case <-time.After(500 * time.Millisecond):
}
gate.unblock()
if err := <-restored; err != nil {
t.Fatalf("restore: %v", err)
}
if rec == nil {
rec = <-uploaded
}
if rec.Code != http.StatusNotFound || !strings.Contains(rec.Body.String(), "NoSuchUpload") {
t.Errorf("public UploadPart on a native restore upload: %d %s, want NoSuchUpload", rec.Code, rec.Body.String())
}
got := attributesPartsSignedRequest(t, router, globalActiveCred, http.MethodGet, "/"+r.bucket+"/"+r.object+"?versionId="+oi.VersionID, nil, nil)
if got.Code != http.StatusOK || !bytes.Equal(got.Body.Bytes(), body) {
t.Errorf("COMPLIANCE version holds other bytes after restore: GET=%d poisoned=%v", got.Code, bytes.HasPrefix(got.Body.Bytes(), poison))
}
}
type restoreIsolationCompletionGate struct {
entered, release chan struct{}
enter, open sync.Once
}
func (g *restoreIsolationCompletionGate) unblock() { g.open.Do(func() { close(g.release) }) }
type restoreIsolationCompletionDisk struct {
StorageAPI
gate *restoreIsolationCompletionGate
}
// Completion removes the part metadata it validated just before it renames
// the upload into place.
func (d restoreIsolationCompletionDisk) DeleteBulk(ctx context.Context, bucket string, paths ...string) error {
if bucket == minioMetaMultipartBucket && len(paths) == 2 && strings.HasSuffix(paths[0], ".meta") && strings.HasSuffix(paths[1], ".meta") {
d.gate.enter.Do(func() { close(d.gate.entered) })
select {
case <-d.gate.release:
case <-ctx.Done():
return ctx.Err()
}
}
return d.StorageAPI.DeleteBulk(ctx, bucket, paths...)
}
// restoreIsolationValidationDisk holds a completion where it reads the parts
// it validates: after its object and upload locks, before its commit lock.
// Stale cleanup then decides on the upload itself, not on a running commit.
type restoreIsolationValidationDisk struct {
StorageAPI
gate *restoreIsolationCompletionGate
}
func (d restoreIsolationValidationDisk) ReadParts(ctx context.Context, bucket string, partMetaPaths ...string) ([]*ObjectPartInfo, error) {
if bucket == minioMetaMultipartBucket {
d.gate.enter.Do(func() { close(d.gate.entered) })
select {
case <-d.gate.release:
case <-ctx.Done():
return nil, ctx.Err()
}
}
return d.StorageAPI.ReadParts(ctx, bucket, partMetaPaths...)
}
// Every public multipart entry point finds no native restore upload, and
// none of them can change it: the restore still completes with its own data.
func TestRestoreUploadHiddenFromPublicEntryPoints(t *testing.T) {
for _, pools := range []int{1, 2} {
t.Run(fmt.Sprintf("pools=%d", pools), func(t *testing.T) {
r := newRestoreSafetyTest(t, pools, versioning.Enabled)
oi, body := nativeRestoreSeed(t, r, 0, false, true)
tier := newRestoreIsolationGateTier(5<<20, nil)
globalTierConfigMgr.drivercache["WARM"] = tier
defer tier.unblock()
ctx, cancel := context.WithTimeout(t.Context(), 20*time.Second)
defer cancel()
restored := make(chan error, 1)
go func() {
restored <- r.z.RestoreTransitionedObject(ctx, r.bucket, r.object, nativeRestoreOptions(r, oi.VersionID))
}()
restoreIsolationEntered(t, tier)
id, part := restoreIsolationUpload(t, r, 0)
stored := restoreIsolationUploads(t, r, 0)
for _, prefix := range []string{r.object, ""} {
uploads, err := r.z.ListMultipartUploads(t.Context(), r.bucket, prefix, "", "", "", 100)
if err != nil {
t.Fatal(err)
}
for _, u := range uploads.Uploads {
if u.UploadID == id {
t.Errorf("ListMultipartUploads(prefix=%q) shows the native restore upload", prefix)
}
}
}
poison := bytes.Repeat([]byte("z"), 5<<20)
noUpload := func(op string, err error) {
t.Helper()
if !errors.As(err, &InvalidUploadID{}) {
t.Errorf("%s on a native restore upload: %v, want NoSuchUpload", op, err)
}
}
// With one pool, part writes first wait for the object lock the
// restore holds; with more they reach the upload at once.
written := make(chan error, 2)
go func() {
_, err := r.z.PutObjectPart(ctx, r.bucket, r.object, id, 1, mustGetPutObjReader(t, bytes.NewReader(poison), int64(len(poison)), "", ""), ObjectOptions{})
written <- err
}()
go func() {
src := ObjectInfo{PutObjReader: mustGetPutObjReader(t, bytes.NewReader(poison), int64(len(poison)), "", "")}
_, err := r.z.CopyObjectPart(ctx, r.bucket, r.object, r.bucket, r.object, id, 1, 0, int64(len(poison)), src, ObjectOptions{}, ObjectOptions{})
written <- err
}()
var writes []error
if pools > 1 {
writes = append(writes, <-written, <-written)
}
_, err := r.z.ListObjectParts(t.Context(), r.bucket, r.object, id, 0, 10, ObjectOptions{})
noUpload("ListObjectParts", err)
_, err = r.z.GetMultipartInfo(t.Context(), r.bucket, r.object, id, ObjectOptions{})
noUpload("GetMultipartInfo", err)
err = r.z.AbortMultipartUpload(t.Context(), r.bucket, r.object, id, ObjectOptions{})
noUpload("AbortMultipartUpload", err)
if after := restoreIsolationUploads(t, r, 0); !reflect.DeepEqual(after, stored) {
t.Errorf("public calls changed the restore upload on disk: %v -> %v", stored, after)
}
// Completion waits for the object lock the restore holds.
completed := make(chan error, 1)
go func() {
_, err := r.z.CompleteMultipartUpload(ctx, r.bucket, r.object, id, []CompletePart{{PartNumber: 1, ETag: part.ETag}}, r.opts(oi.VersionID))
completed <- err
}()
tier.unblock()
if err := <-restored; err != nil {
t.Fatalf("restore after public calls: %v", err)
}
for len(writes) < 2 {
writes = append(writes, <-written)
}
for _, err := range writes {
noUpload("PutObjectPart/CopyObjectPart", err)
}
noUpload("CompleteMultipartUpload", <-completed)
_, got, err := r.read(oi.VersionID)
if err != nil || !bytes.Equal(got, body) {
t.Fatalf("restore contents after public calls: %v", err)
}
})
}
}
// POST records its status on a fresh read under the object lock, so an
// Object Lock update it did not see survives.
func TestRestorePOSTKeepsConcurrentProtection(t *testing.T) {
for _, pools := range []int{1, 2} {
for _, kind := range []string{"legal-hold", "retention"} {
t.Run(fmt.Sprintf("pools=%d/%s", pools, kind), func(t *testing.T) {
r := newRestoreSafetyTest(t, pools, versioning.Enabled)
initConfigSubsystem(t.Context(), r.z)
enableBucketObjectLock(t, r.bucket)
oi, _ := nativeRestoreSeed(t, r, 0, false, false)
if err := r.z.RestoreTransitionedObject(t.Context(), r.bucket, r.object, nativeRestoreOptions(r, oi.VersionID)); err != nil {
t.Fatal(err)
}
initial := []byte(`<LegalHold xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Status>OFF</Status></LegalHold>`)
updated := []byte(`<LegalHold xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Status>ON</Status></LegalHold>`)
key := strings.ToLower(xhttp.AmzObjectLockLegalHold)
if kind == "retention" {
initial = retentionBody("COMPLIANCE", UTCNow().Add(24*time.Hour))
updated = retentionBody("COMPLIANCE", UTCNow().Add(48*time.Hour))
key = strings.ToLower(xhttp.AmzObjectLockRetainUntilDate)
}
if rec := nativeRestoreLockRequest(t.Context(), t, r, oi.VersionID, kind, initial); rec.Code != http.StatusOK {
t.Fatalf("initial protection: %d %s", rec.Code, rec.Body.String())
}
var accepted ObjectInfo
layer := newRestoreIsolationLayer(r)
layer.afterRead = func() {
if rec := nativeRestoreLockRequest(t.Context(), t, r, oi.VersionID, kind, updated); rec.Code != http.StatusOK {
t.Fatalf("update: %d %s", rec.Code, rec.Body.String())
}
var err error
if accepted, err = r.z.GetObjectInfo(t.Context(), r.bucket, r.object, r.opts(oi.VersionID)); err != nil {
t.Fatal(err)
}
}
if rec := restoreIsolationPOST(t, r, layer, oi.VersionID); rec.Code >= 400 {
t.Fatalf("POST: %d %s", rec.Code, rec.Body.String())
}
after, err := r.z.GetObjectInfo(t.Context(), r.bucket, r.object, r.opts(oi.VersionID))
if err != nil {
t.Fatal(err)
}
if accepted.UserDefined[key] == "" || after.UserDefined[key] != accepted.UserDefined[key] {
t.Errorf("POST restore overwrote acknowledged Object Lock metadata: %q -> %q", accepted.UserDefined[key], after.UserDefined[key])
}
if !after.ModTime.Equal(oi.ModTime) || after.ETag != oi.ETag {
t.Error("POST restore changed the version identity")
}
})
}
}
}
// A restored copy removed between POST's read and its status write leads to
// a new restore, never to a completed header without the restored data.
func TestRestorePOSTRacesCacheExpiry(t *testing.T) {
for _, pools := range []int{1, 2} {
t.Run(fmt.Sprintf("pools=%d", pools), func(t *testing.T) {
r := newRestoreSafetyTest(t, pools, versioning.Enabled)
initConfigSubsystem(t.Context(), r.z)
oi := r.put("restored", false, true)
r.restore(oi)
layer := newRestoreIsolationLayer(r)
layer.afterRead = func() {
if err := expireTransitionedObject(t.Context(), r.z, &oi, lifecycle.Event{Action: lifecycle.DeleteRestoredAction}, lcEventSrc_Scanner); err != nil {
t.Fatal(err)
}
}
if rec := restoreIsolationPOST(t, r, layer, oi.VersionID); rec.Code >= 400 {
t.Fatalf("POST: %d %s", rec.Code, rec.Body.String())
}
select {
case err := <-layer.done:
if err != nil {
t.Fatalf("rehydration: %v", err)
}
case <-time.After(5 * time.Second):
t.Error("POST renewed a removed restored copy instead of restoring it")
}
_, body, err := r.read(oi.VersionID)
if err != nil || !bytes.Equal(body, r.bodies["restored"]) {
t.Errorf("version unreadable after POST raced cache expiry: %v", err)
}
})
}
}
// A restore queued with the versioning POST captured writes back the null
// version it resolved, even after versioning was enabled in between.
func TestRestoreKeepsCapturedNullIdentity(t *testing.T) {
enable := func(t *testing.T, r *restoreTest) {
meta, err := globalBucketMetadataSys.Get(r.bucket)
if err != nil {
t.Fatal(err)
}
meta.VersioningConfigXML = []byte(`<VersioningConfiguration><Status>Enabled</Status></VersioningConfiguration>`)
if err := meta.Save(t.Context(), r.z); err != nil {
t.Fatal(err)
}
globalBucketMetadataSys.Set(r.bucket, meta)
}
for _, mode := range []string{"direct", "post"} {
t.Run(mode, func(t *testing.T) {
r := newRestoreSafetyTest(t, 1, "")
initConfigSubsystem(t.Context(), r.z)
var oi ObjectInfo
var body []byte
if mode == "direct" {
oi, body = nativeRestoreSeed(t, r, 0, true, false)
// These are the options that POST captured while versioning was off.
queued := nativeRestoreOptions(r, "")
enable(t, r)
if err := r.z.RestoreTransitionedObject(t.Context(), r.bucket, r.object, queued); err != nil {
t.Fatal(err)
}
} else {
oi, body = restoreIsolationSeed(t, r, 0, true, false)
release := make(chan struct{})
layer := newRestoreIsolationLayer(r)
layer.restore = func(ctx context.Context, bucket, object string, opts ObjectOptions) error {
<-release
return r.z.RestoreTransitionedObject(ctx, bucket, object, opts)
}
if rec := restoreIsolationPOST(t, r, layer, ""); rec.Code != http.StatusOK {
t.Fatalf("POST: %d %s", rec.Code, rec.Body.String())
}
enable(t, r)
close(release)
if err := layer.wait(t); err != nil {
t.Fatal(err)
}
}
versions := nativeRestoreSnapshot(t, r)[0]
if len(versions) != 1 || versions[0].VersionID != "" {
t.Errorf("restore created a UUID alias of the queued null version: %d versions", len(versions))
}
_, got, err := r.read(oi.VersionID)
if err != nil || !bytes.Equal(got, body) {
t.Fatalf("null original: %v", err)
}
})
}
}
// A restore that fails before it reads the version, on its lock wait or on
// its first read, must not leave POST's ongoing marker for every later POST
// to refuse: bounded retries clear it once the version is readable again.
func TestRestoreRecoversStrandedMarker(t *testing.T) {
for _, pools := range []int{1, 2} {
for _, stage := range []string{"lock-wait", "initial-read"} {
t.Run(fmt.Sprintf("pools=%d/%s", pools, stage), func(t *testing.T) {
r := newRestoreSafetyTest(t, pools, versioning.Enabled)
oi, _ := nativeRestoreSeed(t, r, 0, false, false)
var err error
if stage == "lock-wait" {
lk := r.z.NewNSLock(r.bucket, r.object)
if pools == 1 {
lk = r.z.serverPools[0].getHashedSet(r.object).NewNSLock(r.bucket, r.object)
}
lkctx, lerr := lk.GetLock(t.Context(), globalOperationTimeout)
if lerr != nil {
t.Fatal(lerr)
}
ctx, cancel := context.WithTimeout(t.Context(), 100*time.Millisecond)
err = r.z.RestoreTransitionedObject(ctx, r.bucket, r.object, nativeRestoreOptions(r, oi.VersionID))
cancel()
lk.Unlock(lkctx)
} else {
reads, _ := installRestoreIsolationFaults(r, 0, 0)
reads.Store(true)
err = r.z.RestoreTransitionedObject(t.Context(), r.bucket, r.object, nativeRestoreOptions(r, oi.VersionID))
reads.Store(false)
}
if err == nil {
t.Fatal("restore succeeded without its lock or its version")
}
after := restoreIsolationSettled(t, r, oi.VersionID)
if !after.IsRemote() || !after.ModTime.Equal(oi.ModTime) {
t.Error("recovery changed more than the restore status")
}
})
}
}
}
// A later POST takes over a marker that no running restore holds, and the
// superseded attempt then neither downloads nor clears the newer status,
// also when both POSTs share a second, the precision of the request date.
func TestRestoreSupersededAttempt(t *testing.T) {
for _, mode := range []string{"newer-completes", "newer-fails"} {
t.Run(mode, func(t *testing.T) {
r := newRestoreSafetyTest(t, 1, versioning.Enabled)
initConfigSubsystem(t.Context(), r.z)
oi, body := restoreIsolationSeed(t, r, 0, false, false)
tier := globalTierConfigMgr.drivercache["WARM"].(*restoreTestTier)
release := make(chan struct{})
var releaseOnce sync.Once
unblock := func() { releaseOnce.Do(func() { close(release) }) }
t.Cleanup(unblock)
older := newRestoreIsolationLayer(r)
older.restore = func(ctx context.Context, bucket, object string, opts ObjectOptions) error {
<-release
return r.z.RestoreTransitionedObject(ctx, bucket, object, opts)
}
newer := newRestoreIsolationLayer(r)
time.Sleep(time.Until(time.Now().Truncate(time.Second).Add(time.Second + 10*time.Millisecond)))
if rec := restoreIsolationPOST(t, r, older, oi.VersionID); rec.Code != http.StatusOK {
t.Fatalf("first POST: %d %s", rec.Code, rec.Body.String())
}
first := r.fileInfo(oi.VersionID).Metadata[xhttp.AmzRestoreRequestDate]
if mode == "newer-fails" {
globalTierConfigMgr.drivercache["WARM"] = nativeRestoreFailTier{tier, errors.New("injected remote failure")}
}
if rec := restoreIsolationPOST(t, r, newer, oi.VersionID); rec.Code != http.StatusOK {
t.Fatalf("POST over a marker no restore holds: %d %s", rec.Code, rec.Body.String())
}
second := r.fileInfo(oi.VersionID).Metadata[xhttp.AmzRestoreRequestDate]
t.Logf("request dates %q %q, same second: %v", first, second, first == second)
newerErr := newer.wait(t)
globalTierConfigMgr.drivercache["WARM"] = tier
before := r.fileInfo(oi.VersionID)
gets := tier.gets.Load()
unblock()
if err := older.wait(t); err == nil {
t.Error("superseded restore reported success")
}
if tier.gets.Load() != gets {
t.Error("superseded restore downloaded the version again")
}
after := r.fileInfo(oi.VersionID)
if !reflect.DeepEqual(before.Metadata, after.Metadata) || before.DataDir != after.DataDir {
t.Errorf("superseded restore changed the version: %q -> %q", before.Metadata[xhttp.AmzRestore], after.Metadata[xhttp.AmzRestore])
}
info, err := r.z.GetObjectInfo(t.Context(), r.bucket, r.object, r.opts(oi.VersionID))
if err != nil || info.RestoreOngoing {
t.Fatalf("version left ongoing: %q, %v", info.UserDefined[xhttp.AmzRestore], err)
}
if mode == "newer-completes" {
if newerErr != nil || info.IsRemote() {
t.Fatalf("newer restore: %v remote=%v", newerErr, info.IsRemote())
}
if _, got, err := r.read(oi.VersionID); err != nil || !bytes.Equal(got, body) || tier.gets.Load() != gets {
t.Errorf("restored contents: %v", err)
}
return
}
if newerErr == nil || !info.IsRemote() || info.UserDefined[xhttp.AmzRestore] != "" {
t.Fatalf("failed newer restore is not retryable: %v %q", newerErr, info.UserDefined[xhttp.AmzRestore])
}
if rec := restoreIsolationPOST(t, r, newer, oi.VersionID); rec.Code != http.StatusOK {
t.Fatalf("retry POST: %d %s", rec.Code, rec.Body.String())
}
if err := newer.wait(t); err != nil {
t.Fatal(err)
}
if _, got, err := r.read(oi.VersionID); err != nil || !bytes.Equal(got, body) {
t.Errorf("retried restore contents: %v", err)
}
})
}
}
// A restart loses the restore that POST started; a POST to the restarted
// server takes the stranded marker over and restores the version.
func TestRestoreRestartTakeover(t *testing.T) {
r := newRestoreSafetyTest(t, 1, versioning.Enabled)
initConfigSubsystem(t.Context(), r.z)
oi, body := restoreIsolationSeed(t, r, 0, false, true)
lost := newRestoreIsolationLayer(r)
lost.restore = func(context.Context, string, string, ObjectOptions) error { return nil }
if rec := restoreIsolationPOST(t, r, lost, oi.VersionID); rec.Code != http.StatusOK {
t.Fatalf("POST before restart: %d %s", rec.Code, rec.Body.String())
}
lost.wait(t)
if info, err := r.z.GetObjectInfo(t.Context(), r.bucket, r.object, r.opts(oi.VersionID)); err != nil || !info.RestoreOngoing {
t.Fatalf("fixture: %q %v", info.UserDefined[xhttp.AmzRestore], err)
}
endpoints := make(EndpointServerPools, len(r.z.serverPools))
for i, pool := range r.z.serverPools {
endpoints[i] = pool.endpoints
}
obj, err := newErasureServerPools(t.Context(), endpoints)
if err != nil {
t.Fatal(err)
}
restarted := obj.(*erasureServerPools)
t.Cleanup(func() { restarted.Shutdown(context.Background()) })
r.z = restarted
layer := newRestoreIsolationLayer(r)
if rec := restoreIsolationPOST(t, r, layer, oi.VersionID); rec.Code != http.StatusOK {
t.Fatalf("POST after restart: %d %s", rec.Code, rec.Body.String())
}
if err := layer.wait(t); err != nil {
t.Fatal(err)
}
info := restoreIsolationSettled(t, r, oi.VersionID)
if info.IsRemote() || info.UserDefined[restoreIsolationAttemptKey] != "" {
t.Errorf("restore after restart incomplete: remote=%v attempt=%q", info.IsRemote(), info.UserDefined[restoreIsolationAttemptKey])
}
if _, got, err := r.read(oi.VersionID); err != nil || !bytes.Equal(got, body) {
t.Errorf("contents after restart: %v", err)
}
}
// A null version replaced while its restore was queued is another version:
// the restore must not rehydrate it, even if it is transitioned as well.
func TestRestoreReplacementNullObject(t *testing.T) {
for _, state := range []versioning.State{"", versioning.Suspended} {
t.Run(fmt.Sprintf("versioning=%q", state), func(t *testing.T) {
r := newRestoreSafetyTest(t, 1, state)
initConfigSubsystem(t.Context(), r.z)
oi, _ := restoreIsolationSeed(t, r, 0, true, false)
release := make(chan struct{})
layer := newRestoreIsolationLayer(r)
layer.restore = func(ctx context.Context, bucket, object string, opts ObjectOptions) error {
<-release
return r.z.RestoreTransitionedObject(ctx, bucket, object, opts)
}
if rec := restoreIsolationPOST(t, r, layer, ""); rec.Code != http.StatusOK {
close(release)
t.Fatalf("POST: %d %s", rec.Code, rec.Body.String())
}
replacement := []byte("replacement null object")
repl, err := r.z.serverPools[0].PutObject(t.Context(), r.bucket, r.object,
mustGetPutObjReader(t, bytes.NewReader(replacement), int64(len(replacement)), "", ""),
ObjectOptions{VersionSuspended: state == versioning.Suspended})
if err != nil {
close(release)
t.Fatal(err)
}
topts := r.opts(nullVersionID)
topts.MTime = repl.ModTime
topts.Transition = TransitionOptions{Tier: "WARM", ETag: repl.ETag}
if err := r.z.serverPools[0].TransitionObject(t.Context(), r.bucket, r.object, topts); err != nil {
close(release)
t.Fatal(err)
}
tier := globalTierConfigMgr.drivercache["WARM"].(*restoreTestTier)
before := r.fileInfo(nullVersionID)
gets := tier.gets.Load()
close(release)
layer.wait(t)
after := r.fileInfo(nullVersionID)
if tier.gets.Load() != gets || after.Metadata[xhttp.AmzRestore] != "" || !reflect.DeepEqual(before.Metadata, after.Metadata) {
t.Errorf("queued restore rehydrated the replacement null object: %q", after.Metadata[xhttp.AmzRestore])
}
if after.ModTime.Equal(oi.ModTime) || !after.ModTime.Equal(repl.ModTime) {
t.Fatal("fixture did not replace the null version")
}
if _, got, err := r.read(nullVersionID); err != nil || !bytes.Equal(got, replacement) {
t.Errorf("replacement contents: %v", err)
}
})
}
}
// POST's own status write can fail after its ongoing marker reached the
// drives; the marker must not stay for every later POST to refuse.
func TestRestorePOSTStatusWritePartialFailure(t *testing.T) {
r := newRestoreSafetyTest(t, 1, versioning.Enabled)
initConfigSubsystem(t.Context(), r.z)
oi, body := restoreIsolationSeed(t, r, 0, false, false)
_, writes := installRestoreIsolationFaults(r, 0, 2)
layer := newRestoreIsolationLayer(r)
writes.Store(true)
rec := restoreIsolationPOST(t, r, layer, oi.VersionID)
writes.Store(false)
if rec.Code < 400 {
t.Fatalf("POST acknowledged a failed status write: %d %s", rec.Code, rec.Body.String())
}
if info, err := r.z.GetObjectInfo(t.Context(), r.bucket, r.object, r.opts(oi.VersionID)); err == nil && !info.RestoreOngoing {
t.Log("the failed status write left no marker in quorum")
}
restoreIsolationSettled(t, r, oi.VersionID)
if rec := restoreIsolationPOST(t, r, layer, oi.VersionID); rec.Code != http.StatusOK {
t.Fatalf("POST after a failed status write: %d %s", rec.Code, rec.Body.String())
}
if err := layer.wait(t); err != nil {
t.Fatal(err)
}
if _, got, err := r.read(oi.VersionID); err != nil || !bytes.Equal(got, body) {
t.Errorf("restore after a failed status write: %v", err)
}
}
// Duplicate copies of a version in two pools can differ in whether they
// hold a restored copy. A completed restore header must never reach a copy
// without one; POST renews or restores only the copy that restores serve.
func TestRestoreDuplicatePoolCacheStates(t *testing.T) {
for _, mode := range []string{"suspended-owner", "unrestored-first", "restored-first"} {
t.Run(mode, func(t *testing.T) {
r := newRestoreSafetyTest(t, 2, versioning.Enabled)
initConfigSubsystem(t.Context(), r.z)
oi, body := restoreIsolationSeed(t, r, 0, false, false)
// The duplicate is the same stored version, metadata only.
src := r.z.serverPools[0].getHashedSet(r.object).getDisks()
dst := r.z.serverPools[1].getHashedSet(r.object).getDisks()
for i := range src {
raw, err := src[i].ReadAll(t.Context(), r.bucket, pathJoin(r.object, xlStorageFormatFile))
if err != nil {
t.Fatal(err)
}
if err := dst[i].WriteAll(t.Context(), r.bucket, pathJoin(r.object, xlStorageFormatFile), raw); err != nil {
t.Fatal(err)
}
}
owner := 0
if mode == "unrestored-first" {
owner = 1
}
if err := r.z.serverPools[owner].RestoreTransitionedObject(t.Context(), r.bucket, r.object, nativeRestoreOptions(r, oi.VersionID)); err != nil {
t.Fatal(err)
}
if mode == "suspended-owner" {
r.z.poolMetaMutex.Lock()
r.z.poolMeta.Pools[0].Decommission = &PoolDecommissionInfo{}
r.z.poolMetaMutex.Unlock()
t.Cleanup(func() {
r.z.poolMetaMutex.Lock()
r.z.poolMeta.Pools[0].Decommission = nil
r.z.poolMetaMutex.Unlock()
})
}
before := nativeRestoreSnapshot(t, r)
layer := newRestoreIsolationLayer(r)
if rec := restoreIsolationPOST(t, r, layer, oi.VersionID); rec.Code != http.StatusOK {
t.Fatalf("POST: %d %s", rec.Code, rec.Body.String())
}
if mode != "restored-first" {
select {
case err := <-layer.done:
if err != nil {
t.Fatal(err)
}
case <-time.After(5 * time.Second):
t.Error("POST did not restore the copy without restored data")
}
}
after := nativeRestoreSnapshot(t, r)
for pool := range r.z.serverPools {
gr, err := r.z.serverPools[pool].GetObjectNInfo(t.Context(), r.bucket, r.object, nil, nil, ObjectOptions{VersionID: oi.VersionID})
if err != nil {
t.Errorf("pool %d copy unreadable, header %q: %v", pool, after[pool][0].Metadata[xhttp.AmzRestore], err)
continue
}
got, err := io.ReadAll(gr)
gr.Close()
if err != nil || !bytes.Equal(got, body) {
t.Errorf("pool %d copy contents: %v", pool, err)
}
}
// The copy that is neither renewed nor restored stays as it was.
untouched := 1
if mode == "suspended-owner" {
untouched = 0
}
if !reflect.DeepEqual(before[untouched], after[untouched]) {
t.Errorf("POST changed the pool %d copy: %q -> %q", untouched, before[untouched][0].Metadata[xhttp.AmzRestore], after[untouched][0].Metadata[xhttp.AmzRestore])
}
})
}
}
// Stale-upload cleanup ages an upload by when it started, not by the
// version's ModTime, keeps the upload of a running restore beyond the stale
// age, and still removes ordinary stale uploads and those of ended attempts.
func TestRestoreUploadOutlivesStaleAge(t *testing.T) {
cleanup := func(t *testing.T, r *restoreTest) {
er := r.z.serverPools[0].getHashedSet(r.object)
for _, disk := range er.getDisks() {
er.cleanupStaleUploadsOnDisk(t.Context(), disk)
}
}
shortExpiry := func(t *testing.T) {
globalAPIConfig.mu.Lock()
prev := globalAPIConfig.staleUploadsExpiry
globalAPIConfig.staleUploadsExpiry = time.Nanosecond
globalAPIConfig.mu.Unlock()
t.Cleanup(func() {
globalAPIConfig.mu.Lock()
globalAPIConfig.staleUploadsExpiry = prev
globalAPIConfig.mu.Unlock()
})
}
for _, mode := range []string{"old-version", "past-stale-age", "public-abort", "ordinary-stale", "unowned-marker"} {
t.Run(mode, func(t *testing.T) {
r := newRestoreSafetyTest(t, 2, versioning.Enabled)
initConfigSubsystem(t.Context(), r.z)
if mode == "ordinary-stale" {
// Control: an abandoned client upload, old by its upload ID.
if _, err := r.z.NewMultipartUpload(t.Context(), r.bucket, r.object, ObjectOptions{MTime: UTCNow().Add(-72 * time.Hour)}); err != nil {
t.Fatal(err)
}
cleanup(t, r)
if uploads := restoreIsolationUploads(t, r, 0); len(uploads) != 0 {
t.Errorf("ordinary stale upload survived cleanup: %v", uploads)
}
return
}
var oi ObjectInfo
var body []byte
if mode == "past-stale-age" {
oi, body = restoreIsolationSeed(t, r, 0, false, true)
} else {
oi, body = nativeRestoreSeed(t, r, 0, false, true)
}
old := r.opts(oi.VersionID)
old.MTime = UTCNow().Add(-72 * time.Hour)
old.EvalMetadataFn = func(*ObjectInfo, error) (ReplicateDecision, error) { return ReplicateDecision{}, nil }
if _, err := r.z.PutObjectMetadata(t.Context(), r.bucket, r.object, old); err != nil {
t.Fatal(err)
}
// The cleanup with a short stale age also removes in-flight
// temporary parts; hold such restores in completion instead,
// before their commit.
gated := mode == "past-stale-age" || mode == "unowned-marker"
tier := newRestoreIsolationGateTier(5<<20, nil)
if !gated {
globalTierConfigMgr.drivercache["WARM"] = tier
}
defer tier.unblock()
gate := &restoreIsolationCompletionGate{entered: make(chan struct{}), release: make(chan struct{})}
defer gate.unblock()
if gated {
er := r.z.serverPools[0].getHashedSet(r.object)
original := er.getDisks
disks := original()
wrapped := make([]StorageAPI, len(disks))
for i, d := range disks {
wrapped[i] = restoreIsolationValidationDisk{d, gate}
}
er.getDisks = func() []StorageAPI { return wrapped }
defer func() { er.getDisks = original }()
}
result := make(chan error, 1)
layer := newRestoreIsolationLayer(r)
if mode == "past-stale-age" {
// A POST publishes the attempt that a running restore owns.
if rec := restoreIsolationPOST(t, r, layer, oi.VersionID); rec.Code != http.StatusOK {
t.Fatalf("POST: %d %s", rec.Code, rec.Body.String())
}
} else {
go func() {
result <- r.z.RestoreTransitionedObject(t.Context(), r.bucket, r.object, nativeRestoreOptions(r, oi.VersionID))
}()
}
if gated {
select {
case <-gate.entered:
case <-time.After(10 * time.Second):
t.Fatal("restore never reached completion")
}
} else {
restoreIsolationEntered(t, tier)
}
switch mode {
case "past-stale-age", "unowned-marker":
shortExpiry(t)
cleanup(t, r)
kept := len(restoreIsolationUploads(t, r, 0)) == 1
if mode == "unowned-marker" && kept {
// The version is ongoing, but not for this direct restore's
// upload: an ongoing marker alone does not keep an upload.
t.Error("stale cleanup kept an upload no attempt owns")
}
if mode == "past-stale-age" && !kept {
t.Error("stale cleanup removed the upload of a running restore")
}
case "old-version":
cleanup(t, r)
case "public-abort":
id, _ := restoreIsolationUpload(t, r, 0)
if err := r.z.AbortMultipartUpload(t.Context(), r.bucket, r.object, id, ObjectOptions{}); !errors.As(err, &InvalidUploadID{}) {
t.Errorf("public abort of a native restore upload: %v, want NoSuchUpload", err)
}
}
tier.unblock()
gate.unblock()
var err error
if mode == "past-stale-age" {
err = layer.wait(t)
} else {
err = <-result
}
if mode == "unowned-marker" {
if err == nil {
t.Error("restore completed without its upload")
}
return
}
if err != nil {
t.Fatalf("restore lost its upload: %v", err)
}
_, got, err := r.read(oi.VersionID)
if err != nil || !bytes.Equal(got, body) {
t.Fatalf("restore contents: %v", err)
}
})
}
}
// A failed multipart restore removes its own upload from the drives, also
// when a newer attempt owns the version by then, and leaves that newer
// attempt's marker alone.
func TestRestoreFailureAbortsUpload(t *testing.T) {
for _, mode := range []string{"download-failure", "superseded-mid-download"} {
t.Run(mode, func(t *testing.T) {
r := newRestoreSafetyTest(t, 1, versioning.Enabled)
initConfigSubsystem(t.Context(), r.z)
failure := errors.New("injected remote failure")
if mode == "download-failure" {
oi, _ := nativeRestoreSeed(t, r, 0, false, true)
tier := globalTierConfigMgr.drivercache["WARM"].(*restoreTestTier)
globalTierConfigMgr.drivercache["WARM"] = nativeRestoreFailTier{tier, failure}
if err := r.z.RestoreTransitionedObject(t.Context(), r.bucket, r.object, nativeRestoreOptions(r, oi.VersionID)); !errors.Is(err, failure) {
t.Fatalf("restore error=%v, want %v", err, failure)
}
if uploads := restoreIsolationUploads(t, r, 0); len(uploads) != 0 {
t.Errorf("failed native restore left its upload on disk: %v", uploads)
}
return
}
oi, _ := restoreIsolationSeed(t, r, 0, false, true)
tier := newRestoreIsolationGateTier(5<<20, failure)
globalTierConfigMgr.drivercache["WARM"] = tier
defer tier.unblock()
layer := newRestoreIsolationLayer(r)
if rec := restoreIsolationPOST(t, r, layer, oi.VersionID); rec.Code != http.StatusOK {
t.Fatalf("POST: %d %s", rec.Code, rec.Body.String())
}
restoreIsolationEntered(t, tier)
if uploads := restoreIsolationUploads(t, r, 0); len(uploads) != 1 {
t.Fatalf("restore upload on disk: %v", uploads)
}
// Model a newer generation that owns the version by now, such as
// one that took over after this restore lost its lock.
newer := r.opts(oi.VersionID)
newer.MTime = oi.ModTime
newer.NoLock = true
newer.EvalMetadataFn = func(o *ObjectInfo, _ error) (ReplicateDecision, error) {
o.UserDefined[restoreIsolationAttemptKey] = "newer-generation"
return ReplicateDecision{}, nil
}
if _, err := r.z.serverPools[0].getHashedSet(r.object).PutObjectMetadata(t.Context(), r.bucket, r.object, newer); err != nil {
t.Fatal(err)
}
tier.unblock()
if err := layer.wait(t); !errors.Is(err, failure) {
t.Fatalf("restore error=%v, want %v", err, failure)
}
if uploads := restoreIsolationUploads(t, r, 0); len(uploads) != 0 {
t.Errorf("superseded restore left its upload on disk: %v", uploads)
}
after := r.fileInfo(oi.VersionID)
if !strings.Contains(after.Metadata[xhttp.AmzRestore], "true") || after.Metadata[restoreIsolationAttemptKey] != "newer-generation" {
t.Errorf("failed restore cleared a newer attempt's marker: %q %q", after.Metadata[xhttp.AmzRestore], after.Metadata[restoreIsolationAttemptKey])
}
})
}
}
// A restored copy expires only by its own reason, on a fresh read: its
// restore deadline passed and nothing else. A renewed deadline survives
// another rule falling due and an expiry checked across all pools.
func TestExpireRestoredNeedsOwnReason(t *testing.T) {
for _, mode := range []string{"other-expiry-due", "checked-all-pools", "ongoing", "renewed", "expired"} {
t.Run(mode, func(t *testing.T) {
r := newRestoreSafetyTest(t, 1, versioning.Enabled)
oi := r.put("restored", false, true)
r.restore(oi)
before := r.fileInfo(oi.VersionID)
if mode == "other-expiry-due" {
meta, err := globalBucketMetadataSys.Get(r.bucket)
if err != nil {
t.Fatal(err)
}
meta.LifecycleConfigXML = []byte(`<LifecycleConfiguration><Rule><ID>delete</ID><Status>Enabled</Status><Filter><Prefix></Prefix></Filter><Expiration><Date>2020-01-01T00:00:00Z</Date></Expiration></Rule></LifecycleConfiguration>`)
if err := meta.Save(t.Context(), r.z); err != nil {
t.Fatal(err)
}
globalBucketMetadataSys.Set(r.bucket, meta)
}
header := completedRestoreObj(UTCNow().Add(48 * time.Hour)).String()
switch mode {
case "ongoing":
header = ongoingRestoreObj().String()
case "expired":
header = ""
}
if header != "" {
opts := r.opts(oi.VersionID)
opts.MTime = oi.ModTime
opts.EvalMetadataFn = func(o *ObjectInfo, _ error) (ReplicateDecision, error) {
o.UserDefined[xhttp.AmzRestore] = header
return ReplicateDecision{}, nil
}
if _, err := r.z.PutObjectMetadata(t.Context(), r.bucket, r.object, opts); err != nil {
t.Fatal(err)
}
}
var err error
if mode == "checked-all-pools" {
opts := r.opts(oi.VersionID)
opts.Expiration = ExpirationOptions{Expire: true, CheckedAllPools: true}
opts.Transition.ExpireRestored = true
_, err = r.z.serverPools[0].getHashedSet(r.object).DeleteObject(t.Context(), r.bucket, r.object, opts)
} else {
err = expireTransitionedObject(t.Context(), r.z, &oi, lifecycle.Event{Action: lifecycle.DeleteRestoredAction}, lcEventSrc_Scanner)
}
after := r.fileInfo(oi.VersionID)
if mode == "expired" {
// Control: an elapsed deadline is the reason itself.
if err != nil || after.Metadata[xhttp.AmzRestore] != "" || r.dataDirs(before.DataDir) != 0 {
t.Errorf("expired restored copy not removed: %v", err)
}
return
}
t.Logf("cleanup=%v header=%q", err, after.Metadata[xhttp.AmzRestore])
if err == nil || after.Metadata[xhttp.AmzRestore] != header || r.dataDirs(before.DataDir) != len(r.z.serverPools[0].getHashedSet(r.object).getDisks()) {
t.Error("cache cleanup removed a restored copy whose own deadline has not passed")
}
})
}
}
// Caller metadata cannot make an upload a native restore upload: the marker
// is dropped, the upload stays an ordinary one and nothing commits it.
func TestRestoreUploadMarkerSpoofing(t *testing.T) {
r := newRestoreSafetyTest(t, 1, versioning.Enabled)
oi, _ := nativeRestoreSeed(t, r, 0, false, true)
forged := fmt.Sprintf(`{"id":%q,"v":%q,"e":%q,"s":%d,"m":%q}`, mustGetUUID(), oi.VersionID, oi.ETag, oi.Size, oi.ModTime.UTC().Format(time.RFC3339Nano))
for _, target := range []string{"existing-version", "new-object"} {
t.Run(target, func(t *testing.T) {
opts := ObjectOptions{Versioned: true, UserDefined: map[string]string{restoreIsolationUploadKey: forged}}
object := r.object
if target == "existing-version" {
opts.VersionID = oi.VersionID
opts.MTime = oi.ModTime
opts.PreserveETag = oi.ETag
} else {
object = "spoofed-" + r.object
}
upload, err := r.z.NewMultipartUpload(t.Context(), r.bucket, object, opts)
if err != nil {
t.Fatal(err)
}
uploads, err := r.z.ListMultipartUploads(t.Context(), r.bucket, object, "", "", "", 100)
if err != nil || len(uploads.Uploads) != 1 || uploads.Uploads[0].UploadID != upload.UploadID {
t.Fatalf("a caller's upload must stay listed: %+v, %v", uploads.Uploads, err)
}
data := []byte("spoofed part")
part, err := r.z.PutObjectPart(t.Context(), r.bucket, object, upload.UploadID, 1, mustGetPutObjReader(t, bytes.NewReader(data), int64(len(data)), "", ""), ObjectOptions{})
if err != nil {
t.Fatal(err)
}
before := nativeRestoreSnapshot(t, r)
done, err := r.z.CompleteMultipartUpload(t.Context(), r.bucket, object, upload.UploadID, []CompletePart{{PartNumber: 1, ETag: part.ETag}}, ObjectOptions{Versioned: true, MTime: opts.MTime})
if target == "existing-version" {
if !errors.Is(err, errAuthentication) {
t.Errorf("spoofed upload overwrote the transitioned version: %v", err)
}
if !reflect.DeepEqual(before, nativeRestoreSnapshot(t, r)) {
t.Error("rejected spoofed completion changed the version")
}
return
}
if err != nil {
t.Fatal(err)
}
info, err := r.z.GetObjectInfo(t.Context(), r.bucket, object, ObjectOptions{VersionID: done.VersionID})
if err != nil || info.UserDefined[restoreIsolationUploadKey] != "" {
t.Errorf("caller metadata committed a restore upload marker: %q, %v", info.UserDefined[restoreIsolationUploadKey], err)
}
})
}
}
// Controls: an ordinary POST restore, a renewal, and a client's multipart
// upload of the same key while a restore runs.
func TestRestorePOSTControls(t *testing.T) {
t.Run("restore", func(t *testing.T) {
r := newRestoreSafetyTest(t, 1, versioning.Enabled)
initConfigSubsystem(t.Context(), r.z)
oi, body := restoreIsolationSeed(t, r, 0, false, true)
layer := newRestoreIsolationLayer(r)
if rec := restoreIsolationPOST(t, r, layer, oi.VersionID); rec.Code != http.StatusOK {
t.Fatalf("POST: %d %s", rec.Code, rec.Body.String())
}
if err := layer.wait(t); err != nil {
t.Fatal(err)
}
info, err := r.z.GetObjectInfo(t.Context(), r.bucket, r.object, r.opts(oi.VersionID))
if err != nil || info.IsRemote() || info.RestoreOngoing || info.UserDefined[restoreIsolationAttemptKey] != "" {
t.Fatalf("restored status: %q %q, %v", info.UserDefined[xhttp.AmzRestore], info.UserDefined[restoreIsolationAttemptKey], err)
}
if !info.ModTime.Equal(oi.ModTime) || info.ETag != oi.ETag || info.UserDefined["x-amz-meta-preserve"] != "keep-me" {
t.Error("restore changed the version identity or metadata")
}
if _, got, err := r.read(oi.VersionID); err != nil || !bytes.Equal(got, body) {
t.Errorf("restored contents: %v", err)
}
if uploads := restoreIsolationUploads(t, r, 0); len(uploads) != 0 {
t.Errorf("completed restore left its upload: %v", uploads)
}
})
t.Run("renewal", func(t *testing.T) {
r := newRestoreSafetyTest(t, 1, versioning.Enabled)
initConfigSubsystem(t.Context(), r.z)
oi, body := nativeRestoreSeed(t, r, 0, false, false)
if err := r.z.RestoreTransitionedObject(t.Context(), r.bucket, r.object, nativeRestoreOptions(r, oi.VersionID)); err != nil {
t.Fatal(err)
}
tier := globalTierConfigMgr.drivercache["WARM"].(*restoreTestTier)
before := r.fileInfo(oi.VersionID)
gets := tier.gets.Load()
layer := newRestoreIsolationLayer(r)
if rec := restoreIsolationPOST(t, r, layer, oi.VersionID); rec.Code != http.StatusOK {
t.Fatalf("POST: %d %s", rec.Code, rec.Body.String())
}
select {
case err := <-layer.done:
t.Fatalf("renewal restored again: %v", err)
case <-time.After(200 * time.Millisecond):
}
after := r.fileInfo(oi.VersionID)
if after.DataDir != before.DataDir || !after.ModTime.Equal(before.ModTime) || after.Metadata[xhttp.AmzRestore] == "" {
t.Error("renewal changed the restored copy")
}
if _, got, err := r.read(oi.VersionID); err != nil || !bytes.Equal(got, body) || tier.gets.Load() != gets {
t.Errorf("renewed copy not served locally: %v", err)
}
})
t.Run("public-multipart-same-key", func(t *testing.T) {
r := newRestoreSafetyTest(t, 1, versioning.Enabled)
initConfigSubsystem(t.Context(), r.z)
oi, body := restoreIsolationSeed(t, r, 0, false, true)
tier := newRestoreIsolationGateTier(5<<20, nil)
globalTierConfigMgr.drivercache["WARM"] = tier
defer tier.unblock()
layer := newRestoreIsolationLayer(r)
if rec := restoreIsolationPOST(t, r, layer, oi.VersionID); rec.Code != http.StatusOK {
t.Fatalf("POST: %d %s", rec.Code, rec.Body.String())
}
restoreIsolationEntered(t, tier)
upload, err := r.z.NewMultipartUpload(t.Context(), r.bucket, r.object, ObjectOptions{Versioned: true})
if err != nil {
t.Fatal(err)
}
uploads, err := r.z.ListMultipartUploads(t.Context(), r.bucket, r.object, "", "", "", 100)
listed := false
for _, u := range uploads.Uploads {
listed = listed || u.UploadID == upload.UploadID
}
if err != nil || !listed {
t.Fatalf("client upload not listed: %+v, %v", uploads.Uploads, err)
}
tier.unblock()
if err := layer.wait(t); err != nil {
t.Fatal(err)
}
// Single-pool part writes wait for the object lock of a running restore.
data := []byte("client data")
part, err := r.z.PutObjectPart(t.Context(), r.bucket, r.object, upload.UploadID, 1, mustGetPutObjReader(t, bytes.NewReader(data), int64(len(data)), "", ""), ObjectOptions{})
if err != nil {
t.Fatal(err)
}
parts, err := r.z.ListObjectParts(t.Context(), r.bucket, r.object, upload.UploadID, 0, 10, ObjectOptions{})
if err != nil || len(parts.Parts) != 1 {
t.Fatalf("client parts: %+v, %v", parts, err)
}
newer, err := r.z.CompleteMultipartUpload(t.Context(), r.bucket, r.object, upload.UploadID, []CompletePart{{PartNumber: 1, ETag: part.ETag}}, ObjectOptions{Versioned: true})
if err != nil {
t.Fatal(err)
}
if _, got, err := r.read(newer.VersionID); err != nil || !bytes.Equal(got, data) {
t.Errorf("client version: %v", err)
}
if _, got, err := r.read(oi.VersionID); err != nil || !bytes.Equal(got, body) {
t.Errorf("restored version: %v", err)
}
})
}