teuton 2.3.1 → 2.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbe8ad9c5430dd71ef38f136d6066965d6531b1e68e23f35cbc9b3ec31730690
-  data.tar.gz: a0798325031d92db0e66e71152c9cbd20d776d043870067a6d79deda9d6930af
+  metadata.gz: 3bc9ff84fbd532b614173964e8de446a11e8126f324f4565a3d2e095ea7fd83d
+  data.tar.gz: dd2b0093dc4a36b1892678ae2ed05fe4611a978c506ca01215bd9e12b7a346fb
 SHA512:
-  metadata.gz: 8a069613b2e5a73282f5eeb61c67f388f1d8c44a2dd785e7a1c44d760e31346db0868a1df8b2aa13b95d5bad0f36a9b64ec46566d61790e25993f625a9bcd7ed
-  data.tar.gz: 7a7ef4a74dec5fb9ece8ad77714d9a4a3b76d810d2d173b95e7351513175af161bf19e22016167480ccc96307010a4fee7476d1885af458121cf6d20fbae00b8
+  metadata.gz: 6147fad14f2aa47b31fc66bc17fdb78db0f9387a9dfea6dee0fb20f89ed2c48b729943bd7bae06155db8234d897b78987c184e936708d4fcdda185d11fcf8ce9
+  data.tar.gz: '0949e0ed282c7faa26c590539c2dad96e9adfe1724709478004b4ae742ed2d2822f5768ef709a8df6ba7cf89823dd0177fd23cb805f0517595017bdd614bcc8a'

data/README.md

