teuton 2.10.8 → 2.11.0

data/lib/teuton/case/play.rb

@@ -24,7 +24,7 @@ class Case
   end
 
   def play_groups_in_sequence
-    verboseln "\n=> Starting case [#{@config.get(:tt_members)}]" if get(:tt_sequence) == true
+    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])
@@ -32,7 +32,7 @@ class Case
   end
 
   def play_groups_in_parallel
-    verboseln "Starting case [#{@config.get(:tt_members)}]"
+    verboseln "Running case [#{@config.get(:tt_members)}]"
     @groups.each do |t|
       verbose "* Processing [#{t[:name]}] "
       @action[:groupname] = t[:name]

data/lib/teuton/case/result/result.rb

@@ -17,10 +17,8 @@ class Result
     @content_backup = []
     @content = []
     @exitcode = -1
-
-    # @value = nil
-    @expected = nil
     @alterations = []
+    @expected = nil
   end
 
   def alterations

data/lib/teuton/case_manager/case_manager.rb

@@ -1,14 +1,12 @@
-require_relative "../case/case"
 require_relative "../report/report"
 require_relative "../utils/project"
 require_relative "../utils/verbose"
-require_relative "../utils/configfile_reader"
-require_relative "check_cases"
+require_relative "ext/check_cases"
+require_relative "ext/report"
 require_relative "export_manager"
 require_relative "send_manager"
-require_relative "show_report"
-require_relative "report"
-require_relative "utils"
+require_relative "show_resume_report"
+require_relative "stats_manager"
 
 # * initialize
 # * play
@@ -18,11 +16,8 @@ require_relative "utils"
 # * send_manager
 # * show_report
 class CaseManager
-  include Utils
   include Verbose
 
-  attr_reader :report, :cases
-
   def initialize
     @cases = []
     @report = Report.new(0)
@@ -33,21 +28,18 @@ class CaseManager
     # Execute "play" order: Start every single case test
     check_cases!
     instance_eval(&block)
-    # Run export if user pass option command "--export=json"
+    # Run export if user pass option command "--export=FORMAT"
     i = Project.value[:options]["export"]
     export(format: i.to_sym) unless i.nil?
     # Accept "configfile" param REVISE There exists?
     i = Project.value[:options]["configfile"]
     export(format: i.to_sym) unless i.nil?
+    # TODO: Export Stats
+    # StatsManager.new.call(@cases)
   end
 
   def export(args = {})
-    ExportManager.new.call(
-      @report,
-      @cases,
-      args,
-      Project.value[:format]
-    )
+    ExportManager.new.call(@report, @cases, args)
   end
 
   def send(args = {})
@@ -55,6 +47,11 @@ class CaseManager
   end
 
   def show(options = {verbose: 1})
-    ShowReport.new(@report).call(options[:verbose])
+    ShowResumeReport.new(@report).call(options[:verbose])
   end
+
+  private
+
+  include CheckCasesExtension
+  include ReportExtension
 end

data/lib/teuton/case_manager/dsl.rb

@@ -1,8 +1,7 @@
 require_relative "../utils/project"
 require_relative "case_manager"
 
-# DSL instructions that apply equally to all cases.
-# Therefore, they are stored globally in the case manager.
+# DSL instructions that apply to all cases. Stored globally in the case manager.
 # * define_macro
 # * group
 # * play
@@ -38,8 +37,9 @@ def use(filename)
     require_relative findfiles.first
     Project.value[:uses] << File.basename(findfiles.first)
   rescue => e
-    puts "[ERROR] #{e}:"
-    puts "        File not found! Fix line <use '#{filename}'>"
+    puts "[ERROR] case_manager/dsl: #{e}"
+    puts "[ERROR] File not found!"
+    puts "[ERROR] Fix line <use '#{filename}'>"
     exit 1
   end
 end

data/lib/teuton/case_manager/export_manager.rb

@@ -13,32 +13,37 @@ class ExportManager
   # @param main_report (Report)
   # @param cases (Array)
   # @param input (Hash) Selected export options
-  def call(main_report, cases, args, default_format)
+  def call(main_report, cases, args)
     if args.class != Hash
-      puts Rainbow("[ERROR] ExportManager:").red
-      puts Rainbow("  Export argument error!").red
-      puts Rainbow("  Revise: export #{args}").red
-      puts Rainbow("  Use   : export format: 'txt'").red
+      puts Rainbow("[ERROR] ExportManager: argument error!").red
+      puts Rainbow("[ERROR] Fix line <export #{args}>").red
+      puts Rainbow("[ERROR] Replace by <export format: 'txt'>").red
       puts ""
       exit 1
     end
 
     # Step 1: Validate options
     options = strings2symbols(args)
-    options[:format] = default_format if options[:format].nil?
+    if options[:format].nil?
+      options[:format] = Project.value[:format]
+    end
 
     unless Formatter.available_formats.include? options[:format]
-      puts Rainbow("[WARN] ExportManager:").yellow.bright
-      puts Rainbow("       Unkown format <#{options[:format]}>. Fix line <export format: FORMAT>.").yellow.bright
-      puts Rainbow("       Available formats: #{Formatter.available_formats.join(", ")}.").yellow.bright
-      puts Rainbow("[INFO] Using default format <txt>.").yellow.bright
+      puts Rainbow("[WARN] ExportManager: Unkown format!").yellow.bright
+      puts Rainbow("[WARN] Fix line <export format: #{options[:format]}>").yellow.bright
+      puts Rainbow("[INFO] Available formats: #{Formatter.available_formats.join(", ")}.").white.bright
+      puts Rainbow("[INFO] Using default format <txt>.").white.bright
       options[:format] = :txt
     end
 
     # Step 2: Export case reports
-    threads = []
-    cases.each { |c| threads << Thread.new { c.export(options) } }
-    threads.each(&:join)
+    if Project.value[:global][:tt_sequence]
+      cases.each { |c| c.export(options) }
+    else
+      threads = []
+      cases.each { |c| threads << Thread.new { c.export(options) } }
+      threads.each(&:join)
+    end
 
     # Step 3: Export resume report
     main_report.export_resume(options)
@@ -79,10 +84,10 @@ class ExportManager
     }
     subdir = format("%<year>s%<month>02d%<day>02d-" \
                     "%<hour>02d%<min>02d%<sec>02d", data)
-    logdir = File.join(srcdir, subdir)
+    preserve_dir = File.join(srcdir, subdir)
 
-    puts "[INFO] Preserving files => #{logdir}"
-    FileUtils.mkdir(logdir)
-    Dir.glob(File.join(srcdir, "**.*")).each { |file| FileUtils.cp(file, logdir) }
+    puts "[INFO] Preserving files => #{preserve_dir}"
+    FileUtils.mkdir(preserve_dir)
+    Dir.glob(File.join(srcdir, "**.*")).each { |file| FileUtils.cp(file, preserve_dir) }
   end
 end

data/lib/teuton/case_manager/{check_cases.rb → ext/check_cases.rb}

@@ -1,14 +1,15 @@
+require "fileutils"
 require_relative "hall_of_fame"
-require_relative "../utils/project"
-
-class CaseManager
-  private
+require_relative "../../case/case"
+require_relative "../../utils/config_file_reader"
+require_relative "../../utils/project"
 
+module CheckCasesExtension
   def check_cases!
     # Start checking every single case
     app = Project.value
     # Load configurations from config file
-    configdata = ConfigFileReader.read(Project.value[:config_path])
+    configdata = ConfigFileReader.call(Project.value[:config_path])
     app[:ialias] = configdata[:alias]
     app[:global] = configdata[:global]
     app[:global][:tt_testname] = app[:global][:tt_testname] || app[:test_name]
@@ -16,7 +17,7 @@ class CaseManager
 
     # Create out dir
     outdir = app[:global][:tt_outdir] || File.join("var", app[:global][:tt_testname])
-    ensure_dir outdir
+    FileUtils.mkdir_p(outdir) unless Dir.exist?(outdir)
     @report.output_dir = outdir
 
     # Fill report head

