teuton 2.10.6 → 2.10.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9a1b6762cc25c63b89aaa6e2d1fa0a245a3451a9aad17c142d1577db0686df8
-  data.tar.gz: af350833b0f89946123adc26f35aedaab554e44953ea50a21bb2fdb2c8d4e4be
+  metadata.gz: 631f4c00542468fa42a36a38c017dc0a5e122fa4d0b1445dd0872ada4e5becdc
+  data.tar.gz: a01194deda208794fafcc3337f762584c36fd492fa9a5fd295240e5f5c9773c8
 SHA512:
-  metadata.gz: 31109462bb8cb4cae1cdacfcde8d396393a64a08cc37c44fb7926475b2379ae1cde1acdcb17c671ebd7b332b9ce15737f5f31b5b707d68f02fd1837b00df6545
-  data.tar.gz: 228d4bfbce686c1a2dafcd0edbcb40f375dd69e1cfd8b49db3523e36a4de5db92a5dbc6e949f62b593e3cd0223d1dbc1371f2d9d5d75f49264af02bf40e35de9
+  metadata.gz: f8ec0d2672650d1b2d422f667dde1eed7e81f65133406d58d2ccc607c9ee8db7451e426a61e792f897f138815ecf37c4e6e0baf416e44fd677baa58003940376
+  data.tar.gz: 76052c9435bad56f8de1822d48491854bf597c3823a0ce056a1f6c0eeafdbf7b16b37ec12737a600eaf9f051e684f0878cbcfd94b2c00cd8e0d67ab9d6e0c76c

data/docs/commands/README.md

@@ -39,7 +39,7 @@ Example:
 ```console
 $ teuton new foo
 
-[INFO] Creating foo project skeleton
+Creating foo project
 * Create dir        => foo
 * Create file       => foo/config.yaml
 * Create file       => foo/start.rb
@@ -74,7 +74,7 @@ Alias: `teuton c foo`, `teuton -c foo`, `teuton --check foo`
 
 # 5. Run test
 
-Read about [how to run tests](howto-run-tests.md)
+Read about [how to run tests](run-tests.md)
 
 # 6. Show test info as README file
 

data/docs/commands/check-example.md

@@ -13,7 +13,7 @@ Usage: `teuton check PATH-TO-TEST-FOLDER`
 
 Example:
 
-```bash
+```
 $ teuton check examples/02-target
 
 +----------------------------+

data/docs/commands/{howto-run-tests.md → run-tests.md}

@@ -17,7 +17,7 @@ Alias: `teuton foo`
 
 Running Teuton test located into `example/01-target` folder.
 
-```bash
+```
 $ teuton run example/01-target
 
 ------------------------------------
@@ -56,37 +56,39 @@ Options:
 | -- | -------------------- | ------------ |
 | 01 | teuton foo           | Run foo/start.rb, with config file foo/config.yaml |
 | 02 | teuton run foo      | Run foo/start.rb, with config file foo/config.yaml |
-| 03 | ruby teuton foo      | Same as 01 on Windows OS |
-| 04 | ruby teuton run foo | Same as 02 on WIndows OS |
-| 05 | teuton . | Run ./start.rb with ./config.yaml file |
-| 06 | teuton run --export=json foo | Run foo/start.rb and force json format during exporting. Others output formats availables are: txt, colored_text, json, yaml |
-| 07 | teuton run --cname=rock foo | Run foo/start.rb with foo/rock.yaml config file |
-| 08 | teuton foo/demo42.rb | Run foo/demo42.rb with foo/demo42.yaml config file |
-| 08 | teuton run --cpath=starwars/jedi.yaml foo | Run foo/start.rb with starwars/jedi.yaml config file |
-| 09 | teuton run --case=6,16 foo | Run foo/start.rb with foo/config.yaml config file but only for case id '06' and '16' |
+| 03 | teuton . | Run ./start.rb with ./config.yaml file |
+| 04 | teuton run --export=json foo | Run foo/start.rb and force json format during exporting |
+| 05 | teuton run --cname=rock foo | Run foo/start.rb with foo/rock.yaml config file |
+| 06 | teuton foo/demo42.rb | Run foo/demo42.rb with foo/demo42.yaml config file |
+| 07 | teuton run --cpath=starwars/jedi.yaml foo | Run foo/start.rb with starwars/jedi.yaml config file |
+| 08 | teuton run --case=6,16 foo | Run foo/start.rb with foo/config.yaml config file but only for case id '06' and '16' |
 
 # 3. Choosing config file
 
-**Default names:**:
+## 3.1 Default file names
+
 By default, when you run `teuton run foo`, this will search for:
 * `foo/start.rb` test file and
 * `foo/config.yaml` config file.
 
-**Using cname param:**
+## 3.2 Using `cname` option
+
 It's posible execute `teuton run --cname=rock foo`, and choose diferent config file into projet folder:
 * `foo/start.rb` test file and
 * `foo/rock.yaml` config file.
 
 > `cname` param searchs YAML config file into the same project folder.
 
-**Using cpath param:**
-An also, it's posible execute `teuton run --cpath=/home/david/startwars.yaml foo`, and choose config file using its absolute path:
+## 3.3 Using `cpath` option
+
+An also, it's posible execute `teuton run --cpath=/home/obiwan/startwars.yaml foo`, and choose config file using its absolute path:
 * `foo/start.rb` test file and
-* `/home/david/starwars.yaml` config file.
+* `/home/obiwan/starwars.yaml` config file.
 
 > `cpath` param selects YAML config file, from the specified path.
 
-**Using diferent main rb name:**
+## 3.4 Using diferent main rb name
+
 When you execute `teuton run foo/mazingerz.rb`, this will search for:
 * `foo/mazingerz.rb` test file and
 * `foo/mazingerz.yaml` config file.

data/docs/dsl/export.md

@@ -2,20 +2,16 @@
 
 # export
 
-Create reports and save then into `var/TEST-NAME` folder.
-
-## Example
-
-Run export and build reports using txt output format by default:
+Create output reports into `var/TESTNAME` folder.
 
+**Example 1**: Run export and build reports using default format (`txt`).
 ```ruby
 play do
   export
 end
 ```
 
-Run test and build reports using `html` output format:
-
+**Example 2**: Run test and build reports using `html` format.
 ```ruby
 play do
   export format: 'html'
@@ -26,9 +22,9 @@ end
 
 | Option | Values | Description |
 | ------ | ------ | ----------- |
-| format | **txt** (default), html, yaml, json, colored_text (txt with colors) |Output file format |
-| preserve | **false** (default), true | Keep report old copies |
-| feedback | **true** (default), false | Hide some fields from reports |
+| format | **txt** (default), html, yaml, json, markdown, colored_text (txt with colors) |Output file format |
+| preserve | **false** (default), true | Keep old report copies |
+| feedback | **true** (default), false | Hide feedback information from reports |
 
 ## Usage
 

data/docs/dsl/get.md

@@ -2,15 +2,11 @@
 
 # get
 
-`get` reads param value from configuration file.
+`get(PARAM)` keyword reads param value from configuration file.
 
-```ruby
-get(PARAM)
-```
-
-## Example
+## Example 1: reading params
 
-**Reading Example**. Suppose we have this `config.yaml` content:
+Suppose we have this `config.yaml` content:
 
 ```yaml
 ---
@@ -28,19 +24,23 @@ Supossing we are **case 01**, then:
 * `get(:username)` returns `obiwan`.
 * `get(:host1_username)`, returns `root`.
 
-**Writting example**: We also can create new temporal params:
+## Example 2: writting and reading params
+
+We also can create new temporal params:
 
 ```ruby
 set(:name, "Obiwan")
-var = get(:name)
+jediname = get(:name)
 ```
 
-So `var` value is "Obiwan".
+So `jediname` value is "Obiwan".
+
+## Example 3: reading alias
 
-**Simpler reading example**: Other ways or reading param values:
+Other ways or reading param values:
 
 ```ruby
-var = _name
+jediname = _name
 ```
 
-So `var` value is "Obiwan" too. `_name` is an alias of `get(:name)`.
+So `jediname` value is "Obiwan" too. `_name` is an alias of `get(:name)`.

data/docs/dsl/group.md

@@ -4,12 +4,14 @@
 
 Groups targets.
 
+## Example
+
 ```ruby
 group "Group name" do
 	...
 end
 ```
 
-* Define a group of targets or goal. These are groups of objectives to be evaluated.
+* Define a group of targets. These are groups of objectives to be evaluated.
 * At least you must define one `group`, where you can define all your targets.
 * We can use `group`, as many times as we need. Usefull to group related objectives.

data/docs/dsl/send.md

@@ -4,6 +4,7 @@
 
 `send` is used to copy Teuton reports into remote machines.
 
+Usage:
 ```ruby
 start do
   export
@@ -11,9 +12,9 @@ start do
 end
 ```
 
-* `send` instruction must be execute after `export`. Reports must be generated before send them, of course.
+* `send` instruction must be execute after `export`, because report files must be generated before send them.
 * `host1`, label that identify remote host. This information must be configured into config file.
-* `send copy_to: :host1`, copy every case resport file into temp directory on remote host `host1`.
+* `send copy_to: :host1`, by default, the home folder of the user `host1_username` is used to copy report on the remote host (`host1_ip`).
 
 ## Options
 
@@ -50,9 +51,9 @@ start do
 end
 ```
 
-## Example: Using "dir" options
+## Example: Change remote dir using "dir" options
 
-Example 1: send `case-01-txt` file to default folder of remote remote host.
+This example sends `case-01-txt` file to default folder of remote host.
 
 ```ruby
 play do
@@ -62,11 +63,9 @@ play do
 end
 ```
 
-Result:
-
 ![](images/send-remote-dir-dot2.jpg)
 
-Example 2: send report file to "./Desktop" folder of remote host.
+Using `dir: "./Desktop"`, report files will be sent to remote host "./Desktop" folder.
 
 ```ruby
 play do

data/docs/learn/01-cmd_new.md

@@ -1,20 +1,22 @@
 
 [<< back](README.md)
 
-# new test
+# New test
 
-Create skeleton for a new project: `teuton create foo`
+`teuton create foo` is a command function that creates skeleton for a new project. 
+
+## Example
 
 ```
-> teuton new foo
+$ teuton new foo
 
-[INFO] Creating foo project skeleton
+Creating foo project
 * Create dir        => foo
 * Create file       => foo/config.yaml
 * Create file       => foo/start.rb
 ```
 
-> NOTA: It is posible to create these files by hand.
+Read about [teuton create](../commands/README.md)
 
 This command will create:
 
@@ -24,5 +26,4 @@ This command will create:
 | foo/start.rb    | Main Script    |
 | foo/config.yaml | YAML configuration file |
 
-
-Now it is time to customize your targets.
+The next step is to personalize your targets.

data/docs/learn/02-target.md

@@ -1,6 +1,6 @@
 [<< back](README.md)
 
-# target
+# Target
 
 A [target](../dsl/target.md) is a feature you want to check. Targets are defined into `group` sections.
 
@@ -8,7 +8,7 @@ A [target](../dsl/target.md) is a feature you want to check. Targets are defined
 
 Every evaluation has 3 parts:
 * [target](dsl/target.md): Description of the element to be tested.
-* [run](../dsl/run.md): Execute a command `id obiwan` on localhost.
+* [run](../dsl/run.md): Execute a command on local or remote host.
 * [expect](../dsl/expect.md): Verify that the result contains expected value.
 
 ```ruby
@@ -24,24 +24,23 @@ group "Learn about targets" do
 end
 ```
 
-> In this example, our localhost's OS is GNU/Linux (or any other compatible OS) because the command executed is `id obiwan`.
+> In this example, our localhost's OS is GNU/Linux (or any other compatible OS), so the command executed is `id obiwan`.
 
 When the user exists, we expect this words: `uid=, (obiwan), gid=`.
 
 ```
-> id obiwan
+$ id obiwan
 uid=1000(obiwan) gid=1000(obiwan) grupos=1000(obiwan)
 ```
 
 But when user does not exist, we expect command fail.
 
 ```
-> id vader
+$ id vader
 id: «vader»: no such user
 
-> echo $?
+>$ echo $?
 1
-
 ```
 
 ## Execution section
@@ -62,8 +61,8 @@ end
 
 Execute this command to run the test:
 
-```console
-> teuton run examples/02-target
+```
+$ teuton run examples/02-target
 
 CASE RESULTS
 +------+-----------+-------+-------+
@@ -74,7 +73,7 @@ CASE RESULTS
 
 Report files are created into `var/02-target/` folder:
 
-```console
+```
 var
 └── 02-target
     ├── case-01.txt
@@ -85,7 +84,7 @@ var
 Let's see one report:
 
 ```
-❯ cat var/02-target/case-01.txt
+$ cat var/02-target/case-01.txt
 CONFIGURATION
 +-------------+-----------+
 | tt_members  | anonymous |
@@ -94,7 +93,6 @@ CONFIGURATION
 | tt_testname | 02-target |
 +-------------+-----------+
 
-
 GROUPS
 - Learn about targets
     01 (0.0/1.0)

data/docs/learn/03-remote_hosts.md

@@ -4,6 +4,8 @@
 
 To run test on remote host we have to define them into config file.
 
+## Example
+
 Let's see an example with:
 * 1 global param.
 * 3 cases with 3 params.
@@ -52,7 +54,7 @@ end
 Execution:
 
 ```
-> teuton run examples/03-remote_hosts
+$ teuton run examples/03-remote_hosts
 
 CASE RESULTS
 +------+-----------+-------+-------+
@@ -70,12 +72,12 @@ CONN ERRORS
 +------+-----------+-------+------------------+
 ```
 
-Notice that case-03 is 100% and conection works. It is running on localhost because has localhost IP (127.0.0.1)
+Notice that case-03 is 100% and conection works. It is running on localhost because has localhost IP (127.0.0.1).
 
 Results:
 
 ```
-❯ tree var/03-remote_hosts
+$ tree var/03-remote_hosts
 
 var/03-remote_hosts
 ├── case-01.txt
@@ -87,7 +89,7 @@ var/03-remote_hosts
 
 ## tt_skip param
 
-To disable a case, add skip param `tt_skip: true`.
-* `tt_skip` it is true by default.
+To disable a case, add skip param to config file. Example: `tt_skip: true`.
+* `tt_skip` it is false by default.
 * `tt_skip: false` ignore this case.
 * `tt_skip: true`, evaluate this case.

data/docs/learn/04-config.md

@@ -2,20 +2,20 @@
 
 # config
 
-_It's good idea save dinamic data into config file._
+Our tests use config file to write dinamic data into separated file.
 
 By default, `config.yaml` is our config file. Example:
 
 ```yaml
 global:
 cases:
-- tt_members: name_student_1
+- tt_members: student_1
   username: david
-- tt_members: name_student_2
+- tt_members: student_2
   username: fran
 ```
 
-> **How to choose another config file?** Read this [document](../commands/example_run.md#3-choosing-config-file).
+> **How to choose another config file?** Read this [document](../commands/run-test.md#3-choosing-config-file).
 
 By default, `start.rb` it's our main execution file. Example:
 
@@ -29,19 +29,19 @@ group "Reading params from config file" do
 end
 ```
 
