teuton 3.2.1 → 3.4.0

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
@@ -22,7 +27,16 @@ module ReadmeDSL
     weight = args[:weight].to_f if args[:weight]
     @action.weight = weight
   end
-  alias_method :goal, :target
+
+  def goal(...)
+    Logger.warn("Keyword deprecated: Replace 'goal' by 'target'.")
+    target(...)
+  end
+
+  def event(*args, &block)
+    # TODO
+    # args = on: XXX, when: XXX
+  end
 
   def unique(_key, _value)
     # Nothing to do

data/lib/teuton/readme/main.rb

@@ -20,7 +20,7 @@ def group(name, &block)
 end
 
 def task(...)
-  Logger.warn "[DEPRECATED] Replace 'task' by 'group'"
+  Logger.warn "Keyword deprecated: Replace 'task' by 'group'"
   group(...)
 end
 
@@ -29,6 +29,6 @@ def play(&block)
 end
 
 def start(...)
-  Logger.warn "[DEPRECATED] Replace `start' by' play'"
+  Logger.warn "Keyword deprecated: Replace `start' by' play'"
   play(...)
 end

data/lib/teuton/report/formatter/default/array.rb

@@ -33,45 +33,31 @@ class ArrayFormatter < BaseFormatter
     groups = []
     title = nil
     targets = []
-    @lines.each do |i|
-      unless i.instance_of? Hash
-        @data[:logs] << i.to_s # Add log line
+    @lines.each do |line|
+      unless line.instance_of? Hash
+        @data[:logs] << line.to_s # Add log line
         next
       end
 
-      value = 0.0
-      value = i[:weight] if i[:check]
-      if i[:groupname] != title
+      # value = 0.0
+      # value = line[:weight] if line[:check]
+      if line[:groupname] != title
         # Add currentgroup
         groups << {title: title, targets: targets} unless title.nil?
         # Create new group
-        title = i[:groupname]
+        title = line[:groupname]
         targets = []
       end
-
-      target = {}
-      target[:target_id] = format("%<id>02d", id: i[:id])
-      target[:check] = i[:check]
-      target[:score] = value
-      target[:weight] = i[:weight]
-      target[:description] = i[:description]
-
-      target[:conn_type] = i[:conn_type]
-      target[:duration] = i[:duration]
-
-      target[:command] = i[:command]
-      target[:output] = i[:output]
-      target[:alterations] = i[:alterations]
-      target[:expected] = i[:expected]
-      target[:result] = i[:result]
+      target = line
+      target[:target_id] = format("%<id>02d", id: line[:id])
 
       if options[:feedback] == false
-        target[:command] = "*" * i[:command].size
-        i[:output] = "" if i[:output].nil?
-        target[:output] = "*" * i[:output].size
-        target[:alterations] = "*" * i[:alterations].size
-        target[:expected] = "*" * i[:expected].size
-        target[:result] = "*" * i[:result].size
+        target[:command] = "*" * line[:command].size
+        line[:output] = "" if line[:output].nil?
+        target[:output] = "*" * line[:output].size
+        target[:alterations] = "*" * line[:alterations].size
+        target[:expected] = "*" * line[:expected].size
+        target[:result] = "*" * line[:result].size
       end
 
       targets << target

data/lib/teuton/report/formatter/default/txt.rb

@@ -23,44 +23,43 @@ class TXTFormatter < ArrayFormatter
   private
 
   def process_config
-    w "#{colorize("CONFIGURATION", :bg_blue)}\n"
-    my_screen_table = Terminal::Table.new do |st|
-      @data[:config].sort.each do |key, value|
-        st.add_row [key.to_s, value.to_s]
-      end
+    w "#{colorize(" \u{2692} CONFIGURATION", :bg_blue)}\n"
+    table = Terminal::Table.new do |t|
+      t.style = {border: :unicode}
+      @data[:config].sort.each { |key, value| t.add_row [key.to_s, value.to_s] }
     end
