package test
import (
- "fmt"
"io"
"io/ioutil"
"os"
"sync"
"testing"
+ "testing/iotest"
"time"
"github.com/anacrolix/missinggo/v2/filecache"
"github.com/anacrolix/torrent"
"github.com/anacrolix/torrent/internal/testutil"
"github.com/anacrolix/torrent/storage"
+ qt "github.com/frankban/quicktest"
"golang.org/x/time/rate"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
-type testClientTransferParams struct {
- Responsive bool
- Readahead int64
- SetReadahead bool
- ExportClientStatus bool
- LeecherStorage func(string) storage.ClientImplCloser
- SeederStorage func(string) storage.ClientImplCloser
- SeederUploadRateLimiter *rate.Limiter
- LeecherDownloadRateLimiter *rate.Limiter
- ConfigureSeeder ConfigureClient
- ConfigureLeecher ConfigureClient
-}
-
-func assertReadAllGreeting(t *testing.T, r io.ReadSeeker) {
- pos, err := r.Seek(0, io.SeekStart)
- assert.NoError(t, err)
- assert.EqualValues(t, 0, pos)
- _greeting, err := ioutil.ReadAll(r)
- assert.NoError(t, err)
- assert.EqualValues(t, testutil.GreetingFileContents, _greeting)
-}
-
-// Creates a seeder and a leecher, and ensures the data transfers when a read
-// is attempted on the leecher.
-func testClientTransfer(t *testing.T, ps testClientTransferParams) {
- greetingTempDir, mi := testutil.GreetingTestTorrent()
- defer os.RemoveAll(greetingTempDir)
- // Create seeder and a Torrent.
- cfg := torrent.TestingConfig()
- cfg.Seed = true
- if ps.SeederUploadRateLimiter != nil {
- cfg.UploadRateLimiter = ps.SeederUploadRateLimiter
- }
- // cfg.ListenAddr = "localhost:4000"
- if ps.SeederStorage != nil {
- storage := ps.SeederStorage(greetingTempDir)
- defer storage.Close()
- cfg.DefaultStorage = storage
- } else {
- cfg.DataDir = greetingTempDir
- }
- if ps.ConfigureSeeder.Config != nil {
- ps.ConfigureSeeder.Config(cfg)
- }
- seeder, err := torrent.NewClient(cfg)
- require.NoError(t, err)
- if ps.ConfigureSeeder.Client != nil {
- ps.ConfigureSeeder.Client(seeder)
- }
- if ps.ExportClientStatus {
- defer testutil.ExportStatusWriter(seeder, "s")()
- }
- seederTorrent, _, _ := seeder.AddTorrentSpec(torrent.TorrentSpecFromMetaInfo(mi))
- // Run a Stats right after Closing the Client. This will trigger the Stats
- // panic in #214 caused by RemoteAddr on Closed uTP sockets.
- defer seederTorrent.Stats()
- defer seeder.Close()
- seederTorrent.VerifyData()
- // Create leecher and a Torrent.
- leecherDataDir, err := ioutil.TempDir("", "")
- require.NoError(t, err)
- defer os.RemoveAll(leecherDataDir)
- cfg = torrent.TestingConfig()
- if ps.LeecherStorage == nil {
- cfg.DataDir = leecherDataDir
- } else {
- storage := ps.LeecherStorage(leecherDataDir)
- defer storage.Close()
- cfg.DefaultStorage = storage
- }
- if ps.LeecherDownloadRateLimiter != nil {
- cfg.DownloadRateLimiter = ps.LeecherDownloadRateLimiter
- }
- cfg.Seed = false
- //cfg.Debug = true
- if ps.ConfigureLeecher.Config != nil {
- ps.ConfigureLeecher.Config(cfg)
- }
- leecher, err := torrent.NewClient(cfg)
- require.NoError(t, err)
- defer leecher.Close()
- if ps.ConfigureLeecher.Client != nil {
- ps.ConfigureLeecher.Client(leecher)
- }
- if ps.ExportClientStatus {
- defer testutil.ExportStatusWriter(leecher, "l")()
- }
- leecherTorrent, new, err := leecher.AddTorrentSpec(func() (ret *torrent.TorrentSpec) {
- ret = torrent.TorrentSpecFromMetaInfo(mi)
- ret.ChunkSize = 2
- return
- }())
- require.NoError(t, err)
- assert.True(t, new)
-
- //// This was used when observing coalescing of piece state changes.
- //logPieceStateChanges(leecherTorrent)
-
- // Now do some things with leecher and seeder.
- leecherTorrent.AddClientPeer(seeder)
- // The Torrent should not be interested in obtaining peers, so the one we
- // just added should be the only one.
- assert.False(t, leecherTorrent.Seeding())
- assert.EqualValues(t, 1, leecherTorrent.Stats().PendingPeers)
- r := leecherTorrent.NewReader()
- defer r.Close()
- if ps.Responsive {
- r.SetResponsive()
- }
- if ps.SetReadahead {
- r.SetReadahead(ps.Readahead)
- }
- assertReadAllGreeting(t, r)
- assert.NotEmpty(t, seederTorrent.PeerConns())
- leecherPeerConns := leecherTorrent.PeerConns()
- assert.NotEmpty(t, leecherPeerConns)
- for _, pc := range leecherPeerConns {
- assert.EqualValues(t, leecherTorrent.Info().NumPieces(), pc.PeerPieces().Len())
- }
-
- seederStats := seederTorrent.Stats()
- assert.True(t, 13 <= seederStats.BytesWrittenData.Int64())
- assert.True(t, 8 <= seederStats.ChunksWritten.Int64())
-
- leecherStats := leecherTorrent.Stats()
- assert.True(t, 13 <= leecherStats.BytesReadData.Int64())
- assert.True(t, 8 <= leecherStats.ChunksRead.Int64())
-
- // Try reading through again for the cases where the torrent data size
- // exceeds the size of the cache.
- assertReadAllGreeting(t, r)
-}
-
type fileCacheClientStorageFactoryParams struct {
Capacity int64
SetCapacity bool
- Wrapper func(*filecache.Cache) storage.ClientImplCloser
}
-func newFileCacheClientStorageFactory(ps fileCacheClientStorageFactoryParams) storageFactory {
+func newFileCacheClientStorageFactory(ps fileCacheClientStorageFactoryParams) StorageFactory {
return func(dataDir string) storage.ClientImplCloser {
fc, err := filecache.NewCache(dataDir)
if err != nil {
panic(err)
}
+ var sharedCapacity *int64
if ps.SetCapacity {
+ sharedCapacity = &ps.Capacity
fc.SetCapacity(ps.Capacity)
}
- return ps.Wrapper(fc)
+ return struct {
+ storage.ClientImpl
+ io.Closer
+ }{
+ storage.NewResourcePiecesOpts(
+ fc.AsResourceProvider(),
+ storage.ResourcePiecesOpts{
+ Capacity: sharedCapacity,
+ }),
+ ioutil.NopCloser(nil),
+ }
}
}
-type storageFactory func(string) storage.ClientImplCloser
-
func TestClientTransferDefault(t *testing.T) {
testClientTransfer(t, testClientTransferParams{
- ExportClientStatus: true,
- LeecherStorage: newFileCacheClientStorageFactory(fileCacheClientStorageFactoryParams{
- Wrapper: fileCachePieceResourceStorage,
- }),
+ LeecherStorage: newFileCacheClientStorageFactory(fileCacheClientStorageFactoryParams{}),
+ })
+}
+
+func TestClientTransferDefaultNoMetadata(t *testing.T) {
+ testClientTransfer(t, testClientTransferParams{
+ LeecherStorage: newFileCacheClientStorageFactory(fileCacheClientStorageFactoryParams{}),
+ LeecherStartsWithoutMetadata: true,
})
}
// chunks are 2 bytes in length. Then the smallest burst we can run
// with is 2. Time taken is (13-burst)/rate.
SeederUploadRateLimiter: rate.NewLimiter(11, 2),
- ExportClientStatus: true,
})
require.True(t, time.Since(started) > time.Second)
}
func TestClientTransferRateLimitedDownload(t *testing.T) {
testClientTransfer(t, testClientTransferParams{
LeecherDownloadRateLimiter: rate.NewLimiter(512, 512),
+ ConfigureSeeder: ConfigureClient{
+ Config: func(cfg *torrent.ClientConfig) {
+ // If we send too many keep alives, we consume all the leechers available download
+ // rate. The default isn't exposed, but a minute is pretty reasonable.
+ cfg.KeepAliveTimeout = time.Minute
+ },
+ },
})
}
-func fileCachePieceResourceStorage(fc *filecache.Cache) storage.ClientImplCloser {
- return storage.NewResourcePieces(fc.AsResourceProvider())
-}
-
func testClientTransferSmallCache(t *testing.T, setReadahead bool, readahead int64) {
testClientTransfer(t, testClientTransferParams{
LeecherStorage: newFileCacheClientStorageFactory(fileCacheClientStorageFactoryParams{
// Going below the piece length means it can't complete a piece so
// that it can be hashed.
Capacity: 5,
- Wrapper: fileCachePieceResourceStorage,
}),
- SetReadahead: setReadahead,
+ LeecherStorageCapacity: 5,
+ SetReadahead: setReadahead,
// Can't readahead too far or the cache will thrash and drop data we
// thought we had.
- Readahead: readahead,
- ExportClientStatus: true,
+ Readahead: readahead,
+
+ // These tests don't work well with more than 1 connection to the seeder.
+ ConfigureLeecher: ConfigureClient{
+ Config: func(cfg *torrent.ClientConfig) {
+ cfg.DropDuplicatePeerIds = true
+ // cfg.DisableIPv6 = true
+ // cfg.DisableUTP = true
+ },
+ },
})
}
testClientTransferSmallCache(t, false, -1)
}
-func TestClientTransferVarious(t *testing.T) {
- // Leecher storage
- for _, ls := range []struct {
- name string
- f storageFactory
- }{
- {"Filecache", newFileCacheClientStorageFactory(fileCacheClientStorageFactoryParams{
- Wrapper: fileCachePieceResourceStorage,
- })},
- {"Boltdb", storage.NewBoltDB},
- } {
- t.Run(fmt.Sprintf("LeecherStorage=%s", ls.name), func(t *testing.T) {
- // Seeder storage
- for _, ss := range []struct {
- name string
- f func(string) storage.ClientImplCloser
- }{
- {"File", storage.NewFile},
- {"Mmap", storage.NewMMap},
- } {
- t.Run(fmt.Sprintf("%sSeederStorage", ss.name), func(t *testing.T) {
- for _, responsive := range []bool{false, true} {
- t.Run(fmt.Sprintf("Responsive=%v", responsive), func(t *testing.T) {
- t.Run("NoReadahead", func(t *testing.T) {
- testClientTransfer(t, testClientTransferParams{
- Responsive: responsive,
- SeederStorage: ss.f,
- LeecherStorage: ls.f,
- })
- })
- for _, readahead := range []int64{-1, 0, 1, 2, 3, 4, 5, 6, 9, 10, 11, 12, 13, 14, 15, 20} {
- t.Run(fmt.Sprintf("readahead=%v", readahead), func(t *testing.T) {
- testClientTransfer(t, testClientTransferParams{
- SeederStorage: ss.f,
- Responsive: responsive,
- SetReadahead: true,
- Readahead: readahead,
- LeecherStorage: ls.f,
- })
- })
- }
- })
- }
- })
- }
- })
- }
+func TestFilecacheClientTransferVarious(t *testing.T) {
+ TestLeecherStorage(t, LeecherStorageTestCase{
+ "Filecache", newFileCacheClientStorageFactory(fileCacheClientStorageFactoryParams{}), 0,
+ })
}
// Check that after completing leeching, a leecher transitions to a seeding
greetingTempDir, mi := testutil.GreetingTestTorrent()
defer os.RemoveAll(greetingTempDir)
- cfg := torrent.TestingConfig()
+ cfg := torrent.TestingConfig(t)
cfg.Seed = true
+ cfg.MaxAllocPeerRequestDataPerConn = 4
cfg.DataDir = greetingTempDir
seeder, err := torrent.NewClient(cfg)
require.NoError(t, err)
defer seeder.Close()
- defer testutil.ExportStatusWriter(seeder, "s")()
+ defer testutil.ExportStatusWriter(seeder, "s", t)()
seederTorrent, ok, err := seeder.AddTorrentSpec(torrent.TorrentSpecFromMetaInfo(mi))
require.NoError(t, err)
assert.True(t, ok)
seederTorrent.VerifyData()
- cfg = torrent.TestingConfig()
+ cfg = torrent.TestingConfig(t)
cfg.Seed = true
- cfg.DataDir, err = ioutil.TempDir("", "")
- require.NoError(t, err)
- defer os.RemoveAll(cfg.DataDir)
+ cfg.DataDir = t.TempDir()
leecher, err := torrent.NewClient(cfg)
require.NoError(t, err)
defer leecher.Close()
- defer testutil.ExportStatusWriter(leecher, "l")()
+ defer testutil.ExportStatusWriter(leecher, "l", t)()
- cfg = torrent.TestingConfig()
+ cfg = torrent.TestingConfig(t)
cfg.Seed = false
- cfg.DataDir, err = ioutil.TempDir("", "")
- require.NoError(t, err)
- defer os.RemoveAll(cfg.DataDir)
+ cfg.DataDir = t.TempDir()
+ cfg.MaxAllocPeerRequestDataPerConn = 4
leecherLeecher, _ := torrent.NewClient(cfg)
require.NoError(t, err)
defer leecherLeecher.Close()
- defer testutil.ExportStatusWriter(leecherLeecher, "ll")()
+ defer testutil.ExportStatusWriter(leecherLeecher, "ll", t)()
leecherGreeting, ok, err := leecher.AddTorrentSpec(func() (ret *torrent.TorrentSpec) {
ret = torrent.TorrentSpecFromMetaInfo(mi)
ret.ChunkSize = 2
defer wg.Done()
r := llg.NewReader()
defer r.Close()
- b, err := ioutil.ReadAll(r)
- require.NoError(t, err)
- assert.EqualValues(t, testutil.GreetingFileContents, b)
+ qt.Check(t, iotest.TestReader(r, []byte(testutil.GreetingFileContents)), qt.IsNil)
}()
done := make(chan struct{})
defer close(done)
}()
wg.Wait()
}
-
-type ConfigureClient struct {
- Config func(*torrent.ClientConfig)
- Client func(*torrent.Client)
-}