-* [get](../dsl/get.md) keyword read params from configuration file. It's posible personalize tests with diferent values for every case.
+* [get](../dsl/get.md) keyword read params values from configuration file. It's posible personalize tests with diferent values for every case.
 
 ## Example
 
-```console
-> teuton run examples/04-config
+```
+$ teuton run examples/04-config
 
 CASE RESULTS
-+------+----------------+-------+-------+
-| CASE | MEMBERS        | GRADE | STATE |
-| 01   | name_student_1 | 100.0 | ✔     |
-| 02   | name_student_2 | 0.0   | ?     |
-+------+----------------+-------+-------+
++------+-----------+-------+-------+
+| CASE | MEMBERS   | GRADE | STATE |
+| 01   | student_1 | 100.0 | ✔     |
+| 02   | student_2 | 0.0   | ?     |
++------+-----------+-------+-------+
 ```
 
 Reports:
@@ -57,16 +57,16 @@ var/04-config
 Let's see case 01 report.
 
 ```
-> more var/04-config/case-01.txt
+$ more var/04-config/case-01.txt
 
 CONFIGURATION
-+-------------+----------------+
-| tt_members  | name_student_1 |
-| tt_sequence | false          |
-| tt_skip     | false          |
-| tt_testname | 04-config      |
-| username    | david          |
-+-------------+----------------+
++-------------+------------+
+| tt_members  | student_1  |
+| tt_sequence | false      |
+| tt_skip     | false      |
+| tt_testname | 04-config  |
+| username    | david      |
++-------------+------------+
 
 GROUPS
 - Reading params from config file
@@ -95,10 +95,10 @@ RESULTS
 
 ## Using differents configuration files
 
-Example with 3 config files (yaml files):
+Example with 3 differents config files (yaml files):
 
 ```
-❯ tree examples/04-config
+$ tree examples/04-config
 
 examples/04-config
 ├── config.yaml
@@ -107,23 +107,21 @@ examples/04-config
 └── starwars.yaml
 ```
 
-Usign default config file (`config.yaml`):
-
+**Example 1**: Run test usign default config file (`config.yaml`).
 ```
-❯ teuton run examples/04-config
+$ teuton run examples/04-config
 
 CASE RESULTS
-+------+----------------+-------+-------+
-| CASE | MEMBERS        | GRADE | STATE |
-| 01   | name_student_1 | 100.0 | ✔     |
-| 02   | name_student_2 | 0.0   | ?     |
-+------+----------------+-------+-------+
++------+-----------+-------+-------+
+| CASE | MEMBERS   | GRADE | STATE |
+| 01   | student_1 | 100.0 | ✔     |
+| 02   | student_2 | 0.0   | ?     |
++------+-----------+-------+-------+
 ```
 
-Using `example/04-config/starwars.yaml`:
-
+**Example 2**: Run test using `example/04-config/starwars.yaml` config file. 
 ```
-❯ teuton run --cname=starwars examples/04-config
+$ teuton run --cname=starwars examples/04-config
 
 CASE RESULTS
 +------+------------+-------+-------+
@@ -133,10 +131,9 @@ CASE RESULTS
 +------+------------+-------+-------+
 ```
 
-Using `example/04-config/rock.yaml`:
-
+**Example 3**: Run test using `example/04-config/rock.yaml` config file.
 ```
-❯ teuton run --cpath=examples/04-config/rock.yaml examples/04-config
+$ teuton run --cpath=examples/04-config/rock.yaml examples/04-config
 
 CASE RESULTS
 +------+------------+-------+-------+

data/docs/learn/05-use.md

@@ -2,14 +2,15 @@
 
 # use
 
-`use` keyword allow us organize huge amount of groups/targets into several files.
+`use` keyword allow us organize huge amount of groups/targets into differents files.
 
 ## Example
 
 > This example requires Windows OS on remote machine.
 
-```bash
-❯ tree examples/05-use
+```
+$ tree examples/05-use
+
 examples/05-use
 ├── lib
 │   ├── network.rb
@@ -18,7 +19,7 @@ examples/05-use
 └── start.rb
 ```
 
-* `start.rb` file is now splited into: `start.rb`, `users.rb` and `network.rb`.
+* The content is now splited into: `start.rb`, `users.rb` and `network.rb`.
 
 ```ruby
 # File: start.rb

data/docs/learn/06-cmd_check.md

@@ -3,10 +3,12 @@
 
 # check test
 
-Check Teuton check syntax and show statistics.
+`teuton check DIRPATH` is a command function that checks syntax and show statistics.
+
+## Example
 
 ```
-❯ teuton check examples/05-use     
+$ teuton check examples/05-use     
 
 +--------------------------+
 | GROUP: Using file: users |

data/docs/learn/07-target_weight.md

@@ -2,7 +2,13 @@
 
 # Target weight
 
-* Changing default target weight:
+`weight` is param used by `target` keyword to define weight target value.
+
+## Example
+
+Changing default target weight:
+* The first target has the default weight (1.0).
+* The second target has a weight of 2.0.
 
 ```ruby
 # File: network.rb
@@ -18,15 +24,8 @@ group "Using file: network" do
 end
 ```
 
