15 "github.com/anacrolix/missinggo/v2/filecache"
16 "github.com/anacrolix/torrent"
17 "github.com/anacrolix/torrent/internal/testutil"
18 "github.com/anacrolix/torrent/storage"
19 sqliteStorage "github.com/anacrolix/torrent/storage/sqlite"
20 "golang.org/x/time/rate"
22 "github.com/stretchr/testify/assert"
23 "github.com/stretchr/testify/require"
26 type testClientTransferParams struct {
30 LeecherStorage func(string) storage.ClientImplCloser
31 SeederStorage func(string) storage.ClientImplCloser
32 SeederUploadRateLimiter *rate.Limiter
33 LeecherDownloadRateLimiter *rate.Limiter
34 ConfigureSeeder ConfigureClient
35 ConfigureLeecher ConfigureClient
37 LeecherStartsWithoutMetadata bool
40 func assertReadAllGreeting(t *testing.T, r io.ReadSeeker) {
41 pos, err := r.Seek(0, io.SeekStart)
42 assert.NoError(t, err)
43 assert.EqualValues(t, 0, pos)
44 _greeting, err := ioutil.ReadAll(r)
45 assert.NoError(t, err)
46 assert.EqualValues(t, testutil.GreetingFileContents, string(_greeting))
49 // Creates a seeder and a leecher, and ensures the data transfers when a read
50 // is attempted on the leecher.
51 func testClientTransfer(t *testing.T, ps testClientTransferParams) {
52 greetingTempDir, mi := testutil.GreetingTestTorrent()
53 defer os.RemoveAll(greetingTempDir)
54 // Create seeder and a Torrent.
55 cfg := torrent.TestingConfig()
57 if ps.SeederUploadRateLimiter != nil {
58 cfg.UploadRateLimiter = ps.SeederUploadRateLimiter
60 // cfg.ListenAddr = "localhost:4000"
61 if ps.SeederStorage != nil {
62 storage := ps.SeederStorage(greetingTempDir)
64 cfg.DefaultStorage = storage
66 cfg.DataDir = greetingTempDir
68 if ps.ConfigureSeeder.Config != nil {
69 ps.ConfigureSeeder.Config(cfg)
71 seeder, err := torrent.NewClient(cfg)
72 require.NoError(t, err)
73 if ps.ConfigureSeeder.Client != nil {
74 ps.ConfigureSeeder.Client(seeder)
76 defer testutil.ExportStatusWriter(seeder, "s", t)()
77 seederTorrent, _, _ := seeder.AddTorrentSpec(torrent.TorrentSpecFromMetaInfo(mi))
78 // Run a Stats right after Closing the Client. This will trigger the Stats
79 // panic in #214 caused by RemoteAddr on Closed uTP sockets.
80 defer seederTorrent.Stats()
82 seederTorrent.VerifyData()
83 // Create leecher and a Torrent.
84 leecherDataDir, err := ioutil.TempDir("", "")
85 require.NoError(t, err)
86 defer os.RemoveAll(leecherDataDir)
87 cfg = torrent.TestingConfig()
88 if ps.LeecherStorage == nil {
89 cfg.DataDir = leecherDataDir
91 storage := ps.LeecherStorage(leecherDataDir)
93 cfg.DefaultStorage = storage
95 if ps.LeecherDownloadRateLimiter != nil {
96 cfg.DownloadRateLimiter = ps.LeecherDownloadRateLimiter
99 if ps.ConfigureLeecher.Config != nil {
100 ps.ConfigureLeecher.Config(cfg)
102 leecher, err := torrent.NewClient(cfg)
103 require.NoError(t, err)
104 defer leecher.Close()
105 if ps.ConfigureLeecher.Client != nil {
106 ps.ConfigureLeecher.Client(leecher)
108 defer testutil.ExportStatusWriter(leecher, "l", t)()
109 leecherTorrent, new, err := leecher.AddTorrentSpec(func() (ret *torrent.TorrentSpec) {
110 ret = torrent.TorrentSpecFromMetaInfo(mi)
112 if ps.LeecherStartsWithoutMetadata {
117 require.NoError(t, err)
120 //// This was used when observing coalescing of piece state changes.
121 //logPieceStateChanges(leecherTorrent)
123 // Now do some things with leecher and seeder.
124 added := leecherTorrent.AddClientPeer(seeder)
125 assert.False(t, leecherTorrent.Seeding())
126 // The leecher will use peers immediately if it doesn't have the metadata. Otherwise, they
127 // should be sitting idle until we demand data.
128 if !ps.LeecherStartsWithoutMetadata {
129 assert.EqualValues(t, added, leecherTorrent.Stats().PendingPeers)
131 if ps.LeecherStartsWithoutMetadata {
132 <-leecherTorrent.GotInfo()
134 r := leecherTorrent.NewReader()
136 go leecherTorrent.SetInfoBytes(mi.InfoBytes)
141 r.SetReadahead(ps.Readahead)
143 assertReadAllGreeting(t, r)
144 assert.NotEmpty(t, seederTorrent.PeerConns())
145 leecherPeerConns := leecherTorrent.PeerConns()
146 assert.NotEmpty(t, leecherPeerConns)
148 for _, pc := range leecherPeerConns {
149 completed := pc.PeerPieces().Len()
150 t.Logf("peer conn %v has %v completed pieces", pc, completed)
151 if completed == leecherTorrent.Info().NumPieces() {
156 t.Errorf("didn't find seeder amongst leecher peer conns")
159 seederStats := seederTorrent.Stats()
160 assert.True(t, 13 <= seederStats.BytesWrittenData.Int64())
161 assert.True(t, 8 <= seederStats.ChunksWritten.Int64())
163 leecherStats := leecherTorrent.Stats()
164 assert.True(t, 13 <= leecherStats.BytesReadData.Int64())
165 assert.True(t, 8 <= leecherStats.ChunksRead.Int64())
167 // Try reading through again for the cases where the torrent data size
168 // exceeds the size of the cache.
169 assertReadAllGreeting(t, r)
172 type fileCacheClientStorageFactoryParams struct {
175 Wrapper func(*filecache.Cache) storage.ClientImplCloser
178 func newFileCacheClientStorageFactory(ps fileCacheClientStorageFactoryParams) storageFactory {
179 return func(dataDir string) storage.ClientImplCloser {
180 fc, err := filecache.NewCache(dataDir)
185 fc.SetCapacity(ps.Capacity)
187 return ps.Wrapper(fc)
191 type storageFactory func(string) storage.ClientImplCloser
193 func TestClientTransferDefault(t *testing.T) {
194 testClientTransfer(t, testClientTransferParams{
195 LeecherStorage: newFileCacheClientStorageFactory(fileCacheClientStorageFactoryParams{
196 Wrapper: fileCachePieceResourceStorage,
201 func TestClientTransferDefaultNoMetadata(t *testing.T) {
202 testClientTransfer(t, testClientTransferParams{
203 LeecherStorage: newFileCacheClientStorageFactory(fileCacheClientStorageFactoryParams{
204 Wrapper: fileCachePieceResourceStorage,
206 LeecherStartsWithoutMetadata: true,
210 func TestClientTransferRateLimitedUpload(t *testing.T) {
211 started := time.Now()
212 testClientTransfer(t, testClientTransferParams{
213 // We are uploading 13 bytes (the length of the greeting torrent). The
214 // chunks are 2 bytes in length. Then the smallest burst we can run
215 // with is 2. Time taken is (13-burst)/rate.
216 SeederUploadRateLimiter: rate.NewLimiter(11, 2),
218 require.True(t, time.Since(started) > time.Second)
221 func TestClientTransferRateLimitedDownload(t *testing.T) {
222 testClientTransfer(t, testClientTransferParams{
223 LeecherDownloadRateLimiter: rate.NewLimiter(512, 512),
227 func fileCachePieceResourceStorage(fc *filecache.Cache) storage.ClientImplCloser {
232 storage.NewResourcePieces(fc.AsResourceProvider()),
233 ioutil.NopCloser(nil),
237 func testClientTransferSmallCache(t *testing.T, setReadahead bool, readahead int64) {
238 testClientTransfer(t, testClientTransferParams{
239 LeecherStorage: newFileCacheClientStorageFactory(fileCacheClientStorageFactoryParams{
241 // Going below the piece length means it can't complete a piece so
242 // that it can be hashed.
244 Wrapper: fileCachePieceResourceStorage,
246 SetReadahead: setReadahead,
247 // Can't readahead too far or the cache will thrash and drop data we
249 Readahead: readahead,
251 // These tests don't work well with more than 1 connection to the seeder.
252 ConfigureLeecher: ConfigureClient{
253 Config: func(cfg *torrent.ClientConfig) {
254 cfg.DropDuplicatePeerIds = true
255 //cfg.DisableIPv6 = true
256 //cfg.DisableUTP = true
262 func TestClientTransferSmallCachePieceSizedReadahead(t *testing.T) {
263 testClientTransferSmallCache(t, true, 5)
266 func TestClientTransferSmallCacheLargeReadahead(t *testing.T) {
267 testClientTransferSmallCache(t, true, 15)
270 func TestClientTransferSmallCacheDefaultReadahead(t *testing.T) {
271 testClientTransferSmallCache(t, false, -1)
274 func sqliteClientStorageFactory(connPathMaker func(dataDir string) string) storageFactory {
275 return func(dataDir string) storage.ClientImplCloser {
276 path := connPathMaker(dataDir)
277 log.Printf("opening sqlite db at %q", path)
278 conn, err := sqlite.OpenConn(path, 0)
282 prov, err := sqliteStorage.NewProvider(conn)
290 storage.NewResourcePieces(prov),
297 func TestClientTransferVarious(t *testing.T) {
299 for _, ls := range []struct {
303 {"Filecache", newFileCacheClientStorageFactory(fileCacheClientStorageFactoryParams{
304 Wrapper: fileCachePieceResourceStorage,
306 {"Boltdb", storage.NewBoltDB},
307 {"SqliteFile", sqliteClientStorageFactory(func(dataDir string) string {
308 return "file:" + filepath.Join(dataDir, "sqlite.db")
310 {"SqliteMemory", sqliteClientStorageFactory(func(dataDir string) string {
311 return "file:memory:?mode=memory"
314 t.Run(fmt.Sprintf("LeecherStorage=%s", ls.name), func(t *testing.T) {
316 for _, ss := range []struct {
320 {"File", storage.NewFile},
321 {"Mmap", storage.NewMMap},
323 t.Run(fmt.Sprintf("%sSeederStorage", ss.name), func(t *testing.T) {
324 for _, responsive := range []bool{false, true} {
325 t.Run(fmt.Sprintf("Responsive=%v", responsive), func(t *testing.T) {
326 t.Run("NoReadahead", func(t *testing.T) {
327 testClientTransfer(t, testClientTransferParams{
328 Responsive: responsive,
330 LeecherStorage: ls.f,
333 for _, readahead := range []int64{-1, 0, 1, 2, 3, 4, 5, 6, 9, 10, 11, 12, 13, 14, 15, 20} {
334 t.Run(fmt.Sprintf("readahead=%v", readahead), func(t *testing.T) {
335 testClientTransfer(t, testClientTransferParams{
337 Responsive: responsive,
339 Readahead: readahead,
340 LeecherStorage: ls.f,
352 // Check that after completing leeching, a leecher transitions to a seeding
353 // correctly. Connected in a chain like so: Seeder <-> Leecher <-> LeecherLeecher.
354 func TestSeedAfterDownloading(t *testing.T) {
355 greetingTempDir, mi := testutil.GreetingTestTorrent()
356 defer os.RemoveAll(greetingTempDir)
358 cfg := torrent.TestingConfig()
360 cfg.DataDir = greetingTempDir
361 seeder, err := torrent.NewClient(cfg)
362 require.NoError(t, err)
364 defer testutil.ExportStatusWriter(seeder, "s", t)()
365 seederTorrent, ok, err := seeder.AddTorrentSpec(torrent.TorrentSpecFromMetaInfo(mi))
366 require.NoError(t, err)
368 seederTorrent.VerifyData()
370 cfg = torrent.TestingConfig()
372 cfg.DataDir, err = ioutil.TempDir("", "")
373 require.NoError(t, err)
374 defer os.RemoveAll(cfg.DataDir)
375 leecher, err := torrent.NewClient(cfg)
376 require.NoError(t, err)
377 defer leecher.Close()
378 defer testutil.ExportStatusWriter(leecher, "l", t)()
380 cfg = torrent.TestingConfig()
382 cfg.DataDir, err = ioutil.TempDir("", "")
383 require.NoError(t, err)
384 defer os.RemoveAll(cfg.DataDir)
385 leecherLeecher, _ := torrent.NewClient(cfg)
386 require.NoError(t, err)
387 defer leecherLeecher.Close()
388 defer testutil.ExportStatusWriter(leecherLeecher, "ll", t)()
389 leecherGreeting, ok, err := leecher.AddTorrentSpec(func() (ret *torrent.TorrentSpec) {
390 ret = torrent.TorrentSpecFromMetaInfo(mi)
394 require.NoError(t, err)
396 llg, ok, err := leecherLeecher.AddTorrentSpec(func() (ret *torrent.TorrentSpec) {
397 ret = torrent.TorrentSpecFromMetaInfo(mi)
401 require.NoError(t, err)
403 // Simultaneously DownloadAll in Leecher, and read the contents
404 // consecutively in LeecherLeecher. This non-deterministically triggered a
405 // case where the leecher wouldn't unchoke the LeecherLeecher.
406 var wg sync.WaitGroup
412 b, err := ioutil.ReadAll(r)
413 require.NoError(t, err)
414 assert.EqualValues(t, testutil.GreetingFileContents, b)
416 done := make(chan struct{})
418 go leecherGreeting.AddClientPeer(seeder)
419 go leecherGreeting.AddClientPeer(leecherLeecher)
423 leecherGreeting.DownloadAll()
429 type ConfigureClient struct {
430 Config func(*torrent.ClientConfig)
431 Client func(*torrent.Client)