teuton 2.1.10 → 2.3.1

data/docs/learn/{example-06-log.md → example-07-log.md}

@@ -1,14 +1,14 @@
 [<< back](README.md)
 
-1. [Definition section](#definition-section)
-2. [Run test](#execution-section)
-3. [Result](#result)
+# Example: learn-07-log
 
-# Example: learn-06-log
+> This example is on GitHub repository at `examples/learn-06-log/`.
 
 Let's learn how to create log messages.
 
-> This example is on GitHub repository at `examples/learn-06-log/`.
+1. [Definition section](#definition-section)
+2. [Run test](#execution-section)
+3. [Result](#result)
 
 ## Definition section
 
@@ -29,7 +29,7 @@ end
 
 ## Result
 
-**Let's see example**: Content of `var/learn-06-log/case-01.txt` file.
+**Let's see example**: Content of `var/learn-07-log/case-01.txt` file.
 
 ```bash
 CONFIGURATION
@@ -37,7 +37,7 @@ CONFIGURATION
 | tt_members  | anonymous    |
 | tt_sequence | false        |
 | tt_skip     | false        |
-| tt_testname | learn-06-log |
+| tt_testname | learn-07-log |
 +-------------+--------------+
 
 LOGS

data/docs/learn/example-08-readme.md

@@ -0,0 +1,59 @@
+[<< back](README.md)
+
+# 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.
+
+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 README example."
+  readme "And here we'll see how to use readme keyword"
+
+  target "Create user david."
+  readme "Help: you can use 'useradd' command to create users."
+  readme "Remember: Only root is permitted to create new users."
+
+  run "id david"
+  expect "david"
+
+end
+```
+
+> In this example, localhost's OS must be GNU/Linux (any other compatible OS) because the command used is `id david`.
+
+There exists some `readme` instructions after `group` and `target` lines.
+
+## Execute command
+
+To generate automatically a README file from previous test, execute this:
+
+```
+teuton readme example/learn-08-readme > example/learn-08-readme/README.md
+```
+
+## Result
+
+**Let's see the output**: Content of `example/learn-08-readme/README.md` file.
+
+---
+# learn-08-readme
+
+## Customize readme output
+
+This is our README example.
+And here we'll see how to use readme keyword
+
+Go to [LOCALHOST](#required-hosts) host, and do next:
+* Create user david.
+    * Help: you can use 'useradd' command to create users.
+    * Remember: Only root is permitted to create new users.
+---

data/docs/learn/example-09-preserve.md

@@ -0,0 +1,41 @@
+[<< back](README.md)
+
+# Example: learn-09-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.
+
+1. [Execution section](#execution-section)
+2. [Result](#result)
+
+## Execution section
+
+Take a look at our test execution section (Play):
+```ruby
+play do
+  show
+  export preserve: true
+end
+```
+
+> More information about [export](../dsl/execution/export.md) keyword.
+## Result
+
+Example, executing `teuton run example/learn-09-preserve` twice:
+
+```
+var
+└── learn-09-preserve
+    ├── 20200519-113035
+    │   ├── case-01.txt
+    │   ├── moodle.csv
+    │   └── resume.txt
+    ├── 20200520-113039
+    │   ├── case-01.txt
+    │   ├── moodle.csv
+    │   └── resume.txt
+    ├── case-01.txt
+    ├── moodle.csv
+    └── resume.txt
+```

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.10' # 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/builtin/main.rb

@@ -1,24 +1,8 @@
 
-require_relative 'package'
-require_relative 'service'
-require_relative 'user'
+require_relative 'teuton_host'
 
 class Case
-  def package(param)
-    @package = @package || Package.new(self)
-    @package.param = param
-    @package
-  end
-
-  def service(param)
-    @service = @service || Service.new(self)
-    @service.param = param
-    @service
-  end
-
-  def user(param)
-    @user = @user || User.new(self)
-    @user.param = param
-    @user
+  def host(host = 'localhost')
+    TeutonHost.new(self, host)
   end
 end

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

@@ -1,20 +1,21 @@
 
 class Package
-  attr_accessor :param
-
-  def initialize(parent)
-    @parent = parent
+  def initialize(teuton_host, param)
+    @teuton_host = teuton_host
+    @parent = teuton_host.parent
+    @host = teuton_host.host
+    @param = param
   end
 
   def installed?
     @parent.target("Package #{@param} installed?")
-    @parent.run "whereis #{@param}"
+    @parent.run "whereis #{@param}", on: @host
     @parent.expect_one [ 'bin', @param ]
   end
 
   def not_installed?
     @parent.target("Package #{@param} not installed?")
-    @parent.run "whereis #{@param}"
+    @parent.run "whereis #{@param}", on: @host
     @parent.expect_none [ 'bin' , @param ]
   end
 end

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

@@ -1,32 +1,33 @@
 
 class Service
-  attr_accessor :param
-
-  def initialize(parent)
-    @parent = parent
+  def initialize(teuton_host, param)
+    @teuton_host = teuton_host
+    @parent = teuton_host.parent
+    @host = teuton_host.host
+    @param = param
   end
 
   def is_running?
     @parent.target("Service #{@param} is running?")
-    @parent.run "systemctl status #{@param}"
+    @parent.run "systemctl status #{@param}", on: @host
     @parent.expect_one ['Active:', 'running' ]
   end
 
   def is_inactive?
     @parent.target("Service #{@param} is inactive?")
-    @parent.run "systemctl status #{@param}"
+    @parent.run "systemctl status #{@param}", on: @host
     @parent.expect_one ['Active:', 'inactive' ]
   end
 
   def is_enable?
     @parent.target("Service #{@param} is enable?")
-    @parent.run "systemctl status #{@param}"
+    @parent.run "systemctl status #{@param}", on: @host
     @parent.expect_one ['Loaded:', 'enable' ]
   end
 
   def is_disable?
     @parent.target("Service #{@param} is disable?")
-    @parent.run "systemctl status #{@param}"
+    @parent.run "systemctl status #{@param}", on: @host
     @parent.expect_one ['Loaded:', 'disable' ]
   end
 end

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

@@ -0,0 +1,28 @@
+
+class TeutonFile
+  def initialize(teuton_host, param)
+    @teuton_host = teuton_host
+    @parent = teuton_host.parent
+    @result = @parent.result
+    @host = teuton_host.host
+    @param = param
+  end
+
+  def exist?
+    @parent.target("File #{@param} exists?")
+    @parent.run "file #{@param}", on: @host
+    @parent.expect @result.grep_v('cannot open').grep(@param).count.eq 1
+  end
+
+  def directory?
+    @parent.target("File #{@param} is directory?")
+    @parent.run "file #{@param}", on: @host
+    @parent.expect @result.grep_v('cannot open').grep(@param).grep('directory').count.eq 1
+  end
+
+  def regular?
+    @parent.target("File #{@param} is regular?")
+    @parent.run "file #{@param}", on: @host
+    @parent.expect @result.grep(@param).grep('directory').count.eq 0
+  end
+end

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

@@ -0,0 +1,31 @@
+
+require_relative 'teuton_file'
+require_relative 'package'
+require_relative 'service'
+require_relative 'user'
+
+class TeutonHost
+  attr_reader :parent
+  attr_reader :host
+
+  def initialize(parent, host = 'localhost')
+    @parent = parent
+    @host = host
+  end
+
+  def file(param)
+    TeutonFile.new(self, param)
+  end
+
+  def package(param)
+    Package.new(self, param)
+  end
+
+  def service(param)
+    Service.new(self, param)
+  end
+
+  def user(param)
+    User.new(self, param)
+  end
+end

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

@@ -1,20 +1,21 @@
 
 class User
-  attr_accessor :param
-
-  def initialize(parent)
-    @parent = parent
+  def initialize(teuton_host, param)
+    @teuton_host = teuton_host
+    @parent = teuton_host.parent
+    @host = teuton_host.host
+    @param = param
   end
 
   def exists?
     @parent.target("User #{@param} exists?")
-    @parent.run "id #{@param}"
-    @parent.expect_one @param
+    @parent.run "id #{@param}", on: @host
+    @parent.expect_one [ 'uid=', @param ]
   end
 
   def is_member_of?(groupname)
     @parent.target("User #{@param} is member of #{groupname}?")
-    @parent.run "id #{@param}"
+    @parent.run "id #{@param}", on: @host
     @parent.expect_one [@param, groupname]
   end
 end

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

@@ -115,7 +115,7 @@ class Case
   alias skip? skip
 
   ##
-  # Show case
+  # Show case report data on screen
   def show
     @report.show
   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/log.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 ##
-# Case class -> DSL module : log function
+# Define DSL#log function
 module DSL
   ##
   # Record log message

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
@@ -31,7 +32,9 @@ module DSL
   # * 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] == '?'
+    if a.start_with?('_') && a.end_with?('_')
+      return instance_eval("get(:#{a[1, a.size - 2]})")
+    end
     return macro a[6, a.size], args if a[0,6]=='macro_'
     macro a, args
   end

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/dsl.rb

@@ -1,6 +1,8 @@
 require_relative '../application'
 require_relative 'case_manager'
 
+# Define filename to be used into our test
+# @param filename (String) Filename to be required
 def use(filename)
   filename += '.rb'
   app = Application.instance
@@ -12,17 +14,25 @@ def use(filename)
   app.uses << File.basename(findfiles.first)
 end
 
+# Define macro. That's a name to predefined target-run-expect evaluation.
+# @param name (String) macro name
+# @param block (Block) macro code
 def define_macro(name, *args, &block)
   Application.instance.macros[name] = { args: args, block: block }
 end
 alias def_macro define_macro
 alias defmacro define_macro
 
+# Define a group of tests
+# @param name (String) Group name
+# @param block (Block) Tests code
 def group(name, &block)
   Application.instance.groups << { name: name, block: block }
 end
 alias task group
 
+# Start test
+# @param block (Block) Extra code executed at the end.
 def play(&block)
   CaseManager.instance.play(&block)
 end