client_test.go

   1 package torrent
   2
   3 import (
   4         "encoding/binary"
   5         "fmt"
   6         "io"
   7         "os"
   8         "path/filepath"
   9         "reflect"
  10         "testing"
  11         "testing/iotest"
  12         "time"
  13
  14         "github.com/frankban/quicktest"
  15         "github.com/stretchr/testify/assert"
  16         "github.com/stretchr/testify/require"
  17
  18         "github.com/anacrolix/log"
  19
  20         "github.com/anacrolix/dht/v2"
  21         "github.com/anacrolix/missinggo/v2"
  22         "github.com/anacrolix/missinggo/v2/filecache"
  23
  24         "github.com/anacrolix/torrent/bencode"
  25         "github.com/anacrolix/torrent/internal/testutil"
  26         "github.com/anacrolix/torrent/iplist"
  27         "github.com/anacrolix/torrent/metainfo"
  28         "github.com/anacrolix/torrent/storage"
  29 )
  30
  31 func TestClientDefault(t *testing.T) {
  32         cl, err := NewClient(TestingConfig(t))
  33         require.NoError(t, err)
  34         require.Empty(t, cl.Close())
  35 }
  36
  37 func TestClientNilConfig(t *testing.T) {
  38         // The default config will put crap in the working directory.
  39         origDir, _ := os.Getwd()
  40         defer os.Chdir(origDir)
  41         os.Chdir(t.TempDir())
  42         cl, err := NewClient(nil)
  43         require.NoError(t, err)
  44         require.Empty(t, cl.Close())
  45 }
  46
  47 func TestAddDropTorrent(t *testing.T) {
  48         cl, err := NewClient(TestingConfig(t))
  49         require.NoError(t, err)
  50         defer cl.Close()
  51         dir, mi := testutil.GreetingTestTorrent()
  52         defer os.RemoveAll(dir)
  53         tt, new, err := cl.AddTorrentSpec(TorrentSpecFromMetaInfo(mi))
  54         require.NoError(t, err)
  55         assert.True(t, new)
  56         tt.SetMaxEstablishedConns(0)
  57         tt.SetMaxEstablishedConns(1)
  58         tt.Drop()
  59 }
  60
  61 func TestAddTorrentNoSupportedTrackerSchemes(t *testing.T) {
  62         // TODO?
  63         t.SkipNow()
  64 }
  65
  66 func TestAddTorrentNoUsableURLs(t *testing.T) {
  67         // TODO?
  68         t.SkipNow()
  69 }
  70
  71 func TestAddPeersToUnknownTorrent(t *testing.T) {
  72         // TODO?
  73         t.SkipNow()
  74 }
  75
  76 func TestPieceHashSize(t *testing.T) {
  77         assert.Equal(t, 20, pieceHash.Size())
  78 }
  79
  80 func TestTorrentInitialState(t *testing.T) {
  81         dir, mi := testutil.GreetingTestTorrent()
  82         defer os.RemoveAll(dir)
  83         var cl Client
  84         cl.init(TestingConfig(t))
  85         cl.initLogger()
  86         tor := cl.newTorrent(
  87                 mi.HashInfoBytes(),
  88                 storage.NewFileWithCompletion(t.TempDir(), storage.NewMapPieceCompletion()),
  89         )
  90         tor.setChunkSize(2)
  91         tor.cl.lock()
  92         err := tor.setInfoBytesLocked(mi.InfoBytes)
  93         tor.cl.unlock()
  94         require.NoError(t, err)
  95         require.Len(t, tor.pieces, 3)
  96         tor.pendAllChunkSpecs(0)
  97         tor.cl.lock()
  98         assert.EqualValues(t, 3, tor.pieceNumPendingChunks(0))
  99         tor.cl.unlock()
 100         assert.EqualValues(t, ChunkSpec{4, 1}, chunkIndexSpec(2, tor.pieceLength(0), tor.chunkSize))
 101 }
 102
 103 func TestReducedDialTimeout(t *testing.T) {
 104         cfg := NewDefaultClientConfig()
 105         for _, _case := range []struct {
 106                 Max             time.Duration
 107                 HalfOpenLimit   int
 108                 PendingPeers    int
 109                 ExpectedReduced time.Duration
 110         }{
 111                 {cfg.NominalDialTimeout, 40, 0, cfg.NominalDialTimeout},
 112                 {cfg.NominalDialTimeout, 40, 1, cfg.NominalDialTimeout},
 113                 {cfg.NominalDialTimeout, 40, 39, cfg.NominalDialTimeout},
 114                 {cfg.NominalDialTimeout, 40, 40, cfg.NominalDialTimeout / 2},
 115                 {cfg.NominalDialTimeout, 40, 80, cfg.NominalDialTimeout / 3},
 116                 {cfg.NominalDialTimeout, 40, 4000, cfg.NominalDialTimeout / 101},
 117         } {
 118                 reduced := reducedDialTimeout(cfg.MinDialTimeout, _case.Max, _case.HalfOpenLimit, _case.PendingPeers)
 119                 expected := _case.ExpectedReduced
 120                 if expected < cfg.MinDialTimeout {
 121                         expected = cfg.MinDialTimeout
 122                 }
 123                 if reduced != expected {
 124                         t.Fatalf("expected %s, got %s", _case.ExpectedReduced, reduced)
 125                 }
 126         }
 127 }
 128
 129 func TestAddDropManyTorrents(t *testing.T) {
 130         cl, err := NewClient(TestingConfig(t))
 131         require.NoError(t, err)
 132         defer cl.Close()
 133         for i := 0; i < 1000; i += 1 {
 134                 var spec TorrentSpec
 135                 binary.PutVarint(spec.InfoHash[:], int64(i))
 136                 tt, new, err := cl.AddTorrentSpec(&spec)
 137                 assert.NoError(t, err)
 138                 assert.True(t, new)
 139                 defer tt.Drop()
 140         }
 141 }
 142
 143 func fileCachePieceResourceStorage(fc *filecache.Cache) storage.ClientImpl {
 144         return storage.NewResourcePiecesOpts(
 145                 fc.AsResourceProvider(),
 146                 storage.ResourcePiecesOpts{
 147                         LeaveIncompleteChunks: true,
 148                 },
 149         )
 150 }
 151
 152 func TestMergingTrackersByAddingSpecs(t *testing.T) {
 153         cl, err := NewClient(TestingConfig(t))
 154         require.NoError(t, err)
 155         defer cl.Close()
 156         spec := TorrentSpec{}
 157         T, new, _ := cl.AddTorrentSpec(&spec)
 158         if !new {
 159                 t.FailNow()
 160         }
 161         spec.Trackers = [][]string{{"http://a"}, {"udp://b"}}
 162         _, new, _ = cl.AddTorrentSpec(&spec)
 163         assert.False(t, new)
 164         assert.EqualValues(t, [][]string{{"http://a"}, {"udp://b"}}, T.metainfo.AnnounceList)
 165         // Because trackers are disabled in TestingConfig.
 166         assert.EqualValues(t, 0, len(T.trackerAnnouncers))
 167 }
 168
 169 // We read from a piece which is marked completed, but is missing data.
 170 func TestCompletedPieceWrongSize(t *testing.T) {
 171         cfg := TestingConfig(t)
 172         cfg.DefaultStorage = badStorage{}
 173         cl, err := NewClient(cfg)
 174         require.NoError(t, err)
 175         defer cl.Close()
 176         info := metainfo.Info{
 177                 PieceLength: 15,
 178                 Pieces:      make([]byte, 20),
 179                 Files: []metainfo.FileInfo{
 180                         {Path: []string{"greeting"}, Length: 13},
 181                 },
 182         }
 183         b, err := bencode.Marshal(info)
 184         require.NoError(t, err)
 185         tt, new, err := cl.AddTorrentSpec(&TorrentSpec{
 186                 InfoBytes: b,
 187                 InfoHash:  metainfo.HashBytes(b),
 188         })
 189         require.NoError(t, err)
 190         defer tt.Drop()
 191         assert.True(t, new)
 192         r := tt.NewReader()
 193         defer r.Close()
 194         quicktest.Check(t, iotest.TestReader(r, []byte(testutil.GreetingFileContents)), quicktest.IsNil)
 195 }
 196
 197 func BenchmarkAddLargeTorrent(b *testing.B) {
 198         cfg := TestingConfig(b)
 199         cfg.DisableTCP = true
 200         cfg.DisableUTP = true
 201         cl, err := NewClient(cfg)
 202         require.NoError(b, err)
 203         defer cl.Close()
 204         b.ReportAllocs()
 205         for i := 0; i < b.N; i += 1 {
 206                 t, err := cl.AddTorrentFromFile("testdata/bootstrap.dat.torrent")
 207                 if err != nil {
 208                         b.Fatal(err)
 209                 }
 210                 t.Drop()
 211         }
 212 }
 213
 214 func TestResponsive(t *testing.T) {
 215         seederDataDir, mi := testutil.GreetingTestTorrent()
 216         defer os.RemoveAll(seederDataDir)
 217         cfg := TestingConfig(t)
 218         cfg.Seed = true
 219         cfg.DataDir = seederDataDir
 220         seeder, err := NewClient(cfg)
 221         require.Nil(t, err)
 222         defer seeder.Close()
 223         seederTorrent, _, _ := seeder.AddTorrentSpec(TorrentSpecFromMetaInfo(mi))
 224         seederTorrent.VerifyData()
 225         leecherDataDir := t.TempDir()
 226         cfg = TestingConfig(t)
 227         cfg.DataDir = leecherDataDir
 228         leecher, err := NewClient(cfg)
 229         require.Nil(t, err)
 230         defer leecher.Close()
 231         leecherTorrent, _, _ := leecher.AddTorrentSpec(func() (ret *TorrentSpec) {
 232                 ret = TorrentSpecFromMetaInfo(mi)
 233                 ret.ChunkSize = 2
 234                 return
 235         }())
 236         leecherTorrent.AddClientPeer(seeder)
 237         reader := leecherTorrent.NewReader()
 238         defer reader.Close()
 239         reader.SetReadahead(0)
 240         reader.SetResponsive()
 241         b := make([]byte, 2)
 242         _, err = reader.Seek(3, io.SeekStart)
 243         require.NoError(t, err)
 244         _, err = io.ReadFull(reader, b)
 245         assert.Nil(t, err)
 246         assert.EqualValues(t, "lo", string(b))
 247         _, err = reader.Seek(11, io.SeekStart)
 248         require.NoError(t, err)
 249         n, err := io.ReadFull(reader, b)
 250         assert.Nil(t, err)
 251         assert.EqualValues(t, 2, n)
 252         assert.EqualValues(t, "d\n", string(b))
 253 }
 254
 255 func TestTorrentDroppedDuringResponsiveRead(t *testing.T) {
 256         seederDataDir, mi := testutil.GreetingTestTorrent()
 257         defer os.RemoveAll(seederDataDir)
 258         cfg := TestingConfig(t)
 259         cfg.Seed = true
 260         cfg.DataDir = seederDataDir
 261         seeder, err := NewClient(cfg)
 262         require.Nil(t, err)
 263         defer seeder.Close()
 264         seederTorrent, _, _ := seeder.AddTorrentSpec(TorrentSpecFromMetaInfo(mi))
 265         seederTorrent.VerifyData()
 266         leecherDataDir := t.TempDir()
 267         cfg = TestingConfig(t)
 268         cfg.DataDir = leecherDataDir
 269         leecher, err := NewClient(cfg)
 270         require.Nil(t, err)
 271         defer leecher.Close()
 272         leecherTorrent, _, _ := leecher.AddTorrentSpec(func() (ret *TorrentSpec) {
 273                 ret = TorrentSpecFromMetaInfo(mi)
 274                 ret.ChunkSize = 2
 275                 return
 276         }())
 277         leecherTorrent.AddClientPeer(seeder)
 278         reader := leecherTorrent.NewReader()
 279         defer reader.Close()
 280         reader.SetReadahead(0)
 281         reader.SetResponsive()
 282         b := make([]byte, 2)
 283         _, err = reader.Seek(3, io.SeekStart)
 284         require.NoError(t, err)
 285         _, err = io.ReadFull(reader, b)
 286         assert.Nil(t, err)
 287         assert.EqualValues(t, "lo", string(b))
 288         _, err = reader.Seek(11, io.SeekStart)
 289         require.NoError(t, err)
 290         leecherTorrent.Drop()
 291         n, err := reader.Read(b)
 292         assert.EqualError(t, err, "torrent closed")
 293         assert.EqualValues(t, 0, n)
 294 }
 295
 296 func TestDhtInheritBlocklist(t *testing.T) {
 297         ipl := iplist.New(nil)
 298         require.NotNil(t, ipl)
 299         cfg := TestingConfig(t)
 300         cfg.IPBlocklist = ipl
 301         cfg.NoDHT = false
 302         cl, err := NewClient(cfg)
 303         require.NoError(t, err)
 304         defer cl.Close()
 305         numServers := 0
 306         cl.eachDhtServer(func(s DhtServer) {
 307                 t.Log(s)
 308                 assert.Equal(t, ipl, s.(AnacrolixDhtServerWrapper).Server.IPBlocklist())
 309                 numServers++
 310         })
 311         assert.EqualValues(t, 2, numServers)
 312 }
 313
 314 // Check that stuff is merged in subsequent AddTorrentSpec for the same
 315 // infohash.
 316 func TestAddTorrentSpecMerging(t *testing.T) {
 317         cl, err := NewClient(TestingConfig(t))
 318         require.NoError(t, err)
 319         defer cl.Close()
 320         dir, mi := testutil.GreetingTestTorrent()
 321         defer os.RemoveAll(dir)
 322         tt, new, err := cl.AddTorrentSpec(&TorrentSpec{
 323                 InfoHash: mi.HashInfoBytes(),
 324         })
 325         require.NoError(t, err)
 326         require.True(t, new)
 327         require.Nil(t, tt.Info())
 328         _, new, err = cl.AddTorrentSpec(TorrentSpecFromMetaInfo(mi))
 329         require.NoError(t, err)
 330         require.False(t, new)
 331         require.NotNil(t, tt.Info())
 332 }
 333
 334 func TestTorrentDroppedBeforeGotInfo(t *testing.T) {
 335         dir, mi := testutil.GreetingTestTorrent()
 336         os.RemoveAll(dir)
 337         cl, _ := NewClient(TestingConfig(t))
 338         defer cl.Close()
 339         tt, _, _ := cl.AddTorrentSpec(&TorrentSpec{
 340                 InfoHash: mi.HashInfoBytes(),
 341         })
 342         tt.Drop()
 343         assert.EqualValues(t, 0, len(cl.Torrents()))
 344         select {
 345         case <-tt.GotInfo():
 346                 t.FailNow()
 347         default:
 348         }
 349 }
 350
 351 func writeTorrentData(ts *storage.Torrent, info metainfo.Info, b []byte) {
 352         for i := 0; i < info.NumPieces(); i += 1 {
 353                 p := info.Piece(i)
 354                 ts.Piece(p).WriteAt(b[p.Offset():p.Offset()+p.Length()], 0)
 355         }
 356 }
 357
 358 func testAddTorrentPriorPieceCompletion(t *testing.T, alreadyCompleted bool, csf func(*filecache.Cache) storage.ClientImpl) {
 359         fileCacheDir := t.TempDir()
 360         fileCache, err := filecache.NewCache(fileCacheDir)
 361         require.NoError(t, err)
 362         greetingDataTempDir, greetingMetainfo := testutil.GreetingTestTorrent()
 363         defer os.RemoveAll(greetingDataTempDir)
 364         filePieceStore := csf(fileCache)
 365         info, err := greetingMetainfo.UnmarshalInfo()
 366         require.NoError(t, err)
 367         ih := greetingMetainfo.HashInfoBytes()
 368         greetingData, err := storage.NewClient(filePieceStore).OpenTorrent(&info, ih)
 369         require.NoError(t, err)
 370         writeTorrentData(greetingData, info, []byte(testutil.GreetingFileContents))
 371         // require.Equal(t, len(testutil.GreetingFileContents), written)
 372         // require.NoError(t, err)
 373         for i := 0; i < info.NumPieces(); i++ {
 374                 p := info.Piece(i)
 375                 if alreadyCompleted {
 376                         require.NoError(t, greetingData.Piece(p).MarkComplete())
 377                 }
 378         }
 379         cfg := TestingConfig(t)
 380         // TODO: Disable network option?
 381         cfg.DisableTCP = true
 382         cfg.DisableUTP = true
 383         cfg.DefaultStorage = filePieceStore
 384         cl, err := NewClient(cfg)
 385         require.NoError(t, err)
 386         defer cl.Close()
 387         tt, err := cl.AddTorrent(greetingMetainfo)
 388         require.NoError(t, err)
 389         psrs := tt.PieceStateRuns()
 390         assert.Len(t, psrs, 1)
 391         assert.EqualValues(t, 3, psrs[0].Length)
 392         assert.Equal(t, alreadyCompleted, psrs[0].Complete)
 393         if alreadyCompleted {
 394                 r := tt.NewReader()
 395                 quicktest.Check(t, iotest.TestReader(r, []byte(testutil.GreetingFileContents)), quicktest.IsNil)
 396         }
 397 }
 398
 399 func TestAddTorrentPiecesAlreadyCompleted(t *testing.T) {
 400         testAddTorrentPriorPieceCompletion(t, true, fileCachePieceResourceStorage)
 401 }
 402
 403 func TestAddTorrentPiecesNotAlreadyCompleted(t *testing.T) {
 404         testAddTorrentPriorPieceCompletion(t, false, fileCachePieceResourceStorage)
 405 }
 406
 407 func TestAddMetainfoWithNodes(t *testing.T) {
 408         cfg := TestingConfig(t)
 409         cfg.ListenHost = func(string) string { return "" }
 410         cfg.NoDHT = false
 411         cfg.DhtStartingNodes = func(string) dht.StartingNodesGetter { return func() ([]dht.Addr, error) { return nil, nil } }
 412         // For now, we want to just jam the nodes into the table, without verifying them first. Also the
 413         // DHT code doesn't support mixing secure and insecure nodes if security is enabled (yet).
 414         // cfg.DHTConfig.NoSecurity = true
 415         cl, err := NewClient(cfg)
 416         require.NoError(t, err)
 417         defer cl.Close()
 418         sum := func() (ret int64) {
 419                 cl.eachDhtServer(func(s DhtServer) {
 420                         ret += s.Stats().(dht.ServerStats).OutboundQueriesAttempted
 421                 })
 422                 return
 423         }
 424         assert.EqualValues(t, 0, sum())
 425         tt, err := cl.AddTorrentFromFile("metainfo/testdata/issue_65a.torrent")
 426         require.NoError(t, err)
 427         // Nodes are not added or exposed in Torrent's metainfo. We just randomly
 428         // check if the announce-list is here instead. TODO: Add nodes.
 429         assert.Len(t, tt.metainfo.AnnounceList, 5)
 430         // There are 6 nodes in the torrent file.
 431         for sum() != int64(6*len(cl.dhtServers)) {
 432                 time.Sleep(time.Millisecond)
 433         }
 434 }
 435
 436 type testDownloadCancelParams struct {
 437         SetLeecherStorageCapacity bool
 438         LeecherStorageCapacity    int64
 439         Cancel                    bool
 440 }
 441
 442 func testDownloadCancel(t *testing.T, ps testDownloadCancelParams) {
 443         greetingTempDir, mi := testutil.GreetingTestTorrent()
 444         defer os.RemoveAll(greetingTempDir)
 445         cfg := TestingConfig(t)
 446         cfg.Seed = true
 447         cfg.DataDir = greetingTempDir
 448         seeder, err := NewClient(cfg)
 449         require.NoError(t, err)
 450         defer seeder.Close()
 451         defer testutil.ExportStatusWriter(seeder, "s", t)()
 452         seederTorrent, _, _ := seeder.AddTorrentSpec(TorrentSpecFromMetaInfo(mi))
 453         seederTorrent.VerifyData()
 454         leecherDataDir := t.TempDir()
 455         fc, err := filecache.NewCache(leecherDataDir)
 456         require.NoError(t, err)
 457         if ps.SetLeecherStorageCapacity {
 458                 fc.SetCapacity(ps.LeecherStorageCapacity)
 459         }
 460         cfg.DefaultStorage = storage.NewResourcePieces(fc.AsResourceProvider())
 461         cfg.DataDir = leecherDataDir
 462         leecher, err := NewClient(cfg)
 463         require.NoError(t, err)
 464         defer leecher.Close()
 465         defer testutil.ExportStatusWriter(leecher, "l", t)()
 466         leecherGreeting, new, err := leecher.AddTorrentSpec(func() (ret *TorrentSpec) {
 467                 ret = TorrentSpecFromMetaInfo(mi)
 468                 ret.ChunkSize = 2
 469                 return
 470         }())
 471         require.NoError(t, err)
 472         assert.True(t, new)
 473         psc := leecherGreeting.SubscribePieceStateChanges()
 474         defer psc.Close()
 475
 476         leecherGreeting.cl.lock()
 477         leecherGreeting.downloadPiecesLocked(0, leecherGreeting.numPieces())
 478         if ps.Cancel {
 479                 leecherGreeting.cancelPiecesLocked(0, leecherGreeting.NumPieces(), "")
 480         }
 481         leecherGreeting.cl.unlock()
 482         done := make(chan struct{})
 483         defer close(done)
 484         go leecherGreeting.AddClientPeer(seeder)
 485         completes := make(map[int]bool, 3)
 486         expected := func() map[int]bool {
 487                 if ps.Cancel {
 488                         return map[int]bool{0: false, 1: false, 2: false}
 489                 } else {
 490                         return map[int]bool{0: true, 1: true, 2: true}
 491                 }
 492         }()
 493         for !reflect.DeepEqual(completes, expected) {
 494                 v := <-psc.Values
 495                 completes[v.Index] = v.Complete
 496         }
 497 }
 498
 499 func TestTorrentDownloadAll(t *testing.T) {
 500         testDownloadCancel(t, testDownloadCancelParams{})
 501 }
 502
 503 func TestTorrentDownloadAllThenCancel(t *testing.T) {
 504         testDownloadCancel(t, testDownloadCancelParams{
 505                 Cancel: true,
 506         })
 507 }
 508
 509 // Ensure that it's an error for a peer to send an invalid have message.
 510 func TestPeerInvalidHave(t *testing.T) {
 511         cfg := TestingConfig(t)
 512         cfg.DropMutuallyCompletePeers = false
 513         cl, err := NewClient(cfg)
 514         require.NoError(t, err)
 515         defer cl.Close()
 516         info := metainfo.Info{
 517                 PieceLength: 1,
 518                 Pieces:      make([]byte, 20),
 519                 Files:       []metainfo.FileInfo{{Length: 1}},
 520         }
 521         infoBytes, err := bencode.Marshal(info)
 522         require.NoError(t, err)
 523         tt, _new, err := cl.AddTorrentSpec(&TorrentSpec{
 524                 InfoBytes: infoBytes,
 525                 InfoHash:  metainfo.HashBytes(infoBytes),
 526                 Storage:   badStorage{},
 527         })
 528         require.NoError(t, err)
 529         assert.True(t, _new)
 530         defer tt.Drop()
 531         cn := &PeerConn{Peer: Peer{
 532                 t:         tt,
 533                 callbacks: &cfg.Callbacks,
 534         }}
 535         tt.conns[cn] = struct{}{}
 536         cn.peerImpl = cn
 537         cl.lock()
 538         defer cl.unlock()
 539         assert.NoError(t, cn.peerSentHave(0))
 540         assert.Error(t, cn.peerSentHave(1))
 541 }
 542
 543 func TestPieceCompletedInStorageButNotClient(t *testing.T) {
 544         greetingTempDir, greetingMetainfo := testutil.GreetingTestTorrent()
 545         defer os.RemoveAll(greetingTempDir)
 546         cfg := TestingConfig(t)
 547         cfg.DataDir = greetingTempDir
 548         seeder, err := NewClient(TestingConfig(t))
 549         require.NoError(t, err)
 550         seeder.AddTorrentSpec(&TorrentSpec{
 551                 InfoBytes: greetingMetainfo.InfoBytes,
 552         })
 553 }
 554
 555 // Check that when the listen port is 0, all the protocols listened on have
 556 // the same port, and it isn't zero.
 557 func TestClientDynamicListenPortAllProtocols(t *testing.T) {
 558         cl, err := NewClient(TestingConfig(t))
 559         require.NoError(t, err)
 560         defer cl.Close()
 561         port := cl.LocalPort()
 562         assert.NotEqual(t, 0, port)
 563         cl.eachListener(func(s Listener) bool {
 564                 assert.Equal(t, port, missinggo.AddrPort(s.Addr()))
 565                 return true
 566         })
 567 }
 568
 569 func TestClientDynamicListenTCPOnly(t *testing.T) {
 570         cfg := TestingConfig(t)
 571         cfg.DisableUTP = true
 572         cfg.DisableTCP = false
 573         cl, err := NewClient(cfg)
 574         require.NoError(t, err)
 575         defer cl.Close()
 576         assert.NotEqual(t, 0, cl.LocalPort())
 577 }
 578
 579 func TestClientDynamicListenUTPOnly(t *testing.T) {
 580         cfg := TestingConfig(t)
 581         cfg.DisableTCP = true
 582         cfg.DisableUTP = false
 583         cl, err := NewClient(cfg)
 584         require.NoError(t, err)
 585         defer cl.Close()
 586         assert.NotEqual(t, 0, cl.LocalPort())
 587 }
 588
 589 func totalConns(tts []*Torrent) (ret int) {
 590         for _, tt := range tts {
 591                 tt.cl.lock()
 592                 ret += len(tt.conns)
 593                 tt.cl.unlock()
 594         }
 595         return
 596 }
 597
 598 func TestSetMaxEstablishedConn(t *testing.T) {
 599         var tts []*Torrent
 600         ih := testutil.GreetingMetaInfo().HashInfoBytes()
 601         cfg := TestingConfig(t)
 602         cfg.DisableAcceptRateLimiting = true
 603         cfg.DropDuplicatePeerIds = true
 604         for i := 0; i < 3; i += 1 {
 605                 cl, err := NewClient(cfg)
 606                 require.NoError(t, err)
 607                 defer cl.Close()
 608                 tt, _ := cl.AddTorrentInfoHash(ih)
 609                 tt.SetMaxEstablishedConns(2)
 610                 defer testutil.ExportStatusWriter(cl, fmt.Sprintf("%d", i), t)()
 611                 tts = append(tts, tt)
 612         }
 613         addPeers := func() {
 614                 for _, tt := range tts {
 615                         for _, _tt := range tts {
 616                                 // if tt != _tt {
 617                                 tt.AddClientPeer(_tt.cl)
 618                                 // }
 619                         }
 620                 }
 621         }
 622         waitTotalConns := func(num int) {
 623                 for totalConns(tts) != num {
 624                         addPeers()
 625                         time.Sleep(time.Millisecond)
 626                 }
 627         }
 628         addPeers()
 629         waitTotalConns(6)
 630         tts[0].SetMaxEstablishedConns(1)
 631         waitTotalConns(4)
 632         tts[0].SetMaxEstablishedConns(0)
 633         waitTotalConns(2)
 634         tts[0].SetMaxEstablishedConns(1)
 635         addPeers()
 636         waitTotalConns(4)
 637         tts[0].SetMaxEstablishedConns(2)
 638         addPeers()
 639         waitTotalConns(6)
 640 }
 641
 642 // Creates a file containing its own name as data. Make a metainfo from that, adds it to the given
 643 // client, and returns a magnet link.
 644 func makeMagnet(t *testing.T, cl *Client, dir, name string) string {
 645         os.MkdirAll(dir, 0o770)
 646         file, err := os.Create(filepath.Join(dir, name))
 647         require.NoError(t, err)
 648         file.Write([]byte(name))
 649         file.Close()
 650         mi := metainfo.MetaInfo{}
 651         mi.SetDefaults()
 652         info := metainfo.Info{PieceLength: 256 * 1024}
 653         err = info.BuildFromFilePath(filepath.Join(dir, name))
 654         require.NoError(t, err)
 655         mi.InfoBytes, err = bencode.Marshal(info)
 656         require.NoError(t, err)
 657         magnet := mi.Magnet(nil, &info).String()
 658         tr, err := cl.AddTorrent(&mi)
 659         require.NoError(t, err)
 660         require.True(t, tr.Seeding())
 661         tr.VerifyData()
 662         return magnet
 663 }
 664
 665 // https://github.com/anacrolix/torrent/issues/114
 666 func TestMultipleTorrentsWithEncryption(t *testing.T) {
 667         testSeederLeecherPair(
 668                 t,
 669                 func(cfg *ClientConfig) {
 670                         cfg.HeaderObfuscationPolicy.Preferred = true
 671                         cfg.HeaderObfuscationPolicy.RequirePreferred = true
 672                 },
 673                 func(cfg *ClientConfig) {
 674                         cfg.HeaderObfuscationPolicy.RequirePreferred = false
 675                 },
 676         )
 677 }
 678
 679 // Test that the leecher can download a torrent in its entirety from the seeder. Note that the
 680 // seeder config is done first.
 681 func testSeederLeecherPair(t *testing.T, seeder, leecher func(*ClientConfig)) {
 682         cfg := TestingConfig(t)
 683         cfg.Seed = true
 684         cfg.DataDir = filepath.Join(cfg.DataDir, "server")
 685         os.Mkdir(cfg.DataDir, 0o755)
 686         seeder(cfg)
 687         server, err := NewClient(cfg)
 688         require.NoError(t, err)
 689         defer server.Close()
 690         defer testutil.ExportStatusWriter(server, "s", t)()
 691         magnet1 := makeMagnet(t, server, cfg.DataDir, "test1")
 692         // Extra torrents are added to test the seeder having to match incoming obfuscated headers
 693         // against more than one torrent. See issue #114
 694         makeMagnet(t, server, cfg.DataDir, "test2")
 695         for i := 0; i < 100; i++ {
 696                 makeMagnet(t, server, cfg.DataDir, fmt.Sprintf("test%d", i+2))
 697         }
 698         cfg = TestingConfig(t)
 699         cfg.DataDir = filepath.Join(cfg.DataDir, "client")
 700         leecher(cfg)
 701         client, err := NewClient(cfg)
 702         require.NoError(t, err)
 703         defer client.Close()
 704         defer testutil.ExportStatusWriter(client, "c", t)()
 705         tr, err := client.AddMagnet(magnet1)
 706         require.NoError(t, err)
 707         tr.AddClientPeer(server)
 708         <-tr.GotInfo()
 709         tr.DownloadAll()
 710         client.WaitAll()
 711 }
 712
 713 // This appears to be the situation with the S3 BitTorrent client.
 714 func TestObfuscatedHeaderFallbackSeederDisallowsLeecherPrefers(t *testing.T) {
 715         // Leecher prefers obfuscation, but the seeder does not allow it.
 716         testSeederLeecherPair(
 717                 t,
 718                 func(cfg *ClientConfig) {
 719                         cfg.HeaderObfuscationPolicy.Preferred = false
 720                         cfg.HeaderObfuscationPolicy.RequirePreferred = true
 721                 },
 722                 func(cfg *ClientConfig) {
 723                         cfg.HeaderObfuscationPolicy.Preferred = true
 724                         cfg.HeaderObfuscationPolicy.RequirePreferred = false
 725                 },
 726         )
 727 }
 728
 729 func TestObfuscatedHeaderFallbackSeederRequiresLeecherPrefersNot(t *testing.T) {
 730         // Leecher prefers no obfuscation, but the seeder enforces it.
 731         testSeederLeecherPair(
 732                 t,
 733                 func(cfg *ClientConfig) {
 734                         cfg.HeaderObfuscationPolicy.Preferred = true
 735                         cfg.HeaderObfuscationPolicy.RequirePreferred = true
 736                 },
 737                 func(cfg *ClientConfig) {
 738                         cfg.HeaderObfuscationPolicy.Preferred = false
 739                         cfg.HeaderObfuscationPolicy.RequirePreferred = false
 740                 },
 741         )
 742 }
 743
 744 func TestClientAddressInUse(t *testing.T) {
 745         s, _ := NewUtpSocket("udp", ":50007", nil, log.Default)
 746         if s != nil {
 747                 defer s.Close()
 748         }
 749         cfg := TestingConfig(t).SetListenAddr(":50007")
 750         cl, err := NewClient(cfg)
 751         require.Error(t, err)
 752         require.Nil(t, cl)
 753 }
 754
 755 func TestClientHasDhtServersWhenUtpDisabled(t *testing.T) {
 756         cc := TestingConfig(t)
 757         cc.DisableUTP = true
 758         cc.NoDHT = false
 759         cl, err := NewClient(cc)
 760         require.NoError(t, err)
 761         defer cl.Close()
 762         assert.NotEmpty(t, cl.DhtServers())
 763 }
 764
 765 func TestClientDisabledImplicitNetworksButDhtEnabled(t *testing.T) {
 766         cfg := TestingConfig(t)
 767         cfg.DisableTCP = true
 768         cfg.DisableUTP = true
 769         cfg.NoDHT = false
 770         cl, err := NewClient(cfg)
 771         require.NoError(t, err)
 772         defer cl.Close()
 773         assert.Empty(t, cl.listeners)
 774         assert.NotEmpty(t, cl.DhtServers())
 775 }