teuton 2.1.8 → 2.1.9

data/docs/learn/example-04-use.md

@@ -1,6 +1,10 @@
-
 [<< back](README.md)
 
+1. [Tree directory](#tree-directory)
+2. [Execution section](#execution-section)
+3. [Users file](#users-file)
+4. [Network file](#network-file)
+
 # Example: learn-04-use
 
 Learn how to:
@@ -14,8 +18,8 @@ Learn how to:
 This example has more files:
 
 ```bash
-$ tree learn/learn-04-use
-learn/learn-04-require
+$ tree example/learn-04-use
+example/learn-04-require
 ├── config.yaml
 ├── network.rb
 ├── README.md
@@ -23,11 +27,11 @@ learn/learn-04-require
 └── users.rb
 ```
 
-* `README.md` and `config.yaml` are the same as previous examples.
+* `README.md` and `config.yaml` are the same as previous example.
 
-## Execution (play section)
+## Execution section
 
-Previous `start.rb` file is splited in: start.rb, users.rb and network.rb.
+Previous `start.rb` file is now splited in: start.rb, users.rb and network.rb.
 
 Let's see current `start.rb` file:
 
@@ -43,35 +47,37 @@ end
 
 * `use`, indicates external rb file that will be included/imported into main rb file. It's a good idea to organize project files, when the number of groups/targets is high.
 
-## Definitions (user section)
+## Users file
 
 > Require Windows OS on remote machine.
 
 Let's see `users.rb` file
+
 ```ruby
-group "User configuration" do
-  target "Exist user <#{get(:username)}>"
-  goto   :host1, :exec => "net user"
+group "Use file: User configuration" do
+
+  target "Create user #{gett(:username)}"
+  run "net user", on: :host1
   expect get(:username)
-end
 
+end
 ```
 
-## Definitions (network section)
+## Network file
 
 > Require Windows OS on remote machine.
 
 Let's see `network.rb` file:
 
 ```ruby
-group "Network configuracion" do
+group "Use file: Network configuracion" do
 
-  target "Hostname is <#{get(:host1_hostname)}>"
-  goto   :host1, :exec => "hostname"
+  target "Update computer name with #{gett(:host1_hostname)}"
+  run "hostname", on: :host1
   expect_one get(:host1_hostname)
 
-  target "DNS Server OK"
-  goto   :host1, :exec => "nslookup www.nba.es"
+  target "Ensure DNS Server is working"
+  run "nslookup www.google.es", on: :host1
   expect "Nombre:"
 
 end

data/docs/learn/example-05-debug.md

@@ -1,6 +1,11 @@
 
 [<< back](README.md)
 
+1. [Tree directory](#tree-directory)
+2. [Execution section](#execution-section)
+3. [Check test](#check-test)
+4. [Debug](#debug)
+
 # Example: learn-05-debug
 
 Learn how to:
@@ -13,7 +18,7 @@ Learn how to:
 
 ```bash
 $ tree learn/learn-05-debug
-learn/learn-05-debug
+example/learn-05-debug
 ├── config.yaml
 ├── external.rb
 ├── internal.rb
@@ -21,7 +26,7 @@ learn/learn-05-debug
 └── start.rb
 ```
 
-## Execution (play section)
+## Execution section
 
 The `start.rb`  is main execution rb file, and uses `external` and `internal` rb files.
 
@@ -37,24 +42,26 @@ play do
 end
 ```
 
-## Debugging: Testing rb files
+## Check test
 
 Tests grows and becames huge, with a lot of targets (That isn't a problem). Then, we organize them spliting into several files and invoke `use` keywork from our main rb file to load other files (That's good idea) .
 
-When this happend, sometimes we need to verify or check rb file consistency and syntax, and we will do it with `teuton check PATH/TO/PROJECT/FOLDER`. Let's see an example:
+When this happend, sometimes we need to verify or check rb file consistency and syntax, and we will do it with `teuton check PATH/TO/PROJECT/FOLDER`.
+
+Let's see example `teuton check examples/learn-01-target`:
 
 ```bash
-teuton check examples/learn-01-target
-[INFO] ScriptPath => .../teuton.d/teuton/examples/learn-01-target/start.rb
-[INFO] ConfigPath => ...uton.d/teuton/examples/learn-01-target/config.yaml
+[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-01-target |
-+------------------------+
-(001) target      Create user <david>
++----------------------------+
+| GROUP: Learn about targets |
++----------------------------+
+(001) target      Create user david
       weight      1.0
-      goto        localhost and {:exec=>"id david"}
+      run         'id david' on localhost
       expect      david (String)
 
 +--------------+-------+
@@ -83,23 +90,23 @@ teuton check examples/learn-01-target
 
 In this case, Teuton detects that there isn't exist config file, and propose us content for `config.yaml`.
 
-## Debugging: Result content
+## Debug
 
-Every time we invoke `goto` or `run` keywork, an OS command is executed and the output showed on screen is captured by Teuton and saved into `result` internal object.
+Every time we invoke `run` or `goto` keywork, an OS command is executed. The output is showed on screen and saved into **result** internal object.
 
-We could debug it invoking `result.debug` into our rb file. Let's see an example from `external.rb.rb` file:
+We could debug it invoking `result.debug` into our tests. Let's see an example from `external.rb` file:
 
 ```ruby
 group "Windows: external configuration" do
 
   target "Localhost: Verify connectivity with #{gett(:windows1_ip)}"
-  run "ping #{get(:windows1_ip)} -c 1"
+  run    "ping #{get(:windows1_ip)} -c 1"
   result.debug
   expect_one "0% packet loss"
   result.debug
 
   target "Localhost: netbios-ssn service working on #{gett(:windows1_ip)}"
-  run "nmap -Pn #{get(:windows1_ip)}"
+  run    "nmap -Pn #{get(:windows1_ip)}"
   expect "139/tcp", "open"
 
 end

data/docs/learn/example-06-log.md

@@ -0,0 +1,70 @@
+[<< back](README.md)
+
+1. [Definition section](#definition-section)
+2. [Run test](#execution-section)
+3. [Result](#result)
+
+# Example: learn-06-log
+
+Let's learn how to create log messages.
+
+> This example is on GitHub repository at `examples/learn-06-log/`.
+
+## Definition section
+
+Test definition section (Group):
+```ruby
+group "Learning about log messages" do
+  log 'Using log messages...'
+
+  target "Create user david"
+  run    "id david"
+  expect "david"
+
+  log 'Problem detected!', :error
+end
+```
+
+> In this example, localhost's OS must be GNU/Linux (any other compatible OS) because the command used is `id david`.
+
+## Result
+
+**Let's see example**: Content of `var/learn-06-log/case-01.txt` file.
+
+```bash
+CONFIGURATION
++-------------+--------------+
+| tt_members  | anonymous    |
+| tt_sequence | false        |
+| tt_skip     | false        |
+| tt_testname | learn-06-log |
++-------------+--------------+
+
+LOGS
+    [19:23:20] : Using log messages...
+    [19:23:20] ERROR: Problem detected!
+
+GROUPS
+- Learning about log messages
+    01 (1.0/1.0)
+        Description : Create user david
+        Command     : id david
+        Duration    : 0.003 (local)
+        Alterations : find(david) & count
+        Expected    : Greater than 0 (String)
+        Result      : 1 (Integer)
+
+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               |
+| unique_fault | 0                         |
+| max_weight   | 1.0                       |
+| good_weight  | 1.0                       |
+| fail_weight  | 0.0                       |
+| fail_counter | 0                         |
+| grade        | 100                       |
++--------------+---------------------------+
+```

data/lib/teuton/application.rb

@@ -6,7 +6,7 @@ require 'singleton'
 class Application
   include Singleton
 
-  VERSION = '2.1.8' # Application version
+  VERSION = '2.1.9' # Application version
   NAME = 'teuton' # Application name
 
   attr_reader   :letter
@@ -14,8 +14,11 @@ class Application
   attr_reader   :default
   attr_accessor :options
   attr_accessor :verbose
-  attr_accessor :global, :ialias
-  attr_accessor :checks, :groups, :uses
+  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
 
@@ -38,7 +41,7 @@ class Application
 
     @global = {}
     @ialias = {}
-    @checks = {}
+    @macros = {}
     @groups = []
     @uses = [] # TODO
     @hall_of_fame = []

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

@@ -82,8 +82,11 @@ class Case
     @report.export format
   end
 
+  ##
+  # Return case report filename
+  # @return String
   def filename
-    @report.filename #+ '.' + @report.format.to_s
+    @report.filename
   end
 
   ##

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rainbow'
+
 # DSL module:
 # * expect_none
 # * expect_one
@@ -62,7 +64,7 @@ module DSL
     app = Application.instance
     c = app.letter[:bad]
     c = app.letter[:good] if cond
-    verbose c
+    verbose Rainbow(c).yellow.bright
   end
 
   # Set weight value for the action

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

@@ -6,10 +6,22 @@ require_relative '../runner'
 # * goto
 # * run
 module DSL
+  ##
+  # DLS run: It's the same as goto :localhost
+  # @param command (String)
+  # @param args (Hash)
+  def run(command, args = {})
+    args[:exec] = command.to_s
+    host = :localhost
+    host = args[:on] if args[:on]
+    goto(host, args)
+  end
+
   # Run command from the host identify as pHostname
   # goto :host1, :execute => "command"
   def goto(host = :localhost, args = {})
     @result.reset
+    args[:on] = host unless args[:on]
     @action[:command] = args[:execute] if args[:execute]
     @action[:command] = args[:exec] if args[:exec]
     tempfile(args[:tempfile]) if args[:tempfile]
@@ -20,11 +32,4 @@ module DSL
     @action[:duration] = (Time.now - start_time).round(3)
   end
   alias on goto
-
-  ##
-  # DLS run: It's the same as goto :localhost
-  def run(command, args = {})
-    args[:exec] = command.to_s
-    goto(:localhost, args)
-  end
 end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require_relative '../../../application'
+
+# DSL module methods: assert, missing_method
+module DSL
+  ##
+  # Invoke macro
+  # @param name (String) Macro name
+  # @param input (Hash) Macro params
+  def macro(name, input = {})
+    macros = Application.instance.macros
+    unless macros[name]
+      log("Macro #{name} not found!", :error)
+      return
+    end
+    input.each_pair { |k, v| set(k, v) }
+    errors = []
+    macros[name][:args].each do |i|
+      errors << i if get(i) == 'NODATA'
+    end
+    if errors.count > 0
+      log("Macro #{name} => required params #{errors.join(',')}",:error)
+    else
+      instance_eval(&macros[name][:block])
+    end
+    input.each_pair { |k, v| unset(k) }
+  end
+
+  # If a method call is missing, then:
+  # * delegate to concept parent.
+  # * Invoke macro (assert)
+  def method_missing(method, args = {})
+    a = method.to_s
+    return instance_eval("get(:#{a[0, a.size - 1]})") if a[a.size - 1] == '?'
+    return macro a[6, a.size], args if a[0,6]=='macro_'
+    macro a, args
+  end
+end

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

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'check'
 require_relative 'expect'
 require_relative 'getset'
 require_relative 'goto'
 require_relative 'log'
-require_relative 'missing'
+require_relative 'macro'
 require_relative 'send'
 require_relative 'target'
 require_relative 'unique'

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

@@ -3,7 +3,7 @@
 # DSL#target
 module DSL
   def readme(_text)
-    # Usefull for "teuton reamde" action.
+    # Usefull only for "teuton reamde" command action.
   end
 
   def target(desc, args = {})

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

@@ -84,17 +84,17 @@ class Case
     rescue Errno::EHOSTUNREACH
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :host_unreachable
-      verbose Application.instance.letter[:error]
+      verbose Rainbow(Application.instance.letter[:error]).red.bright
       log("Host #{ip} unreachable!", :error)
     rescue Net::SSH::AuthenticationFailed
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :error_authentication_failed
-      verbose Application.instance.letter[:error]
+      verbose Rainbow(Application.instance.letter[:error]).red.bright
       log('SSH::AuthenticationFailed!', :error)
     rescue Net::SSH::HostKeyMismatch
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :host_key_mismatch
-      verbose Application.instance.letter[:error]
+      verbose Rainbow(Application.instance.letter[:error]).red.bright
       log('SSH::HostKeyMismatch!', :error)
       log("* The destination server's fingerprint is not matching " \
           'what is in your local known_hosts file.', :error)
@@ -104,7 +104,7 @@ class Case
     rescue StandardError => e
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :error
-      verbose Application.instance.letter[:error]
+      verbose Rainbow(Application.instance.letter[:error]).red.bright
       log("[#{e.class}] SSH on <#{username}@#{ip}>" \
           " exec: #{@action[:command]}", :error)
     end
@@ -137,18 +137,18 @@ class Case
     rescue Net::OpenTimeout
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :open_timeout
-      verbose Application.instance.letter[:error]
+      verbose Rainbow(Application.instance.letter[:error]).red.bright
       log(" ExceptionType=<Net::OpenTimeout> doing <telnet #{ip}>", :error)
       log(' └── Revise host IP!', :warn)
     rescue Net::ReadTimeout
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :read_timeout
-      verbose Application.instance.letter[:error]
+      verbose Rainbow(Application.instance.letter[:error]).red.bright
       log(" ExceptionType=<Net::ReadTimeout> doing <telnet #{ip}>", :error)
     rescue StandardError => e
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :error
-      verbose Application.instance.letter[:error]
+      verbose Rainbow(Application.instance.letter[:error]).red.bright
       log(" ExceptionType=<#{e.class}> doing telnet on <#{username}@#{ip}>" \
           " exec: #{@action[:command]}", :error)
       log(" └── username=<#{username}>, password=<#{password}>," \