teuton 2.3.11 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a921e5d61265422dfdf27ffdc1f7416969252618b771abae1532d23d106d1fe4
-  data.tar.gz: 21464a12017ae54c3aaefc4330bba347a6c1b9912a192df0235b8200da3e8679
+  metadata.gz: 4abcfe5aee651ce09c17012de250c39c6286b3d11ba00462f6ab285224d65d49
+  data.tar.gz: 1158d3a447ad5c0a9c8b2cc7e524fa8c235d00492243f6959be890c379c9ea12
 SHA512:
-  metadata.gz: d887d03658989103a24556e46622146fb8e13f4b45a382bd3b99d33c6183990b6a6487dbb5bfd2dbe416babd9e18878e88764c548c054d9fcc02261401694467
-  data.tar.gz: f0968a7a1923dfd70d3d9408f6f3fda267cc71bd51a3ed85629afd2e59cf2b4d272a898fd3c5b3bd7a118eac0cc260b6e3927304899163793a9a0d5a9cfefa41
+  metadata.gz: 3006a5ecbb9b8ee634b62704d80911175c9a02e3e0e2d7388e191071bd27a8accbd89871139252f0e587ead1be3feac6bee7f0e04ba40cb734660173215aa4d9
+  data.tar.gz: 4c47dbe5964231ca099dd530beac2ba4266b085fe8f0c8a93473f4f8089bdede91cbdcf94b6bb463b9f6686b38930de250cba7f478530dd4d47ceee9c5d32c9a

data/README.md

@@ -1,9 +1,9 @@
 
