teuton 3.1.0 → 3.2.1

data/lib/teuton/case/dsl/send.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module DSL
-  # * send, tempfile, tempdir, remote_tempdir, remote_tempfile
+  # * send, tempdir, remote_tempdir
   def send(logfile, args = {})
     return if skip?
 
@@ -38,7 +38,7 @@ module DSL
       logfile.write "#{msg}\n"
       logfile.flush
     rescue => e
-      msg = Rainbow("==> [FAIL] Case #{get(:tt_members)}: 'scp #{localfilepath}' to #{remotefilepath}").red
+      msg = Rainbow("==> [FAIL] Case #{get(:tt_members)}: 'scp #{localfilepath}' to #{remotefilepath}").yellow
       msg += "\n--> [ERROR] #{e}"
       verboseln(msg)
       logfile.write "#{msg}\n"
@@ -46,26 +46,10 @@ module DSL
     end
   end
 
-  def tempfile(input = nil)
-    return @action[:tempfile] if input.nil?
-
-    name = input
-    name = "teuton.tmp" if input == :default
-
-    @action[:tempfile] = File.join(@tempdir, name)
-    @action[:remote_tempfile] = File.join(remote_tempdir, name)
-
-    @action[:tempfile]
-  end
-
   def tempdir
     @tempdir
   end
 
-  def remote_tempfile
-    @action[:remote_tempfile]
-  end
-
   def remote_tempdir
     File.join("/", "tmp") # TODO: Remove this?
   end

data/lib/teuton/case/dsl/target.rb

@@ -3,14 +3,16 @@
 # DSL#target
 module DSL
   def readme(_text)
-    # Usefull only for "teuton reamde" command action.
+    # Usefull when running.
+    # It's works only with "teuton reamde" command action.
   end
 
   def target(desc, args = {})
-    @action[:description] = desc.to_s
-    @action[:asset] = args[:asset].to_s if args[:asset]
+    @action.description = desc.to_s
+    @action.asset = args[:asset].to_s if args[:asset]
     w = args[:weight] || 1.0
     weight(w)
   end
-  alias_method :goal, :target
+
+  alias_method :goal, :target # DEPRECATE
 end

data/lib/teuton/case/dsl/upload.rb

@@ -15,10 +15,7 @@ module DSL
   end
 
   def upload_one(localpath, args = {})
-    if args[:to].nil?
-      Logger.err("ERROR upload requires to: XXX")
-      exit 1
-    end
+    raise ArgumentError, "upload requires 'to: XXX'" if args[:to].nil?
 
     host = get_host(args[:to])
     if host.protocol == "ssh"
@@ -35,7 +32,7 @@ module DSL
         verbose(Rainbow("!").green)
       end
     elsif host.protocol != "local"
-      msg = Rainbow("==> [ERROR] upload: Incorrect protocol(#{host.protocol})").red
+      msg = Rainbow("==> [ERROR] upload: Incorrect protocol(#{host.protocol})").bright.red
       verboseln(msg)
     end
   end

data/lib/teuton/case/dsl/weight.rb

@@ -2,11 +2,11 @@ module DSL
   def weight(value = nil)
     # Set weight value for the action
     if value.nil?
-      @action[:weight]
+      @action.weight
     elsif value == :default
-      @action[:weight] = 1.0
+      @action.weight = 1.0
     else
-      @action[:weight] = value.to_f
+      @action.weight = value.to_f
     end
   end
 end

data/lib/teuton/case/execute/execute_base.rb

@@ -1,7 +1,7 @@
 class ExecuteBase
   def initialize(parent)
     @parent = parent
-    # READ: @config, cmd = action[:command]
+    # READ: @config, cmd = action.command
     # WRITE: @action, @result, @session
   end
 
@@ -46,9 +46,9 @@ class ExecuteBase
     begin
       text = ec.convert(text)
     rescue => e
-      puts "[ERROR] ExecuteBase: #{e}"
-      puts "[ERROR] Declare text encoding. Example:"
-      puts "[ERROR] run 'command', on: :host, encoding: 'ISO-8859-1'"
+      warn Rainbow("[ERROR] ExecuteBase: #{e}").bright.red
+      warn Rainbow("[ERROR] Declare text encoding. Example:").white
+      warn Rainbw("[ERROR] run 'command', on: :host, encoding: 'ISO-8859-1'").white
     end
 
     text.split("\n").compact

data/lib/teuton/case/execute/execute_local.rb

@@ -8,8 +8,8 @@ class ExecuteLocal < ExecuteBase
   include Verbose
 
   def call
-    action[:conn_type] = :local
-    response = my_execute(action[:command], action[:encoding])
+    action.conn_type = :local
+    response = my_execute(action.command, action.encoding)
     result.exitcode = response[:exitcode]
     result.content = response[:content]
   end

data/lib/teuton/case/execute/execute_manager.rb

@@ -5,7 +5,7 @@ require_relative "execute_telnet"
 class ExecuteManager
   def initialize(parent)
     @parent = parent
-    # READ: @config, cmd = action[:command]
+    # READ: @config, cmd = action.command
     # WRITE: @action, @result, @session
     # my_execute, encode_and_split methods?
   end
@@ -13,7 +13,7 @@ class ExecuteManager
   def call(host)
     start_time = Time.now
     run_on(host)
-    action[:duration] = (Time.now - start_time).round(3)
+    action.duration = (Time.now - start_time).round(3)
   end
 
   private
@@ -34,16 +34,16 @@ class ExecuteManager
     protocol = config.get(:"#{host}_protocol")
     ip = config.get(:"#{host}_ip")
 
-    if protocol.to_s.downcase == "local" || host.to_s == "localhost"
+    if protocol.to_s.casecmp("local").zero? || host.to_s == "localhost"
       # Protocol force => local
       ExecuteLocal.new(@parent).call
-    elsif protocol.to_s.downcase == "ssh"
+    elsif protocol.to_s.casecmp("ssh").zero?
       # Protocol force => ssh
       ExecuteSSH.new(@parent).call(host)
-    elsif protocol.to_s.downcase == "telnet"
+    elsif protocol.to_s.casecmp("telnet").zero?
       # Protocol force => telnet
       ExecuteTelnet.new(@parent).call(host)
-    elsif ip.to_s.downcase == "localhost" || ip.to_s.include?("127.0.0.")
+    elsif ip.to_s.casecmp("localhost").zero? || ip.to_s.include?("127.0.0.")
       # run_cmd_localhost
       ExecuteLocal.new(@parent).call
     elsif ip == "NODATA"

data/lib/teuton/case/execute/execute_ssh.rb

@@ -6,7 +6,7 @@ require_relative "execute_base"
 
 class ExecuteSSH < ExecuteBase
   def call(input_hostname)
-    action[:conn_type] = :ssh
+    action.conn_type = :ssh
     hostname = input_hostname.to_s
     ip = config.get(:"#{hostname}_ip").to_s
     username = config.get(:"#{hostname}_username").to_s
@@ -20,14 +20,14 @@ class ExecuteSSH < ExecuteBase
       ip2 = ip
       username2 = username
       password2 = password
-      command2 = action[:command]
+      command2 = action.command
       hostname = config.get(:"#{hostname}_route")
       ip = config.get(:"#{hostname}_ip").to_s
       username = config.get(:"#{hostname}_username").to_s
       password = config.get(:"#{hostname}_password").to_s
       ostype = config.get(:"#{hostname}_ostype").to_s
 
-      action[:command] = if ostype.downcase.start_with? "win"
+      action.command = if ostype.downcase.start_with? "win"
         "echo y | plink #{username2}@#{ip2} -ssh -pw #{password2} \"#{command2}\""
       else
         "sshpass -p #{password2} #{username2}@#{ip2} #{command2}"
@@ -49,7 +49,7 @@ class ExecuteSSH < ExecuteBase
         )
       end
       if sessions[hostname].instance_of? Net::SSH::Connection::Session
-        text = sessions[hostname].exec!(action[:command])
+        text = sessions[hostname].exec!(action.command)
         exitcode = text.exitstatus
       else
         text = "TEUTON_ERROR_SSH_NO_CONNECTION"
@@ -84,9 +84,9 @@ class ExecuteSSH < ExecuteBase
       text = "TEUTON_ERROR_SSH"
       exitcode = -1
       log("[#{e.class}] SSH on <#{username}@#{ip}>" \
-          " exec: #{action[:command]}", :error)
+          " exec: #{action.command}", :error)
     end
     result.exitcode = exitcode
-    result.content = encode_and_split(action[:encoding], text)
+    result.content = encode_and_split(action.encoding, text)
   end
 end

data/lib/teuton/case/execute/execute_telnet.rb

@@ -4,7 +4,7 @@ require_relative "execute_base"
 
 class ExecuteTelnet < ExecuteBase
   def call(input_hostname)
-    action[:conn_type] = :telnet
+    action.conn_type = :telnet
     hostname = input_hostname.to_s
     ip = config.get((hostname + "_ip").to_sym)
     port = config.get((hostname + "_port").to_sym)
