teuton 2.1.11 → 2.2.2

data/docs/learn/{example-07-readme.md → example-08-readme.md}

@@ -1,21 +1,21 @@
 [<< back](README.md)
 
-1. [Definition section](#definition-section)
-2. [Execute command](#execute-command)
-3. [Result](#result)
-
 # Example: learn-07-readme
 
+> This example is on GitHub repository at `examples/learn-08-readme/`.
+
 Create README files (with test instructions) from our test definition.
 
-> This example is on GitHub repository at `examples/learn-07-readme/`.
+1. [Definition section](#definition-section)
+2. [Execute command](#execute-command)
+3. [Result](#result)
 
 ## Definition section
 
 Take a look at our test definition section (Group):
 ```ruby
 group "Customize readme output" do
-  readme "This is our example 07."
+  readme "This is our README example."
   readme "And here we'll see how to use readme keyword"
 
   target "Create user david."
@@ -37,19 +37,19 @@ There exists some `readme` instructions after `group` and `target` lines.
 To generate automatically a README file from previous test, execute this:
 
 ```
-teuton readme example/learn-07-readme > example/learn-07-readme/README.md
+teuton readme example/learn-08-readme > example/learn-08-readme/README.md
 ```
 
 ## Result
 
-**Let's see the output**: Content of `example/learn-07-readme/README.md` file.
+**Let's see the output**: Content of `example/learn-08-readme/README.md` file.
 
 ---
-# learn-07-readme
+# learn-08-readme
 
 ## Customize readme output
 
-This is our example 07.
+This is our README example.
 And here we'll see how to use readme keyword
 
 Go to [LOCALHOST](#required-hosts) host, and do next:

data/docs/learn/{example-08-preserve.md → example-09-preserve.md}

@@ -1,13 +1,13 @@
 [<< back](README.md)
 
-1. [Execution section](#execution-section)
-2. [Result](#result)
+# Example: learn-09-preserve
 
-# Example: learn-08-preserve
+> This example is on GitHub repository at `examples/learn-09-preserve/`.
 
 Older output report files are overwritten with new reports, every time we run teuton test. With `preserve` option we keep copies.
 
-> This example is on GitHub repository at `examples/learn-08-preserve/`.
+1. [Execution section](#execution-section)
+2. [Result](#result)
 
 ## Execution section
 
@@ -22,11 +22,11 @@ end
 > More information about [export](../dsl/execution/export.md) keyword.
 ## Result
 
-Example, executing `teuton run example/learn-08-preserve` twice:
+Example, executing `teuton run example/learn-09-preserve` twice:
 
 ```
 var
-└── learn-08-preserve
+└── learn-09-preserve
     ├── 20200519-113035
     │   ├── case-01.txt
     │   ├── moodle.csv

data/docs/videos.md

@@ -0,0 +1,19 @@
+[<< back](../README.md)
+
+# News
+
+* [Introducción a Teuton](https://elpuig.xeill.net/Members/vcarceler/articulos/introduccion-a-teuton): iniciarse en el uso de Teutón gracias al fantástico artículo de Víctor Carceler.
+* [Verificar prácticas de GNS3 con Teuton](https://elpuig.xeill.net/Members/juanmorote/articulos/verificar-practicas-de-gns3-con-teuton): GNS3 es un excelente simulador de red Open Source que además se entiende con Teuton a las mil maravillas.
+
+# Videos
+
+Teuton en el 2016 se llamaba "sysadmingame".
+* [CHAPI16 - Presentación sysadmingame chapi16 - Abril 2016](https://youtu.be/cNJaB5xzHHQ)
+* sysadmingame:
+    1. [Instalación del programa](https://youtu.be/dnyMq9_KDco)
+    2. [Crear un caso simple](https://youtu.be/0e2g5Izvc6c)
+    3. [Crear un caso complejo](https://youtu.be/ebEK6OXH8kQ)
+
+Teuton:
+* [Apuntes FP Informática - I Congreso Virtual - Mayo 2020](https://youtu.be/RxIV26BAoGo)
+* [Teuton Software 2.1 - Tutorial - Oct 2020](https://youtu.be/cyBN-rOYQeY)

data/lib/teuton/application.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 require 'singleton'
+require_relative 'version'
+require_relative 'utils/name_file_finder'
 
 # This Singleton contains application params
 class Application
   include Singleton
-
-  VERSION = '2.1.11' # Application version
-  NAME = 'teuton' # Application name
+  include Teuton
 
   attr_reader   :letter
   attr_reader   :running_basedir, :output_basedir
@@ -71,4 +71,23 @@ class Application
 
     false
   end
+
+  ##
+  # Preprocess input options:
+  # * Convert input case options String to an Array of integers
+  # * Read color input option
+  # rubocop:disable Metrics/AbcSize
+  def add_input_params(projectpath, options)
+    @options.merge! options
+    NameFileFinder.find_filenames_for(projectpath)
+    @options['color'] = true if @options['color'].nil?
+    Rainbow.enabled = @options['color']
+    @options['panel'] = false if @options['panel'].nil?
+
+    return if @options['case'].nil?
+
+    a = @options['case'].split(',')
+    @options['case'] = a.collect!(&:to_i)
+  end
+  # rubocop:enable Metrics/AbcSize
 end

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

@@ -22,8 +22,8 @@ module DSL
   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]
+    @action[:command] = args[:execute].to_s if args[:execute]
+    @action[:command] = args[:exec].to_s if args[:exec]
     tempfile(args[:tempfile]) if args[:tempfile]
     @action[:encoding] = args[:encoding] || 'UTF-8'
 

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require_relative '../../../application'
+require 'os'
 
 # DSL module methods: assert, missing_method
 module DSL

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

@@ -18,6 +18,7 @@ module DSL
     ip = get((host + '_ip').to_sym)
     username = get((host + '_username').to_sym).to_s
     password = get((host + '_password').to_sym).to_s
+    port = get((host + '_port').to_sym) || 22
 
     filename = @report.filename + '.' + @report.format.to_s
     localfilepath = File.join(@report.output_dir, filename)
@@ -32,7 +33,7 @@ module DSL
 
     # Upload a file or directory to the remote host
     begin
-      Net::SFTP.start(ip, username, password: password) do |sftp|
+      Net::SFTP.start(ip, username, password: password, port: port) do |sftp|
         sftp.upload!(localfilepath, remotefilepath)
       end
       verboseln("=> [ OK  ] #{(get(:tt_members)[0,15]).ljust(16)} : #{remotefilepath}")

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

@@ -58,6 +58,7 @@ class Case
 
   ##
   # Fill case report with time information
+  # rubocop:disable Metrics/AbcSize
   def fill_report(start_time, finish_time)
     @report.head.merge! @config.global
     @report.head.merge! @config.local
@@ -67,4 +68,5 @@ class Case
     @report.tail[:finish_time] = finish_time
     @report.tail[:duration] = finish_time - start_time
   end
+  # rubocop:enable Metrics/AbcSize
 end

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

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
 # This is an extension of Result class
+# rubocop:disable Metrics/ClassLength
 class Result
+  # rubocop:disable Metrics/MethodLength
+  # Return true when content is equal than input
+  # @param input (Object)
   def eq(input)
     @expected = input
 
@@ -21,11 +25,13 @@ class Result
     end
     value == input
   end
+  # rubocop:enable Metrics/MethodLength
   alias eq?        eq
   alias equal      eq
   alias equal?     eq
   alias is_equal?  eq
 
+  # rubocop:disable Metrics/MethodLength
   def neq(external)
     @expected = "Not equal to #{external}"
 
@@ -43,10 +49,12 @@ class Result
     end
     internal != external
   end
+  # rubocop:enable Metrics/MethodLength
   alias neq?       neq
   alias not_equal  neq
   alias not_equal? neq
 
+  # rubocop:disable Metrics/MethodLength
   def ge(input)
     @expected = "Greater or equal to #{input}"
     return false if @content.nil? || @content[0].nil?
@@ -64,9 +72,11 @@ class Result
     end
     value >= input
   end
+  # rubocop:enable Metrics/MethodLength
   alias greater_or_equal  ge
   alias greater_or_equal? ge
 
+  # rubocop:disable Metrics/MethodLength
   def gt(input)
     @expected = "Greater than #{input}"
     return false if @content.nil? || @content[0].nil?
@@ -84,9 +94,11 @@ class Result
     end
     value > input
   end
+  # rubocop:enable Metrics/MethodLength
   alias greater          gt
   alias greater_than     gt
 
+  # rubocop:disable Metrics/MethodLength
   def le(input)
     @expected = "Lesser or equal to #{input}"
 
@@ -105,9 +117,11 @@ class Result
     end
     value <= input
   end
+  # rubocop:enable Metrics/MethodLength
   alias lesser_or_equal  le
   alias lesser_or_equal? le
 
+  # rubocop:disable Metrics/MethodLength
   def lt(input)
     @expected = "Lesser than #{input}"
     return false if @content.nil? || @content[0].nil?
@@ -125,6 +139,7 @@ class Result
     end
     value < input
   end
+  # rubocop:enable Metrics/MethodLength
   alias lesser  lt
   alias smaller lt
   alias lesser_than lt
@@ -145,3 +160,4 @@ class Result
   alias near? near_to?
   alias near near_to?
 end
+# rubocop:enable Metrics/ClassLength

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

@@ -44,7 +44,7 @@ class Result
     print " [DEBUG] count=#{@content.count} "
     puts '*' * 20
     @content.each_with_index do |item, index|
-      puts format('%2d: %s', index, item)
+      puts format('%<index>2d: %<item>s', { index: index, item: item })
     end
     puts '*' * 57
   end

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

@@ -8,6 +8,7 @@ require_relative 'dsl/log'
 # * run_local_cmd
 # * run_remote_cmd
 # * run_remote_cmd_ssh
+# * reconfigure_command_with_gateway
 # * run_remote_cmd_telnet
 class Case
 
@@ -65,21 +66,45 @@ class Case
   def run_cmd_remote_ssh(input_hostname)
     @action[:conn_type] = :ssh
     hostname = input_hostname.to_s
-    ip = @config.get((hostname + '_ip').to_sym)
-    username = @config.get((hostname + '_username').to_sym).to_s
-    password = @config.get((hostname + '_password').to_sym).to_s
+    ip = @config.get("#{hostname}_ip".to_sym).to_s
+    username = @config.get("#{hostname}_username".to_sym).to_s
+    password = @config.get("#{hostname}_password".to_sym).to_s
+    port = @config.get("#{hostname}_port".to_sym).to_i || 22
+
+    unless @config.get("#{hostname}_route".to_sym) == 'NODATA'
+      # Reconfigure command with gateway. Example host1_route: IP.
+      hostname2 = hostname
+      ip2 = ip
+      username2 = username
+      password2 = password
+      command2 = @action[:command]
+      hostname = @config.get("#{hostname}_route".to_sym)
+      ip = @config.get("#{hostname}_ip".to_sym).to_s
+      username = @config.get("#{hostname}_username".to_sym).to_s
+      password = @config.get("#{hostname}_password".to_sym).to_s
+      ostype = @config.get("#{hostname}_ostype".to_sym).to_s
+
+      if ostype.downcase.start_with? 'win'
+        # echo y | plink idp@2.tcp.eu.ngrok.io -ssh -P 16256 -pw idp "echo > Desktop\hola.txt"
+        @action[:command] = "echo y | plink #{username2}@#{ip2} -ssh -pw #{password2} \"#{command2}\""
+      else
+        @action[:command] = "sshpass -p #{password2} #{username2}@#{ip2} #{command2}"
+      end
+    end
+
     text = ''
     begin
       if @sessions[hostname].nil?
         @sessions[hostname] = Net::SSH.start(ip,
                                              username,
+                                             port: port,
                                              password: password,
                                              keepalive: true,
                                              timeout: 30,
                                              non_interactive: true)
       end
       if @sessions[hostname].class == Net::SSH::Connection::Session
-        text = @sessions[hostname].exec!(@action[:command].to_s)
+        text = @sessions[hostname].exec!(@action[:command])
       end
     rescue Errno::EHOSTUNREACH
       @sessions[hostname] = :nosession
@@ -109,6 +134,7 @@ class Case
           " exec: #{@action[:command]}", :error)
     end
     output = encode_and_split(@action[:encoding], text)
+    # revise: @result.exitstatus = text.exitstatus
     @result.content = output
     @result.content.compact!
   end

data/lib/teuton/case_manager/case_manager.rb

@@ -3,7 +3,7 @@
 require 'singleton'
 require_relative '../application'
 require_relative '../report/report'
-require_relative '../project/configfile_reader'
+require_relative '../utils/configfile_reader'
 require_relative 'case/case'
 require_relative 'export_manager'
 require_relative 'main'

data/lib/teuton/case_manager/export_manager.rb

@@ -10,16 +10,10 @@ module ExportManager
   # @param main_report (Report)
   # @param cases (Array)
   # @param input (Hash) Selected export options
-  # rubocop: disable Metrics/AbcSize
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/CyclomaticComplexity
   def self.run(main_report, cases, input)
-    args = {}
-    input.each_pair do |key, value|
-      if value.class == String
-        args[key] = value.to_sym
-      else
-        args[key] = value
-      end
-    end
+    args = strings2symbols(input)
 
     # default :mode=>:all, :format=>:txt
     format = args[:format] || Application.instance.default[:format]
@@ -36,12 +30,29 @@ module ExportManager
     preserve_files if args[:preserve] == true
   end
   # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/CyclomaticComplexity
+
+  ##
+  # Convert Hash String values into Symbol values
+  # @param input (Hash)
+  # rubocop:disable Style/ConditionalAssignment
+  private_class_method def self.strings2symbols(input)
+    args = {}
+    input.each_pair do |key, value|
+      if value.class == String
+        args[key] = value.to_sym
+      else
+        args[key] = value
+      end
+    end
+    args
+  end
+  # rubocop:enable Style/ConditionalAssignment
 
   ##
   # Preserve output files for current project
   # rubocop:disable Metrics/AbcSize
   # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Layout/LineLength
   private_class_method def self.preserve_files
     app = Application.instance
     t = Time.now
@@ -57,5 +68,4 @@ module ExportManager
   end
   # rubocop:enable Metrics/AbcSize
   # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Layout/LineLength
 end

data/lib/teuton/case_manager/utils.rb

@@ -26,7 +26,7 @@ module Utils
       text = ec.convert(text)
     rescue StandardError => e
       puts "[ERROR] #{e}: Declare text encoding..."
-      puts "        goto :host, :exec => 'command', :encoding => 'ISO-8859-1'"
+      puts "        run 'command', on: :host, :encoding => 'ISO-8859-1'"
     end
 
     text.split("\n")

data/lib/teuton/{project/laboratory → check}/dsl.rb

@@ -1,36 +1,27 @@
-# Laboratory
-# * target
-# * request (development)
-# * tempfile
-# * goto
-# * run
-# * expect
-# * get
-# * unique
-# * log
-# * set
+# frozen_string_literal: true
+
+##
+# Include Teuton DSL keywords into Laboratory class
 class Laboratory
+  ##
+  # Execute Teuton DSL readme keyword
   def readme(_text)
     # Usefull for "teuton readme" command action.
   end
 
+  ##
+  # Execute Teuton DSL target keyword
   def target(desc, args = {})
     @stats[:targets] += 1
     @targetid += 1
     weight = args[:weight] || 1.0
-    verboseln '(%03d' % @targetid + ") target      #{desc}"
+    verboseln format('(%03<targetid>d) target      %<desc>s', targetid: @targetid, desc: desc)
     verboseln "      weight      #{weight}"
   end
   alias goal target
 
-#  def request(text)
-#    @requests << text.to_s
-#  end
-
-  def tempfile(_tempfile = nil)
-    'tempfile'
-  end
-
+  ##
+  # Execute Teuton DSL run keyword
   def run(command, args = {})
     args[:exec] = command
     host = :localhost
@@ -38,6 +29,8 @@ class Laboratory
     goto(host, args)
   end
 
+  ##
+  # Execute Teuton DSL goto keyword
   def goto(host = :localhost, args = {})
     result.reset
     args[:on] = host unless args[:on]
@@ -50,24 +43,32 @@ class Laboratory
     verboseln "      run         '#{args[:exec]}' on #{args[:on]}"
   end
 
-  def expect(_cond, args = {})
+  ##
+  # Execute Teuton DSL expect keyword
+  def expect(cond)
     verboseln "      alter       #{result.alterations}" unless result.alterations.empty?
-    verboseln "      expect      #{_cond} (#{_cond.class})"
+    verboseln "      expect      #{cond} (#{cond.class})"
     verboseln ''
   end
 
-  def expect_one(_cond, args = {})
+  ##
+  # Execute Teuton DSL expect_one keyword
+  def expect_one(cond)
     verboseln "      alter       #{result.alterations}" unless result.alterations.empty?
-    verboseln "      expect_one  #{_cond} (#{_cond.class})"
+    verboseln "      expect_one  #{cond} (#{cond.class})"
     verboseln ''
   end
 
-  def expect_none(_cond, args = {})
+  ##
+  # Execute Teuton DSL expect_none keyword
+  def expect_none(cond)
     verboseln "      alter       #{result.alterations}" unless result.alterations.empty?
-    verboseln "      expect_none #{_cond} (#{_cond.class})"
+    verboseln "      expect_none #{cond} (#{cond.class})"
     verboseln ''
   end
 
+  ##
+  # Execute Teuton DSL get keyword
   def get(varname)
     @stats[:gets] += 1
 
@@ -80,17 +81,24 @@ class Laboratory
     "get(#{varname})"
   end
 
-  # If a method call is missing, then delegate to concept parent.
+  # If a method call is missing, then try to call get(var)
+  # rubocop:disable Style/MissingRespondToMissing
   def method_missing(method)
     a = method.to_s
-    instance_eval("get(:#{a[0, a.size - 1]})") if a[a.size - 1] == '?'
+    instance_eval("get(:#{a[0, a.size - 1]})", __FILE__, __LINE__) if a[a.size - 1] == '?'
   end
+  # rubocop:enable Style/MissingRespondToMissing
 
+  ##
+  # Execute Teuton DSL gett keyword
+  # Same as get keyword, but show pretty output when used by readme command.
   def gett(option)
     value = get(option)
     value
   end
 
+  ##
+  # Execute Teuton DSL unique keyword
   def unique(key, _value)
     @stats[:uniques] += 1
 
@@ -98,11 +106,15 @@ class Laboratory
     verboseln ''
   end
 
+  ##
+  # Execute Teuton DSL log keyword
   def log(text = '', type = :info)
     @stats[:logs] += 1
     verboseln "      log    [#{type}]: " + text.to_s
   end
 
+  ##
+  # Execute Teuton DSL set keyword
   def set(key, value)
     @stats[:sets] += 1
 

data/lib/teuton/{project/laboratory → check}/laboratory.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
-require 'terminal-table'
-require 'rainbow'
-
-require_relative '../../application'
-require_relative '../../case_manager/case/result/result'
+require_relative '../application'
+require_relative '../case_manager/case/result/result'
 require_relative 'show'
 require_relative 'dsl'
 require_relative 'builtin'
@@ -35,7 +32,7 @@ alias task group
 # DSL start: Define main teuton test execution
 # @param block (Proc)
 def start(&block)
-  # don't do nothing
+  # Don't do nothing. We are checking test not running it
 end
 alias play start
 
@@ -54,8 +51,6 @@ class Laboratory
     reset
   end
 
-  ##
-  # Set attibutes to default values
   def reset
     @result = Result.new
     @targetid = 0