teuton 2.4.0 → 2.4.2

data/docs/dsl/{execution/show.md → show.md}

@@ -1,36 +1,27 @@
 [<< back](../../README.md)
 
-1. [Description](#description)
-2. [Usage](#usage)
-3. [Parameters](#parameters)
-
-## Description
+# show
 
 When all tests are finished, the `show` command displays information on the screen about the final results.
 
-## Usage
-
 ```ruby
 start do
   show
 end
 ```
 
-or
-
-```ruby
-start do
-  show verbose: 1
-end
-```
-
-## Parameters
+## Verbosity
 
 | Action               | Description                       |
 | -------------------- | --------------------------------- |
 | `show`               | Same as `show level: 0` (Default) |
 | `show verbose: NUMBER` | NUMBER is the value of the verbose level |
 
+```ruby
+start do
+  show verbose: 1
+end
+```
 
 | Verbosity level | Description |
 | :-------------: | ----------- |

data/docs/dsl/target.md

@@ -0,0 +1,33 @@
+[<< back](../README.md)
+
+# target
+
+`target` instruction is used to begin every new target and sets its description.
+
+```ruby
+target "Write here your description"
+```
+
+Describe your targets so everybody could understand what is going to be measured. This text will be shown into reports to help us understand output information easily.
+
+## Weight
+
+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/ideas/todo.md

@@ -1,124 +1,44 @@
 
-# Ideas
+# TODO list
 
-Esta es una lista de ideas para que no se me olvide... lo podemos ir ajustando 😊
+## Add
 
-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.
+* Option roadmap_ok_only. When expect returns false... test stop. The rest of targets are forced to fails.
+* `expect_equal "camaleon"`, same as `expect result.equal "camaleon"`.
+* **FEATURE** Define a loop of executions of our activity. For example:
+  every 5 minutes, run the activity, and repeat this 10 times.
+  `start :times=>10, :every=>5 do`
+* Script to set **static IP**
+* Change export to show **command output** into reports.   
+* **TEST**: actualizar las pruebas con vagrant para la versión actual. Mejora de la calidad del código.
+* **DOCS** 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 eval: :targets`
+    1. Evaluate task: `start eval: :groups` and perhaps add group weight?
+    1. config file with `tt_eval: groups`
+
+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.
+
+## Ideas
 
-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.
+Esta es una lista de ideas para que no se me olvide... lo podemos ir ajustando 😊
 
-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
+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. 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.
+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???
-
 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...
+5. `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....
+6. When students demand help they could recibe some advises. More ideas: bonus, lives, etc.
+7. 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.
 
-5. `result.test("...")`
-6. `send :email_to => :members_emails`
-
-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"
-
-
-# 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=>:groups 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.
-
-### 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
-```
-
----
+# Propuestas de sdelquin
 
-* teuton run into
-* txt format -> remove conn_errors when errors = 0
+- Docker en vez de vagrant?? → https://www.cloudbees.com/blog/ssh-into-a-docker-container-how-to-execute-your-commands
+- Tablas "bonitas" en terminal → https://github.com/piotrmurach/tty-markdown#17-table
+- Documentación en https://readthedocs.org/ ??

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-cmd_new.md

@@ -0,0 +1,28 @@
+
+[<< back](README.md)
+
+# new test
+
+Create skeleton for a new project: `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: It is posible to create these files by hand.
+
+This command will create:
+
+| File/Directory  | Description    |
+| --------------- | -------------- |
+| foo             | Base directory |
+| foo/start.rb    | Main Script    |
+| foo/config.yaml | YAML configuration file |
+
+
+Now it is time to customize your targets.

data/docs/learn/{01-target.md → 02-target.md}

@@ -1,18 +1,15 @@
 [<< back](README.md)
 
-# Example: 01-target
+# target
 
-Let's learn how to create our first target.
-A target is a feature you want to measure or check.
+A [target](../dsl/target.md) is a feature you want to check. Targets are defined into `group` sections and every evaluation has 3 parts:
 
-1. [Definition section](#definition-section)
-2. [Execution section](#execution-section)
-3. [Run test](#run-test)
-4. [Output reports](#output-reports)
+## Target definition
 
-## Definition section
+* [target](dsl/target.md): Description of the element to be tested.
+* [run](../dsl/run.md): Execute a command `id david` on localhost.
+* [expect](../&dsl/expect.md): Verify that the result contains expected value.
 
-Test definition section (Group):
 ```ruby
 group "Learn about targets" do
 
@@ -23,16 +20,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`.
+> In this example, our localhost's OS is GNU/Linux (or any other compatible OS) because the command executed is `id david`.
 
 ## Execution section
 
-Test execution section (Play):
+When we run this teuton test, the execution section (`play`) is processed. This seccion now contains this:
+
+* [show](../dsl/show.md): display process information on screen.
+* [export](../dsl/export.md): build output reports.
 
 ```ruby
 play do
@@ -41,15 +36,13 @@ play do
 end
 ```
 
-DSL keywords:
-* **show**: display process information on screen.
-* **export**: build output reports.
+## Example
 
-## Run test
+Execute this command to run the test:
 
-**Let's see example**: Executing ` teuton run examples/01-target` command.
+```console
+> teuton run examples/01-target
 
-```bash
 CASE RESULTS
 +------+-----------+-------+-------+
 | CASE | MEMBERS   | GRADE | STATE |
@@ -57,11 +50,9 @@ CASE RESULTS
 +------+-----------+-------+-------+
 ```
 
-## Output reports
-
-**Output directory**: reports created into `var/01-target/` output directory.
+Report files are created into `var/02-target/` folder:
 
-```bash
+```console
 var
 └── 01-target
     ├── case-01.txt
@@ -69,9 +60,11 @@ var
     └── resume.txt
 ```
 
-**Let's see example**: Executing `more var/01-target/case-01.txt` command.
+Let's see one report:
+
+```
+> more var/02-target/case-01.txt
 
-```bash
 CONFIGURATION
 +-------------+-----------+
 | tt_members  | anonymous |