-    w "#{my_screen_table}\n\n"
+    w "#{table}\n"
   end
 
   def process_logs
     return if @data[:logs].empty?
 
-    w "#{colorize("LOGS", :bg_blue)}\n"
-    @data[:logs].each { |line| w "    #{line}\n" }
+    w "#{colorize("\n \u{1f6c8} LOGS", :bg_blue)}\n"
+    @data[:logs].each { |line| w "   #{line}\n" }
   end
 
   def process_groups
     return if @data[:groups].empty?
 
-    w "\n#{colorize("GROUPS", :bg_blue)}\n"
+    w "\n#{colorize(" \u{2630} GROUPS", :bg_blue)}\n"
     @data[:groups].each { |g| process_group g }
   end
 
   def process_results
-    w "\n#{colorize("RESULTS", :bg_blue)}\n"
-    my_screen_table = Terminal::Table.new do |st|
-      @data[:results].each do |key, value|
-        st.add_row [key.to_s, value.to_s]
-      end
+    w "\n#{colorize(" \u{1f5f9} RESULTS", :bg_blue)}\n"
+    table = Terminal::Table.new do |t|
+      t.style = {border: :unicode}
+      @data[:results].each { |key, value| t.add_row [key.to_s, value.to_s] }
     end
-    w "#{my_screen_table}\n"
+    w "#{table}\n"
   end
 
   def process_hof
     return if @data[:hall_of_fame].empty?
 
-    w "\n#{colorize("HALL OF FAME", :bg_blue)}\n"
-    my_screen_table = Terminal::Table.new do |st|
+    w "\n#{colorize(" \u{2605} HALL OF FAME", :bg_blue)}\n"
+    my_screen_table = Terminal::Table.new do |t|
+      t.style = {border: :unicode}
       @data[:hall_of_fame].each do |line|
         color = :green
         color = :red if line[0] < 50
@@ -70,7 +69,7 @@ class TXTFormatter < ArrayFormatter
           text1 = colorize(text1, :bright)
           text2 = colorize(text2, :bright)
         end
-        st.add_row [text1, text2]
+        t.add_row [text1, text2]
       end
     end
     w "#{my_screen_table}\n"
@@ -80,21 +79,34 @@ class TXTFormatter < ArrayFormatter
 
   def process_group(group)
     tab = "  "
-    w "- #{colorize(group[:title], :blue_bright)}\n"
+    w " \u{25B6} #{colorize(group[:title], :blue_bright)}\n"
+    corner = nil
     group[:targets].each do |i|
-      color = :red
-      color = :green if i[:check]
-      w tab * 2 + format("%02d", i[:target_id].to_i)
+      if i[:check]
+        color = :green
+        symbol = Settings.letter[:ok]
+      else
+        color = :red
+        symbol = Settings.letter[:cross]
+      end
+      w tab * 1 + format(" #{symbol} %02d", i[:target_id].to_i)
       text = "#{i[:score]}/#{i[:weight]}"
-      w " (#{colorize(text, color)})\n"
-      w "#{tab * 4}Description : #{i[:description]}\n"
-      w "#{tab * 4}Command     : #{i[:command]}\n"
-      w "#{tab * 4}Output      : #{i[:output]}\n"
-      w "#{tab * 4}Duration    : #{i[:duration]} (#{i[:conn_type]})\n"
-      w "#{tab * 4}Alterations : #{i[:alterations]}\n"
-      w "#{tab * 4}Expected    : #{i[:expected]}\n"
-      w "#{tab * 4}Result      : #{i[:result]}\n"
+      corner = if corner.nil?
+        "┌──"
+      else
+        "├──"
+      end
+      s = " " * (10 - text.size)
+      w " (#{colorize(text, color)})#{s}#{corner}\n"
+      w "#{tab * 4}Description │ #{i[:description]}\n"
+      w "#{tab * 4}Command     │ #{i[:command]}\n"
+      w "#{tab * 4}Output      │ #{i[:output]}\n"
+      w "#{tab * 4}Duration    │ #{i[:duration]} (#{i[:conn_type]})\n"
+      w "#{tab * 4}Alterations │ #{i[:alterations]}\n"
+      w "#{tab * 4}Expected    │ #{i[:expected]}\n"
+      w "#{tab * 4}Result      │ #{i[:result]}\n"
     end
+    w "#{tab * 10}└──\n"
   end
 
   def colorize(text, option)

data/lib/teuton/report/formatter/resume/txt.rb

@@ -25,21 +25,21 @@ class ResumeTXTFormatter < ResumeArrayFormatter
   private
 
   def process_config
-    w "#{colorize("CONFIGURATION", :bg_blue)}\n"
-    my_screen_table = Terminal::Table.new do |st|
-      @data[:config].each do |key, value|
-        st.add_row [key.to_s, trim(value)]
-      end
+    w "#{colorize(" \u{2692} CONFIGURATION ", :bg_blue)}\n"
+    table = Terminal::Table.new do |t|
+      t.style = {border: :unicode}
+      @data[:config].each { |key, value| t.add_row [key.to_s, trim(value)] }
     end
-    w "#{my_screen_table}\n\n"
+    w "#{table}\n\n"
   end
 
   def process_cases
-    w "#{colorize("CASES", :bg_blue)}\n"
-    my_screen_table = Terminal::Table.new do |st|
-      st.add_row %w[CASE MEMBERS GRADE STATE]
+    w "#{colorize(" \u{2630} CASES", :bg_blue)}\n"
+    table = Terminal::Table.new do |t|
+      t.style = {border: :unicode}
+      t.add_row %w[CASE MEMBERS GRADE STATE]
       @data[:cases].each do |line|
