teuton 2.7.2 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49783f5731dfc4f6344649a794f17b02e0d79e6f197068dde010414cdb6f7873
-  data.tar.gz: 0a4c44633bc0f101e5095678edf9da2e2c22372641302647244917c573a777c2
+  metadata.gz: 12d43ceacd278684c8415098d95fc3803486bfa437fb2bb91c5224074b42fd2d
+  data.tar.gz: 610841aa8b490d72158d8641450fcf794fda245285621a454e259cfbbb5f2749
 SHA512:
-  metadata.gz: ea56789646f536090a8afb7a28aef46e89daec281b7fe7c95bad0ff7170c27f1f1937540c899bf9d6e9b16c8126871facde4bedf97d5c7269bb8e51d49778066
-  data.tar.gz: e1ed282d52fbbe1519bbf597669680b46b680c5b3fa7164a0edf6e1472b7b356fce9bdc7e13ab68448a9e2318139a37a1adb6eda62a667dd00a3ba0ae2b6c339
+  metadata.gz: 2aa8c93229422728b09aabb1f2a7c95c44af37c4a4c0a02518e8ad58a74b023d2806f299fde0005f695a66e935b03daf25ac6d75ae4fc59f2105fe4dc2fce129
+  data.tar.gz: 047415074d71174f1399422e2cf45b92fdecc3234f3aed94e4c99ce1298fcb9db2bcc4b0daec6abac5ab65162041acf3a519c9a30dda62ee1d10f29efea7a9b1

data/docs/changelog/v2.7.md

@@ -1,4 +1,16 @@
 
+## [2.7.3] 20230607
+
+- [FIX] Hall of fame now use Project class instead of Application.
+
+## [2.7.2] 20230607
+
+- [FIX] Fixed an issue that appeared when exporting reports without feedback after failing to connect to remote computer.
+
+## [2.7.1]
+
+- [FIX] Fixed an issue that appeared when executing test and fail connection to remote computer.
+
 ## [2.7.0]
 
 New features:

data/docs/changelog/v2.8.md

@@ -0,0 +1,11 @@
+
+## [2.8.0] 20230630
+
+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.
+
+send:
+- [UPDATE] Rename "remote_dir" send param to "dir".
+- [UPDATE] send output messages

data/docs/dsl/expect.md

@@ -29,6 +29,9 @@ expect 'obiwan' # Expect previous run command output contains obiwan text
 | 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 |
 
 ## Advanced
 

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/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
+```

data/docs/learn/13-feedback.md

@@ -20,17 +20,16 @@ end
 
 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:
+Each `target` contains following fields:
 
-* Identification: id, description
-* Evaluation result: check(true/false)
-* Punctuation: score, weight
-* Check process: conn_type, command, duration, alterations, expected, result
+* Identification: `id`, `description`
+* Evaluation result: `check`(true/false)
+* Punctuation: `score`, `weight`
+* Check process: `conn_type`, `command`, `duration`, `alterations`, `expected` and `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.
+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.
 
 ## Results
 
@@ -40,7 +39,7 @@ Executing `teuton run examples/13-feedback`, we get this output:
 GROUPS
 - Preserve output reports
     01 (1.0/1.0)
-        Description : Exits user david
+        Description : Exits user Obiwan
         Command     : ********
         Duration    : 0.002 (local)
         Alterations : *******************

data/lib/teuton/case/case.rb

@@ -11,7 +11,6 @@ require_relative "play"
 require_relative "builtin/main"
 
 class Case
-  # Case: export, filename, grade, members,skip
   include DSL
   include Verbose
 

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

@@ -18,9 +18,13 @@ module DSL
   def expect2(cond, args = {})
     @action_counter += 1
     @action[:id] = @action_counter
-    @action[:check] = cond
-
-    @action[:result] = (args[:value] || @result.value)
+    if @result.exitcode < 0
+      @action[:check] = false
+      @action[:result] = @action[:output]
+    else
+      @action[:check] = cond
+      @action[:result] = (args[:value] || @result.value)
+    end
 
     @action[:alterations] = @result.alterations
     @action[:expected] = (args[:expected] || @result.expected)
