8000 Clarify coverage error messages to distinguish license and emulation … · localstack/localstack@49dcd93 · GitHub
[go: up one dir, main page]
Skip to content

Commit 49dcd93

Browse files
MEPalmaMEPalma
authored
Clarify coverage error messages to distinguish license and emulation limits (#12547)
1 parent 560b4cb commit 49dcd93

File tree

3 files changed

+28
-21
lines changed

3 files changed

+28
-21
lines changed

‎localstack-core/localstack/utils/coverage_docs.py

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
COVERAGE_LINK_BASE = "https://docs.localstack.cloud/references/coverage/"
2-
MESSAGE_TEMPLATE = (
3-
f"API %sfor service '%s' not yet implemented or pro feature"
4-
f" - please check {COVERAGE_LINK_BASE}%s for further information"
5-
)
1+
_COVERAGE_LINK_BASE = "https://docs.localstack.cloud/references/coverage"
62

73

84
def get_coverage_link_for_service(service_name: str, action_name: str) -> str:
@@ -11,11 +7,14 @@ def get_coverage_link_for_service(service_name: str, action_name: str) -> str:
117
available_services = SERVICE_PLUGINS.list_available()
128

139
if service_name not in available_services:
14-
return MESSAGE_TEMPLATE % ("", service_name, "")
15-
10+
return (
11+
f"The API for service '{service_name}' is either not included in your current license plan "
12+
"or has not yet been emulated by LocalStack. "
13+
f"Please refer to {_COVERAGE_LINK_BASE} for more details."
14+
)
1615
else:
17-
return MESSAGE_TEMPLATE % (
18-
f"action '{action_name}' ",
19-
service_name,
20-
f"coverage_{service_name}/",
16+
return (
17+
f"The API action '{action_name}' for service '{service_name}' is either not available in "
18+
"your current license plan or has not yet been emulated by LocalStack. "
19+
f"Please refer to {_COVERAGE_LINK_BASE}/coverage_{service_name} for more information."
2120
)

‎tests/unit/aws/test_skeleton.py

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -200,8 +200,11 @@ def test_skeleton_e2e_sqs_send_message():
200200
[
201201
(
202202
TestSqsApiNotImplemented(),
203-
"API action 'SendMessage' for service 'sqs' not yet implemented or pro feature"
204-
" - please check https://docs.localstack.cloud/references/coverage/coverage_sqs/ for further information",
203+
(
204+
"The API action 'SendMessage' for service 'sqs' is either not available "
205+
"in your current license plan or has not yet been emulated by LocalStack. "
206+
"Please refer to https://docs.localstack.cloud/references/coverage/coverage_sqs for more information."
207+
),
205208
),
206209
(
207210
TestSqsApiNotImplementedWithMessage(),
@@ -312,8 +315,11 @@ def test_dispatch_missing_method_returns_internal_failure():
312315
assert "Error" in parsed_response
313316
assert parsed_response["Error"] == {
314317
"Code": "InternalFailure",
315-
"Message": "API action 'DeleteQueue' for service 'sqs' not yet implemented or pro feature - please check "
316-
"https://docs.localstack.cloud/references/coverage/coverage_sqs/ for further information",
318+
"Message": (
319+
"The API action 'DeleteQueue' for service 'sqs' is either not available in your "
320+
"current license plan or has not yet been emulated by LocalStack. "
321+
"Please refer to https://docs.localstack.cloud/references/coverage/coverage_sqs for more information."
322+
),
317323
}
318324

319325

‎tests/unit/utils/test_coverage_docs.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,17 @@
33

44
def test_coverage_link_for_existing_service():
55
coverage_link = get_coverage_link_for_service("s3", "random_action")
6-
assert (
7-
coverage_link
8-
== "API action 'random_action' for service 's3' not yet implemented or pro feature - please check https://docs.localstack.cloud/references/coverage/coverage_s3/ for further information"
6+
assert coverage_link == (
7+
"The API action 'random_action' for service 's3' is either not available in your current "
8+
"license plan or has not yet been emulated by LocalStack. "
9+
"Please refer to https://docs.localstack.cloud/references/coverage/coverage_s3 for more information."
910
)
1011

1112

1213
def test_coverage_link_for_non_existing_service():
1314
coverage_link = get_coverage_link_for_service("dummy_service", "random_action")
14-
assert (
15-
coverage_link
16-
== "API for service 'dummy_service' not yet implemented or pro feature - please check https://docs.localstack.cloud/references/coverage/ for further information"
15+
assert coverage_link == (
16+
"The API for service 'dummy_service' is either not included in your current license plan or "
17+
"has not yet been emulated by LocalStack. "
18+
"Please refer to https://docs.localstack.cloud/references/coverage for more details."
1719
)

0 commit comments

Comments
 (0)
0