data/lib/teuton/case_manager/ext/hall_of_fame.rb

@@ -0,0 +1,28 @@
+require_relative "../../utils/project"
+
+module CheckCasesExtension
+  class HallOfFame
+    MIN_HALL_OF_FAME = 3
+
+    def initialize(cases)
+      @cases = cases
+    end
+
+    def call
+      celebrities = {}
+
+      @cases.each do |acase|
+        next if acase.skip
+
+        grade = acase.grade
+        celebrities[grade] = "" if celebrities[grade].nil?
+        celebrities[grade] += "*"
+      end
+
+      sorted_list = celebrities.sort_by { |key, _value| key }
+      if sorted_list.size >= MIN_HALL_OF_FAME
+        Project.value[:hall_of_fame] = sorted_list.reverse
+      end
+    end
+  end
+end

data/lib/teuton/case_manager/{report.rb → ext/report.rb}

@@ -1,10 +1,8 @@
 require "rainbow"
-require_relative "../utils/project"
-require_relative "../utils/settings"
-
-class CaseManager
-  private
+require_relative "../../utils/project"
+require_relative "../../utils/settings"
 
+module ReportExtension
   ##
   # Open main report (resume report)
   # @param config_filepath (String)
@@ -13,8 +11,8 @@ class CaseManager
     @report.head[:tt_scriptname] = trim(Project.value[:script_path])
     @report.head[:tt_configfile] = trim(config_filepath)
     @report.head[:tt_pwd] = Project.value[:running_basedir]
-    @report.head[:tt_debug] = true if @debug
-    @report.head[:tt_uses] = Project.value[:uses].join(", ") # TO-REVISE
+    @report.head[:tt_debug] = true if Project.value[:debug]
+    @report.head[:tt_uses] = Project.value[:uses].join(", ")
     @report.head.merge!(Project.value[:global])
   end
 
@@ -36,7 +34,7 @@ class CaseManager
           skip: true,
           id: "-",
           grade: 0.0,
-          letter: "S",
+          letter: Settings.letter(:skip),
           members: "-",
           conn_status: {},
           moodle_id: "",

data/lib/teuton/case_manager/send_manager.rb

@@ -1,4 +1,5 @@
 require "rainbow"
+require_relative "../utils/project"
 
 class SendManager
   def initialize

data/lib/teuton/case_manager/{show_report.rb → show_resume_report.rb}

@@ -9,7 +9,9 @@ require_relative "../utils/project"
 # | 2               | Show hall of fame |
 # | 3               | Show final values |
 # | 4               | Show Initial values |
-class ShowReport
+class ShowResumeReport
+  MIN_HALL_OF_FAME = 3
+
   def initialize(report)
     @report = report
   end
@@ -18,7 +20,7 @@ class ShowReport
     return if Project.quiet?
 
     show_initial_configurations if verbose > 2
-    if filename.to_s.include? "resume"
+    if @report.filename.to_s.include? "resume"
       show_resume
     else
       show_targets_history
@@ -29,26 +31,10 @@ class ShowReport
 
   private
 
-  def filename
-    @report.filename
-  end
-
-  def head
-    @report.head
-  end
-
-  def lines
-    @report.lines
-  end
-
-  def tail
-    @report.tail
-  end
-
   def show_initial_configurations
     puts Rainbow("INITIAL CONFIGURATIONS").bright
     my_screen_table = Terminal::Table.new do |st|
-      head.each do |key, value|
+      @report.head.each do |key, value|
         st.add_row [key.to_s, trim(value)]
       end
     end
@@ -64,7 +50,7 @@ class ShowReport
     puts Rainbow("CASE RESULTS").bright
     my_screen_table = Terminal::Table.new do |st|
       st.add_row %w[CASE MEMBERS GRADE STATE]
-      lines.each do |line|
+      @report.lines.each do |line|
         st.add_row [line[:id], line[:members], line[:grade], line[:letter]]
       end
     end
@@ -73,13 +59,13 @@ class ShowReport
 
   def show_conn_status
     errors = 0
