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

   1 # Licensed to the Apache Software Foundation (ASF) under one
   2 # or more contributor license agreements.  See the NOTICE file
   3 # distributed with this work for additional information
   4 # regarding copyright ownership.  The ASF licenses this file
   5 # to you under the Apache License, Version 2.0 (the
   6 # "License"); you may not use this file except in compliance
   7 # with the License.  You may obtain a copy of the License at
   8 #
   9 #     http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 # Unless required by applicable law or agreed to in writing, software
  12 # distributed under the License is distributed on an "AS IS" BASIS,
  13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 # See the License for the specific language governing permissions and
  15 # limitations under the License.
  16 require 'test/unit'
  17
  18 module Testing
  19   module Declarative
  20     # define_test "should do something" do
  21     #   ...
  22     # end
  23     def define_test(name, &block)
  24       test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
  25       defined = instance_method(test_name) rescue false
  26       raise "#{test_name} is already defined in #{self}" if defined
  27       if block_given?
  28         define_method(test_name, &block)
  29       else
  30         define_method(test_name) do
  31           flunk "No implementation provided for #{name}"
  32         end
  33       end
  34     end
  35   end
  36 end
  37
  38 module Hbase
  39   module TestHelpers
  40     require 'hbase_constants'
  41     require 'hbase/hbase'
  42     require 'shell'
  43
  44     def setup_hbase
  45       hbase = ::Hbase::Hbase.new($TEST_CLUSTER.getConfiguration)
  46       @shell = ::Shell::Shell.new(hbase, interactive = false)
  47     end
  48
  49     def shutdown
  50       @shell.hbase.shutdown
  51     end
  52
  53     # This function triggers exactly same path as the users.
  54     def command(command, *args)
  55       @shell.command(command, *args)
  56     end
  57
  58     def table(table)
  59       @shell.hbase_table(table)
  60     end
  61
  62     def admin
  63       @shell.admin
  64     end
  65
  66     def taskmonitor
  67       @shell.hbase_taskmonitor
  68     end
  69
  70     def security_admin
  71       @shell.hbase_security_admin
  72     end
  73
  74     def visibility_admin
  75       @shell.hbase_visibility_labels_admin
  76     end
  77
  78     def quotas_admin
  79       @shell.hbase_quotas_admin
  80     end
  81
  82     def replication_admin
  83       @shell.hbase_replication_admin
  84     end
  85
  86     def group_admin(_formatter)
  87       @shell.hbase_group_admin
  88     end
  89
  90     def create_test_table(name)
  91       # Create the table if needed
  92       unless admin.exists?(name)
  93         command(:create, name, {'NAME' => 'x', 'VERSIONS' => 5}, 'y')
  94         return
  95       end
  96
  97       # Enable the table if needed
  98       unless admin.enabled?(name)
  99         admin.enable(name)
 100       end
 101     end
 102
 103     def create_test_table_with_splits(name, splits)
 104       # Create the table if needed
 105       unless admin.exists?(name)
 106         command(:create, name, 'f1', splits)
 107       end
 108
 109       # Enable the table if needed
 110       unless admin.enabled?(name)
 111         admin.enable(name)
 112       end
 113     end
 114
 115     def drop_test_table(name)
 116       return unless admin.exists?(name)
 117       begin
 118         admin.disable(name) if admin.enabled?(name)
 119       rescue => e
 120         puts "IGNORING DISABLE TABLE ERROR: #{e}"
 121       end
 122       begin
 123         admin.drop(name)
 124       rescue => e
 125         puts "IGNORING DROP TABLE ERROR: #{e}"
 126       end
 127     end
 128
 129     def replication_status(format,type)
 130       return admin.status(format,type)
 131     end
 132
 133     def drop_test_snapshot()
 134       begin
 135         admin.delete_all_snapshot(".*")
 136       rescue => e
 137         puts "IGNORING DELETE ALL SNAPSHOT ERROR: #{e}"
 138       end
 139     end
 140
 141
 142     def capture_stdout
 143       begin
 144         old_stdout = $stdout
 145         $stdout = StringIO.new('','w')
 146         yield
 147         $stdout.string
 148       ensure
 149         $stdout = old_stdout
 150       end
 151     end
 152   end
 153 end
 154
 155 # Extend standard unit tests with our helpers
 156 Test::Unit::TestCase.extend(Testing::Declarative)
 157
 158 # Add the $HBASE_HOME/lib/ruby directory to the ruby
 159 # load path so I can load up my HBase ruby modules
 160 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "..", "main", "ruby")