hbase-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Dima Spivak (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HBASE-12556) Create a golden file for testing client API source/binary compatibility
Date Sat, 22 Nov 2014 00:04:34 GMT

    [ https://issues.apache.org/jira/browse/HBASE-12556?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14221619#comment-14221619
] 

Dima Spivak commented on HBASE-12556:
-------------------------------------

I like Sean's idea of an automated tool over a golden file; I've briefly explored adding annotation
support into our existing jdiff wrapper and could speed this up if there's interest. If we
do this, we might also want to have it run regularly on builds.apache.org; as it stands, I
run it regularly on my own, but it would help to up its visibility and perhaps spam people
if it finds public API deletions where they shouldn't be. 

> Create a golden file for testing client API source/binary compatibility
> -----------------------------------------------------------------------
>
>                 Key: HBASE-12556
>                 URL: https://issues.apache.org/jira/browse/HBASE-12556
>             Project: HBase
>          Issue Type: Sub-task
>          Components: Client
>            Reporter: Enis Soztutar
>            Assignee: Enis Soztutar
>             Fix For: 0.99.2
>
>
> [~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. 



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message