teuton 2.3.11 → 2.4.1

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

@@ -9,10 +9,9 @@
 class Case
   def play
     if skip?
-      verbose "Skipping case <#{@config.get(:tt_members)}>\n"
+      verbose Rainbow("S").green
       return false
     end
-    # TODO: Delete old reports???
     start_time = Time.now
     if get(:tt_sequence) == true
       play_in_sequence

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

@@ -11,11 +11,14 @@ class Case
     ip = @config.get("#{host}_ip".to_sym)
 
     if protocol.to_s.downcase == "local" || host.to_s == "localhost"
-      run_cmd_localhost # Protocol force => local
+      # Protocol force => local
+      run_cmd_localhost
     elsif protocol.to_s.downcase == "ssh"
-      run_cmd_remote_ssh(host) # Protocol force => ssh
+      # Protocol force => ssh
+      run_cmd_remote_ssh(host)
     elsif protocol.to_s.downcase == "telnet"
-      run_cmd_remote_telnet(host) # Protocol force => telnet
+      # Protocol force => telnet
+      run_cmd_remote_telnet(host)
     elsif ip.to_s.downcase == "localhost" || ip.to_s.include?("127.0.0.")
       run_cmd_localhost
     elsif ip == "NODATA"
@@ -101,17 +104,14 @@ class Case
     rescue Errno::EHOSTUNREACH
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :host_unreachable
-      verbose Rainbow(Application.instance.letter[:error]).red.bright
       log("Host #{ip} unreachable!", :error)
     rescue Net::SSH::AuthenticationFailed
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :error_authentication_failed
-      verbose Rainbow(Application.instance.letter[:error]).red.bright
       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("* The destination server's fingerprint is not matching " \
           "what is in your local known_hosts file.", :error)
@@ -121,7 +121,6 @@ class Case
     rescue => e
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :error
-      verbose Rainbow(Application.instance.letter[:error]).red.bright
       log("[#{e.class}] SSH on <#{username}@#{ip}>" \
           " exec: #{@action[:command]}", :error)
     end

data/lib/teuton/case_manager/case_manager.rb

@@ -1,13 +1,12 @@
-# frozen_string_literal: true
-
+require "rainbow"
 require "singleton"
 require_relative "../application"
 require_relative "../report/report"
+require_relative "../report/show"
 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
@@ -18,13 +17,11 @@ require_relative "utils"
 # * case_manager/export
 # * case_manager/hall_of_fame
 # * case_manager/report
-# * case_manager/show
 class CaseManager
   include Singleton
   include Utils
+  attr_reader :report, :cases
 
-  ##
-  # Initialize CaseManager
   def initialize
     @cases = []
     @report = Report.new(0)
@@ -50,12 +47,13 @@ class CaseManager
   # @param args (Hash) Export options
   def export(args = {})
     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 Rainbow("[ERROR] Argument error with 'export'!").red
+      puts Rainbow("  Code : CaseManager#export").red
+      puts Rainbow("  Line : export #{args}").red
+      puts Rainbow("  Use  : export format: 'txt'").red
+      puts ""
+      exit 1
     end
-    # Export report files
     ExportManager.run(@report, @cases, args)
   end
 
@@ -65,8 +63,16 @@ class CaseManager
   def send(args = {})
     threads = []
     puts ""
-    puts "[INFO] Sending files...#{args}"
+    puts Rainbow("-" * 50).green
+    puts Rainbow("Sending files...#{args}").color(:green)
     @cases.each { |c| threads << Thread.new { c.send(args) } }
     threads.each(&:join)
+    puts Rainbow("Sending finished!").color(:green)
+    puts Rainbow("-" * 50).green
+  end
+
+  def show(options = {verbose: 1})
+    verbose = options[:verbose]
+    ShowReport.new(@report).call(verbose)
   end
 end

data/lib/teuton/case_manager/check_cases.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: true
+require_relative "hall_of_fame"
 
 class CaseManager
   private
@@ -32,18 +32,16 @@ class CaseManager
     close_main_report(start_time)
   end
 
-  ##
-  # Run all cases
   def run_all_cases
     start_time = Time.now
+    verboseln Rainbow("-" * 36).green
+    verboseln Rainbow("Started at #{start_time}").green
     if Application.instance.global[:tt_sequence] == true
-      verboseln Rainbow("==> Teuton: Running in sequence (#{start_time})").yellow.bright
       # Run every case in sequence
       @cases.each(&:play)
     else
-      verboseln Rainbow("==> Teuton: Running in parallel (#{start_time})").yellow.bright
-      threads = []
       # Run all cases in parallel
+      threads = []
       @cases.each { |c| threads << Thread.new { c.play } }
       threads.each(&:join)
     end
