teuton 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3143249db4eb37afed6b89f43c8eac399724fc1a65c3d582455693b7c2c70f15
-  data.tar.gz: d45960480b70bca167e2fc8733b05595038db19d9787d737e69fe8292ac6db0b
+  metadata.gz: 2ffb8159388474653ba97b292becba216b9dc0d1361c5669c1c6c3ce8fd5b678
+  data.tar.gz: 7215fb1ca9e5b350c7e46498323bca0f51cc0ad2dfcbfc517ac3f2175183dbbf
 SHA512:
-  metadata.gz: 9ddfd29427767f264e6988bb90e6a1080af39b405028c76274f1731b1b5cfe066b054c08f8669f549537e44284a201871b13dcd9d6a6c76550f8c7e0f2b852e3
-  data.tar.gz: dae095a5c5f4f17643ed5ea26523ec2abb369b0a34c82381102f9ed0f4e0766fe5809188f0ac252b66744a28250fd8b652a7299f42d7faa3443c0a081766d2d8
+  metadata.gz: 53b34316e0dc1e8c7a2a8a042ef1694accb3ca89f3e9d193c8471104fd89de00c123f1f6a8ccbd8e2c1335e0446b11f6dcc328e7a6c28da4d7b4f89f26e1245a
+  data.tar.gz: 42fec6d0b1846cfcc73fef79731aa98966220705a76ed81a76ae3f4e9cc01a2eaa4f7e3b97c13a334b7bcf892d1947314b16417927024976623546ca41a88a33

data/README.md

@@ -37,7 +37,7 @@ group "Learn about targets" do
   expect_fail
 end
 
-start do
+play do
   show
   export
 end
@@ -46,18 +46,18 @@ end
 **Usage**: Run test with `teuton run TESTPATH`.
 
 ```console
-$ teuton run examples/02-target
+$ teutonx examples/02-target 
 ------------------------------------
-Started at 2025-12-01 18:14:44 +0000
+Started at 2026-10-21 17:05:49 +0100
 F.
 Finished in 0.005 seconds
 ------------------------------------
  
-CASE RESULTS
-+------+-----------+-------+-------+
-| CASE | MEMBERS   | GRADE | STATE |
-| 01   | anonymous | 33.0  | ?     |
-+------+-----------+-------+-------+
+ CASE RESULTS
+┌──────┬───────────┬───────┬───────┐
+│ CASE │ MEMBERS   │ GRADE │ STATE │
+│ 01   │ anonymous │ 33.0  │ ?     │
+└──────┴───────────┴───────┴───────┘
 ```
 
 **Output**: reports saved into `var/TESTNAME` folder.

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

@@ -5,13 +5,14 @@
 ```
 $ teuton
 Commands:
-  teuton [run] [OPTIONS] DIRECTORY   # Run test from directory
-  teuton check [OPTIONS] DIRECTORY   # Check test and config file content
-  teuton config [OPTIONS] DIRECTORY  # Suggest configuration or run server
-  teuton help [COMMAND]              # Describe available commands or one specific command
-  teuton new DIRECTORY               # Create skeleton for a new project
-  teuton readme DIRECTORY            # Show README extracted from test contents
-  teuton version                     # Show the program version
+  teuton [run] [OPTIONS] DIRECTORY  # Run test from directory
+  teuton check [OPTIONS] DIRECTORY  # Check test and config file content
+  teuton config DIRECTORY           # Suggest configuration.
+  teuton help [COMMAND]             # Describe available commands or one specific command
+  teuton new DIRECTORY              # Create skeleton for a new project
+  teuton readme DIRECTORY           # Show README extracted from test contents
+  teuton tree                       # Print a tree of all available commands
+  teuton version                    # Show the program version
 ```
 
 Available command functions:

data/docs/commands/check.md

@@ -27,11 +27,12 @@ Alias: `teuton c foo`, `teuton -c foo`, `teuton --check foo`
 ## Example
 
 ```
-$ teuton check examples/02-target
+$ teuton check examples/02-target 
+
+┌────────────────────────────┐
+│ GROUP: Learn about targets │
+└────────────────────────────┘
 
-+----------------------------+
-| GROUP: Learn about targets |
-+----------------------------+
 (001) target      Create user obiwan
       weight      2.0
       run         'id obiwan' on localhost
@@ -42,17 +43,18 @@ $ teuton check examples/02-target
       run         'id vader' on localhost
       expect_fail
 
-+--------------+-------+
-| DSL Stats    | Count |
-+--------------+-------+
-| Groups       | 1     |
-| Targets      | 2     |
-| Runs         | 2     |
-|  * localhost | 2     |
-+--------------+-------+
-[WARN] Configfile not found
-       .../examples/02-target/config.yaml
-[INFO] Recomended content:
+
+┌──────────────┬───────┐
+│ DSL Stats    │ Count │
+├──────────────┼───────┤
+│ Groups       │ 1     │
+│ Targets      │ 2     │
+│ Runs         │ 2     │
+│  * localhost │ 2     │
+└──────────────┴───────┘
+Warn | Configfile not found
+- File: ../examples/02-target/config.yaml
+Info | Recomended content:
 ---
 global:
 cases:

data/docs/commands/help.md

@@ -15,23 +15,33 @@ Alias: `teuton h`,`teuton -h`, `teuton --help`
 Commands:
   teuton [run] [OPTIONS] DIRECTORY   # Run test from directory
   teuton check [OPTIONS] DIRECTORY   # Check test and config file content
-  teuton config [OPTIONS] DIRECTORY  # Suggest configuration or run server
+  teuton config [OPTIONS] DIRECTORY  # Suggest configuration.
   teuton help [COMMAND]              # Describe available commands or one specific command
   teuton new DIRECTORY               # Create skeleton for a new project
   teuton readme DIRECTORY            # Show README extracted from test contents
+  teuton tree                        # Print a tree of all available commands
   teuton version                     # Show the program version
 ```
 
