teuton 2.3.5 → 2.3.7

data/lib/teuton/check/laboratory.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require_relative '../application'
-require_relative '../case_manager/case/result/result'
-require_relative 'show'
-require_relative 'dsl'
-require_relative 'builtin'
+require_relative "../application"
+require_relative "../case_manager/case/result/result"
+require_relative "show"
+require_relative "dsl"
+require_relative "builtin"
 
 ##
 # DSL use: import filename instructions
 # @param filename (String)
 def use(filename)
-  filename += '.rb'
+  filename += ".rb"
   app = Application.instance
-  rbfiles = File.join(app.project_path, '**', filename)
+  rbfiles = File.join(app.project_path, "**", filename)
   files = Dir.glob(rbfiles)
   use = []
   files.sort.each { |f| use << f if f.include?(filename) }
@@ -24,7 +24,7 @@ end
 # @param name (String or Symbol)
 # @param block (Proc)
 def group(name, &block)
-  Application.instance.groups << { name: name, block: block }
+  Application.instance.groups << {name: name, block: block}
 end
 alias task group
 
@@ -40,21 +40,19 @@ alias play start
 class Laboratory
   attr_reader :result
 
-  ##
-  # Initialize instance
   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
+    @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
     @result = Result.new
     @targetid = 0
-    @stats = { groups: 0, targets: 0, uniques: 0, gets: 0, logs: 0, sets: 0 }
+    @stats = {groups: 0, targets: 0, uniques: 0, gets: 0, logs: 0, sets: 0}
     @gets = {}
     @sets = {}
     @hosts = {}

data/lib/teuton/check/show.rb

@@ -1,8 +1,8 @@
-require 'terminal-table'
-require 'rainbow'
+require "terminal-table"
+require "rainbow"
 
-require_relative '../application'
-require_relative '../utils/configfile_reader'
+require_relative "../application"
+require_relative "../utils/configfile_reader"
 
 # Laboratory
 # * show_dsl
@@ -41,7 +41,7 @@ class Laboratory
     groups = Application.instance.groups
     option = Application.instance.options
 
-    verboseln ''
+    verboseln ""
     groups.each do |t|
       @stats[:groups] += 1
       unless option[:panel]
@@ -58,14 +58,14 @@ class Laboratory
     @hosts.each_key do |k|
       next if k == :localhost
 
-      if k.class == Symbol
-        script_vars << (k.to_s + '_ip').to_sym
-        script_vars << (k.to_s + '_username').to_sym
-        script_vars << (k.to_s + '_password').to_sym
+      if k.instance_of? Symbol
+        script_vars << (k.to_s + "_ip").to_sym
+        script_vars << (k.to_s + "_username").to_sym
+        script_vars << (k.to_s + "_password").to_sym
       else
-        script_vars << k.to_s + '_ip'
-        script_vars << k.to_s + '_username'
-        script_vars << k.to_s + '_password'
+        script_vars << k.to_s + "_ip"
+        script_vars << k.to_s + "_username"
+        script_vars << k.to_s + "_password"
       end
     end
     @gets.each_key { |k| script_vars << k }
@@ -73,29 +73,27 @@ class Laboratory
   end
 
   def recomended_config_content
-    verbose Rainbow('[WARN] File ').yellow
+    verbose Rainbow("[WARN] File ").yellow
     verbose Rainbow(@path[:config]).yellow.bright
-    verboseln Rainbow(' not found!').yellow
-    verboseln '[INFO] Recomended content:'
-    output = { global: nil, cases: [] }
+    verboseln Rainbow(" not found!").yellow
+    verboseln "[INFO] Recomended content:"
+    output = {global: nil, cases: []}
     output[:cases][0] = {}
     script_vars = find_script_vars
-    script_vars.each { |i| output[:cases][0][i] = 'VALUE' }
+    script_vars.each { |i| output[:cases][0][i] = "VALUE" }
     verboseln YAML.dump(output)
   end
 
   def recomended_panelconfig_content
-    output = { global: {}, cases: nil }
+    output = {global: {}, cases: nil}
     script_vars = find_script_vars
-    script_vars.each { |i| output[:global][i] = 'VALUE' }
+    script_vars.each { |i| output[:global][i] = "VALUE" }
     verboseln YAML.dump(output)
   end
 
-  ##
-  # Revive and check config content
   def revise_config_content
     my_screen_table = Terminal::Table.new do |st|
-      st.add_row ['Revising CONFIG file']
+      st.add_row ["Revising CONFIG file"]
     end
     verboseln my_screen_table
 
@@ -119,13 +117,13 @@ class Laboratory
       script_vars.each do |value|
         next unless item[value].nil?
 
-        next unless @sets[':' + value.to_s].nil?
+        next unless @sets[":" + value.to_s].nil?
 
-        verbose Rainbow('  * Define ').red
+        verbose Rainbow("  * Define ").red
         verbose Rainbow(value).red.bright
-        verbose Rainbow(' value for Case[').red
+        verbose Rainbow(" value for Case[").red
         verbose Rainbow(index).red.bright
-        verboseln Rainbow('] or set tt_skip = true').red
+        verboseln Rainbow("] or set tt_skip = true").red
       end
     end
   end
@@ -137,23 +135,23 @@ class Laboratory
     @hosts.each_pair { |_k, v| @stats[:hosts] += v }
 
     my_screen_table = Terminal::Table.new do |st|
-      st.add_row ['DSL Stats', 'Count']
+      st.add_row ["DSL Stats", "Count"]
       st.add_separator
-      st.add_row ['Groups', @stats[:groups]]
-      st.add_row ['Targets', @stats[:targets]]
-      st.add_row ['Goto', @stats[:hosts]]
+      st.add_row ["Groups", @stats[:groups]]
+      st.add_row ["Targets", @stats[:targets]]
+      st.add_row ["Goto", @stats[:hosts]]
       @hosts.each_pair { |k, v| st.add_row [" * #{k}", v] }
-      st.add_row ['Uniques', @stats[:uniques]]
-      st.add_row ['Logs', @stats[:uniques]]
-      st.add_row [' ', ' ']
+      st.add_row ["Uniques", @stats[:uniques]]
+      st.add_row ["Logs", @stats[:uniques]]
+      st.add_row [" ", " "]
 
-      st.add_row ['Gets', @stats[:gets]]
+      st.add_row ["Gets", @stats[:gets]]
       if @gets.count > 0
         list = @gets.sort_by { |_k, v| v }
         list.reverse_each { |item| st.add_row [" * #{item[0]}", item[1].to_s] }
       end
 
-      st.add_row ['Sets', @stats[:sets]]
+      st.add_row ["Sets", @stats[:sets]]
       if @sets.count > 0
         @sets.each_pair { |k, v| st.add_row [" * #{k}", v.to_s] }
       end

data/lib/teuton/cli.rb

@@ -1,19 +1,12 @@
-
-require 'thor'
-require_relative 'version'
-require_relative '../teuton'
+require "thor"
+require_relative "version"
+require_relative "../teuton"
 
 class CLI < Thor
-  map ['h', '-h', '--help'] => 'help'
+  map ["h", "-h", "--help"] => "help"
 
-  map ['v', '-v', '--version'] => 'version'
-  desc 'version', 'Show the program version'
-  def version
-    puts "#{Teuton::APPNAME} (version #{Teuton::VERSION})"
-  end
-
-  map ['n', '-n', '--new'] => 'new'
-  desc 'new DIRECTORY', 'Create skeleton for a new project'
+  map ["n", "-n", "--new"] => "new"
+  desc "new DIRECTORY", "Create skeleton for a new project"
   long_desc <<-LONGDESC
   Create files for a new project.
   LONGDESC
@@ -21,12 +14,11 @@ class CLI < Thor
     Teuton.create(projectpath)
   end
 
-  map ['c', '-c', '--check'] => 'check'
+  map ["c", "-c", "--check"] => "check"
   option :panelconfig, type: :boolean
   option :cname, type: :string
   option :cpath, type: :string
