[YETUS-1151] New Yetus check for `.proto` files

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: Precommit
• Assignee: Unassigned
• Reporter: Yongkang Li
• Created: 15/Dec/21 06:04
• Updated: 30/Apr/22 00:53

Description

Regarding some issues caused by the incompatibility of protobuf message, we have created a static checker which keeps track of the proto file change, and detects potential incompatibility:

1. Add/delete required fields.
2. The tag number of a field has been changed.
3. A  required field has been changed to optional, or an optional field has been changed to required.

We have tested the checker on HBASE and found many potential problems. We created HBASE-25340 (you can find more detailed information in this issue) and maintainers suggest that we could get the tool added as a new Yetus check so that it could be easily integrated into HBase and Hadoop CI testing.

Repository of our static checker: https://github.com/YongkangLi/ProtoBufChecker.