-**Example**: `teuton help config`
+**Example**: `teuton help check`
+
 ```
 Usage:
-  teuton config [OPTIONS] DIRECTORY
+  teuton check [OPTIONS] DIRECTORY
 
 Options:
-  [--server], [--no-server], [--skip-server]  
+  [--onlyconfig], [--no-onlyconfig], [--skip-onlyconfig]  
+  [--color], [--no-color], [--skip-color]                 
+  [--cname=CNAME]                                         
+  [--cpath=CPATH]                                         
 
 Description:
-  config DIRECTORY, "Suggest the content of the configuration file based on the test"
+  (1) teuton check PATH/TO/DIR , Check content of start.rb and config.yaml files.
 
-  config --server DIRECTORY, "Init Config Server. Students connect and help to build config file content"
-```
+  (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.```

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

@@ -1,18 +1,16 @@
 [<< back](../../README.md)
 
-# Roadmap Teuton v3.0.0 - 2026
+# Roadmap Teuton v3.3.0 - 2026
 
 # 1. Revisar
 
 * Revisar (tests): result.grep(a).grep(b)
-* "Limpiar" las funciones "deprecated"
 * Aplicar las recomendaciones del informe de seguridad de Andrés.
 * verify get(:key) and get('key') works fine!
 * Formatter: xml
 
 # 2. Documentacion
 
-* Nuevo repo `teuton-book`: para documentación, tutoriales en español.
 * Documentar y hacer videos. Tener foros de la comunidad o presencia en reddit o stackoverflow.... o algo parecido???
 * Snode Dockerfile with SSH server
 * **ngrok**:
@@ -45,7 +43,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 +175,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/dsl/target.md

@@ -17,17 +17,3 @@ By default weight is `1.0`, but it's posible specified other values:
 ```ruby
 target "Write here your description", weight: 2.5
 ```
-
-## [DEPRECATED] Alias
-
-`goal` keyword is an alias of `target`. So it's the same:
-
-```ruby
-target "Write here your description"
-```
-
-or
-
-```ruby
-goal "Write here your description"
-```

data/docs/install/t-node.md

@@ -106,24 +106,13 @@ CMD ["/bin/bash"]
 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
-    * Install Git.
-    * Run `git --version` to show current version
-1. Ruby installation
-    * Install ruby.
-    * Run `ruby -v` to show current version (2.1.3p242+)
-1. Rake installation
-    * Run `gem install rake`, then
-    * `rake --version` to show current version (10.4.2+).
-1. Download this project
-    * (a) `git clone https://github.com/dvarrui/teuton.git` or
-    * (b) Download and unzip [file](https://github.com/dvarrui/teuton-panel/archive/master.zip).
-1. Move into Teuton folder
-    * Run `cd teuton`
-1. Gems installation.
-    * `rake install`, to install required gems.
-1. Only for developers
-    * Run `rake devel:debian` or
-    * `rake devel:opensuse`, install gem for developers.
-1. Final check
-    * `rake`
+
+1. Install Git. Run `git --version` to show current version
+1. Install ruby. Run `ruby -v` to show current version (3.2.8)
+1. Install Rake (`gem install rake`), then `rake --version` to show current version (13.4.2).
+1. Clone repo `git clone https://github.com/dvarrui/teuton.git` or download and unzip.
+1. Move into Teuton folder: `cd teuton`
+1. Install gems: `rake install`. 
+1. Only Debian OS: `rake devel:debian`.
+1. Obly OpenSUSE OS: `rake devel:opensuse`.
+1. Final check: `rake`

data/docs/learn/02-target.md

@@ -62,13 +62,13 @@ end
 Execute this command to run the test:
 
 ```
-$ teuton run examples/02-target
-
-CASE RESULTS
-+------+-----------+-------+-------+
-| CASE | MEMBERS   | GRADE | STATE |
-| 01   | anonymous | 100.0 | ✔     |
-+------+-----------+-------+-------+
+$ teuton examples/02-target 
+ 
+ CASE RESULTS
+┌──────┬───────────┬───────┬───────┐
+│ CASE │ MEMBERS   │ GRADE │ STATE │
+│ 01   │ anonymous │ 33.0  │ ?     │
+└──────┴───────────┴───────┴───────┘
 ```
 
 Report files are created into `var/02-target/` folder:
@@ -85,44 +85,46 @@ Let's see one report:
 
 ```
 $ cat var/02-target/case-01.txt
-CONFIGURATION
-+-------------+-----------+
-| tt_members  | anonymous |
-| tt_sequence | false     |
-| tt_skip     | false     |
-| tt_testname | 02-target |
-+-------------+-----------+
-
-GROUPS
-- Learn about targets
-    01 (0.0/1.0)
-        Description : Create user obiwan
-        Command     : id obiwan
-        Output      : id: «obiwan»: no existe ese usuario
-        Duration    : 0.002 (local)
-        Alterations : find(uid=) & find((obiwan)) & find(gid=) & count
-        Expected    : Greater than 0
-        Result      : 0
-    02 (1.0/1.0)
-        Description : Delete user vader
-        Command     : id vader
-        Output      : id: «vader»: no existe ese usuario
-        Duration    : 0.002 (local)
-        Alterations : Read exit code
-        Expected    : Greater than 0
-        Result      : 1
-
-RESULTS
-+--------------+---------------------------+
-| case_id      | 01                        |
-| start_time   | 2023-06-16 08:42:13 +0100 |
-| finish_time  | 2023-06-16 08:42:13 +0100 |
-| duration     | 0.004527443               |
-| unique_fault | 0                         |
-| max_weight   | 2.0                       |
-| good_weight  | 1.0                       |
-| fail_weight  | 1.0                       |
-| fail_counter | 1                         |
-| grade        | 50                        |
-+--------------+---------------------------+
+
+ CONFIGURATION
+┌────────────────┬────────────────────────────────┐
+│ tt_config_path │ examples/02-target/config.yaml │
+│ tt_members     │ anonymous                      │
+│ tt_script_path │ examples/02-target/start.rb    │
+│ tt_sequence    │ false                          │
+│ tt_skip        │ false                          │
+└────────────────┴────────────────────────────────┘
+
+ GROUPS
+ ▶ Learn about targets
+   ✖ 01 (0.0/2.0)   ┌──
+        Description │ Create user obiwan
+        Command     │ id obiwan
+        Output      │ id: «obiwan»: no existe ese usuario
+        Duration    │ 0.002 (local)
+        Alterations │ find(uid=) & find((obiwan)) & find(gid=) & count
+        Expected    │ Greater than 0
+        Result      │ 0
+   ✔ 02 (1.0/1.0)   ├──
+        Description │ Delete user vader
+        Command     │ id vader
+        Output      │ id: «vader»: no existe ese usuario
+        Duration    │ 0.002 (local)
+        Alterations │ Read exit code
+        Expected    │ Greater than 0
+        Result      │ 1
+                    └──
+ RESULTS
+┌──────────────┬───────────────────────────┐
+│ unique_fault │ 0                         │
+│ case_id      │ 01                        │
+│ start_time   │ 2026-10-21 21:32:24 +0100 │
+│ finish_time  │ 2026-10-21 21:32:24 +0100 │
+│ duration     │ 0.004153712               │
+│ max_weight   │ 3.0                       │
+│ good_weight  │ 1.0                       │
+│ fail_weight  │ 2.0                       │
+│ fail_counter │ 1                         │
+│ grade        │ 33                        │
+└──────────────┴───────────────────────────┘
 ```

data/docs/learn/03-remote_hosts.md

@@ -55,22 +55,21 @@ end
 Execution:
 
 ```
-$ teuton run examples/03-remote_hosts
+$ teutonx examples/03-remote_hosts 
  
-CASE RESULTS
-+------+-----------+-------+-------+
-| CASE | MEMBERS   | GRADE | STATE |
-| 01   | student_1 | 0.0   | ?     |
-| -    | -         | 0.0   | S     |
-| 03   | student_3 | 100.0 | ✔     |
-+------+-----------+-------+-------+
-
-CONN ERRORS
-+------+-----------+-------+------------------+
-| CASE | MEMBERS   | HOST  | ERROR            |
-| 01   | student_1 | host1 | host_unreachable |
-+------+-----------+-------+------------------+
-
+ CASE RESULTS
+┌──────┬───────────┬───────┬───────┐
+│ CASE │ MEMBERS   │ GRADE │ STATE │
+│ 01   │ student_1 │ 0.0   │ ?     │
+│ -    │ -         │ 0.0   │ S     │
+│ 03   │ student_3 │ 100.0 │ ✔     │
+└──────┴───────────┴───────┴───────┘
+
+ CONN ERRORS
+┌──────┬───────────┬───────┬──────────────────┐
+│ CASE │ MEMBERS   │ HOST  │ ERROR            │
+│ 01   │ student_1 │ host1 │ host_unreachable │
+└──────┴───────────┴───────┴──────────────────┘
 ```
 
 Notice that: