Skip to content

Ministack: Free, open-source local AWS emulator - 60+ services, Terraform compatible, real databases. Free forever. MIT licensed.

fix(sqs): return NextToken from ListQueues when MaxResults is set (#1145)

Bruno7375d04ebe24
diff --git a/ministack/services/sqs.py b/ministack/services/sqs.py
index 0497dd6a..2dd9a525 100644
--- a/ministack/services/sqs.py
+++ b/ministack/services/sqs.py
@@ -415,10 +415,20 @@ def _act_delete_queue(data: dict, qurl: str) -> dict:
def _act_list_queues(data: dict, _u: str) -> dict:
pfx = data.get("QueueNamePrefix", "")
- mx = int(data.get("MaxResults", 1000))
urls = [u for u, q in _queues.items()
if not pfx or q["name"].startswith(pfx)]
- return {"QueueUrls": urls[:mx]}
+ # AWS parity: without MaxResults the response holds up to 1000 results
+ # and never a NextToken; with MaxResults, NextToken is returned whenever
+ # more results remain.
+ max_results = data.get("MaxResults")
+ if max_results is None:
+ return {"QueueUrls": urls[:1000]}
+ mx = int(max_results)
+ start = int(data.get("NextToken") or 0)
+ resp: dict = {"QueueUrls": urls[start:start + mx]}
+ if start + mx < len(urls):
+ resp["NextToken"] = str(start + mx)
+ return resp
def _act_get_queue_url(data: dict, _u: str) -> dict:
@@ -1327,6 +1337,8 @@ def _to_xml(action: str, result: dict) -> tuple:
members = "".join(
f"<QueueUrl>{_esc(u)}</QueueUrl>"
for u in result.get("QueueUrls", []))
+ if "NextToken" in result:
+ members += f"<NextToken>{_esc(result['NextToken'])}</NextToken>"
return _xml_resp(200, "ListQueuesResponse",
f"<ListQueuesResult>{members}</ListQueuesResult>")
@@ -1503,7 +1515,7 @@ def _normalise(action: str, params: dict) -> dict:
for key in ("QueueName", "QueueUrl", "MessageBody", "ReceiptHandle",
"VisibilityTimeout", "DelaySeconds", "WaitTimeSeconds",
"MaxNumberOfMessages", "MaxResults", "QueueNamePrefix",
- "MessageGroupId", "MessageDeduplicationId",
+ "NextToken", "MessageGroupId", "MessageDeduplicationId",
"ReceiveRequestAttemptId"):
v = _p(params, key)
if v:
diff --git a/tests/test_sqs.py b/tests/test_sqs.py
index 35fad882..91e6c6b3 100644
--- a/tests/test_sqs.py
+++ b/tests/test_sqs.py
@@ -61,6 +61,43 @@ def test_sqs_list_queues(sqs):
assert any("intg-sqs-list-alpha" in u for u in urls)
assert any("intg-sqs-list-beta" in u for u in urls)
+def test_sqs_list_queues_paginates_with_max_results(sqs):
+ prefix = f"intg-sqs-page-{_uuid_mod.uuid4().hex[:8]}-"
+ for i in range(5):
+ sqs.create_queue(QueueName=f"{prefix}{i}")
+
+ first = sqs.list_queues(QueueNamePrefix=prefix, MaxResults=2)
+ assert len(first["QueueUrls"]) == 2
+ assert "NextToken" in first
+
+ collected = list(first["QueueUrls"])
+ token = first["NextToken"]
+ while token:
+ page = sqs.list_queues(QueueNamePrefix=prefix, MaxResults=2, NextToken=token)
+ collected.extend(page["QueueUrls"])
+ token = page.get("NextToken")
+
+ assert len(collected) == 5
+ assert len(set(collected)) == 5
+
+
+def test_sqs_list_queues_no_next_token_without_max_results(sqs):
+ prefix = f"intg-sqs-nopage-{_uuid_mod.uuid4().hex[:8]}-"
+ sqs.create_queue(QueueName=f"{prefix}only")
+ resp = sqs.list_queues(QueueNamePrefix=prefix)
+ assert len(resp["QueueUrls"]) == 1
+ assert "NextToken" not in resp
+
+
+def test_sqs_list_queues_no_next_token_on_exact_fit(sqs):
+ prefix = f"intg-sqs-exact-{_uuid_mod.uuid4().hex[:8]}-"
+ for i in range(3):
+ sqs.create_queue(QueueName=f"{prefix}{i}")
+ resp = sqs.list_queues(QueueNamePrefix=prefix, MaxResults=3)
+ assert len(resp["QueueUrls"]) == 3
+ assert "NextToken" not in resp
+
+
def test_sqs_get_queue_url(sqs):
sqs.create_queue(QueueName="intg-sqs-geturl")
resp = sqs.get_queue_url(QueueName="intg-sqs-geturl")