+Output:
 ```
-+--------------------------+
-| GROUP: Using file: users |
-+--------------------------+
-(001) target      Create user get(username)
-      weight      1.0
-      run         'id get(username)' on host1
-      expect      ["uid=", "(get(username))", "gid="] (Array)
-
 +----------------------------+
 | GROUP: Using file: network |
 +----------------------------+

data/docs/learn/08-unique_values.md

@@ -2,7 +2,9 @@
 
 # Unique value
 
-* `unique NAME, VALUE` keyword defines unique values.
+`unique` keyword defines a value that must be unique in all cases.
+
+* Usage: `unique NAME, VALUE`. NAME is the param name, and VALUE is the value that must be unique.
 * All cases that do not comply with this requirement will obtain a score of 0 and it will be reflected in the reports.
 
 Example:
@@ -20,7 +22,7 @@ end
 Cheking test:
 
 ```
-❯ teuton check examples/08-unique_values
+$ teuton check examples/08-unique_values
 
 +--------------------------+
 | GROUP: Using file: users |

data/docs/learn/09-send.md

@@ -2,8 +2,7 @@
 
 # Send
 
-* [export](../dsl/export.md) keyword generate reports into diferents formats:
-* [send](../dsl/send.md) keyword send report copies to every remote host.
+`send` is a keyword used to copy the output report into remote host.
 
 ## Example
 
@@ -16,5 +15,6 @@ end
 ```
 
 * `show`, show process log on screen.
-* `export`, create reports with `txt` format.
-* `send copy_to: :host1`, copy output report into remote machine (host1).
+* [export](../dsl/export.md), create reports with `txt` format.
+* [send copy_to: :host1](../dsl/send.md), copy output report into remote machine (host1).
+* `host1`, is a set params defined into config file (host1_ip, host1_username, host1_password, etc.)

data/docs/learn/10-debug.md

@@ -2,10 +2,14 @@
 
 # debug
 
-* Debug your tests.
+`result.debug` is an instrucction used to debug your tests.
+
+## Introduction
+
+Tests grows and becames huge, with a lot of targets (That isn't a problem). Then, we organize them spliting into several files and invoke `use` keywork from our main rb file to load other files (That's good idea).
 
 ```
-> tree examples/10-debug
+$ tree examples/10-debug
 
 examples/10-debug
 ├── config.yaml
@@ -14,11 +18,9 @@ examples/10-debug
 └── start.rb
 ```
 
-Tests grows and becames huge, with a lot of targets (That isn't a problem). Then, we organize them spliting into several files and invoke `use` keywork from our main rb file to load other files (That's good idea).
-
-Sometimes we need to verify or check rb file consistency and syntax, and we will do it with `teuton check PATH/TO/PROJECT/FOLDER`.
+Sometimes we need to verify or check rb file consistency and syntax, and we will do it with `teuton check DIRPATH`.
 
-## Debug
+## Explication
 
 Every time we invoke `run` keywork, an OS command is executed. The output is showed on screen and saved into **result** internal object.
 

data/docs/learn/11-export.md

@@ -2,9 +2,12 @@
 
 # Export
 
-* [export](../dsl/export.md) keyword generate reports into diferents formats:
+[export](../dsl/export.md) keyword generates output reports into diferents formats.
+
+Available formats: colored_text, html, json, markdown, txt, xml, yaml.
+
+## Example
 
-Example
 ```ruby
 play do
   show
@@ -19,10 +22,10 @@ end
 * `export format: :html`, create reports with `html` format.
 * `export format: :json`, create reports with `json` format.
 
-Firs run `teuton examples/11-export`, then we have:
+Firs run `teuton examples/11-export`, then we have this files:
 
 ```
-❯ tree var/11-export
+$ tree var/11-export
 
 var/11-export
 ├── case-01.html

data/docs/learn/12-preserve.md

@@ -1,15 +1,18 @@
 [<< back](README.md)
 
-# Example: 09-preserve
+# preserve
+
+`preserve` is an option of `export` keyword used to keep older report copies.
 
 Every time we run teuton test, older output report files are overwritten with new reports. if you want to preserve old versions then use `preserve`.
 
-With `preserve` option we keep older copies.
+Usage: `export preserve: true`
+
+## Example
 
-1. [Execution section](#execution-section)
-2. [Result](#result)
+Example files in the `examples/12-preserve` folder.
 
-## Execution section
+**Execution section**
 
 Take a look at our test execution section (Play):
 ```ruby
@@ -19,15 +22,15 @@ play do
 end
 ```
 
-> More information about [export](../dsl/execution/export.md) keyword.
+> More information about [export](../dsl/export.md) keyword.
 
-## Result
+**Result**
 
-Example, executing `teuton run example/09-preserve` twice:
+Example, executing `teuton run example/12-preserve` twice:
 
 ```
 var
-└── learn-09-preserve
+└── 12-preserve
     ├── 20200519-113035
     │   ├── case-01.txt
     │   ├── moodle.csv
