teuton 2.9.4 → 2.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6df4861135eb226e52818814c68af43772f58cd196c5cd8008572a4bbaa26065
-  data.tar.gz: fe68c2d388c2e506641addcb32476c8de97c77224d50333a8026e2fc263656a2
+  metadata.gz: b77d496bd14e955446cbb709c63c7df74059c708949159326e3d2e0edc09b81a
+  data.tar.gz: f721aa3a9fd30021bdf15ca26c19b308d7f38e00ea016a43d6b847f7b673f7b8
 SHA512:
-  metadata.gz: 3b853fecce334497ee93d289e90f67ce8ab1d6f3f78d67072d0ed424df431e1e967a3f529c20cec4089e76d05209b7854f1d311115ec5e385185bcbf6d8cacb5
-  data.tar.gz: 56d989afeeca6f82b9f03a8a3d1613814db19e47df0d4e301934affa03e8faff033c7d85a6c60d14b04b9764ca56392db66659d5238cb314f204594b07393676
+  metadata.gz: 7cdc0745e4b04b7c81893a3aaef4fa1478f55d2c8390edaf1153ad82005238cce3d6a4ff668566528e2eca1a127c941adc1683f2164e4afd75c4125380c2bb77
+  data.tar.gz: 88b54291a14bb76f074dd9ec27657ede78142e2388b7e40af5ed058b8cad0e43d1257a6c48b9e60106268aa4b932a532b8953a96a0b600bdfe9787ff4d623cc4

data/README.md

