teuton 3.3.0 → 3.4.0

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

@@ -2,23 +2,83 @@ 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
-
+    AVAILABLE = [
+      %i[last_target failed now],
+      %i[last_target passed now],
+      %i[every_target failed eachtime],
+      %i[every_target passed eachtime],
+      %i[all_targets failed atend],
+      %i[all_targets passed atend]
+    ].freeze
     attr_reader :actions, :events, :current_action
+    attr_writer :log
 
     def initialize
       @current_action = nil
       @actions = []
-      @events = {runonce: [], repeat: []}
+      @events = []
       @stopped = false
+      @log = nil
+    end
+
+    def check_event(args)
+      object = args[:on]
+      condition = args[:when]
+      options = AVAILABLE.select { |obj, cond| obj == object && cond == condition }
+      if options.empty?
+        Logger.warn "Unkown! Event on: #{object}, when: #{condition}"
+        return false
+      elsif options.count > 1
+        Logger.warn "More than one definition! Event on: #{object}, when: #{condition}"
+      end
+      true
     end
 
-    def add_event(...)
+    def add_event(args, block)
+      return unless check_event(args)
+
+      object = args[:on]
+      condition = args[:when]
+      if object == :last_target
+        trigger_on_last_target(args, block)
+      elsif object == :all_targets
+        trigger_on_all_targets(args, block)
+      else
+        id = events.count
+        events << {id: id, args: args, block: block, type: :eachtime}
+        log "Register (sinde target #{last_action.id}) event on: #{object} , when: #{condition}"
+      end
     end
 
-    def check_event(...)
+    def close(report)
+      trigger_events!
+      @current_action = nil
+
+      # Calculate final values
+      @grade = @max_weight = @good_weight = @fails_weight = @fail_counter = 0
+      @history = ""
+
+      @actions.each do |action|
+        @max_weight += action.weight if action.weight.positive?
+
+        if action.check
+          @good_weight += action.weight
+          @history += Settings.letter[:good]
+        else
+          @fails_weight += action.weight
+          @fail_counter += 1
+          @history += Settings.letter[:fail]
+        end
+      end
+
+      report.lines += @actions.map(&:to_h)
+      report.history = @history
+
+      report.tail[:max_weight] = @max_weight
+      report.tail[:good_weight] = @good_weight
+      report.tail[:fail_weight] = @fails_weight
+      report.tail[:fail_counter] = @fail_counter
+      report.tail[:grade] = calculate_grade(report)
     end
 
     def last_action
@@ -38,16 +98,28 @@ class Case
       @current_action
     end
 
+    def current_score
+      current_good_weight = @actions.sum(&:score)
+      value = current_good_weight.to_f / @max_weight
+      value = 0.0 if value.nan?
+      value
+    end
+
     def stopped?
       @stopped
     end
 
     def scores_to_zero
-      @action.each { |action| action.score = 0 }
+      @actions.each do |action|
+        action.score = 0.0
+        action.description << " (SCORE TO ZERO)"
+      end
+      log("Scores set to ZERO!")
     end
 
     def stop
-      @stop_test = true
+      @stopped = true
+      log("Test STOPPED!")
     end
 
     def to_h
@@ -55,9 +127,72 @@ class Case
     end
 
     def trigger_events!
-      @events[:repeat].each do |event|
-        # TODO: Do something
+      @events.each do |event|
+        # TODO: Do something if type == :eachtime
+      end
+
+      return unless @stopped
+
+      @current_action.description = "TEST STOPPED!"
+      @current_action.command = ""
+      @current_action.exec = ""
+      @current_action.conn_type = "?"
+      @current_action.duration = "?"
+      @current_action.result = ""
+      @current_action.output = ""
+      @current_action.alterations = ""
+      @current_action.expected = ""
+      @current_action.check = false
+      @current_action.score = 0.0
+    end
+
+    private
+
+    def log(...)
+      return if @log.nil?
+
+      @log.call(...)
+    end
+
+    def calculate_grade(report)
+      current_good_weight = @actions.sum(&:score)
+      current_score = current_good_weight.to_f / @max_weight
+      current_score = 0.0 if current_score.nan?
+
+      @grade = (100.0 * current_score).round
+
+      @grade = 0.0 if report.tail[:unique_fault].positive?
+      @grade
+    end
+
+    def trigger_on_last_target(args, block)
+      do_ok = last_action.check && args[:when] == :is_ok
+      do_failed = !last_action.check && args[:when] == :failed
+      unless do_ok || do_failed
+        id = events.count
+        events << {id: id, args: args, block: block, status: :cancelled}
+        log "Event[#{id}] cancelled because target[#{last_action.id}] #{args[:when]}"
+      end
+      id = events.count
+      events << {id: id, args: args, block: block, status: :triggered}
+      log "Event[#{id}] triggered because target[#{last_action.id}] #{args[:when]}"
+      instance_exec(**args, &block) if block
+    end
+
+    def trigger_on_all_targets(args, block)
+      all_targets_passed = @actions.map { _1.check }.all?
+      do_all_passed = all_targets_passed && args[:when] == :is_ok
+      all_targets_failed = @actions.map { !_1.check }.all?
+      do_all_failed = all_targets_failed && args[:when] == :failed
+      unless do_all_passed || do_all_failed
+        id = events.count
+        events << {id: id, args: args, block: block, status: :cancelled}
+        log "Event[#{id}] cancelled. Not all_targets[1, #{last_action.id}] #{args[:when]}"
       end
+      id = events.count
+      events << {id: id, args: args, block: block, status: :triggered}
+      log "Event[#{id}] triggered. All_targets[1, #{last_action.id}] #{args[:when]}"
+      instance_exec(**args, &block) if block
     end
   end
 end

data/lib/teuton/case/case.rb

@@ -49,6 +49,7 @@ class Case
     @unique_values = {}
     @result = Result.new
     @action_manager = ActionManager.new
+    @action_manager.log = method(:log)
     @action = @action_manager.next_action
     @uniques = []
     @sessions = {} # Store opened sessions for this case
@@ -69,6 +70,7 @@ class Case
     return 0.0 if skip
 
     @report.tail[:grade]
+    # @action_manager.score
   end
 
   def last_action

data/lib/teuton/case/close.rb

@@ -3,6 +3,7 @@
 class Case
   def close(uniques)
     # Invoked from check_cases!
+    @action_manager.close(@report)
 
     fails = 0
     uniques.each_pair do |key, values|
@@ -12,16 +13,15 @@ class Case
       log_unique_message(key, values)
     end
     @report.tail[:unique_fault] = fails
-    @report.close
   end
 
   private
 
   def log_unique_message(key, value)
-    log("UNIQUE:", :error)
+    log("UNIQUE:", :warn)
     begin
-      log("   ├── Value     => #{key}", :error)
-      log("   └── Conflicts => #{value}", :error)
+      log("  ├── Value     => #{key}", :warn)
+      log("  └── Conflicts => #{value}", :warn)
     rescue => e
       log(key, :error)
       log(e.to_s, :error)

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

@@ -1,24 +1,5 @@
 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
+    @action_manager.add_event(args, block)
   end
 end

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

@@ -34,7 +34,7 @@ module DSL
     @action.expected = (args[:expected] || @result.expected)
 
     @action_manager.trigger_events!
-    @report.lines << @action.to_h
+    ## @report.lines << @action.to_h
     @action = @action_manager.next_action
     # TODO: weight(1.0)
 

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

@@ -4,12 +4,17 @@ module DSL
   # type => :info, :warn or :error
   def log(text = "", type = :info)
     s = " INFO"
-    s = Rainbow(" WARN").color(:yellow) if type == :warn
-    s = Rainbow("ERROR").bg(:red) if type == :error
+    s = " WARN" if type == :warn
+    s = "ERROR" 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}] #{text}" if s == ""
-    @report.lines << msg
+
+    colored_msg = msg
+    colored_msg = Rainbow(msg).yellow.bright if type == :warn
+    colored_msg = Rainbow(msg).bg(:red) if type == :error
+
+    @report.lines << colored_msg
   end
 end

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

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