@@ -57,6 +61,14 @@ module DSL
     expect2 cond, value: real_value, expected: expect_value
   end
 
+  def expect_fail
+    @result.alterations = "Read exit code"
+    real_value = result.exitcode
+    expect_value = "Greater than 0"
+    cond = (real_value > 0)
+    expect2 cond, value: real_value, expected: expect_value
+  end
+
   def expect_first(input, args = {})
     @result.first
     output = input
@@ -95,6 +107,10 @@ module DSL
     expect2 result.count.eq(1), args
   end
 
+  def expect_ok
+    expect_exit 0
+  end
+
   def weight(value = nil)
     # Set weight value for the action
     if value.nil?

data/lib/teuton/case/dsl/macro.rb

@@ -2,7 +2,6 @@
 
 require_relative "../../utils/project"
 
-# DSL module methods: assert, missing_method
 module DSL
   ##
   # Invoke macro

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

@@ -21,8 +21,8 @@ module DSL
     localfilepath = File.join(@report.output_dir, filename)
     filename = args[:prefix].to_s + filename if args[:prefix]
 
-    remotefilepath = if args[:remote_dir]
-      File.join(args[:remote_dir], filename)
+    remotefilepath = if args[:dir]
+      File.join(args[:dir], filename)
     else
       File.join(".", filename)
     end
@@ -32,7 +32,7 @@ module DSL
       Net::SFTP.start(ip, username, password: password, port: port) do |sftp|
         sftp.upload!(localfilepath, remotefilepath)
       end
-      msg = Rainbow("==> File '#{remotefilepath}' of '#{get(:tt_members)}' has been copied").green
+      msg = Rainbow("==> Case #{get(:tt_members)}: report (#{remotefilepath}) copy to (#{ip})").green
       verboseln(msg)
     rescue
       msg = Rainbow("==> [FAIL] #{get(:tt_members)}: 'scp #{localfilepath}' to #{remotefilepath}").red

data/lib/teuton/case/execute/execute_ssh.rb

@@ -35,7 +35,7 @@ class ExecuteSSH < ExecuteBase
       end
     end
 
-    text = ""
+    text = "TEUTON_NODATA"
     exitcode = 0
     begin
       if sessions[hostname].nil?
@@ -49,25 +49,29 @@ class ExecuteSSH < ExecuteBase
           non_interactive: true
         )
       end
-      text = if sessions[hostname].instance_of? Net::SSH::Connection::Session
-        sessions[hostname].exec!(action[:command])
+      if sessions[hostname].instance_of? Net::SSH::Connection::Session
+        text = sessions[hostname].exec!(action[:command])
+        exitcode = text.exitstatus
       else
-        "SSH: NO CONNECTION!"
+        text = "TEUTON_ERROR_SSH_NO_CONNECTION"
+        exitcode = -1
       end
-      exitcode = text.exitstatus
     rescue Errno::EHOSTUNREACH
       sessions[hostname] = :nosession
       conn_status[hostname] = :host_unreachable
+      text = "TEUTON_ERROR_SSH_HOST_UNREACHABLE"
       exitcode = -1
       log("Host #{ip} unreachable!", :error)
     rescue Net::SSH::AuthenticationFailed
       sessions[hostname] = :nosession
       conn_status[hostname] = :error_authentication_failed
+      text = "TEUTON_ERROR_SSH_AUTH_FAILED"
       exitcode = -1
       log("SSH::AuthenticationFailed!", :error)
     rescue Net::SSH::HostKeyMismatch
       sessions[hostname] = :nosession
       conn_status[hostname] = :host_key_mismatch
+      text = "TEUTON_ERROR_SSH_HOST_KEY"
       exitcode = -1
       log("SSH::HostKeyMismatch!", :error)
       log("* The destination server's fingerprint is not matching " \
@@ -78,13 +82,13 @@ class ExecuteSSH < ExecuteBase
     rescue => e
       sessions[hostname] = :nosession
       conn_status[hostname] = :error
+      text = "TEUTON_ERROR_SSH"
       exitcode = -1
       log("[#{e.class}] SSH on <#{username}@#{ip}>" \
           " exec: #{action[:command]}", :error)
     end
-    output = encode_and_split(action[:encoding], text)
     result.exitcode = exitcode
-    result.content = output
+    result.content = encode_and_split(action[:encoding], text)
     result.content.compact!
   end
 end

data/lib/teuton/case_manager/show_report.rb

@@ -1,5 +1,6 @@
 require "rainbow"
 require "terminal-table"
+# require_relative "../utils/application"
 require_relative "../utils/project"
 
 # | Verbosity level | Description |
@@ -121,11 +122,12 @@ class ShowReport
   end
 
   def show_hall_of_fame
-    return if Project.value[:hall_of_fame].size < 3
+    hall_of_fame = Project.value[:hall_of_fame]
+    return if hall_of_fame.size < 3
 
     puts Rainbow("HALL OF FAME").bright
     my_screen_table = Terminal::Table.new do |st|
-      app.hall_of_fame.each do |line|
+      hall_of_fame.each do |line|
         st.add_row [line[0], line[1]]
       end
     end

data/lib/teuton/report/formatter/default/txt.rb

@@ -94,8 +94,8 @@ class TXTFormatter < ArrayFormatter
       w "#{tab * 4}Output      : #{i[:output]}\n"
       w "#{tab * 4}Duration    : #{i[:duration]} (#{i[:conn_type]})\n"
       w "#{tab * 4}Alterations : #{i[:alterations]}\n"
-      w "#{tab * 4}Expected    : #{i[:expected]} (#{i[:expected].class})\n"
-      w "#{tab * 4}Result      : #{i[:result]} (#{i[:result].class})\n"
+      w "#{tab * 4}Expected    : #{i[:expected]}\n"
+      w "#{tab * 4}Result      : #{i[:result]}\n"
     end
   end
 end

data/lib/teuton/utils/application.rb

@@ -11,10 +11,7 @@ class Application
   attr_accessor :verbose
   attr_accessor :global # Global configuration params
   attr_accessor :ialias # Internal alias
-  attr_accessor :macros # Array of macros
-  attr_accessor :groups # Array of groups
   attr_accessor :uses # Array of uses
-  attr_accessor :hall_of_fame
   attr_accessor :project_path, :script_path, :config_path, :test_name
 
   def initialize
@@ -42,10 +39,7 @@ class Application
 
     @global = {}
     @ialias = {}
-    @macros = {}
-    @groups = []
     @uses = [] # TODO
-    @hall_of_fame = []
   end
 
   def debug

data/lib/teuton/version.rb

@@ -1,5 +1,5 @@
 module Teuton
-  VERSION = "2.7.2"
+  VERSION = "2.8.0"
   APPNAME = "teuton"
   GEMNAME = "teuton"
   DOCKERNAME = "dvarrui/#{GEMNAME}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 2.7.2
+  version: 2.8.0
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-07 00:00:00.000000000 Z
+date: 2023-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -134,6 +134,7 @@ extra_rdoc_files:
 - docs/changelog/v2.5.md
 - docs/changelog/v2.6.md
 - docs/changelog/v2.7.md
+- docs/changelog/v2.8.md
 - docs/changelog/version2.1.md
 - docs/commands/README.md
 - docs/commands/example_check.md
@@ -204,6 +205,7 @@ files:
 - docs/changelog/v2.5.md
 - docs/changelog/v2.6.md
 - docs/changelog/v2.7.md
+- docs/changelog/v2.8.md
 - docs/changelog/version2.1.md
 - docs/commands/README.md
 - docs/commands/example_check.md