teuton 2.1.7 → 2.1.8dev1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f3afa907473fea0072b32db4ce5b6d8fd2f93d1e48c0937fd37e5c74756dfb3
-  data.tar.gz: 44065354ff9987c8e92477767064e5a62afea9f9da03eecf49e71e6c116ddddc
+  metadata.gz: f9adfc25439c6c4041e3ebe2c3defd49f2377fd5bc9283da0849e5e2ad220581
+  data.tar.gz: ddfb9194f6ce7d070fd53aa796094ffa25faa19f7d7142bb044ce9d92ed6725a
 SHA512:
-  metadata.gz: cbab8d53ac2945943316c789e6efb5e83bc9c2dd4435a6f7c9c231d7bd4d8bfb9e5a1e27fff4f8d7cd7c82536f85fe5d2cd46234c02b091e1d6c3b75557c04b5
-  data.tar.gz: e8088367c4d4182c5cd50cce7aad58bae68df6303356a9daa94980cf0db97307244de09254879cf59f29de0aee2506bfd577f9001e89c8da92e42a33253e8a7e
+  metadata.gz: ca261f8258065c3684c82dae7ea8929c1d77bfeeb64baea71dd60c2aa52d99f1767af1bd2467a1747881a4e37ba4078df1dc9541895bcee6f0695b73874e8cc8
+  data.tar.gz: 001aa6f198e560ec39cac6a1cca65ed67d7ef887751e7f9e13759309c7bf42cf772c8c8fb32fc8e0f8ec1ddc92477ef2a8bfbdae7c74851cad4afb7123eadeff

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

@@ -8,6 +8,7 @@
 
 > This example is on GitHub repository at `examples/learn-02-config`.
 
+---
 ## Config file
 
 By default, `config.yaml` is our config file. Let's an example:
@@ -47,10 +48,8 @@ In this section we define targets using keywords: target, run, expect and get.
 ```ruby
 play do
   show
-  # export using other output formats
-  export :format => :colored_text
+  export
 end
-
 ```
 
 Runing this example and see `show` keyword output:
@@ -100,7 +99,7 @@ HALL OF FAME
 
 ## Results
 
-Output reports are saved into `var/learn-02-config/` directory.
+Output reports are saved into `var/learn-02-config/` directory. Detail output report is created for every case.
 
 ```
 var/learn-02-config
@@ -109,7 +108,7 @@ var/learn-02-config
 └── resume.txt
 ```
 
-Let's see `export` keyword output.
+Let's see `export` keyword output for case 01.
 
 ```
 $ more var/learn-02-config/case-01.txt
@@ -156,18 +155,18 @@ By default, when you run `teuton run foo`, this will search for:
 * `foo/config.yaml` config file.
 
 **Using cname param:**
-But it's posible run `teuton run --cname=rock foo`, and this will search for:
+But it's posible run `teuton run --cname=rock foo`, and choose diferent config file into projet folder:
 * `foo/start.rb` test file and
 * `foo/rock.yaml` config file.
 
 `cname` param searchs YAML config file into the same project folder.
 
 **Using cpath param:**
-An also, it's posible run `teuton run --cpath=/home/david/startwars.yaml foo`, and this will search for:
+An also, it's posible run `teuton run --cpath=/home/david/startwars.yaml foo`, and choose config file using its absolute path:
 * `foo/start.rb` test file and
 * `/home/david/starwars.yaml` config file.
 
-`cpath` param use YAML config file, from the specified path.
+`cpath` param selects YAML config file, from the specified path.
 
 **Using diferent main rb name:**
 When you run `teuton run foo/mazingerz.rb`, this will search for:

data/docs/learn/example-03-remote-hosts.md

@@ -1,4 +1,8 @@
 
+[<< back](README.md)
+
+# Example: learn-03-remote-hosts
+
 Learn how to:
 * Check a group of remote hosts.
 * Export reports using other output formats.
@@ -6,7 +10,9 @@ Learn how to:
 
 > This example is on GitHub repository at `examples/learn-03-remote-hosts`.
 
-## Config file (`config.yaml`)
+## Config file
+
+`config.yaml` file:
 
 ```yaml
 ---
@@ -30,7 +36,7 @@ Learn how to:
 
 ## Definitions (group section)
 
-Defining 3 targets to be checked:
+Define 3 targets (items to be checked):
 
 ```ruby
 group "learn 03 remote hosts" do
@@ -87,4 +93,4 @@ var
 * `case-01`, report with details about case 01 (maul)
 * `case-02`, report with details about case 02 (r2d2)
 * `case-03`, report with details about case 03 (obiwan)
-* `cresume`, report with global resumed information about all cases.
+* `resume`, report with global resumed information about all cases.

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

@@ -1,4 +1,8 @@
 
+[<< back](README.md)
+
+# Example: learn-04-use
+
 Learn how to:
 * Organize huge amount of groups/targets into several files.
 * Checking Windows OS infrastructure (host1).

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

@@ -1,4 +1,8 @@
 
+[<< back](README.md)
+
+# Example: learn-05-debug
+
 Learn how to:
 * Check test syntax.
 * Debug your tests.
@@ -35,23 +39,23 @@ end
 
 ## Debugging: Testing rb files
 
-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 (That's good) to load other files.
+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 test 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 an example:
 
 ```bash
-$ teuton test learn/learn-01-target
-[INFO] ScriptPath => ...epos/teuton.d/units/learn/learn-01-target/start.rb
-[INFO] ConfigPath => ...s/teuton.d/units/learn/learn-01-target/config.yaml
+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] TestName   => learn-01-target
 
 +------------------------+
 | GROUP: learn-01-target |
 +------------------------+
 (001) target      Create user <david>
-     weight      1.0
-     goto        localhost and {:exec=>"id david"}
-     expect      david (String)
+      weight      1.0
+      goto        localhost and {:exec=>"id david"}
+      expect      david (String)
 
 +--------------+-------+
 | DSL Stats    | Count |
@@ -69,7 +73,7 @@ $ teuton test learn/learn-01-target
 +----------------------+
 | Revising CONFIG file |
 +----------------------+
-[WARN] File /home/david/proy/repos/teuton.d/units/learn/learn-01-target/config.yaml not found!
+[WARN] File ./examples/learn-01-target/config.yaml not found!
 [INFO] Recomended content:
 ---
 :global:
@@ -77,13 +81,13 @@ $ teuton test learn/learn-01-target
 - :tt_members: VALUE
 ```
 
-In this case, Teuton detects that there isn't config file and propose us content for `config.yaml`.
+In this case, Teuton detects that there isn't exist config file, and propose us content for `config.yaml`.
 
 ## Debugging: Result content
 
-Every time we invoke `goto` or `run` keywork, a OS command is executed and the output showed on screen is captured by Teuton and saved into `result` internal object.
+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.
 
-We coul 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 rb file. Let's see an example from `external.rb.rb` file:
 
 ```ruby
 group "Windows: external configuration" do
@@ -101,4 +105,4 @@ group "Windows: external configuration" do
 end
 ```
 
-`result.debug` it's usefull when you are verifying what command ouput has been captured by Teuton.
+`result.debug` it's usefull when you are verifying command output captured by Teuton.

data/lib/teuton/application.rb

@@ -4,7 +4,7 @@ require 'singleton'
 class Application
   include Singleton
 
-  VERSION = '2.1.7' # Application version
+  VERSION = '2.1.8dev1' # Application version
   NAME = 'teuton'   # Application name
 
   attr_reader   :letter

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

@@ -26,7 +26,7 @@ class Case
   attr_accessor :result
   attr_accessor :action # TODO: why not reader only???
   attr_reader :id, :config, :uniques, :conn_status
-  @@id = 1
+  @@id = '01'
 
   def initialize(config)
     app = Application.instance
@@ -34,7 +34,7 @@ class Case
     @groups = app.groups
 
     @id = @@id
-    @@id += 1
+    @@id = @@id.next
 
     # Define Case Report
     @report = Report.new(@id)

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

@@ -7,16 +7,14 @@ module DSL
   # Record log message
   # @param text (String)
   # @param type (Symbol) Values :info, :warn or :error
-  # rubocop:disable Style/FormatStringToken
   def log(text = '', type = :info)
     s = ''
     s = Rainbow('WARN!').color(:yellow) if type == :warn
     s = Rainbow('ERROR').bg(:red) if type == :error
     t = Time.now
-#    f = format('%02d:%02d:%02d', t.hour, t.min, t.sec)
-    f = '%02d:%02d:%02d' % [t.hour, t.min, t.sec]
+    f = format('%<hour>02d:%<min>02d:%<sec>02d',
+               { hour: t.hour, min: t.min, sec: t.sec })
     @report.lines << "[#{f}] #{s}: #{text}"
   end
-  # rubocop:enable Style/FormatStringToken
   alias msg log
 end

data/lib/teuton/case_manager/case_manager.rb

@@ -61,9 +61,7 @@ class CaseManager
     srcdir = File.join(app.output_basedir, app.global[:tt_testname])
     puts "[INFO] Preserving files => #{logdir}"
     FileUtils.mkdir(logdir)
-    Dir.glob('var/learn-08-preserve/**.*').each do |file|
-      FileUtils.cp(file, logdir)
-    end
+    Dir.glob(srcdir, '**.*').each { |file| FileUtils.cp(file, logdir) }
   end
 
   def send(args = {})

data/lib/teuton/case_manager/export_manager.rb

@@ -2,8 +2,14 @@
 
 require_relative '../application'
 
-# ExportManager#run
+##
+# ExportManager is used by CaseManager to export output reports)
 module ExportManager
+  ##
+  # Run export function
+  # @param main_report (Report)
+  # @param cases (Array)
+  # @param args (Hash) Selected export options
   def self.run(main_report, cases, args)
     # default :mode=>:all, :format=>:txt
     format = args[:format] || Application.instance.default[:format]

data/lib/teuton/case_manager/report.rb

@@ -38,7 +38,7 @@ class CaseManager
                 moodle_id: '', moodle_feedback: '' }
       else
         line[:skip] = false
-        line[:id] = format('case_%02d', c.id.to_i)
+        line[:id] = format('%<id>02d', { id: c.id.to_i })
         line[:letter] = app.letter[:error] if c.grade < 50.0
         line[:grade] = c.grade.to_f #format('  %3d', c.grade.to_f)
         line[:members] = c.members

data/lib/teuton/report/formatter/moodle_csv_formatter.rb

@@ -2,13 +2,19 @@
 
 require_relative 'resume_array_formatter'
 
-# MoodleCSVFormatter class
+##
+# Format data to Moodle CSV
 class MoodleCSVFormatter < ResumeArrayFormatter
+  ##
+  # initialize instance
+  # @param report (Report)
   def initialize(report)
     super(report)
     @data = {}
   end
 
+  ##
+  # Process internal data and generates data with format
   def process
     build_data
     process_cases
@@ -21,8 +27,12 @@ class MoodleCSVFormatter < ResumeArrayFormatter
     # MoodleID, Grade, Feedback
     w "MoodleID, TeutonGrade, TeutonFeedback\n"
     @data[:cases].each do |line|
-      w "#{line[:moodle_id]},#{line[:grade]}," \
-        "#{line[:moodle_feedback]}\n" unless line[:skip]
+      moodle_id = line[:moodle_id]
+      moodle_id = line[:moodle_id].split(',') if moodle_id.class == String
+      moodle_id.each do |id|
+        w "#{id.strip},#{line[:grade]}," \
+          "#{line[:moodle_feedback]}\n" unless line[:skip]
+      end
     end
   end
 end

data/lib/teuton/report/formatter/resume_txt_formatter.rb

@@ -6,7 +6,7 @@ require_relative 'resume_array_formatter'
 
 # TXTFormatter class
 class ResumeTXTFormatter < ResumeArrayFormatter
-  def initialize(report, color=false)
+  def initialize(report, color = false)
     @color = color
     super(report)
     @data = {}
@@ -30,60 +30,61 @@ class ResumeTXTFormatter < ResumeArrayFormatter
   private
 
   def process_config
-    w "#{Rainbow("CONFIGURATION").bg(:blue)}\n"
+    w "#{Rainbow('CONFIGURATION').bg(:blue)}\n"
     my_screen_table = Terminal::Table.new do |st|
-      @data[:config].each do |key,value|
-        st.add_row [ key.to_s, trim(value)]
+      @data[:config].each do |key, value|
+        st.add_row [key.to_s, trim(value)]
       end
     end
-    w my_screen_table.to_s+"\n\n"
+    w "#{my_screen_table}\n\n"
   end
 
+  # rubocop:disable Metrics/MethodLength
   def process_cases
     w "#{Rainbow('CASES').bg(:blue)}\n"
-
     my_screen_table = Terminal::Table.new do |st|
-      st.add_row [ 'CASE ID', 'MEMBERS', 'GRADE', 'STATE' ]
+      st.add_row %w[CASE MEMBERS GRADE STATE]
       @data[:cases].each do |line|
-        st.add_row [ line[:id],
-                     line[:members],
-                     format('  %3d', line[:grade]),
-                     line[:letter] ]
+        st.add_row [line[:id],
+                    line[:members],
+                    format('  %<grade>3d', { grade: line[:grade] }),
+                    line[:letter]]
       end
     end
-    w my_screen_table.to_s+"\n\n"
+    w "#{my_screen_table}\n\n"
   end
+  # rubocop:enable Metrics/MethodLength
 
   def process_conn_errors
-    w "#{Rainbow('CONN ERRORS').bg(:red)}\n"
-
     my_screen_table = Terminal::Table.new do |st|
-      st.add_row [ 'CASE ID', 'MEMBERS', 'HOST', 'ERROR' ]
+      st.add_row %w[CASE MEMBERS HOST ERROR]
       @data[:cases].each do |line|
         line[:conn_status].each_pair do |h, e|
-          st.add_row [ line[:id],
-                       line[:members],
-                       h, e ]
+          st.add_row [line[:id], line[:members], h, e]
         end
       end
     end
-    w my_screen_table.to_s+"\n"
+    return unless my_screen_table.rows.size > 1
+    w "#{Rainbow('CONN ERRORS').bg(:red)}\n"
+    w "#{my_screen_table}\n"
   end
 
   def process_results
-    w "\n#{Rainbow("RESULTS").bg(:blue)}\n"
+    w "\n#{Rainbow('RESULTS').bg(:blue)}\n"
     my_screen_table = Terminal::Table.new do |st|
-      @data[:results].each do |key,value|
-        st.add_row [ key.to_s, value.to_s]
+      @data[:results].each do |key, value|
+        st.add_row [key.to_s, value.to_s]
       end
     end
-    w my_screen_table.to_s+"\n"
+    w "#{my_screen_table}\n"
   end
 
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
   def process_hof
     return if @data[:hall_of_fame].size < 3
 
-    w "\n#{Rainbow("HALL OF FAME").bg(:blue)}\n"
+    w "\n#{Rainbow('HALL OF FAME').bg(:blue)}\n"
     my_screen_table = Terminal::Table.new do |st|
       @data[:hall_of_fame].each do |line|
         mycolor = :green
@@ -97,6 +98,8 @@ class ResumeTXTFormatter < ResumeArrayFormatter
         st.add_row [text1, text2]
       end
     end
-    w my_screen_table.to_s + "\n"
+    w "#{my_screen_table}\n"
   end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
 end

data/lib/teuton/report/report.rb

@@ -28,11 +28,9 @@ class Report
   attr_reader :history
   ##
   # Class constructor
-  def initialize(id = 0)
+  def initialize(id = '00')
     @id = id
-    number = '0' + @id.to_s
-    number = @id.to_s if @id > 9
-    @filename = "case-#{number}"
+    @filename = "case-#{@id}"
     @output_dir = Application.instance.output_basedir
     @head    = {}
     @lines   = []

data/lib/teuton/report/show.rb

@@ -35,7 +35,7 @@ class Report
   def show_case_list
     puts 'CASE RESULTS'
     my_screen_table = Terminal::Table.new do |st|
-      st.add_row ['CASE ID', 'MEMBERS', 'GRADE', 'STATE' ]
+      st.add_row ['CASE', 'MEMBERS', 'GRADE', 'STATE' ]
       @lines.each do |line|
         st.add_row [line[:id], line[:members], line[:grade], line[:letter]]
       end
@@ -50,7 +50,7 @@ class Report
 
     puts 'CONN ERRORS'
     my_screen_table = Terminal::Table.new do |st|
-      st.add_row ['CASE ID', 'MEMBERS', 'HOST', 'ERROR']
+      st.add_row ['CASE', 'MEMBERS', 'HOST', 'ERROR']
       @lines.each do |line|
         line[:conn_status].each_pair do |h,e|
           st.add_row [line[:id], line[:members], h, e]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 2.1.7
+  version: 2.1.8dev1
 platform: ruby
 authors:
 - David Vargas Ruiz
@@ -336,9 +336,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
 signing_key: