teuton 0.0.1

data/lib/teuton/project/readme/readme.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require_relative '../../application'
+require_relative '../configfile_reader'
+require_relative '../../case_manager/case/result/result'
+require_relative 'dsl'
+require_relative 'lang'
+
+def use(filename)
+  filename += '.rb'
+  app = Application.instance
+  rbfiles = File.join(app.project_path, '**', filename)
+  files = Dir.glob(rbfiles)
+  use = []
+  files.sort.each { |f| use << f if f.include?(filename) }
+  require_relative use[0]
+end
+
+def group(name, &block)
+  Application.instance.groups << { name: name, block: block }
+end
+alias task group
+
+def start(&block)
+  # don't do nothing
+end
+alias play start
+
+# Creates README.md file from RB script file
+class Readme
+  attr_reader :result
+  attr_reader :data
+
+  def initialize(script_path, config_path)
+    @path = {}
+    @path[:script]   = script_path
+    @path[:dirname]  = File.dirname(script_path)
+    @path[:filename] = File.basename(script_path, '.rb')
+    @path[:config]   = config_path
+    reset
+  end
+
+  def reset
+    app = Application.instance
+    @config = ConfigFileReader.read(app.config_path)
+    @verbose = app.verbose
+    @result = Result.new
+    @data = {}
+    @data[:logs] = []
+    @data[:groups] = []
+    @data[:play] = []
+    reset_action
+    @setted_params = {}
+    @cases_params = []
+    @global_params = {}
+    @required_hosts = {}
+  end
+
+  def process_content
+    Application.instance.groups.each do |g|
+      @current = { name: g[:name], readme: [], actions: [] }
+      @data[:groups] << @current
+      reset_action
+      instance_eval(&g[:block])
+    end
+  end
+
+  def reset_action
+    @action = { readme: [] }
+  end
+
+  def show
+    process_content
+    show_head
+    show_content
+    show_tail
+  end
+
+  def show_content
+    @data[:groups].each do |group|
+      next if group[:actions].empty?
+
+      puts "\n## #{group[:name]}\n\n"
+      group[:readme].each { |line| puts "#{line}\n" }
+      previous_host = nil
+      group[:actions].each_with_index do |item, index|
+        if item[:host].nil? && index.positive?
+          item[:host] = group[:actions][0][:host]
+        end
+        if previous_host.nil? || item[:host] != previous_host
+          previous_host = item[:host] || 'null'
+          puts format(Lang::get(:goto), previous_host.upcase)
+        end
+
+        weight = ''
+        weight = "(x#{item[:weight]}) " if item[:weight] != 1.0
+        puts "* #{weight}#{item[:target]}"
+        item[:readme].each { |line| puts "    * #{line}\n" }
+      end
+    end
+  end
+
+  def show_head
+    app = Application.instance
+    puts '```'
+    puts format(Lang::get(:testname), app.test_name)
+    puts format(Lang::get(:date), Time.now)
+    puts format(Lang::get(:version), Application::VERSION)
+    puts '```'
+    puts "# README.md\n"
+
+    i = 1
+    unless @required_hosts.empty?
+      puts Lang::get(:hosts)
+      puts "\n"
+      puts '| ID | Host | Configuration |'
+      puts '| -- | ---- | ------------- |'
+      @required_hosts.each_pair do |k, v|
+        c = []
+        v.each_pair { |k2,v2| c << "#{k2}=#{v2}" }
+        puts "|#{i}|#{k.upcase}|#{c.join(', ')}|"
+        i += 1
+      end
+      puts "\n> NOTE: SSH Service installation is required on every host."
+    end
+
+    unless @cases_params.empty?
+      @cases_params.uniq!.sort!
+      puts Lang::get(:params)
+      @cases_params.uniq.each { |i| puts format('* %s', i) }
+      puts "\n> NOTE:"
+      puts "> * Teuton software must known this information!"
+      puts "> * Save every ':param: value' into config file."
+    end
+  end
+
+  def show_tail
+    return if @global_params.empty?
+
+    app = Application.instance
+    puts "\n---"
+    puts "# ANEXO"
+    puts "\n\#\# Global params"
+    puts Lang::get(:global)
+    puts "\n"
+    puts '| Global param | Value |'
+    puts '| ------------ | ----- |'
+    @global_params.each_pair { |k,v| puts "|#{k}|#{v}|" }
+    puts "\n\#\# Created params"
+    puts Lang::get(:created)
+    puts "\n"
+    puts '| Created params | Value |'
+    puts '| -------------- | ----- |'
+    @setted_params.each_pair { |k,v| puts "|#{k}|#{v}|" }
+  end
+end

