# # Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file # distributed with this work for additional information # regarding copyright ownership. The ASF licenses this file # to you under the Apache License, Version 2.0 (the # "License"); you may not use this file except in compliance # with the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. # from __future__ import absolute_import from qpid.client import Client, Closed from qpid.queue import Empty from qpid.content import Content from qpid.testlib import TestBase class BasicTests(TestBase): """Tests for 'methods' on the amqp basic 'class'""" def test_consume_no_local(self): """ Test that the no_local flag is honoured in the consume method """ channel = self.channel #setup, declare two queues: channel.queue_declare(queue="test-queue-1a", exclusive=True) channel.queue_declare(queue="test-queue-1b", exclusive=True) #establish two consumers one of which excludes delivery of locally sent messages channel.basic_consume(consumer_tag="local_included", queue="test-queue-1a") channel.basic_consume(consumer_tag="local_excluded", queue="test-queue-1b", no_local=True) #send a message channel.basic_publish(routing_key="test-queue-1a", content=Content("consume_no_local")) channel.basic_publish(routing_key="test-queue-1b", content=Content("consume_no_local")) #check the queues of the two consumers excluded = self.client.queue("local_excluded") included = self.client.queue("local_included") msg = included.get(timeout=self.recv_timeout()) self.assertEqual("consume_no_local", msg.content.body) try: excluded.get(timeout=self.recv_timeout()) self.fail("Received locally published message though no_local=true") except Empty: None def test_consume_exclusive(self): """ Test that the exclusive flag is honoured in the consume method """ channel = self.channel #setup, declare a queue: channel.queue_declare(queue="test-queue-2", exclusive=True) #check that an exclusive consumer prevents other consumer being created: channel.basic_consume(consumer_tag="first", queue="test-queue-2", exclusive=True) try: channel.basic_consume(consumer_tag="second", queue="test-queue-2") self.fail("Expected consume request to fail due to previous exclusive consumer") except Closed as e: self.assertChannelException(403, e.args[0]) #open new channel and cleanup last consumer: channel = self.client.channel(2) channel.channel_open() #check that an exclusive consumer cannot be created if a consumer already exists: channel.basic_consume(consumer_tag="first", queue="test-queue-2") try: channel.basic_consume(consumer_tag="second", queue="test-queue-2", exclusive=True) self.fail("Expected exclusive consume request to fail due to previous consumer") except Closed as e: self.assertChannelException(403, e.args[0]) def test_reconnect_to_durable_subscription(self): try: publisherchannel = self.channel my_id = "my_id" consumer_connection_properties_with_instance = {"instance": my_id} queue_for_subscription = "queue_for_subscription_%s" % my_id topic_name = "my_topic_name" test_message = self.uniqueString() durable_subscription_client = self.connect(client_properties=consumer_connection_properties_with_instance) consumerchannel = durable_subscription_client.channel(1) consumerchannel.channel_open() self._declare_and_bind_exclusive_queue_on_topic_exchange(consumerchannel, queue_for_subscription, topic_name) # disconnect durable_subscription_client.close() # send message to topic publisherchannel.basic_publish(routing_key=topic_name, exchange="amq.topic", content=Content(test_message)) # reconnect and consume message durable_subscription_client = self.connect(client_properties=consumer_connection_properties_with_instance) consumerchannel = durable_subscription_client.channel(1) consumerchannel.channel_open() self._declare_and_bind_exclusive_queue_on_topic_exchange(consumerchannel, queue_for_subscription, topic_name) # Create consumer and consume the message that was sent whilst subscriber was disconnected. By convention we # declare the consumer as exclusive to forbid concurrent access. subscription = consumerchannel.basic_consume(queue=queue_for_subscription, exclusive=True) queue = durable_subscription_client.queue(subscription.consumer_tag) # consume and verify message content msg = queue.get(timeout=self.recv_timeout()) self.assertEqual(test_message, msg.content.body) consumerchannel.basic_ack(delivery_tag=msg.delivery_tag) finally: consumerchannel.queue_delete(queue=queue_for_subscription) durable_subscription_client.close() def _declare_and_bind_exclusive_queue_on_topic_exchange(self, channel, queue, topic_name): channel.queue_declare(queue=queue, exclusive=True, auto_delete=False, durable=True) channel.queue_bind(exchange="amq.topic", queue=queue, routing_key=topic_name) def test_consume_queue_errors(self): """ Test error conditions associated with the queue field of the consume method: """ channel = self.channel try: #queue specified but doesn't exist: channel.basic_consume(queue="invalid-queue") self.fail("Expected failure when consuming from non-existent queue") except Closed as e: self.assertChannelException(404, e.args[0]) channel = self.client.channel(2) channel.channel_open() try: #queue not specified and none previously declared for channel: channel.basic_consume(queue="") self.fail("Expected failure when consuming from unspecified queue") except Closed as e: self.assertConnectionException(530, e.args[0]) def test_consume_unique_consumers(self): """ Ensure unique consumer tags are enforced """ channel = self.channel #setup, declare a queue: channel.queue_declare(queue="test-queue-3", exclusive=True) #check that attempts to use duplicate tags are detected and prevented: channel.basic_consume(consumer_tag="first", queue="test-queue-3") try: channel.basic_consume(consumer_tag="first", queue="test-queue-3") self.fail("Expected consume request to fail due to non-unique tag") except Closed as e: self.assertConnectionException(530, e.args[0]) def test_cancel(self): """ Test compliance of the basic.cancel method """ channel = self.channel #setup, declare a queue: channel.queue_declare(queue="test-queue-4", exclusive=True) channel.basic_consume(consumer_tag="my-consumer", queue="test-queue-4") channel.basic_publish(routing_key="test-queue-4", content=Content("One")) myqueue = self.client.queue("my-consumer") msg = myqueue.get(timeout=self.recv_timeout()) self.assertEqual("One", msg.content.body) #cancel should stop messages being delivered channel.basic_cancel(consumer_tag="my-consumer") channel.basic_publish(routing_key="test-queue-4", content=Content("Two")) try: msg = myqueue.get(timeout=self.recv_timeout()) self.fail("Got message after cancellation: " + msg) except Empty: None #cancellation of non-existant consumers should be handled without error channel.basic_cancel(consumer_tag="my-consumer") channel.basic_cancel(consumer_tag="this-never-existed") def test_ack(self): """ Test basic ack/recover behaviour """ channel = self.channel channel.queue_declare(queue="test-ack-queue", exclusive=True) reply = channel.basic_consume(queue="test-ack-queue", no_ack=False) queue = self.client.queue(reply.consumer_tag) channel.basic_publish(routing_key="test-ack-queue", content=Content("One")) channel.basic_publish(routing_key="test-ack-queue", content=Content("Two")) channel.basic_publish(routing_key="test-ack-queue", content=Content("Three")) channel.basic_publish(routing_key="test-ack-queue", content=Content("Four")) channel.basic_publish(routing_key="test-ack-queue", content=Content("Five")) msg1 = queue.get(timeout=self.recv_timeout()) msg2 = queue.get(timeout=self.recv_timeout()) msg3 = queue.get(timeout=self.recv_timeout()) msg4 = queue.get(timeout=self.recv_timeout()) msg5 = queue.get(timeout=self.recv_timeout()) self.assertEqual("One", msg1.content.body) self.assertEqual("Two", msg2.content.body) self.assertEqual("Three", msg3.content.body) self.assertEqual("Four", msg4.content.body) self.assertEqual("Five", msg5.content.body) channel.basic_ack(delivery_tag=msg2.delivery_tag, multiple=True) #One & Two channel.basic_ack(delivery_tag=msg4.delivery_tag, multiple=False) #Four channel.basic_recover(requeue=False) msg3b = queue.get(timeout=self.recv_timeout()) msg5b = queue.get(timeout=self.recv_timeout()) self.assertEqual("Three", msg3b.content.body) self.assertEqual("Five", msg5b.content.body) try: extra = queue.get(timeout=self.recv_timeout()) self.fail("Got unexpected message: " + extra.content.body) except Empty: None def test_recover_requeue(self): """ Test requeing on recovery """ channel = self.channel channel.queue_declare(queue="test-requeue", exclusive=True) subscription = channel.basic_consume(queue="test-requeue", no_ack=False) queue = self.client.queue(subscription.consumer_tag) channel.basic_publish(routing_key="test-requeue", content=Content("One")) channel.basic_publish(routing_key="test-requeue", content=Content("Two")) channel.basic_publish(routing_key="test-requeue", content=Content("Three")) channel.basic_publish(routing_key="test-requeue", content=Content("Four")) channel.basic_publish(routing_key="test-requeue", content=Content("Five")) msg1 = queue.get(timeout=self.recv_timeout()) msg2 = queue.get(timeout=self.recv_timeout()) msg3 = queue.get(timeout=self.recv_timeout()) msg4 = queue.get(timeout=self.recv_timeout()) msg5 = queue.get(timeout=self.recv_timeout()) self.assertEqual("One", msg1.content.body) self.assertEqual("Two", msg2.content.body) self.assertEqual("Three", msg3.content.body) self.assertEqual("Four", msg4.content.body) self.assertEqual("Five", msg5.content.body) channel.basic_ack(delivery_tag=msg2.delivery_tag, multiple=True) #One & Two channel.basic_ack(delivery_tag=msg4.delivery_tag, multiple=False) #Four channel.basic_cancel(consumer_tag=subscription.consumer_tag) channel.basic_recover(requeue=True) subscription2 = channel.basic_consume(queue="test-requeue") queue2 = self.client.queue(subscription2.consumer_tag) msg3b = queue2.get(timeout=self.recv_timeout()) msg5b = queue2.get(timeout=self.recv_timeout()) self.assertEqual("Three", msg3b.content.body) self.assertEqual("Five", msg5b.content.body) self.assertEqual(True, msg3b.redelivered) self.assertEqual(True, msg5b.redelivered) try: extra = queue2.get(timeout=self.recv_timeout()) self.fail("Got unexpected message in second queue: " + extra.content.body) except Empty: None try: extra = queue.get(timeout=self.recv_timeout()) self.fail("Got unexpected message in original queue: " + extra.content.body) except Empty: None def test_qos_prefetch_count(self): """ Test that the prefetch count specified is honoured """ #setup: declare queue and subscribe channel = self.channel channel.queue_declare(queue="test-prefetch-count", exclusive=True) subscription = channel.basic_consume(queue="test-prefetch-count", no_ack=False) queue = self.client.queue(subscription.consumer_tag) #set prefetch to 5: channel.basic_qos(prefetch_count=5) #publish 10 messages: for i in range(1, 11): channel.basic_publish(routing_key="test-prefetch-count", content=Content("Message %d" % i)) #only 5 messages should have been delivered: for i in range(1, 6): msg = queue.get(timeout=self.recv_timeout()) self.assertEqual("Message %d" % i, msg.content.body) try: extra = queue.get(timeout=self.recv_timeout()) self.fail("Got unexpected 6th message in original queue: " + extra.content.body) except Empty: None #ack messages and check that the next set arrive ok: channel.basic_ack(delivery_tag=msg.delivery_tag, multiple=True) for i in range(6, 11): msg = queue.get(timeout=self.recv_timeout()) self.assertEqual("Message %d" % i, msg.content.body) channel.basic_ack(delivery_tag=msg.delivery_tag, multiple=True) try: extra = queue.get(timeout=self.recv_timeout()) self.fail("Got unexpected 11th message in original queue: " + extra.content.body) except Empty: None def test_qos_prefetch_size(self): """ Test that the prefetch size specified is honoured """ #setup: declare queue and subscribe channel = self.channel channel.queue_declare(queue="test-prefetch-size", exclusive=True) subscription = channel.basic_consume(queue="test-prefetch-size", no_ack=False) queue = self.client.queue(subscription.consumer_tag) #set prefetch to 50 bytes (each message is 9 or 10 bytes): channel.basic_qos(prefetch_size=50) #publish 10 messages: for i in range(1, 11): channel.basic_publish(routing_key="test-prefetch-size", content=Content("Message %d" % i)) #only 5 messages should have been delivered (i.e. 45 bytes worth): for i in range(1, 6): msg = queue.get(timeout=self.recv_timeout()) self.assertEqual("Message %d" % i, msg.content.body) try: extra = queue.get(timeout=self.recv_timeout()) self.fail("Got unexpected 6th message in original queue: " + extra.content.body) except Empty: None #ack messages and check that the next set arrive ok: channel.basic_ack(delivery_tag=msg.delivery_tag, multiple=True) for i in range(6, 11): msg = queue.get(timeout=self.recv_timeout()) self.assertEqual("Message %d" % i, msg.content.body) channel.basic_ack(delivery_tag=msg.delivery_tag, multiple=True) try: extra = queue.get(timeout=self.recv_timeout()) self.fail("Got unexpected 11th message in original queue: " + extra.content.body) except Empty: None #make sure that a single oversized message still gets delivered large = "abcdefghijklmnopqrstuvwxyz" large = large + "-" + large channel.basic_publish(routing_key="test-prefetch-size", content=Content(large)) msg = queue.get(timeout=self.recv_timeout()) self.assertEqual(large, msg.content.body) def test_get(self): """ Test basic_get method """ channel = self.channel channel.queue_declare(queue="test-get", exclusive=True) #publish some messages (no_ack=True) for i in range(1, 11): channel.basic_publish(routing_key="test-get", content=Content("Message %d" % i)) #use basic_get to read back the messages, and check that we get an empty at the end for i in range(1, 11): reply = channel.basic_get(no_ack=True) self.assertEqual(reply.method.klass.name, "basic") self.assertEqual(reply.method.name, "get_ok") self.assertEqual("Message %d" % i, reply.content.body) reply = channel.basic_get(no_ack=True) self.assertEqual(reply.method.klass.name, "basic") self.assertEqual(reply.method.name, "get_empty") #repeat for no_ack=False for i in range(11, 21): channel.basic_publish(routing_key="test-get", content=Content("Message %d" % i)) for i in range(11, 21): reply = channel.basic_get(no_ack=False) self.assertEqual(reply.method.klass.name, "basic") self.assertEqual(reply.method.name, "get_ok") self.assertEqual("Message %d" % i, reply.content.body) if(i == 13): channel.basic_ack(delivery_tag=reply.delivery_tag, multiple=True) if(i in [15, 17, 19]): channel.basic_ack(delivery_tag=reply.delivery_tag) reply = channel.basic_get(no_ack=True) self.assertEqual(reply.method.klass.name, "basic") self.assertEqual(reply.method.name, "get_empty") #recover(requeue=True) channel.basic_recover(requeue=True) #get the unacked messages again (14, 16, 18, 20) for i in [14, 16, 18, 20]: reply = channel.basic_get(no_ack=False) self.assertEqual(reply.method.klass.name, "basic") self.assertEqual(reply.method.name, "get_ok") self.assertEqual("Message %d" % i, reply.content.body) channel.basic_ack(delivery_tag=reply.delivery_tag) reply = channel.basic_get(no_ack=True) self.assertEqual(reply.method.klass.name, "basic") self.assertEqual(reply.method.name, "get_empty") channel.basic_recover(requeue=True) reply = channel.basic_get(no_ack=True) self.assertEqual(reply.method.klass.name, "basic") self.assertEqual(reply.method.name, "get_empty")