teuton 2.1.8dev1 → 2.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9adfc25439c6c4041e3ebe2c3defd49f2377fd5bc9283da0849e5e2ad220581
-  data.tar.gz: ddfb9194f6ce7d070fd53aa796094ffa25faa19f7d7142bb044ce9d92ed6725a
+  metadata.gz: cfb81fb786d0111b84d43f68a98b222639f37cc620fcf1156bf8722416f78a25
+  data.tar.gz: 71ba4a3325eb5d2ed76b64efbe9476fc77d82794d620416482a7ac57b835f692
 SHA512:
-  metadata.gz: ca261f8258065c3684c82dae7ea8929c1d77bfeeb64baea71dd60c2aa52d99f1767af1bd2467a1747881a4e37ba4078df1dc9541895bcee6f0695b73874e8cc8
-  data.tar.gz: 001aa6f198e560ec39cac6a1cca65ed67d7ef887751e7f9e13759309c7bf42cf772c8c8fb32fc8e0f8ec1ddc92477ef2a8bfbdae7c74851cad4afb7123eadeff
+  metadata.gz: 599b8e1e1dece4f9a3afad33c1d7e71417a280f31ed7e78632d62d8b2819d8cb99d04409b152a1e1cabfa90191e244863ca02593fbe44638ddd9fde9bdb682d7
+  data.tar.gz: d781970ef1d69087099915f6474df31af872fd64823e2643279407df6f9a83731127696c91bb5b8a0627b3543d0cfb6dac8c2db29b0edb006a64222a589ea01d

data/lib/teuton/application.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'singleton'
 
 # This Singleton contains application params
 class Application
   include Singleton
 
-  VERSION = '2.1.8dev1' # Application version
-  NAME = 'teuton'   # Application name
+  VERSION = '2.1.8' # Application version
+  NAME = 'teuton' # Application name
 
   attr_reader   :letter
   attr_reader   :running_basedir, :output_basedir
@@ -17,10 +19,15 @@ class Application
   attr_accessor :hall_of_fame
   attr_accessor :project_path, :script_path, :config_path, :test_name
 
+  ##
+  # Initialize Application instance
   def initialize
     reset
   end
 
+  ##
+  # Reset param values
+  # rubocop:disable Metrics/MethodLength
   def reset
     @letter = { good: '.', bad: 'F', error: '?', none: ' ' }
     @running_basedir = Dir.getwd
@@ -36,18 +43,29 @@ class Application
     @uses = [] # TODO
     @hall_of_fame = []
   end
+  # rubocop:enable Metrics/MethodLength
 
+  ##
+  # Return debug param
+  # @return Boolean
   def debug
     @default[:debug]
   end
 
+  ##
+  # Return name param
+  # @return String
   def name
     @default[:name]
   end
 
+  ##
+  # Return quiet param
+  # @return Boolean
   def quiet?
     return true if Application.instance.options['quiet']
     return true unless Application.instance.verbose
+
     false
   end
 end

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

@@ -26,8 +26,11 @@ class Case
   attr_accessor :result
   attr_accessor :action # TODO: why not reader only???
   attr_reader :id, :config, :uniques, :conn_status
-  @@id = '01'
+  @@id = '01' # First case ID value
 
+  ##
+  # Initialize case from specified config
+  # @param config (Hash)
   def initialize(config)
     app = Application.instance
     @config = Case::Config.new(local: config, global: app.global)
@@ -46,7 +49,7 @@ class Case
     @skip = get(:tt_skip) unless get(:tt_skip) == 'NODATA'
     unless app.options['case'].nil?
       @skip = true
-      @skip = false if app.options['case'].include? @id
+      @skip = false if app.options['case'].include? @id.to_i
     end
 
     @conn_status = {}
@@ -70,8 +73,12 @@ class Case
     tempfile :default
   end
 
+  ##
+  # Export Case with specific output format
+  # @param format (Symbol)
   def export(format)
     return if skip?
+
     @report.export format
   end
 
@@ -79,21 +86,33 @@ class Case
     @report.filename #+ '.' + @report.format.to_s
   end
 
+  ##
+  # Return case grade
+  # @return grade
   def grade
     return 0.0 if skip
+
     @report.tail[:grade]
   end
 
+  ## Return case members
+  # @return members
   def members
     return '-' if skip
+
     @report.head[:tt_members] || 'noname'
   end
 
+  ##
+  # Return case skip value
+  # @return skip
   def skip
     @skip
   end
   alias skip? skip
 
+  ##
+  # Show case
   def show
     @report.show
   end

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

@@ -7,6 +7,8 @@
 # * fill_report
 # * close_opened_sessions
 class Case
+  ##
+  # Execute "play" order on this case
   def play
     if skip?
       verbose "Skipping case <#{@config.get(:tt_members)}>\n"
@@ -21,6 +23,8 @@ class Case
   end
   alias start play
 
+  ##
+  # Close opened sessions for this case
   def close_opened_sessions
     @sessions.each_value do |s|
       s.close if s.class == Net::SSH::Connection::Session
@@ -29,6 +33,9 @@ class Case
 
   private
 
+  ##
+  # Execute every play#group in parallel
+  # TO-DO: Under construction!
   def play_in_parallel
     @groups.each do |t|
       @action[:groupname] = t[:name]
@@ -36,6 +43,8 @@ class Case
     end
   end
 
+  ##
+  # Execute every play#group in sequence
   def play_in_sequence
     verboseln "Starting case <#{@config.get(:tt_members)}>"
     @groups.each do |t|
@@ -47,12 +56,14 @@ class Case
     verboseln "\n"
   end
 
+  ##
+  # Fill case report with time information
   def fill_report(start_time, finish_time)
     @report.head.merge! @config.global
     @report.head.merge! @config.local
     @report.head.merge! @config.running
     @report.tail[:case_id] = @id
-    @report.tail[:start_time_] = start_time
+    @report.tail[:start_time] = start_time
     @report.tail[:finish_time] = finish_time
     @report.tail[:duration] = finish_time - start_time
   end

data/lib/teuton/case_manager/case_manager.rb

@@ -23,12 +23,17 @@ class CaseManager
   include Singleton
   include Utils
 
+  ##
+  # Initialize CaseManager
   def initialize
     @cases = []
     @report = Report.new(0)
     @report.filename = 'resume'
   end
 
+  ##
+  # Execute "play" order: Start every single case test
+  # @param block (Block)
   def play(&block)
     check_cases!
     instance_eval(&block)
@@ -40,6 +45,9 @@ class CaseManager
     export(format: i.to_sym) unless i.nil?
   end
 
+  ##
+  # Execute "export" order: Export every case report
+  # @param args (Hash) Export options
   def export(args = {})
     if args.class != Hash
       puts "[ERROR] CaseManager#export: Argument = <#{args}>, " \
@@ -47,10 +55,27 @@ class CaseManager
       puts '        Usage: export :format => :colored_text'
       raise '[ERROR] CaseManager#export: Argument error!'
     end
+    # First: export files
     ExportManager.run(@report, @cases, args)
+    # Second: preserve files if required
     preserve_files if args[:preserve] == true
   end
 
+  ##
+  # Execute "send" order: Send every case report
+  # @param args (Hash) Send options
+  def send(args = {})
+    threads = []
+    puts ''
+    puts "[INFO] Sending files...#{args.to_s}"
+    @cases.each { |c| threads << Thread.new { c.send(args) } }
+    threads.each(&:join)
+  end
+
+  private
+
+  ##
+  # Preserve output files for current project
   def preserve_files
     app = Application.instance
     t = Time.now
@@ -61,14 +86,6 @@ class CaseManager
     srcdir = File.join(app.output_basedir, app.global[:tt_testname])
     puts "[INFO] Preserving files => #{logdir}"
     FileUtils.mkdir(logdir)
