forked from TrueCloudLab/rclone
operations: fix overwrite of destination when multi-thread transfer fails
Before this change, if a multithread upload failed (let's say the source became unavailable) rclone would finalise the file first before aborting the transfer. This caused the partial file to be written which would overwrite any existing files. This was fixed by making sure we Abort the transfer before Close-ing it. This updates the docs to encourage calling of Abort before Close and updates writerAtChunkWriter to make sure that works properly. This also reworks the tests to detect this and to make sure we upload and download to each multi-thread capable backend (we were only downloading before which isn't a full test). Fixes #7071
This commit is contained in:
Nick Craig-Wood
parent
94ccc95515
commit
d5d28a7513
3 changed files with 206 additions and 39 deletions
|
|
@ -2,10 +2,16 @@ package operations
|
|||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/rclone/rclone/fs/accounting"
|
||||
"github.com/rclone/rclone/fs/hash"
|
||||
"github.com/rclone/rclone/fs/object"
|
||||
"github.com/rclone/rclone/fstest/mockfs"
|
||||
"github.com/rclone/rclone/fstest/mockobject"
|
||||
"github.com/rclone/rclone/lib/random"
|
||||
|
|
@ -108,45 +114,193 @@ func TestMultithreadCalculateNumChunks(t *testing.T) {
|
|||
}
|
||||
}
|
||||
|
||||
// Skip if not multithread, returning the chunkSize otherwise
|
||||
func skipIfNotMultithread(ctx context.Context, t *testing.T, r *fstest.Run) int {
|
||||
features := r.Fremote.Features()
|
||||
if features.OpenChunkWriter == nil && features.OpenWriterAt == nil {
|
||||
t.Skip("multithread writing not supported")
|
||||
}
|
||||
|
||||
// Only support one hash otherwise we end up spending a huge amount of CPU on hashing!
|
||||
oldHashes := hash.SupportOnly([]hash.Type{r.Fremote.Hashes().GetOne()})
|
||||
t.Cleanup(func() {
|
||||
_ = hash.SupportOnly(oldHashes)
|
||||
})
|
||||
|
||||
ci := fs.GetConfig(ctx)
|
||||
chunkSize := int(ci.MultiThreadChunkSize)
|
||||
if features.OpenChunkWriter != nil {
|
||||
//OpenChunkWriter func(ctx context.Context, remote string, src ObjectInfo, options ...OpenOption) (info ChunkWriterInfo, writer ChunkWriter, err error)
|
||||
const fileName = "chunksize-probe"
|
||||
src := object.NewStaticObjectInfo(fileName, time.Now(), int64(100*fs.Mebi), true, nil, nil)
|
||||
info, writer, err := features.OpenChunkWriter(ctx, fileName, src)
|
||||
require.NoError(t, err)
|
||||
chunkSize = int(info.ChunkSize)
|
||||
err = writer.Abort(ctx)
|
||||
require.NoError(t, err)
|
||||
}
|
||||
return chunkSize
|
||||
}
|
||||
|
||||
func TestMultithreadCopy(t *testing.T) {
|
||||
r := fstest.NewRun(t)
|
||||
ctx := context.Background()
|
||||
chunkSize := skipIfNotMultithread(ctx, t, r)
|
||||
|
||||
for _, test := range []struct {
|
||||
size int
|
||||
streams int
|
||||
}{
|
||||
{size: multithreadChunkSize*2 - 1, streams: 2},
|
||||
{size: multithreadChunkSize * 2, streams: 2},
|
||||
{size: multithreadChunkSize*2 + 1, streams: 2},
|
||||
} {
|
||||
t.Run(fmt.Sprintf("%+v", test), func(t *testing.T) {
|
||||
if *fstest.SizeLimit > 0 && int64(test.size) > *fstest.SizeLimit {
|
||||
t.Skipf("exceeded file size limit %d > %d", test.size, *fstest.SizeLimit)
|
||||
for _, upload := range []bool{false, true} {
|
||||
for _, test := range []struct {
|
||||
size int
|
||||
streams int
|
||||
}{
|
||||
{size: chunkSize*2 - 1, streams: 2},
|
||||
{size: chunkSize * 2, streams: 2},
|
||||
{size: chunkSize*2 + 1, streams: 2},
|
||||
} {
|
||||
fileName := fmt.Sprintf("test-multithread-copy-%v-%d-%d", upload, test.size, test.streams)
|
||||
t.Run(fmt.Sprintf("upload=%v,size=%v,streams=%v", upload, test.size, test.streams), func(t *testing.T) {
|
||||
if *fstest.SizeLimit > 0 && int64(test.size) > *fstest.SizeLimit {
|
||||
t.Skipf("exceeded file size limit %d > %d", test.size, *fstest.SizeLimit)
|
||||
}
|
||||
var (
|
||||
contents = random.String(test.size)
|
||||
t1 = fstest.Time("2001-02-03T04:05:06.499999999Z")
|
||||
file1 fstest.Item
|
||||
src, dst fs.Object
|
||||
err error
|
||||
)
|
||||
|
||||
if upload {
|
||||
file1 = r.WriteFile(fileName, contents, t1)
|
||||
r.CheckRemoteItems(t)
|
||||
r.CheckLocalItems(t, file1)
|
||||
src, err = r.Flocal.NewObject(ctx, fileName)
|
||||
} else {
|
||||
file1 = r.WriteObject(ctx, fileName, contents, t1)
|
||||
r.CheckRemoteItems(t, file1)
|
||||
r.CheckLocalItems(t)
|
||||
src, err = r.Fremote.NewObject(ctx, fileName)
|
||||
}
|
||||
require.NoError(t, err)
|
||||
|
||||
accounting.GlobalStats().ResetCounters()
|
||||
tr := accounting.GlobalStats().NewTransfer(src)
|
||||
|
||||
defer func() {
|
||||
tr.Done(ctx, err)
|
||||
}()
|
||||
|
||||
if upload {
|
||||
dst, err = multiThreadCopy(ctx, r.Fremote, fileName, src, test.streams, tr)
|
||||
} else {
|
||||
dst, err = multiThreadCopy(ctx, r.Flocal, fileName, src, test.streams, tr)
|
||||
}
|
||||
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, src.Size(), dst.Size())
|
||||
assert.Equal(t, fileName, dst.Remote())
|
||||
fstest.CheckListingWithPrecision(t, r.Fremote, []fstest.Item{file1}, nil, fs.GetModifyWindow(ctx, r.Flocal, r.Fremote))
|
||||
fstest.CheckListingWithPrecision(t, r.Flocal, []fstest.Item{file1}, nil, fs.GetModifyWindow(ctx, r.Flocal, r.Fremote))
|
||||
require.NoError(t, dst.Remove(ctx))
|
||||
require.NoError(t, src.Remove(ctx))
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
type errorObject struct {
|
||||
fs.Object
|
||||
size int64
|
||||
wg *sync.WaitGroup
|
||||
}
|
||||
|
||||
// Open opens the file for read. Call Close() on the returned io.ReadCloser
|
||||
//
|
||||
// Remember this is called multiple times whenever the backend seeks (eg having read checksum)
|
||||
func (o errorObject) Open(ctx context.Context, options ...fs.OpenOption) (io.ReadCloser, error) {
|
||||
fs.Debugf(nil, "Open with options = %v", options)
|
||||
rc, err := o.Object.Open(ctx, options...)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
// Return an error reader for the second segment
|
||||
for _, option := range options {
|
||||
if ropt, ok := option.(*fs.RangeOption); ok {
|
||||
end := ropt.End + 1
|
||||
if end >= o.size {
|
||||
// Give the other chunks a chance to start
|
||||
time.Sleep(time.Second)
|
||||
// Wait for chunks to upload first
|
||||
o.wg.Wait()
|
||||
fs.Debugf(nil, "Returning error reader")
|
||||
return errorReadCloser{rc}, nil
|
||||
}
|
||||
var err error
|
||||
contents := random.String(test.size)
|
||||
t1 := fstest.Time("2001-02-03T04:05:06.499999999Z")
|
||||
file1 := r.WriteObject(ctx, "file1", contents, t1)
|
||||
r.CheckRemoteItems(t, file1)
|
||||
r.CheckLocalItems(t)
|
||||
}
|
||||
}
|
||||
o.wg.Add(1)
|
||||
return wgReadCloser{rc, o.wg}, nil
|
||||
}
|
||||
|
||||
src, err := r.Fremote.NewObject(ctx, "file1")
|
||||
require.NoError(t, err)
|
||||
accounting.GlobalStats().ResetCounters()
|
||||
tr := accounting.GlobalStats().NewTransfer(src)
|
||||
type errorReadCloser struct {
|
||||
io.ReadCloser
|
||||
}
|
||||
|
||||
defer func() {
|
||||
tr.Done(ctx, err)
|
||||
}()
|
||||
dst, err := multiThreadCopy(ctx, r.Flocal, "file1", src, 2, tr)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, src.Size(), dst.Size())
|
||||
assert.Equal(t, "file1", dst.Remote())
|
||||
func (rc errorReadCloser) Read(p []byte) (n int, err error) {
|
||||
fs.Debugf(nil, "BOOM: simulated read failure")
|
||||
return 0, errors.New("BOOM: simulated read failure")
|
||||
}
|
||||
|
||||
fstest.CheckListingWithPrecision(t, r.Flocal, []fstest.Item{file1}, nil, fs.GetModifyWindow(ctx, r.Flocal, r.Fremote))
|
||||
require.NoError(t, dst.Remove(ctx))
|
||||
})
|
||||
type wgReadCloser struct {
|
||||
io.ReadCloser
|
||||
wg *sync.WaitGroup
|
||||
}
|
||||
|
||||
func (rc wgReadCloser) Close() (err error) {
|
||||
rc.wg.Done()
|
||||
return rc.ReadCloser.Close()
|
||||
}
|
||||
|
||||
// Make sure aborting the multi-thread copy doesn't overwrite an existing file.
|
||||
func TestMultithreadCopyAbort(t *testing.T) {
|
||||
r := fstest.NewRun(t)
|
||||
ctx := context.Background()
|
||||
chunkSize := skipIfNotMultithread(ctx, t, r)
|
||||
size := 2*chunkSize + 1
|
||||
|
||||
if *fstest.SizeLimit > 0 && int64(size) > *fstest.SizeLimit {
|
||||
t.Skipf("exceeded file size limit %d > %d", size, *fstest.SizeLimit)
|
||||
}
|
||||
|
||||
// first write a canary file which we are trying not to overwrite
|
||||
const fileName = "test-multithread-abort"
|
||||
contents := random.String(100)
|
||||
t1 := fstest.Time("2001-02-03T04:05:06.499999999Z")
|
||||
canary := r.WriteObject(ctx, fileName, contents, t1)
|
||||
r.CheckRemoteItems(t, canary)
|
||||
|
||||
// Now write a local file to upload
|
||||
file1 := r.WriteFile(fileName, random.String(size), t1)
|
||||
r.CheckLocalItems(t, file1)
|
||||
|
||||
src, err := r.Flocal.NewObject(ctx, fileName)
|
||||
require.NoError(t, err)
|
||||
accounting.GlobalStats().ResetCounters()
|
||||
tr := accounting.GlobalStats().NewTransfer(src)
|
||||
|
||||
defer func() {
|
||||
tr.Done(ctx, err)
|
||||
}()
|
||||
wg := new(sync.WaitGroup)
|
||||
dst, err := multiThreadCopy(ctx, r.Fremote, fileName, errorObject{src, int64(size), wg}, 1, tr)
|
||||
assert.Error(t, err)
|
||||
assert.Nil(t, dst)
|
||||
|
||||
if r.Fremote.Features().PartialUploads {
|
||||
r.CheckRemoteItems(t)
|
||||
|
||||
} else {
|
||||
r.CheckRemoteItems(t, canary)
|
||||
o, err := r.Fremote.NewObject(ctx, fileName)
|
||||
require.NoError(t, err)
|
||||
require.NoError(t, o.Remove(ctx))
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue