def test_client_retries_defines_how_many_times_the_client_retries_connection(self, retries, connect_count):
# Client wont' connect ;)
self.client._client.connect = Mock(side_effect=Exception('Could not connect'))
# No delay between retries (faster unit tests)
self.client.config.reconnect_delay = 0
self.client._wait_for_policy_delay = 0
broker = Broker(host_name='localhost')
broker._parse(UuidGenerator.generate_id_as_string() + ";9999;localhost;127.0.0.1")
self.client.config.brokers = [broker]
self.client.config.connect_retries = retries
with self.assertRaises(DxlException):
self.client.connect()
self.assertEqual(self.client._client.connect.call_count, connect_count)
def _brokers_for_config(broker_lines):
"""
Convert the supplied broker configuration, a `list` of strings - one
for each broker - into a list of :class:`Broker` objects. Each string
in the input list represents a key/value pair, delimited by an equal
sign. This method uses :meth:`Broker._parse` as a constructor, raising
an `Exception` any broker configuration lines are syntactically
invalid.
:param broker_lines: collection of configuration info for each broker
:type broker_lines: list(str) or tuple(str) or set(str)
:return: `list` of broker info
:rtype: list(Broker)
"""
brokers = []
for broker_line in broker_lines:
try:
broker_key, broker_value = broker_line.split("=")
except Exception:
logger.error("Invalid key value pair for broker entry: %s",
broker_line)
raise
broker = Broker(host_name="none")
try:
broker._parse(broker_value)
except Exception as ex:
logger.error("Failed to process broker value: %s. Message: %s",
broker_value, ex)
raise
if not broker.unique_id:
raise Exception("No guid for broker: {}".format(broker_value))
if broker.unique_id != broker_key:
raise Exception("{}{}{}{}. Broker line: {}".format(
"guid for broker key ", broker_key,
" did not match guid for broker value: ", broker.unique_id,
broker_line))
brokers.append(broker)
return brokers
class BrokerTest(unittest.TestCase):
def setUp(self):
self.socket_mock = patch('socket.socket').start()
self.connection_mock = patch('socket.create_connection').start()
self.connection_mock.return_value = self.socket_mock
self.broker = Broker(host_name='localhost')
def tearDown(self):
patch.stopall()
@parameterized.expand([
("", ),
("a ; "),
])
@raises(MalformedBrokerUriException)
def test_parse_string_with_invalid_port_raises_exception(self, unique_id):
self.broker._parse(unique_id + "b; [c] ")
@parameterized.expand([
("", ),
("a ; "),
])
@raises(MalformedBrokerUriException)
def test_parse_string_without_hostname_raises_exception(self, unique_id):
self.broker._parse(unique_id + "b")
@parameterized.expand([
("", ),
("a ; "),
])
@raises(MalformedBrokerUriException)
def test_parse_string_with_empty_hostname_raises_exception(
self, unique_id):
self.broker._parse(unique_id + "b;")
@parameterized.expand([
("", ),
("a ;"),
])
@raises(MalformedBrokerUriException)
def test_parse_string_with_port_out_of_range_raises_exception(
self, unique_id):
self.broker._parse(unique_id + "65536; [c] ")
def test_parse_string_valid_with_unique_id_but_no_ip_address(self):
self.broker._parse("a ; 8883; [c] ")
self.assertEqual("a", self.broker.unique_id)
self.assertEqual(8883, self.broker.port)
self.assertEqual("c", self.broker.host_name)
self.assertIsNone(self.broker.ip_address)
def test_parse_string_valid_with_unique_id_and_ip_address(self):
self.broker._parse("a ; 8883; [c];10.0.0.1 ")
self.assertEqual("a", self.broker.unique_id)
self.assertEqual(8883, self.broker.port)
self.assertEqual("c", self.broker.host_name)
self.assertEqual("10.0.0.1", self.broker.ip_address)
def test_parse_string_valid_without_unique_id_or_ip_address(self):
self.broker._parse("8883; [c] ")
self.assertEqual("", self.broker.unique_id)
self.assertEqual(8883, self.broker.port)
self.assertEqual("c", self.broker.host_name)
self.assertIsNone(self.broker.ip_address)
def test_parse_string_valid_with_ip_address_but_no_unique_id(self):
self.broker._parse("8883; [c];10.0.0.1 ")
self.assertEqual("", self.broker.unique_id)
self.assertEqual(8883, self.broker.port)
self.assertEqual("c", self.broker.host_name)
self.assertEqual("10.0.0.1", self.broker.ip_address)
def test_parse_url_valid_with_host_name(self):
broker = Broker.parse("mybroker")
self.assertIsInstance(broker, Broker)
self.assertEqual("mybroker", broker.host_name)
def test_parse_url_valid_with_host_name_and_port(self):
broker = Broker.parse("mybroker:8993")
self.assertIsInstance(broker, Broker)
self.assertEqual("mybroker", broker.host_name)
self.assertEqual(8993, broker.port)
def test_parse_url_valid_with_protocol_and_host_name(self):
broker = Broker.parse("ssl://mybroker")
self.assertIsInstance(broker, Broker)
self.assertEqual("mybroker", broker.host_name)
self.assertEqual(8883, broker.port)
def test_parse_url_valid_with_protocol_host_name_and_port(self):
broker = Broker.parse("ssl://mybroker:8993")
self.assertIsInstance(broker, Broker)
self.assertEqual("mybroker", broker.host_name)
self.assertEqual(8993, broker.port)
def test_parse_url_generates_id(self):
broker = Broker.parse("mybroker")
self.assertIsInstance(broker, Broker)
self.assertIsNotNone(broker.unique_id)
self.assertIsNot("", broker.unique_id.strip())
def test_parse_url_valid_with_ipv6_hostname_but_no_port(self):
broker = Broker.parse("[ff02::1]")
self.assertIsInstance(broker, Broker)
self.assertEqual("ff02::1", broker.host_name)
self.assertEqual(8883, broker.port)
def test_parse_url_valid_with_ipv6_hostname_and_port(self):
broker = Broker.parse("[ff02::1]:8993")
self.assertIsInstance(broker, Broker)
self.assertEqual("ff02::1", broker.host_name)
self.assertEqual(8993, broker.port)
def test_attributes(self):
self.assertEqual("", self.broker.unique_id)
self.assertEqual("localhost", self.broker.host_name)
self.assertIsNone(self.broker.ip_address)
self.assertEqual(8883, self.broker.port)
self.assertIsNone(self.broker._response_from_ip_address)
self.assertIsNone(self.broker._response_time)
def test_connect_tries_first_using_hostname(self):
self.broker._parse("broker_guid;8883;broker.fake.com;1.2.3.4")
self.broker._connect_to_broker()
self.assertFalse(self.broker._response_from_ip_address)
self.assertIsNotNone(self.broker._response_time)
self.connection_mock.assert_called_with(('broker.fake.com', 8883),
timeout=ANY)
def test_connect_uses_ip_address_when_connect_to_hostname_fails(self):
self.connection_mock.side_effect = [socket.error, self.socket_mock]
self.broker._parse("broker_guid;8883;broker.fake.com;1.2.3.4")
self.broker._connect_to_broker()
self.assertEqual(2, self.connection_mock.call_count)
self.assertTrue(self.broker._response_from_ip_address)
self.assertIsNotNone(self.broker._response_time)
self.connection_mock.assert_called_with(('1.2.3.4', 8883), timeout=ANY)
def test_close_once(self):
self.broker._parse("broker_guid;8883;broker.fake.com;1.2.3.4")
self.broker._connect_to_broker()
self.assertEqual(1, self.socket_mock.close.call_count)
def test_close_once_when_errors(self):
self.connection_mock.side_effect = [socket.error, self.socket_mock]
self.broker._parse("broker_guid;8883;broker.fake.com;1.2.3.4")
self.broker._connect_to_broker()
self.assertEqual(1, self.socket_mock.close.call_count)
class BrokerTest(unittest.TestCase):
def setUp(self):
self.socket_mock = patch('socket.socket', autospec=True).start()
self.connection_mock = patch('socket.create_connection').start()
self.connection_mock.return_value = self.socket_mock
self.broker = Broker(host_name='localhost')
def tearDown(self):
patch.stopall()
@raises(MalformedBrokerUriException)
def test_parse_invalid_port(self):
self.broker._parse("a ; b; [c] ")
@raises(MalformedBrokerUriException)
def test_parse_missing_hostname(self):
self.broker._parse("a ; b;")
@raises(MalformedBrokerUriException)
def test_parse_port_out_of_range(self):
self.broker._parse("a ; 65536; [c] ")
def test_parse_valid_without_ip_address(self):
self.broker._parse("a ; 8883; [c] ")
self.assertTrue(self.broker.unique_id == "a")
self.assertTrue(self.broker.port == 8883)
self.assertTrue(self.broker.host_name == "c")
@raises(MalformedBrokerUriException)
def test_parse_valid_with_invalid_ip_address(self):
self.broker._parse("a ; 8883; [c];[d] ")
def test_parse_valid_with_iPv4_address(self):
self.broker._parse("a ; 8883; [c];10.0.0.1 ")
self.assertTrue(self.broker.unique_id == "a")
self.assertTrue(self.broker.port == 8883)
self.assertTrue(self.broker.host_name == "c")
self.assertTrue(self.broker.ip_address == "10.0.0.1")
def test_parse_valid_with_iPv6_address(self):
self.broker._parse("a ; 8883; [c];[::1] ")
self.assertTrue(self.broker.unique_id == "a")
self.assertTrue(self.broker.port == 8883)
self.assertTrue(self.broker.host_name == "c")
self.assertTrue(self.broker.ip_address == "::1")
def test_attributes(self):
self.assertEqual(self.broker.unique_id, "")
self.assertEqual(self.broker.host_name, "localhost")
self.assertEqual(self.broker.ip_address, None)
self.assertEqual(self.broker.port, 8883)
self.assertEqual(self.broker._response_from_ip_address, None)
self.assertEqual(self.broker._response_time, None)
def test_connect_tries_first_using_hostname(self):
self.broker._parse("broker_guid;8883;broker.fake.com;1.2.3.4")
self.broker._connect_to_broker()
self.assertEqual(self.broker._response_from_ip_address, False)
self.assertIsNotNone(self.broker._response_time)
self.connection_mock.assert_called_with(('broker.fake.com', 8883), timeout=ANY)
def test_connect_uses_ip_address_when_connect_to_hostname_fails(self):
self.connection_mock.side_effect = [socket.error, self.socket_mock]
self.broker._parse("broker_guid;8883;broker.fake.com;1.2.3.4")
self.broker._connect_to_broker()
self.assertEquals(self.connection_mock.call_count, 2)
self.assertEqual(self.broker._response_from_ip_address, True)
self.assertIsNotNone(self.broker._response_time)
self.connection_mock.assert_called_with(('1.2.3.4', 8883), timeout=ANY)
def test_close_once(self):
self.broker._parse("broker_guid;8883;broker.fake.com;1.2.3.4")
self.broker._connect_to_broker()
self.assertEquals(self.socket_mock.close.call_count, 1)
def test_close_once_when_errors(self):
self.connection_mock.side_effect = [socket.error, self.socket_mock]
self.broker._parse("broker_guid;8883;broker.fake.com;1.2.3.4")
self.broker._connect_to_broker()
self.assertEquals(self.socket_mock.close.call_count, 1)