-  desc 'check [OPTIONS] DIRECTORY',
-       'Check test and config file content'
+  desc "check [OPTIONS] DIRECTORY", "Check test and config file content"
   long_desc <<-LONGDESC
 
   (1) teuton check path/to/dir/foo
@@ -46,15 +38,31 @@ class CLI < Thor
     Teuton.check(projectpath, options)
   end
 
-  map ['--run', 'run'] => 'play'
+  map ["--readme"] => "readme"
+  option :lang, type: :string
+  desc "readme DIRECTORY", "Show README extracted from test contents"
+  long_desc <<-LONGDESC
+
+  (1) teuton readme foo
+  , Create README.md from foo/start.rb.
+
+  (2) teuton readme foo/demo.rb
+  , Create README.md from foo/demo.rb.
+  LONGDESC
+
+  def readme(projectpath)
+    # Create README from teuton test
+    Teuton.readme(projectpath, options)
+  end
+
+  map ["--run", "run"] => "play"
   option :export, type: :string
   option :cname, type: :string
   option :cpath, type: :string
   option :case, type: :string
   option :color, type: :boolean
   option :quiet, type: :boolean
-  desc '[run] [OPTIONS] DIRECTORY',
-       'Run test from directory'
+  desc "[run] [OPTIONS] DIRECTORY", "Run test from directory"
   long_desc <<-LONGDESC
   This function execute challenge from specified directory.
   By default, show progress on the screen.
@@ -77,22 +85,10 @@ class CLI < Thor
     Teuton.run(filepath, options)
   end
 
-  map ['--readme'] => 'readme'
-  option :lang, type: :string
-  desc 'readme DIRECTORY',
-       'Show README extracted from test contents'
-  long_desc <<-LONGDESC
-
-  (1) teuton readme foo
-  , Create README.md from foo/start.rb.
-
-  (2) teuton readme foo/demo.rb
-  , Create README.md from foo/demo.rb.
-  LONGDESC
-
-  def readme(projectpath)
-    # Create README from teuton test
-    Teuton.readme(projectpath, options)
+  map ["v", "-v", "--version"] => "version"
+  desc "version", "Show the program version"
+  def version
+    puts "#{Teuton::APPNAME} version #{Teuton::VERSION}"
   end
 
   ##

data/lib/teuton/files/start.rb

@@ -1,10 +1,7 @@
-
 group "GROUP NAME" do
-
-  target "TARGET.1 DESCRIPTION"
-  run "COMMAND.1"
-  expect "TEXT.1"
-
+  target "TARGET_1 DESCRIPTION"
+  run "COMMAND_1"
+  expect "TEXT_1"
 end
 
 play do

data/lib/teuton/readme/dsl.rb

@@ -20,7 +20,7 @@ class Readme
 
   def target(desc, args = {})
     previous_host = @action[:host]
-    @action = { target: desc, host: previous_host, readme: [] }
+    @action = {target: desc, host: previous_host, readme: []}
     weight = 1.0
     weight = args[:weight].to_f if args[:weight]
     @action[:weight] = weight
@@ -54,7 +54,7 @@ class Readme
       @required_hosts[host.to_s] = b
     end
     @action[:host] = host
-    @action[:exec] = args[:exec] || 'noexec'
+    @action[:exec] = args[:exec] || "noexec"
   end
 
   def run(command, args = {})
@@ -85,9 +85,15 @@ class Readme
   end
 
   # If a method call is missing, then delegate to concept parent.
-  def method_missing(method)
-    a = method.to_s
-    instance_eval("get(:#{a[0, a.size - 1]})") if a[a.size - 1] == '?'
+  def method_missing(method, args = {})
+    m = method.to_s
+    if m[0] == "_"
+      instance_eval("get(:#{m[1, m.size - 1]})", __FILE__, __LINE__)
+    end
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    true
   end
 
   def gett(value)
@@ -106,7 +112,7 @@ class Readme
     # don't do nothing
   end
 
-  def log(text = '', type = :info)
+  def log(text = "", type = :info)
     @data[:logs] << "[#{type}]: " + text.to_s
   end
 end

data/lib/teuton/readme/lang.rb

@@ -1,30 +1,29 @@
-
-require_relative '../application'
+require_relative "../application"
 
 module Lang
   def self.get(key)
     lang = {}
-    lang['en'] = {
-      version:  'Teuton version : %s',
-      testname: 'Test unit name : %s',
-      date:     'Date           : %s',
-      hosts:    "\n\#\#\# Required hosts\n",
-      params:   "\n\#\#\# Required params\n",
-      goto:     "\nGo to [%s](\#required-hosts) host, and do next:\n",
-      global:   "\nGlobal parameters that can be modified:\n",
-      created:  "\nParams created during challenge execution:\n"
+    lang["en"] = {
+      version: "Teuton version : %s",
+      testname: "Test unit name : %s",
+      date: "Date           : %s",
+      hosts: "\n\#\#\# Required hosts\n",
+      params: "\n\#\#\# Required params\n",
+      goto: "\nGo to [%s](\#required-hosts) host, and do next:\n",
+      global: "\nGlobal parameters that can be modified:\n",
+      created: "\nParams created during challenge execution:\n"
     }
-    lang['es'] = {
-      version:  'Versión de Teuton : %s',
-      testname: 'Nombre del test   : %s',
-      date:     'Fecha             : %s',
-      hosts:    "\n\#\#\# Máquinas que se necesitan\n",
-      params:   "\n\#\#\# Parámetros de necesarios\n",
-      goto:     "\nIr a la máquina [%s](\#required-hosts), y hacer lo siguiente:\n",
-      global:   "\nParámetros globales que pueden ser modificados:\n",
-      created:  "\nParámetros creados durante la ejecución del reto:\n"
+    lang["es"] = {
+      version: "Versión de Teuton : %s",
+      testname: "Nombre del test   : %s",
+      date: "Fecha             : %s",
+      hosts: "\n\#\#\# Máquinas que se necesitan\n",
+      params: "\n\#\#\# Parámetros de necesarios\n",
+      goto: "\nIr a la máquina [%s](\#required-hosts), y hacer lo siguiente:\n",
+      global: "\nParámetros globales que pueden ser modificados:\n",
+      created: "\nParámetros creados durante la ejecución del reto:\n"
     }
-    locale = Application.instance.options['lang'].downcase
+    locale = Application.instance.options["lang"].downcase
     lang[locale][key]
   end
 end

data/lib/teuton/readme/readme.rb

@@ -1,14 +1,13 @@
-
-require_relative '../application'
-require_relative '../utils/configfile_reader'
-require_relative '../case_manager/case/result/result'
-require_relative 'dsl'
-require_relative 'lang'
+require_relative "../application"
+require_relative "../utils/configfile_reader"
+require_relative "../case_manager/case/result/result"
+require_relative "dsl"
+require_relative "lang"
 
 def use(filename)
-  filename += '.rb'
+  filename += ".rb"
   app = Application.instance
-  rbfiles = File.join(app.project_path, '**', filename)
+  rbfiles = File.join(app.project_path, "**", filename)
   files = Dir.glob(rbfiles)
   use = []
   files.sort.each { |f| use << f if f.include?(filename) }
@@ -16,13 +15,14 @@ def use(filename)
 end
 
 def group(name, &block)
-  Application.instance.groups << { name: name, block: block }
+  Application.instance.groups << {name: name, block: block}
 end
 alias task group
 
 def start(&block)
   # don't do nothing
 end
+# alias_method "play", "start" # REVISE THIS
 alias play start
 
 # Creates README.md file from RB script file
@@ -36,10 +36,10 @@ class Readme
   # @param config_path (String) Path to main config file (config.yaml)
   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
+    @path[:script] = script_path
+    @path[:dirname] = File.dirname(script_path)
+    @path[:filename] = File.basename(script_path, ".rb")
+    @path[:config] = config_path
     reset
   end
 
@@ -70,7 +70,7 @@ class Readme
 
   def process_content
     Application.instance.groups.each do |g|
-      @current = { name: g[:name], readme: [], actions: [] }
+      @current = {name: g[:name], readme: [], actions: []}
       @data[:groups] << @current
       reset_action
       instance_eval(&g[:block])
@@ -78,29 +78,29 @@ class Readme
   end
 
   def reset_action
-    @action = { readme: [] }
+    @action = {readme: []}
   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 "```"
+    puts format(Lang.get(:testname), app.test_name)
+    puts format(Lang.get(:date), Time.now)
+    puts format(Lang.get(:version), Application::VERSION)
+    puts "```"
     puts "\n"
     puts "# #{app.test_name}\n"
 
     i = 1
     unless @required_hosts.empty?
-      puts Lang::get(:hosts)
+      puts Lang.get(:hosts)
       puts "\n"
-      puts '| ID | Host | Configuration |'
-      puts '| --- | --- | --- |'
+      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(', ')} |"
+        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."
@@ -108,8 +108,8 @@ class Readme
 
     unless @cases_params.empty?
       @cases_params.sort!
-      puts Lang::get(:params)
-      @cases_params.uniq.each { |i| puts format('* %s', i) }
+      puts Lang.get(:params)
+      @cases_params.uniq.each { |i| puts format("* %s", i) }
       puts "\n> NOTE: Save every 'param: value' into config file."
     end
   end
@@ -126,13 +126,13 @@ class Readme
           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)
+          previous_host = item[:host] || "null"
+          puts format(Lang.get(:goto), previous_host.upcase)
         end
 
-        weight = ''
-        weight = "(x#{item[:weight]}) " if item[:weight] != 1.0
-        last = (item[:target].end_with?('.') ? '' : '.')
+        weight = ""
+        weight = "(x#{item[:weight]}) " if item[:weight].to_i != 1
+        last = (item[:target].end_with?(".") ? "" : ".")
         puts "* #{weight}#{item[:target]}#{last}"
         item[:readme].each { |line| puts "    * #{line}\n" }
       end
@@ -142,21 +142,19 @@ class Readme
   def show_tail
     return if @global_params.empty?
 
-    app = Application.instance
     puts "\n---"
     puts "# ANEXO"
     puts "\n\#\# Global params"
-    puts Lang::get(:global)
+    puts Lang.get(:global)
     puts "\n"
-    puts '| Global param | Value |'
-    puts '| --- | --- |'
-    @global_params.each_pair { |k,v| puts "|#{k}|#{v}|" }
+    puts "| Global param | Value |"
+    puts "| --- | --- |"
+    @global_params.each_pair { |k, v| puts "|#{k}|#{v}|" }
     puts "\n\#\# Created params"
-    puts Lang::get(:created)
+    puts Lang.get(:created)
     puts "\n"
-    puts '| Created params | Value |'
-    puts '| --- | --- |'
-    @setted_params.each_pair { |k,v| puts "|#{k}|#{v}|" }
+    puts "| Created params | Value |"
+    puts "| --- | --- |"
+    @setted_params.each_pair { |k, v| puts "|#{k}|#{v}|" }
   end
 end
-

data/lib/teuton/report/close.rb

@@ -1,6 +1,3 @@
-# frozen_string_literal: true
-
-# Close Show methods for Report class.
 class Report
   ##
   # Calculate final values:
@@ -9,8 +6,6 @@ class Report
   # * good_weight,d
   # * fail_weight
   # * fail_counter
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/MethodLength
   def close
     app = Application.instance
     max = 0.0
@@ -18,7 +13,7 @@ class Report
     fail = 0.0
     fail_counter = 0
     @lines.each do |i|
-      next unless i.class.to_s == 'Hash'
+      next unless i.instance_of? Hash
 
       max += i[:weight] if i[:weight].positive?
       if i[:check]
@@ -40,6 +35,4 @@ class Report
     @tail[:grade] = (100.0 * i).round
     @tail[:grade] = 0 if @tail[:unique_fault].positive?
   end
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/MethodLength
 end