@@ -31,7 +31,7 @@ class ExecuteTelnet < ExecuteBase
           password = config.get((hostname + "_password").to_sym).to_s
           h.login(username, password)
         end
-        h.cmd(action[:command]) { |i| text << i }
+        h.cmd(action.command) { |i| text << i }
         h.close
         sessions[hostname] = :ok
         exitcode = 0
@@ -51,11 +51,11 @@ class ExecuteTelnet < ExecuteBase
       sessions[hostname] = :nosession
       conn_status[hostname] = :error
       log(" ExceptionType=<#{e.class}> doing telnet on <#{username}@#{ip}>" \
-          " exec: #{action[:command]}", :error)
+          " exec: #{action.command}", :error)
       log(" └── username=<#{username}>, password=<#{password}>," \
           " ip=<#{ip}>, HOSTID=<#{hostname}>", :warn)
     end
     result.exitcode = exitcode
-    result.content = encode_and_split(action[:encoding], text)
+    result.content = encode_and_split(action.encoding, text)
   end
 end

data/lib/teuton/case/play.rb

@@ -2,7 +2,6 @@
 
 class Case
   # READ: sessions, config, groups, action, report
-  # TODO: groups from Project or from Case???
   def play
     if skip?
       verbose Rainbow("S").green
@@ -25,18 +24,18 @@ class Case
 
   def play_groups_in_sequence
     verboseln "\n==> Running case [#{@config.get(:tt_members)}]" if get(:tt_sequence) == true
-    @groups.each do |t|
-      @action[:groupname] = t[:name]
-      instance_eval(&t[:block])
+    @groups.each do |group|
+      @action.groupname = group[:name]
+      instance_eval(&group[:block])
     end
   end
 
   def play_groups_in_parallel
     verboseln "Running case [#{@config.get(:tt_members)}]"
-    @groups.each do |t|
-      verbose "* Processing [#{t[:name]}] "
-      @action[:groupname] = t[:name]
-      instance_eval(&t[:block])
+    @groups.each do |group|
+      verbose "* Processing [#{group[:name]}] "
+      @action.groupname = group[:name]
+      instance_eval(&group[:block])
       verbose "\n"
     end
     verboseln "\n"

data/lib/teuton/case_manager/case_manager.rb

@@ -29,11 +29,11 @@ class CaseManager
     check_cases!
     instance_eval(&block)
     # Run export if user pass option command "--export=FORMAT"
-    i = Project.value[:options]["export"]
-    export(format: i.to_sym) unless i.nil?
+    option = Project.value[:options]["export"]
+    export(format: option.to_sym) unless option.nil?
     # Accept "configfile" param REVISE There exists?
-    i = Project.value[:options]["configfile"]
-    export(format: i.to_sym) unless i.nil?
+    option = Project.value[:options]["configfile"]
+    export(format: option.to_sym) unless option.nil?
     # TODO: Export Stats
     # StatsManager.new.call(@cases)
   end

data/lib/teuton/case_manager/dsl.rb

@@ -13,19 +13,19 @@ end
 alias def_macro define_macro
 alias defmacro define_macro
 
-# Define a group of [target/run/expect]s
-# @param name (String) Group name
-# @param block (Block) Tests code
 def group(name, &block)
   Project.value[:groups] << { name: name, block: block }
 end
 alias task group
 
 def play(&block)
-  # Start test
   CaseManager.new.play(&block)
 end
-alias start play
+
+def start(...)
+  Logger.warn "[DEPRECATED] Replace 'start do' by `play do'"
+  play(...)
+end
 
 def use(filename)
   filename += ".rb"
@@ -36,10 +36,7 @@ def use(filename)
   begin
     require_relative findfiles.first
     Project.value[:uses] << File.basename(findfiles.first)
-  rescue => e
-    puts "[ERROR] case_manager/dsl: #{e}"
-    puts "[ERROR] File not found!"
-    puts "[ERROR] Fix line <use '#{filename}'>"
-    exit 1
+  rescue StandardError => e
+    raise Teuton::CaseManagerDslError.new(e, filename)
   end
 end

data/lib/teuton/case_manager/export_manager.rb

@@ -14,23 +14,17 @@ class ExportManager
   # @param cases (Array)
   # @param input (Hash) Selected export options
   def call(main_report, cases, args)
-    if args.class != Hash
-      puts Rainbow("[ERROR] ExportManager: argument error!").red
-      puts Rainbow("[ERROR] Fix line <export #{args}>").red
-      puts Rainbow("[ERROR] Replace by <export format: 'txt'>").red
-      puts ""
-      exit 1
-    end
+    raise Teuton::ExportArgumentError, args if args.class != Hash
 
     # Step 1: Validate options
     options = strings2symbols(args)
     options[:format] = Project.value[:format] if options[:format].nil?
 
     unless Formatter.available_formats.include? options[:format]
-      puts Rainbow("[WARN] ExportManager: Unkown format!").yellow.bright
-      puts Rainbow("[WARN] Fix line <export format: #{options[:format]}>").yellow.bright
-      puts Rainbow("[INFO] Available formats: #{Formatter.available_formats.join(", ")}.").white.bright
-      puts Rainbow("[INFO] Using default format <txt>.").white.bright
+      Logger.warn "ExportManager: Unkown format!"
+      Logger.warn "Fix line <export format: #{options[:format]}>"
+      Logger.warn "Available formats: #{Formatter.available_formats.join(", ")}."
+      Logger.warn "Using default format <txt>."
       options[:format] = :txt
     end
 
@@ -84,7 +78,7 @@ class ExportManager
                     "%<hour>02d%<min>02d%<sec>02d", data)
     preserve_dir = File.join(srcdir, subdir)
 
-    puts "[INFO] Preserving files => #{preserve_dir}"
+    Logger.info "Preserving files => #{preserve_dir}"
     FileUtils.mkdir(preserve_dir)
     Dir.glob(File.join(srcdir, "**.*")).each { |file| FileUtils.cp(file, preserve_dir) }
   end

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

@@ -69,7 +69,7 @@ module CheckCasesExtension
   # 3) And order to build hall of fame
   def close_reports_for_all_cases(uniques)
     threads = []
-    @cases.each { |c| threads << Thread.new { c.close uniques } }
+    @cases.each { |c| threads << Thread.new { c.close(uniques) } }
     threads.each(&:join)
 
     HallOfFame.new(@cases).call

data/lib/teuton/cli/app.rb

@@ -0,0 +1,123 @@
+require "thor"
+require_relative "../version"
+require_relative "../../teuton"
+
+module Teuton
+  module CLI
+    class App < Thor
+      map ["h", "-h", "--help"] => "help"
+
+      map ["n", "-n", "--new"] => "new"
+      desc "new DIRECTORY", "Create skeleton for a new project"
+      long_desc <<-LONGDESC
+      Create files for a new project.
+      LONGDESC
+      def new(projectpath)
+        Teuton.create(projectpath)
+      end
+
+      map ["c", "-c", "--check"] => "check"
+      option :onlyconfig, type: :boolean
+      option :color, type: :boolean
+      option :cname, type: :string
+      option :cpath, type: :string
+      desc "check [OPTIONS] DIRECTORY", "Check test and config file content"
+      long_desc <<~LONGDESC
+
+        (1) teuton check PATH/TO/DIR , Check content of start.rb and config.yaml files.
+
+        (2) teuton check PATH/TO/DIR --cname=demo , Check content of start.rb and demo.yaml files:
+
+        (3) teuton check PATH/TO/DIR --onlyconfig  , Only show config file recomendations
+
+        (4) teuton check PATH/TO/DIR/foo.rb , Check content of foo.rb and foo.yaml files.
+
+        (5) teuton check PATH/TO/DIR/foo.rb --cname=demo , Check content of foo.rb and demo.yaml files.
+
+      LONGDESC
+      def check(projectpath)
+        Teuton.check(projectpath, options)
+      end
+
+      map ["co", "-co", "--config"] => "config"
+      desc "config [OPTIONS] DIRECTORY", "Suggest configuration."
+      long_desc <<~LONGDESC
+        config DIRECTORY, "Suggest the content of the configuration file based on the test"
+      LONGDESC
+      def config(projectpath)
+        # Check Test: suggest the content of the configuration file based on the test
+        opt = {"onlyconfig" => true}
+        Teuton.check(projectpath, opt)
+      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)
+        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"
+      long_desc <<-LONGDESC
+      This function execute challenge from specified directory.
+      By default, show progress on the screen.
+
+      Let's see others options:
+
+      (1) teuton foo, run challenge from foo/start.rb with foo/config.yaml config file.
+
+      (2) teuton run foo, same as (1).
+
+      (3) teuton run --export=json foo, run challenge and export using json format.
+      Others output formats availables are: txt, html, yaml, json and colored_text.
+
+      (4) teuton run --cname=demo foo, run challenge from foo/start.rb with foo/demo.yaml config file.
+
+      (5) teuton foo/demo.rb, Run challenge from foo/demo.rb with foo/demo.yaml config file.
+
+      LONGDESC
+      def play(filepath)
+        Teuton.run(filepath, options)
+      end
+
+      map ["v", "-v", "--version"] => "version"
+      desc "version", "Show the program version"
+      def version
+        puts "#{Teuton::APPNAME} version #{Teuton::VERSION}"
+      end
+
+      ##
+      # These inputs are equivalents:
+      # * teuton dir/foo
+      # * teuton run dir/foo
+      def method_missing(method, *_args, &_block)
+        play(method.to_s)
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        # Respond to missing methods name
+        super
+      end
+
+      def self.exit_on_failure?
+        true
+      end
+    end
+  end
+end

data/lib/teuton/cli/run.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require_relative "app"
+
+module Teuton::CLI
+  def self.run(argv)
+    begin
+      Teuton::CLI::App.start(argv)
+      exit 0
+    rescue Interrupt
+      puts "\nExecution cancelled by the user."
+      exit 130
+    rescue Teuton::CaseManagerDslError => e
+      lines = e.message.split("\n")
+      head = lines.shift
+      warn "Error | #{head}"
+      lines.each { |line| warn Rainbow("Error| #{line}").white }
+    rescue Teuton::ConfigFileError => e
+      lines = e.message.split("\n")
+      head = lines.shift
+      warn "Error | #{head}"
+      lines.each { |line| warn Rainbow("Error| #{line}").white }
+    rescue Teuton::MainScriptNotFoundError => e
+      warn "Error | #{e.message}"
+    rescue Teuton::Error => e
+      warn "Controlled error: #{e.message}"
+      e.backtrace&.first(3)&.each do |line|
+        warn Rainbow("Error |   #{line}").white
+      end
+    rescue => e
+      warn "Unexpected error: #{e.message}"
+      raise e if ENV["DEBUG"]
+
+      e.backtrace&.first(3)&.each { |line| warn Rainbow("Error |   #{line}").white }
+    end
+    exit 1
+  end
+end

data/lib/teuton/errors.rb

@@ -0,0 +1,94 @@
+module Teuton
+  class Error < StandardError; end
+
+  class CaseManagerDslError < Error
+    attr_reader :original_error, :filename
+
+    def initialize(original_error, filename)
+      @original_error = original_error
+      @filename = filename
+      super(build_message)
+    end
+
+    private
+
+    def build_message
+      <<~MSG.strip
+        case_manager/dsl: #{@original_error}
+        File not found! Fix line <use '#{@filename}'>
+      MSG
+    end
+  end
+
+  class ConfigurationError < Error; end
+
+  class ConfigFileError < Error
+    attr_reader :filepath, :original_error
+
+    def initialize(filepath, original_error)
+      @filepath = filepath
+      @original_error = original_error
+      super(build_message)
+    end
+
+    private
+
+    def build_message
+      <<~MSG.strip
+        Reading configurations file:
+        - File : #{@filepath}
+        - Type : #{@original_error}
+      MSG
+    end
+  end
+
+  class InputError < Error; end
+  class ExecutionError < Error; end
+
+  class ExportArgumentError < Error
+    attr_reader :args
+
+    def initialize(args)
+      @args = args
+      super(build_message)
+    end
+
+    private
+
+    def build_message
+      <<~MSG.strip
+        ExportManager: argument error!
+        - Fix line <export #{@args}>
+        - Replace by <export format: 'txt'>
+      MSG
+    end
+  end
+
+  class MainScriptNotFoundError < Error
+    attr_reader :script_path
+
+    def initialize(script_path)
+      @script_path = script_path
+      super(build_message)
+    end
+
+    private
+
+    def build_message
+      <<~MSG.strip
+        Main script file not found!
+        - File: #{script_path}
+      MSG
+    end
+  end
+
+  class UnexpectedSequenceTypeError < Error
+    attr_reader :received_class
+
+    def initialize(value_class)
+      super("expect_sequence #{value_class}")
+    end
+  end
+
+  class UploadArgumentError < ArgumentError; end
+end

data/lib/teuton/readme/action.rb

@@ -0,0 +1,29 @@
+class Readme
+  class Action
+    attr_reader :id
+    attr_accessor :description, :weight, :readme, :host, :exec
+
+    def initialize
+      @id = 0
+      @description = nil
+      @host = nil
+      @readme = []
+    end
+
+    def reset
+      @id += 1
+      @description = nil
+      @host = nil
+      @readme = []
+      self
+    end
+
+    def to_h
+      {
+        id: id,
+        description: description, weight: weight, readme: readme,
+        host: host, exec: exec
+      }
+    end
+  end
+end