framework_gem 0.1.0

data/lib/diagnostics/webservices/mas_rest_services_checkup.tmc

@@ -0,0 +1,24 @@
+#Test automation script version# TA-5.5.mdn released time stamp: 12-03-12 14:40:20
+
+require './dsllib/common/utils/server_components_utils'
+
+set_log_test_name 'diagnostics/webservices/rest_services_check'
+tcstart "Check various REST services"
+tc_start_epoch = current_epoch_time
+
+begin
+  # REST service check
+  rest_services_check_failure = _verify_rest_services
+  unless rest_services_check_failure.empty?
+    tcfail rest_services_check_failure.join(',')
+  end
+
+  log PASS, "REST services check successful"
+rescue StandardError => e
+  log FAIL,"REST services check failed : #{e.message}"
+ensure
+  curr_time = current_epoch_time
+  logdebug "Total execution time : [#{(curr_time - tc_start_epoch) / 60000}] min [#{((curr_time - tc_start_epoch) % 60000) / 1000}] sec"
+end
+
+tcstop

data/lib/diagnostics/webservices/mas_soap_services_checkup.tmc

@@ -0,0 +1,24 @@
+#Test automation script version# TA-5.5.mdn released time stamp: 12-03-12 14:40:20
+
+require './dsllib/common/utils/server_components_utils'
+
+set_log_test_name 'diagnostics/webservices/soap_services_check'
+tcstart "Check various SOAP services"
+tc_start_epoch = current_epoch_time
+
+begin
+  # SOAP service check
+  soap_services_check_failure = _verify_soap_services
+  unless soap_services_check_failure.empty?
+    tcfail soap_services_check_failure.join(',')
+  end
+
+  log PASS, "SOAP services check successful"
+rescue StandardError => e
+  log FAIL,"SOAP services check failed : #{e.message}"
+ensure
+  curr_time = current_epoch_time
+  logdebug "Total execution time : [#{(curr_time - tc_start_epoch) / 60000}] min [#{((curr_time - tc_start_epoch) % 60000) / 1000}] sec"
+end
+
+tcstop

data/lib/dsllib/common/dncs/dncs_utils.rb

