[HBASE-12556] Create a golden file for testing client API source/binary compatibility

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Won't Fix
• Component/s: Client
• Assignee: Unassigned
• Reporter: Enis Soztutar
• Created: 21/Nov/14 19:32
• Updated: 16/Jun/22 05:58
• Resolved: 12/Jun/22 17:40

Description

lhofhansl had a suggestion (in some other jira I forgot) for doing a golden file for the HBase API so that we can compare between releases to ensure that we are keeping source and binary compatibility as defined in this document : https://docs.google.com/document/d/1p5pP7v2OuzSSaomK2S2v7sfKky1Hex6OqwsJO0sZTUY/edit

I think we can generate a file, commit it to the repo, and create a unit test to check whether any API's are broken. Adding new InterfaceAudience.Public interfaces has to modify this file so that it becomes an explicit decision.

The downside is that we have to modify the file every time we add a new API, but it should be fine since it will force us to think more before committing to supporting new interfaces within the same major versions.

Issue Links

• relates to: HBASE-12808 Use Java API Compliance Checker for binary/source compatibility