[HBASE-13126] Provide alternate mini cluster classes other than HBTU for downstream users to write unit tests

• Type: Umbrella
• Status: Resolved
• Priority: Critical
• Resolution: Fixed
• Affects Version/s: 2.0.0
• Fix Version/s: 2.5.0, 3.0.0-alpha-4
• Component/s: API, test
• Hadoop Flags: Reviewed

Release Note

Introduce a TestingHBaseCluster for users to implement integration test with mini hbase cluster.
See this section https://hbase.apache.org/book.html#_integration_testing_with_an_hbase_mini_cluster in the ref guide for more details on how to use it.
TestingHBaseCluster also allowes you to start a mini hbase cluster based on external HDFS cluster and zookeeper cluster, please see the release note of HBASE-26167 for more details.
HBaseTestingUtility is marked as deprecated and will be 'removed' in the future.

• Assignee: Duo Zhang
• Reporter: Sean Busbey
• Created: 27/Feb/15 17:49
• Updated: 15/May/23 15:25
• Resolved: 24/Jun/22 04:46

Description

Over in the review for HBASE-12972, enis mentioned that one of the HBTU methods wasn't intended for public consumption.

Can we build a list of such methods across the API, appropriately annotate them for 2.0, and deprecate them in earlier versions with a warning that they're going to be restricted?

Issue Links

• duplicates: HBASE-20650 Revisit the HBaseTestingUtility related classes

Sub-Tasks

• HBaseCluster should be marked as IA.Public: Resolved
• Implement a new mini cluster class for end users: Resolved
• Copy HBTU to hbase-testing-util, rename the HBTU related classes in hbase-server and mark them as IA.LimitedPrivate: Resolved
• Mark LocalHBaseCluster as IA.Private: Resolved
• Modify our ref guide to mention the deprecation of HBTU and also how to make use of the new TestingHBaseCluster: Resolved
• Cleanup the deprecated methods in HBTU related classes and format code: Resolved
• Support passing a customized Configuration object when creating TestingHBaseCluster: Resolved
• Expose some IA.LimitedPrivate interface in TestingHBaseCluster: Resolved
• MiniZooKeeperCluster should not be IA.Public: Resolved
• Allow users to not start zookeeper and dfs cluster when using TestingHBaseCluster: Resolved