@@ -0,0 +1,449 @@
+#Test automation script version# TA-5.5.mdn released time stamp: 12-03-12 14:40:20
+
+require './dsllib/common/utils/tmc_utils'
+
+# Use it to remove Package on DNCS
+# * *Args* :
+#   - +packages+ -> a packagename or array of packagenames to be removed
+#   - +wait_for_changes_to_reflect - polls DNCS until STB shows all packages installed
+#   - retries - Try multiple times to add packages if they aren't the first time
+#   - mac_address - STB Mac Address used by DNCS to push packages to STB
+#   - Immediate - If false, all DNCS commands will be executed with a random pause
+# * *Returns* :
+#   - true if all the packages STB is entitled for else false
+def remove_pkg_from_dncs (packages,wait_for_changes_to_reflect = true,retries=3, mac_address = fetch_stb_mac_address, immediate = false)
+  immediate = immediate || @test_case.options[:ssh_immediate]
+  #convert String to array
+  packages = [packages] if packages.class == String
+
+  # Verify packages
+  loginfo2 "Verifying package from DNCS",false
+
+  packages_to_be_removed = _dncs_matched_packages(packages,mac_address,immediate)
+
+  if packages_to_be_removed.empty?
+    loginfo2 "No need to remove any package because #{packages.join(',')} doesn't exist on  STB",false
+    return true
+  end
+
+  retries.times do
+    # Remove packages added on STB
+    packages_to_be_removed.each do |pkg|
+      # convert spaces to '\ ' for modDhctCfg command
+      pkg = pkg.strip.gsub(/\s+/, '\ ')
+
+      loginfo2 "Removing #{pkg} package from DNCS",false
+      cmd = "modDhctCfg -p#{pkg} #{mac_address}"
+      loginfo2 "Executing dncs cmd #{cmd}",false
+      exec_dncs_cmd "modDhctCfg -p#{pkg} #{mac_address}", immediate
+    end
+
+    # Refresh package list
+    _revive_stb_entitlements_on_dncs
+
+    if verify_package_on_dncs(packages_to_be_removed,mac_address,immediate) # try again if verified
+      loginfo2 "Failed to remove packages, trying again in 10 sec",false
+      sleep 10.sec
+      next
+    end
+
+    sleep_until_pkg_added_or_removed if wait_for_changes_to_reflect
+    loginfo2 "Removed #{packages.join(',')} packages from DNCS",false
+
+    return true
+  end
+
+  loginfo2 "Failed to remove packages : [#{packages.join(',')}]",false
+  return false
+end
+
+# Use it to add Package on DNCS
+# * *Args* :
+#   - +packages+ -> a packagename or array of packagenames to be added
+#   - +wait_for_changes_to_reflect -> Polls DNCS until STB shows all packages
+#   - retries -> Tries multiple times to add packages until all are added
+#   - mac_address -> STB address DNCS uses to push packages to the STB
+#   - immediate -> All DNCS commands are executed with a random pause if this is false
+# * *Returns* :
+#   - true if all the packages STB is entitled for else false
+def add_pkg_on_dncs (packages,wait_for_changes_to_reflect = true,retries=3, mac_address = fetch_stb_mac_address, immediate = false)
+  immediate = immediate || @test_case.options[:ssh_immediate]
+  # convert String to array
+  packages = [packages] if packages.class == String
+
+  # Verify packages
+  loginfo2 "Verifying package from DNCS",false
+
+  packages_to_be_added = packages - _dncs_matched_packages(packages,mac_address, immediate)
+
+  if packages_to_be_added.empty?
+    loginfo2 "No need to add any package because #{packages.join(',')} already exist on  STB",false
+    return true
+  end
+
+  retries.times do
+    packages_to_be_added.each do |pkg|
+      # convert spaces to '\ ' for modDhctCfg command
+      pkg = pkg.strip.gsub(/\s+/, '\ ')
+
+      loginfo2 "Adding #{pkg} package from DNCS",false
+      cmd = "modDhctCfg +p#{pkg} #{mac_address}"
+      loginfo2 "Executing dncs cmd #{cmd}",false
+      exec_dncs_cmd "modDhctCfg +p#{pkg} #{mac_address}", immediate
+    end
+
+    _revive_stb_entitlements_on_dncs
+
+    unless verify_package_on_dncs(packages_to_be_added,mac_address,immediate) # try again if not verified
+      loginfo2 "Failed to add packages, trying again in 10 sec",false
+      sleep 10.sec
+      next
+    end
+
+    sleep_until_pkg_added_or_removed if wait_for_changes_to_reflect
+    loginfo2 "Added #{packages.join(',')} packages from DNCS",false
+
+    return true
+  end
+
+  loginfo2 "Failed to add packages : [#{packages.join(',')}]",false
+  return false
+end
+
+# Use it to set credit limit for a box using DNCS
+def set_credit_limit_for_stb_from_dncs (credit_limit,wait_for_changes_to_reflect=true,retries=3, mac_address = fetch_stb_mac_address, immediate = false)
+  immediate = immediate || @test_case.options[:ssh_immediate]
+  if(credit_limit == 0)
+    credit_limit=1
+  end
+
+  mac_address = fetch_stb_mac_address
+
+  # verify credit limit
+  if _dncs_verify_mod_dhct_config_attributes("creditLimit=#{credit_limit}",mac_address)
+    loginfo2 "Credit limit already set to value : #{credit_limit}, No need to change",false
+    return true
+  end
+
+  retries.times do
+    loginfo2 "Setting credit limit for stb to  #{credit_limit} from DNCS",false
+    cmd = "modDhctCfg -c#{credit_limit} #{mac_address}"
+    loginfo2 "Executing dncs cmd #{cmd}",false
+    exec_dncs_cmd cmd, immediate
+    _revive_stb_entitlements_on_dncs
+
+    # verify credit limit
+    if _dncs_verify_mod_dhct_config_attributes("creditLimit=#{credit_limit}",mac_address)
+      sleep_until_pkg_added_or_removed if wait_for_changes_to_reflect
+      loginfo2 "Credit limit set for ths stb from DNCS",false
+      return true
+    end
+  end
+
+  loginfo2 "Failed to set credit limit to : #{credit_limit}",false
+  return false
+end
+
+# Use it to enable IPPV for a box using DNCS
+def enable_ippv_from_dncs(wait_for_changes_to_reflect = true,retries=3, mac_address = fetch_stb_mac_address, immediate = false)
+  immediate = immediate || @test_case.options[:ssh_immediate]
+  loginfo2 "Verifying IPPV package ...",false
+  mac_address = fetch_stb_mac_address
+
+  if _dncs_verify_mod_dhct_config_attributes("ippvEnableFlag=IEF_Enabled",mac_address)
+    loginfo2 "IPPV already enabled, No need to change",false
+    return true
+  end
+
+  retries.times do
+    loginfo2 "Enabling IPPV package from DNCS",false
+    cmd = "modDhctCfg +i #{mac_address}"
+    loginfo2 "Executing dncs cmd #{cmd}",false
+    exec_dncs_cmd cmd, immediate
+    _revive_stb_entitlements_on_dncs
+
+    loginfo2 "Verifying IPPV package ...",false
+    if _dncs_verify_mod_dhct_config_attributes("ippvEnableFlag=IEF_Enabled",mac_address)
+      loginfo2 "IPPV verified",false
+      sleep_until_pkg_added_or_removed if wait_for_changes_to_reflect
+      loginfo2 "Successfully enabled IPPV package from DNCS",false
+      return true
+    end
+  end
+
+  loginfo2 "Failed to enable IPPV package",false
+  return false
+end
+
+# Use it to disable IPPV for a box using DNCS
+def disable_ippv_from_dncs(wait_for_changes_to_reflect = true,retries=3,mac_address = fetch_stb_mac_address, immediate =  false)
+  immediate = immediate || @test_case.options[:ssh_immediate]
+  loginfo2 "Verifying IPPV package ...",false
+  mac_address = fetch_stb_mac_address
+
+  if _dncs_verify_mod_dhct_config_attributes("ippvEnableFlag=IEF_Disabled",mac_address)
+    loginfo2 "IPPV already disabled, No need to change",false
+    return true
+  end
+
+  retries.times do
+    loginfo2 "Disabling IPPV package from DNCS",false
+    cmd = "modDhctCfg -i #{mac_address}"
+    loginfo2 "Executing dncs cmd #{cmd}",false
+    exec_dncs_cmd cmd, immediate
+    _revive_stb_entitlements_on_dncs
+
+    loginfo2 "Verifying IPPV package disabled ...",false
+    unless _dncs_verify_mod_dhct_config_attributes("ippvEnableFlag=IEF_Enabled",mac_address)
+      loginfo2 "IPPV package disabled verified",false
+      sleep_until_pkg_added_or_removed if wait_for_changes_to_reflect
+      loginfo2 "Successfully disabled IPPV package from DNCS",false
+      return true
+    end
+  end
+
+  loginfo2 "Failed to enable IPPV package",false
+  return false
+end
+
+# Use it to verify package for a STB usin DNCS
+# * *Args* :
+#   - +pkg_array+ -> a package or an array of packages to be verified
+# * *Returns* :
+#   - true if all the packages STB is entitled for else false
+def verify_package_on_dncs (pkg_array,mac_address = fetch_stb_mac_address, immediate = fase)
+  immediate = immediate || @test_case.options[:ssh_immediate]
+  #convert String to array
+  pkg_array = [pkg_array] if pkg_array.class == String
+
+  loginfo2 "Verifying package from DNCS",false
+  packages_verified = _dncs_matched_packages(pkg_array,mac_address,immediate)
+
+  return (packages_verified.length.eql?(pkg_array.length))
+end
+
+# Private method
+# Use it to revive/refresh STB entitlements using DNCS
+def _revive_stb_entitlements_on_dncs(mac_address = fetch_stb_mac_address,immediate = false)
+  immediate = immediate || @test_case.options[:ssh_immediate]
+  
+  cmd = "modDhctCfg -s #{mac_address}"
+  loginfo2 "Executing dncs cmd #{cmd}",false
+  exec_dncs_cmd cmd, immediate
+  
+end
+
+# Private method
+# Use it to verify message in modDhctCfg command output
+def _dncs_verify_mod_dhct_config_attributes messages,mac_address = fetch_stb_mac_address, immediate = false
+  immediate = immediate || @test_case.options[:ssh_immediate]
+  # convert message to list
+  return_boolean = false
+  unless messages.class == Array
+    messages = [messages]
+    return_boolean = true
+  end
+
+  loginfo2 "Verifying [#{messages.join(',')}] ...",false
+  mac_address = fetch_stb_mac_address
+  cmd = "modDhctCfg #{mac_address}"
+  loginfo2 "Executing dncs cmd #{cmd}",false
+  result = exec_dncs_cmd cmd, immediate
+  
+  result = result.strip.downcase
+
+  # verify error message
+  error_messages = ['Box has no sm_auth_profile record'] # TODO add more error messages [or] verify success message
+  error_messages.each {|err_msg|
+    if result.downcase.include?(err_msg.downcase)
+      tcinvalid "DNCS Package listing error : #{err_msg}",false,false
+    end
+  }
+
+  result_arr = []
+  messages.each {|msg|
+    if result.include?(msg.strip.downcase)
+      loginfo2 "Message : [#{msg}] successfully verified",false
+      result_arr.push(msg)
+    else
+      loginfo2 "Failed to verify message : [#{msg}]",false
+    end
+  }
+
+  if return_boolean
+    return !result_arr.empty? # true of false
+  else
+    return result_arr # matched result
+  end
+end
+
+# "Private" method
+# Takes a package name or array of package names and verifies that those
+# packages are installed on a STB. Returns an array of packages names
+# that were matched. Setting immediate to true will cause the dncs
+# commands to run immediatedly. If you don't do this, there will be a
+# random pause between each command. I assume this is an attempt
+# to prevent two commands from being run at exactly the same time.
+# between separate test cases. TMC should prevent this from happening
+# anyway, but I haven't verified that.
+def _dncs_matched_packages packages,mac_address = fetch_stb_mac_address, immediate = false
+  immediate = immediate || @test_case.options[:ssh_immediate]
+  unless packages.is_a?(Array)
+    packages = [packages]
+  end
+
+  loginfo2 "Verifying [#{packages.join(',')}] ...",false
+
+  installed_packages = _dncs_installed_packages(mac_address, immediate)
+  
+  retval = []
+  packages.each {|pkg|
+    if installed_packages.include?(pkg.strip.upcase)
+      loginfo2 "Package : [#{pkg}] successfully verified",false
+      retval.push(pkg)
+    else
+      loginfo2 "Failed to verify package : [#{pkg}]",false
+    end
+  }
+
+  return retval
+end
+
+# Use it to verify if IPPV is enabled
+# * *Args* :
+#   - +mac_address+ -> mac address of the stb
+# * *Returns* :
+#   - true if ippv is enabled else false
+def dncs_verify_ippv_enabled? mac_address = fetch_stb_mac_address
+  return _dncs_verify_mod_dhct_config_attributes("ippvEnableFlag=IEF_Enabled",mac_address)
+end
+
+# Use it to fetch FDR logs from Cisco STB on DNCS
+# * *Args* :
+#   - +ip_addr+ -> ip address of the stb
+# * *Returns* :
+#   - true logs fetched else false
+def dncs_fetch_cisco_fdr_logs_from_stb(ip_addr = fetch_ip)
+  begin
+    return false if ip_addr.nil?
+
+    dncs_ip = fetch_option(:dncs_server_ip)
+    dncs_prompt = fetch_option(:dncs_server_prompt)
+    dncs_username = fetch_option(:dncs_username)
+    dncs_password = fetch_option(:dncs_password)
+
+    dncs_opened = false
+    open_interactive_ssh(dncs_ip, 22, dncs_prompt, dncs_username, dncs_password)
+    dncs_opened = true
+
+    exec_interactive_ssh(dncs_prompt, "echo #{ip_addr} > /tmp/tmc_#{fetch_option(:rack_ip)}_iplist")
+
+    begin
+      logdebug "Running script 'probefdr18' to fetch FDR logs."
+      result3 = exec_interactive_ssh(dncs_prompt, "/export/home/dncs/ODNlogs/probefdr18 /tmp/tmc_#{fetch_option(:rack_ip)}_iplist")
+      logdebug "Output: #{result3}"
+    rescue StandardError => e
+      logdebug e.to_s
+      logdebug "Still fetching FDR logs..."
+      dncs_opened = false
+    end
+
+    close_interactive_ssh if dncs_opened
+
+    log_fetched = false
+    10.times do
+      dncs_opened = false
+      open_interactive_ssh(dncs_ip, 22, dncs_prompt, dncs_username, dncs_password)
+      dncs_opened = true
+      result5 = exec_interactive_ssh(dncs_prompt, "ls *#{ip_addr}* | grep -i .txt")
+      logdebug "Output: #{result5}"
+
+      unless result5.include?("#{ip_addr}_diag")
+        logdebug "Still fetching FDR logs... Will try again in 3 minutes."
+        close_interactive_ssh if dncs_opened
+        sleep 3.min
+      else
+        logdebug "FDR logs fetched from STB."
+        log_fetched = true
+        break
+      end
+    end
+
+    return false unless log_fetched
+
+    result6 = exec_interactive_ssh(dncs_prompt, "ls -t | grep #{ip_addr}")
+    logdebug "Output: #{result6}"
+
+    start_index = result6.index("#{ip_addr}_")
+    end_index = result6.index('txt')
+    log_name = result6[start_index..end_index+2]
+    logdebug "FDR log file: [#{log_name}]"
+    logdebug "Moving log file to directory /tmp"
+    result7 = exec_interactive_ssh(dncs_prompt, "mv #{log_name} /tmp")
+    close_interactive_ssh if dncs_opened
+    loginfo2 "Cisco ODN FDR log file: [#{log_name}] created in directory /tmp"
+    return true
+  rescue StandardError => e
+    loginfo2 "Unexpected Failure: #{e.message}"
+    return false
+  ensure
+    close_interactive_ssh if dncs_opened
+  end
+end
+
+# Get list of installed packages
+
+def _dncs_installed_packages(mac_address = fetch_stb_mac_address, immediate = false)
+  immediate = immediate || @test_case.options[:ssh_immediate]
+  packages = []
+  query_cmd = "modDhctCfg " + mac_address
+  query_result = exec_dncs_cmd(query_cmd, immediate)
+
+  if (nil != query_result)
+    found_start = false
+    query_result.each_line do |line|
+      if line.index("PackageNameVector") != nil
+        found_start = true
+        next
+      end
+      if found_start != true
+        next
+      end
+      if line.index("bossServer") != nil
+        break
+      end
+      line.chomp! # eat \n at EOL
+      line.strip!
+      if (! line.empty?)
+        packages.push line
+      end
+    end
+  end
+  return packages
+end
+  
+#
+# Remove all encryption packages from STB
+#
+
+def _dncs_remove_all_encryption_packages(mac_address = fetch_stb_mac_address, immediate = false)
+  immediate = immediate || @test_case.options[:ssh_immediate]
+  
+  installed_packages = _dncs_installed_packages(mac_address, immediate)
+  
+  if installed_packages.empty?
+    loginfo2 "No packages to remove during test reset"
+  else
+    pkg_string = ""
+    installed_packages.each do |package|
+      if pkg_string.empty?
+        pkg_string = package
+      else
+        pkg_string += "," + package
+      end
+    end
+    loginfo2 "Removing #{pkg_string} from STB"    
+    delete_cmd = "modDhctCfg -p" + pkg_string + " " + mac_address
+    exec_dncs_cmd(delete_cmd, immediate)
+  end
+end