teuton 2.11.0 → 3.0.1

data/README.md

@@ -83,33 +83,60 @@ Consult the generated [output files](examples/02-target/output.d/)
 
 # Documentation
 
-* Installation
+1. Installation
     * [Teuton installation](docs/install/t-node.md)
     * [SSH/Telnet installation](docs/install/s-node.md)
-* Teuton commands
-    * [teuton config](docs/commands/config.md)
-    * [teuton check](docs/commands/check.md)
-    * [teuton help](docs/commands/help.md)
-    * [teuton new](docs/commands/new.md)
-    * [teuton readme](docs/commands/readme.md)
-    * [teuton run](docs/commands/run.md)
-* [Learning guide](docs/learn/README.md). Learning to create tests by doing.
-* [Learning Examples](examples). The learning guide is based on these examples.
-* [Configuration file](docs/config_file.md)
-* [DSL - Language reference](docs/dsl/README.md). DSL used to define tests.
-    * [expect](docs/dsl/expect.md)
-    * [export](docs/dsl/export.md)
-    * [get](docs/dsl/get.md)
-    * [group](docs/dsl/group.md)
-    * [play](docs/dsl/play.md)
-    * [result](docs/dsl/result.md)
-    * [run](docs/dsl/run.md)
-    * [send](docs/dsl/send.md)
-    * [set](docs/dsl/set.md)
-    * [show](docs/dsl/show.md)
-    * [target](docs/dsl/target.md)
-* [Modes of use](docs/modes_of_use.md): Classroom, contest, standalone.
-* [Blogs and videos](docs/videos.md)
+2. Teuton commands
+    * [teuton config](docs/commands/config.md): suggest config file.
+    * [teuton check](docs/commands/check.md): check test syntax.
+    * [teuton help](docs/commands/help.md): show command help.
+    * [teuton new](docs/commands/new.md): create new test.
+    * [teuton readme](docs/commands/readme.md): generate test documentation.
+    * [teuton run](docs/commands/run.md): run test.
+3. [Learning guide](docs/learn/README.md). Learn writing your own tests. [Examples](examples).
+    * [Create NEW test](docs/learn/01-cmd_new.md)
+    * [Evaluate TARGET](docs/learn/02-target.md)
+    * [Check REMOTE HOSTS](docs/learn/03-remote_hosts.md)
+    * [Read CONFIG file](docs/learn/04-config.md)
+    * [Use several files](docs/learn/05-use.md)
+    * [CHECK test syntax](docs/learn/06-cmd_check.md)
+    * [Target WEIGHT](docs/learn/07-target_weight.md)
+    * [UNIQUE values](docs/learn/08-unique_values.md)
+    * [SEND report copies to remote hosts](docs/learn/09-send.md)
+    * [DEBUG results](docs/learn/10-debug.md)
+    * [Export other FORMATS](docs/learn/11-export.md)
+    * [PRESERVE old reports](docs/learn/12-preserve.md)
+    * [Hide FEEDBACK from reports](docs/learn/13-feedback.md)
+    * [MOODLE](docs/learn/14-moodle_id.md)
+    * [Build README from test](docs/learn/15-readme.md)
+    * [INCLUDE more configuration files](docs/learn/16-include.md)
+    * [ALIAS](docs/learn/17-alias.md)
+    * [LOG messages](docs/learn/18-log.md)
+    * [Don't get params, just read vars](docs/learn/19-read_vars.md)
+    * [MACROS](docs/learn/20-macros.md)
+    * [Checking exit codes](docs/learn/21-exit_codes.md)
+    * [RESULT object](docs/learn/22-result.md)
+    * [How to test code](docs/learn/23-test-code.md)
+    * [How to test SQL and database](docs/learn/24-test-sql.md)
+    * [expect vs result](docs/learn/25-expect-result.md) TODO
+    * [EXPECT_SEQUENCE](docs/learn/26-expect_sequence.md)
+    * [RUN_SCRIPT](docs/learn/27-run_script.md)
+    * [UPLOAD](docs/learn/28-upload.md)
+4. [Configuration file](docs/config_file.md): Reserved params, configure hosts, etc.
+5. [Language reference](docs/dsl/README.md). DSL used to define tests.
+    * [expect](docs/dsl/expect.md): check run output with expectations.
+    * [export](docs/dsl/export.md): save evaluation reports.
+    * [get](docs/dsl/get.md): read config params.
+    * [group](docs/dsl/group.md): group targets.
+    * [play](docs/dsl/play.md): starts main execution.
+    * [result](docs/dsl/result.md): contains run output.
+    * [run](docs/dsl/run.md): execute command on local/remote host.
+    * [send](docs/dsl/send.md): send reports into remote machines.
+    * [set](docs/dsl/set.md): write new param.
+    * [show](docs/dsl/show.md): show progress on screen.
+    * [target](docs/dsl/target.md): define new target.
+6. [Modes of use](docs/modes_of_use.md): Classroom, contest, standalone.
+7. [More information](docs/more.md)
 
 # Contact
 

data/docs/devel/contribute.md

@@ -0,0 +1,52 @@
+[<< back](../../README.md)
+
+# Contributing
+
+List of things to do, classified into 3 sections:
+* (A) I know read and write.
+* (B) I work as IT teacher
+* (C) I want to program using Ruby language
+
+> I write this list without any criteria.
+> Only an unordered list of interesting/usefull things to be done.
+
+## Section A
+
+Documentation
+
+* Revise documentation.
+* Make videos showing how to use this tool
+    * Video about download and install this tool
+    * Test installation scripts
+    * Vídeo with Windows installation.
+    * Video using examples 01 to 05...
+* Write a special documentation for novice
+
+## Section B
+
+* Create your own (simple or complex) teuton tests.
+* Upload your own tests to github.com/teuton-software/challenge repository.
+* Make videos showing how to create our own tests and run it on VMs.
+
+## Section C
+
+Contact with us to help develop this tool.
+
+1. Make sure you have Ruby installed
+1. Fork it and clone it
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+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 or suggestions.
+
+**Development environment installation**
+
+* git clone REPO
+* install ruby-dev or ruby-devel 
+    * debian => sudo apt install ruby-dev build-essential
+    * debian => ssh make gcc ruby-devel
+* gem install bundler
+* bundle install
+* rake

data/docs/devel/todo.md

@@ -0,0 +1,218 @@
+[<< back](../../README.md)
+
+# Roadmap Teuton v3.0.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.
+* Eliminar/limpiar toda referencia a Vagrant.
+* 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**:
+    * Doc ngrok use. Use cases and tutorial
+    * Doc host1_route combined with ngrok
+* **PENSAR**: Script to set **static IP**
+
+# 3. Features
+
+## 3.1. teuton readme -> teuton doc
+
+* Renombrar "teuton readme" por "teuton doc".
+    * Modificar código, documentación y los ejemplos
+    * Modificar los ejemplos de dvarrui/teuton-tests
+* Añadir opciones de lenguaje a `teuton doc`.
+    * Por defecto se usará `--lang=en`.
+    * Pero poder especificar el idioma usando el paráemetro `lang`. Por ejemplo :`teuton doc --lang=es`
+
+## 3.2. Feature: export stats on resume
+
+Ampliar las estadísticas de salida en el report `resume`:
+* Improve RESUME report or create stat-report, with stat information.
+* the worst target/task/case,
+* the best target/task/case,
+* the slowest target/task/case,
+* the fastest target/task/case, etc.
+* Related targets: group of targets that always have the same state in every case.
+
+## 3.3. Feature: Eventos
+
+Nueva feature "eventos".
+
+* La idea está documentada mejor en el enlace siguiente.
+* [Propuesta](https://github.com/dvarrui/teuton-book/blob/main/docs/03.eventos/index.md)
+
+Idea antigua: `ensure`
+
+* ensure: es como un target pero que no puntua
+* Puede puntuar 0, poner grade a 0, dejar un log y terminar
+* Puede puntuar 0 y dejar un log
+* Puede puntuar negativo y dejar un log
+* para controlar los hacking de los alias/fake scripts
+
+## 3.4. Feature: libs vs macros
+
+libs/module
+
+* Cambiar las macros por lib/modules
+* Permitir crear librerías reutilizables
+* bloques "TRE" target/run/expect
+* Conjuntos de bloques <TRE>
+* cualquier lógica reutilizable
+
+## 3.5 Integración con contenedores
+
+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
+
+Host definition example:
+
+```
+  host1_ip:
+  host1_port:
+  host1_username:
+  host1_password:
+
+  host1_docker_image: "debian:latest"
+  host1_docker_name (default value) -> "testname_hostname_case01" as dockername
+  host1_docker_preffix: (Code added to docker name) "idp" -> "idp_hostname_case01"
+
+  host1_docker_vol_rw: "_, _, _"
+  host1_docker_vol_ro: "_, _, _"
+```
+
+* Folders to mount docker volumes
+  Create temp folders for every case/host.
+  but... When create theses folders?
+  (1) While running? This may be done automaticaly at running first step
+      It's easy but temp folders that not exists before running test
+  (2) Before run?    New command as: "teuton create-temp" TESTNAME
+      It's usefull if we need to put files into temp folders (volumes)
+      before running test.
+
+```
+var
+└── test_1
+    └── tmp
+        ├── case01
+        │   ├── host1
+        │   └── host2
+        ├── case02
+        │   ├── host1
+        │   └── host2
+        └── case03
+            ├── host1
+            └── host2
+```
+
+## 3.6 SEND email
+
+* `send :email_to => :members_emails`... esto requiere que cada caso tenga un email y que además el profesor tenga configurado el acceso a su cuenta de correo... para poder enviar copias de los informes....
+
+## 3.7 varios
+
+* **HELP**. When students demand help they could recibe some advises. More ideas: bonus, lives, etc.
+
+# 4. Refactor internal code
+
+## 4.1. Host object
+
+* Host object so "host(:debian)" return a Host object so
+
+```
+   h = host(:debian)
+   h.ip -> get(:debian_ip)
+   h.username -> get(:debian_username)
+   h.password -> get(:debian_password)
+   h.port
+   h.route
+   h.protocol
+```
+
+## 4.2 Cambios internos
+
+* Default port values ssh/telnet and default username values (root, Administrator)
+* `expect_equal "camaleon"`, same as `expect result.equal "camaleon"`.
+* RENAME
+    * Laboratory to Checker
+    * Add tt_label as alias of tt_members
+* 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
+
+* Save case state or progress. var/tesname/states.db ¿?
+* save partial grades. Before play challenge read previous moodle.cvs.
+* Then play challenge and when creates new moodle.csv... we could preseve old cases(grades) 100% for example.
+* Create 2 evaluation modes:
+    1. Evaluate targets (current mode): `start eval: :targets`
+    1. Evaluate task: `start eval: :groups` and perhaps add group weight?
+    1. config file with `tt_eval: groups`
+
+## 4.4 varios
+
+* Implement "scp" over Telnet ¿?
+* Use travis???
+* **FEATURE - EXPORT**. Sign reports generated with GPG... just to verify autenticity if needed.
+* **PENSAR**: Change export to show full command output into reports.   
+* Propuestas de sdelquin
+    * Tablas "bonitas" en terminal → https://github.com/piotrmurach/tty-markdown#17-table
+    * Documentación en https://readthedocs.org/ ??
+* FEATURE: Auto Parse new input format, and detect parse errors
+
+# 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
+
+* 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.
+* Pero si podemos aprovechar y crear una" librería " de los módulos más frecuentes?!... una ayuda para facilitar la creación de test... esto se puede emparejar con el editor de test...

data/docs/dsl/expect.md

@@ -97,8 +97,10 @@ run    'cat /etc/passwd'
 
 Then we can check result with:
 
-* **expect result.find(/obiwan|kenobi/).count.eq(1)**, expect there exists only 1 line with "obiwan" or "kenobi".
-* **expect result.find(/darth/).find(/vader/).count.gt(2)**, expect there exists more than 2 lines with texts "darth" and "vader".
-* **expect result.not_find('#').find('yoda').count.lt(3)**, expects there exists less than 3 lines with text "yoda" and without "#" symbol.
+```ruby
+expect result.find(/obiwan|kenobi/).count.eq(1)       # only 1 line with "obiwan" or "kenobi".
+expect result.find(/darth/).find(/vader/).count.gt(2) # more than 2 lines with texts "darth" and "vader".
+expect result.not_find('#').find('yoda').count.lt(3)  # less than 3 lines with text "yoda" and without "#" symbol.
+```
 
 Read more about [result](result.md) object.

data/docs/{videos.md → more.md}

@@ -4,6 +4,8 @@
 
 * ES - [Introducción a Teuton](https://elpuig.xeill.net/Members/vcarceler/articulos/introduccion-a-teuton): iniciarse en el uso de Teutón gracias al fantástico artículo de Víctor Carceler.
 * ES - [Verificar prácticas de GNS3 con Teuton](https://elpuig.xeill.net/Members/juanmorote/articulos/verificar-practicas-de-gns3-con-teuton): GNS3 es un excelente simulador de red Open Source que además se entiende con Teuton a las mil maravillas.
+* ES - [teuton-book](https://github.com/dvarrui/teuton-book): Documentación y tutoriales sobre Teuton en español.
+* Mores examples at [teuton-tests](https://github.com/dvarrui/teuton-tests) GitHub repository.
 
 # Videos
 

data/lib/teuton/report/formatter/base_formatter.rb

@@ -30,7 +30,7 @@ class BaseFormatter
 
   def trim(input)
     output = input.to_s
-    output = "...#{input[input.size - 50, input.size]}" if output.size > 65
+    output = "...#{input[-50, input.size]}" if output.size > 65
     output.to_s
   end
 end

data/lib/teuton/version.rb

@@ -1,5 +1,5 @@
 module Teuton
-  VERSION = "2.11.0"
+  VERSION = "3.0.1"
   APPNAME = "teuton"
   GEMNAME = "teuton"
   DOCKERNAME = "dvarrui/#{GEMNAME}"

data/lib/teuton.rb

@@ -42,9 +42,9 @@ module Teuton
     require_relative dslpath
     begin
       require_relative Project.value[:script_path]
-    rescue => e
-      warn Rainbow.new("[ERROR] require_dsl_and_script: <#{e}>").bright.red
-      warn Rainbow.new("[ERROR] Reading file #{Project.value[:script_path]}").bright.red
+    rescue StandardError => e
+      warn Rainbow("[ERROR] require_dsl_and_script: <#{e}>").bright.red
+      warn Rainbow("[ERROR] Reading file #{Project.value[:script_path]}").bright.red
       exit 1
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 3.0.1
 platform: ruby
 authors:
 - David Vargas Ruiz
@@ -131,9 +131,9 @@ extra_rdoc_files:
 - docs/commands/readme.md
 - docs/commands/run.md
 - docs/config_file.md
-- docs/devel/README.md
-- docs/devel/contributions.md
+- docs/devel/contribute.md
 - docs/devel/diagram.md
+- docs/devel/todo.md
 - docs/dsl/README.md
 - docs/dsl/expect.md
 - docs/dsl/export.md
@@ -183,8 +183,8 @@ extra_rdoc_files:
 - docs/learn/28-upload.md
 - docs/learn/README.md
 - docs/modes_of_use.md
+- docs/more.md
 - docs/tutorial/es/nginx/README.md
-- docs/videos.md
 files:
 - LICENSE
 - README.md
@@ -197,9 +197,9 @@ files:
 - docs/commands/readme.md
 - docs/commands/run.md
 - docs/config_file.md
-- docs/devel/README.md
-- docs/devel/contributions.md
+- docs/devel/contribute.md
 - docs/devel/diagram.md
+- docs/devel/todo.md
 - docs/dsl/README.md
 - docs/dsl/expect.md
 - docs/dsl/export.md
@@ -249,8 +249,8 @@ files:
 - docs/learn/28-upload.md
 - docs/learn/README.md
 - docs/modes_of_use.md
+- docs/more.md
 - docs/tutorial/es/nginx/README.md
-- docs/videos.md
 - lib/teuton.rb
 - lib/teuton/case/builtin/main.rb
 - lib/teuton/case/builtin/package.rb
@@ -349,7 +349,7 @@ files:
 - lib/teuton/version.rb
 homepage: https://github.com/teuton-software/teuton
 licenses:
-- GPL-3.0
+- MPL-2.0
 metadata: {}
 rdoc_options: []
 require_paths:
@@ -365,7 +365,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Teuton (Infrastructure test)
 test_files: []

data/docs/devel/README.md

@@ -1,12 +0,0 @@
-
-Development process:
-
-Process
-git clone REPO
-install ruby-dev or ruby-devel 
-debian => sudo apt install ruby-dev build-essential
-debian => ssh make gcc ruby-devel
-
-gem install bundler
-bundle install
-rake

data/docs/devel/contributions.md

@@ -1,32 +0,0 @@
-
-# TO-DO list
-
-List of things to do, classified into 3 sections:
-* (A) I know read and write.
-* (B) I work as IT teacher
-* (C) I want to program ruby language
-
-> I write this list without any criteria.
-> Only an unordered list of interesting/usefull things to be done.
-
-## Section A
-
-Documentation
-
-* Revise documentation.
-* Make videos showing how to use this tool
-    * Video about download and install this tool
-    * Test installation scripts
-    * Vídeo with Windows installation.
-    * Video using examples 01 to 05...
-* Write a special documentation for novice
-
-## Section B
-
-* Create your own (simple or complex) teuton tests.
-* Upload your own tests to github.com/teuton-software/challenge repository.
-
-## Section C
-
-* Contact with us to help develop this tool :-)
-