-    Dir.glob(srcdir, '**.*').each { |file| FileUtils.cp(file, logdir) }
-  end
-
-  def send(args = {})
-    threads = []
-    puts ''
-    puts "[INFO] Sending files...#{args.to_s}"
-    @cases.each { |c| threads << Thread.new { c.send(args) } }
-    threads.each(&:join)
+    Dir.glob(File.join(srcdir, '**.*')).each { |file| FileUtils.cp(file, logdir) }
   end
 end

data/lib/teuton/case_manager/check_cases.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-# CaseManager#check_cases!
+##
+# CaseManager: check_cases!
 class CaseManager
   private
 

data/lib/teuton/cli/{test.rb → check.rb}

@@ -33,6 +33,6 @@ class CLI < Thor
   # Verify or test Teuton test units syntax
   # @param path_to_rb_file [String] Route to main rb Teuton file
   def check(path_to_rb_file)
-    Project.test(path_to_rb_file, options)
+    Project.check(path_to_rb_file, options)
   end
 end

data/lib/teuton/cli/main.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'check'
 require_relative 'play'
 require_relative 'readme'
-require_relative 'test'
 require_relative 'version'

data/lib/teuton/cli/play.rb

@@ -30,8 +30,8 @@ class CLI < Thor
   LONGDESC
   ##
   # Execute Teuton test unit
-  # @param path_to_rb_file [String] Route to main rb Teuton file
-  def play(path_to_rb_file)
-    Project.play(path_to_rb_file, options)
+  # @param filepath [String] Route to main: rb file or folder
+  def play(filepath)
+    Project.play(filepath, options)
   end
 end

data/lib/teuton/project/name_file_finder.rb

@@ -6,25 +6,31 @@ require_relative '../application'
 # Project:
 # * find_filenames_for, verbose, verboseln
 module NameFileFinder
-  def self.find_filenames_for(relpathtofile)
-    pathtofile = File.absolute_path(relpathtofile)
+  ##
+  # Find project filenames from input project relative path
+  # @param relprojectpath (String)
+  def self.find_filenames_for(relprojectpath)
+    projectpath = File.absolute_path(relprojectpath)
 
     # Define:
     #   script_path, must contain fullpath to DSL script file
     #   config_path, must contain fullpath to YAML config file
-    if File.directory?(pathtofile)
+    if File.directory?(projectpath)
       # COMPLEX MODE: We use start.rb as main RB file
-      find_filenames_from_directory(pathtofile)
+      find_filenames_from_directory(projectpath)
     else
       # SIMPLE MODE: We use pathtofile as main RB file
-      find_filenames_from_rb(pathtofile)
+      find_filenames_from_rb(projectpath)
     end
     true
   end
 
-  def self.find_filenames_from_directory(pathtodir)
+  ##
+  # Find project filenames from input folder path
+  # @param folder_path (String)
+  def self.find_filenames_from_directory(folder_path)
     # COMPLEX MODE: We use start.rb as main RB file
-    script_path = File.join(pathtodir, 'start.rb')
+    script_path = File.join(folder_path, 'start.rb')
     unless File.exist? script_path
       print Rainbow('[ERROR] File ').red
       print Rainbow(script_path).bright.red
@@ -33,14 +39,17 @@ module NameFileFinder
     end
 
     app = Application.instance
-    app.project_path = pathtodir
+    app.project_path = folder_path
     app.script_path = script_path
-    app.test_name = pathtodir.split(File::SEPARATOR)[-1]
+    app.test_name = folder_path.split(File::SEPARATOR)[-1]
 
-    find_configfilename_from_directory(pathtodir)
+    find_configfilename_from_directory(folder_path)
   end
 
-  def self.find_configfilename_from_directory(pathtodir)
+  ##
+  # Find project config filename from input folder path
+  # @param folder_path (String)
+  def self.find_configfilename_from_directory(folder_path)
     # COMPLEX MODE: We use config.yaml by default
     app = Application.instance
 
@@ -49,9 +58,9 @@ module NameFileFinder
       config_name = 'config'
       # Config name file is introduced by cname arg option from teuton command
       config_name = app.options['cname'] unless app.options['cname'].nil?
-      config_path = File.join(pathtodir, "#{config_name}.json")
+      config_path = File.join(folder_path, "#{config_name}.json")
       unless File.exist? config_path
-        config_path = File.join(pathtodir, "#{config_name}.yaml")
+        config_path = File.join(folder_path, "#{config_name}.yaml")
       end
     else
       # Config path file is introduced by cpath arg option from teuton command
@@ -111,6 +120,10 @@ module NameFileFinder
     verboseln Rainbow(trim(app.test_name)).blue.bright
   end
 
+  ##
+  # Trim string text when is too long
+  # @param input (String)
+  # @return String
   def self.trim(input)
     output = input.to_s
     output = "...#{input[input.size - 50, input.size]}" if output.size > 65

data/lib/teuton/project/project.rb

@@ -9,10 +9,14 @@ require_relative 'name_file_finder'
 # * process_input_case_option
 # * readme
 # * require_dsl_and_script
-module Project
-  def self.test(pathtofile, options)
+module Project  ##
+  ##
+  # Check teuton test syntax
+  # @param projectpath (String) Path to teuton test
+  # @param options (Array) Array of input options
+  def self.check(projectpath, options)
     Application.instance.options.merge! options
-    NameFileFinder.find_filenames_for(pathtofile)
+    NameFileFinder.find_filenames_for(projectpath)
     NameFileFinder.puts_input_info_on_screen
     require_dsl_and_script('laboratory/laboratory') # Define DSL keywords
 
@@ -23,14 +27,20 @@ module Project
     lab.show_dsl unless options[:r] || options[:c]
   end
 
-  def self.play(pathtofile, options)
+  ##
+  # Run test
+  # @param projectpath (String) Path to teuton test
+  # @param options (Array) Array of input options
+  def self.play(projectpath, options)
     Application.instance.options.merge! options
     process_input_case_option
-    NameFileFinder.find_filenames_for(pathtofile)
+    NameFileFinder.find_filenames_for(projectpath)
     NameFileFinder.puts_input_info_on_screen
     require_dsl_and_script('../case_manager/dsl') # Define DSL keywords
   end
 
+  ##
+  # Convert input case options String to an Array of integers
   def self.process_input_case_option
     options = Application.instance.options
     return if options['case'].nil?
@@ -39,9 +49,13 @@ module Project
     options['case'] = a.collect!(&:to_i)
   end
 
-  def self.readme(pathtofile, options)
+  ##
+  # Create Readme file for a test
+  # @param projectpath (String) Path to teuton test
+  # @param options (Array) Array of input options
+  def self.readme(projectpath, options)
     Application.instance.options.merge! options
-    NameFileFinder.find_filenames_for(pathtofile)
+    NameFileFinder.find_filenames_for(projectpath)
     require_dsl_and_script('readme/readme') # Define DSL keywords
 
     app = Application.instance

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

@@ -11,7 +11,7 @@ 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 'html_formatter'
 require_relative 'xml_formatter'
 
 # FormaterFactory module
@@ -23,11 +23,17 @@ module FormatterFactory
     when :csv
       f = CSVFormatter.new(report)
     when :html
-      f = HTMLFormatter.new(report)
+ #     f = HTMLFormatter.new(report)
     when :json
       f = JSONFormatter.new(report)
     when :list
       f = ListFormatter.new(report)
+    when :txt
+      f = TXTFormatter.new(report,false)
+    when :xml
+      f = XMLFormatter.new(report)
+    when :yaml
+      f = YAMLFormatter.new(report)
     when :moodle_csv
       f = MoodleCSVFormatter.new(report)
     when :resume_txt
@@ -40,12 +46,6 @@ module FormatterFactory
       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

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

@@ -1,19 +1,41 @@
+# frozen_string_literal: true
 
-require_relative 'base_formatter'
+require_relative 'yaml_formatter'
 
-class HTMLFormatter < BaseFormatter
-
-  def initialize(pReport)
-    super(pReport)
+##
+# HTMLFormatter class receive a [Report] and generates HAML output.
+class HAMLFormatter < YAMLFormatter
+  ##
+  # Class constructor
+  # @param report [Report] Parent object that contains data to be exported.
+  def initialize(report)
+    super(report)
+    @data = {}
   end
 
+  ##
+  # Process data from parent object and export it into YAML format.
+  # @return [nil]
   def process
+    build_data
+    # w @data.to_yaml # Write data into ouput file
+    build_page
+    deinit
+  end
+
+  def build_page
     puts "<html>"
-    puts "<head><title>Checking Machines</title></head>"
+    puts "<head><title>TEUTON report</title></head>"
     puts "<body>"
+    build_config
+    build_targets
+    build_results
+  end
+
+  def build_config
     puts "<header><h1><a name=\"index\">Checking Machines v0.4</a></h1>"
     puts '<ul>'
-    @head.each do |key,value|
+    @data[:head].each do |key,value|
       puts "<li><b>"+key.to_s+": </b>"+value.to_s+"</li>" if key!=:title
     end
     puts '</ul>'
@@ -22,19 +44,20 @@ class HTMLFormatter < BaseFormatter
     puts "<tbody>"
 
     counter=0
-    @datagroups.each do |i|
+    @data[:groups].each do |group|
+      group[:targets].each do |target|
       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>"
+        puts "<tr><td><a href=\"#group"+counter.to_s+"\">"+target.head[:members]+"</a></td>"
+      puts "<td>"+target[:tail][:grade]+"</td>"
+      puts "<td>"+target[:tail][:fail_counter]+"</td></tr>"
     end
     puts "</tbody></table></header>"
     puts "<h1>Cases</h1>"
 
     counter=0
-    @datagroups.each do |i|
-      counter+=1
-      process_datagroup(i,counter)
+    @data[:groups].each do |group|
+      counter += 1
+      process_datagroup(group, counter)
     end
 
     puts '<ul>'
@@ -77,5 +100,5 @@ class HTMLFormatter < BaseFormatter
     end
     puts '</ul>'
   end
-
+end
 end

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

@@ -65,8 +65,8 @@ class ResumeTXTFormatter < ResumeArrayFormatter
       end
     end
     return unless my_screen_table.rows.size > 1
-    w "#{Rainbow('CONN ERRORS').bg(:red)}\n"
-    w "#{my_screen_table}\n"
+
+    w "#{Rainbow('CONN ERRORS').bg(:red)}\n#{my_screen_table}\n"
   end
 
   def process_results

data/lib/teuton.rb

@@ -34,8 +34,8 @@ module Teuton
   ##
   # Simulate play Teuton project, check syntax and display stats.
   # @param path_to_rb_file [String] Path to main rb file.
-  def self.test(path_to_rb_file)
-    Project.test(path_to_rb_file, options)
+  def self.check(path_to_rb_file)
+    Project.check(path_to_rb_file, options)
   end
 
   ##

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 2.1.8dev1
+  version: 2.1.8
 platform: ruby
 authors:
 - David Vargas Ruiz
@@ -281,10 +281,10 @@ files:
 - lib/teuton/case_manager/show.rb
 - lib/teuton/case_manager/utils.rb
 - lib/teuton/cli.rb
+- lib/teuton/cli/check.rb
 - lib/teuton/cli/main.rb
 - lib/teuton/cli/play.rb
 - lib/teuton/cli/readme.rb
-- lib/teuton/cli/test.rb
 - lib/teuton/cli/version.rb
 - lib/teuton/files/README.md
 - lib/teuton/files/config.yaml
@@ -336,9 +336,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: