teuton 2.3.6 → 2.3.8

data/lib/teuton/case_manager/case/runner.rb

@@ -1,43 +1,33 @@
+require "net/ssh"
+require "net/sftp"
+require "net/telnet"
+require_relative "dsl/log"
 
-require 'net/ssh'
-require 'net/sftp'
-require 'net/telnet'
-require_relative 'dsl/log'
-
-# Class Case
-# * run_local_cmd
-# * run_remote_cmd
-# * run_remote_cmd_ssh
-# * reconfigure_command_with_gateway
-# * run_remote_cmd_telnet
 class Case
-
   private
 
   def run_cmd_on(host)
     protocol = @config.get("#{host}_protocol".to_sym)
     ip = @config.get("#{host}_ip".to_sym)
 
-    if (protocol.to_s.downcase == 'local' || host.to_s == 'localhost')
-      run_cmd_localhost() # Protocol force => local
-    elsif protocol.to_s.downcase == 'ssh'
+    if protocol.to_s.downcase == "local" || host.to_s == "localhost"
+      run_cmd_localhost # Protocol force => local
+    elsif protocol.to_s.downcase == "ssh"
       run_cmd_remote_ssh(host) # Protocol force => ssh
-    elsif protocol.to_s.downcase == 'telnet'
-        run_cmd_remote_telnet(host) # Protocol force => telnet
-    elsif (ip.to_s.downcase == 'localhost' || ip.to_s.include?('127.0.0.'))
-      run_cmd_localhost()
-    elsif ip == 'NODATA'
+    elsif protocol.to_s.downcase == "telnet"
+      run_cmd_remote_telnet(host) # Protocol force => telnet
+    elsif ip.to_s.downcase == "localhost" || ip.to_s.include?("127.0.0.")
+      run_cmd_localhost
+    elsif ip == "NODATA"
       log("#{host} IP not found!", :error)
     else
       run_cmd_remote_ssh host
     end
   end
 
-  ##
-  # Run command on local machine
-  def run_cmd_localhost()
+  def run_cmd_localhost
     @action[:conn_type] = :local
-    i = my_execute( @action[:command], @action[:encoding] )
+    i = my_execute(@action[:command], @action[:encoding])
     @result.exitstatus = i[:exitstatus]
     @result.content = i[:content]
   end
@@ -47,9 +37,9 @@ class Case
   # @param input_hostname (Symbol or String)
   def run_cmd_remote(input_hostname)
     hostname = input_hostname.to_s
-    i = (hostname + '_protocol').to_sym
+    i = (hostname + "_protocol").to_sym
     protocol = @config.get(i) if @config.get(i)
-    protocol = :ssh if protocol.nil? || protocol == 'NODATA'
+    protocol = :ssh if protocol.nil? || protocol == "NODATA"
     protocol = protocol.to_sym
     case protocol
     when :ssh
@@ -57,7 +47,7 @@ class Case
     when :telnet
       run_cmd_remote_telnet(input_hostname)
     when :local
-      run_cmd_localhost()
+      run_cmd_localhost
     else
       log("Protocol #{protocol} unknown! Use ssh or telnet.", :error)
     end
@@ -72,9 +62,9 @@ class Case
     port = @config.get("#{hostname}_port".to_sym).to_i
     port = 22 if port.zero?
 
-    unless @config.get("#{hostname}_route".to_sym) == 'NODATA'
+    unless @config.get("#{hostname}_route".to_sym) == "NODATA"
       # Reconfigure command with gateway. Example host1_route: IP.
-      hostname2 = hostname
+      # hostname2 = hostname ¿not used?
       ip2 = ip
       username2 = username
       password2 = password
@@ -85,26 +75,27 @@ class Case
       password = @config.get("#{hostname}_password".to_sym).to_s
       ostype = @config.get("#{hostname}_ostype".to_sym).to_s
 
-      if ostype.downcase.start_with? 'win'
-        # echo y | plink idp@2.tcp.eu.ngrok.io -ssh -P 16256 -pw idp "echo > Desktop\hola.txt"
-        @action[:command] = "echo y | plink #{username2}@#{ip2} -ssh -pw #{password2} \"#{command2}\""
+      @action[:command] = if ostype.downcase.start_with? "win"
+        "echo y | plink #{username2}@#{ip2} -ssh -pw #{password2} \"#{command2}\""
       else
-        @action[:command] = "sshpass -p #{password2} #{username2}@#{ip2} #{command2}"
+        "sshpass -p #{password2} #{username2}@#{ip2} #{command2}"
       end
     end
 
-    text = ''
+    text = ""
     begin
       if @sessions[hostname].nil?
-        @sessions[hostname] = Net::SSH.start(ip,
-                                             username,
-                                             port: port,
-                                             password: password,
-                                             keepalive: true,
-                                             timeout: 30,
-                                             non_interactive: true)
+        @sessions[hostname] = Net::SSH.start(
+          ip,
+          username,
+          port: port,
+          password: password,
+          keepalive: true,
+          timeout: 30,
+          non_interactive: true
+        )
       end
-      if @sessions[hostname].class == Net::SSH::Connection::Session
+      if @sessions[hostname].instance_of? Net::SSH::Connection::Session
         text = @sessions[hostname].exec!(@action[:command])
       end
     rescue Errno::EHOSTUNREACH
@@ -116,18 +107,18 @@ class Case
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :error_authentication_failed
       verbose Rainbow(Application.instance.letter[:error]).red.bright
-      log('SSH::AuthenticationFailed!', :error)
+      log("SSH::AuthenticationFailed!", :error)
     rescue Net::SSH::HostKeyMismatch
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :host_key_mismatch
       verbose Rainbow(Application.instance.letter[:error]).red.bright
-      log('SSH::HostKeyMismatch!', :error)
+      log("SSH::HostKeyMismatch!", :error)
       log("* The destination server's fingerprint is not matching " \
-          'what is in your local known_hosts file.', :error)
-      log('* Remove the existing entry in your local known_hosts file', :error)
+          "what is in your local known_hosts file.", :error)
+      log("* Remove the existing entry in your local known_hosts file", :error)
       log("* Try this => ssh-keygen -f '/home/USERNAME/.ssh/known_hosts' " \
           "-R #{ip}", :error)
-    rescue StandardError => e
+    rescue => e
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :error
       verbose Rainbow(Application.instance.letter[:error]).red.bright
@@ -142,21 +133,23 @@ class Case
 
   def run_cmd_remote_telnet(input_hostname)
     @action[:conn_type] = :telnet
-    app = Application.instance
+    # app = Application.instance ¿not used?
     hostname = input_hostname.to_s
-    ip = @config.get((hostname + '_ip').to_sym)
-    username = @config.get((hostname + '_username').to_sym).to_s
-    password = @config.get((hostname + '_password').to_sym).to_s
-    text = ''
+    ip = @config.get((hostname + "_ip").to_sym)
+    username = @config.get((hostname + "_username").to_sym).to_s
+    password = @config.get((hostname + "_password").to_sym).to_s
+    text = ""
     begin
       if @sessions[hostname].nil? || @sessions[hostname] == :ok
-        h = Net::Telnet.new( 'Host' => ip,
-                             'Timeout' => 30,
-                             'Prompt' => /login|teuton|[$%#>]/ )
-#                            'Prompt' => Regexp.new(username[1, 40]))
-#                            'Prompt' => /[$%#>] \z/n)
+        h = Net::Telnet.new(
+          "Host" => ip,
+          "Timeout" => 30,
+          "Prompt" => /login|teuton|[$%#>]/
+        )
+        # "Prompt" => Regexp.new(username[1, 40]))
+        # "Prompt" => /[$%#>] \z/n)
         h.login(username, password)
-        text = ''
+        text = ""
         h.cmd(@action[:command]) { |i| text << i }
         h.close
         @sessions[hostname] = :ok
@@ -166,13 +159,13 @@ class Case
       @conn_status[hostname] = :open_timeout
       verbose Rainbow(Application.instance.letter[:error]).red.bright
       log(" ExceptionType=<Net::OpenTimeout> doing <telnet #{ip}>", :error)
-      log(' └── Revise host IP!', :warn)
+      log(" └── Revise host IP!", :warn)
     rescue Net::ReadTimeout
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :read_timeout
       verbose Rainbow(Application.instance.letter[:error]).red.bright
       log(" ExceptionType=<Net::ReadTimeout> doing <telnet #{ip}>", :error)
-    rescue StandardError => e
+    rescue => e
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :error
       verbose Rainbow(Application.instance.letter[:error]).red.bright

data/lib/teuton/case_manager/case_manager.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'singleton'
-require_relative '../application'
-require_relative '../report/report'
-require_relative '../utils/configfile_reader'
-require_relative 'case/case'
-require_relative 'export_manager'
-require_relative 'main'
-require_relative 'utils'
+require "singleton"
+require_relative "../application"
+require_relative "../report/report"
+require_relative "../utils/configfile_reader"
+require_relative "case/case"
+require_relative "export_manager"
+require_relative "main"
+require_relative "utils"
 
 # This class does all the job
 # Organize the hole job, sending orders to others classes
@@ -28,7 +28,7 @@ class CaseManager
   def initialize
     @cases = []
     @report = Report.new(0)
-    @report.filename = 'resume'
+    @report.filename = "resume"
   end
 
   ##
@@ -38,10 +38,10 @@ class CaseManager
     check_cases!
     instance_eval(&block)
     # Run export if user pass option command "--export=json"
-    i = Application.instance.options['export']
+    i = Application.instance.options["export"]
     export(format: i.to_sym) unless i.nil?
     # Accept "configfile" param REVISE There exists?
-    i = Application.instance.options['configfile']
+    i = Application.instance.options["configfile"]
     export(format: i.to_sym) unless i.nil?
   end
 
@@ -52,8 +52,8 @@ class CaseManager
     if args.class != Hash
       puts "[ERROR] CaseManager#export: Argument = <#{args}>, " \
            "class = #{args.class}"
-      puts '        Usage: export :format => :colored_text'
-      raise '[ERROR] CaseManager#export: Argument error!'
+      puts "        Usage: export :format => :colored_text"
+      raise "[ERROR] CaseManager#export: Argument error!"
     end
     # Export report files
     ExportManager.run(@report, @cases, args)
@@ -64,8 +64,8 @@ class CaseManager
   # @param args (Hash) Send options
   def send(args = {})
     threads = []
-    puts ''
-    puts "[INFO] Sending files...#{args.to_s}"
+    puts ""
+    puts "[INFO] Sending files...#{args}"
     @cases.each { |c| threads << Thread.new { c.send(args) } }
     threads.each(&:join)
   end

data/lib/teuton/case_manager/check_cases.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-##
-# CaseManager: check_cases!
 class CaseManager
   private
 
@@ -18,8 +16,7 @@ class CaseManager
     app.global[:tt_sequence] = false if app.global[:tt_sequence].nil?
 
     # Create out dir
-    outdir = app.global[:tt_outdir] ||
-             File.join('var', app.global[:tt_testname])
+    outdir = app.global[:tt_outdir] || File.join("var", app.global[:tt_testname])
     ensure_dir outdir
     @report.output_dir = outdir
 

data/lib/teuton/case_manager/dsl.rb

@@ -1,10 +1,10 @@
-require_relative '../application'
-require_relative 'case_manager'
+require_relative "../application"
+require_relative "case_manager"
 
 # Define filename to be used into our test
 # @param filename (String) Filename to be required
 def use(filename)
-  filename += '.rb'
+  filename += ".rb"
   app = Application.instance
   rbfiles = File.join(app.project_path, "**", filename)
   files = Dir.glob(rbfiles)
@@ -18,7 +18,7 @@ end
 # @param name (String) macro name
 # @param block (Block) macro code
 def define_macro(name, *args, &block)
-  Application.instance.macros[name] = { args: args, block: block }
+  Application.instance.macros[name] = {args: args, block: block}
 end
 alias def_macro define_macro
 alias defmacro define_macro
@@ -27,7 +27,7 @@ alias defmacro define_macro
 # @param name (String) Group name
 # @param block (Block) Tests code
 def group(name, &block)
-  Application.instance.groups << { name: name, block: block }
+  Application.instance.groups << {name: name, block: block}
 end
 alias task group
 

data/lib/teuton/case_manager/export_manager.rb

@@ -1,17 +1,13 @@
 # frozen_string_literal: true
 
-require_relative '../application'
+require_relative "../application"
 
-##
-# ExportManager is used by CaseManager to export output reports
 module ExportManager
   ##
   # Run export function
   # @param main_report (Report)
   # @param cases (Array)
   # @param input (Hash) Selected export options
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/CyclomaticComplexity
   def self.run(main_report, cases, input)
     args = strings2symbols(input)
 
@@ -29,42 +25,35 @@ module ExportManager
     # Step 3: Preserve files if required
     preserve_files if args[:preserve] == true
   end
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/CyclomaticComplexity
 
   ##
   # Convert Hash String values into Symbol values
   # @param input (Hash)
-  # rubocop:disable Style/ConditionalAssignment
   private_class_method def self.strings2symbols(input)
     args = {}
     input.each_pair do |key, value|
-      if value.class == String
-        args[key] = value.to_sym
+      args[key] = if value.instance_of? String
+        value.to_sym
       else
-        args[key] = value
+        value
       end
     end
     args
   end
-  # rubocop:enable Style/ConditionalAssignment
 
   ##
   # Preserve output files for current project
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/MethodLength
   private_class_method def self.preserve_files
     app = Application.instance
     t = Time.now
-    data = { year: t.year, month: t.month, day: t.day,
-             hour: t.hour, min: t.min, sec: t.sec }
-    subdir = format('%<year>s%<month>02d%<day>02d-' \
-                    '%<hour>02d%<min>02d%<sec>02d', data)
+    data = {year: t.year, month: t.month, day: t.day, hour: t.hour, min: t.min, sec: t.sec}
+    subdir = format("%<year>s%<month>02d%<day>02d-" \
+                    "%<hour>02d%<min>02d%<sec>02d", data)
     logdir = File.join(app.output_basedir, app.global[:tt_testname], subdir)
     srcdir = File.join(app.output_basedir, app.global[:tt_testname])
     puts "[INFO] Preserving files => #{logdir}"
     FileUtils.mkdir(logdir)
-    Dir.glob(File.join(srcdir, '**.*')).each { |file| FileUtils.cp(file, logdir) }
+    Dir.glob(File.join(srcdir, "**.*")).each { |file| FileUtils.cp(file, logdir) }
   end
   # rubocop:enable Metrics/AbcSize
   # rubocop:enable Metrics/MethodLength

data/lib/teuton/case_manager/hall_of_fame.rb

@@ -1,8 +1,6 @@
-
-require_relative '../application'
+require_relative "../application"
 
 class CaseManager
-
   private
 
   def build_hall_of_fame
@@ -10,10 +8,10 @@ class CaseManager
 
     @cases.each do |c|
       grade = c.grade # report.tail[:grade]
-      if celebrities[grade]
-        label = celebrities[grade] + '*'
+      label = if celebrities[grade]
+        celebrities[grade] + "*"
       else
-        label = '*'
+        "*"
       end
       celebrities[grade] = label unless c.skip
     end

data/lib/teuton/case_manager/main.rb

@@ -1,5 +1,4 @@
-
-require_relative 'check_cases'
-require_relative 'hall_of_fame'
-require_relative 'report'
-require_relative 'show'
+require_relative "check_cases"
+require_relative "hall_of_fame"
+require_relative "report"
+require_relative "show"

data/lib/teuton/case_manager/report.rb

@@ -1,9 +1,6 @@
-require 'rainbow'
-##
-# Class CaseManager
-# Methods related with report
-class CaseManager
+require "rainbow"
 
+class CaseManager
   private
 
   ##
@@ -27,22 +24,32 @@ class CaseManager
     @report.tail[:finish_time] = finish_time
     @report.tail[:duration] = finish_time - start_time
 
-    verbose Rainbow("\n==> Teuton: Duration=#{format('%3.3f',(finish_time - start_time))}").yellow.bright
+    duration = format("%3.3f", (finish_time - start_time))
+    verbose Rainbow("\n==> Teuton: Duration=#{duration}").yellow.bright
     verboseln Rainbow(" (#{finish_time})").yellow.bright
-    verboseln ' '
+    verboseln " "
 
     app = Application.instance
     @cases.each do |c|
       line = {}
       if c.skip?
-        line = { skip: true, id: '-', grade: 0.0, letter: '',
-                members: '-', conn_status: {},
-                moodle_id: '', moodle_feedback: '' }
+        line = {
+          skip: true,
+          id: "-",
+          grade: 0.0,
+          letter: "",
+          members: "-",
+          conn_status: {},
+          moodle_id: "",
+          moodle_feedback: ""
+        }
       else
         line[:skip] = false
-        line[:id] = format('%<id>02d', { id: c.id.to_i })
+        line[:id] = format("%<id>02d", {id: c.id.to_i})
+        line[:letter] = app.letter[:cross] if c.grade.zero?
         line[:letter] = app.letter[:error] if c.grade < 50.0
-        line[:grade] = c.grade.to_f #format('  %3d', c.grade.to_f)
+        line[:letter] = app.letter[:ok] if c.grade.to_i == 100
+        line[:grade] = c.grade.to_f
         line[:members] = c.members
         line[:conn_status] = c.conn_status
         line[:moodle_id] = c.get(:tt_moodle_id)
@@ -60,9 +67,7 @@ class CaseManager
     return input unless input.to_s.start_with? Dir.pwd.to_s
     return input if input == Dir.pwd.to_s
 
-    output = input.to_s
-    offset = (Dir.pwd).length + 1
-    output = "#{input[offset, input.size]}"
-    output.to_s
+    offset = Dir.pwd.length + 1
+    input[offset, input.size].to_s
   end
 end

data/lib/teuton/case_manager/show.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../application'
+require_relative "../application"
 
 # CaseManager show method
 class CaseManager
@@ -17,7 +17,7 @@ class CaseManager
     return if mode == :resume
 
     @cases.each do |c|
-      puts '=' * 40
+      puts "=" * 40
       c.show
     end
   end

data/lib/teuton/case_manager/utils.rb

@@ -1,10 +1,9 @@
-
-require_relative '../application'
-require 'fileutils'
+require_relative "../application"
+require "fileutils"
 
 module Utils
-  # Create the directory if it dosn't exist.
   def ensure_dir(dirname)
+    # Create the directory if it dosn't exist.
     unless Dir.exist?(dirname)
       FileUtils.mkdir_p(dirname)
       return false
@@ -14,15 +13,15 @@ module Utils
 
   def encode_and_split(encoding, text)
     # Convert text to UTF-8 deleting unknown chars
-    text ||= '' # Ensure text is not nil
-    flag = [:default, 'UTF-8'].include? encoding
-    return text.encode('UTF-8', invalid: :replace).split("\n") if flag
+    text ||= "" # Ensure text is not nil
+    flag = [:default, "UTF-8"].include? encoding
+    return text.encode("UTF-8", invalid: :replace).split("\n") if flag
 
     # Convert text from input ENCODING to UTF-8
-    ec = Encoding::Converter.new(encoding.to_s, 'UTF-8')
+    ec = Encoding::Converter.new(encoding.to_s, "UTF-8")
     begin
       text = ec.convert(text)
-    rescue StandardError => e
+    rescue => e
       puts "[ERROR] #{e}: Declare text encoding..."
       puts "        run 'command', on: :host, :encoding => 'ISO-8859-1'"
     end
@@ -30,18 +29,18 @@ module Utils
     text.split("\n")
   end
 
-  def my_execute(cmd, encoding = 'UTF-8')
-    return { exitstatus: 0, content: '' } if Application.instance.debug
+  def my_execute(cmd, encoding = "UTF-8")
+    return {exitstatus: 0, content: ""} if Application.instance.debug
 
     begin
       text = `#{cmd}`
       exitstatus = $CHILD_STATUS.exitstatus
-    rescue StandardError => e # rescue Exception => e
-      verbose '!'
+    rescue => e
+      verbose "!"
       puts("[ERROR] #{e}: Local exec: #{cmd}")
     end
     content = encode_and_split(encoding, text)
-    { exitstatus: exitstatus, content: content }
+    {exitstatus: exitstatus, content: content}
   end
 
   def verboseln(text)

data/lib/teuton/check/builtin.rb

@@ -10,6 +10,10 @@ class Builtin
   def method_missing(method)
     @parent.log "BUILTIN #{method}"
   end
+
+  def respond_to_missing?(_method, *)
+    true
+  end
 end
 
 # Laboratory
@@ -17,7 +21,7 @@ end
 class Laboratory
   def service(param)
     log "BUILTIN service(#{param})"
-    @builtin = @builtin || Builtin.new(self)
+    @builtin ||= Builtin.new(self)
     @builtin.param = param
     @builtin
   end

data/lib/teuton/check/dsl.rb

@@ -15,7 +15,7 @@ class Laboratory
     @stats[:targets] += 1
     @targetid += 1
     weight = args[:weight] || 1.0
-    verboseln format('(%03<targetid>d) target      %<desc>s', targetid: @targetid, desc: desc)
+    verboseln format("(%03<targetid>d) target      %<desc>s", targetid: @targetid, desc: desc)
     verboseln "      weight      #{weight}"
   end
   alias goal target
@@ -48,7 +48,7 @@ class Laboratory
   def expect(cond)
     verboseln "      alter       #{result.alterations}" unless result.alterations.empty?
     verboseln "      expect      #{cond} (#{cond.class})"
-    verboseln ''
+    verboseln ""
   end
 
   ##
@@ -56,7 +56,7 @@ class Laboratory
   def expect_one(cond)
     verboseln "      alter       #{result.alterations}" unless result.alterations.empty?
     verboseln "      expect_one  #{cond} (#{cond.class})"
-    verboseln ''
+    verboseln ""
   end
 
   ##
@@ -64,7 +64,7 @@ class Laboratory
   def expect_none(cond)
     verboseln "      alter       #{result.alterations}" unless result.alterations.empty?
     verboseln "      expect_none #{cond} (#{cond.class})"
-    verboseln ''
+    verboseln ""
   end
 
   ##
@@ -85,7 +85,7 @@ class Laboratory
   # rubocop:disable Style/MissingRespondToMissing
   def method_missing(method)
     a = method.to_s
-    instance_eval("get(:#{a[0, a.size - 1]})", __FILE__, __LINE__) if a[a.size - 1] == '?'
+    instance_eval("get(:#{a[0, a.size - 1]})", __FILE__, __LINE__) if a[a.size - 1] == "?"
   end
   # rubocop:enable Style/MissingRespondToMissing
 
@@ -93,8 +93,7 @@ class Laboratory
   # Execute Teuton DSL gett keyword
   # Same as get keyword, but show pretty output when used by readme command.
   def gett(option)
-    value = get(option)
-    value
+    get(option)
   end
 
   ##
@@ -103,12 +102,12 @@ class Laboratory
     @stats[:uniques] += 1
 
     verboseln "    ! Unique      value for <#{key}>"
-    verboseln ''
+    verboseln ""
   end
 
   ##
   # Execute Teuton DSL log keyword
-  def log(text = '', type = :info)
+  def log(text = "", type = :info)
     @stats[:logs] += 1
     verboseln "      log    [#{type}]: " + text.to_s
   end
@@ -118,8 +117,8 @@ class Laboratory
   def set(key, value)
     @stats[:sets] += 1
 
-    key = ':' + key.to_s if key.class == Symbol
-    value = ':' + value.to_s if value.class == Symbol
+    key = ":" + key.to_s if key.instance_of? Symbol
+    value = ":" + value.to_s if value.instance_of? Symbol
 
     @sets[key] = value
     "set(#{key},#{value})"