teuton 3.0.3 → 3.2.0

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

@@ -7,27 +7,23 @@ require_relative "../../utils/project"
 module CheckCasesExtension
   def check_cases!
     # Start checking every single case
-    app = Project.value
     # Load configurations from config file
     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]
-    app[:global][:tt_sequence] = false if app[:global][:tt_sequence].nil?
+    Project.add_config(configdata)
 
     # Create out dir
-    outdir = app[:global][:tt_outdir] || File.join("var", app[:global][:tt_testname])
-    FileUtils.mkdir_p(outdir) unless Dir.exist?(outdir)
-    @report.output_dir = outdir
+    output_dir = Project.value[:output_dir]
+    FileUtils.mkdir_p(output_dir) unless Dir.exist?(output_dir)
+    @report.output_dir = output_dir
 
     # Fill report head
-    open_main_report(app[:config_path])
+    open_main_report(Project.value[:config_path])
 
     # create cases and run
     configdata[:cases].each { |config| @cases << Case.new(config) }
     start_time = run_all_cases # run cases
 
-    # TODO: merge these 2 methdos
+    # TODO: merge these 2 methods
     # TODO: CloseManager.call ???
     uniques = collect_uniques_for_all_cases
     close_reports_for_all_cases(uniques)

data/lib/teuton/case_manager/send_manager.rb

@@ -3,7 +3,7 @@ require_relative "../utils/project"
 
 class SendManager
   def initialize
-    logpath = File.join(Project.value[:output_basedir], Project.value[:test_name], "send.log")
+    logpath = File.join(Project.value[:output_basedir], Project.value[:testname], "send.log")
     @logfile = File.open(logpath, "a")
   end
 

data/lib/teuton/case_manager/stats_manager.rb

@@ -2,7 +2,7 @@ require_relative "../utils/project"
 
 class StatsManager
   def initialize
-    filepath = File.join(Project.value[:output_basedir], Project.value[:test_name], "stats.txt")
+    filepath = File.join(Project.value[:output_basedir], Project.value[:testname], "stats.txt")
     @file = File.open(filepath, "w")
   end
 

data/lib/teuton/cli.rb

@@ -44,7 +44,7 @@ class CLI < Thor
   LONGDESC
   def config(projectpath)
     # Check Test: suggest the content of the configuration file based on the test
-    opt = { "onlyconfig" => true }
+    opt = {"onlyconfig" => true}
     Teuton.check(projectpath, opt)
   end
 

data/lib/teuton/readme/readme.rb

@@ -11,8 +11,7 @@ class Readme
   include DSL
   include ReadmeDSL
 
-  attr_reader :result
-  attr_reader :data
+  attr_reader :result, :data
 
   def initialize(script_path, config_path)
     @path = {}
@@ -66,7 +65,7 @@ class Readme
     puts format(Lang.get(:version), Teuton::VERSION)
     puts "```"
     puts "\n"
-    puts "# Test: #{Project.value[:test_name]}\n"
+    puts "# Test: #{Project.value[:testname]}\n"
 
     i = 1
     unless @required_hosts.empty?
@@ -83,11 +82,11 @@ class Readme
       puts "\n> NOTE: SSH Service installation is required on every host."
     end
 
-    unless @cases_params.empty?
-      @cases_params.sort!
-      puts Lang.get(:params)
-      @cases_params.uniq.each { |i| puts format("* %s", i) }
-    end
+    return if @cases_params.empty?
+
+    @cases_params.sort!
+    puts Lang.get(:params)
+    @cases_params.uniq.each { |i| puts format("* %s", i) }
   end
 
   def show_content
@@ -98,9 +97,7 @@ class Readme
       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
+        item[:host] = group[:actions][0][:host] if item[:host].nil? && index.positive?
         if previous_host.nil? || item[:host] != previous_host
           previous_host = item[:host] || "null"
           puts format(Lang.get(:goto), previous_host.upcase)
@@ -127,12 +124,12 @@ class Readme
       puts "| ----- | ----- |"
       @global_params.each_pair { |k, v| puts "|#{k}|#{v}|" }
     end
-    if @setted_params.size.positive?
-      puts Lang.get(:created_params)
-      puts "\n"
-      puts "| Param |"
-      puts "| ----- |"
-      @setted_params.each_pair { |k, v| puts "|#{k}|" }
-    end
+    return unless @setted_params.size.positive?
+
+    puts Lang.get(:created_params)
+    puts "\n"
+    puts "| Param |"
+    puts "| ----- |"
+    @setted_params.each_pair { |k, v| puts "|#{k}|" }
   end
 end

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

@@ -30,7 +30,7 @@ class BaseFormatter
 
   def trim(input)
     output = input.to_s
-    output = "...#{input[-50, input.size]}" if output.size > 65
-    output.to_s
+    output = "...#{output[-50, 50]}" if output.size > 65
+    output
   end
 end

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

@@ -112,7 +112,7 @@ class TXTFormatter < ArrayFormatter
     when :red
       Rainbow(text).color(:red)
     else
-      puts "[ERROR] TXTFormatter#colorize option=#{option}"
+      puts Rainbow("[ERROR] TXTFormatter#colorize option=#{option}").bright.red
       exit 1
     end
   end

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

@@ -41,9 +41,9 @@ module Formatter
   def self.call(report, options, filename)
     klass = get(options[:format])
     if klass.nil?
-      puts "[ERROR] Formatter:"
-      puts "        Unkown format <#{options[:format]}>. Fix line <export format: FORMAT>"
-      puts "        Available formats: #{Formatter.available_formats.join(",")}."
+      warn Rainbow("[ERROR] Formatter:").bright.red
+      warn Rainbow("[ERROR] - Unkown format <#{options[:format]}>. Fix line <export format: FORMAT>").white
+      warn Rainbow("[ERROR] - Available formats: #{Formatter.available_formats.join(",")}.").white
       exit 1
     end
     formatter = klass.new(report)

data/lib/teuton/utils/config_file_reader.rb

@@ -11,7 +11,7 @@ module ConfigFileReader
 
     return read_json(filepath) if File.extname(filepath) == ".json"
 
-    raise "[ERROR] ConfigFileReader.call: <#{filepath}>. Unkown extension!"
+    raise Rainbow("[ERROR] ConfigFileReader.call: <#{filepath}>. Unkown extension!").bright.red
   end
 
   def self.convert_string_keys_to_symbol(input)
@@ -37,7 +37,7 @@ module ConfigFileReader
     data = {}
     data[:global] = {}
     data[:alias] = {}
-    data[:cases] = [{ tt_members: "anonymous" }]
+    data[:cases] = [{tt_members: "anonymous"}]
     data
   end
 
@@ -60,9 +60,9 @@ module ConfigFileReader
   def self.read_yaml(filepath)
     begin
       data = YAML.load(File.open(filepath))
-    rescue StandardError => e
-      warn "[ERROR] ConfigFileReader.read_yaml: #{e}"
-      warn "[ERROR] Revise file content! <#{filepath}>"
+    rescue => e
+      warn Rainbow("[ERROR] ConfigFileReader.read_yaml: #{e}").bright.red
+      warn Rainbow("[ERROR] Revise file content! <#{filepath}>").white
       exit 1
     end
     data = convert_string_keys_to_symbol(data)
@@ -88,10 +88,10 @@ module ConfigFileReader
 
     include_dir = data[:global][:tt_include]
     basedir = if include_dir == File.absolute_path(include_dir)
-                include_dir
-              else
-                File.join(File.dirname(filepath), data[:global][:tt_include])
-              end
+      include_dir
+    else
+      File.join(File.dirname(filepath), data[:global][:tt_include])
+    end
     filepaths = Dir.glob(File.join(basedir, "**/*"))
     filepaths.each do |filepath|
       if File.directory?(filepath)
@@ -110,10 +110,10 @@ module ConfigFileReader
   def self.read_included_yaml_file(filepath)
     begin
       data = YAML.load(File.open(filepath))
-    rescue StandardError => e
-      warn "[ERROR] Reading configurations from yaml:"
-      warn "[ERROR] - File : #{filepath}"
-      warn "[ERROR] - Type : #{e}"
+    rescue => e
+      warn Rainbow("[ERROR] Reading configurations from yaml:").bright.red
+      warn Rainbow("[ERROR] - File : #{filepath}").white
+      warn Rainbow("[ERROR] - Type : #{e}").white
       exit 1
     end
     data[:tt_source_file] = relative_path(filepath)
@@ -123,10 +123,10 @@ module ConfigFileReader
   def self.read_included_json_file(filepath)
     begin
       data = JSON.parse(File.read(filepath), symbolize_names: true)
-    rescue StandardError => e
-      warn "[ERROR] Reading configurations from json:"
-      warn "[ERROR] - File : #{filepath}"
-      warn "[ERROR] - Type : #{e}"
+    rescue => e
+      warn Rainbow("[ERROR] Reading configurations from json:").bright.red
+      warn Rainboe("[ERROR] - File : #{filepath}").white
+      warn Rainbow("[ERROR] - Type : #{e}").white
       exit 1
     end
     data[:tt_source_file] = relative_path(filepath)

data/lib/teuton/utils/name_file_finder.rb

@@ -1,18 +1,14 @@
 require "rainbow"
 
 class NameFileFinder
-  attr_reader :options
-  attr_reader :project_path
-  attr_reader :script_path
-  attr_reader :config_path
-  attr_reader :test_name
+  attr_reader :options, :project_path, :script_path, :config_path, :testname
 
   def initialize(options = {})
     @options = options
     @project_path = nil
     @script_path = nil # Path to DSL script file
     @config_path = nil # Path to YAML config file
-    @test_name = nil
+    @testname = nil
   end
 
   ##
@@ -44,7 +40,7 @@ class NameFileFinder
 
     @project_path = folder_path
     @script_path = script_path
-    @test_name = folder_path.split(File::SEPARATOR)[-1]
+    @testname = folder_path.split(File::SEPARATOR)[-1]
 
     find_configfilename_from_directory(folder_path)
   end
@@ -59,9 +55,7 @@ class NameFileFinder
       # Config name file is introduced by cname arg option from teuton command
       config_name = options["cname"] unless options["cname"].nil?
       config_path = File.join(folder_path, "#{config_name}.json")
-      unless File.exist? config_path
-        config_path = File.join(folder_path, "#{config_name}.yaml")
-      end
+      config_path = File.join(folder_path, "#{config_name}.yaml") unless File.exist? config_path
     else
       # Config path file is introduced by cpath arg option from teuton command
       config_path = options["cpath"]
@@ -81,7 +75,7 @@ class NameFileFinder
 
     @project_path = File.dirname(script_path)
     @script_path = script_path
-    @test_name = File.basename(script_path, ".rb")
+    @testname = File.basename(script_path, ".rb")
     find_configfilenames_from_rb(script_path)
   end
 
@@ -95,9 +89,7 @@ class NameFileFinder
       config_name = options["cname"] unless options["cname"].nil?
 
       config_path = File.join(@project_path, config_name + ".json")
-      unless File.exist? config_path
-        config_path = File.join(@project_path, config_name + ".yaml")
-      end
+      config_path = File.join(@project_path, config_name + ".yaml") unless File.exist? config_path
     else
       # Config path file is introduced by cpath arg option from teuton command
       config_path = options["cpath"]

data/lib/teuton/utils/project.rb

@@ -7,6 +7,7 @@ class Project
     @project = {}
     @project[:running_basedir] = Dir.getwd
     @project[:output_basedir] = "var"
+    @project[:output_dir] = @project[:output_basedir]
     @project[:name] = "teuton"
     @project[:format] = :txt # Default export format
     @project[:debug] = false # Disable/enable local executions
@@ -42,7 +43,7 @@ class Project
   # Preprocess input options:
   # * Convert input case options String to an Array of integers
   # * Read color input option
-  def self.add_input_params(projectpath, options)
+  def self.add_options(projectpath, options)
     value[:options].merge! options
     Rainbow.enabled = value[:options]["color"]
 
@@ -51,7 +52,7 @@ class Project
     value[:project_path] = finder.project_path
     value[:script_path] = finder.script_path
     value[:config_path] = finder.config_path
-    value[:test_name] = finder.test_name
+    value[:testname] = finder.testname
 
     return if value[:options]["case"].nil?
 
@@ -59,6 +60,19 @@ class Project
     value[:options]["case"] = numbers.collect!(&:to_i)
   end
 
+  def self.add_config(configdata)
+    # Load configurations from config file
+    value[:ialias] = configdata[:alias] || {}
+    value[:global] = configdata[:global] || {}
+    value[:global][:tt_sequence] = false if value[:global][:tt_sequence].nil?
+    running_basedir = "#{value[:running_basedir]}/"
+    value[:global][:tt_script_path] = value[:script_path].gsub(running_basedir, "")
+    value[:global][:tt_config_path] = value[:config_path].gsub(running_basedir, "")
+
+    value[:testname] = value[:global][:tt_testname] if value[:global][:tt_testname]
+    value[:output_dir] = (value[:global][:tt_output_dir] || File.join(value[:output_basedir], value[:testname]))
+  end
+
   def self.relative_path(filepath)
     if filepath.start_with?(Dir.pwd)
       filepath[Dir.pwd.length + 1, filepath.length]

data/lib/teuton/version.rb

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

data/lib/teuton.rb

@@ -8,7 +8,7 @@ module Teuton
   end
 
   def self.check(projectpath, options = {})
-    Project.add_input_params(projectpath, options)
+    Project.add_options(projectpath, options)
     require_dsl_and_script("teuton/check/main")
     require_relative "teuton/check/checker"
     checker = Checker.new(
@@ -19,12 +19,12 @@ module Teuton
   end
 
   def self.run(projectpath, options = {})
-    Project.add_input_params(projectpath, options)
+    Project.add_options(projectpath, options)
     require_dsl_and_script("teuton/case_manager/dsl")
   end
 
   def self.readme(projectpath, options = {})
-    Project.add_input_params(projectpath, options)
+    Project.add_options(projectpath, options)
     require_dsl_and_script("teuton/readme/main")
     readme = Readme.new(
       Project.value[:script_path],
@@ -39,10 +39,10 @@ module Teuton
     begin
       mainscriptfile = Project.value[:script_path]
       require_relative mainscriptfile
-    rescue StandardError => e
+    rescue => e
       warn Rainbow("[ERROR] #{e}").bright.red
       e.backtrace&.first(3)&.each do |line|
-        warn Rainbow("[ERROR]   #{line}").red
+        warn Rainbow("[ERROR]   #{line}").white
       end
       exit 1
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.2.0
 platform: ruby
 authors:
 - David Vargas Ruiz
@@ -349,7 +349,7 @@ files:
 - lib/teuton/version.rb
 homepage: https://github.com/teuton-software/teuton
 licenses:
-- MPL-2.0
+- AGPL-3.0
 metadata: {}
 rdoc_options: []
 require_paths: