teuton 3.2.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3143249db4eb37afed6b89f43c8eac399724fc1a65c3d582455693b7c2c70f15
-  data.tar.gz: d45960480b70bca167e2fc8733b05595038db19d9787d737e69fe8292ac6db0b
+  metadata.gz: 3516a5e7aa9c634173b9e5eb7861ff1714ee4e583da4bcad3c01ac8400831313
+  data.tar.gz: c551387224c5c47a545c4455a673d7401495b0a2ef000770010c8d0d3926079d
 SHA512:
-  metadata.gz: 9ddfd29427767f264e6988bb90e6a1080af39b405028c76274f1731b1b5cfe066b054c08f8669f549537e44284a201871b13dcd9d6a6c76550f8c7e0f2b852e3
-  data.tar.gz: dae095a5c5f4f17643ed5ea26523ec2abb369b0a34c82381102f9ed0f4e0766fe5809188f0ac252b66744a28250fd8b652a7299f42d7faa3443c0a081766d2d8
+  metadata.gz: 320eb8621ce4b42c2f5316a2b8edb7a8a6ea01abf9fc2e42588df583bd3baa10a22b51b9389d829544a1fae82a84934f6e1c82d98624a6bd263a8cafb5db2678
+  data.tar.gz: 80cc780a54d6b2771904475f5cd89b6954b46c9cf9e04a173cc6dc0e996db13eb3bed7dd2c92b252ae8d58faedb16d1f361d4e151fb26f8baab4f812349086c1

data/README.md

@@ -37,7 +37,7 @@ group "Learn about targets" do
   expect_fail
 end
 
-start do
+play do
   show
   export
 end

data/bin/teuton

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
+require "teuton/cli/run"
 
-require "teuton/cli"
-
-CLI.start(ARGV)
+Teuton::CLI.run(ARGV)

data/docs/commands/readme.md

@@ -28,7 +28,7 @@ group "Learn about targets" do
   expect_fail
 end
 
-start do
+play do
   show
   export
 end

data/docs/devel/todo.md

@@ -9,6 +9,7 @@
 * Aplicar las recomendaciones del informe de seguridad de Andrés.
 * verify get(:key) and get('key') works fine!
 * Formatter: xml
+* Revisar la utilidad de action.assets al generar README.
 
 # 2. Documentacion
 
@@ -45,7 +46,7 @@ Ampliar las estadísticas de salida en el report `resume`:
 
 Nueva feature "eventos".
 
-* La idea está documentada mejor en el enlace siguiente.
+* La idea está desarrollada en el enlace siguiente.
 * [Propuesta](https://github.com/dvarrui/teuton-book/blob/main/docs/03.eventos/index.md)
 
 Idea antigua: `ensure`
@@ -177,6 +178,78 @@ Expandir el modo de ejecución y medir rendimiento:
 - Fibras
 - Actores
 
+## 4.6 Excepciones vs exit 
+
+La buena práctica es la separación de responsabilidades:
+
+* La librería nunca debe hacer exit ni abort. Su trabajo es exclusivamente levantar excepciones personalizadas cuando algo sale mal.
+* El ejecutable (CLI) es el único que debe capturar esas excepciones, mostrarlas de forma amigable por la terminal y decidir cuándo terminar el proceso con exit 1.
+
+* **Paso 1: Definir excepciones personalizadas**: 
+
+```ruby
+# lib/teuton/errors.rb
+module Teuton
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+  class ExecutionError < Error; end
+end
+```
+* **Paso 2: Reemplazar los exit 1 en la librería por `raise`**
+
+```ruby
+# lib/teuton/runner.rb
+def run
+  if invalid_config?
+    raise Teuton::ConfigurationError, "Configuración inválida"
+  end
+end
+```
+
+* Paso 3: Capturar las excepciones en CLI
+* Integración con Thor
+
+1. Hacer que Thor devuelva un código de salida 1 en errores de Thor
+
+```ruby
+# lib/teuton/cli.rb
+require "thor"
+
+module Teuton
+  class CLI < Thor
+    # Esto asegura que si Thor falla internamente (ej: comandos/opciones inválidas),
+    # el programa salga con código 1 en lugar de 0.
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "run", "Ejecuta un script de Teuton"
+    def run
+      # Aquí llamas a la lógica de tu gema
+      # Si hay un error, tu lógica lanzará una excepción (ej: Teuton::Error)
+      Teuton::Runner.new.execute
+    end
+  end
+end
+```
+
+2. Lanzar excepciones personalizadas en la lógica de tu librería.
+
+```ruby
+# lib/teuton/runner.rb
+module Teuton
+  class Runner
+    def execute
+      if algun_error_detectado?
+        raise Teuton::Error, "Ocurrió un error al ejecutar los tests"
+      end
+    end
+  end
+end
+```
+
+3. Capturar excepciones en el ejecutable bin/teuton
+
 # 5. Proyectos
 
 Ideas que emepzaron como un nuevo feature pero por sus dimensiones, funcionalidades y características van ha derivar a su propio proyecto independiente:

data/docs/dsl/send.md

@@ -6,7 +6,7 @@
 
 Usage:
 ```ruby
-start do
+play do
   export
   send copy_to: :host1
 end
@@ -31,7 +31,7 @@ If you export several files using differents output formats, you will use severa
 In this example we export html and txt files, but only send txt to remote hosts:
 
 ```ruby
-start do
+play do
   export format: :json
   export format: :txt
 
@@ -42,7 +42,7 @@ end
 If you want to send every exported output file, then do like this:
 
 ```ruby
-start do
+play do
   export format: :html
   send copy_to: :host1
 

data/docs/dsl/show.md

@@ -5,7 +5,7 @@
 When all tests are finished, the `show` command displays information on the screen about the final results.
 
 ```ruby
-start do
+play do
   show
 end
 ```
@@ -18,7 +18,7 @@ end
 | `show verbose: NUMBER` | NUMBER is the value of the verbose level |
 
 ```ruby
-start do
+play do
   show verbose: 1
 end
 ```

data/docs/tutorial/es/nginx/README.md

@@ -43,7 +43,7 @@ Usando la siguiente plantilla de ejemplo de la herramienta Teuton:
   expect_fail
 end
 
-start do
+play do
   show
   export
 end
@@ -80,7 +80,7 @@ group "Nginx Web Service Checks" do
   expect ["Hola Mundo!"]
 end
 
-start do
+play do
   show 
   export 
 end
@@ -109,7 +109,7 @@ group "Comprobar el servicio web Nginx" do
   expect "Hola Mundo!"
 end
 
-start do
+play do
   show 
   export 
 end
@@ -129,7 +129,7 @@ end
 # File: start.rb (Script principal)
 use "nginx"
 
-start do
+play do
   show 
   export 
 end

data/lib/teuton/case/action.rb

@@ -0,0 +1,31 @@
+class Case
+  class Action
+    attr_reader :id
+    attr_accessor :groupname, :description, :weight, :asset,
+      :command, :encoding, :host, :exec, :conn_type, :duration,
+      :result, :output, :alterations, :expected, :check
+
+    def initialize
+      @id = 0
+      @groupname = nil
+      @description = "No description!"
+      @weight = 1.0
+    end
+
+    def next
+      @id += 1
+      self
+    end
+
+    def to_h
+      {
+        id: id,
+        groupname: groupname, description: description, weight: weight, asset: asset,
+        command: command, encoding: encoding, host: host, exec: exec,
+        conn_type: conn_type, duration: duration,
+        result: result, output: output,
+        alterations: alterations, expected: expected, check: check
+      }
+    end
+  end
+end

data/lib/teuton/case/case.rb

@@ -4,6 +4,7 @@ require_relative "../utils/project"
 require_relative "../utils/verbose"
 require_relative "../report/report"
 require_relative "dsl/all"
+require_relative "action"
 require_relative "config"
 require_relative "close"
 # require_relative "builtin/main"
@@ -20,7 +21,11 @@ class Case
   # Readed by ExecuteManager
   attr_reader :id, :config, :uniques, :skip
 
-  @@id = "01" # First case ID value
+  @current_case_id = "00" # First case ID value
+
+  def self.next_id
+    @current_case_id = @current_case_id.next
+  end
 
   def initialize(config)
     @config = Case::Config.new(
@@ -28,9 +33,7 @@ class Case
       global: Project.value[:global]
     )
     @groups = Project.value[:groups]
-
-    @id = @@id
-    @@id = @@id.next
+    @id = Case.next_id
 
     # Define Case Report
     @report = Report.new(@id)
@@ -49,17 +52,10 @@ class Case
 
     @unique_values = {}
     @result = Result.new
-    @action_counter = 0
-    @action = {
-      id: 0,
-      weight: 1.0,
-      description: "No description!",
-      groupname: nil
-    }
+    @action = Action.new
     @uniques = []
     @sessions = {} # Store opened sessions for this case
     @conn_status = {}
-    tempfile :default
   end
 
   def export(format)

data/lib/teuton/case/close.rb

@@ -5,7 +5,7 @@ class Case
     # Invoked from check_cases!
 
     fails = 0
-    @uniques.each do |key|
+    uniques.each do |key|
       next unless uniques[key].include?(id) && uniques[key].count > 1
 
       fails += 1

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

@@ -20,21 +20,20 @@ module DSL
   end
 
   def expect2(cond, args = {})
-    @action_counter += 1
-    @action[:id] = @action_counter
-    if @result.exitcode < 0
+    @action.next
+    if @result.exitcode.negative?
       # When exitcode is less than zero, it is because there has been
       # an error in the remote connection (SSH or Telnet)
-      @action[:check] = false
-      @action[:result] = @action[:output]
+      @action.check = false
+      @action.result = @action.output
     else
-      @action[:check] = cond
-      @action[:result] = (args[:value] || @result.value)
+      @action.check = cond
+      @action.result = (args[:value] || @result.value)
     end
 
-    @action[:alterations] = @result.alterations
-    @action[:expected] = (args[:expected] || @result.expected)
-    @report.lines << @action.clone
+    @action.alterations = @result.alterations
+    @action.expected = (args[:expected] || @result.expected)
+    @report.lines << @action.to_h
     weight(1.0)
 
     c = Settings.letter[:fail]

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

@@ -164,8 +164,7 @@ class ExpectSequence
     elsif value.is_a? Regexp
       return true << index if value.match(line)
     else
-      puts Rainbow("[ERROR] expect_sequence #{value.class}").bright.red
-      exit 1
+      raise Teuton::UnexpectedSequenceTypeError, value.class
     end
     false
   end

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

@@ -11,9 +11,9 @@ module DSL
   def macro(name, input = {})
     macros = Project.value[:macros]
     unless macros[name]
-      msg = "DSL '#{name}' not found!"
+      msg = "Unknown DSL keyword '#{name}'"
       log(msg, :error)
-      Logger.error("ERROR #{msg}")
+      Logger.warn("Warn: #{msg}")
       return
     end
     input.each_pair { |k, v| set(k, v) }
@@ -39,6 +39,7 @@ module DSL
     elsif a[0, 6] == "macro_"
       return macro a[6, a.size], args
     end
+
     macro a, args
   end
 

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

@@ -19,13 +19,12 @@ module DSL
   def goto(host = :localhost, args = {})
     @result.reset
     args[:on] = host unless args[:on]
-    @action[:command] = args[:execute].to_s if args[:execute]
-    @action[:command] = args[:exec].to_s if args[:exec]
-    tempfile(args[:tempfile]) if args[:tempfile]
-    @action[:encoding] = args[:encoding] || "UTF-8"
+    @action.command = args[:execute].to_s if args[:execute]
+    @action.command = args[:exec].to_s if args[:exec]
+    @action.encoding = args[:encoding] || "UTF-8"
 
     ExecuteManager.new(self).call(host)
-    @action[:output] = if @result.content.size < 2
+    @action.output = if @result.content.size < 2
       @result.value.clone
     else
       "(#{@result.content.size} lines)"

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?
 
@@ -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"

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
 

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