data/lib/teuton/case_manager/show_resume_report.rb

@@ -46,7 +46,7 @@ class ShowResumeReport
   end
 
   def show_case_list
-    Logger.puts Rainbow(" CASE RESULTS").bright
+    Logger.puts Rainbow(" \u{2630} CASE RESULTS").bright
     table = Terminal::Table.new do |t|
       t.style = {border: :unicode}
       t.add_row %w[CASE MEMBERS GRADE STATE]
@@ -62,7 +62,7 @@ class ShowResumeReport
     @report.lines.each { |line| errors += line[:conn_status].size }
     return if errors.zero?
 
-    Logger.puts Rainbow(" CONN ERRORS").bright
+    Logger.puts Rainbow(" \u{1f5f2} CONN ERRORS").bright
     table = Terminal::Table.new do |t|
       t.style = {border: :unicode}
       t.add_row %w[CASE MEMBERS HOST ERROR]

data/lib/teuton/check/checker.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "../case/action/manager"
 require_relative "../case/dsl/macro"
 require_relative "../case/result/result"
 require_relative "../utils/project"
@@ -14,6 +15,7 @@ class Checker
   attr_reader :result
 
   def initialize(script_path, config_path)
+    @action_manager = Case::ActionManager.new
     @path = {}
     @path[:script] = script_path
     @path[:dirname] = File.dirname(script_path)

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

@@ -1,45 +1,31 @@
 require_relative "builtin"
 require_relative "expect"
+require_relative "event"
 require_relative "getset"
 require_relative "run"
+require_relative "target"
 
 module CheckDSL
-  def event(**args) # , &block)
-    @stats[:events] += 1
-    # args = on: XXX, when: XXX
-    Logger.puts "      event       on: #{args[:on]}, when: #{args[:when]}"
-  end
-
   def log(text = "", type = :info)
     @stats[:logs] += 1
     prefix = (type == :info) ? "" : "#{type.to_s.upcase}: "
     Logger.puts "      log         #{prefix}" + text.to_s
   end
 
-  def readme(text)
+  def doc(text)
     @stats[:readmes] += 1
-    Logger.puts "      readme      #{text}"
-  end
-
-  def target(desc, args = {})
-    Logger.warn "WARN  Previous 'target' requires 'expect'" if @target_begin
-    @target_begin = true
-    @stats[:targets] += 1
-    @targetid += 1
-    weight = args[:weight] ? args[:weight].to_f : 1.0
-    Logger.puts format("(%03<targetid>d) target      %<desc>s", targetid: @targetid, desc: desc)
-    Logger.puts "      weight      #{weight}"
+    Logger.puts "      doc         #{text}"
   end
 
-  def goal(...)
-    Logger.warn("Keyword deprecated: Replace 'goal' by 'target'.")
-    target(...)
+  def readme(...)
+    Logger.warn("Keyword deprecated: Replace 'readme' by 'doc'.")
+    doc(...)
   end
 
   def unique(key, _value)
     @stats[:uniques] += 1
 
-    Logger.puts "      unique      value for <#{key}>"
+    Logger.puts "   \u{26bf}  unique      value for <#{key}>"
     Logger.puts ""
   end
 end

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

@@ -0,0 +1,10 @@
+module CheckDSL
+  def event(**args)
+    if @action_manager.check_event(args)
+      @stats[:events] += 1
+      Logger.puts "   \u{1f5f2}  event       on: #{args[:on]}, when: #{args[:when]}"
+    else
+      Logger.puts "    \u{2718} event       on: #{args[:on]}, when: #{args[:when]} (UNKOWN!)"
+    end
+  end
+end

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

@@ -2,48 +2,42 @@ require_relative "expect_sequence"
 
 module CheckDSL
   def expect(cond)
-    Logger.warn "WARN  'expect' with no previous 'target'" unless @target_begin
+    Logger.warn "    \u{1f6c8} 'expect' with no previous 'target'" unless @target_begin
     Logger.puts "      alter       #{result.alterations}" unless result.alterations.empty?
     Logger.puts "      expect      #{cond} (#{cond.class})"
-    Logger.puts ""
     @target_begin = false
   end
 
   def expect_exit(cond)
-    Logger.warn "WARN  'expect' with no previous 'target'" unless @target_begin
+    Logger.warn "    \u{1f6c8} 'expect' with no previous 'target'" unless @target_begin
     Logger.puts "      expect_exit #{cond} (#{cond.class})"
-    Logger.puts ""
     @target_begin = false
   end
 
   def expect_fail
-    Logger.warn "WARN  'expect' with no previous 'target'" unless @target_begin
+    Logger.warn "    \u{1f6c8} 'expect' with no previous 'target'" unless @target_begin
     Logger.puts "      expect_fail"
-    Logger.puts ""
     @target_begin = false
   end
 
   def expect_first(cond)
-    Logger.warn "WARN  'expect' with no previous 'target'" unless @target_begin
+    Logger.warn "    \u{1f6c8} 'expect' with no previous 'target'" unless @target_begin
     Logger.puts "      alter        #{result.alterations}" unless result.alterations.empty?
     Logger.puts "      expect_first #{cond} (#{cond.class})"
-    Logger.puts ""
     @target_begin = false
   end
 
   def expect_last(cond)
-    Logger.warn "WARN  'expect' with no previous 'target'" unless @target_begin
+    Logger.warn "    \u{1f6c8} 'expect' with no previous 'target'" unless @target_begin
     Logger.puts "      alter        #{result.alterations}" unless result.alterations.empty?
     Logger.puts "      expect_last #{cond} (#{cond.class})"
-    Logger.puts ""
     @target_begin = false
   end
 
   def expect_none(cond = nil, args = {})
-    Logger.warn "WARN  'expect' with no previous 'target'" unless @target_begin
+    Logger.warn "    \u{1f6c8} 'expect' with no previous 'target'" unless @target_begin
     Logger.puts "      alter       #{result.alterations}" unless result.alterations.empty?
     Logger.puts "      expect_none #{cond} (#{cond.class})"
-    Logger.puts ""
     @target_begin = false
   end
 
@@ -56,19 +50,17 @@ module CheckDSL
   end
 
   def expect_one(cond)
-    Logger.warn "WARN  'expect' with no previous 'target'" unless @target_begin
+    Logger.warn "    \u{1f6c8} 'expect' with no previous 'target'" unless @target_begin
     Logger.puts "      alter       #{result.alterations}" unless result.alterations.empty?
     Logger.puts "      expect_one  #{cond} (#{cond.class})"
-    Logger.puts ""
     @target_begin = false
   end
 
   def expect_sequence(&block)
-    Logger.warn "WARN  'expect' with no previous 'target'" unless @target_begin
+    Logger.warn "    \u{1f6c8} 'expect' with no previous 'target'" unless @target_begin
     seq = CheckDSL::ExpectSequence.new
     seq.is_valid?(&block)
     Logger.puts "      expect_sequence #{seq.expected}"
-    Logger.puts ""
     @target_begin = false
   end
 end

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

@@ -0,0 +1,17 @@
+module CheckDSL
+  def target(desc, args = {})
+    Logger.warn "Previous 'target' requires 'expect'" if @target_begin
+    @target_begin = true
+    @stats[:targets] += 1
+    @targetid += 1
+    weight = args[:weight] ? args[:weight].to_f : 1.0
+    Logger.puts ""
+    Logger.puts format("(%03<targetid>d) target      %<desc>s", targetid: @targetid, desc: desc)
+    Logger.puts "      weight      #{weight}"
+  end
+
+  def goal(...)
+    Logger.warn("Keyword deprecated: Replace 'goal' by 'target'.")
+    target(...)
+  end
+end

data/lib/teuton/check/show.rb

@@ -64,19 +64,19 @@ class ShowCheck
       end
       t.add_row ["Groups", @stats[:groups]]
       t.add_row ["Targets", @stats[:targets]]
-      t.add_row ["Events", @stats[:events]] if @stats[:events].positive?
+      t.add_row ["Events", @stats[:events]]
       runs = @stats[:hosts].values.sum
       t.add_row ["Runs", runs]
-      @stats[:hosts].each_pair { |k, v| t.add_row [" * #{k}", v] }
+      @stats[:hosts].each_pair { |k, v| t.add_row ["- #{k}", v] }
       t.add_row ["Uniques", @stats[:uniques]] if @stats[:uniques].positive?
       t.add_row ["Logs", @stats[:logs]] if @stats[:logs].positive?
-      t.add_row ["Readmes", @stats[:readmes]] if @stats[:readmes].positive?
+      t.add_row ["Docs", @stats[:readmes]] if @stats[:readmes].positive?
 
       if @stats[:gets].size.positive?
         total = @stats[:gets].values.sum
         t.add_row ["Gets", total]
         list = @stats[:gets].sort_by { |_k, v| v }
-        list.reverse_each { |item| t.add_row [" * #{item[0]}", item[1].to_s] }
+        list.reverse_each { |item| t.add_row [" - #{item[0]}", item[1].to_s] }
       end
 
       if @stats[:sets].size.positive?
@@ -89,7 +89,7 @@ class ShowCheck
         uploads.each { |value| t.add_row ["", value] }
       end
     end
-    Logger.puts "#{table}\n"
+    Logger.puts "\n#{table}\n"
   end
 
   private
@@ -100,16 +100,16 @@ class ShowCheck
       next if k == :localhost
 
       if k.instance_of? Symbol
-        script_vars << (k.to_s + "_ip").to_sym
-        script_vars << (k.to_s + "_username").to_sym
-        script_vars << (k.to_s + "_password").to_sym
+        script_vars << :"#{k}_ip"
+        script_vars << :"#{k}_username"
+        script_vars << :"#{k}_password"
       else
-        script_vars << k.to_s + "_ip"
-        script_vars << k.to_s + "_username"
-        script_vars << k.to_s + "_password"
+        script_vars << "#{k}_ip"
+        script_vars << "#{k}_username"
+        script_vars << "#{k}_password"
       end
     end
-    @stats[:gets].keys.each { |value| script_vars << value }
+    @stats[:gets].each_key { |value| script_vars << value }
     script_vars
   end
 end

data/lib/teuton/cli/app.rb

@@ -50,22 +50,30 @@ module Teuton
         Teuton.check(projectpath, opt)
       end
 
-      map ["--readme"] => "readme"
+      map ["--doc"] => "doc"
       option :lang, type: :string
-      desc "readme DIRECTORY", "Show README extracted from test contents"
+      desc "doc DIRECTORY", "Display practice exercise statement"
       long_desc <<-LONGDESC
 
-      (1) teuton readme foo
-      , Create README.md from foo/start.rb.
+      (1) teuton doc foo
+      , Display exercise statement from foo/start.rb.
 
-      (2) teuton readme foo/demo.rb
-      , Create README.md from foo/demo.rb.
+      (2) teuton doc foo/demo.rb
+      , Display exercise statement from foo/demo.rb.
       LONGDESC
 
-      def readme(projectpath)
+      def doc(projectpath)
         Teuton.readme(projectpath, options)
       end
 
+      map ["--readme"] => "readme"
+      desc "readme DIRECTORY", "DEPRECATED! Use 'teuton doc'"
+
+      def readme(projectpath)
+        Logger.info "Use: teuton doc"
+        Logger.warn "'teuton readme' has been DEPRECATED!"
+      end
+
       map ["--run", "run"] => "play"
       option :export, type: :string
       option :cname, type: :string

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

@@ -5,7 +5,7 @@ require_relative "getset"
 require_relative "run"
 
 module ReadmeDSL
-  def readme(text)
+  def doc(text)
     if @action.description.nil?
       @current[:readme] << text # It's a group readme
     else
@@ -13,6 +13,11 @@ module ReadmeDSL
     end
   end
 
+  def readme(...)
+    Logger.warn("Keyword deprecated: Replace 'readme' by 'doc'.")
+    doc(...)
+  end
+
   def target(desc, args = {})
     previous_host = @action.host
     @action.description = desc