[HDDS-3595] Add a maven proto file backward compatibility checker into Ozone.

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.0.0
• Labels: pull-request-available
• Assignee: Mukul Kumar Singh
• Reporter: Mukul Kumar Singh
• Created: 15/May/20 11:08
• Updated: 19/May/20 10:30
• Resolved: 19/May/20 10:07

Description

The plugin proto-backwards-compat-maven-plugin flags incompatible protobuf changes.

cc arp avijayan elek

https://github.com/salesforce/proto-backwards-compat-maven-plugin
and
https://mvnrepository.com/artifact/com.salesforce.servicelibs/proto-backwards-compatibility

To test, I modified the following code in proto

diff --git a/hadoop-ozone/csi/src/main/proto/csi.proto b/hadoop-ozone/csi/src/main/proto/csi.proto
index 3bd53a075..b8a984de2 100644
--- a/hadoop-ozone/csi/src/main/proto/csi.proto
+++ b/hadoop-ozone/csi/src/main/proto/csi.proto
@@ -119,7 +119,7 @@ message GetPluginInfoResponse {
   // characters or less, beginning and ending with an alphanumeric
   // character ([a-z0-9A-Z]) with dashes (-), dots (.), and
   // alphanumerics between. This field is REQUIRED.
-  string name = 1;
+  string newName = 1;

and this flagged the following change

[ERROR] CONFLICT: "GetPluginInfoResponse" field: "name" has been removed, but is not reserved [csi.proto]
[ERROR] CONFLICT: "GetPluginInfoResponse" field: "newName" ID: 1 has an updated name, previously "name" [csi.proto]

Issue Links

• links to: GitHub Pull Request #924