teuton 2.7.3 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4bee1e3cc6c28460e9fd3cbaf09dacf2c16c1824a4bc4782aeb1749a25b5fda
-  data.tar.gz: 5d41ccb0c129a9894eaa4ae13db4116cf4dc13c875aeaf1edade09159cccc6fc
+  metadata.gz: 41d7f02d5c9cc429427966cadfc4b7190a30194d4e23af3b436100dac3a1ee17
+  data.tar.gz: 41a7034fad8189b98ff0d17e5d875a5ed3512ddfb0dcac3e22d9b750e6c62304
 SHA512:
-  metadata.gz: 005a48257a74193057e0edba4e6a65edbd7481962f8f380f82f6f5dbae1a6e49f16d74e4f5dc5a9919f8a54ba17c5293f09eaec793e56a11f8d192a706e7a776
-  data.tar.gz: 58d57804d06cc4edaaf0327199fc3ff5845fea01e342a071fc61c52376e08b51ae67d233f5f780fe333445bee64d9066bcd6545fd41f29bf587b46a1d00c362f
+  metadata.gz: 3c6058ce58e3794926125f6bb06b27d98412e6ebf230c27e2f1abec30da87334fa519329ebff176e8ed649f79d876f15be811a6976aeef79e0168b647df637be
+  data.tar.gz: 1447f163a0b1d83c8ffa0cc1e3813810b2b22b59bb1ad359b2e5364f840f196ab8dc35906b612eb0912ec48b7dc67b9e136d42302b5943a08c4ec642e6b91faf

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,105 @@
+
+## [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] unrelease
+
+- [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`.

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,31 +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_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
 
@@ -42,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/export.md

@@ -24,9 +24,11 @@ end
 
 ## Options
 
-1. **format**: txt (default), html, yaml, json, colored_text (txt with colors).
-2. **preserve**: false (default), true.
-3. **feedback**: true (default), false
+| 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 |
 
 ## Usage
 
@@ -40,3 +42,4 @@ end
 | 06 | `export format: 'colored_text'` or  `export format: :colored_text` | Export file using colored TXT ouput format |
 | 07 | `export preserve: true` | Export default format and preserve report copies |
 | 08 | `export format: 'html', preserve: true` or `export format: :html, preserve: true` | Export 'html' format and preserve report copies |
+| 09 | `export feedback: false` | With "feedback: false" some fields are hidden: command, alterations, expected and result |

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/dsl/send.md

@@ -12,33 +12,18 @@ end
 ```
 
 * `send` instruction must be execute after `export`. Reports must be generated before send them, of course.
-* `host1`, it' the label that identified remote host. This information must be configured into config file.
+* `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`.
 
-## Example
+## Options
 
-Example 1: send `case-01-txt` file to remote Windows host.
+| Option  | Action | Description |
+| ------: | ------ | ----------- |
+| copy_to | send copy_to: :host1 | Copy report into default directory of remote machine `host1`. |
+| prefix | send copy_to: :host1, prefix: "example_" | Case report will be save into default directory on every host `host1`, named as `example_case-XX.txt`. |
+| dir    | send copy_to: :host1, dir: "/home/obiwan" | Reports will be saved into "/home/obiwan" directory in remote machine `host1`. |
 
-![](images/send-remote-dir-dot1.jpg)
-
-![](images/send-remote-dir-dot2.jpg)
-
-Example 2: send report file to remote "./Desktop" folder.
-
-![](images/send-remote-dir-desktop1.jpg)
-
-## Parameters
-
-| Action | Description |
-| ------ | ----------- |
-| `send copy_to: :host1, remote_dir: "/home/david"` | Reports will be saved into "/home/david" directory in remote machine `host1`. |
-| `send copy_to: :host1, prefix: "samba_"` | Case report will be save into temp directory on every host `host1`, named as `samba_case-XX.txt`. |
-
-> Teuton version 2.0.x
-> * By default, `send` only works when remote OS type is UNIX base, like GNU/Linux, MACOS, BSD, etc.
-> * For Windows OS we must specified `:remote_dir`. Example: `send :copy_to => :host1, :remote_dir => "C:\\"`. This example will copy files on directory c:\ of host1 machine.
-
-## Send several reports
+## Example: Send several reports with diferent formats
 
 If you export several files using differents output formats, you will use several `export` orders. Then when invoke `send` order, this will send the last exported file.
 
@@ -64,3 +49,29 @@ start do
   send copy_to: :host1
 end
 ```
+
+## Example: Using "dir" options
+
+Example 1: send `case-01-txt` file to default folder of remote remote host.
+
+```ruby
+play do
+  show
+  export
+  send copy_to: :host1
+end
+```
+
+Result:
+
+![](images/send-remote-dir-dot2.jpg)
+
+Example 2: send report file to "./Desktop" folder of remote host.
+
+```ruby
+play do
+  show
+  export
+  send copy_to: :host1, dir: "./Desktop"
+end
+```