tdi 0.1.0

data/helper/ssh.rb

@@ -0,0 +1,58 @@
+require 'net/ssh'
+require 'etc'
+
+class TDIPlan < TDI
+  def ssh(plan)
+    plan.select { |key, val|
+      val.is_a?(Hash)
+    }.each_pair do |case_name, case_content|
+      # Validate.
+      unless /^[^@]+@[^@]+$/.match(case_name)
+        puts "ERR: Invalid ssh plan format \"#{case_name}\". Case name must match pattern \"user@host\".".light_magenta
+        exit 1
+      end
+
+      # Parse.
+      remote_user = case_name.split('@').first
+      host = case_name.split('@').last
+      local_users = [case_content['local_user']].flatten
+
+      # Users.
+      local_users.each do |local_user|
+        # Privileged user.
+        begin
+          Process.euid = 0
+        rescue => e
+          puts "ERR: Must run as root to change user credentials #{e}).".light_magenta
+          exit 1
+        end
+
+        # Change credentials to local user.
+        begin
+          Process.euid = Etc.getpwnam(local_user).uid
+          # SSH needs to know the user homedir in order to use the right
+          # private/public key pair to authenticate.
+          ENV['HOME'] = Etc.getpwnam(local_user).dir
+        rescue => e
+          puts "ERR: User \"#{local_user}\" not found (#{e}).".light_magenta
+          exit 1
+        end
+
+        begin
+          timeout(5) do
+            ssh_session = Net::SSH.start(host,
+                                         remote_user,
+                                         :auth_methods => ['publickey'])
+            ssh_session.close
+            success "SSH (#{local_user}): #{remote_user}@#{host}"
+          end
+        rescue
+          failure "SSH (#{local_user}): #{remote_user}@#{host}"
+        end
+      end
+    end
+
+    # Change credentials back to privileged user.
+    Process.euid = 0
+  end
+end

data/lib/planner.rb

@@ -0,0 +1,298 @@
+require_relative 'rblank'
+require_relative 'rmerge'
+
+# Test plan builder.
+def planner(opts, plan)
+  # Compila um plano completo.
+  # Processa a herança.
+  # Compila novamente para gerar um plano intermediário.
+  #
+  # Pass 1.
+  if opts[:verbose] > 1
+    puts '* Pass 1...'.cyan
+    puts
+  end
+  compiled_plan1 = plan_compiler(opts, plan)
+  inherited_plan1 = plan_inheriter(opts, compiled_plan1)
+  recompiled_plan1 = plan_compiler(opts, inherited_plan1)
+  if opts[:verbose] > 1
+    puts '* Pass 1... done.'.green
+    puts
+  end
+
+  # Zera o plano, mantendo apenas a estrutura de hashes. Desta forma é possível
+  # gerar um esqueleto de plano com todas as entradas de test cases com valores
+  # vazios (originais e herdados).
+  # Logo em seguida ocorre um merge recursivo com os valores originais para
+  # depois ser processado por completo novamente.
+  # O objetivo é dar precedência aos valores globais locais sobre os valores
+  # herdados.
+  #
+  # Blank and repopulate with original values.
+  blanked_plan = recompiled_plan1.rblank
+  if opts[:verbose] > 2
+    puts 'Blanked plan:'
+    puts "* #{blanked_plan}".yellow
+  end
+
+  repopulated_plan = blanked_plan.rmerge(compiled_plan1)
+  if opts[:verbose] > 2
+    puts 'Repopulated plan:'
+    puts "* #{repopulated_plan}".yellow
+  end
+
+  # Compila um plano completo.
+  # Processa a herança.
+  # Compila novamente para gerar um plano final.
+  #
+  # Pass 2.
+  if opts[:verbose] > 1
+    puts '* Pass 2...'.cyan
+    puts
+  end
+  compiled_plan2 = plan_compiler(opts, repopulated_plan)
+  inherited_plan2 = plan_inheriter(opts, compiled_plan2)
+  recompiled_plan2 = plan_compiler(opts, inherited_plan2)
+  if opts[:verbose] > 1
+    puts '* Pass 2... done.'.green
+    puts
+  end
+
+  # Final plan.
+  plan_filter(opts, recompiled_plan2)
+end
+
+# Test plan compile.
+def plan_compiler(opts, plan)
+  # Gera um plano de teste baseado em todos os valores dos hashes, desde o mais
+  # global (role) até o mais específico (test case).
+  # Ordem de precedência: test case > test plan.
+
+  puts 'Compiling test plan...'.cyan if opts[:verbose] > 1
+
+  compiled_plan = {}
+
+  # Role.
+  # Ex: {"admin": {"desc": "...", "acl": {"domain1": {"port": 80}...}...}...}
+  plan.select { |key, val|
+    val.is_a?(Hash)
+  }.each_with_index do |(role_name, role_content), index|
+    if opts[:verbose] > 2
+      puts '=' * 60
+      puts "Role: #{role_name}"
+      puts 'Role content:'
+      puts "* #{role_content}".yellow
+    end
+
+    # Role (if not already).
+    compiled_plan[role_name] ||= role_content
+
+    # Test plan.
+    # Ex: {"acl": {"domain1": {"port": 80}...}...}
+    role_content.select { |key, val|
+      val.is_a?(Hash)
+    }.each_pair do |plan_name, plan_content|
+      if opts[:verbose] > 2
+        puts "Plan: #{plan_name}"
+        puts 'Plan content:'
+        puts "* #{plan_content}".yellow
+      end
+
+      # Test plan (if not already).
+      compiled_plan[role_name][plan_name] ||= plan_content
+
+      # Test case.
+      # Ex: {"domain1": {"port": 80}...}
+      plan_content.select { |key, val|
+        val.is_a?(Hash)
+      }.each_pair do |case_name, case_content|
+        if opts[:verbose] > 2
+          puts "Case: #{case_name}"
+          puts 'Case content:'
+          puts "* #{case_content}".yellow
+        end
+
+        # Test case compile.
+        new_case_content = role_content.reject { |key, val| UNMERGEABLE_KEY_LIST.include?(key) or val.is_a?(Hash) }
+        new_case_content.merge!(plan_content.reject { |key, val| UNMERGEABLE_KEY_LIST.include?(key) or val.is_a?(Hash) })
+        new_case_content.merge!(case_content.reject { |key, val| UNMERGEABLE_KEY_LIST.include?(key) or val.is_a?(Hash) })
+
+        # Test case (new, merged).
+        compiled_plan[role_name][plan_name][case_name] = new_case_content
+
+        if opts[:verbose] > 2
+          puts 'Compiled case content:'
+          puts "* #{new_case_content}".yellow
+        end
+      end
+    end
+
+    if opts[:verbose] > 2
+      puts '=' * 60
+      puts unless index == plan.size - 1
+    end
+  end
+
+  if opts[:verbose] > 1
+    puts 'Compiling test plan... done.'.green
+    puts
+  end
+
+  compiled_plan
+end
+
+# Poor's man test plan inheritance.
+def plan_inheriter(opts, plan)
+  # Processa a herança entre roles e test plans.
+
+  puts 'Inheriting test plan...'.cyan if opts[:verbose] > 1
+
+  inherited_plan = {}
+
+  # Role may inherit from role.
+  # Ex: {"admin": {"desc": "...", "inherits": "other_role", "acl": {"domain1": {"port": 80}...}...}...}
+  plan.select { |key, val|
+    val.is_a?(Hash)
+  }.each_with_index do |(role_name, role_content), index|
+    if opts[:verbose] > 2
+      puts '=' * 60
+      puts "Role: #{role_name}"
+      puts 'Role content:'
+      puts "* #{role_content}".yellow
+    end
+
+    # Role (if not already).
+    inherited_plan[role_name] ||= role_content
+
+    # Inheritance present?
+    i_role_name = role_content['inherits']
+    unless i_role_name.nil?
+      puts "Role #{role_name} inherits #{i_role_name}" if opts[:verbose] > 2
+      inherited_plan[role_name] = plan[i_role_name].rmerge(role_content)
+    end
+
+    # Plan may inherit from plan.
+    # Ex: {"acl": {"inherits": "other_role::other_plan", "domain1": {"port": 80}...}...}
+    role_content.select { |key, val|
+      val.is_a?(Hash)
+    }.each_pair do |plan_name, plan_content|
+      if opts[:verbose] > 2
+        puts "Plan: #{plan_name}"
+        puts 'Plan content:'
+        puts "* #{plan_content}".yellow
+      end
+
+      # Test plan (if not already).
+      inherited_plan[role_name][plan_name] ||= plan_content
+
+      # Inheritance present?
+      i_plan = plan_content['inherits']
+      unless i_plan.nil?
+        i_role_name, i_plan_name = role_plan_split(i_plan)
+
+        if i_role_name.nil? or i_plan_name.nil?
+          puts "ERR: Invalid inheritance \"#{i_plan}\". Must match pattern \"role::plan\".".light_magenta
+          exit 1
+        end
+
+        # TODO: Tratar quando chave não existe.
+        puts "Plan #{plan_name} inherits #{i_plan}" if opts[:verbose] > 2
+        inherited_plan[role_name][plan_name] = plan[i_role_name][i_plan_name].rmerge(plan_content)
+      end
+    end
+
+    if opts[:verbose] > 2
+      puts '=' * 60
+      puts unless index == plan.size - 1
+    end
+  end
+
+  if opts[:verbose] > 1
+    puts 'Inheriting test plan... done.'.green
+    puts
+  end
+
+  inherited_plan
+end
+
+# Test plan filter.
+def plan_filter(opts, plan)
+  # Filtra roles e test plans desejados a partir do plano fornecido.
+
+  puts 'Filtering test plan...'.cyan if opts[:verbose] > 1
+
+  filtered_plan = {}
+  flag_err = false
+
+  # Ex: tdi -p admin
+  # Ex: tdi -p admin::acl
+  # Ex: tdi --plan fe
+  # Ex: tdi --plan admin::acl,solr,be
+  if opts.plan?
+    # Do filter.
+    puts 'Filtering following test plan from input file:'.cyan if opts[:verbose] > 0
+    opts[:plan].each do |plan_name|
+      puts "  - #{plan_name}".cyan if opts[:verbose] > 0
+
+      # Pattern from command line is already validate by validate_args().
+      # Does not need to check for nil.
+      f_role_name, f_plan_name = role_plan_split(plan_name)
+
+      if plan.has_key?(f_role_name)
+        unless f_plan_name.nil?
+          # Test plan only.
+          if plan[f_role_name].has_key?(f_plan_name)
+            # Initialize hash key if not present.
+            filtered_plan[f_role_name] ||= {}
+            filtered_plan[f_role_name][f_plan_name] = plan[f_role_name][f_plan_name]
+            puts "    Test plan \"#{plan_name}\" included.".green if opts[:verbose] > 0
+          else
+            puts "ERR: Test plan \"#{plan_name}\" not found in input file. This test plan can not be included.".light_magenta
+            flag_err = true
+          end
+        else
+          # Role test plan (entire).
+          filtered_plan[f_role_name] = plan[f_role_name]
+          puts "    Role \"#{plan_name}\" included.".green if opts[:verbose] > 0
+        end
+      else
+        puts "ERR: Role \"#{f_role_name}\" not found in input file. Test plan \"#{plan_name}\" can not be included.".light_magenta
+        flag_err = true
+      end
+    end
+
+    puts if opts[:verbose] > 0
+  else
+    # No filter.
+    filtered_plan = plan
+  end
+
+  if opts[:verbose] > 2
+    puts 'Filtered test plan:'.cyan
+    puts "* #{filtered_plan}".yellow
+  end
+
+  exit 1 if flag_err
+
+  if opts[:verbose] > 1
+    puts 'Filtering test plan... done.'.green
+    puts
+  end
+
+  filtered_plan
+end
+
+# Split role_name and plan_name.
+def role_plan_split(name)
+  if name.include?('::')
+    # Test plan only.
+    f_role_name = name.split('::').first
+    f_plan_name = name.split('::').last
+  else
+    # Role test plan (entire).
+    f_role_name = name
+    f_plan_name = nil
+  end
+
+  return f_role_name, f_plan_name
+end

