mu 5.7.2.3

data/lib/mu/command/cmd_runscenario.rb

@@ -0,0 +1,258 @@
+# Verifies a  Mu Studio scenario xml template
+require 'mu/api/ddt'
+class Mu
+class Command
+class Cmd_runscenario < Command
+
+  attr_accessor :host, :username, :password, :ddt_api, :errors
+
+  # displays command-line help
+  #  * argv = command-line arguments
+  def cmd_help argv
+     help
+  end
+
+  # verifies a Mu Studio scenario
+  #   * argv = command-line arguments, requires a scenario (-s) argument, which must be an xml scenario template to be loaded onto the Mu
+  def cmd_run argv
+    args = parse_cli argv
+    setup
+
+    if not args['scenario']
+      msg "scenario required"
+      return help
+    else
+      if args['scenario'].include?(".xml")
+         scenario = args['scenario']
+      else # TODO: eventually, msl files may be supported by this api
+        msg "only .xml files are currently supported"
+        return help
+      end
+    end
+
+    if not args['dir']
+      dir = "."
+    else
+      dir = args['dir']
+    end
+
+    if scenario.include?("/")
+      filename = scenario
+    else
+      filename = dir + "/" + scenario
+    end
+
+    if not args['interfaces']
+      @interfaces = Array.new
+    else
+      @interfaces = args['interfaces'].split(",")
+    end
+
+    @errors = Array.new
+    hosts_array = Array.new
+    roles_array = Array.new
+        
+    begin
+   msg "new session"
+      @ddt_api.new_session
+      msg filename, Logger::DEBUG
+      f = File.open(filename)
+      doc = Nokogiri::XML(f)
+      response = @http.post_xml("templates/import", doc)
+      msg "response from post(#{filename}):\n#{response}", Logger::DEBUG
+      scenario_name = doc.xpath("//scenario")[0].attribute('name')
+      hosts = doc.xpath("//hosts/host")
+      uuid = doc.xpath("//scenario")[0].attribute('uuid')
+      roles = doc.xpath("//hosts/host/role")
+      ids = doc.xpath("//hosts/host/id")
+      channels = doc.xpath("//steps/channel")
+      type = doc.xpath("//hosts/host/type")[0].text
+
+      if !@interfaces.empty?
+        if @interfaces.size != hosts.size
+          msg "Error. The number of hosts/interfaces specified on the command-line does not equal the number
+               of hosts in the template. #{@interfaces.size} != #{hosts.size}"
+          return
+        end
+      end
+      
+      msg @ddt_api.load_scenario(uuid)
+
+      roles.each_with_index do | r, i |
+         content = r.text
+         if @interfaces.empty?
+           begin
+             host = content.match(/\(.*\)/).to_s
+             host = host[1, host.index(".") - 1].downcase
+             hosts_array << host
+           rescue => e
+             msg e
+             msg "expected to find host name embedded in role, e.g. 'client (A1.V4)'"
+           end
+         else
+           hosts_array << @interfaces[i]
+         end
+         roles_array << content # use the whole name for the role
+      end
+
+      msg @ddt_api.set_hosts(roles_array, hosts_array, type)
+
+      # if there are channels in the scenario, bind them
+      if channels.size > 0
+        channel_roles = Array.new
+        channel_names = Array.new
+        arg_channels = args['channel'].split(",")
+        arg_channels.each do | c |
+          channel_roles << "channel" # role is always "channel"
+          channel_names << c
+        end
+        msg @ddt_api.set_channels(channel_roles, channel_names)
+      end
+
+      # verify the scenario
+      msg @ddt_api.setup_test
+      response = @ddt_api.run
+      if response == ""
+        msg "==> #{scenario_name} run returned without status"
+        @errors << "#{scenario_name}: status = #{response}"
+      else
+        doc = Nokogiri::XML(response)
+        status = doc.xpath("//status")[0].content
+        msg "==> #{scenario_name}: status = #{status}"
+        if status == 'failed'
+        # on error, add to the errors array
+          @errors << "#{scenario_name}: status = #{status}"
+        end
+      end
+
+      @ddt_api.teardown_test
+      @ddt_api.close_session
+
+      # clear the hosts and roles array for the next iteration
+      roles_array.clear
+      hosts_array.clear
+    end # if !exclude_list.include? and hosts.length
+    # if there were errors, print them out and fail the test
+    estr = ""
+    if @errors.size > 0
+      @errors.each do | e |
+        estr = estr + e + "\n"
+        msg estr
+      end
+   end
+  ensure
+    teardown
+  end
+
+private
+
+  def setup
+    @host = (@@mu_ip.nil?) ? "127.0.0.1" : @@mu_ip
+    @username  = (@@mu_admin_user.nil?) ? "admin" : @@mu_admin_user
+    @password  = (@@mu_admin_pass.nil?) ? "admin" : @@mu_admin_pass
+    @ddt_api = Ddt.new(@host, @username, @password)
+    @docroot ="/api/v3/"
+    @http = HttpHelper.new(@host, @username, @password, @docroot)
+  end
+
+  def teardown
+    unless @ddt_api.nil?
+      @ddt_api.close_all_sessions
+    end
+  end
+
+  def parse_cli argv
+      hash = Hash.new
+      while not argv.empty?
+          break if argv.first[0,1] != '-'
+
+          k = argv.shift
+
+          if [ '-c', '--channel' ].member? k
+              hash['channel'] = shift(k, argv)
+              next
+          end
+
+          if [ '-d', '--dir' ].member? k
+              hash['dir'] = shift(k, argv)
+              next
+          end
+
+          if [ '-h', '--help' ].member? k
+              help
+              exit
+          end
+
+          if [ '-i', '--interfaces' ].member? k
+              hash['interfaces'] = shift(k, argv)
+              next
+          end
+
+          if [ '-m', '--mu_string' ].member? k
+             mu_string = shift(k, argv)
+             if mu_string =~ /(.+?):(.+?)@(.*)/
+               @@mu_admin_user = $1
+               @@mu_admin_pass = $2
+               @@mu_ip = $3
+             end
+             next
+          end
+
+          if [ '-o', '--output' ].member? k
+            $stdout.reopen(shift(k, argv), "w")
+            next
+          end
+
+          if [ '-s', '--scenario' ].member? k
+              hash['scenario'] = shift(k, argv)
+              next
+          end
+
+          if [ '-v', '--verbose' ].member? k
+            $log.level = Logger::DEBUG
+            next
+          end
+
+          raise ArgumentError, "Unknown option #{k}"
+      end
+
+      hash
+  end
+
+  def help
+        helps = [
+            { :short => '-c', :long => '--channel', :value => '<string>', :help => 'channel name' },
+            { :short => '-d', :long => '--dir', :value => '<string>', :help => 'directory containing the scenario file' },
+            { :short => '-h', :long => '--help', :value => '', :help => 'help on command line options' },
+            { :short => '-i', :long => '--interfaces', :value => '<string>', :help => 'comma-separated list of interfaces/hosts, e.g. b1,dell-server' },
+            { :short => '-m', :long => '--mu_string', :value => '<string>', :help => 'user, password, mu_ip in the form of admin:admin@10.9.8.7' },
+            { :short => '-o', :long => '--output', :value => '<string>', :help => 'output logging to this file' },
+            { :short => '-s', :long => '--scenario', :value => '<string>', :help => 'scenario file to run' },
+            { :short => '-v', :long => '--verbose', :value => '', :help => 'set Logger::DEBUG level' }
+        ]
+
+        cmds = [
+           "mu cmd_runscenario:help",
+           "mu cmd_runscenario:run -s <scenario> -i <hosts>"
+        ]
+
+        max_long_size = helps.inject(0) { |memo, obj| [ obj[:long].size, memo ].max }
+        max_value_size = helps.inject(0) { |memo, obj| [ obj[:value].size, memo ].max }
+        puts
+        puts "Usage: mu cmd_runscenario:<command> <options>"
+        puts
+        helps.each do |h|
+            puts "%-*s %*s %-*s %s" % [max_long_size, h[:long], 2, h[:short], max_value_size, h[:value], h[:help]]
+        end
+        puts
+        puts "Available Commands"
+        puts
+        cmds.each do | c |
+           puts c
+        end
+        puts
+    end
+
+end
+end # Command
+end # Mu