+# TEUTON
+
 [![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.3.10)
-
-# TEUTON
+![Gem](https://img.shields.io/gem/dv/teuton/2.4.0)
 
 _Create Unit Test for your machines. Test your infraestructure as code._
 
@@ -18,23 +18,55 @@ Teuton allow us:
 * Write unit tests for real or virtual devices, using simple DSL.
 * Check compliance with requirements on local or remote devices.
 
-# Documentation
+# Installation
 
-* [Installation](https://github.com/teuton-software/teuton/tree/master/docs/install/README.md)
-    * Install Ruby on your system.
-    * Install Teuton as normal user: `gem install --user-install teuton` (or install as superuser `gem install teuton`).
-* [Blogs and videos](docs/videos.md)
-* [Learning](docs/learn/README.md)
-* [Commands](docs/commands/README.md)
-* [Language reference](docs/dsl/README.md)
+Install Ruby and then:
+
+```console
+gem install teuton
+```
+
+> Install Teuton as normal user: `gem install --user-install teuton`
+
+# Usage
+
+Executing `teuton` command to run example test:
+
+```console
+❯ teuton run examples/01-target
+
+CASE RESULTS
++------+-----------+-------+-------+
+| CASE | MEMBERS   | GRADE | STATE |
+| 01   | anonymous | 100.0 | ✔     |
++------+-----------+-------+-------+
+
+```
 
 # Features
 
 * [Free Software License](LICENSE).
 * Multiplatform.
-* Remote machines only require SSH or Telnet service installed.
-* Developed using ruby language.
+* Remote machines/devices only require SSH or Telnet service installed.
+
+# Documentation
+
+* [Learn](docs/learn/README.md)
+* [Commands](docs/commands/README.md)
+* [Language reference](docs/dsl/README.md)
+* [Installation](docs/install/README.md)
+
+> [Blogs and videos](docs/videos.md)
 
 # Contact
 
 * **Email**: `teuton.software@protonmail.com`
+
+# Contributing
+
+1. Make sure you have Ruby installed
+1. Fork 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.

data/docs/CHANGELOG.md

@@ -6,16 +6,3 @@
 * [version 2.2](changelog/v2.2.md)
 * [version 2.1](changelog/v2.1.md)
 * [version 2.0](changelog/v2.0.md)
-
-## TO-DO
-
-- Teuton readme --lang=es
-
-Revise 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/todo.md

@@ -0,0 +1,26 @@
+
+## TO-DO
+
+New features:
+- Teuton readme --lang=es
+- Export files with other langs
+
+Revise:
+* verify get(:key) and get('key') works fine!
+* Formatter: xml,
+
+Revise documentation:
+* Doc learn 10,11, 12,13 y 14
+* 10 result and moodle_id
+* 12 alias
+* 13 include
+* 14 macro
+* Doc tt_include
+
+Internal changes:
+* Application to Settings
+* Laboratory to Checker
+* Colorize to Rainbow
+* Unify messages ERROR, INFO, WARN. etc
+* Create SendManager as ExportManager?
+* Add tt_label as alias of tt_members

data/docs/changelog/v2.4.md

@@ -2,10 +2,15 @@
 ## [2.4.0]
 
 New features:
+- Hide feedback from reports: `export feedback: false`
 - Add new DSL keyword: expect_last, expect_fisrt
-- New doc and example: learn-15-exit_codes
 - Remove os gem.
 - Change test output colors to green as use others test tools.
+- Change show DSL params. Accepts one param "verbose: NUMBER" to adjust verbosity output level on screen.
+
+New doc and example:
+- 14-alias
+- 16-exit_codes
 
 Bug fixed:
 - All "expect*" keywords must require 2 arguments. The second is optional.
@@ -13,4 +18,3 @@ Bug fixed:
 Revise
 - Remove colors to log text
 - teuton readme: macros, getvars, expect_last, expect_first
-- Formatter: xml, csv, list, etc.

data/docs/dsl/execution/export.md

@@ -23,30 +23,25 @@ Run test and build reports using `html` output format:
 
 ```ruby
 play do
-  export format: :html
+  export format: 'html'
 end
 ```
 
 ## Options
 
-1. **format**: txt, html, yaml. json, colored_text (txt with colors).
-2. **preserve**: true, false.
+1. **format**: txt (default), html, yaml, json, colored_text (txt with colors).
+2. **preserve**: false (default), true.
+3. **feedback**: true (default), false
 
 ## Usage
 
 |    | Command                  | Description |
 | -- | ------------------------ | ----------- |
 | 01 | `export`                 | Export report files using default ouput format |
-| 02 | `export format: :txt` | Export file using TXT ouput format |
-| 03 | `export format: :html` | Export file using HTML ouput format |
-| 04 | `export format: :yaml` | Export file using YAML ouput format |
-| 05 | `export format: :json` | Export file using JSON ouput format |
-| 06 | `export format: :colored_text` | Export file using colored TXT ouput format |
-| 07 | `export preserve: true` | Same as 01 example buy preserving report copies |
-| 08 | `export format: :html, preserve: true` | Same as 03 example but preserving report copies |
-| 09 | `export format: "txt"` | Same as 02 |
-| 10 | `export format: "html"` | Same as 03 |
-| 11 | `export format: "yaml"` | Same as 04 |
-| 12 | `export format: "json"` | Same as 05 |
-| 13 | `export format: "colored_text"` | Same as 06 |
-| 14 | `export format: "html", preserve: true` | Same as 08 |
+| 02 | `export format: 'txt'` or  `export format: :txt` | Export file using TXT ouput format |
+| 03 | `export format: 'html'` or `export format: :html`  | Export file using HTML ouput format |
+| 04 | `export format: 'yaml'` or `export format: :yaml`| Export file using YAML ouput format |
+| 05 | `export format: 'json'` or `export format: :json`| Export file using JSON ouput format |
+| 06 | `export format: 'colored_text'` or  `export format: :colored_text` | Export file using colored TXT ouput format |
+| 07 | `export preserve: true` | Export default format and preserve report copies |
+| 08 | `export format: 'html', preserve: true` or `export format: :html, preserve: true` | Export 'html' format and preserve report copies |

data/docs/dsl/execution/show.md

@@ -6,7 +6,7 @@
 
 ## Description
 
-When tests ends, `show` instruction shows on screen information about final results.
+When all tests are finished, the `show` command displays information on the screen about the final results.
 
 ## Usage
 
@@ -16,11 +16,26 @@ start do
 end
 ```
 
+or
+
+```ruby
+start do
+  show verbose: 1
+end
+```
+
 ## Parameters
 
-| Action         | Description                             |
-| -------------- | --------------------------------------- |
-| `show`         | Same as `show :resume`. Default option. |
-| `show :resume` | Show resumed information on screen.     |
-| `show :cases`  | Show information from every case on screen.|
-| `show :all`    | Same as `show :resume` and `show :details`. |
+| Action               | Description                       |
+| -------------------- | --------------------------------- |
+| `show`               | Same as `show level: 0` (Default) |
+| `show verbose: NUMBER` | NUMBER is the value of the verbose level |
+
+
+| Verbosity level | Description |
+| :-------------: | ----------- |
+| 0               | No output   |
+| 1               | Default output messages |
+| 2               | Show hall of fame |
+| 3               | Show final values |
+| 4               | Show Initial values |

data/docs/ideas/{ideas.md → todo.md}

@@ -3,24 +3,22 @@
 
 Esta es una lista de ideas para que no se me olvide... lo podemos ir ajustando 😊
 
-1. REPOSITORIOS: teutonget in process
+1. 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.
 
-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
+2. 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..
+3. 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...
+4. 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`
+5. `result.test("...")`
+6. `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..  
+7. 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"
 
 
@@ -43,7 +41,7 @@ Al ejecutar un test poder hacerlo "teuton run PATH/TO/FILE.zip"
 
 Create 2 evaluation modes:
 1. Evaluate targets (current mode): `start :score=>:targets do ...`
-1. Evaluate task: `start :score=>:tasks do ...`
+1. Evaluate task: `start :score=>:groups do ...`
 
 
 ## Pending
@@ -60,9 +58,6 @@ Create 2 evaluation modes:
 * `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.
@@ -124,9 +119,6 @@ end
 ```
 
 ---
-....
 
-* config -> host_port
 * teuton run into
-* resume.html
 * txt format -> remove conn_errors when errors = 0

data/docs/install/README.md

@@ -1,44 +1,28 @@
 [<< back](../../README.md)
 
-# Installation
-
-> Definitions:
-> * **T-node**: Host where Teuton software is installed. A T-NODE monitors several S-NODE hosts.
-> * **S-node**: Host where SSH server is installed. This hosts are monitotized by T-NODE host.
->
-> Read [Modes of use](modes_of_use.md) to know about different Teuton ways of using it.
-
-## T-NODE installation
-
-* **Install** Teuton (T-NODE role host):
-    1. Install Ruby on your system.
-    2. `gem install teuton`
-* Run `teuton version` to check the installed version.
-
-> **PROBLEMS**: If you don't find `teuton` command (OpenSUSE distro, for example), try this:
-> * Option A:
->     * `ruby -v`, display your current ruby version. Suppose it is "2.5".
->     * Run `teuton.ruby2.5`, instead of `teuton`.
-> * Option B:
->     * `find /usr/lib64/ruby -name teuton`, to find absolute path to teuton command.
->     * `sudo ln -s /PATH/TO/bin/teuton /usr/local/bin/teuton`, to create symbolic link to teuton command.
-
-* **Update** Teuton with `gem teuton update`.
-* **Uninstall** Teuton with `gem uninstall teuton`.
-
-## S-NODE installation
-
-* **Install** SSH server on every machine with S-NODE role.
-
----
-# Other installation ways
-
-**Scripts**: [Installation using scripts](scripts.md)
-* These scripts run automatical installation for your OS.
-* Choose this way if you don't know how to install Ruby on your system.
-
-**Vagrant or Docker**: [Installation using Vagrant or Docker](vagrant_docker.md)
-* Choose this way if you plan to install Teuton into virtual machines or containers, and you are familiar with Vagrant and Docker technologies.
-
-**Manual**: [Manual installation](manual.md)
-* 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.
+# Installation process
+
+There are 2 types of nodes/hosts:
+
+| 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 |
+
+Read [modes of use](modes_of_use.md) to know more about differents T-NODE/S-NODE schemes.
+
+## Tested OS list
+
+| Type      | O.S.      | Version        | Arch   | T-node | S-node |
+| --------- | --------- | -------------- | ------ | ------ | ------ |
+| GNU/Linux | CentOS    | 7              | x86-64 |        |        |
+|           | Debian    | 9.7.0          | x86-64 | Ok     |        |
+|           | Fedora    | Workstation 29 | x84-64 | Ok     |        |
+|           | LinuxMint | 18.3           | x86-64 | Ok     |        |
+|           | openSUSE  | Leap 15        | x86-64 | Ok     | Ok     |
+|           | Ubuntu    | 18.04          | x86-64 | Ok     | Ok     |
+| Microsoft | Windows   | 7 Enterprise   | x86    | Ok     |        |
+|           | Windows   | 10 Pro         | x86-64 | Ok     | Ok     |
+|           | Windows   | Server 2012 R2 | x86-64 |        |        |
+| Apple     | Mac OS X  | Capitán (10.11.6) | x86-64 | Ok  | Ok     |
+|           | Mac OS X  | Sierra (10.12)    | x86-64 | Ok  |        |

data/docs/install/s-node.md

@@ -0,0 +1,35 @@
+[<< back](README.md)
+
+# S-NODE installation
+
+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**
+
+Run this command as `root` user:
+
+```bash
+wget -qO- https://raw.githubusercontent.com/teuton-software/teuton/master/install/linux/linux_s-node_install.sh | bash
+```
+
+**S-node Windows installation**
+
+Requirements:
+* Windows 7+ / Windows Server 2003+
+* PowerShell v2+
+
+Run this command on **PowerShell (PS)** as `Administrator` user:
+
+```powershell
+Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/teuton-software/teuton/master/install/windows/windows_s-node_install.ps1'))
+```
+
+**S-node Mac OS X installation**
+
+Run this command as `root` user:
+
+```bash
+curl -sL https://raw.githubusercontent.com/teuton-software/teuton/master/install/mac/macosx_s-node_install.sh | bash
+```

data/docs/install/t-node.md

@@ -0,0 +1,76 @@
+[<< back](README.md)
+
+# T-NODE installation
+
+# 1. Recommended
+
+**Installation**
+
+1. Install Ruby on your system.
+2. `gem install teuton`
+
+Run `teuton version` to check the installed version.
+
+**Update**
+
+`gem teuton update`.
+
+**Uninstall**
+
+`gem uninstall teuton`.
+
+# 2. Problems
+
+Don't find `teuton` command (OpenSUSE distro, for example), try this:
+
+Option A:
+* `ruby -v`, display your current ruby version. Suppose it is "2.5".
+* Run `teuton.ruby2.5`, instead of `teuton`.
+
+Option B:
+* `find /usr/lib64/ruby -name teuton`, to find absolute path to teuton command.
+* `sudo ln -s /PATH/TO/bin/teuton /usr/local/bin/teuton`, to create symbolic link to teuton command.
+
+# 3. Installation scripts
+
+If you don't know how to install Ruby on your system, execute this script to run automatical installation for your OS.
+
+**T-node GNU/Linux installation**
+
+Run this command as `root` user:
+
+```bash
+wget -qO- https://raw.githubusercontent.com/teuton-software/teuton/master/install/linux/linux_t-node_install.sh | bash
+```
+
+**T-node Windows installation**
+
+Requirements:
+* Windows 7+ / Windows Server 2003+
+* PowerShell v2+
+
+Run this command on **PowerShell (PS)** as `Administrator` user:
+
+```powershell
+Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/teuton-software/teuton/master/install/windows/windows_t-node_install.ps1'))
+```
+
+**T-node Mac OS X installation**
+
+Run this command as admin user (member of `admin` group):
+
+```bash
+curl -sL https://raw.githubusercontent.com/teuton-software/teuton/master/install/mac/macosx_t-node_install.sh | bash
+```
+
+# 4. Vagrant/Docker
+
+Choose this way if you plan to install Teuton into virtual machines or containers, and you are familiar with Vagrant and Docker technologies.
+
+[Installation using Vagrant or Docker](vagrant_docker.md)
+
+# 5. 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.
+
+[Manual installation](manual.md)

data/docs/learn/01-target.md

@@ -1,18 +1,17 @@
 [<< back](README.md)
 
-# Example: 01-target
+# Example: target
 
-Let's learn how to create our first target.
-A target is a feature you want to measure or check.
-
-1. [Definition section](#definition-section)
-2. [Execution section](#execution-section)
-3. [Run test](#run-test)
-4. [Output reports](#output-reports)
+A target is a feature you want to check.
 
 ## Definition section
 
-Test definition section (Group):
+Test definition section (`group`):
+
+* **target**: Description of the element to be tested.
+* **run**: Execute a command `id david` on localhost.
+* **expect**: Ensure the result contains expected value.
+
 ```ruby
 group "Learn about targets" do
 
@@ -23,16 +22,14 @@ group "Learn about targets" do
 end
 ```
 
-Define targets using these lines:
-* **target**: Description of the element to be tested.
-* **run**: Execute a command `id david` on localhost.
-* **expect**: Ensure the result contains expected value.
-
 > In this example, localhost's OS must be GNU/Linux (any other compatible OS) because the command used is `id david`.
 
 ## Execution section
 
-Test execution section (Play):
+Test execution section (`play`):
+
+* **show**: display process information on screen.
+* **export**: build output reports.
 
 ```ruby
 play do
@@ -41,73 +38,44 @@ play do
 end
 ```
 
-DSL keywords:
-* **show**: display process information on screen.
-* **export**: build output reports.
+## Running the test
 
-## Run test
-
-**Let's see example**: Executing ` teuton run examples/learn-01-target` command.
-
-```bash
-[INFO] ScriptPath => examples/learn-01-target/start.rb
-[INFO] ConfigPath => examples/learn-01-target/config.yaml
-[INFO] Pwd        => /home/david/proy/repos/teuton.d/teuton
-[INFO] TestName   => learn-01-target
-
-==================================
-Executing [teuton] (version 2.2.0)
-[INFO] Running in parallel (2020-10-10 12:29:34 +0100)
-.
-[INFO] Duration = 0.002    (2020-10-10 12:29:34 +0100)
-==================================
-
-INITIAL CONFIGURATIONS
-+---------------+----------------------------------------+
-| tt_title      | Executing [teuton] (version 2.2.0)     |
-| tt_scriptname | examples/learn-01-target/start.rb      |
-| tt_configfile | examples/learn-01-target/config.yaml   |
-| tt_pwd        | /home/david/proy/repos/teuton.d/teuton |
-| tt_testname   | learn-01-target                        |
-| tt_sequence   | false                                  |
-+---------------+----------------------------------------+
+Execute this command to run the test:
+
+```console
+> teuton run examples/01-target
 
 CASE RESULTS
 +------+-----------+-------+-------+
 | CASE | MEMBERS   | GRADE | STATE |
-| 01   | anonymous | 100.0 |       |
+| 01   | anonymous | 100.0 | ✔     |
 +------+-----------+-------+-------+
-
-FINAL VALUES
-+-------------+---------------------------+
-| start_time  | 2020-10-10 12:29:34 +0100 |
-| finish_time | 2020-10-10 12:29:34 +0100 |
-| duration    | 0.002187719               |
-+-------------+---------------------------+
 ```
 
 ## Output reports
 
-**Output directory**: reports created into `var/learn-01-target/` output directory.
+Report files created into `var/01-target/`:
 
-```bash
+```console
 var
-└── learn-01-target
+└── 01-target
     ├── case-01.txt
     ├── moodle.csv
     └── resume.txt
 ```
 
-**Let's see example**: Executing `more var/learn-01-target/case-01.txt` command.
+Let's see one report:
+
+```
+> more var/01-target/case-01.txt
 
-```bash
 CONFIGURATION
-+-------------+-----------------+
-| tt_members  | anonymous       |
-| tt_sequence | false           |
-| tt_skip     | false           |
-| tt_testname | learn-01-target |
-+-------------+-----------------+
++-------------+-----------+
+| tt_members  | anonymous |
+| tt_sequence | false     |
+| tt_skip     | false     |
+| tt_testname | 01-target |
++-------------+-----------+
 
 GROUPS
 - Learn about targets
@@ -122,9 +90,9 @@ GROUPS
 RESULTS
 +--------------+---------------------------+
 | case_id      | 01                        |
-| start_time   | 2020-10-10 12:29:34 +0100 |
-| finish_time  | 2020-10-10 12:29:34 +0100 |
-| duration     | 0.001781893               |
+| start_time   | 2022-12-24 13:31:28 +0000 |
+| finish_time  | 2022-12-24 13:31:28 +0000 |
+| duration     | 0.001880141               |
 | unique_fault | 0                         |
 | max_weight   | 1.0                       |
 | good_weight  | 1.0                       |