teuton 3.2.0 → 3.3.0

data/lib/teuton/case/action/action.rb

@@ -0,0 +1,39 @@
+class Case
+  class Action
+    attr_reader :id
+    attr_accessor :groupname, :description, :weight,
+      :command, :encoding, :host, :exec,
+      :conn_type, :duration,
+      :result, :output,
+      :alterations, :expected, :check
+    attr_writer :score
+
+    def initialize(id = 1)
+      @id = id
+      @groupname = nil
+      @description = "No description!"
+      @weight = 1.0
+      @check = false
+      @score = nil
+    end
+
+    def score
+      return @score unless @score.nil?
+      return 0.0 if @check == false
+
+      @weight
+    end
+
+    def to_h
+      {
+        id: id,
+        groupname: groupname, description: description, weight: weight,
+        command: command, encoding: encoding, host: host, exec: exec,
+        conn_type: conn_type, duration: duration,
+        result: result, output: output,
+        alterations: alterations, expected: expected, check: check,
+        score: score
+      }
+    end
+  end
+end

data/lib/teuton/case/action/manager.rb

@@ -0,0 +1,63 @@
+require_relative "action"
+
+class Case
+  class ActionManager
+    OBJECTS = %i[last_target every_target all_targets].freeze
+    CONDITIONS = %i[failed is_ok].freeze
+    ACTIONS = %i[scores_to_zero stop log].freeze
+
+    attr_reader :actions, :events, :current_action
+
+    def initialize
+      @current_action = nil
+      @actions = []
+      @events = {runonce: [], repeat: []}
+      @stopped = false
+    end
+
+    def add_event(...)
+    end
+
+    def check_event(...)
+    end
+
+    def last_action
+      @actions.last
+    end
+
+    def next_action
+      if @current_action.nil?
+        @current_action = Action.new(1)
+        return @current_action
+      end
+
+      @actions << @current_action
+      @current_action = Action.new(last_action.id + 1)
+      @current_action.groupname = last_action.groupname
+      @current_action.description = last_action.description
+      @current_action
+    end
+
+    def stopped?
+      @stopped
+    end
+
+    def scores_to_zero
+      @action.each { |action| action.score = 0 }
+    end
+
+    def stop
+      @stop_test = true
+    end
+
+    def to_h
+      @actions.map { _1.to_h }
+    end
+
+    def trigger_events!
+      @events[:repeat].each do |event|
+        # TODO: Do something
+      end
+    end
+  end
+end

data/lib/teuton/case/case.rb

@@ -4,6 +4,8 @@ require_relative "../utils/project"
 require_relative "../utils/verbose"
 require_relative "../report/report"
 require_relative "dsl/all"
+# require_relative "action/action"
+require_relative "action/manager"
 require_relative "config"
 require_relative "close"
 # require_relative "builtin/main"
@@ -15,26 +17,24 @@ class Case
   include DSL
   include Verbose
 
-  # Updated by ExecuteManager
+  # INFO: Used by ExecuteManager
   attr_accessor :action, :result, :sessions, :conn_status
-  # Readed by ExecuteManager
-  attr_reader :id, :config, :uniques, :skip
+  attr_reader :id, :config, :uniques, :skip, :action_manager
 
-  @@id = "01" # First case ID value
+  @current_case_id = Project.value[:base_case_id]
+
+  def self.next_id
+    @current_case_id = @current_case_id.next
+  end
 
   def initialize(config)
     @config = Case::Config.new(
       local: config,
       global: Project.value[:global]
     )
+    @id = Case.next_id
     @groups = Project.value[:groups]
-
-    @id = @@id
-    @@id = @@id.next
-
-    # Define Case Report
     @report = Report.new(@id)
-    @report.output_dir = Project.value[:output_dir]
 
     # Default configuration
     @skip = false
@@ -43,23 +43,16 @@ class Case
       @skip = true
       @skip = false if Project.value[:options]["case"].include? @id.to_i
     end
-    @verbose = Project.value[:verbose]
-
     @tempdir = File.join(Project.value[:output_dir], "tmp", @id.to_s)
+    @verbose = Project.value[:verbose]
 
     @unique_values = {}
     @result = Result.new
-    @action_counter = 0
-    @action = {
-      id: 0,
-      weight: 1.0,
-      description: "No description!",
-      groupname: nil
-    }
+    @action_manager = ActionManager.new
+    @action = @action_manager.next_action
     @uniques = []
     @sessions = {} # Store opened sessions for this case
     @conn_status = {}
-    tempfile :default
   end
 
   def export(format)
@@ -69,7 +62,6 @@ class Case
   end
 
   def filename
-    # called from: close_main_report
     @report.filename
   end
 
@@ -79,6 +71,10 @@ class Case
     @report.tail[:grade]
   end
 
+  def last_action
+    @action_manager.actions.last
+  end
+
   def members
     return "-" if skip
 

data/lib/teuton/case/close.rb

@@ -5,11 +5,11 @@ class Case
     # Invoked from check_cases!
 
     fails = 0
-    @uniques.each do |key|
-      next unless uniques[key].include?(id) && uniques[key].count > 1
+    uniques.each_pair do |key, values|
+      next unless values&.include?(id) && (values&.count&.> 1)
 
       fails += 1
-      log_unique_message(key, uniques[key])
+      log_unique_message(key, values)
     end
     @report.tail[:unique_fault] = fails
     @report.close

data/lib/teuton/case/dsl/all.rb

@@ -1,3 +1,4 @@
+require_relative "event"
 require_relative "expect"
 require_relative "getset"
 require_relative "host"

data/lib/teuton/case/dsl/event.rb

@@ -0,0 +1,24 @@
+module DSL
+  def event(**args, &block)
+    object = args[:on]
+    unless Case::ActionManager::OBJECTS.include? object
+      Logger.warn "Incorrect argument in event on: #{object} ..."
+      Logger.info "Valid OBJECTS: #{Case::ActionManager::OBJECTS.join(",")}"
+      return
+    end
+    condition = args[:when]
+    unless Case::ActionManager::CONDITIONS.include? condition
+      Logger.warn "Incorrect argument in event on: :#{object} when: #{condition}"
+      Logger.info "Valid CONDITIONS: #{Case::ActionManager::CONDITIONS.join(",")}"
+      return
+    end
+
+    if object == :every_target
+      @action_manager.events << {args: args, block: block}
+    else
+      # last_target, all_targets
+      log "Event triggered on: #{object}, when: #{condition} Target #{@action.id}"
+      # TODO: do something more
+    end
+  end
+end

data/lib/teuton/case/dsl/expect.rb

@@ -15,27 +15,28 @@ module DSL
     elsif input.instance_of?(String) || input.instance_of?(Regexp) || input.instance_of?(Array)
       expect_any input
     else
-      puts Rainbow("[ERROR] Case expect TypeError: <expect #{input} (#{input.class})>").bright.red
+      Logger.warn "Case expect TypeError: <expect #{input} (#{input.class})>"
     end
   end
 
   def expect2(cond, args = {})
-    @action_counter += 1
-    @action[:id] = @action_counter
-    if @result.exitcode < 0
+    if @result.exitcode.negative?
       # When exitcode is less than zero, it is because there has been
       # an error in the remote connection (SSH or Telnet)
-      @action[:check] = false
-      @action[:result] = @action[:output]
+      @action.check = false
+      @action.result = @action.output
     else
-      @action[:check] = cond
-      @action[:result] = (args[:value] || @result.value)
+      @action.check = cond
+      @action.result = (args[:value] || @result.value)
     end
 
-    @action[:alterations] = @result.alterations
-    @action[:expected] = (args[:expected] || @result.expected)
-    @report.lines << @action.clone
-    weight(1.0)
+    @action.alterations = @result.alterations
+    @action.expected = (args[:expected] || @result.expected)
+
+    @action_manager.trigger_events!
+    @report.lines << @action.to_h
+    @action = @action_manager.next_action
+    # TODO: weight(1.0)
 
     c = Settings.letter[:fail]
     c = Settings.letter[:good] if cond

data/lib/teuton/case/dsl/expect_sequence.rb

@@ -164,8 +164,7 @@ class ExpectSequence
     elsif value.is_a? Regexp
       return true << index if value.match(line)
     else
-      puts Rainbow("[ERROR] expect_sequence #{value.class}").bright.red
-      exit 1
+      raise Teuton::UnexpectedSequenceTypeError, value.class
     end
     false
   end

data/lib/teuton/case/dsl/log.rb

@@ -1,19 +1,15 @@
 require "rainbow"
 
 module DSL
