test/transfer_test.go

   1 package test
   2
   3 import (
   4         "io"
   5         "io/ioutil"
   6         "os"
   7         "sync"
   8         "testing"
   9         "testing/iotest"
  10         "time"
  11
  12         "github.com/anacrolix/missinggo/v2/filecache"
  13         "github.com/anacrolix/torrent"
  14         "github.com/anacrolix/torrent/internal/testutil"
  15         "github.com/anacrolix/torrent/storage"
  16         "github.com/frankban/quicktest"
  17         "golang.org/x/time/rate"
  18
  19         "github.com/stretchr/testify/assert"
  20         "github.com/stretchr/testify/require"
  21 )
  22
  23 type fileCacheClientStorageFactoryParams struct {
  24         Capacity    int64
  25         SetCapacity bool
  26 }
  27
  28 func newFileCacheClientStorageFactory(ps fileCacheClientStorageFactoryParams) StorageFactory {
  29         return func(dataDir string) storage.ClientImplCloser {
  30                 fc, err := filecache.NewCache(dataDir)
  31                 if err != nil {
  32                         panic(err)
  33                 }
  34                 var sharedCapacity *int64
  35                 if ps.SetCapacity {
  36                         sharedCapacity = &ps.Capacity
  37                         fc.SetCapacity(ps.Capacity)
  38                 }
  39                 return struct {
  40                         storage.ClientImpl
  41                         io.Closer
  42                 }{
  43                         storage.NewResourcePiecesOpts(
  44                                 fc.AsResourceProvider(),
  45                                 storage.ResourcePiecesOpts{
  46                                         Capacity: sharedCapacity,
  47                                 }),
  48                         ioutil.NopCloser(nil),
  49                 }
  50         }
  51 }
  52
  53 func TestClientTransferDefault(t *testing.T) {
  54         testClientTransfer(t, testClientTransferParams{
  55                 LeecherStorage: newFileCacheClientStorageFactory(fileCacheClientStorageFactoryParams{}),
  56         })
  57 }
  58
  59 func TestClientTransferDefaultNoMetadata(t *testing.T) {
  60         testClientTransfer(t, testClientTransferParams{
  61                 LeecherStorage:               newFileCacheClientStorageFactory(fileCacheClientStorageFactoryParams{}),
  62                 LeecherStartsWithoutMetadata: true,
  63         })
  64 }
  65
  66 func TestClientTransferRateLimitedUpload(t *testing.T) {
  67         started := time.Now()
  68         testClientTransfer(t, testClientTransferParams{
  69                 // We are uploading 13 bytes (the length of the greeting torrent). The
  70                 // chunks are 2 bytes in length. Then the smallest burst we can run
  71                 // with is 2. Time taken is (13-burst)/rate.
  72                 SeederUploadRateLimiter: rate.NewLimiter(11, 2),
  73         })
  74         require.True(t, time.Since(started) > time.Second)
  75 }
  76
  77 func TestClientTransferRateLimitedDownload(t *testing.T) {
  78         testClientTransfer(t, testClientTransferParams{
  79                 LeecherDownloadRateLimiter: rate.NewLimiter(512, 512),
  80                 ConfigureSeeder: ConfigureClient{
  81                         Config: func(cfg *torrent.ClientConfig) {
  82                                 // If we send too many keep alives, we consume all the leechers available download
  83                                 // rate. The default isn't exposed, but a minute is pretty reasonable.
  84                                 cfg.KeepAliveTimeout = time.Minute
  85                         },
  86                 },
  87         })
  88 }
  89
  90 func testClientTransferSmallCache(t *testing.T, setReadahead bool, readahead int64) {
  91         testClientTransfer(t, testClientTransferParams{
  92                 LeecherStorage: newFileCacheClientStorageFactory(fileCacheClientStorageFactoryParams{
  93                         SetCapacity: true,
  94                         // Going below the piece length means it can't complete a piece so
  95                         // that it can be hashed.
  96                         Capacity: 5,
  97                 }),
  98                 LeecherStorageCapacity: 5,
  99                 SetReadahead:           setReadahead,
 100                 // Can't readahead too far or the cache will thrash and drop data we
 101                 // thought we had.
 102                 Readahead: readahead,
 103
 104                 // These tests don't work well with more than 1 connection to the seeder.
 105                 ConfigureLeecher: ConfigureClient{
 106                         Config: func(cfg *torrent.ClientConfig) {
 107                                 cfg.DropDuplicatePeerIds = true
 108                                 // cfg.DisableIPv6 = true
 109                                 // cfg.DisableUTP = true
 110                         },
 111                 },
 112         })
 113 }
 114
 115 func TestClientTransferSmallCachePieceSizedReadahead(t *testing.T) {
 116         testClientTransferSmallCache(t, true, 5)
 117 }
 118
 119 func TestClientTransferSmallCacheLargeReadahead(t *testing.T) {
 120         testClientTransferSmallCache(t, true, 15)
 121 }
 122
 123 func TestClientTransferSmallCacheDefaultReadahead(t *testing.T) {
 124         testClientTransferSmallCache(t, false, -1)
 125 }
 126
 127 func TestFilecacheClientTransferVarious(t *testing.T) {
 128         TestLeecherStorage(t, LeecherStorageTestCase{
 129                 "Filecache", newFileCacheClientStorageFactory(fileCacheClientStorageFactoryParams{}), 0,
 130         })
 131 }
 132
 133 // Check that after completing leeching, a leecher transitions to a seeding
 134 // correctly. Connected in a chain like so: Seeder <-> Leecher <-> LeecherLeecher.
 135 func TestSeedAfterDownloading(t *testing.T) {
 136         greetingTempDir, mi := testutil.GreetingTestTorrent()
 137         defer os.RemoveAll(greetingTempDir)
 138
 139         cfg := torrent.TestingConfig(t)
 140         cfg.Seed = true
 141         cfg.DataDir = greetingTempDir
 142         seeder, err := torrent.NewClient(cfg)
 143         require.NoError(t, err)
 144         defer seeder.Close()
 145         defer testutil.ExportStatusWriter(seeder, "s", t)()
 146         seederTorrent, ok, err := seeder.AddTorrentSpec(torrent.TorrentSpecFromMetaInfo(mi))
 147         require.NoError(t, err)
 148         assert.True(t, ok)
 149         seederTorrent.VerifyData()
 150
 151         cfg = torrent.TestingConfig(t)
 152         cfg.Seed = true
 153         cfg.DataDir = t.TempDir()
 154         leecher, err := torrent.NewClient(cfg)
 155         require.NoError(t, err)
 156         defer leecher.Close()
 157         defer testutil.ExportStatusWriter(leecher, "l", t)()
 158
 159         cfg = torrent.TestingConfig(t)
 160         cfg.Seed = false
 161         cfg.DataDir = t.TempDir()
 162         leecherLeecher, _ := torrent.NewClient(cfg)
 163         require.NoError(t, err)
 164         defer leecherLeecher.Close()
 165         defer testutil.ExportStatusWriter(leecherLeecher, "ll", t)()
 166         leecherGreeting, ok, err := leecher.AddTorrentSpec(func() (ret *torrent.TorrentSpec) {
 167                 ret = torrent.TorrentSpecFromMetaInfo(mi)
 168                 ret.ChunkSize = 2
 169                 return
 170         }())
 171         require.NoError(t, err)
 172         assert.True(t, ok)
 173         llg, ok, err := leecherLeecher.AddTorrentSpec(func() (ret *torrent.TorrentSpec) {
 174                 ret = torrent.TorrentSpecFromMetaInfo(mi)
 175                 ret.ChunkSize = 3
 176                 return
 177         }())
 178         require.NoError(t, err)
 179         assert.True(t, ok)
 180         // Simultaneously DownloadAll in Leecher, and read the contents
 181         // consecutively in LeecherLeecher. This non-deterministically triggered a
 182         // case where the leecher wouldn't unchoke the LeecherLeecher.
 183         var wg sync.WaitGroup
 184         wg.Add(1)
 185         go func() {
 186                 defer wg.Done()
 187                 r := llg.NewReader()
 188                 defer r.Close()
 189                 quicktest.Check(t, iotest.TestReader(r, []byte(testutil.GreetingFileContents)), quicktest.IsNil)
 190         }()
 191         done := make(chan struct{})
 192         defer close(done)
 193         go leecherGreeting.AddClientPeer(seeder)
 194         go leecherGreeting.AddClientPeer(leecherLeecher)
 195         wg.Add(1)
 196         go func() {
 197                 defer wg.Done()
 198                 leecherGreeting.DownloadAll()
 199                 leecher.WaitAll()
 200         }()
 201         wg.Wait()
 202 }