Development of an internal social media platform with personalised dashboards for students
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

test_qpid.py 71KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928
  1. from __future__ import absolute_import
  2. import select
  3. import ssl
  4. import socket
  5. import sys
  6. import time
  7. import uuid
  8. from collections import Callable
  9. from itertools import count
  10. from functools import wraps
  11. from mock import call
  12. from kombu.five import Empty, keys, range, monotonic
  13. from kombu.transport.qpid import (AuthenticationFailure, Channel, Connection,
  14. ConnectionError, Message, NotFound, QoS,
  15. Transport)
  16. from kombu.transport.virtual import Base64
  17. from kombu.tests.case import Case, Mock, case_no_pypy, case_no_python3
  18. from kombu.tests.case import patch
  19. from kombu.utils.compat import OrderedDict
  20. QPID_MODULE = 'kombu.transport.qpid'
  21. def disable_runtime_dependency_check(cls):
  22. """A decorator to disable runtime dependency checking"""
  23. setup = cls.setUp
  24. teardown = cls.tearDown
  25. dependency_is_none_patcher = patch(QPID_MODULE + '.dependency_is_none')
  26. @wraps(setup)
  27. def around_setup(self):
  28. mock_dependency_is_none = dependency_is_none_patcher.start()
  29. mock_dependency_is_none.return_value = False
  30. setup(self)
  31. @wraps(setup)
  32. def around_teardown(self):
  33. dependency_is_none_patcher.stop()
  34. teardown(self)
  35. cls.setUp = around_setup
  36. cls.tearDown = around_teardown
  37. return cls
  38. class ExtraAssertionsMixin(object):
  39. """A mixin class adding assertDictEqual and assertDictContainsSubset"""
  40. def assertDictEqual(self, a, b, msg=None):
  41. """
  42. Test that two dictionaries are equal.
  43. Implemented here because this method was not available until Python
  44. 2.6. This asserts that the unique set of keys are the same in a and b.
  45. Also asserts that the value of each key is the same in a and b using
  46. the is operator.
  47. """
  48. self.assertEqual(set(keys(a)), set(keys(b)))
  49. for key in keys(a):
  50. self.assertEqual(a[key], b[key])
  51. def assertDictContainsSubset(self, a, b, msg=None):
  52. """
  53. Assert that all the key/value pairs in a exist in b.
  54. """
  55. for key in keys(a):
  56. self.assertIn(key, b)
  57. self.assertEqual(a[key], b[key])
  58. class QpidException(Exception):
  59. """
  60. An object used to mock Exceptions provided by qpid.messaging.exceptions
  61. """
  62. def __init__(self, code=None, text=None):
  63. super(Exception, self).__init__(self)
  64. self.code = code
  65. self.text = text
  66. class BreakOutException(Exception):
  67. pass
  68. @case_no_python3
  69. @case_no_pypy
  70. class TestQoS__init__(Case):
  71. def setUp(self):
  72. self.mock_session = Mock()
  73. self.qos = QoS(self.mock_session)
  74. def test__init__prefetch_default_set_correct_without_prefetch_value(self):
  75. self.assertEqual(self.qos.prefetch_count, 1)
  76. def test__init__prefetch_is_hard_set_to_one(self):
  77. qos_limit_two = QoS(self.mock_session)
  78. self.assertEqual(qos_limit_two.prefetch_count, 1)
  79. def test__init___not_yet_acked_is_initialized(self):
  80. self.assertIsInstance(self.qos._not_yet_acked, OrderedDict)
  81. @case_no_python3
  82. @case_no_pypy
  83. class TestQoSCanConsume(Case):
  84. def setUp(self):
  85. session = Mock()
  86. self.qos = QoS(session)
  87. def test_True_when_prefetch_limit_is_zero(self):
  88. self.qos.prefetch_count = 0
  89. self.qos._not_yet_acked = []
  90. self.assertTrue(self.qos.can_consume())
  91. def test_True_when_len_of__not_yet_acked_is_lt_prefetch_count(self):
  92. self.qos.prefetch_count = 3
  93. self.qos._not_yet_acked = ['a', 'b']
  94. self.assertTrue(self.qos.can_consume())
  95. def test_False_when_len_of__not_yet_acked_is_eq_prefetch_count(self):
  96. self.qos.prefetch_count = 3
  97. self.qos._not_yet_acked = ['a', 'b', 'c']
  98. self.assertFalse(self.qos.can_consume())
  99. @case_no_python3
  100. @case_no_pypy
  101. class TestQoSCanConsumeMaxEstimate(Case):
  102. def setUp(self):
  103. self.mock_session = Mock()
  104. self.qos = QoS(self.mock_session)
  105. def test_return_one_when_prefetch_count_eq_zero(self):
  106. self.qos.prefetch_count = 0
  107. self.assertEqual(self.qos.can_consume_max_estimate(), 1)
  108. def test_return_prefetch_count_sub_len__not_yet_acked(self):
  109. self.qos._not_yet_acked = ['a', 'b']
  110. self.qos.prefetch_count = 4
  111. self.assertEqual(self.qos.can_consume_max_estimate(), 2)
  112. @case_no_python3
  113. @case_no_pypy
  114. class TestQoSAck(Case):
  115. def setUp(self):
  116. self.mock_session = Mock()
  117. self.qos = QoS(self.mock_session)
  118. def test_ack_pops__not_yet_acked(self):
  119. message = Mock()
  120. self.qos.append(message, 1)
  121. self.assertIn(1, self.qos._not_yet_acked)
  122. self.qos.ack(1)
  123. self.assertNotIn(1, self.qos._not_yet_acked)
  124. def test_ack_calls_session_acknowledge_with_message(self):
  125. message = Mock()
  126. self.qos.append(message, 1)
  127. self.qos.ack(1)
  128. self.qos.session.acknowledge.assert_called_with(message=message)
  129. @case_no_python3
  130. @case_no_pypy
  131. class TestQoSReject(Case):
  132. def setUp(self):
  133. self.mock_session = Mock()
  134. self.mock_message = Mock()
  135. self.qos = QoS(self.mock_session)
  136. self.patch_qpid = patch(QPID_MODULE + '.qpid')
  137. self.mock_qpid = self.patch_qpid.start()
  138. self.mock_Disposition = self.mock_qpid.messaging.Disposition
  139. self.mock_RELEASED = self.mock_qpid.messaging.RELEASED
  140. self.mock_REJECTED = self.mock_qpid.messaging.REJECTED
  141. def tearDown(self):
  142. self.patch_qpid.stop()
  143. def test_reject_pops__not_yet_acked(self):
  144. self.qos.append(self.mock_message, 1)
  145. self.assertIn(1, self.qos._not_yet_acked)
  146. self.qos.reject(1)
  147. self.assertNotIn(1, self.qos._not_yet_acked)
  148. def test_reject_requeue_true(self):
  149. self.qos.append(self.mock_message, 1)
  150. self.qos.reject(1, requeue=True)
  151. self.mock_Disposition.assert_called_with(self.mock_RELEASED)
  152. self.qos.session.acknowledge.assert_called_with(
  153. message=self.mock_message,
  154. disposition=self.mock_Disposition.return_value,
  155. )
  156. def test_reject_requeue_false(self):
  157. message = Mock()
  158. self.qos.append(message, 1)
  159. self.qos.reject(1, requeue=False)
  160. self.mock_Disposition.assert_called_with(self.mock_REJECTED)
  161. self.qos.session.acknowledge.assert_called_with(
  162. message=message, disposition=self.mock_Disposition.return_value,
  163. )
  164. @case_no_python3
  165. @case_no_pypy
  166. class TestQoS(Case):
  167. def mock_message_factory(self):
  168. """Create and return a mock message tag and delivery_tag."""
  169. m_delivery_tag = self.delivery_tag_generator.next()
  170. m = 'message %s' % (m_delivery_tag, )
  171. return m, m_delivery_tag
  172. def add_n_messages_to_qos(self, n, qos):
  173. """Add N mock messages into the passed in qos object"""
  174. for i in range(n):
  175. self.add_message_to_qos(qos)
  176. def add_message_to_qos(self, qos):
  177. """Add a single mock message into the passed in qos object.
  178. Uses the mock_message_factory() to create the message and
  179. delivery_tag.
  180. """
  181. m, m_delivery_tag = self.mock_message_factory()
  182. qos.append(m, m_delivery_tag)
  183. def setUp(self):
  184. self.mock_session = Mock()
  185. self.qos_no_limit = QoS(self.mock_session)
  186. self.qos_limit_2 = QoS(self.mock_session, prefetch_count=2)
  187. self.delivery_tag_generator = count(1)
  188. def test_append(self):
  189. """Append two messages and check inside the QoS object that they
  190. were put into the internal data structures correctly
  191. """
  192. qos = self.qos_no_limit
  193. m1, m1_tag = self.mock_message_factory()
  194. m2, m2_tag = self.mock_message_factory()
  195. qos.append(m1, m1_tag)
  196. length_not_yet_acked = len(qos._not_yet_acked)
  197. self.assertEqual(length_not_yet_acked, 1)
  198. checked_message1 = qos._not_yet_acked[m1_tag]
  199. self.assertIs(m1, checked_message1)
  200. qos.append(m2, m2_tag)
  201. length_not_yet_acked = len(qos._not_yet_acked)
  202. self.assertEqual(length_not_yet_acked, 2)
  203. checked_message2 = qos._not_yet_acked[m2_tag]
  204. self.assertIs(m2, checked_message2)
  205. def test_get(self):
  206. """Append two messages, and use get to receive them"""
  207. qos = self.qos_no_limit
  208. m1, m1_tag = self.mock_message_factory()
  209. m2, m2_tag = self.mock_message_factory()
  210. qos.append(m1, m1_tag)
  211. qos.append(m2, m2_tag)
  212. message1 = qos.get(m1_tag)
  213. message2 = qos.get(m2_tag)
  214. self.assertIs(m1, message1)
  215. self.assertIs(m2, message2)
  216. @case_no_python3
  217. @case_no_pypy
  218. class ConnectionTestBase(Case):
  219. @patch(QPID_MODULE + '.qpid')
  220. def setUp(self, mock_qpid):
  221. self.connection_options = {
  222. 'host': 'localhost',
  223. 'port': 5672,
  224. 'transport': 'tcp',
  225. 'timeout': 10,
  226. 'sasl_mechanisms': 'ANONYMOUS',
  227. }
  228. self.mock_qpid_connection = mock_qpid.messaging.Connection
  229. self.conn = Connection(**self.connection_options)
  230. @case_no_python3
  231. @case_no_pypy
  232. class TestConnectionInit(ExtraAssertionsMixin, ConnectionTestBase):
  233. def test_stores_connection_options(self):
  234. # ensure that only one mech was passed into connection. The other
  235. # options should all be passed through as-is
  236. modified_conn_opts = self.connection_options
  237. self.assertDictEqual(
  238. modified_conn_opts, self.conn.connection_options,
  239. )
  240. def test_class_variables(self):
  241. self.assertIsInstance(self.conn.channels, list)
  242. self.assertIsInstance(self.conn._callbacks, dict)
  243. def test_establishes_connection(self):
  244. modified_conn_opts = self.connection_options
  245. self.mock_qpid_connection.establish.assert_called_with(
  246. **modified_conn_opts
  247. )
  248. def test_saves_established_connection(self):
  249. created_conn = self.mock_qpid_connection.establish.return_value
  250. self.assertIs(self.conn._qpid_conn, created_conn)
  251. @patch(QPID_MODULE + '.ConnectionError', new=(QpidException, ))
  252. @patch(QPID_MODULE + '.sys.exc_info')
  253. @patch(QPID_MODULE + '.qpid')
  254. def test_mutates_ConnError_by_message(self, mock_qpid, mock_exc_info):
  255. text = 'connection-forced: Authentication failed(320)'
  256. my_conn_error = QpidException(text=text)
  257. mock_qpid.messaging.Connection.establish.side_effect = my_conn_error
  258. mock_exc_info.return_value = 'a', 'b', None
  259. try:
  260. self.conn = Connection(**self.connection_options)
  261. except AuthenticationFailure as error:
  262. exc_info = sys.exc_info()
  263. self.assertNotIsInstance(error, QpidException)
  264. self.assertIs(exc_info[1], 'b')
  265. self.assertIsNone(exc_info[2])
  266. else:
  267. self.fail('ConnectionError type was not mutated correctly')
  268. @patch(QPID_MODULE + '.ConnectionError', new=(QpidException, ))
  269. @patch(QPID_MODULE + '.sys.exc_info')
  270. @patch(QPID_MODULE + '.qpid')
  271. def test_mutates_ConnError_by_code(self, mock_qpid, mock_exc_info):
  272. my_conn_error = QpidException(code=320, text='someothertext')
  273. mock_qpid.messaging.Connection.establish.side_effect = my_conn_error
  274. mock_exc_info.return_value = 'a', 'b', None
  275. try:
  276. self.conn = Connection(**self.connection_options)
  277. except AuthenticationFailure as error:
  278. exc_info = sys.exc_info()
  279. self.assertNotIsInstance(error, QpidException)
  280. self.assertIs(exc_info[1], 'b')
  281. self.assertIsNone(exc_info[2])
  282. else:
  283. self.fail('ConnectionError type was not mutated correctly')
  284. @patch(QPID_MODULE + '.ConnectionError', new=(QpidException, ))
  285. @patch(QPID_MODULE + '.sys.exc_info')
  286. @patch(QPID_MODULE + '.qpid')
  287. def test_connection__init__mutates_ConnError_by_message2(self, mock_qpid,
  288. mock_exc_info):
  289. """
  290. Test for PLAIN connection via python-saslwrapper, sans cyrus-sasl-plain
  291. This test is specific for what is returned when we attempt to connect
  292. with PLAIN mech and python-saslwrapper is installed, but
  293. cyrus-sasl-plain is not installed.
  294. """
  295. my_conn_error = QpidException()
  296. my_conn_error.text = 'Error in sasl_client_start (-4) SASL(-4): no '\
  297. 'mechanism available'
  298. mock_qpid.messaging.Connection.establish.side_effect = my_conn_error
  299. mock_exc_info.return_value = ('a', 'b', None)
  300. try:
  301. self.conn = Connection(**self.connection_options)
  302. except AuthenticationFailure as error:
  303. exc_info = sys.exc_info()
  304. self.assertTrue(not isinstance(error, QpidException))
  305. self.assertTrue(exc_info[1] is 'b')
  306. self.assertTrue(exc_info[2] is None)
  307. else:
  308. self.fail('ConnectionError type was not mutated correctly')
  309. @patch(QPID_MODULE + '.ConnectionError', new=(QpidException, ))
  310. @patch(QPID_MODULE + '.sys.exc_info')
  311. @patch(QPID_MODULE + '.qpid')
  312. def test_unknown_connection_error(self, mock_qpid, mock_exc_info):
  313. # If we get a connection error that we don't understand,
  314. # bubble it up as-is
  315. my_conn_error = QpidException(code=999, text='someothertext')
  316. mock_qpid.messaging.Connection.establish.side_effect = my_conn_error
  317. mock_exc_info.return_value = 'a', 'b', None
  318. try:
  319. self.conn = Connection(**self.connection_options)
  320. except Exception as error:
  321. self.assertTrue(error.code == 999)
  322. else:
  323. self.fail('Connection should have thrown an exception')
  324. @patch.object(Transport, 'channel_errors', new=(QpidException, ))
  325. @patch(QPID_MODULE + '.qpid')
  326. @patch(QPID_MODULE + '.ConnectionError', new=IOError)
  327. def test_non_qpid_error_raises(self, mock_qpid):
  328. mock_Qpid_Connection = mock_qpid.messaging.Connection
  329. my_conn_error = SyntaxError()
  330. my_conn_error.text = 'some non auth related error message'
  331. mock_Qpid_Connection.establish.side_effect = my_conn_error
  332. with self.assertRaises(SyntaxError):
  333. Connection(**self.connection_options)
  334. @patch(QPID_MODULE + '.qpid')
  335. @patch(QPID_MODULE + '.ConnectionError', new=IOError)
  336. def test_non_auth_conn_error_raises(self, mock_qpid):
  337. mock_Qpid_Connection = mock_qpid.messaging.Connection
  338. my_conn_error = IOError()
  339. my_conn_error.text = 'some non auth related error message'
  340. mock_Qpid_Connection.establish.side_effect = my_conn_error
  341. with self.assertRaises(IOError):
  342. Connection(**self.connection_options)
  343. @case_no_python3
  344. @case_no_pypy
  345. class TestConnectionClassAttributes(ConnectionTestBase):
  346. def test_connection_verify_class_attributes(self):
  347. self.assertEqual(Channel, Connection.Channel)
  348. @case_no_python3
  349. @case_no_pypy
  350. class TestConnectionGetQpidConnection(ConnectionTestBase):
  351. def test_connection_get_qpid_connection(self):
  352. self.conn._qpid_conn = Mock()
  353. returned_connection = self.conn.get_qpid_connection()
  354. self.assertIs(self.conn._qpid_conn, returned_connection)
  355. @case_no_python3
  356. @case_no_pypy
  357. class TestConnectionClose(ConnectionTestBase):
  358. def test_connection_close(self):
  359. self.conn._qpid_conn = Mock()
  360. self.conn.close()
  361. self.conn._qpid_conn.close.assert_called_once_with()
  362. @case_no_python3
  363. @case_no_pypy
  364. class TestConnectionCloseChannel(ConnectionTestBase):
  365. def setUp(self):
  366. super(TestConnectionCloseChannel, self).setUp()
  367. self.conn.channels = Mock()
  368. def test_connection_close_channel_removes_channel_from_channel_list(self):
  369. mock_channel = Mock()
  370. self.conn.close_channel(mock_channel)
  371. self.conn.channels.remove.assert_called_once_with(mock_channel)
  372. def test_connection_close_channel_handles_ValueError_being_raised(self):
  373. self.conn.channels.remove = Mock(side_effect=ValueError())
  374. self.conn.close_channel(Mock())
  375. def test_connection_close_channel_set_channel_connection_to_None(self):
  376. mock_channel = Mock()
  377. mock_channel.connection = False
  378. self.conn.channels.remove = Mock(side_effect=ValueError())
  379. self.conn.close_channel(mock_channel)
  380. self.assertIsNone(mock_channel.connection)
  381. @case_no_python3
  382. @case_no_pypy
  383. class ChannelTestBase(Case):
  384. def setUp(self):
  385. self.patch_qpidtoollibs = patch(QPID_MODULE + '.qpidtoollibs')
  386. self.mock_qpidtoollibs = self.patch_qpidtoollibs.start()
  387. self.mock_broker_agent = self.mock_qpidtoollibs.BrokerAgent
  388. self.conn = Mock()
  389. self.transport = Mock()
  390. self.channel = Channel(self.conn, self.transport)
  391. def tearDown(self):
  392. self.patch_qpidtoollibs.stop()
  393. @case_no_python3
  394. @case_no_pypy
  395. class TestChannelPurge(ChannelTestBase):
  396. def setUp(self):
  397. super(TestChannelPurge, self).setUp()
  398. self.mock_queue = Mock()
  399. def test_gets_queue(self):
  400. self.channel._purge(self.mock_queue)
  401. getQueue = self.mock_broker_agent.return_value.getQueue
  402. getQueue.assert_called_once_with(self.mock_queue)
  403. def test_does_not_call_purge_if_message_count_is_zero(self):
  404. values = {'msgDepth': 0}
  405. queue_obj = self.mock_broker_agent.return_value.getQueue.return_value
  406. queue_obj.values = values
  407. self.channel._purge(self.mock_queue)
  408. self.assertFalse(queue_obj.purge.called)
  409. def test_purges_all_messages_from_queue(self):
  410. values = {'msgDepth': 5}
  411. queue_obj = self.mock_broker_agent.return_value.getQueue.return_value
  412. queue_obj.values = values
  413. self.channel._purge(self.mock_queue)
  414. queue_obj.purge.assert_called_with(5)
  415. def test_returns_message_count(self):
  416. values = {'msgDepth': 5}
  417. queue_obj = self.mock_broker_agent.return_value.getQueue.return_value
  418. queue_obj.values = values
  419. result = self.channel._purge(self.mock_queue)
  420. self.assertEqual(result, 5)
  421. @patch(QPID_MODULE + '.NotFound', new=QpidException)
  422. def test_raises_channel_error_if_queue_does_not_exist(self):
  423. self.mock_broker_agent.return_value.getQueue.return_value = None
  424. self.assertRaises(QpidException, self.channel._purge, self.mock_queue)
  425. @case_no_python3
  426. @case_no_pypy
  427. class TestChannelPut(ChannelTestBase):
  428. @patch(QPID_MODULE + '.qpid')
  429. def test_channel__put_onto_queue(self, mock_qpid):
  430. routing_key = 'routingkey'
  431. mock_message = Mock()
  432. mock_Message_cls = mock_qpid.messaging.Message
  433. self.channel._put(routing_key, mock_message)
  434. address_str = '{0}; {{assert: always, node: {{type: queue}}}}'.format(
  435. routing_key,
  436. )
  437. self.transport.session.sender.assert_called_with(address_str)
  438. mock_Message_cls.assert_called_with(
  439. content=mock_message, subject=None,
  440. )
  441. mock_sender = self.transport.session.sender.return_value
  442. mock_sender.send.assert_called_with(
  443. mock_Message_cls.return_value, sync=True,
  444. )
  445. mock_sender.close.assert_called_with()
  446. @patch(QPID_MODULE + '.qpid')
  447. def test_channel__put_onto_exchange(self, mock_qpid):
  448. mock_routing_key = 'routingkey'
  449. mock_exchange_name = 'myexchange'
  450. mock_message = Mock()
  451. mock_Message_cls = mock_qpid.messaging.Message
  452. self.channel._put(mock_routing_key, mock_message, mock_exchange_name)
  453. addrstr = '{0}/{1}; {{assert: always, node: {{type: topic}}}}'.format(
  454. mock_exchange_name, mock_routing_key,
  455. )
  456. self.transport.session.sender.assert_called_with(addrstr)
  457. mock_Message_cls.assert_called_with(
  458. content=mock_message, subject=mock_routing_key,
  459. )
  460. mock_sender = self.transport.session.sender.return_value
  461. mock_sender.send.assert_called_with(
  462. mock_Message_cls.return_value, sync=True,
  463. )
  464. mock_sender.close.assert_called_with()
  465. @case_no_python3
  466. @case_no_pypy
  467. class TestChannelGet(ChannelTestBase):
  468. def test_channel__get(self):
  469. mock_queue = Mock()
  470. result = self.channel._get(mock_queue)
  471. self.transport.session.receiver.assert_called_once_with(mock_queue)
  472. mock_rx = self.transport.session.receiver.return_value
  473. mock_rx.fetch.assert_called_once_with(timeout=0)
  474. mock_rx.close.assert_called_once_with()
  475. self.assertIs(mock_rx.fetch.return_value, result)
  476. @case_no_python3
  477. @case_no_pypy
  478. class TestChannelClose(ChannelTestBase):
  479. def setUp(self):
  480. super(TestChannelClose, self).setUp()
  481. self.patch_basic_cancel = patch.object(self.channel, 'basic_cancel')
  482. self.mock_basic_cancel = self.patch_basic_cancel.start()
  483. self.mock_receiver1 = Mock()
  484. self.mock_receiver2 = Mock()
  485. self.channel._receivers = {
  486. 1: self.mock_receiver1, 2: self.mock_receiver2,
  487. }
  488. self.channel.closed = False
  489. def tearDown(self):
  490. self.patch_basic_cancel.stop()
  491. super(TestChannelClose, self).tearDown()
  492. def test_channel_close_sets_close_attribute(self):
  493. self.channel.close()
  494. self.assertTrue(self.channel.closed)
  495. def test_channel_close_calls_basic_cancel_on_all_receivers(self):
  496. self.channel.close()
  497. self.mock_basic_cancel.assert_has_calls([call(1), call(2)])
  498. def test_channel_close_calls_close_channel_on_connection(self):
  499. self.channel.close()
  500. self.conn.close_channel.assert_called_once_with(self.channel)
  501. def test_channel_close_calls_close_on_broker_agent(self):
  502. self.channel.close()
  503. self.channel._broker.close.assert_called_once_with()
  504. def test_channel_close_does_nothing_if_already_closed(self):
  505. self.channel.closed = True
  506. self.channel.close()
  507. self.assertFalse(self.mock_basic_cancel.called)
  508. def test_channel_close_does_not_call_close_channel_if_conn_is_None(self):
  509. self.channel.connection = None
  510. self.channel.close()
  511. self.assertFalse(self.conn.close_channel.called)
  512. @case_no_python3
  513. @case_no_pypy
  514. class TestChannelBasicQoS(ChannelTestBase):
  515. def test_channel_basic_qos_always_returns_one(self):
  516. self.channel.basic_qos(2)
  517. self.assertEqual(self.channel.qos.prefetch_count, 1)
  518. @case_no_python3
  519. @case_no_pypy
  520. class TestChannelBasicGet(ChannelTestBase):
  521. def setUp(self):
  522. super(TestChannelBasicGet, self).setUp()
  523. self.channel.Message = Mock()
  524. self.channel._get = Mock()
  525. def test_channel_basic_get_calls__get_with_queue(self):
  526. mock_queue = Mock()
  527. self.channel.basic_get(mock_queue)
  528. self.channel._get.assert_called_once_with(mock_queue)
  529. def test_channel_basic_get_creates_Message_correctly(self):
  530. mock_queue = Mock()
  531. self.channel.basic_get(mock_queue)
  532. mock_raw_message = self.channel._get.return_value.content
  533. self.channel.Message.assert_called_once_with(
  534. self.channel, mock_raw_message,
  535. )
  536. def test_channel_basic_get_acknowledges_message_by_default(self):
  537. mock_queue = Mock()
  538. self.channel.basic_get(mock_queue)
  539. mock_qpid_message = self.channel._get.return_value
  540. acknowledge = self.transport.session.acknowledge
  541. acknowledge.assert_called_once_with(message=mock_qpid_message)
  542. def test_channel_basic_get_acknowledges_message_with_no_ack_False(self):
  543. mock_queue = Mock()
  544. self.channel.basic_get(mock_queue, no_ack=False)
  545. mock_qpid_message = self.channel._get.return_value
  546. acknowledge = self.transport.session.acknowledge
  547. acknowledge.assert_called_once_with(message=mock_qpid_message)
  548. def test_channel_basic_get_acknowledges_message_with_no_ack_True(self):
  549. mock_queue = Mock()
  550. self.channel.basic_get(mock_queue, no_ack=True)
  551. mock_qpid_message = self.channel._get.return_value
  552. acknowledge = self.transport.session.acknowledge
  553. acknowledge.assert_called_once_with(message=mock_qpid_message)
  554. def test_channel_basic_get_returns_correct_message(self):
  555. mock_queue = Mock()
  556. basic_get_result = self.channel.basic_get(mock_queue)
  557. expected_message = self.channel.Message.return_value
  558. self.assertIs(expected_message, basic_get_result)
  559. def test_basic_get_returns_None_when_channel__get_raises_Empty(self):
  560. mock_queue = Mock()
  561. self.channel._get = Mock(side_effect=Empty)
  562. basic_get_result = self.channel.basic_get(mock_queue)
  563. self.assertEqual(self.channel.Message.call_count, 0)
  564. self.assertIsNone(basic_get_result)
  565. @case_no_python3
  566. @case_no_pypy
  567. class TestChannelBasicCancel(ChannelTestBase):
  568. def setUp(self):
  569. super(TestChannelBasicCancel, self).setUp()
  570. self.channel._receivers = {1: Mock()}
  571. def test_channel_basic_cancel_no_error_if_consumer_tag_not_found(self):
  572. self.channel.basic_cancel(2)
  573. def test_channel_basic_cancel_pops_receiver(self):
  574. self.channel.basic_cancel(1)
  575. self.assertNotIn(1, self.channel._receivers)
  576. def test_channel_basic_cancel_closes_receiver(self):
  577. mock_receiver = self.channel._receivers[1]
  578. self.channel.basic_cancel(1)
  579. mock_receiver.close.assert_called_once_with()
  580. def test_channel_basic_cancel_pops__tag_to_queue(self):
  581. self.channel._tag_to_queue = Mock()
  582. self.channel.basic_cancel(1)
  583. self.channel._tag_to_queue.pop.assert_called_once_with(1, None)
  584. def test_channel_basic_cancel_pops_connection__callbacks(self):
  585. self.channel._tag_to_queue = Mock()
  586. self.channel.basic_cancel(1)
  587. mock_queue = self.channel._tag_to_queue.pop.return_value
  588. self.conn._callbacks.pop.assert_called_once_with(mock_queue, None)
  589. @case_no_python3
  590. @case_no_pypy
  591. class TestChannelInit(ChannelTestBase, ExtraAssertionsMixin):
  592. def test_channel___init__sets_variables_as_expected(self):
  593. self.assertIs(self.conn, self.channel.connection)
  594. self.assertIs(self.transport, self.channel.transport)
  595. self.assertFalse(self.channel.closed)
  596. self.conn.get_qpid_connection.assert_called_once_with()
  597. expected_broker_agent = self.mock_broker_agent.return_value
  598. self.assertIs(self.channel._broker, expected_broker_agent)
  599. self.assertDictEqual(self.channel._tag_to_queue, {})
  600. self.assertDictEqual(self.channel._receivers, {})
  601. self.assertIs(self.channel._qos, None)
  602. @case_no_python3
  603. @case_no_pypy
  604. class TestChannelBasicConsume(ChannelTestBase, ExtraAssertionsMixin):
  605. def setUp(self):
  606. super(TestChannelBasicConsume, self).setUp()
  607. self.conn._callbacks = {}
  608. def test_channel_basic_consume_adds_queue_to__tag_to_queue(self):
  609. mock_tag = Mock()
  610. mock_queue = Mock()
  611. self.channel.basic_consume(mock_queue, Mock(), Mock(), mock_tag)
  612. expected_dict = {mock_tag: mock_queue}
  613. self.assertDictEqual(expected_dict, self.channel._tag_to_queue)
  614. def test_channel_basic_consume_adds_entry_to_connection__callbacks(self):
  615. mock_queue = Mock()
  616. self.channel.basic_consume(mock_queue, Mock(), Mock(), Mock())
  617. self.assertIn(mock_queue, self.conn._callbacks)
  618. self.assertIsInstance(self.conn._callbacks[mock_queue], Callable)
  619. def test_channel_basic_consume_creates_new_receiver(self):
  620. mock_queue = Mock()
  621. self.channel.basic_consume(mock_queue, Mock(), Mock(), Mock())
  622. self.transport.session.receiver.assert_called_once_with(mock_queue)
  623. def test_channel_basic_consume_saves_new_receiver(self):
  624. mock_tag = Mock()
  625. self.channel.basic_consume(Mock(), Mock(), Mock(), mock_tag)
  626. new_mock_receiver = self.transport.session.receiver.return_value
  627. expected_dict = {mock_tag: new_mock_receiver}
  628. self.assertDictEqual(expected_dict, self.channel._receivers)
  629. def test_channel_basic_consume_sets_capacity_on_new_receiver(self):
  630. mock_prefetch_count = Mock()
  631. self.channel.qos.prefetch_count = mock_prefetch_count
  632. self.channel.basic_consume(Mock(), Mock(), Mock(), Mock())
  633. new_receiver = self.transport.session.receiver.return_value
  634. self.assertTrue(new_receiver.capacity is mock_prefetch_count)
  635. def get_callback(self, no_ack=Mock(), original_cb=Mock()):
  636. self.channel.Message = Mock()
  637. mock_queue = Mock()
  638. self.channel.basic_consume(mock_queue, no_ack, original_cb, Mock())
  639. return self.conn._callbacks[mock_queue]
  640. def test_channel_basic_consume_callback_creates_Message_correctly(self):
  641. callback = self.get_callback()
  642. mock_qpid_message = Mock()
  643. callback(mock_qpid_message)
  644. mock_content = mock_qpid_message.content
  645. self.channel.Message.assert_called_once_with(
  646. self.channel, mock_content,
  647. )
  648. def test_channel_basic_consume_callback_adds_message_to_QoS(self):
  649. self.channel._qos = Mock()
  650. callback = self.get_callback()
  651. mock_qpid_message = Mock()
  652. callback(mock_qpid_message)
  653. mock_delivery_tag = self.channel.Message.return_value.delivery_tag
  654. self.channel._qos.append.assert_called_once_with(
  655. mock_qpid_message, mock_delivery_tag,
  656. )
  657. def test_channel_basic_consume_callback_gratuitously_acks(self):
  658. self.channel.basic_ack = Mock()
  659. callback = self.get_callback()
  660. mock_qpid_message = Mock()
  661. callback(mock_qpid_message)
  662. mock_delivery_tag = self.channel.Message.return_value.delivery_tag
  663. self.channel.basic_ack.assert_called_once_with(mock_delivery_tag)
  664. def test_channel_basic_consume_callback_does_not_ack_when_needed(self):
  665. self.channel.basic_ack = Mock()
  666. callback = self.get_callback(no_ack=False)
  667. mock_qpid_message = Mock()
  668. callback(mock_qpid_message)
  669. self.assertFalse(self.channel.basic_ack.called)
  670. def test_channel_basic_consume_callback_calls_real_callback(self):
  671. self.channel.basic_ack = Mock()
  672. mock_original_callback = Mock()
  673. callback = self.get_callback(original_cb=mock_original_callback)
  674. mock_qpid_message = Mock()
  675. callback(mock_qpid_message)
  676. expected_message = self.channel.Message.return_value
  677. mock_original_callback.assert_called_once_with(expected_message)
  678. @case_no_python3
  679. @case_no_pypy
  680. class TestChannelQueueDelete(ChannelTestBase):
  681. def setUp(self):
  682. super(TestChannelQueueDelete, self).setUp()
  683. self.patch__has_queue = patch.object(self.channel, '_has_queue')
  684. self.mock__has_queue = self.patch__has_queue.start()
  685. self.patch__size = patch.object(self.channel, '_size')
  686. self.mock__size = self.patch__size.start()
  687. self.patch__delete = patch.object(self.channel, '_delete')
  688. self.mock__delete = self.patch__delete.start()
  689. self.mock_queue = Mock()
  690. def tearDown(self):
  691. self.patch__has_queue.stop()
  692. self.patch__size.stop()
  693. self.patch__delete.stop()
  694. super(TestChannelQueueDelete, self).tearDown()
  695. def test_checks_if_queue_exists(self):
  696. self.channel.queue_delete(self.mock_queue)
  697. self.mock__has_queue.assert_called_once_with(self.mock_queue)
  698. def test_does_nothing_if_queue_does_not_exist(self):
  699. self.mock__has_queue.return_value = False
  700. self.channel.queue_delete(self.mock_queue)
  701. self.assertFalse(self.mock__delete.called)
  702. def test_not_empty_and_if_empty_True_no_delete(self):
  703. self.mock__size.return_value = 1
  704. self.channel.queue_delete(self.mock_queue, if_empty=True)
  705. mock_broker = self.mock_broker_agent.return_value
  706. self.assertFalse(mock_broker.getQueue.called)
  707. def test_calls_get_queue(self):
  708. self.channel.queue_delete(self.mock_queue)
  709. getQueue = self.mock_broker_agent.return_value.getQueue
  710. getQueue.assert_called_once_with(self.mock_queue)
  711. def test_gets_queue_attribute(self):
  712. self.channel.queue_delete(self.mock_queue)
  713. queue_obj = self.mock_broker_agent.return_value.getQueue.return_value
  714. queue_obj.getAttributes.assert_called_once_with()
  715. def test_queue_in_use_and_if_unused_no_delete(self):
  716. queue_obj = self.mock_broker_agent.return_value.getQueue.return_value
  717. queue_obj.getAttributes.return_value = {'consumerCount': 1}
  718. self.channel.queue_delete(self.mock_queue, if_unused=True)
  719. self.assertFalse(self.mock__delete.called)
  720. def test_calls__delete_with_queue(self):
  721. self.channel.queue_delete(self.mock_queue)
  722. self.mock__delete.assert_called_once_with(self.mock_queue)
  723. @case_no_python3
  724. @case_no_pypy
  725. class TestChannel(ExtraAssertionsMixin, Case):
  726. @patch(QPID_MODULE + '.qpidtoollibs')
  727. def setUp(self, mock_qpidtoollibs):
  728. self.mock_connection = Mock()
  729. self.mock_qpid_connection = Mock()
  730. self.mock_qpid_session = Mock()
  731. self.mock_qpid_connection.session = Mock(
  732. return_value=self.mock_qpid_session,
  733. )
  734. self.mock_connection.get_qpid_connection = Mock(
  735. return_value=self.mock_qpid_connection,
  736. )
  737. self.mock_transport = Mock()
  738. self.mock_broker = Mock()
  739. self.mock_Message = Mock()
  740. self.mock_BrokerAgent = mock_qpidtoollibs.BrokerAgent
  741. self.mock_BrokerAgent.return_value = self.mock_broker
  742. self.my_channel = Channel(
  743. self.mock_connection, self.mock_transport,
  744. )
  745. self.my_channel.Message = self.mock_Message
  746. def test_verify_QoS_class_attribute(self):
  747. """Verify that the class attribute QoS refers to the QoS object"""
  748. self.assertIs(QoS, Channel.QoS)
  749. def test_verify_Message_class_attribute(self):
  750. """Verify that the class attribute Message refers to the Message
  751. object."""
  752. self.assertIs(Message, Channel.Message)
  753. def test_body_encoding_class_attribute(self):
  754. """Verify that the class attribute body_encoding is set to base64"""
  755. self.assertEqual('base64', Channel.body_encoding)
  756. def test_codecs_class_attribute(self):
  757. """Verify that the codecs class attribute has a correct key and
  758. value."""
  759. self.assertIsInstance(Channel.codecs, dict)
  760. self.assertIn('base64', Channel.codecs)
  761. self.assertIsInstance(Channel.codecs['base64'], Base64)
  762. def test_size(self):
  763. """Test getting the number of messages in a queue specified by
  764. name and returning them."""
  765. message_count = 5
  766. mock_queue = Mock()
  767. mock_queue_to_check = Mock()
  768. mock_queue_to_check.values = {'msgDepth': message_count}
  769. self.mock_broker.getQueue.return_value = mock_queue_to_check
  770. result = self.my_channel._size(mock_queue)
  771. self.mock_broker.getQueue.assert_called_with(mock_queue)
  772. self.assertEqual(message_count, result)
  773. def test_delete(self):
  774. """Test deleting a queue calls purge and delQueue with queue name."""
  775. mock_queue = Mock()
  776. self.my_channel._purge = Mock()
  777. result = self.my_channel._delete(mock_queue)
  778. self.my_channel._purge.assert_called_with(mock_queue)
  779. self.mock_broker.delQueue.assert_called_with(mock_queue)
  780. self.assertIsNone(result)
  781. def test_has_queue_true(self):
  782. """Test checking if a queue exists, and it does."""
  783. mock_queue = Mock()
  784. self.mock_broker.getQueue.return_value = True
  785. result = self.my_channel._has_queue(mock_queue)
  786. self.assertTrue(result)
  787. def test_has_queue_false(self):
  788. """Test checking if a queue exists, and it does not."""
  789. mock_queue = Mock()
  790. self.mock_broker.getQueue.return_value = False
  791. result = self.my_channel._has_queue(mock_queue)
  792. self.assertFalse(result)
  793. @patch('amqp.protocol.queue_declare_ok_t')
  794. def test_queue_declare_with_exception_raised(self,
  795. mock_queue_declare_ok_t):
  796. """Test declare_queue, where an exception is raised and silenced."""
  797. mock_queue = Mock()
  798. mock_passive = Mock()
  799. mock_durable = Mock()
  800. mock_exclusive = Mock()
  801. mock_auto_delete = Mock()
  802. mock_nowait = Mock()
  803. mock_arguments = Mock()
  804. mock_msg_count = Mock()
  805. mock_queue.startswith.return_value = False
  806. mock_queue.endswith.return_value = False
  807. options = {
  808. 'passive': mock_passive,
  809. 'durable': mock_durable,
  810. 'exclusive': mock_exclusive,
  811. 'auto-delete': mock_auto_delete,
  812. 'arguments': mock_arguments,
  813. }
  814. mock_consumer_count = Mock()
  815. mock_return_value = Mock()
  816. values_dict = {
  817. 'msgDepth': mock_msg_count,
  818. 'consumerCount': mock_consumer_count,
  819. }
  820. mock_queue_data = Mock()
  821. mock_queue_data.values = values_dict
  822. exception_to_raise = Exception('The foo object already exists.')
  823. self.mock_broker.addQueue.side_effect = exception_to_raise
  824. self.mock_broker.getQueue.return_value = mock_queue_data
  825. mock_queue_declare_ok_t.return_value = mock_return_value
  826. result = self.my_channel.queue_declare(
  827. mock_queue,
  828. passive=mock_passive,
  829. durable=mock_durable,
  830. exclusive=mock_exclusive,
  831. auto_delete=mock_auto_delete,
  832. nowait=mock_nowait,
  833. arguments=mock_arguments,
  834. )
  835. self.mock_broker.addQueue.assert_called_with(
  836. mock_queue, options=options,
  837. )
  838. mock_queue_declare_ok_t.assert_called_with(
  839. mock_queue, mock_msg_count, mock_consumer_count,
  840. )
  841. self.assertIs(mock_return_value, result)
  842. def test_queue_declare_set_ring_policy_for_celeryev(self):
  843. """Test declare_queue sets ring_policy for celeryev."""
  844. mock_queue = Mock()
  845. mock_queue.startswith.return_value = True
  846. mock_queue.endswith.return_value = False
  847. expected_default_options = {
  848. 'passive': False,
  849. 'durable': False,
  850. 'exclusive': False,
  851. 'auto-delete': True,
  852. 'arguments': None,
  853. 'qpid.policy_type': 'ring',
  854. }
  855. mock_msg_count = Mock()
  856. mock_consumer_count = Mock()
  857. values_dict = {
  858. 'msgDepth': mock_msg_count,
  859. 'consumerCount': mock_consumer_count,
  860. }
  861. mock_queue_data = Mock()
  862. mock_queue_data.values = values_dict
  863. self.mock_broker.addQueue.return_value = None
  864. self.mock_broker.getQueue.return_value = mock_queue_data
  865. self.my_channel.queue_declare(mock_queue)
  866. mock_queue.startswith.assert_called_with('celeryev')
  867. self.mock_broker.addQueue.assert_called_with(
  868. mock_queue, options=expected_default_options,
  869. )
  870. def test_queue_declare_set_ring_policy_for_pidbox(self):
  871. """Test declare_queue sets ring_policy for pidbox."""
  872. mock_queue = Mock()
  873. mock_queue.startswith.return_value = False
  874. mock_queue.endswith.return_value = True
  875. expected_default_options = {
  876. 'passive': False,
  877. 'durable': False,
  878. 'exclusive': False,
  879. 'auto-delete': True,
  880. 'arguments': None,
  881. 'qpid.policy_type': 'ring',
  882. }
  883. mock_msg_count = Mock()
  884. mock_consumer_count = Mock()
  885. values_dict = {
  886. 'msgDepth': mock_msg_count,
  887. 'consumerCount': mock_consumer_count,
  888. }
  889. mock_queue_data = Mock()
  890. mock_queue_data.values = values_dict
  891. self.mock_broker.addQueue.return_value = None
  892. self.mock_broker.getQueue.return_value = mock_queue_data
  893. self.my_channel.queue_declare(mock_queue)
  894. mock_queue.endswith.assert_called_with('pidbox')
  895. self.mock_broker.addQueue.assert_called_with(
  896. mock_queue, options=expected_default_options,
  897. )
  898. def test_queue_declare_ring_policy_not_set_as_expected(self):
  899. """Test declare_queue does not set ring_policy as expected."""
  900. mock_queue = Mock()
  901. mock_queue.startswith.return_value = False
  902. mock_queue.endswith.return_value = False
  903. expected_default_options = {
  904. 'passive': False,
  905. 'durable': False,
  906. 'exclusive': False,
  907. 'auto-delete': True,
  908. 'arguments': None,
  909. }
  910. mock_msg_count = Mock()
  911. mock_consumer_count = Mock()
  912. values_dict = {
  913. 'msgDepth': mock_msg_count,
  914. 'consumerCount': mock_consumer_count,
  915. }
  916. mock_queue_data = Mock()
  917. mock_queue_data.values = values_dict
  918. self.mock_broker.addQueue.return_value = None
  919. self.mock_broker.getQueue.return_value = mock_queue_data
  920. self.my_channel.queue_declare(mock_queue)
  921. mock_queue.startswith.assert_called_with('celeryev')
  922. mock_queue.endswith.assert_called_with('pidbox')
  923. self.mock_broker.addQueue.assert_called_with(
  924. mock_queue, options=expected_default_options,
  925. )
  926. def test_queue_declare_test_defaults(self):
  927. """Test declare_queue defaults."""
  928. mock_queue = Mock()
  929. mock_queue.startswith.return_value = False
  930. mock_queue.endswith.return_value = False
  931. expected_default_options = {
  932. 'passive': False,
  933. 'durable': False,
  934. 'exclusive': False,
  935. 'auto-delete': True,
  936. 'arguments': None,
  937. }
  938. mock_msg_count = Mock()
  939. mock_consumer_count = Mock()
  940. values_dict = {
  941. 'msgDepth': mock_msg_count,
  942. 'consumerCount': mock_consumer_count,
  943. }
  944. mock_queue_data = Mock()
  945. mock_queue_data.values = values_dict
  946. self.mock_broker.addQueue.return_value = None
  947. self.mock_broker.getQueue.return_value = mock_queue_data
  948. self.my_channel.queue_declare(mock_queue)
  949. self.mock_broker.addQueue.assert_called_with(
  950. mock_queue,
  951. options=expected_default_options,
  952. )
  953. def test_queue_declare_raises_exception_not_silenced(self):
  954. unique_exception = Exception('This exception should not be silenced')
  955. mock_queue = Mock()
  956. self.mock_broker.addQueue.side_effect = unique_exception
  957. with self.assertRaises(unique_exception.__class__):
  958. self.my_channel.queue_declare(mock_queue)
  959. self.mock_broker.addQueue.assert_called_once_with(
  960. mock_queue,
  961. options={
  962. 'exclusive': False,
  963. 'durable': False,
  964. 'qpid.policy_type': 'ring',
  965. 'passive': False,
  966. 'arguments': None,
  967. 'auto-delete': True
  968. })
  969. def test_exchange_declare_raises_exception_and_silenced(self):
  970. """Create exchange where an exception is raised and then silenced"""
  971. self.mock_broker.addExchange.side_effect = Exception(
  972. 'The foo object already exists.',
  973. )
  974. self.my_channel.exchange_declare()
  975. def test_exchange_declare_raises_exception_not_silenced(self):
  976. """Create Exchange where an exception is raised and not silenced."""
  977. unique_exception = Exception('This exception should not be silenced')
  978. self.mock_broker.addExchange.side_effect = unique_exception
  979. with self.assertRaises(unique_exception.__class__):
  980. self.my_channel.exchange_declare()
  981. def test_exchange_declare(self):
  982. """Create Exchange where an exception is NOT raised."""
  983. mock_exchange = Mock()
  984. mock_type = Mock()
  985. mock_durable = Mock()
  986. options = {'durable': mock_durable}
  987. result = self.my_channel.exchange_declare(
  988. mock_exchange, mock_type, mock_durable,
  989. )
  990. self.mock_broker.addExchange.assert_called_with(
  991. mock_type, mock_exchange, options,
  992. )
  993. self.assertIsNone(result)
  994. def test_exchange_delete(self):
  995. """Test the deletion of an exchange by name."""
  996. mock_exchange = Mock()
  997. result = self.my_channel.exchange_delete(mock_exchange)
  998. self.mock_broker.delExchange.assert_called_with(mock_exchange)
  999. self.assertIsNone(result)
  1000. def test_queue_bind(self):
  1001. """Test binding a queue to an exchange using a routing key."""
  1002. mock_queue = Mock()
  1003. mock_exchange = Mock()
  1004. mock_routing_key = Mock()
  1005. self.my_channel.queue_bind(
  1006. mock_queue, mock_exchange, mock_routing_key,
  1007. )
  1008. self.mock_broker.bind.assert_called_with(
  1009. mock_exchange, mock_queue, mock_routing_key,
  1010. )
  1011. def test_queue_unbind(self):
  1012. """Test unbinding a queue from an exchange using a routing key."""
  1013. mock_queue = Mock()
  1014. mock_exchange = Mock()
  1015. mock_routing_key = Mock()
  1016. self.my_channel.queue_unbind(
  1017. mock_queue, mock_exchange, mock_routing_key,
  1018. )
  1019. self.mock_broker.unbind.assert_called_with(
  1020. mock_exchange, mock_queue, mock_routing_key,
  1021. )
  1022. def test_queue_purge(self):
  1023. """Test purging a queue by name."""
  1024. mock_queue = Mock()
  1025. purge_result = Mock()
  1026. self.my_channel._purge = Mock(return_value=purge_result)
  1027. result = self.my_channel.queue_purge(mock_queue)
  1028. self.my_channel._purge.assert_called_with(mock_queue)
  1029. self.assertIs(purge_result, result)
  1030. @patch(QPID_MODULE + '.Channel.qos')
  1031. def test_basic_ack(self, mock_qos):
  1032. """Test that basic_ack calls the QoS object properly."""
  1033. mock_delivery_tag = Mock()
  1034. self.my_channel.basic_ack(mock_delivery_tag)
  1035. mock_qos.ack.assert_called_with(mock_delivery_tag)
  1036. @patch(QPID_MODULE + '.Channel.qos')
  1037. def test_basic_reject(self, mock_qos):
  1038. """Test that basic_reject calls the QoS object properly."""
  1039. mock_delivery_tag = Mock()
  1040. mock_requeue_value = Mock()
  1041. self.my_channel.basic_reject(mock_delivery_tag, mock_requeue_value)
  1042. mock_qos.reject.assert_called_with(
  1043. mock_delivery_tag, requeue=mock_requeue_value,
  1044. )
  1045. def test_qos_manager_is_none(self):
  1046. """Test the qos property if the QoS object did not already exist."""
  1047. self.my_channel._qos = None
  1048. result = self.my_channel.qos
  1049. self.assertIsInstance(result, QoS)
  1050. self.assertEqual(result, self.my_channel._qos)
  1051. def test_qos_manager_already_exists(self):
  1052. """Test the qos property if the QoS object already exists."""
  1053. mock_existing_qos = Mock()
  1054. self.my_channel._qos = mock_existing_qos
  1055. result = self.my_channel.qos
  1056. self.assertIs(mock_existing_qos, result)
  1057. def test_prepare_message(self):
  1058. """Test that prepare_message() returns the correct result."""
  1059. mock_body = Mock()
  1060. mock_priority = Mock()
  1061. mock_content_encoding = Mock()
  1062. mock_content_type = Mock()
  1063. mock_header1 = Mock()
  1064. mock_header2 = Mock()
  1065. mock_properties1 = Mock()
  1066. mock_properties2 = Mock()
  1067. headers = {'header1': mock_header1, 'header2': mock_header2}
  1068. properties = {'properties1': mock_properties1,
  1069. 'properties2': mock_properties2}
  1070. result = self.my_channel.prepare_message(
  1071. mock_body,
  1072. priority=mock_priority,
  1073. content_type=mock_content_type,
  1074. content_encoding=mock_content_encoding,
  1075. headers=headers,
  1076. properties=properties)
  1077. self.assertIs(mock_body, result['body'])
  1078. self.assertIs(mock_content_encoding, result['content-encoding'])
  1079. self.assertIs(mock_content_type, result['content-type'])
  1080. self.assertDictEqual(headers, result['headers'])
  1081. self.assertDictContainsSubset(properties, result['properties'])
  1082. self.assertIs(
  1083. mock_priority, result['properties']['delivery_info']['priority'],
  1084. )
  1085. @patch('__builtin__.buffer')
  1086. @patch(QPID_MODULE + '.Channel.body_encoding')
  1087. @patch(QPID_MODULE + '.Channel.encode_body')
  1088. @patch(QPID_MODULE + '.Channel._put')
  1089. def test_basic_publish(self, mock_put,
  1090. mock_encode_body,
  1091. mock_body_encoding,
  1092. mock_buffer):
  1093. """Test basic_publish()."""
  1094. mock_original_body = Mock()
  1095. mock_encoded_body = 'this is my encoded body'
  1096. mock_message = {'body': mock_original_body,
  1097. 'properties': {'delivery_info': {}}}
  1098. mock_encode_body.return_value = (
  1099. mock_encoded_body, mock_body_encoding,
  1100. )
  1101. mock_exchange = Mock()
  1102. mock_routing_key = Mock()
  1103. mock_encoded_buffered_body = Mock()
  1104. mock_buffer.return_value = mock_encoded_buffered_body
  1105. self.my_channel.basic_publish(
  1106. mock_message, mock_exchange, mock_routing_key,
  1107. )
  1108. mock_encode_body.assert_called_once_with(
  1109. mock_original_body, mock_body_encoding,
  1110. )
  1111. mock_buffer.assert_called_once_with(mock_encoded_body)
  1112. self.assertIs(mock_message['body'], mock_encoded_buffered_body)
  1113. self.assertIs(
  1114. mock_message['properties']['body_encoding'], mock_body_encoding,
  1115. )
  1116. self.assertIsInstance(
  1117. mock_message['properties']['delivery_tag'], uuid.UUID,
  1118. )
  1119. self.assertIs(
  1120. mock_message['properties']['delivery_info']['exchange'],
  1121. mock_exchange,
  1122. )
  1123. self.assertIs(
  1124. mock_message['properties']['delivery_info']['routing_key'],
  1125. mock_routing_key,
  1126. )
  1127. mock_put.assert_called_with(
  1128. mock_routing_key, mock_message, mock_exchange,
  1129. )
  1130. @patch(QPID_MODULE + '.Channel.codecs')
  1131. def test_encode_body_expected_encoding(self, mock_codecs):
  1132. """Test if encode_body() works when encoding is set correctly"""
  1133. mock_body = Mock()
  1134. mock_encoder = Mock()
  1135. mock_encoded_result = Mock()
  1136. mock_codecs.get.return_value = mock_encoder
  1137. mock_encoder.encode.return_value = mock_encoded_result
  1138. result = self.my_channel.encode_body(mock_body, encoding='base64')
  1139. expected_result = (mock_encoded_result, 'base64')
  1140. self.assertEqual(expected_result, result)
  1141. @patch(QPID_MODULE + '.Channel.codecs')
  1142. def test_encode_body_not_expected_encoding(self, mock_codecs):
  1143. """Test if encode_body() works when encoding is not set correctly."""
  1144. mock_body = Mock()
  1145. result = self.my_channel.encode_body(mock_body, encoding=None)
  1146. expected_result = mock_body, None
  1147. self.assertEqual(expected_result, result)
  1148. @patch(QPID_MODULE + '.Channel.codecs')
  1149. def test_decode_body_expected_encoding(self, mock_codecs):
  1150. """Test if decode_body() works when encoding is set correctly."""
  1151. mock_body = Mock()
  1152. mock_decoder = Mock()
  1153. mock_decoded_result = Mock()
  1154. mock_codecs.get.return_value = mock_decoder
  1155. mock_decoder.decode.return_value = mock_decoded_result
  1156. result = self.my_channel.decode_body(mock_body, encoding='base64')
  1157. self.assertEqual(mock_decoded_result, result)
  1158. @patch(QPID_MODULE + '.Channel.codecs')
  1159. def test_decode_body_not_expected_encoding(self, mock_codecs):
  1160. """Test if decode_body() works when encoding is not set correctly."""
  1161. mock_body = Mock()
  1162. result = self.my_channel.decode_body(mock_body, encoding=None)
  1163. self.assertEqual(mock_body, result)
  1164. def test_typeof_exchange_exists(self):
  1165. """Test that typeof() finds an exchange that already exists."""
  1166. mock_exchange = Mock()
  1167. mock_qpid_exchange = Mock()
  1168. mock_attributes = {}
  1169. mock_type = Mock()
  1170. mock_attributes['type'] = mock_type
  1171. mock_qpid_exchange.getAttributes.return_value = mock_attributes
  1172. self.mock_broker.getExchange.return_value = mock_qpid_exchange
  1173. result = self.my_channel.typeof(mock_exchange)
  1174. self.assertIs(mock_type, result)
  1175. def test_typeof_exchange_does_not_exist(self):
  1176. """Test that typeof() finds an exchange that does not exists."""
  1177. mock_exchange = Mock()
  1178. mock_default = Mock()
  1179. self.mock_broker.getExchange.return_value = None
  1180. result = self.my_channel.typeof(mock_exchange, default=mock_default)
  1181. self.assertIs(mock_default, result)
  1182. @case_no_python3
  1183. @case_no_pypy
  1184. @disable_runtime_dependency_check
  1185. class TestTransportInit(Case):
  1186. def setUp(self):
  1187. self.patch_a = patch.object(Transport, 'verify_runtime_environment')
  1188. self.mock_verify_runtime_environment = self.patch_a.start()
  1189. self.patch_b = patch(QPID_MODULE + '.base.Transport.__init__')
  1190. self.mock_base_Transport__init__ = self.patch_b.start()
  1191. def tearDown(self):
  1192. self.patch_a.stop()
  1193. self.patch_b.stop()
  1194. def test_Transport___init___calls_verify_runtime_environment(self):
  1195. Transport(Mock())
  1196. self.mock_verify_runtime_environment.assert_called_once_with()
  1197. def test_transport___init___calls_parent_class___init__(self):
  1198. m = Mock()
  1199. Transport(m)
  1200. self.mock_base_Transport__init__.assert_called_once_with(m)
  1201. def test_transport___init___sets_use_async_interface_False(self):
  1202. transport = Transport(Mock())
  1203. self.assertFalse(transport.use_async_interface)
  1204. @case_no_python3
  1205. @case_no_pypy
  1206. @disable_runtime_dependency_check
  1207. class TestTransportDrainEvents(Case):
  1208. def setUp(self):
  1209. self.transport = Transport(Mock())
  1210. self.transport.session = Mock()
  1211. self.mock_queue = Mock()
  1212. self.mock_message = Mock()
  1213. self.mock_conn = Mock()
  1214. self.mock_callback = Mock()
  1215. self.mock_conn._callbacks = {self.mock_queue: self.mock_callback}
  1216. def mock_next_receiver(self, timeout):
  1217. time.sleep(0.3)
  1218. mock_receiver = Mock()
  1219. mock_receiver.source = self.mock_queue
  1220. mock_receiver.fetch.return_value = self.mock_message
  1221. return mock_receiver
  1222. def test_socket_timeout_raised_when_all_receivers_empty(self):
  1223. with patch(QPID_MODULE + '.QpidEmpty', new=QpidException):
  1224. self.transport.session.next_receiver.side_effect = QpidException()
  1225. with self.assertRaises(socket.timeout):
  1226. self.transport.drain_events(Mock())
  1227. def test_socket_timeout_raised_when_by_timeout(self):
  1228. self.transport.session.next_receiver = self.mock_next_receiver
  1229. with self.assertRaises(socket.timeout):
  1230. self.transport.drain_events(self.mock_conn, timeout=1)
  1231. def test_timeout_returns_no_earlier_then_asked_for(self):
  1232. self.transport.session.next_receiver = self.mock_next_receiver
  1233. start_time = monotonic()
  1234. try:
  1235. self.transport.drain_events(self.mock_conn, timeout=1)
  1236. except socket.timeout:
  1237. pass
  1238. elapsed_time_in_s = monotonic() - start_time
  1239. self.assertGreaterEqual(elapsed_time_in_s, 1.0)
  1240. def test_callback_is_called(self):
  1241. self.transport.session.next_receiver = self.mock_next_receiver
  1242. try:
  1243. self.transport.drain_events(self.mock_conn, timeout=1)
  1244. except socket.timeout:
  1245. pass
  1246. self.mock_callback.assert_called_with(self.mock_message)
  1247. @case_no_python3
  1248. @case_no_pypy
  1249. @disable_runtime_dependency_check
  1250. class TestTransportCreateChannel(Case):
  1251. def setUp(self):
  1252. self.transport = Transport(Mock())
  1253. self.mock_conn = Mock()
  1254. self.mock_new_channel = Mock()
  1255. self.mock_conn.Channel.return_value = self.mock_new_channel
  1256. self.returned_channel = self.transport.create_channel(self.mock_conn)
  1257. def test_new_channel_created_from_connection(self):
  1258. self.assertIs(self.mock_new_channel, self.returned_channel)
  1259. self.mock_conn.Channel.assert_called_with(
  1260. self.mock_conn, self.transport,
  1261. )
  1262. def test_new_channel_added_to_connection_channel_list(self):
  1263. append_method = self.mock_conn.channels.append
  1264. append_method.assert_called_with(self.mock_new_channel)
  1265. @case_no_python3
  1266. @case_no_pypy
  1267. @disable_runtime_dependency_check
  1268. class TestTransportEstablishConnection(Case):
  1269. def setUp(self):
  1270. class MockClient(object):
  1271. pass
  1272. self.client = MockClient()
  1273. self.client.connect_timeout = 4
  1274. self.client.ssl = False
  1275. self.client.transport_options = {}
  1276. self.client.userid = None
  1277. self.client.password = None
  1278. self.client.login_method = None
  1279. self.transport = Transport(self.client)
  1280. self.mock_conn = Mock()
  1281. self.transport.Connection = self.mock_conn
  1282. def test_transport_establish_conn_new_option_overwrites_default(self):
  1283. self.client.userid = 'new-userid'
  1284. self.client.password = 'new-password'
  1285. self.transport.establish_connection()
  1286. self.mock_conn.assert_called_once_with(
  1287. username=self.client.userid,
  1288. password=self.client.password,
  1289. sasl_mechanisms='PLAIN',
  1290. host='localhost',
  1291. timeout=4,
  1292. port=5672,
  1293. transport='tcp',
  1294. )
  1295. def test_transport_establish_conn_empty_client_is_default(self):
  1296. self.transport.establish_connection()
  1297. self.mock_conn.assert_called_once_with(
  1298. sasl_mechanisms='ANONYMOUS',
  1299. host='localhost',
  1300. timeout=4,
  1301. port=5672,
  1302. transport='tcp',
  1303. )
  1304. def test_transport_establish_conn_additional_transport_option(self):
  1305. new_param_value = 'mynewparam'
  1306. self.client.transport_options['new_param'] = new_param_value
  1307. self.transport.establish_connection()
  1308. self.mock_conn.assert_called_once_with(
  1309. sasl_mechanisms='ANONYMOUS',
  1310. host='localhost',
  1311. timeout=4,
  1312. new_param=new_param_value,
  1313. port=5672,
  1314. transport='tcp',
  1315. )
  1316. def test_transport_establish_conn_transform_localhost_to_127_0_0_1(self):
  1317. self.client.hostname = 'localhost'
  1318. self.transport.establish_connection()
  1319. self.mock_conn.assert_called_once_with(
  1320. sasl_mechanisms='ANONYMOUS',
  1321. host='localhost',
  1322. timeout=4,
  1323. port=5672,
  1324. transport='tcp',
  1325. )
  1326. def test_transport_password_no_userid_raises_exception(self):
  1327. self.client.password = 'somepass'
  1328. self.assertRaises(Exception, self.transport.establish_connection)
  1329. def test_transport_userid_no_password_raises_exception(self):
  1330. self.client.userid = 'someusername'
  1331. self.assertRaises(Exception, self.transport.establish_connection)
  1332. def test_transport_overrides_sasl_mech_from_login_method(self):
  1333. self.client.login_method = 'EXTERNAL'
  1334. self.transport.establish_connection()
  1335. self.mock_conn.assert_called_once_with(
  1336. sasl_mechanisms='EXTERNAL',
  1337. host='localhost',
  1338. timeout=4,
  1339. port=5672,
  1340. transport='tcp',
  1341. )
  1342. def test_transport_overrides_sasl_mech_has_username(self):
  1343. self.client.userid = 'new-userid'
  1344. self.client.login_method = 'EXTERNAL'
  1345. self.transport.establish_connection()
  1346. self.mock_conn.assert_called_once_with(
  1347. username=self.client.userid,
  1348. sasl_mechanisms='EXTERNAL',
  1349. host='localhost',
  1350. timeout=4,
  1351. port=5672,
  1352. transport='tcp',
  1353. )
  1354. def test_transport_establish_conn_set_password(self):
  1355. self.client.userid = 'someuser'
  1356. self.client.password = 'somepass'
  1357. self.transport.establish_connection()
  1358. self.mock_conn.assert_called_once_with(
  1359. username='someuser',
  1360. password='somepass',
  1361. sasl_mechanisms='PLAIN',
  1362. host='localhost',
  1363. timeout=4,
  1364. port=5672,
  1365. transport='tcp',
  1366. )
  1367. def test_transport_establish_conn_no_ssl_sets_transport_tcp(self):
  1368. self.client.ssl = False
  1369. self.transport.establish_connection()
  1370. self.mock_conn.assert_called_once_with(
  1371. sasl_mechanisms='ANONYMOUS',
  1372. host='localhost',
  1373. timeout=4,
  1374. port=5672,
  1375. transport='tcp',
  1376. )
  1377. def test_transport_establish_conn_with_ssl_with_hostname_check(self):
  1378. self.client.ssl = {
  1379. 'keyfile': 'my_keyfile',
  1380. 'certfile': 'my_certfile',
  1381. 'ca_certs': 'my_cacerts',
  1382. 'cert_reqs': ssl.CERT_REQUIRED,
  1383. }
  1384. self.transport.establish_connection()
  1385. self.mock_conn.assert_called_once_with(
  1386. ssl_certfile='my_certfile',
  1387. ssl_trustfile='my_cacerts',
  1388. timeout=4,
  1389. ssl_skip_hostname_check=False,
  1390. sasl_mechanisms='ANONYMOUS',
  1391. host='localhost',
  1392. ssl_keyfile='my_keyfile',
  1393. port=5672, transport='ssl',
  1394. )
  1395. def test_transport_establish_conn_with_ssl_skip_hostname_check(self):
  1396. self.client.ssl = {
  1397. 'keyfile': 'my_keyfile',
  1398. 'certfile': 'my_certfile',
  1399. 'ca_certs': 'my_cacerts',
  1400. 'cert_reqs': ssl.CERT_OPTIONAL,
  1401. }
  1402. self.transport.establish_connection()
  1403. self.mock_conn.assert_called_once_with(
  1404. ssl_certfile='my_certfile',
  1405. ssl_trustfile='my_cacerts',
  1406. timeout=4,
  1407. ssl_skip_hostname_check=True,
  1408. sasl_mechanisms='ANONYMOUS',
  1409. host='localhost',
  1410. ssl_keyfile='my_keyfile',
  1411. port=5672, transport='ssl',
  1412. )
  1413. def test_transport_establish_conn_sets_client_on_connection_object(self):
  1414. self.transport.establish_connection()
  1415. self.assertIs(self.mock_conn.return_value.client, self.client)
  1416. def test_transport_establish_conn_creates_session_on_transport(self):
  1417. self.transport.establish_connection()
  1418. qpid_conn = self.mock_conn.return_value.get_qpid_connection
  1419. new_mock_session = qpid_conn.return_value.session.return_value
  1420. self.assertIs(self.transport.session, new_mock_session)
  1421. def test_transport_establish_conn_returns_new_connection_object(self):
  1422. new_conn = self.transport.establish_connection()
  1423. self.assertIs(new_conn, self.mock_conn.return_value)
  1424. def test_transport_establish_conn_uses_hostname_if_not_default(self):
  1425. self.client.hostname = 'some_other_hostname'
  1426. self.transport.establish_connection()
  1427. self.mock_conn.assert_called_once_with(
  1428. sasl_mechanisms='ANONYMOUS',
  1429. host='some_other_hostname',
  1430. timeout=4,
  1431. port=5672,
  1432. transport='tcp',
  1433. )
  1434. def test_transport_sets_qpid_message_ready_handler(self):
  1435. self.transport.establish_connection()
  1436. qpid_conn_call = self.mock_conn.return_value.get_qpid_connection
  1437. mock_session = qpid_conn_call.return_value.session.return_value
  1438. mock_set_callback = mock_session.set_message_received_notify_handler
  1439. expected_msg_callback = self.transport._qpid_message_ready_handler
  1440. mock_set_callback.assert_called_once_with(expected_msg_callback)
  1441. def test_transport_sets_session_exception_handler(self):
  1442. self.transport.establish_connection()
  1443. qpid_conn_call = self.mock_conn.return_value.get_qpid_connection
  1444. mock_session = qpid_conn_call.return_value.session.return_value
  1445. mock_set_callback = mock_session.set_async_exception_notify_handler
  1446. exc_callback = self.transport._qpid_async_exception_notify_handler
  1447. mock_set_callback.assert_called_once_with(exc_callback)
  1448. def test_transport_sets_connection_exception_handler(self):
  1449. self.transport.establish_connection()
  1450. qpid_conn_call = self.mock_conn.return_value.get_qpid_connection
  1451. qpid_conn = qpid_conn_call.return_value
  1452. mock_set_callback = qpid_conn.set_async_exception_notify_handler
  1453. exc_callback = self.transport._qpid_async_exception_notify_handler
  1454. mock_set_callback.assert_called_once_with(exc_callback)
  1455. @case_no_python3
  1456. @case_no_pypy
  1457. class TestTransportClassAttributes(Case):
  1458. def test_verify_Connection_attribute(self):
  1459. self.assertIs(Connection, Transport.Connection)
  1460. def test_verify_polling_disabled(self):
  1461. self.assertIsNone(Transport.polling_interval)
  1462. def test_transport_verify_supports_asynchronous_events(self):
  1463. self.assertTrue(Transport.supports_ev)
  1464. def test_verify_driver_type_and_name(self):
  1465. self.assertEqual('qpid', Transport.driver_type)
  1466. self.assertEqual('qpid', Transport.driver_name)
  1467. def test_transport_verify_recoverable_connection_errors(self):
  1468. connection_errors = Transport.recoverable_connection_errors
  1469. self.assertIn(ConnectionError, connection_errors)
  1470. self.assertIn(select.error, connection_errors)
  1471. def test_transport_verify_recoverable_channel_errors(self):
  1472. channel_errors = Transport.recoverable_channel_errors
  1473. self.assertIn(NotFound, channel_errors)
  1474. def test_transport_verify_pre_kombu_3_0_exception_labels(self):
  1475. self.assertEqual(Transport.recoverable_channel_errors,
  1476. Transport.channel_errors)
  1477. self.assertEqual(Transport.recoverable_connection_errors,
  1478. Transport.connection_errors)
  1479. @case_no_python3
  1480. @case_no_pypy
  1481. @disable_runtime_dependency_check
  1482. class TestTransportRegisterWithEventLoop(Case):
  1483. def test_transport_register_with_event_loop_calls_add_reader(self):
  1484. transport = Transport(Mock())
  1485. mock_connection = Mock()
  1486. mock_loop = Mock()
  1487. transport.register_with_event_loop(mock_connection, mock_loop)
  1488. mock_loop.add_reader.assert_called_with(
  1489. transport.r, transport.on_readable, mock_connection, mock_loop,
  1490. )
  1491. @case_no_python3
  1492. @case_no_pypy
  1493. @disable_runtime_dependency_check
  1494. class TestTransportQpidCallbackHandlersAsync(Case):
  1495. def setUp(self):
  1496. self.patch_a = patch(QPID_MODULE + '.os.write')
  1497. self.mock_os_write = self.patch_a.start()
  1498. self.transport = Transport(Mock())
  1499. self.transport.register_with_event_loop(Mock(), Mock())
  1500. def tearDown(self):
  1501. self.patch_a.stop()
  1502. def test__qpid_message_ready_handler_writes_symbol_to_fd(self):
  1503. self.transport._qpid_message_ready_handler(Mock())
  1504. self.mock_os_write.assert_called_once_with(self.transport._w, '0')
  1505. def test__qpid_async_exception_notify_handler_writes_symbol_to_fd(self):
  1506. self.transport._qpid_async_exception_notify_handler(Mock(), Mock())
  1507. self.mock_os_write.assert_called_once_with(self.transport._w, 'e')
  1508. @case_no_python3
  1509. @case_no_pypy
  1510. @disable_runtime_dependency_check
  1511. class TestTransportQpidCallbackHandlersSync(Case):
  1512. def setUp(self):
  1513. self.patch_a = patch(QPID_MODULE + '.os.write')
  1514. self.mock_os_write = self.patch_a.start()
  1515. self.transport = Transport(Mock())
  1516. def tearDown(self):
  1517. self.patch_a.stop()
  1518. def test__qpid_message_ready_handler_dows_not_write(self):
  1519. self.transport._qpid_message_ready_handler(Mock())
  1520. self.assertTrue(not self.mock_os_write.called)
  1521. def test__qpid_async_exception_notify_handler_does_not_write(self):
  1522. self.transport._qpid_async_exception_notify_handler(Mock(), Mock())
  1523. self.assertTrue(not self.mock_os_write.called)
  1524. @case_no_python3
  1525. @case_no_pypy
  1526. @disable_runtime_dependency_check
  1527. class TestTransportOnReadable(Case):
  1528. def setUp(self):
  1529. self.patch_a = patch(QPID_MODULE + '.os.read')
  1530. self.mock_os_read = self.patch_a.start()
  1531. self.patch_b = patch.object(Transport, 'drain_events')
  1532. self.mock_drain_events = self.patch_b.start()
  1533. self.transport = Transport(Mock())
  1534. self.transport.register_with_event_loop(Mock(), Mock())
  1535. def tearDown(self):
  1536. self.patch_a.stop()
  1537. self.patch_b.stop()
  1538. def test_transport_on_readable_reads_symbol_from_fd(self):
  1539. self.transport.on_readable(Mock(), Mock())
  1540. self.mock_os_read.assert_called_once_with(self.transport.r, 1)
  1541. def test_transport_on_readable_calls_drain_events(self):
  1542. mock_connection = Mock()
  1543. self.transport.on_readable(mock_connection, Mock())
  1544. self.mock_drain_events.assert_called_with(mock_connection)
  1545. def test_transport_on_readable_catches_socket_timeout(self):
  1546. self.mock_drain_events.side_effect = socket.timeout()
  1547. self.transport.on_readable(Mock(), Mock())
  1548. def test_transport_on_readable_ignores_non_socket_timeout_exception(self):
  1549. self.mock_drain_events.side_effect = IOError()
  1550. with self.assertRaises(IOError):
  1551. self.transport.on_readable(Mock(), Mock())
  1552. @case_no_python3
  1553. @case_no_pypy
  1554. @disable_runtime_dependency_check
  1555. class TestTransportVerifyRuntimeEnvironment(Case):
  1556. def setUp(self):
  1557. self.verify_runtime_environment = Transport.verify_runtime_environment
  1558. self.patch_a = patch.object(Transport, 'verify_runtime_environment')
  1559. self.patch_a.start()
  1560. self.transport = Transport(Mock())
  1561. def tearDown(self):
  1562. self.patch_a.stop()
  1563. @patch(QPID_MODULE + '.PY3', new=True)
  1564. def test_raises_exception_for_Python3(self):
  1565. with self.assertRaises(RuntimeError):
  1566. self.verify_runtime_environment(self.transport)
  1567. @patch('__builtin__.getattr')
  1568. def test_raises_exc_for_PyPy(self, mock_getattr):
  1569. mock_getattr.return_value = True
  1570. with self.assertRaises(RuntimeError):
  1571. self.verify_runtime_environment(self.transport)
  1572. @patch(QPID_MODULE + '.dependency_is_none')
  1573. def test_raises_exc_dep_missing(self, mock_dep_is_none):
  1574. mock_dep_is_none.return_value = True
  1575. with self.assertRaises(RuntimeError):
  1576. self.verify_runtime_environment(self.transport)
  1577. @patch(QPID_MODULE + '.dependency_is_none')
  1578. def test_calls_dependency_is_none(self, mock_dep_is_none):
  1579. mock_dep_is_none.return_value = False
  1580. self.verify_runtime_environment(self.transport)
  1581. self.assertTrue(mock_dep_is_none.called)
  1582. def test_raises_no_exception(self):
  1583. self.verify_runtime_environment(self.transport)
  1584. @case_no_python3
  1585. @case_no_pypy
  1586. @disable_runtime_dependency_check
  1587. class TestTransport(ExtraAssertionsMixin, Case):
  1588. def setUp(self):
  1589. """Creates a mock_client to be used in testing."""
  1590. self.mock_client = Mock()
  1591. def test_close_connection(self):
  1592. """Test that close_connection calls close on the connection."""
  1593. my_transport = Transport(self.mock_client)
  1594. mock_connection = Mock()
  1595. my_transport.close_connection(mock_connection)
  1596. mock_connection.close.assert_called_once_with()
  1597. def test_default_connection_params(self):
  1598. """Test that the default_connection_params are correct"""
  1599. correct_params = {
  1600. 'hostname': 'localhost',
  1601. 'port': 5672,
  1602. }
  1603. my_transport = Transport(self.mock_client)
  1604. result_params = my_transport.default_connection_params
  1605. self.assertDictEqual(correct_params, result_params)
  1606. @patch(QPID_MODULE + '.os.close')
  1607. def test_del_sync(self, close):
  1608. my_transport = Transport(self.mock_client)
  1609. my_transport.__del__()
  1610. self.assertFalse(close.called)
  1611. @patch(QPID_MODULE + '.os.close')
  1612. def test_del_async(self, close):
  1613. my_transport = Transport(self.mock_client)
  1614. my_transport.register_with_event_loop(Mock(), Mock())
  1615. my_transport.__del__()
  1616. self.assertTrue(close.called)
  1617. @patch(QPID_MODULE + '.os.close')
  1618. def test_del_async_failed(self, close):
  1619. close.side_effect = OSError()
  1620. my_transport = Transport(self.mock_client)
  1621. my_transport.register_with_event_loop(Mock(), Mock())
  1622. my_transport.__del__()
  1623. self.assertTrue(close.called)