data/lib/rblank.rb

@@ -0,0 +1,23 @@
+module HashRecursiveBlank
+  def rblank
+    r = {}
+
+    each_pair do |key, val|
+      r[key] = val.rblank if val.is_a?(Hash)
+    end
+
+    r.keep_if { |key, val| val.is_a?(Hash) }
+  end
+
+  def rblank!
+    each_pair do |key, val|
+      self[key] = val.rblank! if val.is_a?(Hash)
+    end
+
+    keep_if { |key, val| val.is_a?(Hash) }
+  end
+end
+
+class Hash
+  include HashRecursiveBlank
+end

data/lib/rmerge.rb

@@ -0,0 +1,19 @@
+module HashRecursiveMerge
+  def rmerge(other_hash)
+    r = {}
+
+    merge(other_hash) do |key, oldval, newval|
+      r[key] = oldval.is_a?(Hash) ? oldval.rmerge(newval) : newval
+    end
+  end
+
+  def rmerge!(other_hash)
+    merge!(other_hash) do |key, oldval, newval|
+      oldval.is_a?(Hash) ? oldval.rmerge!(newval) : newval
+    end
+  end
+end
+
+class Hash
+  include HashRecursiveMerge
+end

data/lib/runner.rb

@@ -0,0 +1,99 @@
+require_relative 'tdi'
+
+# Run tests.
+def runner(opts, filename, plan)
+  puts 'Running tests...'.cyan if opts[:verbose] > 1
+
+  # Skip reserved roles.
+  # Ex: {"global": {"desc": "...", "acl": {"domain1": {"port": 80}...}...}...}
+  # Ex: {"common": {"desc": "...", "acl": {"domain1": {"port": 80}...}...}...}
+  plan.select { |role_name, role_content|
+    if role_content.is_a?(Hash)
+      UNTESTABLE_ROLE_LIST.include?(role_name) or role_content['notest'].eql?('true')
+    end
+  }.each_pair do |role_name, role_content|
+    puts "Skipping reserved or disabled role: #{role_name}".yellow if opts[:verbose] > 0
+  end
+
+  # Remove untestable roles.
+  plan.reject! { |role_name, role_content|
+    if role_content.is_a?(Hash)
+      UNTESTABLE_ROLE_LIST.include?(role_name) or role_content['notest'].eql?('true')
+    end
+  }
+  total_roles = plan.select { |key, val| val.is_a?(Hash) }.size
+  puts "Total roles to run: #{total_roles}".cyan if opts[:verbose] > 1
+
+  # Run the rest.
+  tdiplan = TDIPlan.new
+
+  # Role.
+  # Ex: {"admin": {"desc": "...", "acl": {"domain1": {"port": 80}...}...}...}
+  plan.select { |key, val|
+    val.is_a?(Hash)
+  }.each_with_index do |(role_name, role_content), index|
+    total_plans = role_content.select { |key, val| val.is_a?(Hash) }.size
+
+    if role_content['desc'].nil?
+      puts "* #{role_name.capitalize}".cyan
+    else
+      puts "* #{role_name.capitalize} - #{role_content['desc']}".cyan
+    end
+#    puts "Running tests for role: #{role_name}".cyan if opts[:verbose] > 0
+    puts "Total test plans to run for this role: #{total_plans}".cyan if opts[:verbose] > 1
+
+    # Test plan.
+    # Ex: {"acl": {"domain1": {"port": 80}...}...}
+    role_content.select { |key, val|
+      val.is_a?(Hash)
+    }.each_pair do |plan_name, plan_content|
+      total_cases = plan_content.select { |key, val| val.is_a?(Hash) }.size
+
+      puts "* #{plan_name.upcase}".cyan
+#      puts "Test plan: #{role_name}::#{plan_name}".cyan if opts[:verbose] > 0
+      puts "Total test cases to run for this plan: #{total_cases}".cyan if opts[:verbose] > 1
+
+      if opts[:verbose] > 3
+        puts "Plan: #{plan_name}"
+        puts 'Plan content:'
+        puts "* #{plan_content}".yellow
+      end
+
+      # Test plan content (test cases).
+      # Ex: {"domain1": {"port": 80}, "domain2": {"port": 80}...}
+      if tdiplan.respond_to?(plan_name)
+        tdiplan.send(plan_name, plan_content)
+      else
+        puts "Skipping not supported test plan type \"#{plan_name}\" for \"#{role_name}::#{plan_name}\".".yellow
+        tdiplan.skip = tdiplan.skip + total_cases
+      end
+    end
+
+    puts unless index == plan.size - 1
+  end
+
+  # Summary.
+  summary(opts, tdiplan)
+
+  # Shred.
+  if opts.shred?
+    puts "Shreding and removing test plan file: \"#{filename}\"...".cyan if opts[:verbose] > 2
+    if system("shred -f -n 38 -u -z #{filename}")
+      puts "Shreding and removing test plan file: \"#{filename}\"... done.".green if opts[:verbose] > 2
+    else
+      puts "ERR: Shreding and removing test plan file: \"#{filename}\".".light_magenta
+    end
+  end
+
+  puts 'Running tests... done.'.green if opts[:verbose] > 1
+
+  ret = tdiplan.passed? ? 0 : 1
+  ret = 0 if opts.nofail?
+  ret
+end
+
+# Display test summary.
+def summary(opts, tdiplan)
+  puts '=' * 79
+  puts "Total: #{tdiplan.total}  |  Skip: #{tdiplan.skip}  |  Pass: #{tdiplan.pass}  |  Warn: #{tdiplan.warn}  |  Fail: #{tdiplan.fail}"
+end