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: fix nested one of field handling for protobuf schema dependency verification #689

Merged
merged 1 commit into from
Jul 27, 2023
Merged

fix: fix nested one of field handling for protobuf schema dependency verification #689

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
5 changes: 4 additions & 1 deletion karapace/protobuf/schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,10 @@ def _process_nested_type(

if isinstance(element_type, MessageElement):
for one_of in element_type.one_ofs:
process_one_of(verifier, package_name, parent_name, one_of)
# The parent name for nested one of fields is the parent and element type name.
# The field type name is handled in process_one_of function.
one_of_parent_name = parent_name + "." + element_type.name
process_one_of(verifier, package_name, one_of_parent_name, one_of)
for field in element_type.fields:
verifier.add_used_type(parent_name, field.element_type)
for nested_type in element_type.nested_types:
Expand Down
114 changes: 114 additions & 0 deletions tests/unit/protobuf/test_dependency.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
"""
Copyright (c) 2023 Aiven Ltd
See LICENSE for details
"""
from karapace.protobuf.kotlin_wrapper import trim_margin
from karapace.protobuf.schema import ProtobufSchema


def test_nested_field_one_of_dependency():
"""The nested field may contain nested messages that are referred with one of restriction.
This test is for regression when used types are added and parent name did not include correctly
the nested `Foo`.
The full used type is `.test.FooVal.Foo.Bar`.
"""
proto = """
|syntax = "proto3";
|package test;
|
|option java_multiple_files = true;
|option java_string_check_utf8 = true;
|option java_outer_classname = "FooProto";
|option java_package = "test";
|
|// Comment
|message FooKey {
| // Comment
| string field_a = 1;
|
|}
|
|// Comment
|message FooVal {
| // Comment
| repeated Foo field_a = 1;
|
| // Comment
| string field_b = 2;
|
| // Comment
| message Foo {
|
| // Comment
| message Bar {
| // Comment
| string field_b = 1;
| }
|
| // Comment
| message Bee {
| }
|
| // Comment
| oneof packaging {
| // Comment
| Bar field_h = 2;
|
| // Comment
| Bee field_i = 3;
| }
| }
|}
"""
proto = trim_margin(proto)
pbschema = ProtobufSchema(schema=proto, references=(), dependencies=())
deps = pbschema.verify_schema_dependencies()
assert deps.result, "Dependencies verification failed."


def test_one_of_dependency():
proto = """
|syntax = "proto3";
|package test;
|
|option java_multiple_files = true;
|option java_string_check_utf8 = true;
|option java_outer_classname = "FooProto";
|option java_package = "test";
|
|// Comment
|message FooKey {
| // Comment
| string field_a = 1;
|
|}
|
|// Comment
|message FooVal {
| // Comment
| string field_b = 1;
|
| // Comment
| message Bar {
| // Comment
| string field_b = 1;
| }
|
| // Comment
| message Bee {
| }
|
| // Comment
| oneof packaging {
| // Comment
| Bar field_h = 2;
|
| // Comment
| Bee field_i = 3;
| }
|}
"""
proto = trim_margin(proto)
pbschema = ProtobufSchema(schema=proto, references=(), dependencies=())
deps = pbschema.verify_schema_dependencies()
assert deps.result, "Dependencies verification failed."
Loading