data/lib/mu/command/cmd_runverify.rb

@@ -0,0 +1,336 @@
+# Runs a Studio Verify test, given a Mu Studio Scenario and Test Set.
+# The Scenario template must be in Mu Studio XML format. The
+# Test Set template can be in either the Mu Studio XML format or CSV
+require 'mu/api/ddt'
+class Mu
+class Command
+class Cmd_runverify < Command
+
+  attr_accessor :host, :username, :password, :ddt_api, :errors
+
+  # displays command-line help
+  def cmd_help argv
+     help
+  end
+
+  # sets up, executes, and closes a Studio Verify session
+  #   * argv = command-line arguments, requires a scenario (-s) argument, which must be an xml scenario template to be loaded onto the Mu
+  #   * and a testset (-t) argument of an xml test set template to be loaded on the Mu
+  #   * .msl and .csv files are not currently supported
+  def cmd_run argv
+    args = parse_cli argv
+    setup
+
+    if not args['scenario']
+      msg "scenario required"
+      return help
+    else
+      if args['scenario'].include?(".xml")
+         scenario = args['scenario']
+      else # TODO: eventually, msl files may be supported by this api
+        msg "only .xml files are currently supported"
+        return help
+      end
+    end
+
+    if not args['testset']
+      msg "testset required"
+      return help
+    else
+      testset = args['testset']
+    end
+
+    if not args['dir']
+      dir = "."
+    else
+      dir = args['dir']
+    end
+
+    if scenario.include?("/")
+      scenario_filename = scenario
+    else
+      scenario_filename = dir + "/" + scenario
+    end
+
+    if testset.include?("/")
+      testset_filename = testset
+    else
+      testset_filename = dir + "/" + testset
+    end
+
+    if not args['interfaces']
+      @interfaces = Array.new # initialize an empty array
+    else
+      @interfaces = args['interfaces'].split(",")
+    end
+
+    if not args['options']
+      @options = Array.new # initialize an empty array
+    else
+      @options = args['options'].split(",")
+    end
+
+    if not args['channels']
+      @arg_channels = Array.new # initialize an empty array
+    else
+      @arg_channels = args['channels'].split(",")
+    end
+
+    @errors = Array.new
+    hosts_array = Array.new
+    roles_array = Array.new
+
+    begin
+      msg @ddt_api.new_session
+
+      if File.extname(testset_filename) == ".xml"
+        msg testset_filename, Logger::DEBUG
+        f = File.open(testset_filename)
+        doc = Nokogiri::XML(f)
+        response = @http.post_xml("templates/import", doc)
+        msg "response from post(#{testset_filename}):\n#{response}", Logger::DEBUG
+        testset_uuid = doc.xpath("//ddt_set")[0].attribute('uuid')
+      elsif File.extname(testset_filename) == ".csv"
+        doc = Nokogiri::XML(@ddt_api.csv_import(testset_filename))
+        testset_uuid = doc.xpath("//message")[0].content
+      else
+        raise "Testset filename extension must be either .xml or .csv, but filename is #{testset}"
+      end
+
+      msg scenario_filename, Logger::DEBUG
+      f = File.open(scenario_filename)
+      doc = Nokogiri::XML(f)
+      response = @http.post_xml("templates/import", doc)
+      msg "response from post(#{scenario_filename}):\n#{response}", Logger::DEBUG
+
+      scenario_name = doc.xpath("//scenario")[0].attribute('name')
+      hosts = doc.xpath("//hosts/host")
+      scenario_uuid = doc.xpath("//scenario")[0].attribute('uuid')
+      roles = doc.xpath("//hosts/host/role")
+      ids = doc.xpath("//hosts/host/id")
+      channels = doc.xpath("//steps/channel")
+      type = doc.xpath("//hosts/host/type")[0].text
+
+      if !@interfaces.empty?
+        if @interfaces.size != hosts.size
+          msg "Error. The number of hosts/interfaces specified on the command-line does not equal the number
+               of hosts in the template. #{@interfaces.size} != #{hosts.size}"
+          return
+        end
+      end
+
+      msg @ddt_api.load_scenario(scenario_uuid)
+
+      roles.each_with_index do | r, i |
+         content = r.content
+         if @interfaces.empty?
+           begin
+             host = content.match(/\(.*\)/).to_s
+             host = host[1, host.index(".") - 1].downcase
+             hosts_array << host
+           rescue => e
+             puts e
+             puts "no hosts were specified, and none were found embedded in the role, e.g. 'client (A1.V4)'"
+           end
+         else
+           hosts_array << @interfaces[i]
+         end
+         roles_array << content # use the whole name for the role
+      end
+
+      msg @ddt_api.set_hosts(roles_array, hosts_array, type)
+
+      # if there are channels in the scenario, bind them
+      if channels.size > 0
+        if @arg_channels.size != channels.size
+          msg "Error. The number of channels specified on the command-line does not equal the number
+               of channels in the template. #{@arg_channels.size} != #{channels.size}"
+          return
+        end
+        
+        channel_roles = Array.new
+        channel_names = Array.new
+        @arg_channels.each do | c |
+          channel_roles << "channel" # role is always "channel"
+          channel_names << c
+        end
+        msg @ddt_api.set_channels(channel_roles, channel_names)
+      end
+
+      # if there are options specified on the command-line, set them
+      if !@options.empty?
+         option_names = Array.new
+         option_values = Array.new
+         @options.each do | o |
+           opts = o.split(":")
+           option_names << opts[0]
+           option_values << opts[1]
+         end
+         msg @ddt_api.set_options(option_names, option_values)
+      end
+
+      # verify the scenario
+      msg @ddt_api.setup_test
+      response = @ddt_api.run
+      if response == ""
+        msg "==> #{scenario_name} run returned without status"
+        @errors << "#{scenario_name}: status = #{response}"
+      else
+        doc = Nokogiri::XML(response)
+        status = doc.xpath("//status")[0].content
+        msg "==> #{scenario_name}: status = #{status}"
+        if status == 'failed'
+        # on error, add to the errors array
+          @errors << "#{scenario_name}: status = #{status}"
+        end
+      end
+
+      msg @ddt_api.run_testset(testset_uuid)
+      results = @ddt_api.collect_results # will wait until 'Done' is returned by status
+      msg "results = #{results}"
+      if results.to_s.include?("FAILED")
+        @errors << "test failed"
+
+      msg @ddt_api.teardown_test
+      msg @ddt_api.close_session
+
+      # clear the hosts and roles array for the next iteration
+      roles_array.clear
+      hosts_array.clear
+    end # if !exclude_list.include? and hosts.length
+   end
+  ensure
+    teardown
+  end
+
+private
+
+  def setup
+    @host = (@@mu_ip.nil?) ? "127.0.0.1" : @@mu_ip
+    @username  = (@@mu_admin_user.nil?) ? "admin" : @@mu_admin_user
+    @password  = (@@mu_admin_pass.nil?) ? "admin" : @@mu_admin_pass
+    @ddt_api = Ddt.new(@host, @username, @password)
+    @docroot ="/api/v3/"
+    @http = HttpHelper.new(@host, @username, @password, @docroot)
+  end
+
+  def teardown
+    unless @ddt_api.nil?
+      @ddt_api.close_all_sessions
+    end
+  end
+
+  def output_results(filename, doc)
+    f = File.open(filename, "a")
+   # doc = "#{msl_file},#{@executed},#{@errors.to_i},#{@timeouts.to_i}\n"
+    File.open(filename, 'a') {|f| f.write(doc) }
+  end
+
+  def parse_cli argv
+      hash = Hash.new
+      while not argv.empty?
+          break if argv.first[0,1] != '-'
+
+          k = argv.shift
+
+          if [ '-c', '--channels' ].member? k
+              hash['channels'] = shift(k, argv)
+              next
+          end
+
+          if [ '-d', '--dir' ].member? k
+              hash['dir'] = shift(k, argv)
+              next
+          end
+
+          if [ '-i', '--interfaces' ].member? k
+              hash['interfaces'] = shift(k, argv)
+              next
+          end
+
+          if [ '-h', '--help' ].member? k
+              help
+              exit
+          end
+
+          if [ '-m', '--mu_string' ].member? k
+             mu_string = shift(k, argv)
+             if mu_string =~ /(.+?):(.+?)@(.*)/
+               @@mu_admin_user = $1
+               @@mu_admin_pass = $2
+               @@mu_ip = $3
+             end
+             next
+          end
+
+          if [ '-o', '--output' ].member? k
+            $stdout.reopen(shift(k, argv), "w")
+            next
+          end
+
+          if [ '-p', '--options' ].member? k
+              hash['options'] = shift(k, argv)
+              next
+          end
+
+          if [ '-s', '--scenario' ].member? k
+              hash['scenario'] = shift(k, argv)
+              next
+          end
+
+          if [ '-t', '--testset' ].member? k
+              hash['testset'] = shift(k, argv)
+              next
+          end
+
+          if [ '-v', '--verbose' ].member? k
+            $log.level = Logger::DEBUG
+            next
+          end
+
+          raise ArgumentError, "Unknown option #{k}"
+      end
+
+      hash
+  end
+
+  def help
+        helps = [
+            { :short => '-c', :long => '--channels', :value => '<string>', :help => 'comma-separated list of channel hosts' },
+            { :short => '-d', :long => '--dir', :value => '<string>', :help => 'directory containing the scenario file' },
+            { :short => '-h', :long => '--help', :value => '', :help => 'help on command line options' },
+            { :short => '-i', :long => '--interfaces', :value => '<string>', :help => 'comma-separated list of interfaces/hosts, e.g. b1,dell-server' },
+            { :short => '-m', :long => '--mu_string', :value => '<string>', :help => 'user, password, mu_ip in the form of admin:admin@10.9.8.7' },
+            { :short => '-o', :long => '--output', :value => '<string>', :help => 'output logging to this file' },
+            { :short => '-p', :long => '--options', :value => '<string>', :help => 'comma-separated list of of options name:value pairs' },
+            { :short => '-s', :long => '--scenario', :value => '<string>', :help => 'name of scenario file to run' },
+            { :short => '-t', :long => '--testset', :value => '<string>', :help => 'name of testset to run' },
+            { :short => '-v', :long => '--verbose', :value => '', :help => 'set Logger::DEBUG level' }
+        ]
+
+        cmds = [
+           "mu cmd_runverify:help",
+           "mu cmd_runverify:run -s <scenario> -t <testset> -i <hosts>"
+        ]
+
+        max_long_size = helps.inject(0) { |memo, obj| [ obj[:long].size, memo ].max }
+        max_value_size = helps.inject(0) { |memo, obj| [ obj[:value].size, memo ].max }
+        puts
+        puts "Usage: mu cmd_runverify:<command> <options>"
+        puts
+        helps.each do |h|
+            puts "%-*s %*s %-*s %s" % [max_long_size, h[:long], 2, h[:short], max_value_size, h[:value], h[:help]]
+        end
+        puts
+        puts "Available Commands"
+        puts
+        cmds.each do | c |
+           puts c
+        end
+        puts
+    end
+
+end
+end # Command
+end # Mu
+