@@ -41,4 +44,4 @@ var
     └── resume.txt
 ```
 
-* The first time test was launched at 11:30, and second at 12:30 the same day.
+The first time test was launched at 11:30, and second at 12:30 the same day.

data/lib/teuton/case/dsl/expect_sequence.rb

@@ -37,8 +37,8 @@ class ExpectSequence
 
   def find_best_state
     @states.each do |state|
-      state[:score] = state[:steps].count { _1 }
-      state[:fails] = state[:steps].count { !_1 }
+      state[:score] = state[:steps].count { |value| value }
+      state[:fails] = state[:steps].count { |value| !value }
       state[:ok] = state[:fails].zero?
     end
     best = @states[0]

data/lib/teuton/case_manager/case_manager.rb

@@ -3,20 +3,20 @@ require_relative "../report/report"
 require_relative "../utils/project"
 require_relative "../utils/verbose"
 require_relative "../utils/configfile_reader"
+require_relative "check_cases"
 require_relative "export_manager"
 require_relative "send_manager"
 require_relative "show_report"
-require_relative "check_cases"
 require_relative "report"
 require_relative "utils"
 
 # * initialize
 # * play
 # Split into several files:
-# * case_manager/check_cases
-# * case_manager/export
-# * case_manager/hall_of_fame
-# * case_manager/report
+# * check_cases
+# * export_manager
+# * send_manager
+# * show_report
 class CaseManager
   include Utils
   include Verbose

data/lib/teuton/case_manager/dsl.rb

@@ -37,9 +37,9 @@ def use(filename)
   begin
     require_relative findfiles.first
     Project.value[:uses] << File.basename(findfiles.first)
-  rescue StandardError
-    puts "[ERROR] Unknown file : #{filename}"
-    puts "        Check line   : use '#{filename}'"
+  rescue => e
+    puts "[ERROR] #{e}:"
+    puts "        File not found! Fix line <use '#{filename}'>"
     exit 1
   end
 end

data/lib/teuton/case_manager/export_manager.rb

@@ -30,7 +30,7 @@ class ExportManager
     unless Formatter.available_formats.include? options[:format]
       puts Rainbow("[WARN] ExportManager:").yellow.bright
       puts Rainbow("       Unkown format <#{options[:format]}>. Fix line <export format: FORMAT>.").yellow.bright
-      puts Rainbow("       Available formats: #{Formatter.available_formats.join(",")}.").yellow.bright
+      puts Rainbow("       Available formats: #{Formatter.available_formats.join(", ")}.").yellow.bright
       puts Rainbow("[INFO] Using default format <txt>.").yellow.bright
       options[:format] = :txt
     end

data/lib/teuton/case_manager/report.rb

@@ -9,8 +9,6 @@ class CaseManager
   # Open main report (resume report)
   # @param config_filepath (String)
   def open_main_report(config_filepath)
-    # app = Application.instance
-
     @report.head[:tt_title] = "Teuton (#{Teuton::VERSION})"
     @report.head[:tt_scriptname] = trim(Project.value[:script_path])
     @report.head[:tt_configfile] = trim(config_filepath)
@@ -31,7 +29,6 @@ class CaseManager
     verboseln Rainbow("-" * 36).green
     verboseln " "
 
-    # app = Application.instance
     @cases.each do |c|
       line = {}
       if c.skip?

data/lib/teuton/check/show.rb

@@ -61,7 +61,7 @@ class ShowCheck
       end
       if Project.value[:macros].size.positive?
         st.add_row ["Macros", Project.value[:macros].size]
-        Project.value[:macros].each_key { st.add_row ["", it] }
+        Project.value[:macros].each_key { |value| st.add_row ["", value] }
       end
       st.add_row ["Groups", @stats[:groups]]
       st.add_row ["Targets", @stats[:targets]]
@@ -87,11 +87,12 @@ class ShowCheck
 
       if @stats[:sets].size.positive?
         st.add_row ["Sets", @stats[:sets].size]
-        @stats[:sets].each { st.add_row ["", it] }
+        @stats[:sets].each { |value| st.add_row ["", value] }
       end
       if @stats[:uploads].size.positive?
         st.add_row ["Uploads", @stats[:uploads].size]
-        @stats[:uploads].each { st.add_row ["", it] }
+        uploads = @stats[:uploads].select { _1 }
+        uploads.each { |value| st.add_row ["", value] }
       end
     end
     Logger.info my_screen_table.to_s + "\n"
@@ -114,7 +115,7 @@ class ShowCheck
         script_vars << k.to_s + "_password"
       end
     end
-    @stats[:gets].keys.each { script_vars << it }
+    @stats[:gets].keys.each { |value| script_vars << value }
     script_vars
   end
 end

data/lib/teuton/files/config.yaml

@@ -1,4 +1,4 @@
 ---
 global:
 cases:
-- tt_members: NAMES_TO-CHANGE
+- tt_members: TOCHANGE

data/lib/teuton/files/start.rb

@@ -1,7 +1,7 @@
-group "NAME-TO-CHANGE" do
-  target "DESC_TO-CHANGE"
-  run "COMMAND_TO-CHANGE"
-  expect "TEXT_TO-CHANGE"
+group "TOCHANGE" do
+  target "TOCHANGE"
+  run "TOCHANGE"
+  expect "TOCHANGE"
 end
 
 play do

data/lib/teuton/report/formatter/default/markdown.rb

@@ -0,0 +1,90 @@
+require_relative "array"
+
+class MarkdownFormatter < ArrayFormatter
+  def initialize(report)
+    super
+    @ext = "md"
+    @data = {}
+  end
+
+  def process(options = {})
+    build_data(options)
+    process_config
+    process_logs
+    process_groups
+    process_results
+    process_hof
+    deinit
+  end
+
+  private
+
+  def process_config
+    w "# CONFIGURATION\n\n"
+    w "| Param | Value |\n"
+    w "| ----- | ----- |\n"
+    @data[:config].sort.each { |key, value| w "| #{key} | #{value} |\n" }
+    w "\n"
+  end
+
+  def process_logs
+    return if @data[:logs].empty?
+
+    w "# LOGS\n\n"
+    @data[:logs].each { |line| w "* #{line}\n" }
+    w "\n"
+  end
+
+  def process_groups
+    return if @data[:groups].empty?
+
+    w "# GROUPS\n\n"
+    @data[:groups].each { |g| process_group g }
+    w "\n"
+  end
+
+  def process_results
+    w "# RESULTS\n\n"
+    w "| Param | Value |\n"
+    w "| ----- | ----- |\n"
+    @data[:results].sort.each { |key, value| w "| #{key} | #{value} |\n" }
+    w "\n"
+  end
+
+  def process_hof
+    return if @data[:hall_of_fame].size < 3
+
+    w "# HALL OF FAME\n\n"
+    w "| Grade | Amount |\n"
+    w "| ----- | ------ |\n"
+    @data[:hall_of_fame].each do |grade, amount|
+      if grade == @data[:results][:grade]
+        w "| **#{grade}** | **#{amount}** |\n"
+      else
+        w "| #{grade} | #{amount} |\n"
+      end
+    end
+    w "\n"
+  end
+
+  private
+
+  def process_group(group)
+    tab = "  "
+    w "* **#{group[:title]}**\n"
+    group[:targets].each do |i|
+      style = "**"
+      style = "" if i[:check]
+      w "#{tab * 1}* #{format("%02d", i[:target_id].to_i)}"
+      text = "#{i[:score]}/#{i[:weight]}"
+      w " #{style}(#{text})#{style}\n"
+      w "#{tab * 2} * Description : #{i[:description]}\n"
+      w "#{tab * 2} * Command     : #{i[:command]}\n"
+      w "#{tab * 2} * Output      : #{i[:output]}\n"
+      w "#{tab * 2} * Duration    : #{i[:duration]} (#{i[:conn_type]})\n"
+      w "#{tab * 2} * Alterations : #{i[:alterations]}\n"
+      w "#{tab * 2} * Expected    : #{i[:expected]}\n"
+      w "#{tab * 2} * Result      : #{i[:result]}\n"
+    end
+  end
+end

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

@@ -2,12 +2,14 @@ require "rainbow"
 require_relative "default/colored_text"
 require_relative "default/html"
 require_relative "default/json"
+require_relative "default/markdown"
 require_relative "default/txt"
 require_relative "default/xml"
 require_relative "default/yaml"
 require_relative "resume/colored_text"
 require_relative "resume/html"
 require_relative "resume/json"
+require_relative "resume/markdown"
 require_relative "resume/txt"
 require_relative "resume/yaml"
 require_relative "moodle_csv_formatter"
@@ -17,6 +19,7 @@ module Formatter
     colored_text: ColoredTextFormatter,
     html: HTMLFormatter,
     json: JSONFormatter,
+    markdown: MarkdownFormatter,
     txt: TXTFormatter,
     xml: XMLFormatter,
     yaml: YAMLFormatter,
@@ -24,13 +27,14 @@ module Formatter
     resume_colored_text: ResumeColoredTextFormatter,
     resume_html: ResumeHTMLFormatter,
     resume_json: ResumeJSONFormatter,
+    resume_markdown: ResumeMarkdownFormatter,
     resume_txt: ResumeTXTFormatter,
     resume_xml: ResumeTXTFormatter, # TODO
     resume_yaml: ResumeYAMLFormatter
   }
 
   def self.available_formats
-    LIST.keys.take(6)
+    LIST.keys.take(7)
   end
 
   def self.call(report, options, filename)

data/lib/teuton/report/formatter/resume/markdown.rb

@@ -0,0 +1,84 @@
+require_relative "array"
+
+class ResumeMarkdownFormatter < ResumeArrayFormatter
+  MIN_HALL_OF_FAME = 3
+
+  def initialize(report)
+    super
+    @ext = "md"
+    @data = {}
+  end
+
+  def process(options = {})
+    build_data(options)
+    process_config
+    process_cases
+    process_conn_errors
+    process_results
+    process_hof
+    deinit
+  end
+
+  private
+
+  def process_config
+    w "# CONFIGURATION\n\n"
+    w "| Param | Value |\n"
+    w "| ----- | ----- |\n"
+    @data[:config].each { |key, value| w("| #{key} | #{trim(value)} |\n") }
+    w "\n"
+  end
+
+  def process_cases
+    w "# CASES\n\n"
+    w "| CASE | MEMBERS | GRADE | STATE |\n"
+    w "| ---- | ------- | ----- | ----- |\n"
+    @data[:cases].each do |line|
+      grade = format("  %<grade>3d", {grade: line[:grade]})
+      w "| #{line[:id]} | #{line[:members]} | #{grade} | #{line[:letter]} |\n"
+    end
+    w "\n"
+  end
+
+  def process_conn_errors
+    lines = []
+    lines << "# CONN ERRORS"
+    lines << ""
+    lines << "| CASE | MEMBERS | HOST | ERROR |"
+    lines << "| ---- | ------- | ---- | ----- |"
+    @data[:cases].each do |line|
+      line[:conn_status].each_pair do |h, e|
+        lines << "| #{line[:id]} | #{line[:members]} | #{h} | **#{e}** |\n"
+      end
+    end
+
+    if lines.size > 4
+      w lines.join("\n")
+      w "\n\n"
+    end
+  end
+
+  def process_results
+    w "# RESULTS\n\n"
+    w "| Param | Value |\n"
+    w "| ----- | ----- |\n"
+    @data[:results].each { |key, value| w("| #{key} | #{value} |\n") }
+    w "\n"
+  end
+
+  def process_hof
+    return if @data[:hall_of_fame].size < MIN_HALL_OF_FAME
+
+    w "# HALL OF FAME\n\n"
+    w "| Grade | Amount |\n"
+    w "| ----- | ------ |\n"
+    @data[:hall_of_fame].each do |grade, amount|
+      if line[0] == @data[:results][:grade]
+        w " | **#{grade}** | **#{amount}** |\n"
+      else
+        w " | #{grade} | #{amount} |\n"
+      end
+    end
+    w "\n"
+  end
+end

data/lib/teuton/report/report.rb

@@ -9,14 +9,12 @@ class Report
   def initialize(id = "00")
     @id = id
     @filename = "case-#{@id}"
-    # @output_dir = Application.instance.output_basedir
     @output_dir = Project.value[:output_basedir]
     @head = {}
     @lines = []
-    @tail = {}
-    # @history save 1 letter for every target.
+    @tail = {unique_fault: 0}
+    # [String] with 1 char for every target in @lines
     # For example: "..F." means: good, good, fail and good
-    # I will use this in the future stats manager.
     @history = ""
   end
 
@@ -55,10 +53,7 @@ class Report
   # * fail_weight
   # * fail_counter
   def close
-    max = 0.0
-    good = 0.0
-    fail = 0.0
-    fail_counter = 0
+    max = good = fails = fail_counter = 0
     @lines.each do |i|
       next unless i.instance_of? Hash
 
@@ -67,14 +62,14 @@ class Report
         good += i[:weight]
         @history += Settings.letter[:good]
       else
-        fail += i[:weight]
+        fails += i[:weight]
         fail_counter += 1
         @history += Settings.letter[:bad]
       end
     end
     @tail[:max_weight] = max
     @tail[:good_weight] = good
-    @tail[:fail_weight] = fail
+    @tail[:fail_weight] = fails
     @tail[:fail_counter] = fail_counter
 
     i = good.to_f / max

data/lib/teuton/version.rb

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

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 2.10.6
+  version: 2.10.7
 platform: ruby
 authors:
 - David Vargas Ruiz
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -121,11 +122,11 @@ executables:
 - teuton
 extensions: []
 extra_rdoc_files:
-- LICENSE
 - README.md
+- LICENSE
 - docs/commands/README.md
 - docs/commands/check-example.md
-- docs/commands/howto-run-tests.md
+- docs/commands/run-tests.md
 - docs/devel/diagram.md
 - docs/dsl/README.md
 - docs/dsl/expect.md
@@ -189,7 +190,7 @@ files:
 - bin/teuton
 - docs/commands/README.md
 - docs/commands/check-example.md
-- docs/commands/howto-run-tests.md
+- docs/commands/run-tests.md
 - docs/devel/diagram.md
 - docs/dsl/README.md
 - docs/dsl/expect.md
@@ -320,6 +321,7 @@ files:
 - lib/teuton/report/formatter/default/colored_text.rb
 - lib/teuton/report/formatter/default/html.rb
 - lib/teuton/report/formatter/default/json.rb
+- lib/teuton/report/formatter/default/markdown.rb
 - lib/teuton/report/formatter/default/txt.rb
 - lib/teuton/report/formatter/default/xml.rb
 - lib/teuton/report/formatter/default/yaml.rb
@@ -329,6 +331,7 @@ files:
 - lib/teuton/report/formatter/resume/colored_text.rb
 - lib/teuton/report/formatter/resume/html.rb
 - lib/teuton/report/formatter/resume/json.rb
+- lib/teuton/report/formatter/resume/markdown.rb
 - lib/teuton/report/formatter/resume/txt.rb
 - lib/teuton/report/formatter/resume/yaml.rb
 - lib/teuton/report/report.rb
@@ -344,6 +347,7 @@ homepage: https://github.com/teuton-software/teuton
 licenses:
 - GPL-3.0
 metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -351,14 +355,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.9
+      version: 3.2.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Teuton (Infrastructure test)
 test_files: []