@@ -75,6 +73,6 @@ class CaseManager
     @cases.each { |c| threads << Thread.new { c.close uniques } }
     threads.each(&:join)
 
-    build_hall_of_fame
+    HallOfFame.new(@cases).call
   end
 end

data/lib/teuton/case_manager/dsl.rb

@@ -24,7 +24,7 @@ end
 alias def_macro define_macro
 alias defmacro define_macro
 
-# Define a group of tests
+# Define a group of [target/run/expect]s
 # @param name (String) Group name
 # @param block (Block) Tests code
 def group(name, &block)

data/lib/teuton/case_manager/export_manager.rb

@@ -8,22 +8,22 @@ module ExportManager
   # @param main_report (Report)
   # @param cases (Array)
   # @param input (Hash) Selected export options
-  def self.run(main_report, cases, input)
-    args = strings2symbols(input)
+  def self.run(main_report, cases, args)
+    options = strings2symbols(args)
+    if options[:format].nil?
+      options[:format] = Application.instance.default[:format]
+    end
 
-    # default :mode=>:all, :format=>:txt
-    format = args[:format] || Application.instance.default[:format]
-    mode = args[:mode] || :all
     # Step 1: Export case reports
-    if %i[details all].include? mode
-      threads = []
-      cases.each { |c| threads << Thread.new { c.export format } }
-      threads.each(&:join)
-    end
+    threads = []
+    cases.each { |c| threads << Thread.new { c.export(options) } }
+    threads.each(&:join)
+
     # Step 2: Export resume report
-    main_report.export_resume format if %i[resume all].include? mode
+    main_report.export_resume(options)
+
     # Step 3: Preserve files if required
-    preserve_files if args[:preserve] == true
+    preserve_files if options[:preserve] == true
   end
 
   ##
@@ -42,7 +42,7 @@ module ExportManager
   end
 
   ##
-  # Preserve output files for current project
+  # Preserve output files for current project execution
   private_class_method def self.preserve_files
     app = Application.instance
     t = Time.now
@@ -55,6 +55,4 @@ module ExportManager
     FileUtils.mkdir(logdir)
     Dir.glob(File.join(srcdir, "**.*")).each { |file| FileUtils.cp(file, logdir) }
   end
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/MethodLength
 end

data/lib/teuton/case_manager/hall_of_fame.rb

@@ -1,26 +1,30 @@
 require_relative "../application"
 
 class CaseManager
-  private
+  class HallOfFame
+    def initialize(cases)
+      @cases = cases
+    end
 
-  def build_hall_of_fame
-    celebrities = {}
+    def call
+      celebrities = {}
 
-    @cases.each do |c|
-      grade = c.grade # report.tail[:grade]
-      label = if celebrities[grade]
-        celebrities[grade] + "*"
-      else
-        "*"
+      @cases.each do |c|
+        grade = c.grade # report.tail[:grade]
+        label = if celebrities[grade]
+          celebrities[grade] + "*"
+        else
+          "*"
+        end
+        celebrities[grade] = label unless c.skip
       end
-      celebrities[grade] = label unless c.skip
-    end
 
-    a = celebrities.sort_by { |key, _value| key }
-    list = a.reverse
+      a = celebrities.sort_by { |key, _value| key }
+      list = a.reverse
 
-    app = Application.instance
-    app.options[:case_number] = @cases.size
-    app.hall_of_fame = list
+      app = Application.instance
+      app.options[:case_number] = @cases.size
+      app.hall_of_fame = list
+    end
   end
 end

data/lib/teuton/case_manager/main.rb

@@ -1,4 +1,3 @@
 require_relative "check_cases"
-require_relative "hall_of_fame"
 require_relative "report"
-require_relative "show"
+require_relative "utils"

data/lib/teuton/case_manager/report.rb

@@ -25,8 +25,8 @@ class CaseManager
     @report.tail[:duration] = finish_time - start_time
 
     duration = format("%3.3f", (finish_time - start_time))
-    verbose Rainbow("\n==> Teuton: Duration=#{duration}").yellow.bright
-    verboseln Rainbow(" (#{finish_time})").yellow.bright
+    verboseln Rainbow("\nFinished in #{duration} seconds").green
+    verboseln Rainbow("-" * 36).green
     verboseln " "
 
     app = Application.instance
@@ -37,7 +37,7 @@ class CaseManager
           skip: true,
           id: "-",
           grade: 0.0,
-          letter: "",
+          letter: "S",
           members: "-",
           conn_status: {},
           moodle_id: "",

data/lib/teuton/report/formatter/base_formatter.rb

@@ -1,18 +1,19 @@
-# frozen_string_literal: true
-
 class BaseFormatter
+  attr_reader :ext
+
   def initialize(report)
-    @head = report.head
-    @lines = report.lines
-    @tail = report.tail
+    @head = report.head.clone
+    @lines = report.lines.clone
+    @tail = report.tail.clone
+    @ext = "unkown"
   end
 
-  def process
+  def process(options = {})
     raise "Empty method!"
   end
 
   def init(filename)
-    @filename = filename
+    @filename = "#{filename}.#{@ext}"
     @file = File.open(@filename, "w")
   end
 

data/lib/teuton/report/formatter/{array_formatter.rb → default/array.rb}

@@ -1,6 +1,5 @@
-# frozen_string_literal: true
-
-require_relative "base_formatter"
+require_relative "../base_formatter"
+require_relative "../../../application"
 
 class ArrayFormatter < BaseFormatter
   def initialize(report)
@@ -8,26 +7,28 @@ class ArrayFormatter < BaseFormatter
     @data = {}
   end
 
-  def process
-    build_data
+  def process(options = {})
+    build_data(options)
     w @data.to_s # Write data into ouput file
     deinit
   end
 
-  def build_data
+  def build_data(options)
     build_initial_data
-    build_history_data
+    build_history_data(options)
     build_final_data
     build_hof_data
   end
 
+  private
+
   def build_initial_data
     head = {}
     @head.each { |key, value| head[key] = value }
     @data[:config] = head
   end
 
-  def build_history_data
+  def build_history_data(options)
     @data[:logs] = []
     groups = []
     title = nil
@@ -54,12 +55,22 @@ class ArrayFormatter < BaseFormatter
       target[:score] = value
       target[:weight] = i[:weight]
       target[:description] = i[:description]
-      target[:command] = i[:command]
+
       target[:conn_type] = i[:conn_type]
       target[:duration] = i[:duration]
+
+      target[:command] = i[:command]
       target[:alterations] = i[:alterations]
       target[:expected] = i[:expected]
       target[:result] = i[:result]
+
+      if options[:feedback] == false
+        target[:command] = "*" * i[:command].size
+        target[:alterations] = "*" * i[:alterations].size
+        target[:expected] = "*" * i[:expected].size
+        target[:result] = "*" * i[:result].size
+      end
+
       targets << target
     end
 
@@ -82,4 +93,28 @@ class ArrayFormatter < BaseFormatter
     app.hall_of_fame.each { |line| fame[line[0]] = line[1] }
     @data[:hall_of_fame] = fame
   end
+
+  def config
+    @data[:config]
+  end
+
+  def results
+    @data[:results]
+  end
+
+  def logs
+    @data[:logs]
+  end
+
+  def groups
+    @data[:groups]
+  end
+
+  def hall_of_fame
+    @data[:hall_of_fame]
+  end
+
+  def version
+    Application::VERSION
+  end
 end

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

@@ -0,0 +1,7 @@
+require_relative "txt"
+
+class ColoredTextFormatter < TXTFormatter
+  def initialize(report)
+    super(report, true)
+  end
+end

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

@@ -0,0 +1,24 @@
+require "erb"
+require_relative "yaml"
+
+class HTMLFormatter < YAMLFormatter
+  def initialize(report)
+    super(report)
+    @ext = "html"
+    @data = {}
+    basedir = File.join(File.dirname(__FILE__), "..", "..", "..")
+    filepath = File.join(basedir, "files", "template", "case.html")
+    @template = File.read(filepath)
+  end
+
+  def process(options = {})
+    build_data(options)
+    build_page
+    deinit
+  end
+
+  def build_page
+    render = ERB.new(@template)
+    w render.result(binding)
+  end
+end

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

@@ -0,0 +1,15 @@
+require "json/pure"
+require_relative "array"
+
+class JSONFormatter < ArrayFormatter
+  def initialize(report)
+    super(report)
+    @ext = "json"
+  end
+
+  def process(options = {})
+    build_data(options)
+    w @data.to_json # Write data into ouput file
+    deinit
+  end
+end

data/lib/teuton/report/formatter/{txt_formatter.rb → default/txt.rb}

@@ -1,19 +1,20 @@
 require "terminal-table"
 require "rainbow"
-require_relative "array_formatter"
+require_relative "array"
 
 class TXTFormatter < ArrayFormatter
   def initialize(report, color = false)
     @color = color
     super(report)
+    @ext = "txt"
     @data = {}
   end
 
-  def process
+  def process(options = {})
     rainbow_state = Rainbow.enabled
     Rainbow.enabled = @color
 
-    build_data
+    build_data(options)
     process_config
     process_logs
     process_groups

data/lib/teuton/report/formatter/{xml_formatter.rb → default/xml.rb}

@@ -1,9 +1,15 @@
-require_relative "base_formatter"
+require_relative "../base_formatter"
+require_relative "../../../version"
 
 class XMLFormatter < BaseFormatter
-  def process
+  def initialize(report)
+    super(report)
+    @ext = "xml"
+  end
+
+  def process(options = {})
     tab = "  "
-    w "<teuton version='0.2'>\n"
+    w "<teuton version='#{Teuton::VERSION}'>\n"
     w "#{tab}<head>\n"
     @head.each { |key, value| w "#{tab * 2}<#{key}>#{value}</#{key}>\n" }
     w "#{tab}</head>\n"
@@ -22,7 +28,7 @@ class XMLFormatter < BaseFormatter
       w "#{tab * 3}<check>#{i[:check]}</check>\n"
       w "#{tab * 3}<weigth>#{i[:weight]}</weigth>\n"
       w "#{tab * 2}</line>\n"
-		end
+    end
     w "#{tab}</lines>\n"
     w "#{tab}<tail>\n"
     @tail.each { |key, value| w "#{tab * 2}<#{key}>#{value}</#{key}>\n" }

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

@@ -0,0 +1,15 @@
+require "yaml"
+require_relative "array"
+
+class YAMLFormatter < ArrayFormatter
+  def initialize(report)
+    super(report)
+    @ext = "yaml"
+  end
+
+  def process(options = {})
+    build_data(options)
+    w @data.to_yaml # Write data into ouput file
+    deinit
+  end
+end

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

@@ -0,0 +1,55 @@
+require "rainbow"
+require_relative "default/colored_text"
+require_relative "default/html"
+require_relative "default/json"
+require_relative "default/txt"
+require_relative "default/xml"
+require_relative "default/yaml"
+require_relative "resume/colored_text"
+require_relative "resume/html"
+require_relative "resume/json"
+require_relative "resume/txt"
+require_relative "resume/yaml"
+require_relative "moodle_csv_formatter"
+
+module Formatter
+  def self.call(report, options, filename)
+    klass = get(options[:format])
+    if klass.nil?
+      puts Rainbow("[ERROR] Unkown format: #{options[:format]}").red
+      puts Rainbow("        export format: FORMAT").red
+      exit 1
+    end
+    formatter = klass.new(report)
+    formatter.init(filename)
+    report.format = formatter.ext
+    formatter.process(options)
+  end
+
+  def self.get(format)
+    list = {
+      colored_text: ColoredTextFormatter,
+      html: HTMLFormatter,
+      json: JSONFormatter,
+      txt: TXTFormatter,
+      xml: XMLFormatter,
+      yaml: YAMLFormatter,
+      moodle_csv: MoodleCSVFormatter,
+      resume_html: ResumeHTMLFormatter,
+      resume_json: ResumeJSONFormatter,
+      resume_txt: ResumeTXTFormatter,
+      resume_xml: ResumeTXTFormatter, # TODO
+      resume_yaml: ResumeYAMLFormatter
+    }
+    list[format]
+  end
+
+  def self.hide_feedback(report)
+    report2 = report.clone
+    report2.groups.each do |group|
+      group.each do |item|
+        puts item.to_s
+      end
+    end
+  end
+end

data/lib/teuton/report/formatter/moodle_csv_formatter.rb

@@ -1,20 +1,14 @@
-# frozen_string_literal: true
-
-require_relative "resume_array_formatter"
+require_relative "resume/array"
 
 class MoodleCSVFormatter < ResumeArrayFormatter
-  ##
-  # initialize instance
-  # @param report (Report)
   def initialize(report)
     super(report)
+    @ext = "csv"
     @data = {}
   end
 
-  ##
-  # Process internal data and generates data with format
-  def process
-    build_data
+  def process(options = {})
+    build_data(options)
     process_cases
     deinit
   end

data/lib/teuton/report/formatter/{resume_array_formatter.rb → resume/array.rb}

@@ -1,21 +1,18 @@
-# frozen_string_literal: true
+require_relative "../base_formatter"
 
-require_relative "base_formatter"
-
-# ArrayFormatter class: format report data into an array
 class ResumeArrayFormatter < BaseFormatter
   def initialize(report)
     super(report)
     @data = {}
   end
 
-  def process
-    build_data
+  def process(options = {})
+    build_data(options)
     w @data.to_s # Write data into ouput file
     deinit
   end
 
-  def build_data
+  def build_data(options)
     build_initial_data
     build_cases_data
     build_final_data

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

@@ -0,0 +1,7 @@
+require_relative "txt"
+
+class ResumeColoredTextFormatter < ResumeTXTFormatter
+  def initialize(report)
+    super(report, true)
+  end
+end