def setUp(self):
self.queue = "test_queue"
self.host1 = "host1"
self.host2 = "host2"
self.port = 5672
self.submitter = RabbitMQSubmitter(
host=self.host1, secondary_host=self.host2, port=self.port, queue=self.queue
)
def setup_submitter(application):
if application.config["EQ_SUBMISSION_BACKEND"] == "gcs":
bucket_name = application.config.get("EQ_GCS_SUBMISSION_BUCKET_ID")
if not bucket_name:
raise Exception("Setting EQ_GCS_SUBMISSION_BUCKET_ID Missing")
application.eq["submitter"] = GCSSubmitter(bucket_name=bucket_name)
elif application.config["EQ_SUBMISSION_BACKEND"] == "rabbitmq":
host = application.config.get("EQ_RABBITMQ_HOST")
secondary_host = application.config.get("EQ_RABBITMQ_HOST_SECONDARY")
if not host:
raise Exception("Setting EQ_RABBITMQ_HOST Missing")
if not secondary_host:
raise Exception("Setting EQ_RABBITMQ_HOST_SECONDARY Missing")
application.eq["submitter"] = RabbitMQSubmitter(
host=host,
secondary_host=secondary_host,
port=application.config["EQ_RABBITMQ_PORT"],
queue=application.config["EQ_RABBITMQ_QUEUE_NAME"],
username=application.eq["secret_store"].get_secret_by_name(
"EQ_RABBITMQ_USERNAME"),
password=application.eq["secret_store"].get_secret_by_name(
"EQ_RABBITMQ_PASSWORD"),
)
elif application.config["EQ_SUBMISSION_BACKEND"] == "log":
application.eq["submitter"] = LogSubmitter()
else:
raise Exception("Unknown EQ_SUBMISSION_BACKEND")
def test_url_generation_with_credentials(self):
# Given
with patch("app.submitter.submitter.BlockingConnection") as connection, patch(
"app.submitter.submitter.URLParameters"
) as url_parameters:
secondary_connection = Mock()
connection.side_effect = [AMQPError(), secondary_connection]
username = "******"
password = str(uuid.uuid4())
submitter = RabbitMQSubmitter(
host=self.host1,
secondary_host=self.host2,
port=self.port,
queue=self.queue,
username=username,
password=password,
)
# When
published = submitter.send_message(
message={},
tx_id="12345",
questionnaire_id="0123456789000000",
case_id="456",
)
# Then
self.assertTrue(published, "send_message should publish message")
# Check we create url for primary then secondary
url_parameters_calls = [
call(
"amqp://{}:{}@{}:{}/%2F".format(
username, password, self.host1, self.port
)
),
call(
"amqp://{}:{}@{}:{}/%2F".format(
username, password, self.host2, self.port
)
),
]
url_parameters.assert_has_calls(url_parameters_calls)
# Check we create connection twice, failing first then with self.url2
self.assertEqual(connection.call_count, 2)
class TestRabbitMQSubmitter(TestCase):
def setUp(self):
self.queue = "test_queue"
self.host1 = "host1"
self.host2 = "host2"
self.port = 5672
self.submitter = RabbitMQSubmitter(host=self.host1,
secondary_host=self.host2,
port=self.port,
queue=self.queue)
def test_when_fail_to_connect_to_queue_then_published_false(self):
# Given
with patch("app.submitter.submitter.BlockingConnection") as connection:
connection.side_effect = AMQPError()
# When
published = self.submitter.send_message(
message={},
tx_id="123",
case_id="456",
)
# Then
self.assertFalse(published,
"send_message should fail to publish message")
def test_when_message_sent_then_published_true(self):
# Given
with patch("app.submitter.submitter.BlockingConnection"):
published = self.submitter.send_message(
message={},
tx_id="123",
case_id="456",
)
# When
# Then
self.assertTrue(published, "send_message should publish message")
def test_when_first_connection_fails_then_secondary_succeeds(self):
# Given
with patch(
"app.submitter.submitter.BlockingConnection"
) as connection, patch(
"app.submitter.submitter.URLParameters") as url_parameters:
secondary_connection = Mock()
connection.side_effect = [AMQPError(), secondary_connection]
# When
published = self.submitter.send_message(
message={},
tx_id="12345",
case_id="456",
)
# Then
self.assertTrue(published, "send_message should publish message")
# Check we create url for primary then secondary
url_parameters_calls = [
call(f"amqp://{self.host1}:{self.port}/%2F"),
call(f"amqp://{self.host2}:{self.port}/%2F"),
]
url_parameters.assert_has_calls(url_parameters_calls)
# Check we create connection twice, failing first then with self.url2
self.assertEqual(connection.call_count, 2)
def test_url_generation_with_credentials(self):
# Given
with patch(
"app.submitter.submitter.BlockingConnection"
) as connection, patch(
"app.submitter.submitter.URLParameters") as url_parameters:
secondary_connection = Mock()
connection.side_effect = [AMQPError(), secondary_connection]
username = "******"
password = str(uuid.uuid4())
submitter = RabbitMQSubmitter(
host=self.host1,
secondary_host=self.host2,
port=self.port,
queue=self.queue,
username=username,
password=password,
)
# When
published = submitter.send_message(
message={},
tx_id="12345",
case_id="456",
)
# Then
self.assertTrue(published, "send_message should publish message")
# Check we create url for primary then secondary
url_parameters_calls = [
call(
f"amqp://{username}:{password}@{self.host1}:{self.port}/%2F"
),
call(
f"amqp://{username}:{password}@{self.host2}:{self.port}/%2F"
),
]
url_parameters.assert_has_calls(url_parameters_calls)
# Check we create connection twice, failing first then with self.url2
self.assertEqual(connection.call_count, 2)
def test_when_fail_to_disconnect_then_log_warning_message(self):
# Given
connection = Mock()
error = AMQPError()
connection.close.side_effect = [error]
with patch("app.submitter.submitter.BlockingConnection",
return_value=connection), patch(
"app.submitter.submitter.logger") as logger:
# When
published = self.submitter.send_message(
message={},
tx_id="123",
case_id="456",
)
# Then
self.assertTrue(published)
logger.error.assert_called_once_with("unable to close connection",
category="rabbitmq",
exc_info=error)
def test_when_fail_to_publish_message_then_returns_false(self):
# Given
channel = Mock()
channel.basic_publish = Mock(
side_effect=NackError("Mock exception for basic_publish"))
connection = Mock()
connection.channel.side_effect = Mock(return_value=channel)
with patch("app.submitter.submitter.BlockingConnection",
return_value=connection):
# When
published = self.submitter.send_message(
message={},
tx_id="123",
case_id="456",
)
# Then
self.assertFalse(published,
"send_message should fail to publish message")
def test_when_message_sent_then_metadata_is_sent_in_header(self):
# Given
channel = Mock()
connection = Mock()
connection.channel.side_effect = Mock(return_value=channel)
with patch("app.submitter.submitter.BlockingConnection",
return_value=connection):
# When
self.submitter.send_message(
message={},
tx_id="12345",
case_id="98765",
)
# Then
call_args = channel.basic_publish.call_args
properties = call_args[1]["properties"]
headers = properties.headers
self.assertEqual(headers["tx_id"], "12345")
self.assertEqual(headers["case_id"], "98765")