data/lib/teuton/rake_function/check.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Method RakeFunction#check
+module RakeFunction
+  def self.check(gems)
+    puts "[INFO] Version #{Application::VERSION}"
+    check_gems gems
+    check_tests
+  end
+
+  def self.check_gems(gems)
+    fails = filter_uninstalled_gems(gems)
+    puts "[ERROR] Gems to install!: #{fails.join(',')}" unless fails == []
+  end
+
+  def self.check_tests
+    testfile = File.join('.', 'tests', 'all.rb')
+    a = File.read(testfile).split("\n")
+    b = a.select { |i| i.include? '_test' }
+
+    d = File.join('.', 'tests', '**', '*_test.rb')
+    e = Dir.glob(d)
+
+    unless b.size == e.size
+      puts "[FAIL] Some ruby tests are not executed by #{testfile}"
+    end
+
+    puts "[INFO] Running #{testfile}"
+    system(testfile)
+  end
+
+  def self.filter_uninstalled_gems(list)
+    cmd = `gem list`.split("\n")
+    names = cmd.map { |i| i.split(' ')[0] }
+    fails = []
+    list.each { |i| fails << i unless names.include?(i) }
+    fails
+  end
+end

data/lib/teuton/rake_function/install.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Methods Module RakeFunction
+# * opensuse
+# * debian
+# * install_gems
+module RakeFunction
+  def self.opensuse(packages)
+    names = %w[openssh make gcc ruby-dev]
+    options = '--non-interactive'
+    names.each do |n|
+      system("zypper #{options} install #{n}")
+    end
+    install_gems packages, '--no-ri'
+    create_symbolic_link
+  end
+
+  def self.debian(packages)
+    names = %w[ssh make gcc ruby-dev]
+    names.each { |name| system("apt-get install -y #{name}") }
+    install_gems packages, '--no-ri'
+    create_symbolic_link
+  end
+
+  def self.install_gems(list, options = '')
+    fails = filter_uninstalled_gems(list)
+    if !fails.empty?
+      puts "[INFO] Installing gems (options = #{options})..."
+      fails.each do |name|
+        system("gem install #{name} #{options}")
+      end
+    else
+      puts '[ OK ] Gems installed'
+    end
+  end
+end

