hbase-shell/src/test/ruby/test_helper.rb

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'test/unit'

module Testing
  module Declarative
    # define_test "should do something" do
    #   ...
    # end
    def define_test(name, &block)
      test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
      defined = instance_method(test_name) rescue false
      raise "#{test_name} is already defined in #{self}" if defined
      if block_given?
        define_method(test_name, &block)
      else
        define_method(test_name) do
          flunk "No implementation provided for #{name}"
        end
      end
    end
  end
end

module Hbase
  module TestHelpers
    require 'hbase_constants'
    require 'hbase/hbase'
    require 'hbase_shell'

    def setup_hbase
      hbase = ::Hbase::Hbase.new($TEST_CLUSTER.getConfiguration)
      @shell = ::Shell::Shell.new(hbase, interactive = false)
    end
    
    def shutdown
      @shell.hbase.shutdown
    end

    # This function triggers exactly same path as the users.
    def command(command, *args)
      @shell.command(command, *args)
    end

    def table(table)
      @shell.hbase_table(table)
    end

    def admin
      @shell.admin
    end

    def taskmonitor
      @shell.hbase_taskmonitor
    end

    def security_admin
      @shell.hbase_security_admin
    end

    def visibility_admin
      @shell.hbase_visibility_labels_admin
    end

    def quotas_admin
      @shell.hbase_quotas_admin
    end

    def replication_admin
      @shell.hbase_replication_admin
    end

    def group_admin(_formatter)
      @shell.hbase_group_admin
    end

    def create_test_table(name)
      # Create the table if needed
      unless admin.exists?(name)
        command(:create, name, {'NAME' => 'x', 'VERSIONS' => 5}, 'y')
        return
      end

      # Enable the table if needed
      unless admin.enabled?(name)
        admin.enable(name)
      end
    end

    def create_test_table_with_splits(name, splits)
      # Create the table if needed
      command(:create, name, 'f1', splits) unless admin.exists?(name)

      # Enable the table if needed
      admin.enable(name) unless admin.enabled?(name)
    end

    def create_test_table_with_splits_file(name, splits_file)
      # Create the table if needed
      command(:create, name, 'f1', splits_file) unless admin.exists?(name)

      # Enable the table if needed
      admin.enable(name) unless admin.enabled?(name)
    end

    def create_test_table_with_region_replicas(name, num_of_replicas, splits)
      # Create the table if needed
      unless admin.exists?(name)
        command(:create, name, 'f1', { ::HBaseConstants::REGION_REPLICATION => num_of_replicas },
                splits)
      end

      # Enable the table if needed
      admin.enable(name) unless admin.enabled?(name)
    end

    def drop_test_table(name)
      return unless admin.exists?(name)
      begin
        admin.disable(name) if admin.enabled?(name)
      rescue => e
        puts "IGNORING DISABLE TABLE ERROR: #{e}"
      end
      begin
        admin.drop(name)
      rescue => e
        puts "IGNORING DROP TABLE ERROR: #{e}"
      end
    end

    def replication_status(format,type)
      return admin.status(format,type)
    end

    def drop_test_snapshot()
      begin
        admin.delete_all_snapshot(".*")
      rescue => e
        puts "IGNORING DELETE ALL SNAPSHOT ERROR: #{e}"
      end
    end


    def capture_stdout
      begin
        old_stdout = $stdout
        $stdout = StringIO.new('','w')
        yield
        $stdout.string
      ensure
        $stdout = old_stdout
      end
    end
  end
end

# Extend standard unit tests with our helpers
Test::Unit::TestCase.extend(Testing::Declarative)