@@ -1,7 +1,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/teuton.svg)](https://badge.fury.io/rb/teuton)
 ![GitHub](https://img.shields.io/github/license/dvarrui/teuton)
-![Gem](https://img.shields.io/gem/dv/teuton/2.3.0)
+![Gem](https://img.shields.io/gem/dv/teuton/2.3.1)
 
 # TEUTON
 
@@ -23,7 +23,7 @@ Teuton allow us:
 
 * [Installation](https://github.com/teuton-software/teuton/tree/master/docs/install/README.md)
     1. Install Ruby on your system.
-    1. `gem install teuton`, to install Teuton.
+    1. Install Teuton with `gem install teuton`.
 * [Videos, blogs, news](docs/videos.md)
 * [Learning](docs/learn/README.md)
 * [Commands](docs/commands/README.md)

data/docs/learn/README.md

@@ -17,8 +17,11 @@ Learn how to use Teuton language to write your own tests:
 - [Example 07 - Log](example-07-log.md)
 - [Example 08 - Readme](example-08-readme.md)
 - [Example 09 - Preserve](example-09-preserve.md)
-- Example 10 - Macros
-- Example 11 - Alias
+- Example 10 - Result and Moodle
+- Example 11 - Get vars
+- Example 12 - Include
+- Example 13 - Alias
+- Example 14 - Macros
 - [Videos](videos.md)
 
 # Examples

data/docs/learn/example-02-config.md

@@ -78,7 +78,6 @@ CASES
 | 02   | Student-name-2 |     0 | ?     |
 +------+----------------+-------+-------+
 
-
 RESULTS
 +-------------+---------------------------+
 | start_time  | 2020-10-10 12:37:54 +0100 |

data/lib/teuton/application.rb

@@ -22,15 +22,10 @@ class Application
   attr_accessor :hall_of_fame
   attr_accessor :project_path, :script_path, :config_path, :test_name
 
-  ##
-  # Initialize Application instance
   def initialize
     reset
   end
 
-  ##
-  # Reset param values
-  # rubocop:disable Metrics/MethodLength
   def reset
     @letter = { good: '.', bad: 'F', error: '?', none: ' ' }
     @running_basedir = Dir.getwd
@@ -46,25 +41,15 @@ class Application
     @uses = [] # TODO
     @hall_of_fame = []
   end
-  # rubocop:enable Metrics/MethodLength
 
-  ##
-  # Return debug param
-  # @return Boolean
   def debug
     @default[:debug]
   end
 
-  ##
-  # Return name param
-  # @return String
   def name
     @default[:name]
   end
 
-  ##
-  # Return quiet param
-  # @return Boolean
   def quiet?
     return true if Application.instance.options['quiet']
     return true unless Application.instance.verbose
@@ -76,7 +61,6 @@ class Application
   # 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)
@@ -89,5 +73,4 @@ class Application
     a = @options['case'].split(',')
     @options['case'] = a.collect!(&:to_i)
   end
-  # rubocop:enable Metrics/AbcSize
 end

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

@@ -16,15 +16,16 @@ class Case
     end
     # TODO: Delete old reports???
     start_time = Time.now
-    play_in_sequence if get(:tt_sequence) == true # Play in sequence
-    play_in_parallel if get(:tt_sequence) != true # Play in parallel
+    if get(:tt_sequence) == true
+      play_in_sequence
+    else
+      play_in_parallel
+    end
     fill_report(start_time, Time.now)
     close_opened_sessions
   end
   alias start play
 
-  ##
-  # Close opened sessions for this case
   def close_opened_sessions
     @sessions.each_value do |s|
       s.close if s.class == Net::SSH::Connection::Session
@@ -46,9 +47,9 @@ class Case
   ##
   # Execute every play#group in sequence
   def play_in_sequence
-    verboseln "Starting case <#{@config.get(:tt_members)}>"
+    verboseln "Starting case [#{@config.get(:tt_members)}]"
     @groups.each do |t|
-      verbose "* Processing <#{t[:name]}> "
+      verbose "* Processing [#{t[:name]}] "
       @action[:groupname] = t[:name]
       instance_eval(&t[:block])
       verbose "\n"
@@ -58,7 +59,6 @@ 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
@@ -68,5 +68,4 @@ 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/runner.rb

@@ -69,7 +69,8 @@ class Case
     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
+    port = @config.get("#{hostname}_port".to_sym).to_i
+    port = 22 if port.zero?
 
     unless @config.get("#{hostname}_route".to_sym) == 'NODATA'
       # Reconfigure command with gateway. Example host1_route: IP.

data/lib/teuton/case_manager/check_cases.rb

@@ -39,12 +39,12 @@ class CaseManager
   # Run all cases
   def run_all_cases
     start_time = Time.now
-    if Application.instance.global[:tt_sequence]
-      verboseln Rainbow("[INFO] Running in sequence (#{start_time})").yellow.bright
+    if Application.instance.global[:tt_sequence] == true
+      verboseln Rainbow("==> Teuton: Running in sequence (#{start_time})").yellow.bright
       # Run every case in sequence
       @cases.each(&:play)
     else
-      verboseln Rainbow("[INFO] Running in parallel (#{start_time})").yellow.bright
+      verboseln Rainbow("==> Teuton: Running in parallel (#{start_time})").yellow.bright
       threads = []
       # Run all cases in parallel
       @cases.each { |c| threads << Thread.new { c.play } }
@@ -78,7 +78,6 @@ class CaseManager
     @cases.each { |c| threads << Thread.new { c.close uniques } }
     threads.each(&:join)
 
-    # Build Hall of Fame
     build_hall_of_fame
   end
 end

data/lib/teuton/case_manager/main.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 
 require_relative 'check_cases'
 require_relative 'hall_of_fame'

data/lib/teuton/case_manager/report.rb

@@ -12,17 +12,13 @@ class CaseManager
   def open_main_report(config_filepath)
     app = Application.instance
 
-    @report.head[:tt_title] = "Executing [#{app.name}] (version #{Application::VERSION})"
+    @report.head[:tt_title] = "Teuton (#{Teuton::VERSION})"
     @report.head[:tt_scriptname] = trim(app.script_path)
     @report.head[:tt_configfile] = trim(config_filepath)
     @report.head[:tt_pwd] = app.running_basedir
     @report.head[:tt_debug] = true if @debug
     # @report.head[:tt_uses] = app.uses.join(', ') # TO-REVISE
     @report.head.merge!(app.global)
-
-    verboseln ' '
-    verboseln '=' * @report.head[:tt_title].length
-    verboseln Rainbow(@report.head[:tt_title]).yellow.bright
   end
 
   def close_main_report(start_time)
@@ -31,9 +27,8 @@ class CaseManager
     @report.tail[:finish_time] = finish_time
     @report.tail[:duration] = finish_time - start_time
 
-    verbose Rainbow("\n[INFO] Duration = #{format('%3.3f',(finish_time - start_time))}").yellow.bright
-    verboseln Rainbow("    (#{finish_time})").yellow.bright
-    verboseln '=' * @report.head[:tt_title].length
+    verbose Rainbow("\n==> Teuton: Duration=#{format('%3.3f',(finish_time - start_time))}").yellow.bright
+    verboseln Rainbow(" (#{finish_time})").yellow.bright
     verboseln ' '
 
     app = Application.instance

data/lib/teuton/files/config.yaml

@@ -1,5 +1,5 @@
 ---
-:global:
-:cases:
-- :tt_members: MEMBERS
-  :tt_moodle_id: MOODLE_ID
+global:
+cases:
+- tt_members: MEMBERS
+  tt_moodle_id: MOODLE_ID

data/lib/teuton/files/start.rb

@@ -1,9 +1,9 @@
 
 group "GROUP NAME" do
 
-  target "TARGET-1 DESCRIPTION"
-  run "COMMAND-1"
-  expect "TEXT-1"
+  target "TARGET.1 DESCRIPTION"
+  run "COMMAND.1"
+  expect "TEXT.1"
 
 end
 

data/lib/teuton/utils/configfile_reader.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 
 require 'yaml'
 require 'json/pure'
@@ -29,9 +28,6 @@ module ConfigFileReader
   # Read YAML config file
   # @param filepath (String) Path to YAML config file
   # @return Hash with config data
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Security/YAMLLoad
   def self.read_yaml(filepath)
     begin
       data = YAML.load(File.open(filepath))
@@ -49,9 +45,6 @@ module ConfigFileReader
     read_included_files!(filepath, data)
     data
   end
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Security/YAMLLoad
 
   ##
   # Read JSON config file
@@ -71,7 +64,6 @@ module ConfigFileReader
   # Read all configuration files from "filepath" folder.
   # @param filepath (String) Folder with config files
   # @param data (Hash) Input configuration
-  # rubocop:disable Security/YAMLLoad
   private_class_method def self.read_included_files!(filepath, data)
     return if data[:global][:tt_include].nil?
 
@@ -94,10 +86,7 @@ module ConfigFileReader
       end
     }
   end
-  # rubocop:enable Security/YAMLLoad
 
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Metrics/AbcSize
   private_class_method def self.convert_string_keys_to_symbol(input)
     return input if input.class != Hash
 
@@ -116,6 +105,4 @@ module ConfigFileReader
     end
     output
   end
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
 end

data/lib/teuton/utils/name_file_finder.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 
 require 'rainbow'
 require_relative '../application'
@@ -29,8 +28,6 @@ module NameFileFinder
   ##
   # Find project filenames from input folder path
   # @param folder_path (String)
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/MethodLength
   def self.find_filenames_from_directory(folder_path)
     # COMPLEX MODE: We use start.rb as main RB file
     script_path = File.join(folder_path, 'start.rb')
@@ -48,15 +45,10 @@ module NameFileFinder
 
     find_configfilename_from_directory(folder_path)
   end
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/MethodLength
 
   ##
   # Find project config filename from input folder path
   # @param folder_path (String)
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Style/IfUnlessModifier
   def self.find_configfilename_from_directory(folder_path)
     # COMPLEX MODE: We use config.yaml by default
     app = Application.instance
@@ -76,12 +68,7 @@ module NameFileFinder
     end
     app.config_path = config_path
   end
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Style/IfUnlessModifier
 
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/MethodLength
   def self.find_filenames_from_rb(script_path)
     # SIMPLE MODE: We use script_path as main RB file
     # This must be fullpath to DSL script file
@@ -99,12 +86,7 @@ module NameFileFinder
 
     find_configfilenames_from_rb(script_path)
   end
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/MethodLength
 
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Style/IfUnlessModifier
   def self.find_configfilenames_from_rb(script_path)
     # SIMPLE MODE: We use script_path as main RB file
     # This must be fullpath to DSL script file
@@ -126,33 +108,6 @@ module NameFileFinder
     end
     app.config_path = config_path
   end
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Style/IfUnlessModifier
-
-  #  def self.puts_input_info_on_screen
-  #    app = Application.instance
-  #
-  #    verbose Rainbow('[INFO] ScriptPath => ').blue
-  #    verboseln Rainbow(trim(app.script_path)).blue.bright
-  #    verbose Rainbow('[INFO] ConfigPath => ').blue
-  #    verboseln Rainbow(trim(app.config_path)).blue.bright
-  #    verbose Rainbow('[INFO] Pwd        => ').blue
-  #    verboseln Rainbow(app.running_basedir).blue.bright
-  #    verbose Rainbow('[INFO] TestName   => ').blue
-  #    verboseln Rainbow(trim(app.test_name)).blue.bright
-  #  end
-
-  ##
-  # Trim string text when is too long
-  #  def self.trim(input)
-  #    return input unless input.to_s.start_with? Dir.pwd.to_s
-  #
-  #    output = input.to_s
-  #    offset = (Dir.pwd).length + 1
-  #    output = "#{input[offset, input.size]}"
-  #    output.to_s
-  #  end
 
   def self.verboseln(text)
     verbose(text + "\n")

data/lib/teuton/utils/verbose.rb

@@ -1,7 +1,6 @@
 
 require_relative '../application'
 
-# Define general use methods
 module Verbose
   def verboseln(text)
     verbose(text + "\n")
@@ -9,7 +8,7 @@ module Verbose
 
   def verbose(text)
     return if Application.instance.quiet?
-    
+
     print text
   end
 end

data/lib/teuton/version.rb

@@ -1,6 +1,6 @@
 
 module Teuton
-  VERSION = '2.3.1'
+  VERSION = '2.3.4'
   APPNAME = 'teuton'
   GEMNAME = 'teuton'
   DOCKERNAME = "dvarrui/#{GEMNAME}"

data/lib/teuton.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 
 require_relative 'teuton/application'
 require_relative 'teuton/skeleton'
@@ -8,18 +7,13 @@ module Teuton
     Skeleton.create(path_to_new_dir)
   end
 
-  # Run test
-  # @param projectpath (String) Path to teuton test
-  # @param options (Array) Array of input options
   def self.run(projectpath, options = {})
     Application.instance.add_input_params(projectpath, options)
     require_dsl_and_script('teuton/case_manager/dsl') # Define DSL keywords
   end
 
-  # Create Readme file for a test
-  # @param projectpath (String) Path to teuton test
-  # @param options (Array) Array of input options
   def self.readme(projectpath, options = {})
+    # Create Readme file for a test
     Application.instance.add_input_params(projectpath, options)
     require_dsl_and_script('teuton/readme/readme') # Define DSL keywords
 
@@ -28,9 +22,6 @@ module Teuton
     readme.show
   end
 
-  # Check teuton test syntax
-  # @param projectpath (String) Path to teuton test
-  # @param options (Array) Array of input options
   def self.check(projectpath, options = {})
     Application.instance.add_input_params(projectpath, options)
     require_dsl_and_script('teuton/check/laboratory') # Define DSL keywords
@@ -48,7 +39,7 @@ module Teuton
       require_relative app.script_path
     rescue SyntaxError => e
       puts e.to_s
-      puts Rainbow.new("[ FAIL ] SyntaxError into file #{app.script_path}").red
+      puts Rainbow.new("==> [FAIL] SyntaxError into file #{app.script_path}").red
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.3.4
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-28 00:00:00.000000000 Z
+date: 2022-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize