teuton 3.1.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a570d2b6215ff6b0ec6b1f2c7b8335fae59bc09fa431ccfe2b53d5915741973a
-  data.tar.gz: 71faaf841d291094d9d31712788984b698e190399232f8ea9ef3b9d05dd6ebff
+  metadata.gz: 3516a5e7aa9c634173b9e5eb7861ff1714ee4e583da4bcad3c01ac8400831313
+  data.tar.gz: c551387224c5c47a545c4455a673d7401495b0a2ef000770010c8d0d3926079d
 SHA512:
-  metadata.gz: 52d80646fd74c71ba0b1b9d4a678cbf3af441f6c1bd8b376cc05d9be43d0c22522b847364ae85c2979618b426c88ef2a0220c9c9f033b1c020767d22159ab960
-  data.tar.gz: 4ff1a2f3cd3d2e0c68e3b7b08e58deef6d96a153e4610378a20be7d22902f9ab6767c80db2c42517454c13178b4cb811147dc9f2b3386c70ec48bc3d0e81b331
+  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

@@ -7,9 +7,9 @@
 * Revisar (tests): result.grep(a).grep(b)
 * "Limpiar" las funciones "deprecated"
 * Aplicar las recomendaciones del informe de seguridad de Andrés.
-* Eliminar/limpiar toda referencia a Vagrant.
 * verify get(:key) and get('key') works fine!
 * Formatter: xml
+* Revisar la utilidad de action.assets al generar README.
 
 # 2. Documentacion
 
@@ -46,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`
@@ -71,7 +71,7 @@ libs/module
 
 Modificar el DSL/configuración para mejorar la integración con los contenidores Docker/podman:
 
-> * Docker en vez de vagrant?? → https://www.cloudbees.com/blog/ssh-into-a-docker-container-how-to-execute-your-commands
+> * Docker?? → https://www.cloudbees.com/blog/ssh-into-a-docker-container-how-to-execute-your-commands
 
 Host definition example:
 
@@ -147,7 +147,6 @@ var
 * Unify messages ERROR, INFO, WARN. etc
 * **TEST**:
     * HallOfFame test
-    * actualizar las pruebas con vagrant para la versión actual. Mejora de la calidad del código (Todo lo de Vagrant debería estar deprecated).
 
 ## 4.3 FEATURE - SAVE STATE
 
@@ -170,48 +169,92 @@ var
     * Documentación en https://readthedocs.org/ ??
 * FEATURE: Auto Parse new input format, and detect parse errors
 
+## 4.5 Async or Ractors
+
+Expandir el modo de ejecución y medir rendimiento:
+
+- Secuencial
+- Hilos
+- 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
 
-Empezó como un nuevo feature pero por su dimensión, funcionalidad y características ha derivado en su propio proyecto indepemndiente:
-
-* La gema `teuton-panel`
-
-## 5.1. Nueva gema teuton-panel (v2.0.0)
-
-> Consultar en el repostorio `teuton-panel`. EN PROCESO!!!
-
-Este TO-DO debería estar en el propio repo de la nueva gema.
-
-* Crear nueva gema `teuton-panel` (v2) que sustituirá la versión obsoleta actual.
-* Modificar/ampliar las funciones de `teuton config` para facilitar el trabajo a `teuton-panel`.
-    * tt_include
-    * tt_include_params
-    * aplanar/desaplanar config file.
-* En las pruebas hemos usado `sinatra` para implementarlo.
-
-Funcionalidades del interfaz web:
-
-* config cases: 
-    * config/remote: 
-      * accept-remote-config. activar/desactivar configuraciones remotas
-      * Aceptar post formulario y vía get curl con ruta.
-    * config/list: mostrar listado con info de alumnos
-    * Elegir ubicación de almacenamiento de las configuraciones
-* run:
-    * Ejecutar por el profesor
-        * Todos
-        * Una selección de cases
-        * every: repeticiones en bucle de I iteraciones, cada T tiempo.
-    * El alumno solicita su propia ejecución vía curl
-    * Elegir ubicación de almacenamiento de los informes
-    * Al finalizar cada ejecución se muestre un listado con los resultados
-* readme/doc:
-    * activar auto "teuton doc" a página web para los alumnos.
-* config panel:
-    * panel/new: crear fichero de configuración del panel
-    * panel/save: save configuración del panel
-
-## 5.2 Editor de tests
+Ideas que emepzaron como un nuevo feature pero por sus dimensiones, funcionalidades y características van ha derivar a su propio proyecto independiente:
+
+## 5.1 Editor de tests
 
 * Editor de tests ?! .... lo veo complejo... a menos que se empiece por una versión simplificada..
 * El DSL es tan sencillo que no le veo sentido a un editor de retos.

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/install/t-node.md

@@ -57,19 +57,9 @@ Run this command as admin user (member of `admin` group):
 curl -sL https://raw.githubusercontent.com/teuton-software/teuton/master/install/mac/t-node_install.sh | bash
 ```
 
-## 3. Vagrant and Docker installation
+## 3. Docker installation
 
-Choose this way if you plan to install Teuton into virtual machines or containers, and you are familiar with Vagrant and Docker technologies.
-
-## 3.1 Install using Vagrant
-
-* First, install `Vagrant` and `VirtualBox` on your host.
-* Create directory for vagrant project. For example, `mkdir teuton-vagrant`.
-* Move into that directory: `cd teuton-vagrant`.
-* Choose and download [Vagrantfile](../../install/vagrant).
-* Run `vagrant up` to create your Virtual Machine.
-
-## 3.2 Install using Docker
+## 3.1 Installation
 
 First:
 * Install `docker` on your host.
@@ -84,7 +74,7 @@ Run this command to pull **dvarrui/teuton** image from Docker Hub and create "te
 
 `docker run --name teuton -v /home/teuton -i -t dvarrui/teuton /bin/bash`
 
-## 3.2 Rebuild local docker image
+## 3.3 Rebuild local docker image
 
 1. Create Dockerfile like this:
 
@@ -113,7 +103,7 @@ CMD ["/bin/bash"]
 
 ## 4. Source code
 
-If you want to install Teuton by your own, or there are not installation scripts for your OS, and you don't want to use Vagrant then... here you have information how to install all the required packages for Teuton.
+If you want to install Teuton by your own, or there are not installation scripts for your OS, here you have information how to install all the required packages for Teuton.
 
 Manual installation:
 1. Git installation

data/docs/learn/18-log.md

@@ -6,6 +6,8 @@
 
 ## Example
 
+* Logging ERROR, WARN and INFO messages.
+
 ```ruby
 group "Learning about log messages" do
   log "Using log messages."
@@ -21,46 +23,79 @@ group "Learning about log messages" do
 end
 ```
 
+* Logging an Array config param, and a Hash config param:
+
+```yaml
+---
+global:
+  values1:
+  - A1
+  - B1
+  - C1
+  values2:
+    p1: A2
+    p2: B2
+    p3: C2
+cases:
+- tt_members: TOCHANGE
+```
+
+```ruby
+group "Log: Array, Hash" do
+  log "-------------"
+  log "Array values : #{get(:values1)}"
+  log "Hash values  : #{get(:values2)}"
+end
+```
+
 ## Output
 
 Content of `var/18-log/case-01.txt` file.
 
-```
+```txt
 CONFIGURATION
-+-------------+-----------+
-| tt_members  | anonymous |
-| tt_sequence | false     |
-| tt_skip     | false     |
-| tt_testname | 18-log    |
-+-------------+-----------+
++----------------+-----------------------------------+
+| tt_config_path | examples/18-log/config.yaml       |
+| tt_members     | TOCHANGE                          |
+| tt_script_path | examples/18-log/start.rb          |
+| tt_sequence    | false                             |
+| tt_skip        | false                             |
+| values1        | ["A1", "B1", "C1"]                |
+| values2        | {:p1=>"A2", :p2=>"B2", :p3=>"C2"} |
++----------------+-----------------------------------+
 
 LOGS
-    [09:14:22]  INFO: Using log messages.
-    [09:14:22]  INFO: uid=1000(david) gid=1000(david) grupos=495(cdrom),493(disk),487(video),474(wheel),464(wireshark),459(docker),456(vboxusers),1000(david)
-    [09:14:22] ERROR: Problem detected!
-    [09:14:22] WARN!: This is a warning
-    [09:14:22]  INFO: Hi, there!
+    [22:35:04]  INFO: Using log messages.
+    [22:35:04]  INFO: uid=1000(david) gid=1000(david) grupos=1000(david),478(wheel),464(vboxusers),108(libvirt),107(qemu),462(vagrant),460(docker),452(ollama)
+    [22:35:04] ERROR: Problem detected!
+    [22:35:04] WARN!: This is a warning
+    [22:35:04]  INFO: Hi, there!
+    [22:35:04]  INFO: -------------
+    [22:35:04]  INFO: Array values : ["A1", "B1", "C1"]
+    [22:35:04]  INFO: Hash values  : {:p1=>"A2", :p2=>"B2", :p3=>"C2"}
 
 GROUPS
 - Learning about log messages
     01 (1.0/1.0)
         Description : Create user david
         Command     : id david
-        Duration    : 0.002 (local)
+        Output      : uid=1000(david) gid=1000(david) grupos=1000(david),478(wheel),464(vboxusers),108(libvirt),107(qemu),462(vagrant),460(docker),452(ollama)
+        Duration    : 0.005 (local)
         Alterations : find(david) & count
-        Expected    : Greater than 0 (String)
-        Result      : 1 (Integer)
+        Expected    : Greater than 0
+        Result      : 1
 
 RESULTS
 +--------------+---------------------------+
-| case_id      | 01                        |
-| start_time   | 2023-01-26 09:14:22 +0000 |
-| finish_time  | 2023-01-26 09:14:22 +0000 |
-| duration     | 0.002012326               |
 | unique_fault | 0                         |
+| case_id      | 01                        |
+| start_time   | 2026-10-12 22:35:04 +0100 |
+| finish_time  | 2026-10-12 22:35:04 +0100 |
+| duration     | 0.004786563               |
 | max_weight   | 1.0                       |
 | good_weight  | 1.0                       |
-| fail_weight  | 0.0                       |
+| fail_weight  | 0                         |
 | fail_counter | 0                         |
 | grade        | 100                       |
 +--------------+---------------------------+
+```

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

@@ -15,26 +15,25 @@ module DSL
     elsif input.instance_of?(String) || input.instance_of?(Regexp) || input.instance_of?(Array)
       expect_any input
     else
-      puts Rainbow("[ERROR] Case expect TypeError: <expect #{input} (#{input.class})>").red
+      puts Rainbow("[ERROR] Case expect TypeError: <expect #{input} (#{input.class})>").bright.red
     end
   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 "[ERROR] expect_sequence #{value.class}"
-      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/run_script.rb

@@ -11,8 +11,8 @@ module DSL
     end
 
     items = script.split(" ")
-    if items.size < 1
-      msg = Rainbow("==> [ERROR] run_script: Incorrect command '#{command}'").red
+    if items.empty?
+      msg = Rainbow("[ERROR] run_script: Incorrect command '#{command}'").bright.red
       verboseln(msg)
       return
     end
@@ -28,7 +28,7 @@ module DSL
       command = items.join(" ")
       run(command, args)
     else
-      msg = Rainbow("==> [ERROR] run_script: Incorrect protocol(#{host.protocol})").red
+      msg = Rainbow("[ERROR] run_script: Incorrect protocol(#{host.protocol})").bright.red
       verboseln(msg)
     end
   end