teuton 2.8.0 → 2.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12d43ceacd278684c8415098d95fc3803486bfa437fb2bb91c5224074b42fd2d
-  data.tar.gz: 610841aa8b490d72158d8641450fcf794fda245285621a454e259cfbbb5f2749
+  metadata.gz: ee10a452f23f3de91ef5ae2239480a7f72fbd07502a846b8517b8b6c4f3200f5
+  data.tar.gz: cd31f3dc5521fb66205c3d5bb2c72420a0455ea1e14b2cbbaa4f1288f58da279
 SHA512:
-  metadata.gz: 2aa8c93229422728b09aabb1f2a7c95c44af37c4a4c0a02518e8ad58a74b023d2806f299fde0005f695a66e935b03daf25ac6d75ae4fc59f2105fe4dc2fce129
-  data.tar.gz: 047415074d71174f1399422e2cf45b92fdecc3234f3aed94e4c99ce1298fcb9db2bcc4b0daec6abac5ab65162041acf3a519c9a30dda62ee1d10f29efea7a9b1
+  metadata.gz: 70386a6f0b98a7efd9740e82709b7632bd67b2bd1aa090698980c151c246e2d6aea53ab76422d6c0318aceef434d5636a8c5d8797e69d13c28fabbe9b2af491e
+  data.tar.gz: 4e0fd5a4462fa8c728aa4daeadafee33620df166eadaab8c9ee55c27ad3e5b0c63b4615a8e7e2fc0562f85083ccca2bd2ae18793a00c668aada941ed44dc9fa5

data/README.md

@@ -47,12 +47,12 @@ CASE RESULTS
 
 # Documentation
 
+* [Installation](docs/install/README.md)
 * [Getting started](docs/learn/README.md)
-* [Language reference](docs/dsl/README.md)
+* [Examples](examples)
 * [Commands](docs/commands/README.md)
-* [Installation](docs/install/README.md)
-
-> [Blogs and videos](docs/videos.md)
+* [Language reference](docs/dsl/README.md)
+* [Blogs and videos](docs/videos.md)
 
 # Contact
 

data/docs/changelog/changelog.1.md

@@ -0,0 +1,119 @@
+[<< back](../CHANGELOG.md)
+
+# CHANGELOG
+
+## [0.22.1] June 2017
+
+* Now it's posible to use config files with YAML and JSON format
+* Preparing migration of CLI command to use Thor gem
+
+## [1.0.0] July 2017
+
+* New stable version
+
+## 2019
+
+## [1.10.0] Janyary 2019
+
+* SysadminGame change his name by TEUTON. "project" command replaced by "teuton".
+* Challenges (Teuton scripts) moved to "teuton-challenges" github repository.
+* Execute "rake get_challenges" to get sample teuton challenges
+
+## [2.0.4] August 2019
+
+* TEUTON project grew up and was divided into the folowing repositories: teuton, challenges, panel, resources and vagrant.
+* Documentation has been moved into respository teuton wiki. Only maintain English docs.
+
+## [2.1.0]
+
+**Export grades on csv file using Moodle format**
+
+* Automaticaly exports `moodle.csv` file with all cases grades, using adecuate format so it could be imported directly into Moodle platform.
+* We need to configure some params like this:
+
+```
+---
+:global:
+:cases:
+- :tt_members: ...
+  :tt_moodle_id: User Moodle Identity
+```
+
+**readme keyword**
+
+We currently use the "teuton readme pry-folder" command to export README file from the challenge.
+
+* This example shows how to use readme keyword to add group description or target description:
+
+```
+group "GROUPNAME" do
+  readme "Description for this group"
+
+  target "target1"
+  readme "Description for this target"
+  goto :host, :exec => 'id root'
+  expec_one 'root'
+```
+
+**Installation process**
+
+* Use Bundler to install gems instead of rake.
+* It will be usefull use sysadming-game as gem? And install it with `gem install teuton`.
+* Vagrant: test how to use vagrant machines as case hosts.
+
+**Info sobre novedades de la versión 2.1**
+
+1. Teuton readme y dsl readme
+2. Macros de define macro
+3. Export yaml y html
+4. Teuton --no-color
+5. teuton run --case
+6. teuton run --cname
+7. teuton run --cpath
+8. actualizar formatos de salida
+9. instalación mediante gemas
+10. teuton panel
+11. teuton client y server
+12. nuevos nombres de comandos...
+13. cambio de goto a run
+
+## [2.2.0]
+
+**New features**
+
+* Let's see new features examples:
+    * 10 result and moodle_id
+    * 11 get_vars
+    * 12 alias
+    * 13 include (tt_include config param)
+    * 14 macros
+
+**Configuration file**
+
+* Por defecto los valores de clave de los ficheros de configuración serán Strings en lugar de símbolos, aunque lo símbolos seguirán funcionando.
+
+**get_vars: To think - We are not sure about this***
+
+* "get" keyword simplification: Simplify getting and setting params process. For example: `_username_`, may be alias for `get(:username)`. Then
+
+```
+target "Create user #{_username_}"
+run "id #{_username_}"
+expect_one _username_
+```
+Same as
+
+```
+target "Create user "+get(:username)
+run "id " + get(:username)
+expect_one get(:username)
+```
+
+* Promocinar el proyecto:
+    * Documentar y hacer videos.
+    * Charlas y talleres
+
+**Fixed**
+
+* Solucionar fallo en --cname
+* Revisar doc options como cpanel

data/docs/changelog/changelog.2.md

@@ -0,0 +1,109 @@
+
+## [2.3.9]
+
+- FIX: Remove warnings from linter
+- FIX: Remove warning about thor gem version. Upgrade gem to 1.2
+
+## [2.3.11]
+
+- Issue #18
+
+## [2.4.0]
+
+New features:
+- Hide feedback from reports: `export feedback: false`
+- Add new DSL keyword: expect_last, expect_fisrt
+- Remove os gem.
+- Change test output colors to green as use others test tools.
+- Change show DSL params. Accepts one param "verbose: NUMBER" to adjust verbosity output level on screen.
+
+New doc and example:
+- 14-alias
+- 16-exit_codes
+
+Bug fixed:
+- All "expect*" keywords must require 2 arguments. The second is optional.
+
+Revise
+- Remove colors to log text
+- teuton readme: macros, getvars, expect_last, expect_first
+
+## [2.4.2]
+
+- Fix bug with result.grep_v(Array)
+
+## [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.4]
+
+-- Modify: teuton check output colors and exit codes.
+   exit code 0 = check OK
+   exit code 1 = check error
+-- Fix teuton check docs.
+
+## [2.4.5]
+
+-- FIX: "expect_nothing" was always TRUE when SSH/Telnet connections fails!
+   Now when SSH/Telnet connections fails result contains "SSH: NO CONNECTION!"
+   So "expect_nothing" will fail.
+
+## [2.5.0]
+
+- ADD: "tt_moodle_max_score" global configuration param. Teuton grades (0-100) are divided by this value when exporting data into "moodle.csv" output file.
+- UPDATE: Revise documentation. Doc learn 10,11, 12,13 y 14. 10 result and moodle_id, 12 alias, 13 include, 14 macro, Doc tt_include
+- UPDATE: Internal changes. Remove Colorize gem and replace with Rainbow.
+
+## [2.6.0]
+
+- [ADD] When running local or SSH commands, stdout and stderr are captured and readed by "expect" sentence.
+
+## [2.7.0]
+
+New features:
+- [ADD] "teuton config PROJECTPATH" will suggest suitable configuration for the project.
+- [ADD] Every one line command output is registered into reports.
+- [ADD] "expect_exit 1", check last command exit code is equal to 1.
+
+Internal changes:
+* Application class splited into Settings and Project classes
+* Create SendManager similar to ExportManager
+
+## [2.7.1]
+
+- [FIX] Fixed an issue that appeared when executing test and fail connection to remote computer.
+
+## [2.7.2] 20230607
+
+- [FIX] Fixed an issue that appeared when exporting reports without feedback after failing to connect to remote computer.
+
+## [2.7.3] 20230607
+
+- [FIX] Hall of fame now use Project class instead of Application.
+
+## [2.8.0] 20230630
+
+DSL expect:
+- [ADD] "expect_ok" as "expect_exit 0 ".
+- [ADD] "expect_fail" as "expect_exit NUMBER" where NUMBER > 0.
+- [FIX] expect evaluation fail when there is no remote connection.
+
+DSL send:
+- [UPDATE] Rename "remote_dir" send param to "dir".
+- [UPDATE] send output messages
+
+## [2.9.0] 20230726
+
+- [ADD] "expect_sequence" that check if sequence is present
+- [ADD] New DSL "run_script". Example: `run_script script, on: :host1`, upload script to host1 and then execute it on remote.
+- [ADD] New DSL "upload". Upload local file to remote host. Example `upload "localfile", to: :host1`
+- [ADD] `teuton check` works with `expect_sequence`, `run_script` and `upload`.
+- [FIX] `teuton check` works fine with `macros`.
+- [ADD] `teuton readme` works with `expect_sequence`, `run_script` and `upload`.
+- [FIX] `teuton readme` works fine with `macros`.
+
+## [2.9.1] 20231117
+
+- [FIX] Config option `tt_include` doubled readed data on Windows platforms.

data/docs/diagram.md

@@ -9,15 +9,15 @@ subgraph user
   CLI --> Teuton
 end
 
-subgraph "create\nnew\nproject"
-  Teuton -- create --> Skeleton("Sekeleton\nFiles")
+subgraph "create new project"
+  Teuton -- create --> Skeleton("Skeleton\nFiles")
 end
 
-subgraph "Check\nproject files"
+subgraph "Check\nproject"
   Teuton -- check --> Laboratory("Laboratory\nDSL\nShow\nBuiltin!")
 end
 
-subgraph "Create readme\nfrom project"
+subgraph "Create\nproject readme"
   Teuton -- readme --> Readme("Readme\nDSL\nLang!")
 end
 
@@ -27,8 +27,8 @@ subgraph manager
   ReportManager --> HallOfFame
 end
 
-subgraph "case folder"
-  CaseManager --> Case("Case\nConfig\nClose\nPlay\nRunner\ncase/DSL\ncase/builtin!")
+subgraph "case"
+  CaseManager --> Case("Case\nConfig\nDSL\nPlay\nExecute\nResult\nClose\nbuiltin!")
 end
 
 subgraph utils
@@ -42,10 +42,10 @@ subgraph utils
   Readme --> Result("Result\next_array\next_compare\next_filter")
   Case --> Result
 
-  Laboratory --> Application
-  Readme --> Application
-  manager/DSL -- use/macros/groups --> Application("Application\nNameFileFinder")
-  Case --> Application
+  Laboratory --> Project
+  Readme --> Project
+  manager/DSL -- use/macros/groups --> Project("Project\nNameFileFinder")
+  Case --> Project
 end
 
 subgraph report

data/docs/dsl/expect.md

@@ -9,33 +9,84 @@ Compare the obtained result with the expected one. This comparation process is r
 Let's see some examples:
 
 ```ruby
-target 'Exist user obiwan'
-run 'id obiwan'
-expect 'obiwan' # Expect previous run command output contains obiwan text
+target "Exist user obiwan"
+run "id obiwan"
+expect "obiwan" # Expect run command output will contain "obiwan"
 ```
 
-## Basic
+## Simple evaluations
 
-| Command | Description |
-| ------- | ----------- |
-| expect "yoda" or expect_any "yoda" | one or more line/s with "yoda" |
-| expect ["obiwan", "kenobi"] | one or more line/s with "obiwan" and kenobi" |
-| expect_first "episode" | the first line with "episode" |
-| expect_last "episode" | the last line with "episode" |
-| expect_one "rogue" | only one line with "rogue" |
+| Command                       | Description                    |
+| ----------------------------- | ------------------------------ |
+| expect "yoda"                 | one or more line/s with "yoda" |
+| expect_any "yoda"             | one or more line/s with "yoda" |
+| expect ["obiwan", "kenobi"]   | one or more line/s with "obiwan" and kenobi" |
+| expect_first "episode"         | the first line with "episode" |
+| expect_last "the end"          | the last line with "the end" |
+| expect_one "rogue"             | only one line with "rogue" |
 | expect_one ["obiwan","kenobi"] | only one line with "obiwan" and "kenobi" |
-| expect_none "vader"| no line with "vader" |
+| expect /Obiwan\|obi-wan/       | one or more line/s with Obiwan or obi-wan. This example uses regular expresions. |
+
+## Negative evaluations
+
+| Command                        | Description                  |
+| ------------------------------ | ---------------------------- |
+| expect_none "vader"            | Expects no line with "vader" |
 | expect_none ["darth", "vader"] | no line with "darth" or "vader" |
-| expect_none | no output lines expected |
-| expect_nothing | no output lines expected |
-| expect /Obiwan\|obi-wan/ | one or more line/s with Obiwan or obi-wan. This example uses regular expresions. |
-| expect_exit NUMBER | Check exit code is NUMBER |
-| expect_ok          | Check exit code is 0 |
-| expect_fail        | Check exit code is > 0 |
+| expect_none                    | no output lines expected |
+| expect_nothing                 | no output lines expected |
+
+## Exitcode evaluations
+
+| Command              | Description               |
+| -------------------- | ------------------------- |
+| expect_ok            | Check exit code is 0      |
+| expect_fail          | Check exit code is > 0    |
+| expect_exit NUMBER   | Check exit code is NUMBER |
+| expect_exit MIN..MAX | Check exit code is >= MIN and < MAXNUMBER |
+
+## Evaluate sequence
+
+* **Simple sequence**. Validate sequences where the elements are in order. Use `find` statement to find each element of the sequence.
+
+```ruby
+# Examples: [A,B,C], [A,s,B,s,C], [x,A,B,s,C,x], etc.
+
+expect_sequence do
+  find "A"
+  find "B"
+  find "C"
+end
+```
+
+* **Strict sequence**. validate sequences where the elements are in strict consecutive order. First use `find` to find an element in the sequence and then `next_to` for the next element in strict order.
+
+```ruby
+# Examples: [A,B,C], [x,A,B,C,x], etc.
+
+expect_sequence do
+  find "A"
+  next_to "B"
+  next_to "C"
+end
+```
+
+* **Strict sequence with jumps**. Use `ignore N` to indicate that there are N lines between 2 elements of the sequence.
+
+```ruby
+# Examples: [A,B,s,s,C], [x,A,B,s,s,C,x], etc.
+
+expect_sequence do
+  find "A"
+  next_to "B"
+  ignore 2
+  next_to "C"
+end
+```
 
-## Advanced
+## Complex evaluations
 
-After every execution keyword (`run`, `on` or `goto`), command outputs is saved by **result** object. Use **result** to create more complex evaluations.
+After every execution keyword `run`, command outputs is wrapped into **result** object. We may use **result** to make complex evaluations.
 
 For example, if we have this execution
 
@@ -44,10 +95,10 @@ target 'Exist user vader'
 run    'cat /etc/passwd'
 ```
 
-Then we check result with:
+Then we can check result with:
 
-* **expect result.find("vader").count.eq(1)**, expect there exists only 1 line with "vader" text.
-* **expect result.find(/Darth|darth/).find(/Vader|vader/).count.gt(2)**, expect there exists more than 2 lines with texts "Darth" and "Vader".
-* **expect result.not_find('#').find('vader').count.lt(3)**, expects there exists less than 3 lines with text "vader" and without "#" symbol.
+* **expect result.find(/obiwan|kenobi/).count.eq(1)**, expect there exists only 1 line with "obiwan" or "kenobi".
+* **expect result.find(/darth/).find(/vader/).count.gt(2)**, expect there exists more than 2 lines with texts "darth" and "vader".
+* **expect result.not_find('#').find('yoda').count.lt(3)**, expects there exists less than 3 lines with text "yoda" and without "#" symbol.
 
-Read [result](result.md) documentation.
+Read more about [result](result.md) object.

data/docs/dsl/result.md

@@ -33,18 +33,12 @@ run "cat /etc/passwd", on: :host1
 ```
 
 And then we could do:
-* Get all lines that dosn't contain "nologin" and contain "/bin/bash"
-```
-result.grep_v("nologin").grep("/bin/bash")
-```
-* Count all lines that dosn't contain "nologin" and contain "/bin/bash"
-```
-result.grep_v("nologin").grep("/bin/bash").count
-```
-* Return true if the number when count all lines that dosn't contain "nologin" and contain "/bin/bash" is greater than 0
-```
-result.grep_v("nologin").grep("/bin/bash").count.gt 0
-```
+
+| Description | Command |
+| ----------- | ------- |
+| Get all lines that dosn't contain "nologin" and contain "/bin/bash" | result.grep_v("nologin").grep("/bin/bash") |
+| Count all lines that dosn't contain "nologin" and contain "/bin/bash" | result.grep_v("nologin").grep("/bin/bash").count |
+| Return true if the number when count all lines that dosn't contain "nologin" and contain "/bin/bash" is greater than 0 | result.grep_v("nologin").grep("/bin/bash").count.gt 0 |
 
 ## Functions
 
@@ -52,33 +46,33 @@ result.grep_v("nologin").grep("/bin/bash").count.gt 0
 
 | Function            | Description               |
 | ------------------- | ------------------------- |
-| `result.eq(VALUE)`  | Result equal to VALUE     |
-| `result.neq(VALUE)` | Result not equal to VALUE |
-| `result.gt(VALUE)`  | Result greater than VALUE |
-| `result.ge(VALUE)`  | Result equal or greater than VALUE |
-| `result.lt(VALUE)`  | Result lesser than VALUE  |
-| `result.le(VALUE)`  | Result equal or lesser than VALUE |
+| result.eq(VALUE)  | Result equal to VALUE     |
+| result.neq(VALUE) | Result not equal to VALUE |
+| result.gt(VALUE)  | Result greater than VALUE |
+| result.ge(VALUE)  | Result equal or greater than VALUE |
+| result.lt(VALUE)  | Result lesser than VALUE  |
+| result.le(VALUE)  | Result equal or lesser than VALUE |
 
 **Filtering functions:**
 
 | Function             | VALUE type  | Description                           |
 | -------------------- | ----------- | ------------------------------------- |
-| `result.count`       |             | Count lines from result and save this number into result object. |
-| `result.first` | | Remove all lines except first one.|
-| `result.find(VALUE)` | String      | Filter lines that contains VALUE text |
+| result.count       |             | Count lines from result and save this number into result object. |
+| result.first | | Remove all lines except first one.|
+| result.find(VALUE) | String      | Filter lines that contains VALUE text |
 |                      | RegExp      | Filter lines that match VALUE regexp. For example `/?ello]`, filter lines with "Hello" or "hello" |
 |                      | Array       | Apply filter to every array element. For example `["Hi","Hello"]`, filter lines with "Hi" or "Hello". |
-| `result.grep(VALUE)` | String, RegExp, Array | Same as find |
-| `result.grep_v(VALUE)` | String, RegExp, Array | Same as not_find |
-| `result.last` | | Remove all lines except last one.|
-| `result.not_find(VALUE)` |         | Filter lines that not contains VALUE. VALUE may be String, Regular Expresion or an Array. |
-| `result.restore`     |             | Restore result data. After every filtering action result is modified, but this function restore data to their original state. |
+| result.grep(VALUE) | String, RegExp, Array | Same as find |
+| result.grep_v(VALUE) | String, RegExp, Array | Same as not_find |
+| result.last | | Remove all lines except last one.|
+| result.not_find(VALUE) |         | Filter lines that not contains VALUE. VALUE may be String, Regular Expresion or an Array. |
+| result.restore     |             | Restore result data. After every filtering action result is modified, but this function restore data to their original state. |
 
 **Information functions:**
 
 | Function             | Description |
 | -------------------- | --------------------------------- |
-| `result.alterations` | Return transformations applied to the output |
-| `result.content`     | Return all output lines         |
-| `result.debug`       | Print the result content on screen. Usefull for debugging process |
-| `result.value`       | Return first output line or value |
+| result.alterations | Return transformations applied to the output |
+| result.content     | Return all output lines         |
+| result.debug       | Print the result content on screen. Usefull for debugging process |
+| result.value       | Return first output line or value |

data/docs/learn/02-target.md

@@ -7,37 +7,40 @@ A [target](../dsl/target.md) is a feature you want to check. Targets are defined
 ## Target definition
 
 * [target](dsl/target.md): Description of the element to be tested.
-* [run](../dsl/run.md): Execute a command `id david` on localhost.
+* [run](../dsl/run.md): Execute a command `id obiwan` on localhost.
 * [expect](../&dsl/expect.md): Verify that the result contains expected value.
 
 ```ruby
 group "Learn about targets" do
 
-  target "Create user david"
-  run "id david"
-  expect ["uid=", "(david)", "gid="]
+  target "Exist user obiwan"
+  run "id obiwan"
+  expect ["uid=", "(obiwan)", "gid="]
 
   target "Delete user vader"
   run "id vader"
-  expect ["id:", "vader", "no exist"]
-
+  expect_fail
 end
 ```
 
-> In this example, our localhost's OS is GNU/Linux (or any other compatible OS) because the command executed is `id david`.
+> In this example, our localhost's OS is GNU/Linux (or any other compatible OS) because the command executed is `id obiwan`.
 
-When the user exists, we expect this words: `uid=, (david), gid=`.
+When the user exists, we expect this words: `uid=, (obiwan), gid=`.
 
 ```
-❯ id david
-uid=1000(david) gid=1000(david) grupos=1000(david)
+❯ id obiwan
+uid=1000(obiwan) gid=1000(obiwan) grupos=1000(obiwan)
 ```
 
 But when user does not exist, we expect different words: `id:, vader, no exist`.
 
 ```
 ❯ id vader
-id: «vader»: no existe ese usuario
+id: «vader»: no such user
+
+❯ echo $?
+1
+
 ```
 
 ## Execution section
@@ -93,32 +96,34 @@ CONFIGURATION
 
 GROUPS
 - Learn about targets
-    01 (1.0/1.0)
-        Description : Create user david
-        Command     : id david
+    01 (0.0/1.0)
+        Description : Create user obiwan
+        Command     : id obiwan
+        Output      : id: «obiwan»: no existe ese usuario
         Duration    : 0.002 (local)
-        Alterations : find(uid=) & find((david)) & find(gid=) & count
-        Expected    : Greater than 0 (String)
-        Result      : 1 (Integer)
+        Alterations : find(uid=) & find((obiwan)) & find(gid=) & count
+        Expected    : Greater than 0
+        Result      : 0
     02 (1.0/1.0)
         Description : Delete user vader
         Command     : id vader
+        Output      : id: «vader»: no existe ese usuario
         Duration    : 0.002 (local)
-        Alterations : find(id:) & find(vader) & find(no exist) & count
-        Expected    : Greater than 0 (String)
-        Result      : 1 (Integer)
+        Alterations : Read exit code
+        Expected    : Greater than 0
+        Result      : 1
 
 RESULTS
 +--------------+---------------------------+
 | case_id      | 01                        |
-| start_time   | 2023-04-10 09:09:30 +0100 |
-| finish_time  | 2023-04-10 09:09:30 +0100 |
-| duration     | 0.003863242               |
+| start_time   | 2023-06-16 08:42:13 +0100 |
+| finish_time  | 2023-06-16 08:42:13 +0100 |
+| duration     | 0.004527443               |
 | unique_fault | 0                         |
 | max_weight   | 2.0                       |
-| good_weight  | 2.0                       |
-| fail_weight  | 0.0                       |
-| fail_counter | 0                         |
-| grade        | 100                       |
+| good_weight  | 1.0                       |
+| fail_weight  | 1.0                       |
+| fail_counter | 1                         |
+| grade        | 50                        |
 +--------------+---------------------------+
 ```

data/docs/learn/25-expect-result.md

@@ -0,0 +1,39 @@
+[<<back](README.md)
+
+# expect vs result
+
+* `expect` is the statement we use to evaluate the result generated by a previous `run` statement.
+* `result` allows you to manipulate the output of the run command in more detail.
+
+`expect` is easier to use but less powerful than `result`.
+
+> Example files at [examples/25-expect-result](../../examples/25-expect-result)
+
+## Expect
+
+`expect` has different ways to evaluate result.
+
+| DSL                | Description |
+| ------------------ | ----------- |
+| expect FILTER      | it finds lines in the output with the content FILTER |
+| expect_none FILTER | it finds lines in the output without the FILTER content |
+| expect_nothing     | is true when the result is empty |
+| expect_exit NUMBER | Exit code is NUMBER |
+| expect_ok          | Exit code 0 |
+| expect_fail        | Exit code > 0 |
+
+> Learn more about [expect](../dsl/expect.md)
+
+## Result
+
+`result` is an object that encapsulates the output of the run command and allows manipulation of its contents before being evaluated by `expect`.
+
+| Result command | Description |
+| -------------- | ----------- |
+| expect result.count.eq NUMBER | Is true when output has NUMBER lines |
+| expect result.count.gt NUMBER | Is true when output has more than NUMBER lines |
+| expect result.count.lt NUMBER | is true when output has less than NUMBER lines |
+| expect result.grep(FILTER).count.eq NUMBER | output has NUMBER lines with FILTER |
+| expect result.grep_v(FILTER).count.eq NUMBER | output has NUMBER lines without FILTER |
+
+> Learn more about [result](../dsl/result.md)