DefaultBtMessageDispatcherTest.cc 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
  1. #include "DefaultBtMessageDispatcher.h"
  2. #include <cassert>
  3. #include <cppunit/extensions/HelperMacros.h>
  4. #include "util.h"
  5. #include "Exception.h"
  6. #include "MockBtMessage.h"
  7. #include "MockBtMessageFactory.h"
  8. #include "prefs.h"
  9. #include "BtCancelSendingPieceEvent.h"
  10. #include "BtHandshakeMessage.h"
  11. #include "Option.h"
  12. #include "RequestGroupMan.h"
  13. #include "ServerStatMan.h"
  14. #include "RequestGroup.h"
  15. #include "DownloadContext.h"
  16. #include "bittorrent_helper.h"
  17. #include "PeerConnection.h"
  18. namespace aria2 {
  19. class DefaultBtMessageDispatcherTest:public CppUnit::TestFixture {
  20. CPPUNIT_TEST_SUITE(DefaultBtMessageDispatcherTest);
  21. CPPUNIT_TEST(testAddMessage);
  22. CPPUNIT_TEST(testSendMessages);
  23. CPPUNIT_TEST(testSendMessages_underUploadLimit);
  24. // See the comment on the definition
  25. //CPPUNIT_TEST(testSendMessages_overUploadLimit);
  26. CPPUNIT_TEST(testDoCancelSendingPieceAction);
  27. CPPUNIT_TEST(testCheckRequestSlotAndDoNecessaryThing);
  28. CPPUNIT_TEST(testCheckRequestSlotAndDoNecessaryThing_timeout);
  29. CPPUNIT_TEST(testCheckRequestSlotAndDoNecessaryThing_completeBlock);
  30. CPPUNIT_TEST(testCountOutstandingRequest);
  31. CPPUNIT_TEST(testIsOutstandingRequest);
  32. CPPUNIT_TEST(testGetOutstandingRequest);
  33. CPPUNIT_TEST(testRemoveOutstandingRequest);
  34. CPPUNIT_TEST_SUITE_END();
  35. private:
  36. std::shared_ptr<DownloadContext> dctx_;
  37. std::shared_ptr<Peer> peer;
  38. std::unique_ptr<DefaultBtMessageDispatcher> btMessageDispatcher;
  39. std::unique_ptr<MockBtMessageFactory> messageFactory_;
  40. std::unique_ptr<RequestGroupMan> rgman_;
  41. std::shared_ptr<Option> option_;
  42. std::unique_ptr<RequestGroup> rg_;
  43. public:
  44. void tearDown() {}
  45. void testAddMessage();
  46. void testSendMessages();
  47. void testSendMessages_underUploadLimit();
  48. void testSendMessages_overUploadLimit();
  49. void testDoCancelSendingPieceAction();
  50. void testCheckRequestSlotAndDoNecessaryThing();
  51. void testCheckRequestSlotAndDoNecessaryThing_timeout();
  52. void testCheckRequestSlotAndDoNecessaryThing_completeBlock();
  53. void testCountOutstandingRequest();
  54. void testIsOutstandingRequest();
  55. void testGetOutstandingRequest();
  56. void testRemoveOutstandingRequest();
  57. struct EventCheck {
  58. EventCheck() : onQueuedCalled{false}, sendCalled{false},
  59. doCancelActionCalled{false}
  60. {}
  61. bool onQueuedCalled;
  62. bool sendCalled;
  63. bool doCancelActionCalled;
  64. };
  65. class MockBtMessage2 : public MockBtMessage {
  66. public:
  67. EventCheck* evcheck;
  68. std::string type;
  69. MockBtMessage2(EventCheck* evcheck = nullptr)
  70. : evcheck{evcheck}
  71. {}
  72. virtual void onQueued() CXX11_OVERRIDE
  73. {
  74. if(evcheck){
  75. evcheck->onQueuedCalled = true;
  76. }
  77. }
  78. virtual void send() CXX11_OVERRIDE
  79. {
  80. if(evcheck) {
  81. evcheck->sendCalled = true;
  82. }
  83. }
  84. virtual void onCancelSendingPieceEvent
  85. (const BtCancelSendingPieceEvent& event) CXX11_OVERRIDE
  86. {
  87. if(evcheck) {
  88. evcheck->doCancelActionCalled = true;
  89. }
  90. }
  91. };
  92. class MockBtMessageFactory2 : public MockBtMessageFactory {
  93. public:
  94. virtual std::unique_ptr<BtCancelMessage>
  95. createCancelMessage(size_t index, int32_t begin, int32_t length)
  96. CXX11_OVERRIDE
  97. {
  98. return make_unique<BtCancelMessage>(index, begin, length);
  99. }
  100. };
  101. void setUp()
  102. {
  103. option_ = std::make_shared<Option>();
  104. option_->put(PREF_DIR, ".");
  105. rg_ = make_unique<RequestGroup>(GroupId::create(), option_);
  106. dctx_ = std::make_shared<DownloadContext>();
  107. bittorrent::load(A2_TEST_DIR"/test.torrent", dctx_, option_);
  108. rg_->setDownloadContext(dctx_);
  109. peer = std::make_shared<Peer>("192.168.0.1", 6969);
  110. peer->allocateSessionResource
  111. (dctx_->getPieceLength(), dctx_->getTotalLength());
  112. messageFactory_ = make_unique<MockBtMessageFactory2>();
  113. rgman_ = make_unique<RequestGroupMan>
  114. (std::vector<std::shared_ptr<RequestGroup>>{}, 0, option_.get());
  115. btMessageDispatcher = make_unique<DefaultBtMessageDispatcher>();
  116. btMessageDispatcher->setPeer(peer);
  117. btMessageDispatcher->setDownloadContext(dctx_.get());
  118. btMessageDispatcher->setBtMessageFactory(messageFactory_.get());
  119. btMessageDispatcher->setCuid(1);
  120. btMessageDispatcher->setRequestGroupMan(rgman_.get());
  121. }
  122. };
  123. CPPUNIT_TEST_SUITE_REGISTRATION(DefaultBtMessageDispatcherTest);
  124. void DefaultBtMessageDispatcherTest::testAddMessage()
  125. {
  126. auto evcheck = EventCheck{};
  127. auto msg = make_unique<MockBtMessage2>(&evcheck);
  128. btMessageDispatcher->addMessageToQueue(std::move(msg));
  129. CPPUNIT_ASSERT_EQUAL(true, evcheck.onQueuedCalled);
  130. CPPUNIT_ASSERT_EQUAL((size_t)1,
  131. btMessageDispatcher->getMessageQueue().size());
  132. }
  133. void DefaultBtMessageDispatcherTest::testSendMessages() {
  134. auto evcheck1 = EventCheck{};
  135. auto msg1 = make_unique<MockBtMessage2>(&evcheck1);
  136. msg1->setUploading(false);
  137. auto evcheck2 = EventCheck{};
  138. auto msg2 = make_unique<MockBtMessage2>(&evcheck2);
  139. msg2->setUploading(false);
  140. btMessageDispatcher->addMessageToQueue(std::move(msg1));
  141. btMessageDispatcher->addMessageToQueue(std::move(msg2));
  142. btMessageDispatcher->sendMessagesInternal();
  143. CPPUNIT_ASSERT(evcheck1.sendCalled);
  144. CPPUNIT_ASSERT(evcheck2.sendCalled);
  145. }
  146. void DefaultBtMessageDispatcherTest::testSendMessages_underUploadLimit() {
  147. auto evcheck1 = EventCheck{};
  148. auto msg1 = make_unique<MockBtMessage2>(&evcheck1);
  149. msg1->setUploading(true);
  150. auto evcheck2 = EventCheck{};
  151. auto msg2 = make_unique<MockBtMessage2>(&evcheck2);
  152. msg2->setUploading(true);
  153. btMessageDispatcher->addMessageToQueue(std::move(msg1));
  154. btMessageDispatcher->addMessageToQueue(std::move(msg2));
  155. btMessageDispatcher->sendMessagesInternal();
  156. CPPUNIT_ASSERT(evcheck1.sendCalled);
  157. CPPUNIT_ASSERT(evcheck2.sendCalled);
  158. }
  159. void DefaultBtMessageDispatcherTest::testDoCancelSendingPieceAction()
  160. {
  161. auto evcheck1 = EventCheck{};
  162. auto msg1 = make_unique<MockBtMessage2>(&evcheck1);
  163. auto evcheck2 = EventCheck{};
  164. auto msg2 = make_unique<MockBtMessage2>(&evcheck2);
  165. btMessageDispatcher->addMessageToQueue(std::move(msg1));
  166. btMessageDispatcher->addMessageToQueue(std::move(msg2));
  167. btMessageDispatcher->doCancelSendingPieceAction(0, 0, 0);
  168. CPPUNIT_ASSERT(evcheck1.doCancelActionCalled);
  169. CPPUNIT_ASSERT(evcheck2.doCancelActionCalled);
  170. }
  171. namespace {
  172. int MY_PIECE_LENGTH = 16_k;
  173. } // namespace
  174. void DefaultBtMessageDispatcherTest::testCheckRequestSlotAndDoNecessaryThing()
  175. {
  176. auto piece = std::make_shared<Piece>(0, MY_PIECE_LENGTH);
  177. size_t index;
  178. CPPUNIT_ASSERT(piece->getMissingUnusedBlockIndex(index));
  179. CPPUNIT_ASSERT_EQUAL((size_t)0, index);
  180. btMessageDispatcher->setRequestTimeout(1_min);
  181. btMessageDispatcher->addOutstandingRequest
  182. (make_unique<RequestSlot>(0, 0, MY_PIECE_LENGTH, 0, piece));
  183. btMessageDispatcher->checkRequestSlotAndDoNecessaryThing();
  184. CPPUNIT_ASSERT_EQUAL((size_t)0,
  185. btMessageDispatcher->getMessageQueue().size());
  186. CPPUNIT_ASSERT_EQUAL((size_t)1,
  187. btMessageDispatcher->getRequestSlots().size());
  188. }
  189. void DefaultBtMessageDispatcherTest::
  190. testCheckRequestSlotAndDoNecessaryThing_timeout() {
  191. auto piece = std::make_shared<Piece>(0, MY_PIECE_LENGTH);
  192. size_t index;
  193. CPPUNIT_ASSERT(piece->getMissingUnusedBlockIndex(index));
  194. CPPUNIT_ASSERT_EQUAL((size_t)0, index);
  195. btMessageDispatcher->setRequestTimeout(1_min);
  196. auto slot = make_unique<RequestSlot>(0, 0, MY_PIECE_LENGTH, 0, piece);
  197. // make this slot timeout
  198. slot->setDispatchedTime(Timer::zero());
  199. btMessageDispatcher->addOutstandingRequest(std::move(slot));
  200. btMessageDispatcher->checkRequestSlotAndDoNecessaryThing();
  201. CPPUNIT_ASSERT_EQUAL((size_t)0,
  202. btMessageDispatcher->getMessageQueue().size());
  203. CPPUNIT_ASSERT_EQUAL((size_t)0,
  204. btMessageDispatcher->getRequestSlots().size());
  205. CPPUNIT_ASSERT_EQUAL(false, piece->isBlockUsed(0));
  206. CPPUNIT_ASSERT_EQUAL(true, peer->snubbing());
  207. }
  208. void DefaultBtMessageDispatcherTest::
  209. testCheckRequestSlotAndDoNecessaryThing_completeBlock() {
  210. auto piece = std::make_shared<Piece>(0, MY_PIECE_LENGTH);
  211. piece->completeBlock(0);
  212. btMessageDispatcher->setRequestTimeout(1_min);
  213. btMessageDispatcher->addOutstandingRequest
  214. (make_unique<RequestSlot>(0, 0, MY_PIECE_LENGTH, 0, piece));
  215. btMessageDispatcher->checkRequestSlotAndDoNecessaryThing();
  216. CPPUNIT_ASSERT_EQUAL((size_t)1,
  217. btMessageDispatcher->getMessageQueue().size());
  218. CPPUNIT_ASSERT_EQUAL((size_t)0,
  219. btMessageDispatcher->getRequestSlots().size());
  220. }
  221. void DefaultBtMessageDispatcherTest::testCountOutstandingRequest() {
  222. btMessageDispatcher->addOutstandingRequest
  223. (make_unique<RequestSlot>(0, 0, MY_PIECE_LENGTH, 0));
  224. CPPUNIT_ASSERT_EQUAL((size_t)1,
  225. btMessageDispatcher->countOutstandingRequest());
  226. }
  227. void DefaultBtMessageDispatcherTest::testIsOutstandingRequest() {
  228. btMessageDispatcher->addOutstandingRequest
  229. (make_unique<RequestSlot>(0, 0, MY_PIECE_LENGTH, 0));
  230. CPPUNIT_ASSERT(btMessageDispatcher->isOutstandingRequest(0, 0));
  231. CPPUNIT_ASSERT(!btMessageDispatcher->isOutstandingRequest(0, 1));
  232. CPPUNIT_ASSERT(!btMessageDispatcher->isOutstandingRequest(1, 0));
  233. CPPUNIT_ASSERT(!btMessageDispatcher->isOutstandingRequest(1, 1));
  234. }
  235. void DefaultBtMessageDispatcherTest::testGetOutstandingRequest() {
  236. btMessageDispatcher->addOutstandingRequest(
  237. make_unique<RequestSlot>(1, 1_k, 16_k, 10));
  238. CPPUNIT_ASSERT(btMessageDispatcher->getOutstandingRequest(1, 1_k, 16_k));
  239. CPPUNIT_ASSERT(!btMessageDispatcher->
  240. getOutstandingRequest(1, 1_k, 17_k));
  241. CPPUNIT_ASSERT(!btMessageDispatcher->
  242. getOutstandingRequest(1, 2_k, 16_k));
  243. CPPUNIT_ASSERT(!btMessageDispatcher->
  244. getOutstandingRequest(2, 1_k, 16_k));
  245. }
  246. void DefaultBtMessageDispatcherTest::testRemoveOutstandingRequest() {
  247. auto piece = std::make_shared<Piece>(1, 1_m);
  248. size_t blockIndex = 0;
  249. CPPUNIT_ASSERT(piece->getMissingUnusedBlockIndex(blockIndex));
  250. uint32_t begin = blockIndex*piece->getBlockLength();
  251. size_t length = piece->getBlockLength(blockIndex);
  252. RequestSlot slot;
  253. btMessageDispatcher->addOutstandingRequest
  254. (make_unique<RequestSlot>(piece->getIndex(), begin, length, blockIndex,
  255. piece));
  256. auto s2 = btMessageDispatcher->getOutstandingRequest(piece->getIndex(),
  257. begin, length);
  258. CPPUNIT_ASSERT(s2);
  259. CPPUNIT_ASSERT(piece->isBlockUsed(blockIndex));
  260. btMessageDispatcher->removeOutstandingRequest(s2);
  261. auto s3 = btMessageDispatcher->getOutstandingRequest(piece->getIndex(),
  262. begin, length);
  263. CPPUNIT_ASSERT(!s3);
  264. CPPUNIT_ASSERT(!piece->isBlockUsed(blockIndex));
  265. }
  266. } // namespace aria2