Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: return "messages" instead "incompatibilities" from compatibility API #975

Merged
merged 1 commit into from
Oct 16, 2024
Merged

fix: return "messages" instead "incompatibilities" from compatibility API #975

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/karapace/schema_registry_apis.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,8 +412,7 @@ async def compatibility_check(
result = SchemaCompatibility.check_compatibility(old_schema, new_schema, compatibility_mode)

if is_incompatible(result):
maybe_truncated_error = ", ".join(result.messages)[:300]
self.r({"is_compatible": False, "incompatibilities": maybe_truncated_error}, content_type)
self.r({"is_compatible": False, "messages": list(result.messages)}, content_type)
self.r({"is_compatible": True}, content_type)

async def schemas_list(self, content_type: str, *, request: HTTPRequest, user: User | None = None):
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/test_schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ async def test_compatibility_endpoint(registry_async_client: Client, trail: str)
)
assert res.status_code == 200
assert res.json().get("is_compatible") is False
assert res.json().get("incompatibilities") == "reader type: string not compatible with writer type: int"
assert res.json().get("messages") == ["reader type: string not compatible with writer type: int"]


@pytest.mark.parametrize("trail", ["", "/"])
Expand Down
12 changes: 6 additions & 6 deletions tests/integration/test_schema_compatibility.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ class SchemaCompatibilityTestCase(BaseTestCase):
register_baseline_schemas: SchemaRegitrationFunc
expected_is_compatible: bool | None
expected_status_code: int
expected_incompatibilities: str | None
expected_incompatibilities: list[str] | None


async def _register_baseline_schemas_no_incompatibilities(registry_async_client: Client, subject: Subject) -> None:
Expand Down Expand Up @@ -149,7 +149,7 @@ async def _set_compatibility_mode(registry_async_client: Client, subject: Subjec
new_schema=json.dumps(schema_int),
expected_is_compatible=False,
expected_status_code=200,
expected_incompatibilities="reader type: int not compatible with writer type: double",
expected_incompatibilities=["reader type: int not compatible with writer type: double"],
),
# Case 3
# Same as previous case, but in non-transitive mode
Expand All @@ -161,7 +161,7 @@ async def _set_compatibility_mode(registry_async_client: Client, subject: Subjec
new_schema=json.dumps(schema_int),
expected_is_compatible=False,
expected_status_code=200,
expected_incompatibilities="reader type: int not compatible with writer type: string",
expected_incompatibilities=["reader type: int not compatible with writer type: string"],
),
# Case 4
# Same as case 2, but with a deleted schema among baseline ones
Expand All @@ -175,7 +175,7 @@ async def _set_compatibility_mode(registry_async_client: Client, subject: Subjec
new_schema=json.dumps(schema_int),
expected_is_compatible=False,
expected_status_code=200,
expected_incompatibilities="reader type: int not compatible with writer type: double",
expected_incompatibilities=["reader type: int not compatible with writer type: double"],
),
# Case 5
# Same as case 3, but with a deleted schema among baseline ones
Expand All @@ -188,7 +188,7 @@ async def _set_compatibility_mode(registry_async_client: Client, subject: Subjec
new_schema=json.dumps(schema_int),
expected_is_compatible=False,
expected_status_code=200,
expected_incompatibilities="reader type: int not compatible with writer type: string",
expected_incompatibilities=["reader type: int not compatible with writer type: string"],
),
# Case 6
# A new schema and no baseline schemas
Expand Down Expand Up @@ -232,4 +232,4 @@ async def test_schema_compatibility(test_case: SchemaCompatibilityTestCase, regi

assert res.status_code == test_case.expected_status_code
assert res.json().get("is_compatible") == test_case.expected_is_compatible
assert res.json().get("incompatibilities", None) == test_case.expected_incompatibilities
assert res.json().get("messages") == test_case.expected_incompatibilities
Loading