@@ -4,14 +4,14 @@
 [![Gem Version](https://badge.fury.io/rb/teuton.svg)](https://badge.fury.io/rb/teuton)
 ![GitHub](https://img.shields.io/github/license/dvarrui/teuton)
 
-_Create Unit Test for your machines. Test your infrastructure as code._
+_Test your infrastructure as code._
 
 ![logo](./docs/images/logo.png)
 
-Infrastructure test, useful for:
+The infrastructure test is useful for:
 * Sysadmin teachers who want to evaluate students remote machines.
-* Sysadmin apprentices who want to evaluate their learning process as a game.
-* Professional sysadmin who want to monitor remote machines.
+* Students who want to evaluate their learning process.
+* Professionals who want to monitor their remote machines.
 
 # Installation
 
@@ -25,10 +25,10 @@ gem install teuton
 
 # Usage
 
-Executing `teuton` command to run example test:
+Use `teuton run TESTPATH` command to run test:
 
 ```console
-❯ teuton run examples/01-target
+> teuton run examples/01-target
 
 CASE RESULTS
 +------+-----------+-------+-------+
@@ -37,9 +37,11 @@ CASE RESULTS
 +------+-----------+-------+-------+
 ```
 
+> More information about [commands](docs/commands/README.md)
+
 # Features
 
-* Simple DSL to define your tests: `target`, `run`,`expect` and more.
+* Use simple DSL to define your tests: `target`, `run`,`expect` and more.
 * Remote devices only require SSH or Telnet service installed.
 * Output format: txt, html, json, yaml, etc.
 * Multiplatform.
@@ -67,4 +69,6 @@ CASE RESULTS
 1. Push to the branch (`git push origin my-new-feature`)
 1. Create new Pull Request.
 
-You can also [create issues](https://github.com/teuton-software/teuton/issues) with your requests/incidences/suggestions.
+You can also [create issues](https://github.com/teuton-software/teuton/issues) with your requests, incidences or suggestions.
+
+> Read [Spanish documentation](docs/es/README.md)

data/docs/changelog/changelog.2.md

@@ -125,4 +125,12 @@ DSL send:
 ## [2.9.4] 20250410
 
 - [FIX] Improve the markdown output of the readme.
-- [FIX] Telnet exitcode
+- [FIX] Telnet exitcode
+
+## [2.9.5] 20250514
+
+- [FIX] `require "json_pure"`is deprecated. Use `json` gem instead of `json_pure`.
+
+## [2.9.6] 20251106
+
+- [FIX] Problem with `export preserve: true`. It was using old class Application. Now use Project class.

data/docs/commands/README.md

@@ -6,66 +6,56 @@ Available command functions:
 1. [Show help](#1-show-help)
 2. [Show version](#2-show-version)
 3. [Create new test](#3-create-new-test)
-4. [Check teuton test](#4-check-teuton-test)
-5. [Run teuton test](#5-run-teuton-test)
+4. [Check test](#4-check-test)
+5. [Run test](#5-run-test)
+6. [Show test info as README file](#6-show-test-info-as-readme-file)
 
 # 1. Show help
 
-```bash
-teuton
-```
+Show help about command functions.
 
 Example:
-
 ```bash
-> teuton
+$ teuton help
 Commands:
-  teuton [run] [OPTIONS] DIRECTORY  # Run challenge from directory
-  teuton check [OPTIONS] DIRECTORY  # Test or check challenge contents
+  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           # Create README.md file from challenge contents
+  teuton readme DIRECTORY           # Show README extracted from test contents
   teuton version                    # Show the program version
-
 ```
 
-Alias:
+Execute `teuton help FUNCTION_NAME` for more information.
 
-* `teuton h`
-* `teuton -h`
-* `teuton --help`
+Alias: `teuton h`,`teuton -h`, `teuton --help`
 
 # 2. Show version
 
-```bash
-teuton version
-```
+Show current version.
+
+Usage: `teuton version`
 
 Example:
 
 ```bash
 $ teuton version                               
-teuton (version 2.2.0)
+teuton (version 2.9.5)
 ```
 
-Alias:
-
-* `teuton v`
-* `teuton -v`
-* `teuton --version`
+Alias: `teuton v`, `teuton -v`, `teuton --version`
 
 # 3. Create new test
 
-Create teuton test skeleton.
+Create test skeleton.
 
-```bash
-teuton new foo
-```
+Usage: `teuton new foo`
 
 Example:
 
 ```console
-> teuton new foo
+$ teuton new foo
 
 [INFO] Creating foo project skeleton
 * Create dir        => foo
@@ -78,24 +68,18 @@ This command will create the next structure:
 | File/Directory  | Description    |
 | --------------- | -------------- |
 | foo             | Base directory |
-| foo/start.rb    | Main Script    |
+| foo/start.rb    | Main file with test definitions |
 | foo/config.yaml | YAML configuration file |
 
-Alias:
-
-* `teuton n foo`
-* `teuton -n foo`
-* `teuton --new foo`
+Alias: `teuton n foo`, `teuton -n foo`, `teuton --new foo`
 
-# 4. Check teuton test
+# 4. Check test
 
-```console
-teuton check DIRPATH
-```
+Check test and config files located into DIRPATH folder.
 
-Description: this command check teuton test and config files located into DIRPATH folder.
+Usage: `teuton check DIRPATH`
 
-[Example](example_check.md)
+[Example](check-example.md)
 
 | Command                      | Description |
 | ---------------------------- | ----------- |
@@ -104,37 +88,21 @@ Description: this command check teuton test and config files located into DIRPAT
 | teuton check path/to/file/foo.rb | Test content of foo.rb and foo.yaml files. |
 | teuton check path/to/file/foo.rb --cname=demo | Test content of foo.rb and demo.yaml files.|
 
-Alias:
+Alias: `teuton c foo`, `teuton -c foo`, `teuton --check foo`
 
-* `teuton c foo`
-* `teuton -c foo`
-* `teuton --check foo`
+# 5. Run test
 
-# 5. Run teuton test
-
-```bash
-teuton run DIRPATH
-```
+Read about [how to run tests](howto-run-tests.md)
 
-Description: this command run teuton test located into DIRPATH folder.
+# 6. Show test info as README file
 
-[Example](example_run.md)
+Create a readme file for the exercise.
 
-Alias:
-
-* `teuton foo`
-
-# 6. Show README
-
-```bash
-teuton readme DIRPATH
-```
+Usage: `teuton readme DIRPATH > README.md`
 
-Read test and config files content, and display information about
-what kind of problem/exercise it is going to be evaluated. The students need this
-information to resolv the problem/exercise into their machines.
+This function reads test and config files, and generate Markdown output with guidelines and target descriptions.
 
-The teacher could write this information or may use this command to generate automaticaly.
+Students will need this information to resolv the proposed problem/exercise into their machines.
 
 Alias:
 * `teuton r DIRPATH`

data/docs/commands/{example_check.md → check-example.md}

@@ -9,16 +9,12 @@
 | --cpath          | Specify path to config file | TEST-FOLDER/config.yaml |
 | --cname          | Specify name to config file | config.yaml |
 
-Usage:
-
-```
-teuton check PATH-TO-TEST-FOLDER
-```
+Usage: `teuton check PATH-TO-TEST-FOLDER`
 
 Example:
 
 ```bash
-❯ teuton check examples/02-target
+$ teuton check examples/02-target
 
 +----------------------------+
 | GROUP: Learn about targets |

data/docs/commands/{example_run.md → howto-run-tests.md}

@@ -1,21 +1,25 @@
 
 [<< back](README.md)
 
-1. [Run test](#1-run-test)
-2. [Command options](#2-command-options)
+# Run test
+
+Run test located into DIRPATH folder.
+
+Usage: `teuton run DIRPATH`
+
+Alias: `teuton foo`
+
+1. [Example](#1-example)
+2. [Options](#2-options)
 3. [Choosing config file](#3-choosing-config-file)
 
-# 1. Run test
+# 1. Example
 
 Running Teuton test located into `example/01-target` folder.
 
 ```bash
-teuton run example/01-target
-```
-
-Example:
+$ teuton run example/01-target
 
-```bash
 ------------------------------------
 Started at 2023-01-21 13:32:24 +0000
 F
@@ -29,10 +33,12 @@ CASE RESULTS
 +------+-----------+-------+-------+
 ```
 
-# 2. Command options
+> Output files are saved into `var/01-target` folder.
+
+# 2. Options
 
 ```
-> teuton help run
+$ teuton help run
 
 Usage:
   teuton [run] [OPTIONS] DIRECTORY

data/docs/es/README.md

@@ -0,0 +1,72 @@
+
+# TEUTON (ES) - (Documentación en progreso)
+
+[![Gem Version](https://badge.fury.io/rb/teuton.svg)](https://badge.fury.io/rb/teuton)
+![GitHub](https://img.shields.io/github/license/dvarrui/teuton)
+
+_Crear test unitarios para tus máquinas y probar tu infraestructura como si fuera código._
+
+![logo](../images/logo.png)
+
+El test de infraestructura es útil para:
+* Profesores de administración de sistemas que quieren evaluar a las máquinas remotas de los alumnos.
+* Alumnos que quieren evaluar su proceso de aprendizaje.
+* Profesionales que desean monitorizar sus máquinas remotas.
+
+# Instalación
+
+Primero es necesario tener instalado `Ruby`y a continuación instalamos Teuton con el siguiente comando:
+
+```console
+gem install teuton
+```
+
+> Para instalar Teuton sin privilegios de root: `gem install --user-install teuton`
+
+# Modo de uso
+
+Usaremos el comando `teuton` para ejecutar los tests:
+
+```console
+> teuton run examples/01-target
+
+CASE RESULTS
++------+-----------+-------+-------+
+| CASE | MEMBERS   | GRADE | STATE |
+| 01   | anonymous | 100.0 | ✔     |
++------+-----------+-------+-------+
+```
+
+> Más información sobre los [comandos](../commands/README.md)
+
+# Características
+
+* DSL sencillo para definir los tests: `target`, `run`,`expect`, etc.
+* Se usa conexiones SSH o Telnet para acceder a los dispositivos remotos.
+* Formatos de salida: `txt`, `html`, `json`, `yaml`, etc.
+* Multiplatforma.
+* [Licencia de Software Libre](LICENSE).
+
+# Documentación
+
+* [Instalación](../install/README.md)
+* [Aprender](../learn/README.md)
+* [Ejemplos](../../examples)
+* [Comandos](../commands/README.md)
+* [DSL](../dsl/README.md)
+* [Blogs y videos](../videos.md)
+
+# Contacto
+
+* **Email**: `teuton.software@protonmail.com`
+
+# Contribuciones
+
+1. Asegúrate de tener `Ruby`instalado.
+1. Haz un "fork" del proyecto.
+1. Crear tu rama "feature" (`git checkout -b my-new-feature`)
+1. Haz "commit" de tus cambios (`git commit -am 'Add some feature'`)
+1. Haz "push" a la rama (`git push origin my-new-feature`)
+1. Crear un "pull request" nuevo.
+
+También se pueden [crear issues](https://github.com/teuton-software/teuton/issues) con peticiones, incidencias o sugerencias.

data/docs/es/aprender/01-cmd_new.md

@@ -0,0 +1,27 @@
+
+[<< back](README.md)
+
+# Nuevo test
+
+Crear el esquelero para un nuevo proyecto: `teuton create foo`
+
+```
+> teuton new foo
+
+[INFO] Creating foo project skeleton
+* Create dir        => foo
+* Create file       => foo/config.yaml
+* Create file       => foo/start.rb
+```
+
+> NOTA: Lo ficheros se pueden crear manualmente.
+
+Este comando crea los siguientes ficheros:
+
+| Fichero/Directorio | Descripción      |
+| ------------------ | ---------------- |
+| foo                | Direcotrio base  |
+| foo/start.rb       | Script principal |
+| foo/config.yaml    | Fichero de configuración |
+
+Ahora es el momento de personalizar nuestros objetivos (targets).

data/docs/es/aprender/02-target.md

@@ -0,0 +1,131 @@
+[<< back](README.md)
+
+# target
+
+Un [target](../../dsl/target.md) es el objetivo que queremos evaluar. Los objetivos se definen dentro de una sección `group`.
+
+## Target definition
+
+Cada proceso de evaluación consta de 3 partes:
+
+* [target](../../dsl/target.md): Descripción del elemento que va a ser evaluado.
+* [run](../../dsl/run.md): Ejecutar el comando `id obiwan` en la máquina local.
+* [expect](../../dsl/expect.md): Verificar que el resultado del comando devuelve el valor esperado.
+
+```ruby
+group "Aprender sobre los targets" do
+
+  target "Existe el usuario <obiwan>"
+  run "id obiwan"
+  expect ["uid=", "(obiwan)", "gid="]
+
+  target "No existe el usuario <vader>"
+  run "id vader"
+  expect_fail
+end
+```
+
+> En este ejemplo estamo usando un SO GNU/Linux en la máquina local porque queremos ejecutar el comando `id obiwan`.
+
+Cuando el usuario existe, esperamos encontrar estas palabras en la salida del comando: `uid=, (obiwan), gid=`.
+
+```
+> id obiwan
+uid=1000(obiwan) gid=1000(obiwan) grupos=1000(obiwan)
+```
+
+Pero cuando el usuario no existe, se esperan una salida de error.
+
+```
+> id vader
+id: «vader»: no such user
+
+> echo $?
+1
+
+```
+
+## Section de ejecución
+
+Cuando se ejecuta el test, se procesa la sección `play`, la cual contiene las siguientes instrucciones:
+
+* [show](../../dsl/show.md): mostrar por pantalla información del proceso.
+* [export](../../dsl/export.md): generar informes de salida.
+
+```ruby
+play do
+  show
+  export
+end
+```
+
+## Ejemplo
+
+Usa este comando para ejecutar el test:
+
+```console
+> teuton run examples/02-target
+
+CASE RESULTS
++------+-----------+-------+-------+
+| CASE | MEMBERS   | GRADE | STATE |
+| 01   | anonymous | 100.0 | ✔     |
++------+-----------+-------+-------+
+```
+
+Los informes de salida se crean en la carpeta `var/02-target/`:
+
+```console
+var
+└── 02-target
+    ├── case-01.txt
+    ├── moodle.csv
+    └── resume.txt
+```
+
+Veamos el contenido:
+
+```
+> 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                        |
++--------------+---------------------------+
+```

data/docs/es/aprender/README.md

@@ -0,0 +1,36 @@
+[<< back](../README.md)
+
+# Aprender
+
+Aprender a escribir tus propios test:
+
+1. [Crear un NUEVO test](01-cmd_new.md)
+1. [Evaluating TARGET](02-target.md)
+1. [Checking REMOTE HOSTS](03-remote_hosts.md)
+1. [Reading CONFIG file](04-config.md)
+1. [Using several files](05-use.md)
+1. [CHECK test syntax](06-cmd_check.md)
+1. [Target WEIGHT](07-target_weight.md)
+1. [UNIQUE values](08-unique_values.md)
+1. [SEND report copies to remote hosts](09-send.md)
+1. [DEBUG results](10-debug.md)
+1. [Export other FORMATS](11-export.md)
+1. [PRESERVE old reports](12-preserve.md)
+1. [Hide FEEDBACK from reports](13-feedback.md)
+1. [MOODLE](14-moodle_id.md)
+1. [Build README from test](15-readme.md)
+1. [INCLUDE more configuration files](16-include.md)
+1. [ALIAS](17-alias.md)
+1. [LOG messages](18-log.md)
+1. [Don't get params, just read vars](19-read_vars.md)
+1. [MACROS](20-macros.md)
+1. [Checking exit codes](21-exit_codes.md)
+1. [RESULT object](22-result.md)
+1. [Test code](23-test-code.md)
+1. [Test SQL and database](24-test-sql.md)
+1. [expect vs result](25-expect-result.md) TODO
+1. [EXPECT_SEQUENCE](26-expect_sequence.md)
+1. [RUN_SCRIPT](27-run_script.md)
+1. [UPLOAD](28-upload.md)
+
+Mores examples at [teuton-tests](https://github.com/dvarrui/teuton-tests) GitHub repository.

data/docs/install/README.md

@@ -2,14 +2,18 @@
 
 # Installation
 
-There are 2 types of nodes (hosts), so there are 2 installations:
+**Teuton installation**
 
-| ID | Software | Description |
-| -- | -------- | ----------- |
-| **T-node** | [Teuton installation](t-node.md) | T-NODE host monitors one or severals S-NODE hosts |
-| **S-node** | [SSH server installation](s-node.md) | S-NODE hosts are monitorized by T-NODE host |
+We call a device with Teuton installed as t-node. [T-NODE](t-node.md) host monitors one or severals S-NODE hosts.
+1. Install Ruby on your system.
+2. `gem install teuton`
 
-> Read [modes of use](modes_of_use.md) to know more about differents T-NODE/S-NODE schemes.
+**SSH server installation**
+
+We call e device with SSH/Telnet service as s-node. [S-NODE](s-node.md) hosts are monitorized by T-NODE host.
+1. Install SSH service.
+
+Read [modes of use](modes_of_use.md) to know more about differents T-NODE/S-NODE schemes.
 
 ## Tested OS list
 

data/docs/install/s-node.md

@@ -6,7 +6,7 @@ Install SSH server on every machine with S-NODE role.
 
 **S-node**: Host where SSH server is installed. This hosts are monitorized by T-NODE host.
 
-**S-node GNU/Linux installation**
+**GNU/Linux installation**
 
 Run this command as `root` user:
 
@@ -14,7 +14,7 @@ Run this command as `root` user:
 wget -qO- https://raw.githubusercontent.com/teuton-software/teuton/master/install/linux/s-node_install.sh | bash
 ```
 
-**S-node Windows installation**
+**Windows installation**
 
 Requirements:
 * Windows 7+ / Windows Server 2003+
@@ -26,7 +26,7 @@ Run this command on **PowerShell (PS)** as `Administrator` user:
 Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/teuton-software/teuton/master/install/windows/s-node_install.ps1'))
 ```
 
-**S-node Mac OS X installation**
+**Mac OS X installation**
 
 Run this command as `root` user: