teuton 2.4.1 → 2.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4abcfe5aee651ce09c17012de250c39c6286b3d11ba00462f6ab285224d65d49
-  data.tar.gz: 1158d3a447ad5c0a9c8b2cc7e524fa8c235d00492243f6959be890c379c9ea12
+  metadata.gz: 4737382a68bd95498f1fcfe7fab7dd674170ac21e56aeea7761cea9c7edb2c58
+  data.tar.gz: 00bbd221c4251ad369a3829eb67d32fce2d05c15a9af764f76874031bc26dc0f
 SHA512:
-  metadata.gz: 3006a5ecbb9b8ee634b62704d80911175c9a02e3e0e2d7388e191071bd27a8accbd89871139252f0e587ead1be3feac6bee7f0e04ba40cb734660173215aa4d9
-  data.tar.gz: 4c47dbe5964231ca099dd530beac2ba4266b085fe8f0c8a93473f4f8089bdede91cbdcf94b6bb463b9f6686b38930de250cba7f478530dd4d47ceee9c5d32c9a
+  metadata.gz: bc557091ed6ae131bf925a0da452b34e01a64ee95ffa1cdc52f17742920614c8126ba66e5c2bd830f901dd3acbb8cc644be604ae267eddd60b3937915d3f3b83
+  data.tar.gz: 9cd807f54792d0cf64d53a5ff82d03ca8e7e3eaf49338d511948defeaa802731ee1c8cb96ec07192d2c415c8ef113ddd180a3ed60a0bf0421ba12d314b12b601

data/README.md

@@ -52,8 +52,8 @@ CASE RESULTS
 # Documentation
 
 * [Learn](docs/learn/README.md)
-* [Commands](docs/commands/README.md)
 * [Language reference](docs/dsl/README.md)
+* [Commands](docs/commands/README.md)
 * [Installation](docs/install/README.md)
 
 > [Blogs and videos](docs/videos.md)
@@ -70,3 +70,5 @@ CASE RESULTS
 1. Commit your changes (`git commit -am 'Add some feature'`)
 1. Push to the branch (`git push origin my-new-feature`)
 1. Create new Pull Request.
+
+You can also [create issues](https://github.com/teuton-software/teuton/issues) with your requests/incidences/suggestions.

data/docs/changelog/todo.md

@@ -2,6 +2,7 @@
 ## TO-DO
 
 New features:
+- Parse new input format, and detect parse errors
 - Teuton readme --lang=es
 - Export files with other langs
 

data/docs/changelog/v2.4.md

@@ -1,4 +1,13 @@
 
+## [2.4.3]
+
+- Fix: "expect_none" without params works as "expect result.count.eq 0"
+- Add: "expect_nothing" that works as "expect result.count.eq 0".
+
+## [2.4.2]
+
+- Fix bug with result.grep_v(Array)
+
 ## [2.4.0]
 
 New features:

data/docs/commands/README.md

@@ -11,8 +11,6 @@ Available command functions:
 
 # 1. Show help
 
-Usage:
-
 ```bash
 teuton
 ```
@@ -32,14 +30,13 @@ Commands:
 ```
 
 Alias:
+
 * `teuton h`
 * `teuton -h`
 * `teuton --help`
 
 # 2. Show version
 
-Usage:
-
 ```bash
 teuton version
 ```
@@ -52,23 +49,22 @@ teuton (version 2.2.0)
 ```
 
 Alias:
+
 * `teuton v`
 * `teuton -v`
 * `teuton --version`
 
 # 3. Create new test
 
-Usage:
+Create teuton test skeleton.
 
 ```bash
 teuton new foo
 ```
 
-Description: Create teuton test skeleton.
-
 Example:
 
-```bash
+```console
 > teuton new foo
 
 [INFO] Creating foo project skeleton
@@ -86,15 +82,14 @@ This command will create the next structure:
 | foo/config.yaml | YAML configuration file |
 
 Alias:
+
 * `teuton n foo`
 * `teuton -n foo`
 * `teuton --new foo`
 
 # 4. Check teuton test
 
-Usage:
-
-```bash
+```console
 teuton check DIRPATH
 ```
 
@@ -110,14 +105,13 @@ Description: this command check teuton test and config files located into DIRPAT
 | teuton check path/to/file/foo.rb --cname=demo | Test content of foo.rb and demo.yaml files.|
 
 Alias:
+
 * `teuton c foo`
 * `teuton -c foo`
 * `teuton --check foo`
 
 # 5. Run teuton test
 
-Usage:
-
 ```bash
 teuton run DIRPATH
 ```
@@ -127,18 +121,15 @@ Description: this command run teuton test located into DIRPATH folder.
 [Example](example_run.md)
 
 Alias:
+
 * `teuton foo`
 
 # 6. Show README
 
-Usage:
-
 ```bash
 teuton readme DIRPATH
 ```
 
-Description:
-
 Read test and config files content, and display information about
 what kind of problem/exercise it is going to be evaluated. The students need this
 information to resolv the problem/exercise into their machines.

data/docs/commands/example_check.md

@@ -2,18 +2,18 @@
 
 # Check Teuton Test
 
-Objective: Revise Teuton test located into `example\learn-01-target`.
+Objective: Revise Teuton test located into `example\01-target`.
 
 Usage:
 
 ```
-teuton check examples/learn-01-target
+teuton check examples/01-target
 ```
 
 Example:
 
 ```bash
-> teuton check examples/learn-01-target
+❯ teuton check examples/01-target
 
 +----------------------------+
 | GROUP: Learn about targets |
@@ -39,7 +39,7 @@ Example:
 +----------------------+
 | Revising CONFIG file |
 +----------------------+
-[WARN] File /mnt/home/leap/proy/repos/teuton.d/teuton/examples/learn-01-target/config.yaml not found!
+[WARN] File .../examples/01-target/config.yaml not found!
 [INFO] Recomended content:
 ---
 :global:

data/docs/commands/example_run.md

@@ -7,55 +7,33 @@
 
 # 1. Run test
 
-Description: Running Teuton test located into `example/learn-01-target` folder.
-
-Usage:
+Running Teuton test located into `example/01-target` folder.
 
 ```bash
-teuton run example/learn-01-target
+teuton run example/01-target
 ```
 
 Example:
 
 ```bash
-> teuton run examples/learn-01-target
-
-==================================
-Executing [teuton] (version 2.1.9)
-[INFO] Running in parallel (2020-04-19 14:09:41 +0100)
-.
-[INFO] Duration = 0.004    (2020-04-19 14:09:41 +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                                     |
-+---------------+-------------------------------------------+
+------------------------------------
+Started at 2023-01-21 13:32:24 +0000
+F
+Finished in 0.004 seconds
+------------------------------------
 
 CASE RESULTS
 +------+-----------+-------+-------+
 | CASE | MEMBERS   | GRADE | STATE |
-| 01   | anonymous | 100.0 |       |
+| 01   | anonymous | 0.0   | ?     |
 +------+-----------+-------+-------+
-
-FINAL VALUES
-+-------------+---------------------------+
-| start_time  | 2020-04-19 14:09:41 +0100 |
-| finish_time | 2020-04-19 14:09:41 +0100 |
-| duration    | 0.004231917               |
-+-------------+---------------------------+
 ```
 
 # 2. Command options
 
-Usage: `teuton help run`
-
 ```
+> teuton help run
+
 Usage:
   teuton [run] [OPTIONS] DIRECTORY
 

data/docs/dsl/README.md

@@ -1,55 +1,43 @@
 [<< back](../../README.md)
 
-# Teuton language
+# Language keywords
 
-To define and run our activity test we use the next DSL keywords:
-1. [Definition instructions](#definition-instructions)
-2. [Execution instructions](#execution-instructions)
-3. [Setting instructions](#setting-instructions)
-4. [Ruby language](#ruby-language)
+To define our targets, and to run our tests, we use the next DSL keywords:
 
-## Definition instructions
+Types:
 
-These are the main DSL key words, usefull to define items to be evaluated.
+* **Definition DSL**: keywords to define targets/items to be checked/evaluated.
+* **Execution DSL**: keywords used to specify accions related with reports and showing information.
+* **Settings DSL**: keyword to read and write config file.
 
-| DSL                            | Description |
-| :----------------------------- | :---------- |
-| [group](definition/group.md)   | Define a group of items to check. |
-| [target](definition/target.md) | Define a target. This is the item to be checked. |
-| Remote [run](definition/run_remote.md)| Execute command into remote host. |
-| Local [run](definition/run_local.md)  | Execute command into local host. |
-| [result](definition/result.md) | Contain the output of previous `run` order. |
-| [expect](definition/expect.md) | Check the obtained result with the expected value. |
+## Keyword table
 
-## Execution instructions
+| DSL                 | Type       | Descripción                       |
+| :------------------ | :--------: | :-------------------------------- |
+| [expect](expect.md) | Definition | Check the obtained result with the expected value. |
+| [export](export.md) | Execution  | Make reports with the results of every evaluation. |
+| [get](get.md)       | Settings   | Read param value from configuration file. |
+| [group](group.md)   | Definition | Define a group of items to check. |
+| [play](play.md)     | Execution  | Run the challenge.                |
+| [result](result.md) | Definition | Contain the output of previous `run` order. |
+| [run](run.md)| Definition | Execute command into remote host or localhost. |
+| [target](target.md) | Definition | Define a target. This is the item to be checked. |
+| [send](send.md)     | Execution  | Send copy of report file to remote host. |
+| [set](set.md)       | Settings   | Set new param value for running configuration. |
+| [show](show.md)     | Execution  | Show the results on screen.       |
 
-DSL key word related with reports and information.
+### Programming language
 
-| DSL                           | Descripción                              |
-| :---------------------------- | :--------------------------------------- |
-| [play](execution/play.md)     | Run the challenge.                       |
-| [show](execution/show.md)     | Show the results on screen.              |
-| [export](execution/export.md) | Make reports with the results of every evaluation. |
-| [send](execution/send.md)     | Send copy of report file to remote host. |
+It is possible to use Ruby language programming into Teuton tests. For example, in the definition of our test (iterators, arrays, etc.). Useful when we have repetitive lines, etc.
 
-## Setting instructions
+Example, how to create 4 target evaluation using a List/Array:
 
-| DSL                   | Descripción                                    |
-| :-------------------- | :--------------------------------------------- |
-| [get](setting/get.md) | Read param value from configuration file.      |
-| [set](setting/set.md) | Set new param value for running configuration. |
-
-## Ruby language
-
-It is possible to use ruby language programming structures, in the definition of our test (iterators, arrays, etc.). Useful when we have repetitive lines, etc.
-
-Example, how to create 4 target evaluation using an Array:
 ```ruby
 users = ['Obiwan', 'Yoda', 'Maul', 'Vader']
 
-users.each do |user|
-  target "Exist user #{user}"
-  run "id #{user}", on: :host1
-  expect_one user
+for name in users do
+  target "Exist user #{name}"
+  run "id #{name}", on: :host1
+  expect_one name
 end
 ```

data/docs/dsl/{definition/expect.md → expect.md}

@@ -1,25 +1,9 @@
 [<< back](../README.md)
 
-1. [Description](#description)
-2. [Usage](#usage)
-3. [Example](#example)
-4. [Basic](#basic)
-5. [Advanced](#advanced)
-
-## Description
+# expect
 
 Compare the obtained result with the expected one. This comparation process is registered into final report.
 
-## Usage
-
-```ruby
-target 'Exist user obiwan'
-run 'cat /etc/passwd'
-expect 'root'
-```
-
-Use `expect` keyword to check output (from previous execution).
-
 ## Example
 
 Let's see some examples:
@@ -27,7 +11,7 @@ Let's see some examples:
 ```ruby
 target 'Exist user obiwan'
 run 'id obiwan'
-expect 'obiwan' # Expect previous command output contains obiwan text
+expect 'obiwan' # Expect previous run command output contains obiwan text
 ```
 
 ## Basic

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

@@ -1,11 +1,6 @@
 [<< back](../../README.md)
 
-1. [Description](#description)
-2. [Example](#example)
-3. [Options](#options)
-4. [Usage](#usage)
-
-## Description
+# export
 
 Create reports and save then into `var/TEST-NAME` folder.
 

data/docs/dsl/{setting/get.md → get.md}

@@ -1,22 +1,16 @@
 [<< back](../README.md)
 
-1. [Description](#description)
-2. [Usage](#usage)
-3. [Examples](#examples)
+# get
 
-## Description
-
-`get` read param value from configuration file.
-
-## Usage
+`get` reads param value from configuration file.
 
 ```ruby
 get(PARAM)
 ```
 
-## Examples
+## Example
 
-**Reading example**: Suppose we have this `config.yaml` content:
+**Reading Example**. Suppose we have this `config.yaml` content:
 
 ```yaml
 ---

data/docs/dsl/{definition/group.md → group.md}

@@ -1,13 +1,8 @@
 [<< back](../README.md)
 
-1. [Description](#description)
-2. [Usage](#usage)
+# group
 
-## Description
-
-Groups targets/goals.
-
-## Usage
+Groups targets.
 
 ```ruby
 group "Group name" do

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

@@ -1,14 +1,9 @@
 [<< back](../../README.md)
 
-1. [Description](#description)
-2. [Usage](#usage)
-
-## Description
+# play
 
 DSL keyword that starts the execution of all targets/goals (defined into groups). We put this instruction at the end of every script, so it begin running the tests over the machines.
 
-## Usage
-
 ```ruby
 play do
 	...

data/docs/dsl/{definition/result.md → result.md}

@@ -1,11 +1,6 @@
 [<< back](../README.md)
 
-1. [Description](#description)
-2. [Example 1](#example-1)
-3. [Example 2](#example-2)
-4. [Functions](#functions)
-
-## Description
+# result
 
 **result** object saves the output from previous execution.
 It is usefull to build advanced `expect result...` sentences.

data/docs/dsl/{definition/run_remote.md → run.md}

@@ -1,32 +1,78 @@
 [<< back](../README.md)
 
-1. [Description](#description)
-2. [Usage](#usage)
-3. [Examples](#examples)
-4. [Protocol](#protocol)
+# Run
 
-## Description
+* [Local execution](#local-run)
+* [Remote execution](#remote-run)
 
-Connect to remote host and executes command. The command output is saved into **result** object.
+# Local run
+
+Execute command on localhost and save output into result object.
+
+```ruby
+run "id COMMAND"
+```
+
+## Alias
 
-## Usage
+In fact it's the same as doing next:
+
+```ruby
+run "COMMAND", on: :localhost
+```
+
+```ruby
+run "COMMAND", on: 127.0.0.1
+```
+
+```ruby
+run "COMMAND", on: 'localhost'
+```
+
+## Example
+
+```ruby
+run "id david"
+```
+
+* This instruction execute "id david" command on local machine, and save results into **result** object.
+* Local machine is where the `Teuton` program is running.
+
+---
+# Remote run
+
+Connect to remote host and executes command. The command output is saved into **result** object.
 
 ```ruby
 run "COMMAND", on: :hostID
-on :hostID, run: "COMMAND"
-goto :hostID, :exec => "COMMAND"
 ```
-> ADVISE: I know that programers dislike `goto` sentence, but this is diferent. Think of it as english speaker, not as developer.
 
 * This example connect to remote host identified by `hostID`. Then we execute the command into it and save the output commadn into result object.
 * Label `hostID` identifies specific machine. Host information (ip, username, password, protocol) cames from config file.
 
+## Alias
+
+I know that programers dislike `goto` sentence, but this is diferent. Think of it as english speaker, not as developer.
+
+```ruby
+on :hostID, run: "COMMAND"
+```
+
+```ruby
+goto :hostID, :exec => "COMMAND"
+```
+
 ## Examples
 
 Execute `id obiwan` comand into remote host `:linux1`.
 
-```Ruby
+```ruby
 run "id obiwan", on: :linux1
+```
+
+## Deprecated
+
+```ruby
 run "id obiwan", :on => :linux1
 on :linux1, run: "id obiwan"
 on :linux1, :run => "id obiwan"
@@ -34,18 +80,6 @@ goto :linux1, exec: "id obiwan"
 goto :linux1, :exec => "id obiwan"
 ```
 
-Execute `id yoda` command into `localhost`.
-
-```Ruby
-run "id yoda"
-run "id yoda", on: :localhost
-run "id yoda", :on => :localhost
-on :localhost, run: "id yoda"
-on :localhost, :run => "id yoda"
-goto :localhost, :exec => "id yoda"
-goto :localhost, :execute => "id yoda"
-```
-
 ## Protocol
 
 **SSH connection**

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

@@ -1,16 +1,9 @@
 [<< back](../../README.md)
 
-1. [Description](#description)
-2. [Usage](#usage)
-3. [Parameters](#parameters)
-4. [Send several reports](#send-several-reports)
-
-## Description
+# send
 
 `send` is used to copy Teuton reports into remote machines.
 
-## Usage
-
 ```ruby
 start do
   export

data/docs/dsl/{setting/set.md → set.md}

@@ -1,15 +1,9 @@
 [<< back](../README.md)
 
-1. [Description](#description)
-2. [Usage](#usage)
-3. [Example](#example)
-
-## Description
+# set
 
 `set` create new temporaly param value for running configuration.
 
-## Usage
-
 ```ruby
 set(:param1, 'value')
 ```

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

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

data/docs/dsl/target.md

@@ -0,0 +1,33 @@
+[<< back](../README.md)
+
+# target
+
+`target` instruction is used to begin every new target and sets its description.
+
+```ruby
+target "Write here your description"
+```
+
+Describe your targets so everybody could understand what is going to be measured. This text will be shown into reports to help us understand output information easily.
+
+## Weight
+
+By default weight is `1.0`, but it's posible specified other values:
+
+```ruby
+target "Write here your description", weight: 2.5
+```
+
+## [DEPRECATED] Alias
+
+`goal` keyword is an alias of `target`. So it's the same:
+
+```ruby
+target "Write here your description"
+```
+
+or
+
+```ruby
+goal "Write here your description"
+```