teuton 2.3.11 → 2.4.1

data/docs/learn/02-config.md

@@ -1,19 +1,16 @@
 [<< back](README.md)
 
-# Example: 02-config
+# Example: config
 
-* Learn how to use config file.
-* Use params defined into config files.
-* It's good idea save variable data separated into external config file.
+_It's good idea save variables into config file._
 
-1. [Config file](#config-file).
-2. [Definition section](#definition-section).
-3. [Execution section](#execution-section).
-4. [Results](#results).
+Learn:
+* How to use config file.
+* How to use params defined into config files.
 
 ## Config file
 
-By default, `config.yaml` is our config file. Let's an example:
+By default, `config.yaml` is our default config file. Example:
 
 ```yaml
 ---
@@ -22,12 +19,14 @@ cases:
 - tt_members: Student-name-1
   username: root
 - tt_members: Student-name-2
-  username: vargas
+  username: david
 ```
 
+> **How to choose another config file?** Read this [document](../commands/example_run.md#3-choosing-config-file).
+
 ## Definition section
 
-By default, `start.rb` it's our main execution file.
+By default, `start.rb` it's our main execution file. Example:
 
 ```ruby
 group "Reading params from config file" do
@@ -39,15 +38,14 @@ group "Reading params from config file" do
 end
 ```
 
-In this section we define targets using keywords: target, run, expect and get.
-
-* **get** keyword is used to read params from configuracion file. It's posible personalize tests with diferent values for every case.
+In this section, we define targets using `target`, `run`, `expect` and `get` keywords.
 
-> NOTE: In this example, we assume GNU/Linux as localhost's OS.
+* **get** keyword read params from configuration file. It's posible personalize tests with diferent values for every case.
 
 ## Execution section
 
 Main execution block:
+
 ```ruby
 play do
   show
@@ -55,41 +53,25 @@ play do
 end
 ```
 
-Runing this example and see `show` keyword output:
+This example run test and show (`show` keyword) output on screen:
 
-```bash
-> teuton run --no-color examples/learn-02-config
-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
+```console
+> teuton run examples/02-config
+
+CASE RESULTS
 +------+----------------+-------+-------+
 | CASE | MEMBERS        | GRADE | STATE |
-| 01   | Student-name-1 |   100 |       |
-| 02   | Student-name-2 |     0 | ?     |
+| 01   | Student-name-1 | 100.0 | ✔     |
+| 02   | Student-name-2 | 0.0   | ?     |
 +------+----------------+-------+-------+
-
-RESULTS
-+-------------+---------------------------+
-| start_time  | 2020-10-10 12:37:54 +0100 |
-| finish_time | 2020-10-10 12:37:54 +0100 |
-| duration    | 0.002054143               |
-+-------------+---------------------------+
 ```
 
 ## Results
 
-Output reports are saved into `var/learn-02-config/` directory. Detail output report is created for every case.
+Output reports are saved into `var/02-config/` directory. Detail output report is created for every case.
 
 ```
-var/learn-02-config
+var/02-config
 ├── case-01.txt
 ├── case-02.txt
 ├── moodle.csv
@@ -99,23 +81,22 @@ var/learn-02-config
 Let's see `export` keyword output for case 01.
 
 ```
-> more var/learn-02-config/case-01.txt
+> more var/02-config/case-01.txt
 CONFIGURATION
-+-------------+-----------------+
-| tt_members  | Student-name-1  |
-| tt_sequence | false           |
-| tt_skip     | false           |
-| tt_testname | learn-02-config |
-| username    | root            |
-+-------------+-----------------+
-
++-------------+----------------+
+| tt_members  | Student-name-1 |
+| tt_sequence | false          |
+| tt_skip     | false          |
+| tt_testname | 02-config      |
+| username    | root           |
++-------------+----------------+
 
 GROUPS
 - Reading params from config file
     01 (1.0/1.0)
-        Description : Create user root (username)
+        Description : Create user root
         Command     : id root
-        Duration    : 0.001 (local)
+        Duration    : 0.002 (local)
         Alterations : find(root) & count
         Expected    : Greater than 0 (String)
         Result      : 1 (Integer)
@@ -123,9 +104,9 @@ GROUPS
 RESULTS
 +--------------+---------------------------+
 | case_id      | 01                        |
-| start_time   | 2020-10-10 12:37:54 +0100 |
-| finish_time  | 2020-10-10 12:37:54 +0100 |
-| duration     | 0.001762191               |
+| start_time   | 2022-12-24 13:33:49 +0000 |
+| finish_time  | 2022-12-24 13:33:49 +0000 |
+| duration     | 0.001777756               |
 | unique_fault | 0                         |
 | max_weight   | 1.0                       |
 | good_weight  | 1.0                       |
@@ -134,5 +115,3 @@ RESULTS
 | grade        | 100                       |
 +--------------+---------------------------+
 ```
-
-> **How to choose another config file?** Read this [document](../commands/example_run.md#3-choosing-config-file).

data/docs/learn/03-remote_hosts.md

@@ -81,11 +81,30 @@ end
 
 * `send copy_to: :host1` keyword copy output report into remote machine (host1).
 
+## Screen output
+
+```
+CASE RESULTS
++------+---------------+-------+-------+
+| CASE | MEMBERS       | GRADE | STATE |
+| 01   | Darth Maul    | 0.0   | ?     |
+| -    | -             | 0.0   |       |
+| 03   | Obiwan Kenobi | 0.0   | ?     |
++------+---------------+-------+-------+
+
+CONN ERRORS
++------+---------------+-------+------------------+
+| CASE | MEMBERS       | HOST  | ERROR            |
+| 01   | Darth Maul    | host1 | host_unreachable |
+| 03   | Obiwan Kenobi | host1 | host_unreachable |
++------+---------------+-------+------------------+
+```
+
 ## Results
 
 ```
 var
-└── learn-03-remote-hosts
+└── 03-remote-hosts
     ├── case-01.json
     ├── case-01.txt
     ├── case-03.json

data/docs/learn/04-new_test.md

@@ -13,8 +13,8 @@ Steps:
 
 Create skeleton for a new project: `teuton create foo`
 
-```bash
-$ teuton new foo
+```
+> teuton new foo
 
 [INFO] Creating foo project skeleton
 * Create dir        => foo
@@ -22,7 +22,7 @@ $ teuton new foo
 * Create file       => foo/start.rb
 ```
 
-> It's posible to create these files by hand.
+> NOTA: It is posible to create these files by hand.
 
 This command will create:
 
@@ -81,7 +81,7 @@ Use a YAML file (`foo/config.yaml`) or JSON for your own configurations. In this
 Now we only have to run the challenge:
 
 ```bash
-$ teuton foo
+> teuton run foo
 ```
 
 Output files are saved into `var/foo` directory.

data/docs/learn/05-use.md

@@ -16,8 +16,9 @@ Learn how to:
 This example has more files:
 
 ```bash
-$ tree example/learn-04-use
-example/learn-04-require
+> tree example/04-use
+
+example/04-require
 ├── config.yaml
 ├── network.rb
 ├── README.md
@@ -25,8 +26,6 @@ example/learn-04-require
 └── users.rb
 ```
 
-* `README.md` and `config.yaml` are the same as previous example.
-
 ## Execution section
 
 Previous `start.rb` file is now splited in: start.rb, users.rb and network.rb.

data/docs/learn/06-debug.md

@@ -14,8 +14,9 @@ Learn how to:
 
 ## Tree directory
 
-```bash
-$ tree learn/learn-06-debug
+```
+> tree learn/learn-06-debug
+
 example/learn-06-debug
 ├── config.yaml
 ├── external.rb
@@ -48,12 +49,7 @@ When this happend, sometimes we need to verify or check rb file consistency and
 
 Let's see example `teuton check examples/learn-01-target`:
 
-```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] TestName   => learn-01-target
-
+```
 +----------------------------+
 | GROUP: Learn about targets |
 +----------------------------+
@@ -78,12 +74,13 @@ Let's see example `teuton check examples/learn-01-target`:
 +----------------------+
 | Revising CONFIG file |
 +----------------------+
-[WARN] File ./examples/learn-01-target/config.yaml not found!
+[WARN] File /home/david/proy/repos/teuton.d/teuton/examples/01-target/config.yaml not found!
 [INFO] Recomended content:
 ---
 :global:
 :cases:
 - :tt_members: VALUE
+
 ```
 
 In this case, Teuton detects that there isn't exist config file, and propose us content for `config.yaml`.

data/docs/learn/07-log.md

@@ -27,27 +27,27 @@ end
 
 ## Result
 
-**Let's see example**: Content of `var/learn-07-log/case-01.txt` file.
+**Let's see example**: Content of `var/07-log/case-01.txt` file.
 
-```bash
+```
 CONFIGURATION
-+-------------+--------------+
-| tt_members  | anonymous    |
-| tt_sequence | false        |
-| tt_skip     | false        |
-| tt_testname | learn-07-log |
-+-------------+--------------+
++-------------+-----------+
+| tt_members  | anonymous |
+| tt_sequence | false     |
+| tt_skip     | false     |
+| tt_testname | 07-log    |
++-------------+-----------+
 
 LOGS
-    [19:23:20] : Using log messages...
-    [19:23:20] ERROR: Problem detected!
+    [13:45:02] : Using log messages...
+    [13:45:02] ERROR: Problem detected!
 
 GROUPS
 - Learning about log messages
     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)
@@ -55,9 +55,9 @@ GROUPS
 RESULTS
 +--------------+---------------------------+
 | case_id      | 01                        |
-| start_time   | 2020-04-22 19:23:20 +0100 |
-| finish_time  | 2020-04-22 19:23:20 +0100 |
-| duration     | 0.003096755               |
+| start_time   | 2022-12-24 13:45:02 +0000 |
+| finish_time  | 2022-12-24 13:45:02 +0000 |
+| duration     | 0.001900685               |
 | unique_fault | 0                         |
 | max_weight   | 1.0                       |
 | good_weight  | 1.0                       |

data/docs/learn/08-readme.md

@@ -1,6 +1,6 @@
 [<< back](README.md)
 
-# Example: 07-readme
+# Example: readme
 
 Create README files (with test instructions) from our test definition.
 
@@ -35,15 +35,15 @@ There exists some `readme` instructions after `group` and `target` lines.
 To generate automatically a README file from previous test, execute this:
 
 ```
-teuton readme example/learn-08-readme > example/learn-08-readme/README.md
+teuton readme example/08-readme > example/08-readme/README.md
 ```
 
 ## Result
 
-**Let's see the output**: Content of `example/learn-08-readme/README.md` file.
+**Let's see the output**: Content of `example/08-readme/README.md` file.
 
 ---
-# learn-08-readme
+# 08-readme
 
 ## Customize readme output
 

data/docs/learn/09-preserve.md

@@ -23,7 +23,7 @@ end
 
 ## Result
 
-Example, executing `teuton run example/learn-09-preserve` twice:
+Example, executing `teuton run example/09-preserve` twice:
 
 ```
 var

data/docs/learn/13-include.md

@@ -2,13 +2,17 @@
 
 # Example: 13-include
 
-Until now, all the tests we have seen came with a configuration file (`config.yaml`) that contained all the parameters that will later be used in the test. It is also possible to have the information distributed among several configuration files.
+Use `tt-include` to include several config files into your main config file.
+
+## Explanation
+
+Until now, all the examples we have seen use one configuration file (`config.yaml`) that contain all the parameters required by the test. It is possible to save configuration distributed among several files.
 
 Suppose we have the following file structure.
 
 ```
 ├── config.yaml
-├── include_this_files
+├── moreconfigfiles
 │   ├── 02
 │   │   └── file02.yaml
 │   ├── file01.yaml
@@ -16,15 +20,15 @@ Suppose we have the following file structure.
 └── start.rb
 ```
 
-`config.yaml` will be the main config file. Using `tt_include` parameter, we define a folder where the rest of the configuration files will be.
+`config.yaml` will be the main config file. We have defined `tt_include` parameter with a folder wich contains more configuration files.
 
-In this example the contents of the files in the include_this_files folder will be included in the configuration:
+In this example the contents of all files in `moreconfigfiles` folder will be included when reading the config parameters:
 
 ```yaml
 ---
 # Fiel: config.yaml
 :global:
-  :tt_include: include_this_files
+  :tt_include: moreconfigfiles
 :cases:
 ```
 
@@ -41,19 +45,22 @@ CASE RESULTS
 +------+---------+-------+-------+
 ```
 
-Config files into `include_this_files` folder:
+Config files into `moreconfigfiles` folder:
 
 ```yaml
+# moreconfigfiles/file01.yaml
 :tt_members: file01
 :username: root
 ```
 
 ```yaml
+# moreconfigfiles/02/file02.yaml
 :tt_members: file02
 :username: quigon
 ```
 
 ```yaml
+# moreconfigfiles/file03.yml
 :tt_members: file03
 :username: vader
 ```

data/docs/learn/14-alias.md

@@ -2,7 +2,11 @@
 
 # Example: 14-alias
 
-Supongamos que tenemos un test como el siguiente:
+By using aliases we can adapt a configuration file, so that it can be used with many different tests.
+
+## Exanation
+
+Suppose we have a test like the following:
 
 ```ruby
 group "Using alias" do
@@ -16,14 +20,14 @@ group "Using alias" do
 end
 ```
 
-Tenemos sólo 2 targets pero podríamos tener muchos más.
+> REMEMBER:
+> * We only have 2 targets but we could have many more.
+> * `_username` is equivalent to `get(:username)`
 
-> Recordemos que `_username` es equivalente a `get(:username)`
-
-Sabemos que el fichero de configuración debe definir los valores para los parámetros `super` y `username`. Queremos aprovechar un fichero de configuración que ya teníamos de otro test, pero tiene el siguiente contenido:
+Our test requires the `super` parameter but the configuration file has named it as `superuser`. Our configuration file define values for `supername` and `username` parameters. Let's see:
 
 ```yaml
-# Version 1
+# First version
 # File: config.yaml
 global:
 cases:
@@ -32,10 +36,10 @@ cases:
   username: obiwan
 ```
 
-Podemos comprobar que nuestro test require el parámetro `super` pero el fichero de configuración lo ha nombrado como `superuser`.
+We would like to take advantage of a configuration file that we already had from another test, without big changes. So we add an `alias`:
 
 ```yaml
-# Version 2
+# Alias Version
 # File: config.yaml
 alias:
   super: :superuser
@@ -45,3 +49,5 @@ cases:
   superuser: root
   username: obiwan
 ```
+
+Now our test will work correctly. Calling `get(:super)` will return the same value as doing `get(:superuser).

data/docs/learn/17-hide-feedback.md

@@ -0,0 +1,52 @@
+[<< back](README.md)
+
+# Example: 17-hide-feedback
+
+When exporting with `feedback: false` option we hide some items from exported reports. Hiden items: command, alterations, expected and result.
+
+> More information about [export](../dsl/execution/export.md) keyword.
+
+## Explanation
+
+Every time teuton is run, all cases are evaluated and when exporting the results, by default, all the information collected during the evaluation process is logged.
+
+Each "target" contains the following fields:
+
+* Identification: id, description
+* Evaluation result: check(true/false)
+* Punctuation: score, weight
+* Check process: conn_type, command, duration, alterations, expected, result
+
+Some of these fields should always be visible, such as: id, description, check, score, and weight. And others, more related to the process that perform teuton for verification can be hidden using the "feedback: false" parameter.
+
+With "feedback: false" the fields are hidden: command, alterations, expected and result.
+Más información sobre este texto de origen
+Para obtener más información sobre la traducción, se necesita el texto de origen
+Enviar comentarios
+Paneles laterales
+
+## Execution section
+
+Take a look at our test execution section (Play):
+```ruby
+play do
+  show
+  export feedback: false
+end
+```
+
+## Result
+
+Executing `teuton run example/17-hide-feedback`:
+
+```
+GROUPS
+- Hide feedback from reports
+    01 (1.0/1.0)
+        Description : Exits user root
+        Command     : *******
+        Duration    : 0.002 (local)
+        Alterations : ******************
+        Expected    : ************** (String)
+        Result      : * (Integer)
+```

data/docs/learn/README.md

@@ -1,13 +1,10 @@
 
 [<< back](../../README.md)
 
-1. [Learning](#learning)
-2. [Examples](#examples)
-3. [Videos](#videos)
+# Learn
 
-# Learning
+Learn how write your own Teuton tests:
 
-Learn how to use Teuton language to write your own tests:
 - [01 - Target](01-target.md)
 - [02 - Config file](02-config.md)
 - [03 - Remote hosts](03-remote_hosts.md)
@@ -21,17 +18,12 @@ Learn how to use Teuton language to write your own tests:
 - [11 - Moodle ID](11-moodle_id.md)
 - [12 - Get vars](12-get_vars.md)
 - [13 - Include](13-include.md)
-- Example 14 - Alias
-- Example 15 - Macros
-- [Example 16 - Exit codes](16-exit_codes.md)
-- [Videos](videos.md)
+- [14 - Alias](14-alias.md)
+- 15 - Macros
+- [16 - Exit codes](16-exit_codes.md)
+- [17 - Hide feedback](17-hide-feedback.md)
 
-# Examples
-
-More examples
-* Let's see examples at [teuton-tests](https://github.com/dvarrui/teuton-tests) GitHub repository.
-* Ask us by email at `teuton.software@protonmail.com` or Twitter at `@SoftwareTeuton`.
-* [ES - CHAPI19: Teuton demo](https://github.com/dvarrui/proyectos-de-ejemplo/tree/master/charlas/teuton)
+Mores examples at [teuton-tests](https://github.com/dvarrui/teuton-tests) GitHub repository.
 
 # Videos
 
@@ -40,6 +32,7 @@ But if you want to see Spanish videos, here you are:
 
 Teuton (v2.0):
 * [ES - CHAPI19: Charla Teuton](https://youtu.be/KFWQDfNAFxI?t=12221)
+* [ES - CHAPI19: Teuton demo](https://github.com/dvarrui/proyectos-de-ejemplo/tree/master/charlas/teuton)
 
 Sysadmingame (Teuton v1.0)
 * [Sysadmingame (1 de 3): Instalación del programa](https://youtu.be/dnyMq9_KDco)

data/lib/teuton/case_manager/case/case.rb

@@ -2,6 +2,7 @@
 
 require_relative "../../application"
 require_relative "../../report/report"
+require_relative "../../report/show"
 require_relative "../utils"
 require_relative "main"
 require_relative "result/result"
@@ -17,7 +18,6 @@ require_relative "builtin/main"
 # * grade
 # * members
 # * skip
-# * show
 # * read_filename ???
 class Case
   include DSL
@@ -42,6 +42,7 @@ class Case
 
     # Define Case Report
     @report = Report.new(@id)
+    # TODO: Move folder creation from case to parent classes?
     @report.output_dir = File.join("var", @config.global[:tt_testname])
     ensure_dir @report.output_dir
 
@@ -100,10 +101,6 @@ class Case
 
   alias skip? skip
 
-  def show
-    @report.show
-  end
-
   private
 
   def read_filename(filename)

data/lib/teuton/case_manager/case/dsl/expect.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "colorize"
-
 module DSL
   # expect <condition>, :weight => <value>
   def expect(input, args = {})
@@ -10,7 +8,7 @@ module DSL
     elsif input.instance_of?(String) || input.instance_of?(Regexp) || input.instance_of?(Array)
       expect_any input
     else
-      puts "[TypeError] expect #{input} (#{input.class})"
+      puts Rainbow("[TypeError] expect #{input} (#{input.class})").red
     end
   end
 
@@ -30,7 +28,7 @@ module DSL
     app = Application.instance
     c = app.letter[:bad]
     c = app.letter[:good] if cond
-    verbose c.colorize(:green)
+    verbose Rainbow(c).green
   end
 
   def expect_any(input, args = {})

data/lib/teuton/case_manager/case/dsl/log.rb

@@ -1,5 +1,4 @@
-# frozen_string_literal: true
-
+require "rainbow"
 ##
 # Define DSL#log function
 module DSL

data/lib/teuton/case_manager/case/dsl/send.rb

@@ -37,9 +37,11 @@ module DSL
       Net::SFTP.start(ip, username, password: password, port: port) do |sftp|
         sftp.upload!(localfilepath, remotefilepath)
       end
-      verboseln("=> [ OK  ] #{(get(:tt_members)[0, 15]).ljust(16)} : #{remotefilepath}")
+      msg = Rainbow("==> File '#{remotefilepath}' of '#{get(:tt_members)}' has been copied").green
+      verboseln(msg)
     rescue
-      verboseln("=> [ERROR] #{(get(:tt_members)[0, 15]).ljust(16)} : scp #{localfilepath} => #{remotefilepath}")
+      msg = Rainbow("==> [FAIL] #{get(:tt_members)}: 'scp #{localfilepath}' to #{remotefilepath}").red
+      verboseln(msg)
     end
   end