-        st.add_row [
+        t.add_row [
           line[:id],
           line[:members],
           format("  %<grade>3d", {grade: line[:grade]}),
@@ -47,38 +47,39 @@ class ResumeTXTFormatter < ResumeArrayFormatter
         ]
       end
     end
-    w "#{my_screen_table}\n\n"
+    w "#{table}\n\n"
   end
 
   def process_conn_errors
-    my_screen_table = Terminal::Table.new do |st|
-      st.add_row %w[CASE MEMBERS HOST ERROR]
+    table = Terminal::Table.new do |t|
+      t.style = {border: :unicode}
+      t.add_row %w[CASE MEMBERS HOST ERROR]
       @data[:cases].each do |line|
         line[:conn_status].each_pair do |h, e|
-          st.add_row [line[:id], line[:members], h, colorize(e, :red_bright)]
+          t.add_row [line[:id], line[:members], h, colorize(e, :red_bright)]
         end
       end
     end
-    return unless my_screen_table.rows.size > 1
+    return unless table.rows.size > 1
 
-    w "#{colorize("CONN ERRORS", :bg_blue)}\n#{my_screen_table}\n\n"
+    w "#{colorize(" \u{1f5f2} CONN ERRORS", :bg_blue)}\n#{table}\n\n"
   end
 
   def process_results
-    w "#{colorize("RESULTS", :bg_blue)}\n"
-    my_screen_table = Terminal::Table.new do |st|
-      @data[:results].each do |key, value|
-        st.add_row [key.to_s, value.to_s]
-      end
+    w "#{colorize(" \u{1f5f9} RESULTS", :bg_blue)}\n"
+    table = Terminal::Table.new do |t|
+      t.style = {border: :unicode}
+      @data[:results].each { |key, value| t.add_row([key.to_s, value.to_s]) }
     end
-    w "#{my_screen_table}\n\n"
+    w "#{table}\n\n"
   end
 
   def process_hof
     return if @data[:hall_of_fame].size < MIN_HALL_OF_FAME
 
-    w "#{colorize("HALL OF FAME", :bg_blue)}\n"
-    my_screen_table = Terminal::Table.new do |st|
+    w "#{colorize(' \u{2605} HALL OF FAME', :bg_blue)}\n"
+    table = Terminal::Table.new do |t|
+      t.style = {border: :unicode}
       @data[:hall_of_fame].each do |line|
         color = :green
         color = :red if line[0] < 50
@@ -88,10 +89,10 @@ class ResumeTXTFormatter < ResumeArrayFormatter
           text1 = colorize(text1, :bright)
           text2 = colorize(text2, :bright)
         end
-        st.add_row [text1, text2]
+        t.add_row [text1, text2]
       end
     end
-    w "#{my_screen_table}\n"
+    w "#{table}\n"
   end
 
   def colorize(text, option)

data/lib/teuton/report/formatter/resume/xml.rb

@@ -61,10 +61,10 @@ class ResumeXMLFormatter < ResumeArrayFormatter
     end
     lines << "  </conn_errors>"
 
-    if lines.size > 2
-      w lines.join("\n")
-      w "\n"
-    end
+    return unless lines.size > 2
+
+    w lines.join("\n")
+    w "\n\n"
   end
 
   def process_results

data/lib/teuton/report/report.rb

@@ -3,16 +3,18 @@ require_relative "../utils/settings"
 require_relative "formatter/formatter"
 
 class Report
-  attr_accessor :id, :filename, :output_dir, :head, :lines, :tail, :format
-  attr_reader :history
+  attr_accessor :id, :filename, :output_dir,
+    :head, :lines, :tail, :format, :history
 
   def initialize(id = "00")
     @id = id
     @filename = "case-#{@id}"
-    @output_dir = Project.value[:output_basedir]
+    @output_dir = Project.value[:output_dir]
+
     @head = {}
     @lines = []
     @tail = {unique_fault: 0}
+    # TODO
     # [String] with 1 char for every target in @lines
     # For example: "..F." means: good, good, fail and good
     @history = ""
@@ -44,37 +46,4 @@ class Report
     filepath = File.join(@output_dir, "moodle")
     Formatter.call(self, {format: :moodle_csv}, filepath)
   end
-
-  ##
-  # Calculate final values:
-  # * grade
-  # * max_weight
-  # * good_weight,d
-  # * fail_weight
-  # * fail_counter
-  def close
-    max = good = fails = fail_counter = 0
-    @lines.each do |i|
-      next unless i.instance_of? Hash
-
-      max += i[:weight] if i[:weight].positive?
-      if i[:check]
-        good += i[:weight]
-        @history += Settings.letter[:good]
-      else
-        fails += i[:weight]
-        fail_counter += 1
-        @history += Settings.letter[:fail]
-      end
-    end
-    @tail[:max_weight] = max
-    @tail[:good_weight] = good
-    @tail[:fail_weight] = fails
-    @tail[:fail_counter] = fail_counter
-
-    i = good.to_f / max
-    i = 0 if i.nan?
-    @tail[:grade] = (100.0 * i).round
-    @tail[:grade] = 0 if @tail[:unique_fault].positive?
-  end
 end

data/lib/teuton/utils/project.rb

@@ -8,6 +8,7 @@ class Project
     @project[:running_basedir] = Dir.getwd
     @project[:output_basedir] = "var"
     @project[:output_dir] = @project[:output_basedir]
+    @project[:base_case_id] = "00"
     @project[:name] = "teuton"
     @project[:format] = :txt # Default export format
     @project[:debug] = false # Disable/enable local executions
@@ -18,12 +19,12 @@ class Project
       "quiet" => false
     }
     @project[:verbose] = true # Enable/disable screen outputs
-    @project[:global] = {}
     @project[:ialias] = {} # Hash of Internal alias
-    @project[:macros] = {}
+    @project[:global] = {}
     @project[:groups] = []
-    @project[:uses] = []
     @project[:hall_of_fame] = [] # Hall of fame content
+    @project[:macros] = {}
+    @project[:uses] = []
   end
 
   def self.value

data/lib/teuton/version.rb

@@ -1,5 +1,5 @@
 module Teuton
