teuton 2.10.6 → 2.10.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9a1b6762cc25c63b89aaa6e2d1fa0a245a3451a9aad17c142d1577db0686df8
-  data.tar.gz: af350833b0f89946123adc26f35aedaab554e44953ea50a21bb2fdb2c8d4e4be
+  metadata.gz: a5b35750a1b166a54ba8f1c2f8dfdf82b8f1bbeb10dbc26c954aa926ebf47209
+  data.tar.gz: 06363a74c993cfe89d182a6f8473d7f713f3351da16e2f397fe9f7dfd327c049
 SHA512:
-  metadata.gz: 31109462bb8cb4cae1cdacfcde8d396393a64a08cc37c44fb7926475b2379ae1cde1acdcb17c671ebd7b332b9ce15737f5f31b5b707d68f02fd1837b00df6545
-  data.tar.gz: 228d4bfbce686c1a2dafcd0edbcb40f375dd69e1cfd8b49db3523e36a4de5db92a5dbc6e949f62b593e3cd0223d1dbc1371f2d9d5d75f49264af02bf40e35de9
+  metadata.gz: ec53a0570321130474a302b5863d470b8e99f051eaad3070a367374dfbeddda4e3cab5e85af02f8dbf29b9405022a440167920aface1242eed30b49243465ec7
+  data.tar.gz: bac07b9e1d452de58acade93b292cd7edf62e37bede4a2ee05d450816c6068577b7463afe986265559f94529aad0ee2a5d84bae606f46a5619afe911320224c1

data/README.md

@@ -21,21 +21,31 @@ Install Ruby and then:
 gem install teuton
 ```
 
+> **NOTE**
+> * Available versions ([rubygems.org/gems/teuton](https://rubygems.org/gems/teuton/))
+> * Install a specific version: `gem install teuton -v VERSION`.
+> * Update: `gem update teuton`.
+
 # Usage
 
 Use `teuton run TESTPATH` command to run test:
 
 ```console
-> teuton run examples/01-target
-
+$ teuton run examples/02-target
+------------------------------------
+Started at 2025-11-12 20:15:59 +0000
+F.
+Finished in 0.005 seconds
+------------------------------------
+ 
 CASE RESULTS
-+------+-----------+-------+-------+
-| CASE | MEMBERS   | GRADE | STATE |
-| 01   | anonymous | 100.0 | ✔     |
-+------+-----------+-------+-------+
++------+---------+-------+-------+
+| CASE | MEMBERS | GRADE | STATE |
+| 01   | VALUE   | 33.0  | ?     |
++------+---------+-------+-------+
 ```
 
-> More information about [commands](docs/commands/README.md)
+Consult the generated [output files](examples/02-target/output.d/)
 
 # Features
 
@@ -48,7 +58,7 @@ CASE RESULTS
 # Documentation
 
 * [Installation](docs/install/README.md)
-* [Getting started](docs/learn/README.md)
+* [Learning](docs/learn/README.md)
 * [Examples](examples)
 * [Commands](docs/commands/README.md)
 * [Language reference](docs/dsl/README.md)
@@ -68,5 +78,3 @@ CASE RESULTS
 1. Create new Pull Request.
 
 You can also [create issues](https://github.com/teuton-software/teuton/issues) with your requests, incidences or suggestions.
-
-> Read [Spanish documentation](docs/es/README.md)

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,40 +13,37 @@ Usage: `teuton check PATH-TO-TEST-FOLDER`
 
 Example:
 
-```bash
+```
 $ teuton check examples/02-target
 
 +----------------------------+
 | GROUP: Learn about targets |
 +----------------------------+
-(001) target      Create user david
+(001) target      Create user obiwan
+      weight      2.0
+      run         'id obiwan' on localhost
+      expect      ["uid=", "(obiwan)", "gid="] (Array)
+
+(002) target      Delete user vader
       weight      1.0
-      run         'id david' on localhost
-      expect      david (String)
+      run         'id vader' on localhost
+      expect_fail
 
 +--------------+-------+
 | DSL Stats    | Count |
 +--------------+-------+
 | Groups       | 1     |
-| Targets      | 1     |
-| Runs         | 1     |
-|  * localhost | 1     |
-| Uniques      | 0     |
-| Logs         | 0     |
-|              |       |
-| Gets         | 0     |
-| Sets         | 0     |
+| Targets      | 2     |
+| Runs         | 2     |
+|  * localhost | 2     |
 +--------------+-------+
-+----------------------+
-| Revising CONFIG file |
-+----------------------+
 [WARN] Configfile not found
-       /home/david/proy/repos/teuton.d/teuton/examples/02-target/config.yaml
+       /home/.../examples/02-target/config.yaml
 [INFO] Recomended content:
 ---
-:global:
-:cases:
-- :tt_members: VALUE
+global:
+cases:
+- tt_members: VALUE
 ```
 
 The check process notifies that

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