-    lines.each { |line| errors += line[:conn_status].size }
+    @report.lines.each { |line| errors += line[:conn_status].size }
     return if errors.zero?
 
     puts Rainbow("CONN ERRORS").bright
     my_screen_table = Terminal::Table.new do |st|
       st.add_row %w[CASE MEMBERS HOST ERROR]
-      lines.each do |line|
+      @report.lines.each do |line|
         line[:conn_status].each_pair do |host, error|
           st.add_row [line[:id], line[:members], host, Rainbow(error).red.bright]
         end
@@ -91,10 +77,10 @@ class ShowReport
   def show_targets_history
     tab = "  "
     puts Rainbow("CASE RESULTS").bright
-    if lines.size == 1
+    if @report.lines.size == 1
       puts lines[0]
     else
-      lines.each do |i|
+      @report.lines.each do |i|
         if i.instance_of?(::Hash)
           value = 0.0
           value = i[:weight] if i[:check]
@@ -113,7 +99,7 @@ class ShowReport
   def show_final_values
     puts Rainbow("FINAL VALUES").bright
     my_screen_table = Terminal::Table.new do |st|
-      tail.each do |key, value|
+      @report.tail.each do |key, value|
         st.add_row [key.to_s, value.to_s]
       end
     end
@@ -122,7 +108,7 @@ class ShowReport
 
   def show_hall_of_fame
     hall_of_fame = Project.value[:hall_of_fame]
-    return if hall_of_fame.size < 3
+    return if hall_of_fame.size < MIN_HALL_OF_FAME
 
     puts Rainbow("HALL OF FAME").bright
     my_screen_table = Terminal::Table.new do |st|

data/lib/teuton/case_manager/stats_manager.rb

@@ -0,0 +1,26 @@
+require_relative "../utils/project"
+
+class StatsManager
+  def initialize
+    filepath = File.join(Project.value[:output_basedir], Project.value[:test_name], "stats.txt")
+    @file = File.open(filepath, "w")
+  end
+
+  def call(cases)
+    write "STATS"
+    write("Started at #{Time.new}")
+
+    # targets = {}
+    cases.each do |acase|
+      write acase.id
+    end
+
+    write("Finished!")
+  end
+
+  private
+
+  def write(msg)
+    @file.write "#{msg}\n"
+  end
+end

data/lib/teuton/check/checker.rb

@@ -39,24 +39,32 @@ class Checker
     @target_begin = nil
   end
 
-  def show
+  def show(onlyconfig)
+    if onlyconfig
+      show_onlyconfig
+    else
+      show_default
+    end
+  end
+
+  private
+
+  def show_default
     Logger.verbose = true
     process_content
-    cs = ShowCheck.new(stats: @stats, path: @path)
-    cs.show_stats
-    cs.revise_config_content
+    show = ShowCheck.new(stats: @stats, path: @path)
+    show.show_stats
+    show.revise_config_content
   end
 
   def show_onlyconfig
     Logger.verbose = false
     process_content
     Logger.verbose = true
-    cs = ShowCheck.new(stats: @stats, path: @path)
-    cs.suggest_config_content
+    show = ShowCheck.new(stats: @stats, path: @path)
+    show.suggest_config_content
   end
 
-  private
-
   def process_content
     groups = Project.value[:groups]
     option = Project.value[:options]

data/lib/teuton/check/main.rb

@@ -8,8 +8,8 @@ def use(filename)
   files = Dir.glob(rbfiles)
   use = []
   files.sort.each { |f| use << f if f.include?(filename) }
-  require_relative use[0]
-  Project.value[:uses] << use[0]
+  require_relative use.first
+  Project.value[:uses] << Project.relative_path(use.first)
 end
 
 def group(name, &block)

data/lib/teuton/check/show.rb

@@ -3,7 +3,7 @@ require "rainbow"
 
 require_relative "../utils/logger"
 require_relative "../utils/project"
-require_relative "../utils/configfile_reader"
+require_relative "../utils/config_file_reader"
 
 class ShowCheck
   def initialize(stats:, path:)