-  VERSION = "3.2.1".freeze
+  VERSION = "3.4.0".freeze
   APPNAME = "teuton".freeze
   GEMNAME = "teuton".freeze
   DOCKERNAME = "dvarrui/#{GEMNAME}".freeze

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.4.0
 platform: ruby
 authors:
 - David Vargas Ruiz
@@ -126,15 +126,16 @@ extra_rdoc_files:
 - docs/commands/README.md
 - docs/commands/check.md
 - docs/commands/config.md
+- docs/commands/doc.md
 - docs/commands/help.md
 - docs/commands/new.md
-- docs/commands/readme.md
 - docs/commands/run.md
 - docs/config_file.md
 - docs/devel/contribute.md
 - docs/devel/diagram.md
 - docs/devel/todo.md
 - docs/dsl/README.md
+- docs/dsl/event.md
 - docs/dsl/expect.md
 - docs/dsl/export.md
 - docs/dsl/get.md
@@ -181,10 +182,11 @@ extra_rdoc_files:
 - docs/learn/26-expect_sequence.md
 - docs/learn/27-run_script.md
 - docs/learn/28-upload.md
+- docs/learn/31-event-stop.md
+- docs/learn/32-event-zero.md
 - docs/learn/README.md
 - docs/modes_of_use.md
 - docs/more.md
-- docs/tutorial/es/nginx/README.md
 files:
 - LICENSE
 - README.md
@@ -192,15 +194,16 @@ files:
 - docs/commands/README.md
 - docs/commands/check.md
 - docs/commands/config.md
+- docs/commands/doc.md
 - docs/commands/help.md
 - docs/commands/new.md
-- docs/commands/readme.md
 - docs/commands/run.md
 - docs/config_file.md
 - docs/devel/contribute.md
 - docs/devel/diagram.md
 - docs/devel/todo.md
 - docs/dsl/README.md
+- docs/dsl/event.md
 - docs/dsl/expect.md
 - docs/dsl/export.md
 - docs/dsl/get.md
@@ -247,12 +250,14 @@ files:
 - docs/learn/26-expect_sequence.md
 - docs/learn/27-run_script.md
 - docs/learn/28-upload.md
+- docs/learn/31-event-stop.md
+- docs/learn/32-event-zero.md
 - docs/learn/README.md
 - docs/modes_of_use.md
 - docs/more.md
-- docs/tutorial/es/nginx/README.md
 - lib/teuton.rb
-- lib/teuton/case/action.rb
+- lib/teuton/case/action/action.rb
+- lib/teuton/case/action/manager.rb
 - lib/teuton/case/builtin/main.rb
 - lib/teuton/case/builtin/package.rb
 - lib/teuton/case/builtin/service.rb
@@ -263,6 +268,7 @@ files:
 - lib/teuton/case/close.rb
 - lib/teuton/case/config.rb
 - lib/teuton/case/dsl/all.rb
+- lib/teuton/case/dsl/event.rb
 - lib/teuton/case/dsl/expect.rb
 - lib/teuton/case/dsl/expect_exitcode.rb
 - lib/teuton/case/dsl/expect_sequence.rb
@@ -300,15 +306,16 @@ files:
 - lib/teuton/check/checker.rb
 - lib/teuton/check/dsl/all.rb
 - lib/teuton/check/dsl/builtin.rb
+- lib/teuton/check/dsl/event.rb
 - lib/teuton/check/dsl/expect.rb
 - lib/teuton/check/dsl/expect_sequence.rb
 - lib/teuton/check/dsl/getset.rb
 - lib/teuton/check/dsl/run.rb
+- lib/teuton/check/dsl/target.rb
 - lib/teuton/check/main.rb
 - lib/teuton/check/show.rb
 - lib/teuton/cli/app.rb
 - lib/teuton/cli/run.rb
-- lib/teuton/deprecated/utils.rb
 - lib/teuton/errors.rb
 - lib/teuton/files/config.yaml
 - lib/teuton/files/start.rb