teuton 2.1.10 → 2.3.1

data/docs/dsl/definition/target.md

@@ -2,7 +2,6 @@
 
 1. [Description](#description)
 2. [Usage](#usage)
-3. [Alias](#alias)
 4. [Weight](#weight)
 
 ## Description
@@ -18,24 +17,24 @@ target "Write here your description"
 * Define target description. Use your own words to describe it, so everybody could understand what is going to be measured.
 * This text will be shown into reports to help us understand output information easily.
 
-## Alias
+## Weight
 
-`goal` keyword is an alias of `target`. So it's the same:
+By default weight is 1.0, but it's posible specified other value:
 
 ```ruby
-target "Write here your description"
+target "Write here your description", :weight => 2.5
 ```
 
-or
+## [DEPRECATED] Alias
+
+`goal` keyword is an alias of `target`. So it's the same:
 
 ```ruby
-goal "Write here your description"
+target "Write here your description"
 ```
 
-## Weight
-
-By default weight is 1.0, but it's posible specified other value:
+or
 
 ```ruby
-target "Write here your description", :weight => 2.5
+goal "Write here your description"
 ```

data/docs/dsl/execution/export.md

@@ -1,22 +1,14 @@
 [<< back](../../README.md)
 
 1. [Description](#description)
-2. [Usage](#usage)
-3. [Example](#example)
-4. [Formats](#formats)
+2. [Example](#example)
+3. [Options](#options)
+4. [Usage](#usage)
 
 ## Description
 
 Create reports and save then into `var/TEST-NAME` folder.
 
-## Usage
-
-```ruby
-play do
-    export
-end
-```
-
 ## Example
 
 Run export and build reports using txt output format by default:
@@ -35,13 +27,28 @@ play do
 end
 ```
 
-## Formats
+## Options
+
+1. **format**: txt, html, yaml. json, colored_text (txt with colors).
+2. **preserve**: true, false.
+
+## Usage
 
-| Command                  | Description |
-| ------------------------ | ----------- |
-| `export`                 | Export report files using default ouput format |
-| `export :format => :txt` | Export file using TXT ouput format |
-| `export :format => :html` | Export file using HTML ouput format |
-| `export :format => :yaml` | Export file using YAML ouput format |
-| `export :format => :json` | Export file using JSON ouput format |
-| `export :format => :colored_text` | Export file using colored TXT ouput format |
+|    | 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: :html, preserve: true` | Same as 08 example |
+| 12 | `export format: "txt"` | Same as 02 |
+| 13 | `export format: "html"` | Same as 03 |
+| 14 | `export format: "yaml"` | Same as 04 |
+| 15 | `export format: "json"` | Same as 05 |
+| 16 | `export format: "colored_text"` | Same as 06 |
+| 17 | `export preserve: true` | Same as 07 |
+| 18 | `export format: "html", preserve: true` | Same as 08 |

data/docs/install/README.md

@@ -3,7 +3,7 @@
 # Installation
 
 > Definitions:
-> * **T-node**: Host where Teuton software is installed. Monitor S-NODE hosts.
+> * **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.
@@ -13,18 +13,18 @@
 * **Install** Teuton (T-NODE role host):
     1. Install Ruby on your system.
     2. `gem install teuton`
-* Run `teuton version` to check is fine.
+* Run `teuton version` to check the installed version.
 
-> **PROBLEMS**: If you don't find `teuton`command (OpenSUSE distro), try this:
+> **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.
+>     * `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** with `gem teuton update`.
-* **Uninstall** with `gem uninstall teuton`
+* **Update** Teuton with `gem teuton update`.
+* **Uninstall** Teuton with `gem uninstall teuton`.
 
 ## S-NODE installation
 
@@ -33,17 +33,12 @@
 ---
 # Other installation ways
 
-**Scripts**. [Installation using scripts](scripts.md)
-* Use our scripts to run automatical installation for your OS.
-* Use this way if you don't know how to install Ruby on your system.
+**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)
-* If you plan to install Teuton into virtual machines or containers.
+**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 don't need help, and want to install Teuton by your own, or there are not installation scripts for your favorite OS, and you don't want to use Vagrant then... here you have information how to install all the required packages for Teuton.
-
----
-Let's us known your installation difficulties.
-
-Thanks!
+**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.

data/docs/install/vagrant_docker.md

@@ -25,7 +25,7 @@ Second, choose:
 
 ## 2.1 Pulling docker images from remote
 
-Run this command to pull **dvarrui/teuton** image from Docker Hub and create teuton container:
+Run this command to pull **dvarrui/teuton** image from Docker Hub and create "teuton" container:
 
 `docker run --name teuton -v /home/teuton -i -t dvarrui/teuton /bin/bash`
 

data/docs/learn/README.md

@@ -11,14 +11,14 @@ Learn how to use Teuton language to write your own tests:
 - [Example 01 - Target](example-01-target.md)
 - [Example 02 - Config file](example-02-config.md)
 - [Example 03 - Remote hosts](example-03-remote-hosts.md)
-- [Example 04 - Use](example-04-use.md)
-- [Example 05 - Debug](example-05-debug.md)
-- [Example 06 - Log](example-06-log.md)
-- Example 07 - Preserve
-- Example 08 - Readme
-- Example 09 - Macros
-- Example 10 - Alias
-- [Example 11 - Create your first test](example-11-first-test.md)
+- [Example 04 - Create new test](example-04-new-test.md)
+- [Example 05 - Use](example-05-use.md)
+- [Example 06 - Debug](example-06-debug.md)
+- [Example 07 - Log](example-07-log.md)
+- [Example 08 - Readme](example-08-readme.md)
+- [Example 09 - Preserve](example-09-preserve.md)
+- Example 10 - Macros
+- Example 11 - Alias
 - [Videos](videos.md)
 
 # Examples

data/docs/learn/example-01-target.md

@@ -1,16 +1,16 @@
 [<< back](README.md)
 
-1. [Definition section](#definition-section)
-2. [Execution section](#execution-section)
-3. [Run test](#run-test)
-4. [Output reports](#output-reports)
-
 # Example: learn-01-target
 
+> This example is on GitHub repository at `examples/learn-01-target/`.
+
 Let's learn how to create our first target.
 A target is a feature you want to measure or check.
 
-> This example is on GitHub repository at `examples/learn-01-target/`.
+1. [Definition section](#definition-section)
+2. [Execution section](#execution-section)
+3. [Run test](#run-test)
+4. [Output reports](#output-reports)
 
 ## Definition section
 
@@ -54,25 +54,25 @@ DSL keywords:
 ```bash
 [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] Pwd        => /home/david/proy/repos/teuton.d/teuton
 [INFO] TestName   => learn-01-target
 
 ==================================
-Executing [teuton] (version 2.1.9)
-[INFO] Running in parallel (2020-04-18 21:32:16 +0100)
+Executing [teuton] (version 2.2.0)
+[INFO] Running in parallel (2020-10-10 12:29:34 +0100)
 .
-[INFO] Duration = 0.003    (2020-04-18 21:32:16 +0100)
+[INFO] Duration = 0.002    (2020-10-10 12:29:34 +0100)
 ==================================
 
 INITIAL CONFIGURATIONS
-+---------------+-------------------------------------------+
-| tt_title      | Executing [teuton] (version 2.1.9)        |
-| tt_scriptname | examples/learn-01-target/start.rb         |
-| tt_configfile | examples/learn-01-target/config.yaml      |
-| tt_pwd        | /mnt/home/leap/proy/repos/teuton.d/teuton |
-| tt_testname   | learn-01-target                           |
-| tt_sequence   | false                                     |
-+---------------+-------------------------------------------+
++---------------+----------------------------------------+
+| 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                                  |
++---------------+----------------------------------------+
 
 CASE RESULTS
 +------+-----------+-------+-------+
@@ -82,9 +82,9 @@ CASE RESULTS
 
 FINAL VALUES
 +-------------+---------------------------+
-| start_time  | 2020-04-18 21:32:16 +0100 |
-| finish_time | 2020-04-18 21:32:16 +0100 |
-| duration    | 0.003310235               |
+| start_time  | 2020-10-10 12:29:34 +0100 |
+| finish_time | 2020-10-10 12:29:34 +0100 |
+| duration    | 0.002187719               |
 +-------------+---------------------------+
 ```
 
@@ -116,7 +116,7 @@ GROUPS
     01 (1.0/1.0)
         Description : Create user david
         Command     : id david
-        Duration    : 0.003 (local)
+        Duration    : 0.002 (local)
         Alterations : find(david) & count
         Expected    : Greater than 0 (String)
         Result      : 1 (Integer)
@@ -124,9 +124,9 @@ GROUPS
 RESULTS
 +--------------+---------------------------+
 | case_id      | 01                        |
-| start_time   | 2020-04-18 21:32:16 +0100 |
-| finish_time  | 2020-04-18 21:32:16 +0100 |
-| duration     | 0.002835857               |
+| start_time   | 2020-10-10 12:29:34 +0100 |
+| finish_time  | 2020-10-10 12:29:34 +0100 |
+| duration     | 0.001781893               |
 | unique_fault | 0                         |
 | max_weight   | 1.0                       |
 | good_weight  | 1.0                       |

data/docs/learn/example-02-config.md

@@ -1,30 +1,30 @@
 [<< back](README.md)
 
-1. [Config file](#config-file).
-2. [Definition section](#definition-section).
-3. [Execution section](#execution-section).
-4. [Results](#results).
-
 # Example: learn-02-config
 
-This example is on GitHub repository at `examples/learn-02-config`.
+> This example is on GitHub repository at `examples/learn-02-config`.
 
 * Learn how to use config file.
-* Tests use params defined into config files.
+* Use params defined into config files.
 * It's good idea save variable data separated into external config file.
 
+1. [Config file](#config-file).
+2. [Definition section](#definition-section).
+3. [Execution section](#execution-section).
+4. [Results](#results).
+
 ## Config file
 
 By default, `config.yaml` is our config file. Let's an example:
 
 ```yaml
 ---
-:global:
-:cases:
-- :tt_members: Student-name-1
-  :username: root
-- :tt_members: Student-name-2
-  :username: vargas
+global:
+cases:
+- tt_members: Student-name-1
+  username: root
+- tt_members: Student-name-2
+  username: vargas
 ```
 
 ## Definition section
@@ -34,7 +34,7 @@ By default, `start.rb` it's our main execution file.
 ```ruby
 group "Reading params from config file" do
 
-  target "Create user #{gett(:username)}"
+  target "Create user #{get(:username)}"
   run "id #{get(:username)}"
   expect get(:username)
 
@@ -61,41 +61,29 @@ Runing this example and see `show` keyword output:
 
 ```bash
 > teuton run --no-color examples/learn-02-config
-[INFO] ScriptPath => examples/learn-02-config/start.rb
-[INFO] ConfigPath => examples/learn-02-config/config.yaml
-[INFO] Pwd        => /mnt/home/leap/proy/repos/teuton.d/teuton
-[INFO] TestName   => learn-02-config
-
-==================================
-Executing [teuton] (version 2.1.9)
-[INFO] Running in parallel (2020-04-18 21:46:38 +0100)
-id: «vargas»: no existe ese usuario
-.F
-[INFO] Duration = 0.004    (2020-04-18 21:46:38 +0100)
-==================================
-
-INITIAL CONFIGURATIONS
-+---------------+-------------------------------------------+
-| tt_title      | Executing [teuton] (version 2.1.9)        |
-| tt_scriptname | examples/learn-02-config/start.rb         |
-| tt_configfile | examples/learn-02-config/config.yaml      |
-| tt_pwd        | /mnt/home/leap/proy/repos/teuton.d/teuton |
-| tt_testname   | learn-02-config                           |
-| tt_sequence   | false                                     |
-+---------------+-------------------------------------------+
-
-CASE RESULTS
+CONFIGURATION
++---------------+----------------------------------------+
+| tt_title      | Executing [teuton] (version 2.2.0)     |
+| tt_scriptname | examples/learn-02-config/start.rb      |
+| tt_configfile | examples/learn-02-config/config.yaml   |
+| tt_pwd        | /home/david/proy/repos/teuton.d/teuton |
+| tt_testname   | learn-02-config                        |
+| tt_sequence   | false                                  |
++---------------+----------------------------------------+
+
+CASES
 +------+----------------+-------+-------+
 | CASE | MEMBERS        | GRADE | STATE |
-| 01   | Student-name-1 | 100.0 |       |
-| 02   | Student-name-2 | 0.0   | ?     |
+| 01   | Student-name-1 |   100 |       |
+| 02   | Student-name-2 |     0 | ?     |
 +------+----------------+-------+-------+
 
-FINAL VALUES
+
+RESULTS
 +-------------+---------------------------+
-| start_time  | 2020-04-18 21:46:38 +0100 |
-| finish_time | 2020-04-18 21:46:38 +0100 |
-| duration    | 0.003665655               |
+| start_time  | 2020-10-10 12:37:54 +0100 |
+| finish_time | 2020-10-10 12:37:54 +0100 |
+| duration    | 0.002054143               |
 +-------------+---------------------------+
 ```
 
@@ -124,12 +112,13 @@ CONFIGURATION
 | username    | root            |
 +-------------+-----------------+
 
+
 GROUPS
-- Using config file values
+- Reading params from config file
     01 (1.0/1.0)
         Description : Create user root (username)
         Command     : id root
-        Duration    : 0.003 (local)
+        Duration    : 0.001 (local)
         Alterations : find(root) & count
         Expected    : Greater than 0 (String)
         Result      : 1 (Integer)
@@ -137,9 +126,9 @@ GROUPS
 RESULTS
 +--------------+---------------------------+
 | case_id      | 01                        |
-| start_time   | 2020-04-18 21:46:38 +0100 |
-| finish_time  | 2020-04-18 21:46:38 +0100 |
-| duration     | 0.002899065               |
+| start_time   | 2020-10-10 12:37:54 +0100 |
+| finish_time  | 2020-10-10 12:37:54 +0100 |
+| duration     | 0.001762191               |
 | unique_fault | 0                         |
 | max_weight   | 1.0                       |
 | good_weight  | 1.0                       |

data/docs/learn/example-03-remote-hosts.md

@@ -1,19 +1,19 @@
 [<< back](README.md)
 
-1. [Config file](#config-file)
-2. [Definition section](#definition-section).
-3. [Execution section](#execution-section).
-4. [Results](#results).
-
 # Example: learn-03-remote-hosts
 
-This example is on GitHub repository at `examples/learn-03-remote-hosts`.
+> This example is on GitHub repository at `examples/learn-03-remote-hosts`.
 
 Summary:
 * Check a group of remote hosts.
 * Export reports using other output formats.
 * Checking remote machine (host1) with Windows OS.
 
+1. [Config file](#config-file)
+2. [Definition section](#definition-section).
+3. [Execution section](#execution-section).
+4. [Results](#results).
+
 ## Config file
 
 This configuration file contains:
@@ -23,22 +23,22 @@ This configuration file contains:
 
 ```yaml
 ---
-:global:
-  :host1_username: root
-  :host1_password: profesor
-:cases:
-- :tt_members: Darth Maul
-  :host1_ip: 192.168.1.201
-  :host1_hostname: siths
-  :username: maul
-- :tt_members: R2D2
-  :host1_ip: 192.168.1.202
-  :host1_hostname: robots
-  :username: r2d2
-- :tt_members: Obiwan Kenobi
-  :host1_ip: 192.168.1.203
-  :host1_hostname: jedis
-  :username: obiwan
+global:
+  host1_username: root
+  host1_password: profesor
+cases:
+- tt_members: Darth Maul
+  host1_ip: 192.168.1.201
+  host1_hostname: siths
+  username: maul
+- tt_members: R2D2
+  host1_ip: 192.168.1.202
+  host1_hostname: robots
+  username: r2d2
+- tt_members: Obiwan Kenobi
+  host1_ip: 192.168.1.203
+  host1_hostname: jedis
+  username: obiwan
 ```
 
 ## Definition section

data/docs/learn/{example-11-first-test.md → example-04-new-test.md}

@@ -1,26 +1,27 @@
 
+[<< back](README.md)
+
+# Example: learn-04-new-test
+
+> This example is on GitHub repository at `examples/learn-04-new-test`.
+
 Steps:
 1. Create skeleton
 2. Personalize targets
 3. Personalize configuration file
 4. Run the challenge
 
----
-
 ## STEP 1: Create skeleton
 
 Create skeleton for a new project: `teuton create foo`
 
 ```bash
-$ teuton create foo
+$ teuton new foo
 
-[INFO] Create project <foo>
+[INFO] Creating foo project skeleton
 * Create dir        => foo
-* Create dir        => foo/assets
-* Create file       => foo/start.rb
 * Create file       => foo/config.yaml
-* Create file       => foo/.gitignore
-* Create file       => foo/assets/README.md
+* Create file       => foo/start.rb
 ```
 
 > It's posible to create these files by hand.
@@ -30,36 +31,32 @@ This command will create:
 | File/Directory  | Description    |
 | --------------- | -------------- |
 | foo             | Base directory |
-| foo/assets      | Base directory for assest (images and text files) |
 | foo/start.rb    | Main Script    |
 | foo/config.yaml | YAML configuration file |
-| foo/.gitignore  | Prevent uploading YAML files to git repository |
-| foo/assets/README.md | Statement of practice |
 
 ---
 
 ## STEP 2: Personalize targets
 
-Write your own targets using the keywords: `target`, `goto` and `expect`. Let's see an example:
+Write your own targets using the keywords: `target`, `run` and `expect`. Let's see:
 
 ```ruby
 group "Demo group" do
 
 	target "Exist </home/david> directory"
-	goto   :host1, :exec => "file /home/david"
+	run "file /home/david", :on => :host1
 	expect ["/home/david", "directory"]
 
 end
 ```
 
-The above example checks if exists 'yoda' user, on *host1* system.
+The above example checks if exists '/home/david' directory, into *host1* device.
 
 > Let's see the keywords used:
 >
 > * `target "Exist </home/david> directory"`, Describe the target with our words, so every one could easily understand what we are trying
 to check.
-> * `goto :host1, :exec => "file /home/david"`: Execute the command
-into the remote machine (host1).
+> * `run "file /home/david", :on => :host1`, : Execute the command into the remote machine (host1).
 > * `expect ["/home/david", "directory"]`: Compare command ouput with our expectations.
 
 ---
@@ -73,17 +70,17 @@ Use a YAML file (`foo/config.yaml`) or JSON for your own configurations. In this
 ```yaml
 ---
 :global:
- :host1_username: root
+  :host1_username: root
 :cases:
-- :tt_members: Student 01 name or alias
- 	:host1_ip: 1.1.1.1
- 	:host1_password: root-password-student-01
-- :tt_members: Student 02 name or alias
- 	:host1_ip: 2.2.2.2
- 	:host1_password: root-password-student-02
+- :tt_members: student-name-01
+  :host1_ip: 1.1.1.1
+  :host1_password: root-password-student-01
+- :tt_members: student-name-02
+  :host1_ip: 2.2.2.2
+  :host1_password: root-password-student-02
 ```
 
-> The above file configures 2 diferents cases with their own params. The script use this information when execute every case.
+> The above file configures 2 differents cases with their own params. The script use this information when execute every case.
 
 ---
 
@@ -94,3 +91,5 @@ Now we only have to run the challenge:
 ```bash
 $ teuton foo
 ```
+
+Output files are saved into `var/foo` directory.

data/docs/learn/{example-04-use.md → example-05-use.md}

@@ -1,17 +1,17 @@
 [<< back](README.md)
 
-1. [Tree directory](#tree-directory)
-2. [Execution section](#execution-section)
-3. [Users file](#users-file)
-4. [Network file](#network-file)
+# Example: learn-05-use
 
-# Example: learn-04-use
+> This example is on GitHub repository at `examples/learn-05-use`.
 
 Learn how to:
 * Organize huge amount of groups/targets into several files.
 * Checking Windows OS infrastructure (host1).
 
-> This example is on GitHub repository at `examples/learn-04-use`.
+1. [Tree directory](#tree-directory)
+2. [Execution section](#execution-section)
+3. [Users file](#users-file)
+4. [Network file](#network-file)
 
 ## Tree directory
 

data/docs/learn/{example-05-debug.md → example-06-debug.md}

@@ -1,24 +1,24 @@
 
 [<< back](README.md)
 
-1. [Tree directory](#tree-directory)
-2. [Execution section](#execution-section)
-3. [Check test](#check-test)
-4. [Debug](#debug)
+# Example: learn-06-debug
 
-# Example: learn-05-debug
+> This example is on GitHub repository at `examples/learn-06-debug`.
 
 Learn how to:
 * Check test syntax.
 * Debug your tests.
 
-> This example is on GitHub repository at `examples/learn-05-debug`.
+1. [Tree directory](#tree-directory)
+2. [Execution section](#execution-section)
+3. [Check test](#check-test)
+4. [Debug](#debug)
 
 ## Tree directory
 
 ```bash
-$ tree learn/learn-05-debug
-example/learn-05-debug
+$ tree learn/learn-06-debug
+example/learn-06-debug
 ├── config.yaml
 ├── external.rb
 ├── internal.rb