client_test.go

   1 package torrent
   2
   3 import (
   4         "context"
   5         "encoding/binary"
   6         "fmt"
   7         "io"
   8         "io/ioutil"
   9         "net"
  10         "os"
  11         "path/filepath"
  12         "reflect"
  13         "sync"
  14         "testing"
  15         "time"
  16
  17         "github.com/anacrolix/dht"
  18         _ "github.com/anacrolix/envpprof"
  19         "github.com/anacrolix/missinggo"
  20         "github.com/anacrolix/missinggo/filecache"
  21         "github.com/bradfitz/iter"
  22         "github.com/stretchr/testify/assert"
  23         "github.com/stretchr/testify/require"
  24         "golang.org/x/time/rate"
  25
  26         "github.com/anacrolix/torrent/bencode"
  27         "github.com/anacrolix/torrent/internal/testutil"
  28         "github.com/anacrolix/torrent/iplist"
  29         "github.com/anacrolix/torrent/metainfo"
  30         "github.com/anacrolix/torrent/storage"
  31 )
  32
  33 func TestingConfig() *Config {
  34         return &Config{
  35                 ListenHost:              LoopbackListenHost,
  36                 NoDHT:                   true,
  37                 DataDir:                 tempDir(),
  38                 DisableTrackers:         true,
  39                 NoDefaultPortForwarding: true,
  40                 // Debug:           true,
  41         }
  42 }
  43
  44 func TestClientDefault(t *testing.T) {
  45         cl, err := NewClient(TestingConfig())
  46         require.NoError(t, err)
  47         cl.Close()
  48 }
  49
  50 func TestClientNilConfig(t *testing.T) {
  51         cl, err := NewClient(nil)
  52         require.NoError(t, err)
  53         cl.Close()
  54 }
  55
  56 func TestBoltPieceCompletionClosedWhenClientClosed(t *testing.T) {
  57         cfg := TestingConfig()
  58         pc, err := storage.NewBoltPieceCompletion(cfg.DataDir)
  59         require.NoError(t, err)
  60         ci := storage.NewFileWithCompletion(cfg.DataDir, pc)
  61         defer ci.Close()
  62         cfg.DefaultStorage = ci
  63         cl, err := NewClient(cfg)
  64         require.NoError(t, err)
  65         cl.Close()
  66         // And again, https://github.com/anacrolix/torrent/issues/158
  67         cl, err = NewClient(cfg)
  68         require.NoError(t, err)
  69         cl.Close()
  70 }
  71
  72 func TestAddDropTorrent(t *testing.T) {
  73         cl, err := NewClient(TestingConfig())
  74         require.NoError(t, err)
  75         defer cl.Close()
  76         dir, mi := testutil.GreetingTestTorrent()
  77         defer os.RemoveAll(dir)
  78         tt, new, err := cl.AddTorrentSpec(TorrentSpecFromMetaInfo(mi))
  79         require.NoError(t, err)
  80         assert.True(t, new)
  81         tt.SetMaxEstablishedConns(0)
  82         tt.SetMaxEstablishedConns(1)
  83         tt.Drop()
  84 }
  85
  86 func TestAddTorrentNoSupportedTrackerSchemes(t *testing.T) {
  87         // TODO?
  88         t.SkipNow()
  89 }
  90
  91 func TestAddTorrentNoUsableURLs(t *testing.T) {
  92         // TODO?
  93         t.SkipNow()
  94 }
  95
  96 func TestAddPeersToUnknownTorrent(t *testing.T) {
  97         // TODO?
  98         t.SkipNow()
  99 }
 100
 101 func TestPieceHashSize(t *testing.T) {
 102         assert.Equal(t, 20, pieceHash.Size())
 103 }
 104
 105 func TestTorrentInitialState(t *testing.T) {
 106         dir, mi := testutil.GreetingTestTorrent()
 107         defer os.RemoveAll(dir)
 108         cl := &Client{}
 109         cl.initLogger()
 110         tor := cl.newTorrent(
 111                 mi.HashInfoBytes(),
 112                 storage.NewFileWithCompletion(tempDir(), storage.NewMapPieceCompletion()),
 113         )
 114         tor.setChunkSize(2)
 115         tor.cl.mu.Lock()
 116         err := tor.setInfoBytes(mi.InfoBytes)
 117         tor.cl.mu.Unlock()
 118         require.NoError(t, err)
 119         require.Len(t, tor.pieces, 3)
 120         tor.pendAllChunkSpecs(0)
 121         tor.cl.mu.Lock()
 122         assert.EqualValues(t, 3, tor.pieceNumPendingChunks(0))
 123         tor.cl.mu.Unlock()
 124         assert.EqualValues(t, chunkSpec{4, 1}, chunkIndexSpec(2, tor.pieceLength(0), tor.chunkSize))
 125 }
 126
 127 func TestUnmarshalPEXMsg(t *testing.T) {
 128         var m peerExchangeMessage
 129         if err := bencode.Unmarshal([]byte("d5:added12:\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0ce"), &m); err != nil {
 130                 t.Fatal(err)
 131         }
 132         if len(m.Added) != 2 {
 133                 t.FailNow()
 134         }
 135         if m.Added[0].Port != 0x506 {
 136                 t.FailNow()
 137         }
 138 }
 139
 140 func TestReducedDialTimeout(t *testing.T) {
 141         cfg := &Config{}
 142         cfg.setDefaults()
 143         for _, _case := range []struct {
 144                 Max             time.Duration
 145                 HalfOpenLimit   int
 146                 PendingPeers    int
 147                 ExpectedReduced time.Duration
 148         }{
 149                 {cfg.NominalDialTimeout, 40, 0, cfg.NominalDialTimeout},
 150                 {cfg.NominalDialTimeout, 40, 1, cfg.NominalDialTimeout},
 151                 {cfg.NominalDialTimeout, 40, 39, cfg.NominalDialTimeout},
 152                 {cfg.NominalDialTimeout, 40, 40, cfg.NominalDialTimeout / 2},
 153                 {cfg.NominalDialTimeout, 40, 80, cfg.NominalDialTimeout / 3},
 154                 {cfg.NominalDialTimeout, 40, 4000, cfg.NominalDialTimeout / 101},
 155         } {
 156                 reduced := reducedDialTimeout(cfg.MinDialTimeout, _case.Max, _case.HalfOpenLimit, _case.PendingPeers)
 157                 expected := _case.ExpectedReduced
 158                 if expected < cfg.MinDialTimeout {
 159                         expected = cfg.MinDialTimeout
 160                 }
 161                 if reduced != expected {
 162                         t.Fatalf("expected %s, got %s", _case.ExpectedReduced, reduced)
 163                 }
 164         }
 165 }
 166
 167 func TestUTPRawConn(t *testing.T) {
 168         l, err := NewUtpSocket("udp", "")
 169         require.NoError(t, err)
 170         defer l.Close()
 171         go func() {
 172                 for {
 173                         _, err := l.Accept()
 174                         if err != nil {
 175                                 break
 176                         }
 177                 }
 178         }()
 179         // Connect a UTP peer to see if the RawConn will still work.
 180         s, err := NewUtpSocket("udp", "")
 181         require.NoError(t, err)
 182         defer s.Close()
 183         utpPeer, err := s.DialContext(context.Background(), "", fmt.Sprintf("localhost:%d", missinggo.AddrPort(l.Addr())))
 184         require.NoError(t, err)
 185         defer utpPeer.Close()
 186         peer, err := net.ListenPacket("udp", ":0")
 187         require.NoError(t, err)
 188         defer peer.Close()
 189
 190         msgsReceived := 0
 191         // How many messages to send. I've set this to double the channel buffer
 192         // size in the raw packetConn.
 193         const N = 200
 194         readerStopped := make(chan struct{})
 195         // The reader goroutine.
 196         go func() {
 197                 defer close(readerStopped)
 198                 b := make([]byte, 500)
 199                 for i := 0; i < N; i++ {
 200                         n, _, err := l.ReadFrom(b)
 201                         require.NoError(t, err)
 202                         msgsReceived++
 203                         var d int
 204                         fmt.Sscan(string(b[:n]), &d)
 205                         assert.Equal(t, i, d)
 206                 }
 207         }()
 208         udpAddr, err := net.ResolveUDPAddr("udp", fmt.Sprintf("localhost:%d", missinggo.AddrPort(l.Addr())))
 209         require.NoError(t, err)
 210         for i := 0; i < N; i++ {
 211                 _, err := peer.WriteTo([]byte(fmt.Sprintf("%d", i)), udpAddr)
 212                 require.NoError(t, err)
 213                 time.Sleep(time.Millisecond)
 214         }
 215         select {
 216         case <-readerStopped:
 217         case <-time.After(time.Second):
 218                 t.Fatal("reader timed out")
 219         }
 220         if msgsReceived != N {
 221                 t.Fatalf("messages received: %d", msgsReceived)
 222         }
 223 }
 224
 225 func TestAddDropManyTorrents(t *testing.T) {
 226         cl, err := NewClient(TestingConfig())
 227         require.NoError(t, err)
 228         defer cl.Close()
 229         for i := range iter.N(1000) {
 230                 var spec TorrentSpec
 231                 binary.PutVarint(spec.InfoHash[:], int64(i))
 232                 tt, new, err := cl.AddTorrentSpec(&spec)
 233                 assert.NoError(t, err)
 234                 assert.True(t, new)
 235                 defer tt.Drop()
 236         }
 237 }
 238
 239 type FileCacheClientStorageFactoryParams struct {
 240         Capacity    int64
 241         SetCapacity bool
 242         Wrapper     func(*filecache.Cache) storage.ClientImpl
 243 }
 244
 245 func NewFileCacheClientStorageFactory(ps FileCacheClientStorageFactoryParams) storageFactory {
 246         return func(dataDir string) storage.ClientImpl {
 247                 fc, err := filecache.NewCache(dataDir)
 248                 if err != nil {
 249                         panic(err)
 250                 }
 251                 if ps.SetCapacity {
 252                         fc.SetCapacity(ps.Capacity)
 253                 }
 254                 return ps.Wrapper(fc)
 255         }
 256 }
 257
 258 type storageFactory func(string) storage.ClientImpl
 259
 260 func TestClientTransferDefault(t *testing.T) {
 261         testClientTransfer(t, testClientTransferParams{
 262                 ExportClientStatus: true,
 263                 LeecherStorage: NewFileCacheClientStorageFactory(FileCacheClientStorageFactoryParams{
 264                         Wrapper: fileCachePieceResourceStorage,
 265                 }),
 266         })
 267 }
 268
 269 func TestClientTransferRateLimitedUpload(t *testing.T) {
 270         started := time.Now()
 271         testClientTransfer(t, testClientTransferParams{
 272                 // We are uploading 13 bytes (the length of the greeting torrent). The
 273                 // chunks are 2 bytes in length. Then the smallest burst we can run
 274                 // with is 2. Time taken is (13-burst)/rate.
 275                 SeederUploadRateLimiter: rate.NewLimiter(11, 2),
 276                 ExportClientStatus:      true,
 277         })
 278         require.True(t, time.Since(started) > time.Second)
 279 }
 280
 281 func TestClientTransferRateLimitedDownload(t *testing.T) {
 282         testClientTransfer(t, testClientTransferParams{
 283                 LeecherDownloadRateLimiter: rate.NewLimiter(512, 512),
 284         })
 285 }
 286
 287 func fileCachePieceResourceStorage(fc *filecache.Cache) storage.ClientImpl {
 288         return storage.NewResourcePieces(fc.AsResourceProvider())
 289 }
 290
 291 func TestClientTransferSmallCache(t *testing.T) {
 292         testClientTransfer(t, testClientTransferParams{
 293                 LeecherStorage: NewFileCacheClientStorageFactory(FileCacheClientStorageFactoryParams{
 294                         SetCapacity: true,
 295                         // Going below the piece length means it can't complete a piece so
 296                         // that it can be hashed.
 297                         Capacity: 5,
 298                         Wrapper:  fileCachePieceResourceStorage,
 299                 }),
 300                 SetReadahead: true,
 301                 // Can't readahead too far or the cache will thrash and drop data we
 302                 // thought we had.
 303                 Readahead:          0,
 304                 ExportClientStatus: true,
 305         })
 306 }
 307
 308 func TestClientTransferVarious(t *testing.T) {
 309         // Leecher storage
 310         for _, ls := range []storageFactory{
 311                 NewFileCacheClientStorageFactory(FileCacheClientStorageFactoryParams{
 312                         Wrapper: fileCachePieceResourceStorage,
 313                 }),
 314                 storage.NewBoltDB,
 315         } {
 316                 // Seeder storage
 317                 for _, ss := range []func(string) storage.ClientImpl{
 318                         storage.NewFile,
 319                         storage.NewMMap,
 320                 } {
 321                         for _, responsive := range []bool{false, true} {
 322                                 testClientTransfer(t, testClientTransferParams{
 323                                         Responsive:     responsive,
 324                                         SeederStorage:  ss,
 325                                         LeecherStorage: ls,
 326                                 })
 327                                 for _, readahead := range []int64{-1, 0, 1, 2, 3, 4, 5, 6, 9, 10, 11, 12, 13, 14, 15, 20} {
 328                                         testClientTransfer(t, testClientTransferParams{
 329                                                 SeederStorage:  ss,
 330                                                 Responsive:     responsive,
 331                                                 SetReadahead:   true,
 332                                                 Readahead:      readahead,
 333                                                 LeecherStorage: ls,
 334                                         })
 335                                 }
 336                         }
 337                 }
 338         }
 339 }
 340
 341 type testClientTransferParams struct {
 342         Responsive                 bool
 343         Readahead                  int64
 344         SetReadahead               bool
 345         ExportClientStatus         bool
 346         LeecherStorage             func(string) storage.ClientImpl
 347         SeederStorage              func(string) storage.ClientImpl
 348         SeederUploadRateLimiter    *rate.Limiter
 349         LeecherDownloadRateLimiter *rate.Limiter
 350 }
 351
 352 // Creates a seeder and a leecher, and ensures the data transfers when a read
 353 // is attempted on the leecher.
 354 func testClientTransfer(t *testing.T, ps testClientTransferParams) {
 355         greetingTempDir, mi := testutil.GreetingTestTorrent()
 356         defer os.RemoveAll(greetingTempDir)
 357         // Create seeder and a Torrent.
 358         cfg := TestingConfig()
 359         cfg.Seed = true
 360         cfg.UploadRateLimiter = ps.SeederUploadRateLimiter
 361         // cfg.ListenAddr = "localhost:4000"
 362         if ps.SeederStorage != nil {
 363                 cfg.DefaultStorage = ps.SeederStorage(greetingTempDir)
 364                 defer cfg.DefaultStorage.Close()
 365         } else {
 366                 cfg.DataDir = greetingTempDir
 367         }
 368         seeder, err := NewClient(cfg)
 369         require.NoError(t, err)
 370         if ps.ExportClientStatus {
 371                 testutil.ExportStatusWriter(seeder, "s")
 372         }
 373         seederTorrent, _, _ := seeder.AddTorrentSpec(TorrentSpecFromMetaInfo(mi))
 374         // Run a Stats right after Closing the Client. This will trigger the Stats
 375         // panic in #214 caused by RemoteAddr on Closed uTP sockets.
 376         defer seederTorrent.Stats()
 377         defer seeder.Close()
 378         seederTorrent.VerifyData()
 379         // Create leecher and a Torrent.
 380         leecherDataDir, err := ioutil.TempDir("", "")
 381         require.NoError(t, err)
 382         defer os.RemoveAll(leecherDataDir)
 383         if ps.LeecherStorage == nil {
 384                 cfg.DataDir = leecherDataDir
 385         } else {
 386                 cfg.DefaultStorage = ps.LeecherStorage(leecherDataDir)
 387         }
 388         cfg.DownloadRateLimiter = ps.LeecherDownloadRateLimiter
 389         cfg.Seed = false
 390         leecher, err := NewClient(cfg)
 391         require.NoError(t, err)
 392         defer leecher.Close()
 393         if ps.ExportClientStatus {
 394                 testutil.ExportStatusWriter(leecher, "l")
 395         }
 396         leecherTorrent, new, err := leecher.AddTorrentSpec(func() (ret *TorrentSpec) {
 397                 ret = TorrentSpecFromMetaInfo(mi)
 398                 ret.ChunkSize = 2
 399                 return
 400         }())
 401         require.NoError(t, err)
 402         assert.True(t, new)
 403         // Now do some things with leecher and seeder.
 404         leecherTorrent.AddClientPeer(seeder)
 405         // The Torrent should not be interested in obtaining peers, so the one we
 406         // just added should be the only one.
 407         assert.False(t, leecherTorrent.Seeding())
 408         assert.EqualValues(t, 1, leecherTorrent.Stats().PendingPeers)
 409         r := leecherTorrent.NewReader()
 410         defer r.Close()
 411         if ps.Responsive {
 412                 r.SetResponsive()
 413         }
 414         if ps.SetReadahead {
 415                 r.SetReadahead(ps.Readahead)
 416         }
 417         assertReadAllGreeting(t, r)
 418
 419         seederStats := seederTorrent.Stats()
 420         assert.True(t, 13 <= seederStats.BytesWrittenData.Int64())
 421         assert.True(t, 8 <= seederStats.ChunksWritten.Int64())
 422
 423         leecherStats := leecherTorrent.Stats()
 424         assert.True(t, 13 <= leecherStats.BytesReadData.Int64())
 425         assert.True(t, 8 <= leecherStats.ChunksRead.Int64())
 426
 427         // Try reading through again for the cases where the torrent data size
 428         // exceeds the size of the cache.
 429         assertReadAllGreeting(t, r)
 430 }
 431
 432 func assertReadAllGreeting(t *testing.T, r io.ReadSeeker) {
 433         pos, err := r.Seek(0, io.SeekStart)
 434         assert.NoError(t, err)
 435         assert.EqualValues(t, 0, pos)
 436         _greeting, err := ioutil.ReadAll(r)
 437         assert.NoError(t, err)
 438         assert.EqualValues(t, testutil.GreetingFileContents, _greeting)
 439 }
 440
 441 // Check that after completing leeching, a leecher transitions to a seeding
 442 // correctly. Connected in a chain like so: Seeder <-> Leecher <-> LeecherLeecher.
 443 func TestSeedAfterDownloading(t *testing.T) {
 444         greetingTempDir, mi := testutil.GreetingTestTorrent()
 445         defer os.RemoveAll(greetingTempDir)
 446         cfg := TestingConfig()
 447         cfg.Seed = true
 448         cfg.DataDir = greetingTempDir
 449         seeder, err := NewClient(cfg)
 450         require.NoError(t, err)
 451         defer seeder.Close()
 452         testutil.ExportStatusWriter(seeder, "s")
 453         seederTorrent, ok, err := seeder.AddTorrentSpec(TorrentSpecFromMetaInfo(mi))
 454         require.NoError(t, err)
 455         assert.True(t, ok)
 456         seederTorrent.VerifyData()
 457         cfg.DataDir, err = ioutil.TempDir("", "")
 458         require.NoError(t, err)
 459         defer os.RemoveAll(cfg.DataDir)
 460         leecher, err := NewClient(cfg)
 461         require.NoError(t, err)
 462         defer leecher.Close()
 463         testutil.ExportStatusWriter(leecher, "l")
 464         cfg.Seed = false
 465         cfg.DataDir, err = ioutil.TempDir("", "")
 466         require.NoError(t, err)
 467         defer os.RemoveAll(cfg.DataDir)
 468         leecherLeecher, _ := NewClient(cfg)
 469         require.NoError(t, err)
 470         defer leecherLeecher.Close()
 471         testutil.ExportStatusWriter(leecherLeecher, "ll")
 472         leecherGreeting, ok, err := leecher.AddTorrentSpec(func() (ret *TorrentSpec) {
 473                 ret = TorrentSpecFromMetaInfo(mi)
 474                 ret.ChunkSize = 2
 475                 return
 476         }())
 477         require.NoError(t, err)
 478         assert.True(t, ok)
 479         llg, ok, err := leecherLeecher.AddTorrentSpec(func() (ret *TorrentSpec) {
 480                 ret = TorrentSpecFromMetaInfo(mi)
 481                 ret.ChunkSize = 3
 482                 return
 483         }())
 484         require.NoError(t, err)
 485         assert.True(t, ok)
 486         // Simultaneously DownloadAll in Leecher, and read the contents
 487         // consecutively in LeecherLeecher. This non-deterministically triggered a
 488         // case where the leecher wouldn't unchoke the LeecherLeecher.
 489         var wg sync.WaitGroup
 490         wg.Add(1)
 491         go func() {
 492                 defer wg.Done()
 493                 r := llg.NewReader()
 494                 defer r.Close()
 495                 b, err := ioutil.ReadAll(r)
 496                 require.NoError(t, err)
 497                 assert.EqualValues(t, testutil.GreetingFileContents, b)
 498         }()
 499         done := make(chan struct{})
 500         defer close(done)
 501         go leecherGreeting.AddClientPeer(seeder)
 502         go leecherGreeting.AddClientPeer(leecherLeecher)
 503         wg.Add(1)
 504         go func() {
 505                 defer wg.Done()
 506                 leecherGreeting.DownloadAll()
 507                 leecher.WaitAll()
 508         }()
 509         wg.Wait()
 510 }
 511
 512 func TestMergingTrackersByAddingSpecs(t *testing.T) {
 513         cl, err := NewClient(TestingConfig())
 514         require.NoError(t, err)
 515         defer cl.Close()
 516         spec := TorrentSpec{}
 517         T, new, _ := cl.AddTorrentSpec(&spec)
 518         if !new {
 519                 t.FailNow()
 520         }
 521         spec.Trackers = [][]string{{"http://a"}, {"udp://b"}}
 522         _, new, _ = cl.AddTorrentSpec(&spec)
 523         assert.False(t, new)
 524         assert.EqualValues(t, [][]string{{"http://a"}, {"udp://b"}}, T.metainfo.AnnounceList)
 525         // Because trackers are disabled in TestingConfig.
 526         assert.EqualValues(t, 0, len(T.trackerAnnouncers))
 527 }
 528
 529 // We read from a piece which is marked completed, but is missing data.
 530 func TestCompletedPieceWrongSize(t *testing.T) {
 531         cfg := TestingConfig()
 532         cfg.DefaultStorage = badStorage{}
 533         cl, err := NewClient(cfg)
 534         require.NoError(t, err)
 535         defer cl.Close()
 536         info := metainfo.Info{
 537                 PieceLength: 15,
 538                 Pieces:      make([]byte, 20),
 539                 Files: []metainfo.FileInfo{
 540                         {Path: []string{"greeting"}, Length: 13},
 541                 },
 542         }
 543         b, err := bencode.Marshal(info)
 544         require.NoError(t, err)
 545         tt, new, err := cl.AddTorrentSpec(&TorrentSpec{
 546                 InfoBytes: b,
 547                 InfoHash:  metainfo.HashBytes(b),
 548         })
 549         require.NoError(t, err)
 550         defer tt.Drop()
 551         assert.True(t, new)
 552         r := tt.NewReader()
 553         defer r.Close()
 554         b, err = ioutil.ReadAll(r)
 555         assert.Len(t, b, 13)
 556         assert.NoError(t, err)
 557 }
 558
 559 func BenchmarkAddLargeTorrent(b *testing.B) {
 560         cfg := TestingConfig()
 561         cfg.DisableTCP = true
 562         cfg.DisableUTP = true
 563         cfg.ListenHost = func(string) string { return "redonk" }
 564         cl, err := NewClient(cfg)
 565         require.NoError(b, err)
 566         defer cl.Close()
 567         for range iter.N(b.N) {
 568                 t, err := cl.AddTorrentFromFile("testdata/bootstrap.dat.torrent")
 569                 if err != nil {
 570                         b.Fatal(err)
 571                 }
 572                 t.Drop()
 573         }
 574 }
 575
 576 func TestResponsive(t *testing.T) {
 577         seederDataDir, mi := testutil.GreetingTestTorrent()
 578         defer os.RemoveAll(seederDataDir)
 579         cfg := TestingConfig()
 580         cfg.Seed = true
 581         cfg.DataDir = seederDataDir
 582         seeder, err := NewClient(cfg)
 583         require.Nil(t, err)
 584         defer seeder.Close()
 585         seederTorrent, _, _ := seeder.AddTorrentSpec(TorrentSpecFromMetaInfo(mi))
 586         seederTorrent.VerifyData()
 587         leecherDataDir, err := ioutil.TempDir("", "")
 588         require.Nil(t, err)
 589         defer os.RemoveAll(leecherDataDir)
 590         cfg = TestingConfig()
 591         cfg.DataDir = leecherDataDir
 592         leecher, err := NewClient(cfg)
 593         require.Nil(t, err)
 594         defer leecher.Close()
 595         leecherTorrent, _, _ := leecher.AddTorrentSpec(func() (ret *TorrentSpec) {
 596                 ret = TorrentSpecFromMetaInfo(mi)
 597                 ret.ChunkSize = 2
 598                 return
 599         }())
 600         leecherTorrent.AddClientPeer(seeder)
 601         reader := leecherTorrent.NewReader()
 602         defer reader.Close()
 603         reader.SetReadahead(0)
 604         reader.SetResponsive()
 605         b := make([]byte, 2)
 606         _, err = reader.Seek(3, io.SeekStart)
 607         require.NoError(t, err)
 608         _, err = io.ReadFull(reader, b)
 609         assert.Nil(t, err)
 610         assert.EqualValues(t, "lo", string(b))
 611         _, err = reader.Seek(11, io.SeekStart)
 612         require.NoError(t, err)
 613         n, err := io.ReadFull(reader, b)
 614         assert.Nil(t, err)
 615         assert.EqualValues(t, 2, n)
 616         assert.EqualValues(t, "d\n", string(b))
 617 }
 618
 619 func TestTorrentDroppedDuringResponsiveRead(t *testing.T) {
 620         seederDataDir, mi := testutil.GreetingTestTorrent()
 621         defer os.RemoveAll(seederDataDir)
 622         cfg := TestingConfig()
 623         cfg.Seed = true
 624         cfg.DataDir = seederDataDir
 625         seeder, err := NewClient(cfg)
 626         require.Nil(t, err)
 627         defer seeder.Close()
 628         seederTorrent, _, _ := seeder.AddTorrentSpec(TorrentSpecFromMetaInfo(mi))
 629         seederTorrent.VerifyData()
 630         leecherDataDir, err := ioutil.TempDir("", "")
 631         require.Nil(t, err)
 632         defer os.RemoveAll(leecherDataDir)
 633         cfg = TestingConfig()
 634         cfg.DataDir = leecherDataDir
 635         leecher, err := NewClient(cfg)
 636         require.Nil(t, err)
 637         defer leecher.Close()
 638         leecherTorrent, _, _ := leecher.AddTorrentSpec(func() (ret *TorrentSpec) {
 639                 ret = TorrentSpecFromMetaInfo(mi)
 640                 ret.ChunkSize = 2
 641                 return
 642         }())
 643         leecherTorrent.AddClientPeer(seeder)
 644         reader := leecherTorrent.NewReader()
 645         defer reader.Close()
 646         reader.SetReadahead(0)
 647         reader.SetResponsive()
 648         b := make([]byte, 2)
 649         _, err = reader.Seek(3, io.SeekStart)
 650         require.NoError(t, err)
 651         _, err = io.ReadFull(reader, b)
 652         assert.Nil(t, err)
 653         assert.EqualValues(t, "lo", string(b))
 654         go leecherTorrent.Drop()
 655         _, err = reader.Seek(11, io.SeekStart)
 656         require.NoError(t, err)
 657         n, err := reader.Read(b)
 658         assert.EqualError(t, err, "torrent closed")
 659         assert.EqualValues(t, 0, n)
 660 }
 661
 662 func TestDHTInheritBlocklist(t *testing.T) {
 663         ipl := iplist.New(nil)
 664         require.NotNil(t, ipl)
 665         cfg := TestingConfig()
 666         cfg.IPBlocklist = ipl
 667         cfg.NoDHT = false
 668         cl, err := NewClient(cfg)
 669         require.NoError(t, err)
 670         defer cl.Close()
 671         numServers := 0
 672         cl.eachDhtServer(func(s *dht.Server) {
 673                 assert.Equal(t, ipl, s.IPBlocklist())
 674                 numServers++
 675         })
 676         assert.EqualValues(t, 2, numServers)
 677 }
 678
 679 // Check that stuff is merged in subsequent AddTorrentSpec for the same
 680 // infohash.
 681 func TestAddTorrentSpecMerging(t *testing.T) {
 682         cl, err := NewClient(TestingConfig())
 683         require.NoError(t, err)
 684         defer cl.Close()
 685         dir, mi := testutil.GreetingTestTorrent()
 686         defer os.RemoveAll(dir)
 687         tt, new, err := cl.AddTorrentSpec(&TorrentSpec{
 688                 InfoHash: mi.HashInfoBytes(),
 689         })
 690         require.NoError(t, err)
 691         require.True(t, new)
 692         require.Nil(t, tt.Info())
 693         _, new, err = cl.AddTorrentSpec(TorrentSpecFromMetaInfo(mi))
 694         require.NoError(t, err)
 695         require.False(t, new)
 696         require.NotNil(t, tt.Info())
 697 }
 698
 699 func TestTorrentDroppedBeforeGotInfo(t *testing.T) {
 700         dir, mi := testutil.GreetingTestTorrent()
 701         os.RemoveAll(dir)
 702         cl, _ := NewClient(TestingConfig())
 703         defer cl.Close()
 704         tt, _, _ := cl.AddTorrentSpec(&TorrentSpec{
 705                 InfoHash: mi.HashInfoBytes(),
 706         })
 707         tt.Drop()
 708         assert.EqualValues(t, 0, len(cl.Torrents()))
 709         select {
 710         case <-tt.GotInfo():
 711                 t.FailNow()
 712         default:
 713         }
 714 }
 715
 716 func writeTorrentData(ts *storage.Torrent, info metainfo.Info, b []byte) {
 717         for i := range iter.N(info.NumPieces()) {
 718                 p := info.Piece(i)
 719                 ts.Piece(p).WriteAt(b[p.Offset():p.Offset()+p.Length()], 0)
 720         }
 721 }
 722
 723 func testAddTorrentPriorPieceCompletion(t *testing.T, alreadyCompleted bool, csf func(*filecache.Cache) storage.ClientImpl) {
 724         fileCacheDir, err := ioutil.TempDir("", "")
 725         require.NoError(t, err)
 726         defer os.RemoveAll(fileCacheDir)
 727         fileCache, err := filecache.NewCache(fileCacheDir)
 728         require.NoError(t, err)
 729         greetingDataTempDir, greetingMetainfo := testutil.GreetingTestTorrent()
 730         defer os.RemoveAll(greetingDataTempDir)
 731         filePieceStore := csf(fileCache)
 732         defer filePieceStore.Close()
 733         info, err := greetingMetainfo.UnmarshalInfo()
 734         require.NoError(t, err)
 735         ih := greetingMetainfo.HashInfoBytes()
 736         greetingData, err := storage.NewClient(filePieceStore).OpenTorrent(&info, ih)
 737         require.NoError(t, err)
 738         writeTorrentData(greetingData, info, []byte(testutil.GreetingFileContents))
 739         // require.Equal(t, len(testutil.GreetingFileContents), written)
 740         // require.NoError(t, err)
 741         for i := 0; i < info.NumPieces(); i++ {
 742                 p := info.Piece(i)
 743                 if alreadyCompleted {
 744                         require.NoError(t, greetingData.Piece(p).MarkComplete())
 745                 }
 746         }
 747         cfg := TestingConfig()
 748         // TODO: Disable network option?
 749         cfg.DisableTCP = true
 750         cfg.DisableUTP = true
 751         cfg.DefaultStorage = filePieceStore
 752         cl, err := NewClient(cfg)
 753         require.NoError(t, err)
 754         defer cl.Close()
 755         tt, err := cl.AddTorrent(greetingMetainfo)
 756         require.NoError(t, err)
 757         psrs := tt.PieceStateRuns()
 758         assert.Len(t, psrs, 1)
 759         assert.EqualValues(t, 3, psrs[0].Length)
 760         assert.Equal(t, alreadyCompleted, psrs[0].Complete)
 761         if alreadyCompleted {
 762                 r := tt.NewReader()
 763                 b, err := ioutil.ReadAll(r)
 764                 assert.NoError(t, err)
 765                 assert.EqualValues(t, testutil.GreetingFileContents, b)
 766         }
 767 }
 768
 769 func TestAddTorrentPiecesAlreadyCompleted(t *testing.T) {
 770         testAddTorrentPriorPieceCompletion(t, true, fileCachePieceResourceStorage)
 771 }
 772
 773 func TestAddTorrentPiecesNotAlreadyCompleted(t *testing.T) {
 774         testAddTorrentPriorPieceCompletion(t, false, fileCachePieceResourceStorage)
 775 }
 776
 777 func TestAddMetainfoWithNodes(t *testing.T) {
 778         cfg := TestingConfig()
 779         cfg.ListenHost = func(string) string { return "" }
 780         cfg.NoDHT = false
 781         cfg.DhtStartingNodes = func() ([]dht.Addr, error) { return nil, nil }
 782         // For now, we want to just jam the nodes into the table, without
 783         // verifying them first. Also the DHT code doesn't support mixing secure
 784         // and insecure nodes if security is enabled (yet).
 785         // cfg.DHTConfig.NoSecurity = true
 786         cl, err := NewClient(cfg)
 787         require.NoError(t, err)
 788         defer cl.Close()
 789         sum := func() (ret int64) {
 790                 cl.eachDhtServer(func(s *dht.Server) {
 791                         ret += s.Stats().OutboundQueriesAttempted
 792                 })
 793                 return
 794         }
 795         assert.EqualValues(t, 0, sum())
 796         tt, err := cl.AddTorrentFromFile("metainfo/testdata/issue_65a.torrent")
 797         require.NoError(t, err)
 798         // Nodes are not added or exposed in Torrent's metainfo. We just randomly
 799         // check if the announce-list is here instead. TODO: Add nodes.
 800         assert.Len(t, tt.metainfo.AnnounceList, 5)
 801         // There are 6 nodes in the torrent file.
 802         assert.EqualValues(t, 6*len(cl.dhtServers), sum())
 803 }
 804
 805 type testDownloadCancelParams struct {
 806         SetLeecherStorageCapacity bool
 807         LeecherStorageCapacity    int64
 808         Cancel                    bool
 809 }
 810
 811 func testDownloadCancel(t *testing.T, ps testDownloadCancelParams) {
 812         greetingTempDir, mi := testutil.GreetingTestTorrent()
 813         defer os.RemoveAll(greetingTempDir)
 814         cfg := TestingConfig()
 815         cfg.Seed = true
 816         cfg.DataDir = greetingTempDir
 817         seeder, err := NewClient(cfg)
 818         require.NoError(t, err)
 819         defer seeder.Close()
 820         testutil.ExportStatusWriter(seeder, "s")
 821         seederTorrent, _, _ := seeder.AddTorrentSpec(TorrentSpecFromMetaInfo(mi))
 822         seederTorrent.VerifyData()
 823         leecherDataDir, err := ioutil.TempDir("", "")
 824         require.NoError(t, err)
 825         defer os.RemoveAll(leecherDataDir)
 826         fc, err := filecache.NewCache(leecherDataDir)
 827         require.NoError(t, err)
 828         if ps.SetLeecherStorageCapacity {
 829                 fc.SetCapacity(ps.LeecherStorageCapacity)
 830         }
 831         cfg.DefaultStorage = storage.NewResourcePieces(fc.AsResourceProvider())
 832         cfg.DataDir = leecherDataDir
 833         leecher, _ := NewClient(cfg)
 834         defer leecher.Close()
 835         testutil.ExportStatusWriter(leecher, "l")
 836         leecherGreeting, new, err := leecher.AddTorrentSpec(func() (ret *TorrentSpec) {
 837                 ret = TorrentSpecFromMetaInfo(mi)
 838                 ret.ChunkSize = 2
 839                 return
 840         }())
 841         require.NoError(t, err)
 842         assert.True(t, new)
 843         psc := leecherGreeting.SubscribePieceStateChanges()
 844         defer psc.Close()
 845
 846         leecherGreeting.cl.mu.Lock()
 847         leecherGreeting.downloadPiecesLocked(0, leecherGreeting.numPieces())
 848         if ps.Cancel {
 849                 leecherGreeting.cancelPiecesLocked(0, leecherGreeting.NumPieces())
 850         }
 851         leecherGreeting.cl.mu.Unlock()
 852         done := make(chan struct{})
 853         defer close(done)
 854         go leecherGreeting.AddClientPeer(seeder)
 855         completes := make(map[int]bool, 3)
 856         expected := func() map[int]bool {
 857                 if ps.Cancel {
 858                         return map[int]bool{0: false, 1: false, 2: false}
 859                 } else {
 860                         return map[int]bool{0: true, 1: true, 2: true}
 861                 }
 862         }()
 863         for !reflect.DeepEqual(completes, expected) {
 864                 select {
 865                 case _v := <-psc.Values:
 866                         v := _v.(PieceStateChange)
 867                         completes[v.Index] = v.Complete
 868                 }
 869         }
 870 }
 871
 872 func TestTorrentDownloadAll(t *testing.T) {
 873         testDownloadCancel(t, testDownloadCancelParams{})
 874 }
 875
 876 func TestTorrentDownloadAllThenCancel(t *testing.T) {
 877         testDownloadCancel(t, testDownloadCancelParams{
 878                 Cancel: true,
 879         })
 880 }
 881
 882 // Ensure that it's an error for a peer to send an invalid have message.
 883 func TestPeerInvalidHave(t *testing.T) {
 884         cl, err := NewClient(TestingConfig())
 885         require.NoError(t, err)
 886         defer cl.Close()
 887         info := metainfo.Info{
 888                 PieceLength: 1,
 889                 Pieces:      make([]byte, 20),
 890                 Files:       []metainfo.FileInfo{{Length: 1}},
 891         }
 892         infoBytes, err := bencode.Marshal(info)
 893         require.NoError(t, err)
 894         tt, _new, err := cl.AddTorrentSpec(&TorrentSpec{
 895                 InfoBytes: infoBytes,
 896                 InfoHash:  metainfo.HashBytes(infoBytes),
 897                 Storage:   badStorage{},
 898         })
 899         require.NoError(t, err)
 900         assert.True(t, _new)
 901         defer tt.Drop()
 902         cn := &connection{
 903                 t: tt,
 904         }
 905         assert.NoError(t, cn.peerSentHave(0))
 906         assert.Error(t, cn.peerSentHave(1))
 907 }
 908
 909 func TestPieceCompletedInStorageButNotClient(t *testing.T) {
 910         greetingTempDir, greetingMetainfo := testutil.GreetingTestTorrent()
 911         defer os.RemoveAll(greetingTempDir)
 912         cfg := TestingConfig()
 913         cfg.DataDir = greetingTempDir
 914         seeder, err := NewClient(TestingConfig())
 915         require.NoError(t, err)
 916         seeder.AddTorrentSpec(&TorrentSpec{
 917                 InfoBytes: greetingMetainfo.InfoBytes,
 918         })
 919 }
 920
 921 // Check that when the listen port is 0, all the protocols listened on have
 922 // the same port, and it isn't zero.
 923 func TestClientDynamicListenPortAllProtocols(t *testing.T) {
 924         cl, err := NewClient(TestingConfig())
 925         require.NoError(t, err)
 926         defer cl.Close()
 927         port := cl.LocalPort()
 928         assert.NotEqual(t, 0, port)
 929         cl.eachListener(func(s socket) bool {
 930                 assert.Equal(t, port, missinggo.AddrPort(s.Addr()))
 931                 return true
 932         })
 933 }
 934
 935 func TestClientDynamicListenTCPOnly(t *testing.T) {
 936         cfg := TestingConfig()
 937         cfg.DisableUTP = true
 938         cl, err := NewClient(cfg)
 939         require.NoError(t, err)
 940         defer cl.Close()
 941         assert.NotEqual(t, 0, cl.LocalPort())
 942         cl.eachListener(func(s socket) bool {
 943                 assert.True(t, isTcpNetwork(s.Addr().Network()))
 944                 return true
 945         })
 946 }
 947
 948 func TestClientDynamicListenUTPOnly(t *testing.T) {
 949         cfg := TestingConfig()
 950         cfg.DisableTCP = true
 951         cl, err := NewClient(cfg)
 952         require.NoError(t, err)
 953         defer cl.Close()
 954         assert.NotEqual(t, 0, cl.LocalPort())
 955         cl.eachListener(func(s socket) bool {
 956                 assert.True(t, isUtpNetwork(s.Addr().Network()))
 957                 return true
 958         })
 959 }
 960
 961 func TestClientDynamicListenPortNoProtocols(t *testing.T) {
 962         cfg := TestingConfig()
 963         cfg.DisableTCP = true
 964         cfg.DisableUTP = true
 965         cl, err := NewClient(cfg)
 966         require.NoError(t, err)
 967         defer cl.Close()
 968         assert.Equal(t, 0, cl.LocalPort())
 969 }
 970
 971 func totalConns(tts []*Torrent) (ret int) {
 972         for _, tt := range tts {
 973                 tt.cl.mu.Lock()
 974                 ret += len(tt.conns)
 975                 tt.cl.mu.Unlock()
 976         }
 977         return
 978 }
 979
 980 func TestSetMaxEstablishedConn(t *testing.T) {
 981         ss := testutil.NewStatusServer(t)
 982         defer ss.Close()
 983         var tts []*Torrent
 984         ih := testutil.GreetingMetaInfo().HashInfoBytes()
 985         for i := range iter.N(3) {
 986                 cl, err := NewClient(TestingConfig())
 987                 require.NoError(t, err)
 988                 defer cl.Close()
 989                 tt, _ := cl.AddTorrentInfoHash(ih)
 990                 tt.SetMaxEstablishedConns(2)
 991                 ss.HandleStatusWriter(cl, fmt.Sprintf("/%d", i))
 992                 tts = append(tts, tt)
 993         }
 994         addPeers := func() {
 995                 for _, tt := range tts {
 996                         for _, _tt := range tts {
 997                                 // if tt != _tt {
 998                                 tt.AddClientPeer(_tt.cl)
 999                                 // }
1000                         }
1001                 }
1002         }
1003         waitTotalConns := func(num int) {
1004                 for totalConns(tts) != num {
1005                         addPeers()
1006                         time.Sleep(time.Millisecond)
1007                 }
1008         }
1009         addPeers()
1010         waitTotalConns(6)
1011         tts[0].SetMaxEstablishedConns(1)
1012         waitTotalConns(4)
1013         tts[0].SetMaxEstablishedConns(0)
1014         waitTotalConns(2)
1015         tts[0].SetMaxEstablishedConns(1)
1016         addPeers()
1017         waitTotalConns(4)
1018         tts[0].SetMaxEstablishedConns(2)
1019         addPeers()
1020         waitTotalConns(6)
1021 }
1022
1023 func makeMagnet(t *testing.T, cl *Client, dir string, name string) string {
1024         os.MkdirAll(dir, 0770)
1025         file, err := os.Create(filepath.Join(dir, name))
1026         require.NoError(t, err)
1027         file.Write([]byte(name))
1028         file.Close()
1029         mi := metainfo.MetaInfo{}
1030         mi.SetDefaults()
1031         info := metainfo.Info{PieceLength: 256 * 1024}
1032         err = info.BuildFromFilePath(filepath.Join(dir, name))
1033         require.NoError(t, err)
1034         mi.InfoBytes, err = bencode.Marshal(info)
1035         require.NoError(t, err)
1036         magnet := mi.Magnet(name, mi.HashInfoBytes()).String()
1037         tr, err := cl.AddTorrent(&mi)
1038         require.NoError(t, err)
1039         require.True(t, tr.Seeding())
1040         tr.VerifyData()
1041         return magnet
1042 }
1043
1044 // https://github.com/anacrolix/torrent/issues/114
1045 func TestMultipleTorrentsWithEncryption(t *testing.T) {
1046         cfg := TestingConfig()
1047         cfg.DisableUTP = true
1048         cfg.Seed = true
1049         cfg.DataDir = filepath.Join(cfg.DataDir, "server")
1050         cfg.ForceEncryption = true
1051         os.Mkdir(cfg.DataDir, 0755)
1052         server, err := NewClient(cfg)
1053         require.NoError(t, err)
1054         defer server.Close()
1055         testutil.ExportStatusWriter(server, "s")
1056         magnet1 := makeMagnet(t, server, cfg.DataDir, "test1")
1057         makeMagnet(t, server, cfg.DataDir, "test2")
1058         cfg = TestingConfig()
1059         cfg.DisableUTP = true
1060         cfg.DataDir = filepath.Join(cfg.DataDir, "client")
1061         cfg.ForceEncryption = true
1062         client, err := NewClient(cfg)
1063         require.NoError(t, err)
1064         defer client.Close()
1065         testutil.ExportStatusWriter(client, "c")
1066         tr, err := client.AddMagnet(magnet1)
1067         require.NoError(t, err)
1068         tr.AddClientPeer(server)
1069         <-tr.GotInfo()
1070         tr.DownloadAll()
1071         client.WaitAll()
1072 }
1073
1074 func TestClientAddressInUse(t *testing.T) {
1075         s, _ := NewUtpSocket("udp", ":50007")
1076         if s != nil {
1077                 defer s.Close()
1078         }
1079         cfg := TestingConfig().SetListenAddr(":50007")
1080         cl, err := NewClient(cfg)
1081         require.Error(t, err)
1082         require.Nil(t, cl)
1083 }