Skip to content

Commit 1e97404

Browse files
darshjoshibpandola
andauthored
SQS: fix pagination for ListQueues (#10348)
Co-authored-by: Brian Pandola <[email protected]>
1 parent 5cab9c9 commit 1e97404

3 files changed

Lines changed: 49 additions & 5 deletions

File tree

‎moto/sqs/models.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -744,7 +744,7 @@ def list_queues(self, queue_name_prefix: str) -> list[Queue]:
744744
for name, q in self.queues.items():
745745
if prefix_re.search(name):
746746
qs.append(q)
747-
return qs[:1000]
747+
return qs
748748

749749
def get_queue(self, queue_name: str) -> Queue:
750750
queue = self.queues.get(queue_name)

‎moto/sqs/responses.py‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22
from typing import Any
33
from urllib.parse import urlparse
44

5-
from moto.core.responses import ActionResult, BaseResponse, EmptyResult
5+
from moto.core.responses import (
6+
ActionResult,
7+
BaseResponse,
8+
EmptyResult,
9+
PaginatedResult,
10+
)
611

712
from .constants import (
813
DEFAULT_RECEIVED_MESSAGES,
@@ -84,9 +89,11 @@ def list_queues(self) -> ActionResult:
8489
request_url = urlparse(self.uri)
8590
queue_name_prefix = self._get_param("QueueNamePrefix")
8691
queues = self.sqs_backend.list_queues(queue_name_prefix)
87-
result = {}
88-
if queues:
89-
result["QueueUrls"] = [queue.url(request_url) for queue in queues]
92+
queue_urls = [queue.url(request_url) for queue in queues]
93+
# AWS only paginates (and returns a NextToken) if MaxResults was supplied
94+
if self._get_param("MaxResults"):
95+
return PaginatedResult({"QueueUrls": queue_urls})
96+
result = {"QueueUrls": queue_urls[:1000]} if queue_urls else {}
9097
return ActionResult(result)
9198

9299
def change_message_visibility(self) -> ActionResult:

‎tests/test_sqs/test_sqs.py‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2922,6 +2922,43 @@ def test_receive_message_for_queue_with_receive_message_wait_time_seconds_set():
29222922
queue.receive_messages()
29232923

29242924

2925+
@mock_aws
2926+
def test_list_queues_paginated():
2927+
client = boto3.client("sqs", region_name=REGION)
2928+
2929+
prefix = str(uuid4())[0:6]
2930+
queue_urls = [
2931+
client.create_queue(QueueName=f"{prefix}-{i}")["QueueUrl"] for i in range(5)
2932+
]
2933+
2934+
page1 = client.list_queues(QueueNamePrefix=prefix, MaxResults=2)
2935+
assert page1["QueueUrls"] == queue_urls[0:2]
2936+
assert "NextToken" in page1
2937+
2938+
page2 = client.list_queues(
2939+
QueueNamePrefix=prefix, MaxResults=2, NextToken=page1["NextToken"]
2940+
)
2941+
assert page2["QueueUrls"] == queue_urls[2:4]
2942+
assert "NextToken" in page2
2943+
2944+
page3 = client.list_queues(
2945+
QueueNamePrefix=prefix, MaxResults=2, NextToken=page2["NextToken"]
2946+
)
2947+
assert page3["QueueUrls"] == queue_urls[4:]
2948+
assert "NextToken" not in page3
2949+
2950+
# NextToken is only returned when MaxResults is supplied
2951+
assert "NextToken" not in client.list_queues(QueueNamePrefix=prefix)
2952+
2953+
paginator = client.get_paginator("list_queues")
2954+
pages = paginator.paginate(QueueNamePrefix=prefix, PaginationConfig={"PageSize": 2})
2955+
assert [page["QueueUrls"] for page in pages] == [
2956+
queue_urls[0:2],
2957+
queue_urls[2:4],
2958+
queue_urls[4:],
2959+
]
2960+
2961+
29252962
@mock_aws
29262963
def test_list_queues_limits_to_1000_queues():
29272964
if settings.TEST_SERVER_MODE:

0 commit comments

Comments
 (0)