teuton 2.1.11 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44f3001566143676b26e8158eea1da85634bd99235f5bb2c3945b55be7196785
-  data.tar.gz: ab250c0be8fe812a5abd50907d5dc92480d8e17925655ddc69754d93ec8968ec
+  metadata.gz: 2b14a9488a679177c5382dca457d85466a13d1544f9e50c1083de3809f3390c2
+  data.tar.gz: fe58ec9659005f4c441f0bb4872ce4e5421255ebf159d652de2be8e800c27286
 SHA512:
-  metadata.gz: 32a509c81ccdcdfb097cc20f7edabbecdc21508d1983715b9ba1281624b803c8adc543aa0684706a3a43ab833d6d3cbeb02a75bc01870dce26c5b03c63f3a578
-  data.tar.gz: 824cba77a3d8b82e43c74c3750247de3d86e831dfdd90a807145ce1ab4447f0c469a20aca84f632aaed2b1f47f638462c61a1efa7cc67072482f965599a4cdc5
+  metadata.gz: 06cd14d16baefa8894b334aaa33babbe56b2539a1e3e3bebfb88a449c9b5ba3eb471b9e418a466e228c4ee64c9e98dbda66080ff219a90d18fc77bd41105eb85
+  data.tar.gz: 395e8d2eb623ff313b7ecb40c57efd4402c087ecbadaf45dc1b749d22d5a9f46b11018e43f1a31507460cd66c9b2b24684890e6c08162db332689713e8cfa14d

data/README.md

@@ -1,7 +1,9 @@
 
 [![Gem Version](https://badge.fury.io/rb/teuton.svg)](https://badge.fury.io/rb/teuton)
+![GitHub](https://img.shields.io/github/license/dvarrui/teuton)
+![Gem](https://img.shields.io/gem/dv/teuton/2.2.2)
 
-# TEUTON (version 2.1)
+# TEUTON
 
 _Create Unit Test for your machines, and
 test your infraestructure as code._
@@ -9,26 +11,27 @@ test your infraestructure as code._
 ![logo](./docs/images/logo.png)
 
 Teuton is an intrastructure test tool, useful for:
-* Sysadmin teachers to evaluate students remote machines.
-* Sysadmin apprentices to evaluate their learning process as a game.
-* Professional sysadmin to monitor remote machines.
+* 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.
 
 Teuton allow us:
-* Write test units for real or virtual machines using simple DSL.
-* Check compliance with requirements on remote machines.
+* Write unit tests for real or virtual devices, using simple DSL.
+* Check compliance with requirements on local or remote devices.
 
 # Documentation
 
-* [Installation](https://github.com/teuton-software/teuton/tree/devel/docs/install/README.md)
+* [Installation](https://github.com/teuton-software/teuton/tree/master/docs/install/README.md)
     1. Install Ruby on your system.
-    1. `gem install teuton`
-* [Learning](https://github.com/teuton-software/teuton/tree/devel/docs/learn/README.md)
-* [Commands](https://github.com/teuton-software/teuton/tree/devel/docs/commands/README.md)
-* [Teuton language](https://github.com/teuton-software/teuton/tree/devel/docs/dsl/README.md)
+    1. `gem install teuton`, to install Teuton.
+* [Videos, blogs, news](docs/videos.md)
+* [Learning](docs/learn/README.md)
+* [Commands](docs/commands/README.md)
+* [Teuton language](docs/dsl/README.md)
 
 # Features
 
-* [Free Software License](https://github.com/teuton-software/teuton/tree/devel/LICENSE).
+* [Free Software License](LICENSE).
 * Multiplatform.
 * Remote machines only require SSH or Telnet service installed.
 * Developed using ruby language.

data/bin/check_teuton

@@ -11,8 +11,6 @@ module CheckTeuton
     run(arg)
   end
 
-  ##
-  # Show help
   def self.show_help()
     puts "check_teuton"
     puts "  help              => Show this help"

data/docs/changelog/ideas.md

@@ -0,0 +1,132 @@
+
+# Ideas
+
+Esta es una lista de ideas para que no se me olvide... lo podemos ir ajustando 😊
+
+1. REPOSITORIOS: teutonget in process
+
+2. TEST-EN-CADENA (smart-shell): es un proyecto en curso que trabajará en colaboración ceon teuton. Detecta las acciones del usuario dentro de la shell y automáticamente lanza el test para validar el cumplimiento de los objetivos. Si se supera un % se pasa al siguiente test.
+
+3. SERVIDOR TEUTON: Teuton web para recibir peticiones de los clientes... ?! Enganchar con teuton-server y teuton-client
+NO. quizás mejor enfoque. Tener un servidor dedicado con una página Web para lanzar test desde el propio servidor.
+
+4. Editor de ficheros de configuración.... una especie de asistente de ayuda..
+no le veo mucho sentido tener un editor específico pero si al ejecutar un reto
+si hay valores con NODATA... entonces que pregunte al usuario y complete la
+configuración sobre la marcha???
+
+5. 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...
+
+6. `result.test("...")`
+7. `send :email_to => :members_emails`
+
+8. Empaquetar tests para facilitar su movilidad . Esto se combina muy bien con la opción de búsqueda de retos.... pensar en firma gpg o md5 de comprobación etc..  
+Al ejecutar un test poder hacerlo "teuton run PATH/TO/FILE.zip"
+
+
+# Gamification ideas
+
+* When students demand help they could recibe some advises.
+* Define a loop of executions of our activity. For example:
+  every 5 minutes, run the activity, and repeat this 10 times.
+  `start :times=>10, :duration=>5 do`      
+* More ideas: bonus, lives, etc.
+
+# Ideas para QA
+
+* actualizar las pruebas con vagrant para la versión actual. Mejora de la calidad del código.
+
+# Ideas para PROMOCIONAR
+
+* Documentar y hacer videos.
+* Tener foros de la comunidad o presencia en reddit o stackoverflow.... o algo parecido???
+
+Create 2 evaluation modes:
+1. Evaluate targets (current mode): `start :score=>:targets do ...`
+1. Evaluate task: `start :score=>:tasks do ...`
+
+
+## Pending
+
+### moodle.csv and 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.
+
+### expect keyword
+
+* `expect_equal "camaleon"`, same as `expect result.equal "camaleon"`.
+* `expect_not_equal "lagarto"`, same as not expect equal.
+* `expect regexp("val1|var2")`, regexp function creates regular expresion from String.
+* `expect result.ok?`, result from previous goto exec.
+* `result.exit_code`, exit code from previous goto exec.
+
+
+* Review docs and replace `"id #{get(:username)}"` by something line `"id "+get(:username)`.
+
+### Reports and export keyword
+
+* Work on more output formats: CSV, HTML, XML.
+    * `export :format=>:html, :prefix => IAN`
+    * `export :format=>:xml, :prefix => IAN`
+    * `export :format=>:csv, :prefix => IAN`
+* 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.
+
+### File extension
+
+* Change ".rb" file extension by ".tt" for example. To avoid users think on ruby when using teuton files.
+* So move "ruby language" documentation to other section like "expert mode"...
+* Change "start.rb" or "play.rb" name to "run.tt".
+
+### loop keyword
+
+* Create keyword to do loops without using ruby style:
+```
+loop i: 1..5 do
+ puts i
+end
+
+loop :a => [3,5,7] do
+  puts a
+end
+```
+
+### Feedback
+
+Add new features to DSL
+* `feedback or advise "Some usefull information"` provide this information when studends demand help.
+## Working
+
+### Remote temp folder
+
+Modify send keyword so it could works with all OS. Now only work with GNU/Linux. So we need to detect remote OS, then choose remote teuton folder where uploading files.
+
+* First goto open new session to remote host. And then:
+    1. Detect remote OSTYPE: (a) GNU/Linux and MAC using "uname -a", (b) Windows using "ver" command.
+    2. Create teuton remote uploading folder: (a) /tmp/teuton for GNU/Linux and MAC, (b) %windir%/temp/teuton for Windows.
+* Every time we send files to remote host we will use this remote folder.
+
+### Readme
+
+* Pass usefull information into README.md:
+```
+readme do
+  title ...
+  intro ...
+  author ...
+  requirements ...
+  tags ...
+end
+```
+
+---
+....
+
+* config -> host_port
+* teuton run into
+* resume.html
+* txt format -> remove conn_errors when errors = 0

data/docs/changelog/v2.1.md

@@ -1,9 +1,7 @@
 
 # CHANGELOG teuton v 2.1
 
-## Done
-
-### 1. Export grades on csv file using Moodle format
+# 1. Export grades on csv file using Moodle format
 
 * Automaticaly exports `moodle.csv` file with all cases grades, using adecuate format so it could be imported directly into Moodle platform.
 * We need to configure some params like this:
@@ -16,7 +14,7 @@
   :tt_moodle_id: User Moodle Identity
 ```
 
-### 2. readme keyword
+# 2. readme keyword
 
 We currently use the "teuton readme pry-folder" command to export README file from the challenge.
 
@@ -32,130 +30,24 @@ group "GROUPNAME" do
   expec_one 'root'
 ```
 
----
-
-## Working
-
-### Remote temp folder
-
-Modify send keyword so it could works with all OS. Now only work with GNU/Linux. So we need to detect remote OS, then choose remote teuton folder where uploading files.
-
-* First goto open new session to remote host. And then:
-    1. Detect remote OSTYPE: (a) GNU/Linux and MAC using "uname -a", (b) Windows using "ver" command.
-    2. Create teuton remote uploading folder: (a) /tmp/teuton for GNU/Linux and MAC, (b) %windir%/temp/teuton for Windows.
-* Every time we send files to remote host we will use this remote folder.
+# 3. Installation process
 
-### Readme
-
-* Pass usefull information into README.md:
-```
-readme do
-  title ...
-  intro ...
-  author ...
-  requirements ...
-  tags ...
-end
-```
-
----
-
-## Pending
-
-### moodle.csv and 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.
-
-### expect keyword
-
-* `expect_equal "camaleon"`, same as `expect result.equal "camaleon"`.
-* `expect_not_equal "lagarto"`, same as not expect equal.
-* `expect regexp("val1|var2")`, regexp function creates regular expresion from String.
-* `expect result.ok?`, result from previous goto exec.
-* `result.exit_code`, exit code from previous goto exec.
-
-### get keyword simplification
-
-* Simplify getting and setting params process. For example: `_username`, may be alias for `get(:username)`. Then
-
-```
-target "Create user _username"
-goto :host1, :exec => "id _username"
-expect_one _username
-```
-Same as
-```
-target "Create user "+get(:username)
-goto :host1, :exec => "id "+get(:username)
-expect_one get(:username)
-```
-
-* Review docs and replace `"id #{get(:username)}"` by something line `"id "+get(:username)`.
-
-### Reports and export keyword
-
-* Work on more output formats: CSV, HTML, XML.
-    * `export :format=>:html, :prefix => IAN`
-    * `export :format=>:xml, :prefix => IAN`
-    * `export :format=>:csv, :prefix => IAN`
-* 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.
-
-### File extension
-
-* Change ".rb" file extension by ".tt" for example. To avoid users think on ruby when using teuton files.
-* So move "ruby language" documentation to other section like "expert mode"...
-* Change "start,rb" or "play.rb" name to "run.tt".
-
-### loop keyword
-
-* Create keyword to do loops without using ruby style:
-```
-loop i: 1..5 do
- puts i
-end
-
-loop :a => [3,5,7] do
-  puts a
-end
-```
-
-### Teuton web server
-
-* It coud be posible read students credential directly from config.yaml information..
-
-### Feedback
-
-Add new features to DSL
-* `feedback or advise "Some usefull information"` provide this information when studends demand help.
-
-### Installation process
 * Use Bundler to install gems instead of rake.
 * It will be usefull use sysadming-game as gem? And install it with `gem install teuton`.
 * Vagrant: test how to use vagrant machines as case hosts.
 
----
-Info sobre novedades de la versión 2.1
+# 4. Info sobre novedades de la versión 2.1
+
 1. Teuton readme y dsl readme
 2. Macros de define macro
 3. Export yaml y html
 4. Teuton --no-color
-5 teuton run --case
-6 teuton run --cname
-7 teuton run --cpath
-8 actualizar formatos de salida
-9 instalación mediante gemas
-10 teuton panel
-11 teuton client y server
-12 nuevos nombres de comandos...
-13 cambio de goto a run
-....
-
-* config -> host_port
-* teuton run into
-* resume.html
-* txt format -> remove conn_errors when errors = 0
+5. teuton run --case
+6. teuton run --cname
+7. teuton run --cpath
+8. actualizar formatos de salida
+9. instalación mediante gemas
+10. teuton panel
+11. teuton client y server
+12. nuevos nombres de comandos...
+13. cambio de goto a run

data/docs/changelog/v2.2.md

@@ -1,29 +1,53 @@
 
-Para la 2.2 entonces:
-1. Metadatis con tags y búsqueda. Facilitar a los usuarios encontrar retos.
-2. Teuton run con estado para la corrección progresiva. Esto da juego a diferentes formas de usar la herramienta. 
-3. Teuton web para recibir peticiones de los clientes... ?!
-4. Editor de ficheros de configuración.... una especie de asistente de ayuda..  
-5. Editor de tests ?! .... lo veo complejo... a menos que se empiece por una versión simplificada.. 
-6. Empaquetar tests para facilitar su movilidad . Esto se combina muy bien con la opción de búsqueda de retos.... pensar en firma gpg o md5 de comprobación etc..  
-7  crear una" librería " de las macros más frecuentes?!... una ayuda para facilitar la creación de test... esto se puede emparejar con el editor de test... 
-8 actualizar las pruebas con vagrant para la versión actual. Mejora de la calidad del código. 
-9. Documentar y hacer videos. 
-10. Tener foros de la comunidad o presencia en reddit o stackoverflow.... o algo parecido???
-...
-Esta es una lista de ideas para la versión 2.2 y que no se me olvide... lo podemos ir ajustando 😊
-
-
-* `result.test("...")`
-* `send :email_to => :members_emails`
-
-Gamification
-* When students demand help they could recibe some advises.
-* Define a loop of executions of our activity. For example:
-  every 5 minutes, run the activity, and repeat this 10 times.
-  `start :times=>10, :duration=>5 do`      
-* More ideas: bonus, lives, etc.
-
-Create 2 evaluation modes:
-1. Evaluate targets (current mode): `start :score=>:targets do ...`
-1. Evaluate task: `start :score=>:tasks do ...`
+# Teuton (version 2.2)
+
+## New features
+
+* Let's see new features examples:
+    * 10 result and moodle_id
+    * 11 get_vars
+    * 12 alias
+    * 13 include (tt_include config param)
+    * 14 macros
+
+**Configuration file**
+
+* Por defecto los valores de clave de los ficheros de configuración serán Strings en lugar de símbolos, aunque lo símbolos seguirán funcionando.
+
+**get_vars: To think - We are not sure about this***
+
+* "get" keyword simplification: Simplify getting and setting params process. For example: `_username_`, may be alias for `get(:username)`. Then
+
+```
+target "Create user #{_username_}"
+run "id #{_username_}"
+expect_one _username_
+```
+Same as
+
+```
+target "Create user "+get(:username)
+run "id " + get(:username)
+expect_one get(:username)
+```
+
+* Promocinar el proyecto:
+    * Documentar y hacer videos.
+    * Charlas y talleres
+
+## Fixed
+
+* Solucionar fallo en --cname
+* Revisar doc options como cpanel
+
+## TODO
+
+**Documentation**
+
+* Doc learn 10,11, 12,13 y 14
+* 10 result and moodle_id
+* 11 get_vars
+* 12 alias
+* 13 include
+* 14 macro
+* Doc tt_include

data/docs/changelog/version2.1.md

@@ -0,0 +1,4 @@
+
+# TEUTON (version 2.1)
+
+Goto to [version 2.1](https://github.com/teuton-software/teuton/tree/devel).

data/docs/commands/README.md

@@ -3,14 +3,11 @@
 # Commands
 
 Available command functions:
-1. Show help
-2. Show version
-3. Create new test skeleton
-4. Check teuton test
-5. Run teuton test
-    * Running Teuton test
-    * Command options
-    * Choosing other config file name
+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)
 
 # 1. Show help
 
@@ -34,6 +31,11 @@ Commands:
 
 ```
 
+Alias:
+* `teuton h`
+* `teuton -h`
+* `teuton --help`
+
 # 2. Show version
 
 Usage:
@@ -46,7 +48,7 @@ Example:
 
 ```bash
 $ teuton version                               
-teuton (version 2.1.9)
+teuton (version 2.2.0)
 ```
 
 Alias:
@@ -54,7 +56,7 @@ Alias:
 * `teuton -v`
 * `teuton --version`
 
-# 3. Create new test skeleton
+# 3. Create new test
 
 Usage:
 
@@ -62,6 +64,8 @@ Usage:
 teuton new foo
 ```
 
+Description: Create teuton test skeleton.
+
 Example:
 
 ```bash
@@ -71,7 +75,6 @@ Example:
 * Create dir        => foo
 * Create file       => foo/config.yaml
 * Create file       => foo/start.rb
-* Create file       => foo/.gitignore
 ```
 
 This command will create the next structure:
@@ -81,9 +84,13 @@ This command will create the next structure:
 | foo             | Base directory |
 | foo/start.rb    | Main Script    |
 | foo/config.yaml | YAML configuration file |
-| foo/.gitignore  | By default, ignore YAML files to be upload on git repository |
 
-# 5. Check teuton test
+Alias:
+* `teuton n foo`
+* `teuton -n foo`
+* `teuton --new foo`
+
+# 4. Check teuton test
 
 Usage:
 
@@ -91,11 +98,23 @@ Usage:
 teuton check DIRPATH
 ```
 
-Description: this command check teuton test source files,located into DIRPATH folder.
+Description: this command check teuton test and config files located into DIRPATH folder.
 
 [Example](example_check.md)
 
-# 4. Run teuton test
+| Command                      | Description |
+| ---------------------------- | ----------- |
+| teuton check path/to/dir/foo | Test content of start.rb and config.yaml files. |
+| teuton check path/to/dir/foo --cname=demo | Test content of start.rb and demo.yaml files. |
+| 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:
+* `teuton c foo`
+* `teuton -c foo`
+* `teuton --check foo`
+
+# 5. Run teuton test
 
 Usage:
 
@@ -106,3 +125,27 @@ teuton run DIRPATH
 Description: this command run teuton test located into DIRPATH folder.
 
 [Example](example_run.md)
+
+Alias:
+* `teuton foo`
+
+# 6. Show README
+
+Usage:
+
+```bash
+teuton readme DIRPATH
+```
+
+Description:
+
+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.
+
+The teacher could write this information or may use this command to generate automaticaly.
+
+Alias:
+* `teuton r DIRPATH`
+* `teuton -r DIRPATH`
+* `teuton --readme DIRPATH`

data/docs/commands/example_check.md

@@ -14,10 +14,6 @@ Example:
 
 ```bash
 > teuton check examples/learn-01-target
-[INFO] ScriptPath => examples/learn-01-target/start.rb
-[INFO] ConfigPath => examples/learn-01-target/config.yaml
-[INFO] Pwd        => /mnt/home/leap/proy/repos/teuton.d/teuton
-[INFO] TestName   => learn-01-target
 
 +----------------------------+
 | GROUP: Learn about targets |

data/docs/commands/example_run.md

@@ -19,10 +19,6 @@ Example:
 
 ```bash
 > teuton run examples/learn-01-target
-[INFO] ScriptPath => examples/learn-01-target/start.rb
-[INFO] ConfigPath => examples/learn-01-target/config.yaml
-[INFO] Pwd        => /mnt/home/leap/proy/repos/teuton.d/teuton
-[INFO] TestName   => learn-01-target
 
 ==================================
 Executing [teuton] (version 2.1.9)

data/docs/dsl/README.md

@@ -18,7 +18,7 @@ These are the main DSL key words, usefull to define items to be evaluated.
 | [target](definition/target.md) | Define a target. This is the item to be checked. |
 | Remote [run](definition/run_remote.md)| Execute command into remote host. |
 | Local [run](definition/run_local.md)  | Execute command into local host. |
-| [result](definition/result.md) | Contain the output of previous `goto` order. |
+| [result](definition/result.md) | Contain the output of previous `run` order. |
 | [expect](definition/expect.md) | Check the obtained result with the expected value. |
 
 ## Execution instructions

data/docs/dsl/definition/result.md

@@ -81,6 +81,7 @@ result.grep_v("nologin").grep("/bin/bash").count.gt 0
 
 | Function             | Description |
 | -------------------- | --------------------------------- |
+| `result.exitstatus`  | Return exit code from the last command executed by run statement |
 | `result.value`       | Return first output line or value |
 | `result.content`     | Return all output lines         |
 | `result.alterations` | Return transformations applied to the output |

data/docs/dsl/definition/run_remote.md

@@ -50,9 +50,11 @@ goto :localhost, :execute => "id yoda"
 
 **SSH connection**
 
-Invoking `run` or `goto` sentence, Teuton opens SSH remote session by default. This config files examples do the same:
+Invoking `run` sentence, will open SSH session with remote host by default.
+This config files examples do the same:
+
+Sample 1. By default, SSH connection is established with remote host:
 
-Sample 1:
 ```
 ---
 :config:
@@ -65,7 +67,8 @@ Sample 1:
   :host1_password: secret
 ```
 
-Sample 2:
+Sample 2. `host1_protocol: ssh` force SSH connection with remote host:
+
 ```
 ---
 :config:
@@ -81,7 +84,8 @@ Sample 2:
 
 **Telnet connection**: Open Telnet remote session.
 
-For example:
+`host1_protocol: telnet` force Telnet connection with remote host:
+
 ```
 ---
 :global:
@@ -93,7 +97,9 @@ For example:
   :host1_protocol: telnet
 ```
 
-**Localhost**: When hostname is localhost, or host IP is 127.0.0.X, then Teuton will assume that you want to run your command on local system, and no session is opened. This examples are the same:
+**Localhost**: When hostname value is "localhost", or host IP is "127.0.0.X", then
+Teuton will assume that you want to run your command on local system, and no remote session is opened.
+This examples are the same:
 
 ```
 run "id david"
@@ -105,7 +111,7 @@ And
 goto :localhost, :exec => "id david"
 ```
 
-**SSH to localhost**: Force SSH session to localhost, then:
+**SSH to localhost**: Force SSH session to localhost:
 
 ```
 ---