-  ##
-  # Record log message
-  # @param text (String)
-  # @param type (Symbol) Values :info, :warn or :error
+  # type => :info, :warn or :error
   def log(text = "", type = :info)
     s = " INFO"
-    s = Rainbow("WARN!").color(:yellow) if type == :warn
+    s = Rainbow(" WARN").color(:yellow) if type == :warn
     s = Rainbow("ERROR").bg(:red) if type == :error
     t = Time.now
     f = format("%<hour>02d:%<min>02d:%<sec>02d", {hour: t.hour, min: t.min, sec: t.sec})
-    msg = "[#{f}] #{s}: #{text}"
+    msg = "[#{f}] #{s}| #{text}"
     msg = "[#{f}] #{text}" if s == ""
     @report.lines << msg
   end
-  # alias_method :msg, :log
 end

data/lib/teuton/case/dsl/macro.rb

@@ -11,9 +11,9 @@ module DSL
   def macro(name, input = {})
     macros = Project.value[:macros]
     unless macros[name]
-      msg = "DSL '#{name}' not found!"
+      msg = "Unknown DSL keyword '#{name}'"
       log(msg, :error)
-      Logger.error("ERROR #{msg}")
+      Logger.warn(msg)
       return
     end
     input.each_pair { |k, v| set(k, v) }
@@ -39,6 +39,7 @@ module DSL
     elsif a[0, 6] == "macro_"
       return macro a[6, a.size], args
     end
+
     macro a, args
   end
 

data/lib/teuton/case/dsl/run.rb

@@ -4,32 +4,26 @@ require_relative "../execute/execute_manager"
 
 module DSL
   ##
-  # DSL run and goto
-  # run: It's the same as goto :localhost
+  # DSL run
   # @param command (String)
   # @param args (Hash)
   def run(command, args = {})
-    args[:exec] = command.to_s
-    host = args[:on] || :localhost
-    goto(host, args)
-  end
+    @action.command = command.to_s
+    @action.host = args[:on] || :localhost
+    @action.encoding = args[:encoding] || "UTF-8"
 
-  # Run command from the host identify as "host"
-  # goto :host1, execute: "command"
-  def goto(host = :localhost, args = {})
     @result.reset
-    args[:on] = host unless args[:on]
-    @action[:command] = args[:execute].to_s if args[:execute]
-    @action[:command] = args[:exec].to_s if args[:exec]
-    tempfile(args[:tempfile]) if args[:tempfile]
-    @action[:encoding] = args[:encoding] || "UTF-8"
 
-    ExecuteManager.new(self).call(host)
-    @action[:output] = if @result.content.size < 2
+    ExecuteManager.new(self).call(@action.host)
+    @action.output = if @result.content.size < 2
       @result.value.clone
     else
       "(#{@result.content.size} lines)"
     end
   end
-  alias_method :on, :goto
+
+  def goto(...)
+    Logger.warn "Keyword DSL deprecated! <goto>"
+    run(...)
+  end
 end

data/lib/teuton/case/dsl/send.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module DSL
-  # * send, tempfile, tempdir, remote_tempdir, remote_tempfile
+  # * send, tempdir, remote_tempdir
   def send(logfile, args = {})
     return if skip?
 
@@ -46,26 +46,10 @@ module DSL
     end
   end
 
-  def tempfile(input = nil)
-    return @action[:tempfile] if input.nil?
-
-    name = input
-    name = "teuton.tmp" if input == :default
-
-    @action[:tempfile] = File.join(@tempdir, name)
-    @action[:remote_tempfile] = File.join(remote_tempdir, name)
-
-    @action[:tempfile]
-  end
-
   def tempdir
     @tempdir
   end
 
-  def remote_tempfile
-    @action[:remote_tempfile]
-  end
-
   def remote_tempdir
     File.join("/", "tmp") # TODO: Remove this?
   end

data/lib/teuton/case/dsl/target.rb

@@ -3,14 +3,18 @@
 # DSL#target
 module DSL
   def readme(_text)
-    # Usefull only for "teuton reamde" command action.
+    # Usefull when running.
+    # It's works only with "teuton reamde" command action.
   end
 
   def target(desc, args = {})
-    @action[:description] = desc.to_s
-    @action[:asset] = args[:asset].to_s if args[:asset]
+    @action.description = desc.to_s
     w = args[:weight] || 1.0
     weight(w)
   end
-  alias_method :goal, :target
+
+  def goal(...)
+    Logger.warn("Keyword deprecated: Replace 'goal' by 'target'.")
+    target(...)
+  end
 end

data/lib/teuton/case/dsl/upload.rb

@@ -15,10 +15,7 @@ module DSL
   end
 
   def upload_one(localpath, args = {})
-    if args[:to].nil?
-      Logger.err("ERROR upload requires to: XXX")
-      exit 1
-    end
+    raise ArgumentError, "upload requires 'to: XXX'" if args[:to].nil?
 
     host = get_host(args[:to])
     if host.protocol == "ssh"

data/lib/teuton/case/dsl/weight.rb

@@ -2,11 +2,11 @@ module DSL
   def weight(value = nil)
     # Set weight value for the action
     if value.nil?
-      @action[:weight]
+      @action.weight
     elsif value == :default
-      @action[:weight] = 1.0
+      @action.weight = 1.0
     else
-      @action[:weight] = value.to_f
+      @action.weight = value.to_f
     end
   end
 end

data/lib/teuton/case/execute/execute_base.rb

@@ -1,7 +1,7 @@
 class ExecuteBase
   def initialize(parent)
     @parent = parent
-    # READ: @config, cmd = action[:command]
+    # READ: @config, cmd = action.command
     # WRITE: @action, @result, @session
   end
 

data/lib/teuton/case/execute/execute_local.rb

@@ -8,8 +8,8 @@ class ExecuteLocal < ExecuteBase
   include Verbose
 
   def call
-    action[:conn_type] = :local
-    response = my_execute(action[:command], action[:encoding])
+    action.conn_type = :local
+    response = my_execute(action.command, action.encoding)
     result.exitcode = response[:exitcode]
     result.content = response[:content]
   end

data/lib/teuton/case/execute/execute_manager.rb

@@ -5,7 +5,7 @@ require_relative "execute_telnet"
 class ExecuteManager
   def initialize(parent)
     @parent = parent
-    # READ: @config, cmd = action[:command]
+    # READ: @config, cmd = action.command
     # WRITE: @action, @result, @session
     # my_execute, encode_and_split methods?
   end
@@ -13,7 +13,7 @@ class ExecuteManager
   def call(host)
     start_time = Time.now
     run_on(host)
-    action[:duration] = (Time.now - start_time).round(3)
+    action.duration = (Time.now - start_time).round(3)
   end
 
   private
@@ -34,16 +34,16 @@ class ExecuteManager
     protocol = config.get(:"#{host}_protocol")
     ip = config.get(:"#{host}_ip")
 
-    if protocol.to_s.downcase == "local" || host.to_s == "localhost"
+    if protocol.to_s.casecmp("local").zero? || host.to_s == "localhost"
       # Protocol force => local
       ExecuteLocal.new(@parent).call
-    elsif protocol.to_s.downcase == "ssh"
+    elsif protocol.to_s.casecmp("ssh").zero?
       # Protocol force => ssh
       ExecuteSSH.new(@parent).call(host)
-    elsif protocol.to_s.downcase == "telnet"
+    elsif protocol.to_s.casecmp("telnet").zero?
       # Protocol force => telnet
       ExecuteTelnet.new(@parent).call(host)
-    elsif ip.to_s.downcase == "localhost" || ip.to_s.include?("127.0.0.")
+    elsif ip.to_s.casecmp("localhost").zero? || ip.to_s.include?("127.0.0.")
       # run_cmd_localhost
       ExecuteLocal.new(@parent).call
     elsif ip == "NODATA"

data/lib/teuton/case/execute/execute_ssh.rb

@@ -6,7 +6,7 @@ require_relative "execute_base"
 
 class ExecuteSSH < ExecuteBase
   def call(input_hostname)
-    action[:conn_type] = :ssh
+    action.conn_type = :ssh
     hostname = input_hostname.to_s
     ip = config.get(:"#{hostname}_ip").to_s
     username = config.get(:"#{hostname}_username").to_s
@@ -20,14 +20,14 @@ class ExecuteSSH < ExecuteBase
       ip2 = ip
       username2 = username
       password2 = password
-      command2 = action[:command]
+      command2 = action.command
       hostname = config.get(:"#{hostname}_route")
       ip = config.get(:"#{hostname}_ip").to_s
       username = config.get(:"#{hostname}_username").to_s
       password = config.get(:"#{hostname}_password").to_s
       ostype = config.get(:"#{hostname}_ostype").to_s
 
-      action[:command] = if ostype.downcase.start_with? "win"
+      action.command = if ostype.downcase.start_with? "win"
         "echo y | plink #{username2}@#{ip2} -ssh -pw #{password2} \"#{command2}\""
       else
         "sshpass -p #{password2} #{username2}@#{ip2} #{command2}"
@@ -49,7 +49,7 @@ class ExecuteSSH < ExecuteBase
         )
       end
       if sessions[hostname].instance_of? Net::SSH::Connection::Session
-        text = sessions[hostname].exec!(action[:command])
+        text = sessions[hostname].exec!(action.command)
         exitcode = text.exitstatus
       else
         text = "TEUTON_ERROR_SSH_NO_CONNECTION"
@@ -84,9 +84,9 @@ class ExecuteSSH < ExecuteBase
       text = "TEUTON_ERROR_SSH"
       exitcode = -1
       log("[#{e.class}] SSH on <#{username}@#{ip}>" \
-          " exec: #{action[:command]}", :error)
+          " exec: #{action.command}", :error)
     end
     result.exitcode = exitcode
-    result.content = encode_and_split(action[:encoding], text)
+    result.content = encode_and_split(action.encoding, text)
   end
 end

data/lib/teuton/case/execute/execute_telnet.rb

@@ -4,7 +4,7 @@ require_relative "execute_base"
 
 class ExecuteTelnet < ExecuteBase
   def call(input_hostname)
-    action[:conn_type] = :telnet
+    action.conn_type = :telnet
     hostname = input_hostname.to_s
     ip = config.get((hostname + "_ip").to_sym)
     port = config.get((hostname + "_port").to_sym)
@@ -31,7 +31,7 @@ class ExecuteTelnet < ExecuteBase
           password = config.get((hostname + "_password").to_sym).to_s
           h.login(username, password)
         end
-        h.cmd(action[:command]) { |i| text << i }
+        h.cmd(action.command) { |i| text << i }
         h.close
         sessions[hostname] = :ok
         exitcode = 0
@@ -51,11 +51,11 @@ class ExecuteTelnet < ExecuteBase
       sessions[hostname] = :nosession
       conn_status[hostname] = :error
       log(" ExceptionType=<#{e.class}> doing telnet on <#{username}@#{ip}>" \
-          " exec: #{action[:command]}", :error)
+          " exec: #{action.command}", :error)
       log(" └── username=<#{username}>, password=<#{password}>," \
           " ip=<#{ip}>, HOSTID=<#{hostname}>", :warn)
     end
     result.exitcode = exitcode
-    result.content = encode_and_split(action[:encoding], text)
+    result.content = encode_and_split(action.encoding, text)
   end
 end

data/lib/teuton/case/play.rb

@@ -2,7 +2,6 @@
 
 class Case
   # READ: sessions, config, groups, action, report
-  # TODO: groups from Project or from Case???
   def play
     if skip?
       verbose Rainbow("S").green
@@ -13,7 +12,7 @@ class Case
     fill_report(start_time, Time.now)
     close_opened_sessions
   end
-  alias_method :start, :play
+  # alias_method :start, :play
 
   private
 
@@ -25,18 +24,18 @@ class Case
 
   def play_groups_in_sequence
     verboseln "\n==> Running case [#{@config.get(:tt_members)}]" if get(:tt_sequence) == true
-    @groups.each do |t|
-      @action[:groupname] = t[:name]
-      instance_eval(&t[:block])
+    @groups.each do |group|
+      @action.groupname = group[:name]
+      instance_eval(&group[:block])
     end
   end
 
   def play_groups_in_parallel
     verboseln "Running case [#{@config.get(:tt_members)}]"
-    @groups.each do |t|
-      verbose "* Processing [#{t[:name]}] "
-      @action[:groupname] = t[:name]
-      instance_eval(&t[:block])
+    @groups.each do |group|
+      verbose "* Processing [#{group[:name]}] "
+      @action.groupname = group[:name]
+      instance_eval(&group[:block])
       verbose "\n"
     end
     verboseln "\n"