@@ -14,7 +14,7 @@ class ShowCheck
   def suggest_config_content
     output = {"global" => nil, "cases" => [{}]}
     script_vars = find_script_vars
-    script_vars.each { |i| output["cases"][0][i.to_s] = "VALUE" }
+    script_vars.each { |i| output["cases"][0][i.to_s] = "TOCHANGE" }
     Logger.info YAML.dump(output)
   end
 
@@ -28,7 +28,7 @@ class ShowCheck
     end
 
     script_vars = find_script_vars
-    config_vars = ConfigFileReader.read(@path[:config])
+    config_vars = ConfigFileReader.call(@path[:config])
     config_vars[:global]&.each_key { |k| script_vars.delete(k) }
     config_vars[:alias]&.each_key { |k| script_vars.delete(k) }
 

data/lib/teuton/cli.rb

@@ -38,11 +38,12 @@ class CLI < Thor
   end
 
   map ["co", "-co", "--config"] => "config"
-  desc "config DIRECTORY", "Suggest configuration"
+  desc "config [OPTIONS] DIRECTORY", "Suggest configuration."
   long_desc <<~LONGDESC
-    config [OPTIONS] DIRECTORY", "Suggest configuration"
+    config DIRECTORY, "Suggest the content of the configuration file based on the test"
   LONGDESC
   def config(projectpath)
+    # Check Test: suggest the content of the configuration file based on the test
     opt = {"onlyconfig" => true}
     Teuton.check(projectpath, opt)
   end

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

@@ -12,6 +12,7 @@ module ReadmeDSL
   end
 
   def gett(value)
+    # TODO: add test
     a = get(value)
     if @cases_params.include? value
       "[#{value}](#required-params)"

data/lib/teuton/readme/main.rb

@@ -7,8 +7,8 @@ def use(filename)
   files = Dir.glob(rbfiles)
   use = []
   files.sort.each { |f| use << f if f.include?(filename) }
-  require_relative use[0]
-  Project.value[:uses] << use[0]
+  require_relative use.first
+  Project.value[:uses] << use.first
 end
 
 def define_macro(name, *args, &block)

data/lib/teuton/readme/readme.rb

@@ -1,6 +1,6 @@
 require_relative "../utils/logger"
 require_relative "../utils/project"
-require_relative "../utils/configfile_reader"
+require_relative "../utils/config_file_reader"
 require_relative "../case/dsl/macro"
 require_relative "../version"
 require_relative "dsl/all"
@@ -33,7 +33,7 @@ class Readme
   private
 
   def reset
-    @config = ConfigFileReader.read(Project.value[:config_path])
+    @config = ConfigFileReader.call(Project.value[:config_path])
     @verbose = Project.value[:verbose]
     @result = ReadmeResult.new
     @data = {}

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

@@ -2,8 +2,6 @@ require_relative "../base_formatter"
 require_relative "../../../utils/project"
 
 class ArrayFormatter < BaseFormatter
-  MIN_HALL_OF_FAME = 3
-
   def initialize(report)
     super
     @data = {}
@@ -91,7 +89,7 @@ class ArrayFormatter < BaseFormatter
 
   def build_hof_data
     @data[:hall_of_fame] = {}
-    return if Project.value[:options][:case_number] < MIN_HALL_OF_FAME
+    return if Project.value[:hall_of_fame].empty?
 
     fame = {}
     Project.value[:hall_of_fame].each { |line| fame[line[0]] = line[1] }

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

@@ -52,7 +52,7 @@ class MarkdownFormatter < ArrayFormatter
   end
 
   def process_hof
-    return if @data[:hall_of_fame].size < 3
+    return if @data[:hall_of_fame].empty?
 
     w "# HALL OF FAME\n\n"
     w "| Grade | Amount |\n"

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

@@ -57,7 +57,7 @@ class TXTFormatter < ArrayFormatter
   end
 
   def process_hof
-    return if @data[:hall_of_fame].size < 3
+    return if @data[:hall_of_fame].empty?
 
     w "\n#{colorize("HALL OF FAME", :bg_blue)}\n"
     my_screen_table = Terminal::Table.new do |st|