data/lib/teuton/report/close.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Close Show methods for Report class.
+class Report
+  def close
+    app = Application.instance
+    max = 0.0
+    good = 0.0
+    fail = 0.0
+    fail_counter = 0
+    @lines.each do |i|
+      if i.class.to_s == 'Hash'
+        max += i[:weight] if i[:weight].positive?
+        if i[:check]
+          good += i[:weight]
+          @history += app.letter[:good]
+        else
+          fail += i[:weight]
+          fail_counter += 1
+          @history += app.letter[:bad]
+        end
+      end
+    end
+    @tail[:max_weight] = max
+    @tail[:good_weight] = good
+    @tail[:fail_weight] = fail
+    @tail[:fail_counter] = fail_counter
+
+    i = good.to_f / max.to_f
+    i = 0 if i.nan?
+    @tail[:grade] = (100.0 * i).round
+    @tail[:grade] = 0 if @tail[:unique_fault].positive?
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require_relative 'base_formatter'
+
+# ArrayFormatter class: format report data into an array
+class ArrayFormatter < BaseFormatter
+  def initialize(report)
+    super(report)
+    @data = {}
+  end
+
+  def process
+    build_data
+    w @data.to_s # Write data into ouput file
+    deinit
+  end
+
+  def build_data
+    build_initial_data
+    build_history_data
+    build_final_data
+    build_hof_data
+  end
+
+  def build_initial_data
+    head = {}
+    @head.each { |key, value| head[key] = value }
+    @data[:config] = head
+  end
+
+  def build_history_data
+    @data[:logs] = []
+    groups = []
+    title = nil
+    targets = []
+    @lines.each do |i|
+      if i.class.to_s == 'Hash'
+        value = 0.0
+        value = i[:weight] if i[:check]
+        if i[:groupname] != title
+          # Add currentgroup
+          groups << { title: title, targets: targets } unless title.nil?
+          # Create new group
+          title = i[:groupname]
+          targets = []
+        end
+
+        target = {}
+        target[:target_id]   = format('%02d', i[:id])
+        target[:check]       = i[:check]
+        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[:alterations] = i[:alterations]
+        target[:expected]    = i[:expected]
+        target[:result]      = i[:result]
+        targets << target
+      else
+        @data[:logs] << i.to_s # Add log line
+      end
+    end
+
+    groups << { title: title, targets: targets } unless title.nil?
+    @data[:groups] = groups
+  end
+
+  def build_final_data
+    tail = {}
+    @tail.each { |key, value| tail[key] = value }
+    @data[:results] = tail
+  end
+
+  def build_hof_data
+    app = Application.instance
+    @data[:hall_of_fame] = {}
+    return if app.options[:case_number] < 3
+    fame = {}
+    app.hall_of_fame.each { |line| fame[line[0]] = line[1] }
+    @data[:hall_of_fame] = fame
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# BaseFormatter class
+class BaseFormatter
+  def initialize(report)
+    @head = report.head
+    @lines = report.lines
+    @tail = report.tail
+  end
+
+  def init(filename)
+    @filename = filename
+    @file = File.open(@filename, 'w')
+  end
+
+  def w(text)
+    @file.write text.to_s # write into output file
+  end
+
+  def process
+    raise 'Empty method!'
+  end
+
+  def deinit
+    @file.close
+  end
+
+  def trim(input)
+    output = input.to_s
+    output = "...#{input[input.size - 50, input.size]}" if output.size > 65
+    output.to_s
+  end
+end

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

@@ -0,0 +1,31 @@
+
+require_relative 'base_formatter'
+
+class CSVFormatter < BaseFormatter
+	def initialize(report)
+		super(report)
+	end
+
+	def process
+		d = ';'
+		@head.each { |key,value| w "HEAD#{d}#{key}#{d}#{value}\n" }
+		@datagroups.each { |item| process_datagroup(item,d) }
+		@tail.each { |key,value| w "TAIL#{d}#{key}#{d}#{value}\n" }
+		deinit
+	end
+
+	def process_datagroup(pGroup, delimiter=';')
+		d = delimiter
+		a = "DATAGROUP"+pGroup.order.to_s+d
+		pGroup.head.each { |key,value| w a+"HEAD"+d+key.to_s+d+value.to_s+"\n" }
+		pGroup.lines.each do |i|
+			if i.class.to_s=='Hash' then
+				w a + "LINES#{d}ACTION#{d}#{i[:id]}#{d}#{i[:weight]}#{d}" +
+				      "#{i[:description]}\n"
+			else
+				w a + "LINES#{d}LOG#{d}#{i}\n"
+			end
+		end
+		pGroup.tail.each { |key,value| w a+"TAIL"+d+key.to_s+d+value.to_s+"\n" }
+	end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'rainbow'
+require_relative 'json_formatter'
+require_relative 'list_formatter'
+require_relative 'txt_formatter'
+require_relative 'yaml_formatter'
+require_relative 'resume_json_formatter'
+require_relative 'resume_list_formatter'
+require_relative 'resume_yaml_formatter'
+require_relative 'resume_txt_formatter'
+require_relative 'moodle_csv_formatter'
+require_relative 'csv_formatter'
+require_relative 'html_formatter'
+require_relative 'xml_formatter'
+
+# FormaterFactory module
+module FormatterFactory
+  def self.get(report, format, filename)
+    case format
+    when :colored_text
+      f = TXTFormatter.new(report,true)
+    when :csv
+      f = CSVFormatter.new(report)
+    when :html
+      f = HTMLFormatter.new(report)
+    when :json
+      f = JSONFormatter.new(report)
+    when :list
+      f = ListFormatter.new(report)
+    when :moodle_csv
+      f = MoodleCSVFormatter.new(report)
+    when :resume_txt
+      f = ResumeTXTFormatter.new(report, false)
+    when :resume_colored_text
+      f = ResumeTXTFormatter.new(report, true)
+    when :resume_json
+      f = ResumeJSONFormatter.new(report)
+    when :resume_list
+      f = ResumeListFormatter.new(report)
+    when :resume_yaml
+      f = ResumeYAMLFormatter.new(report)
+    when :txt
+      f = TXTFormatter.new(report,false)
+    when :xml
+      f = XMLFormatter.new(report)
+    when :yaml
+      f = YAMLFormatter.new(report)
+    else
+      raise Rainbow("[ERROR] FormaterFactory #{format} unkown!").red.bright
+    end
+    f.init(filename)
+    f
+  end
+
+  def self.ext(format)
+    data = { cvs: 'csv',
+             colored_text: 'txt',
+             json: 'json',
+             list: 'txt',
+             resume_colored_text: 'txt',
+             resume_csv: 'csv',
+             resume_json: 'json',
+             resume_list: 'txt',
+             resume_txt: 'txt',
+             resume_yaml: 'yaml',
+             txt: 'txt',
+             yaml: 'yaml' }
+    return format.to_s if data[format].nil?
+
+    data[format]
+  end
+end

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

@@ -0,0 +1,81 @@
+
+require_relative 'base_formatter'
+
+class HTMLFormatter < BaseFormatter
+
+  def initialize(pReport)
+    super(pReport)
+  end
+
+  def process
+    puts "<html>"
+    puts "<head><title>Checking Machines</title></head>"
+    puts "<body>"
+    puts "<header><h1><a name=\"index\">Checking Machines v0.4</a></h1>"
+    puts '<ul>'
+    @head.each do |key,value|
+      puts "<li><b>"+key.to_s+": </b>"+value.to_s+"</li>" if key!=:title
+    end
+    puts '</ul>'
+    puts "<table border=1 >"
+    puts "<thead><tr><td>Members</td><td>Grade</td><td>Fails</td></tr></thead>"
+    puts "<tbody>"
+
+    counter=0
+    @datagroups.each do |i|
+      counter+=1
+      puts "<tr><td><a href=\"#group"+counter.to_s+"\">"+i.head[:members]+"</a></td>"
+      puts "<td>"+i.tail[:grade].to_s+"</td>"
+      puts "<td>"+i.tail[:fail_counter].to_s+"</td></tr>"
+    end
+    puts "</tbody></table></header>"
+    puts "<h1>Cases</h1>"
+
+    counter=0
+    @datagroups.each do |i|
+      counter+=1
+      process_datagroup(i,counter)
+    end
+
+    puts '<ul>'
+    @tail.each do |key,value|
+      puts "<li><b>"+key.to_s+": </b>"+value.to_s+"</li>"
+    end
+    puts '</ul>'
+    puts "</body></html>"
+  end
+
+  def process_datagroup(pGroup, pCounter)
+    puts "<h2><a name=\"group"+pCounter.to_s+"\">Case members "+@head[:members]+"</a> (<a href=\"#index\">up</a>)</h2>"
+    puts "<table border=1 >"
+    puts "<thead><tr><td>Params</td><td>Results</td></tr></thead>"
+    puts "<tbody><tr>"
+    puts "<td><ul>"
+    pGroup.head.each do |key,value|
+      puts "<li><b>"+key.to_s+"</b>= "+value.to_s+"</li>" if key!=:members
+    end
+    puts "</ul></td>"
+    puts '<td><ul>'
+    pGroup.tail.each do |key,value|
+      puts "<li><b>"+key.to_s+"</b>= "+value.to_s+"</li>"
+    end
+    puts '</ul></td>'
+
+    puts '</tr></tbdody></table>'
+    puts '<h3>Test log</h3>'
+    puts '<ul>'
+    pGroup.lines.each do |i|
+      if i.class.to_s=='Hash' then
+        value=0.0
+        value=i[:weight] if i[:check]
+        a="<li>"+i[:id].to_s+" ("+value.to_s+") [weight="+i[:weight].to_s+"] "
+        a+="<i>"+i[:description]+"</i>: "+i[:command]+"</li>"
+        puts a
+      else
+        puts "<li>"+i.to_s+"</li>"
+      end
+    end
+    puts '</ul>'
+  end
+
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'array_formatter'
+
+# JSONFormatter class
+class JSONFormatter < ArrayFormatter
+  def initialize(report)
+    super(report)
+    @data = {}
+  end
+
+  def process
+    build_data
+    w @data.to_json # Write data into ouput file
+    deinit
+  end
+end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative 'array_formatter'
+
+# ListFormatter class
+class ListFormatter < ArrayFormatter
+  def initialize(report)
+    super(report)
+    @data = {}
+  end
+
+  def process
+    build_data
+    process_config
+    process_logs
+    process_groups
+    process_results
+    process_hof
+    deinit
+  end
+
+  private
+
+  def process_config
+    w "CONFIGURATION\n"
+    @data[:config].sort.each { |key,value| w "  * #{key} : #{value}\n" }
+    w "\n\n"
+  end
+
+  def process_logs
+    return if @data[:logs].size == 0
+
+    w "\nLOGS\n"
+    @data[:logs].each { |line| w "  * #{line}\n" }
+  end
+
+  def process_groups
+    return if @data[:groups].size == 0
+
+    w "\nGROUPS\n"
+    @data[:groups].each { |g| process_group g }
+  end
+
+  def process_results
+    w "\nRESULTS\n"
+    @data[:results].each do |key,value|
+      w "  * #{key.to_s} : #{value.to_s}\n"
+    end
+  end
+
+  def process_hof
+    return if @data[:hall_of_fame].size < 3
+
+    w "\nHALL OF FAME\n"
+    @data[:hall_of_fame].each do |line|
+      w "  #{line[0]} #{line[1]}\n"
+    end
+  end
+
+  private
+
+  def process_group(group)
+    tab = '  '
+    w "- #{group[:title]}\n"
+    group[:targets].each do |i|
+      w tab*2 + "#{format("%02d", i[:target_id].to_i)}"
+      w " (#{i[:score]}/#{i[:weight]}) "
+      w "#{i[:description]}\n"
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'resume_array_formatter'
+
+# MoodleCSVFormatter class
+class MoodleCSVFormatter < ResumeArrayFormatter
+  def initialize(report)
+    super(report)
+    @data = {}
+  end
+
+  def process
+    build_data
+    process_cases
+    deinit
+  end
+
+  private
+
+  def process_cases
+    # MoodleID, Grade, Feedback
+    w "MoodleID, TeutonGrade, TeutonFeedback\n"
+    @data[:cases].each do |line|
+      w "#{line[:moodle_id]},#{line[:grade]}," \
+        "#{line[:moodle_feedback]}\n" unless line[:skip]
+    end
+  end
+end