teuton 2.10.6 → 2.10.8

data/docs/learn/06-cmd_check.md

@@ -3,10 +3,12 @@
 
 # check test
 
-Check Teuton check syntax and show statistics.
+`teuton check DIRPATH` is a command function that checks syntax and show statistics.
+
+## Example
 
 ```
-❯ teuton check examples/05-use     
+$ teuton check examples/05-use     
 
 +--------------------------+
 | GROUP: Using file: users |

data/docs/learn/07-target_weight.md

@@ -2,7 +2,13 @@
 
 # Target weight
 
-* Changing default target weight:
+`weight` is param used by `target` keyword to define weight target value.
+
+## Example
+
+Changing default target weight:
+* The first target has the default weight (1.0).
+* The second target has a weight of 2.0.
 
 ```ruby
 # File: network.rb
@@ -18,15 +24,8 @@ group "Using file: network" do
 end
 ```
 
+Output:
 ```
-+--------------------------+
-| GROUP: Using file: users |
-+--------------------------+
-(001) target      Create user get(username)
-      weight      1.0
-      run         'id get(username)' on host1
-      expect      ["uid=", "(get(username))", "gid="] (Array)
-
 +----------------------------+
 | GROUP: Using file: network |
 +----------------------------+

data/docs/learn/08-unique_values.md

@@ -2,7 +2,9 @@
 
 # Unique value
 
-* `unique NAME, VALUE` keyword defines unique values.
+`unique` keyword defines a value that must be unique in all cases.
+
+* Usage: `unique NAME, VALUE`. NAME is the param name, and VALUE is the value that must be unique.
 * All cases that do not comply with this requirement will obtain a score of 0 and it will be reflected in the reports.
 
 Example:
@@ -20,7 +22,7 @@ end
 Cheking test:
 
 ```
-❯ teuton check examples/08-unique_values
+$ teuton check examples/08-unique_values
 
 +--------------------------+
 | GROUP: Using file: users |

data/docs/learn/09-send.md

@@ -2,8 +2,7 @@
 
 # Send
 
-* [export](../dsl/export.md) keyword generate reports into diferents formats:
-* [send](../dsl/send.md) keyword send report copies to every remote host.
+`send` is a keyword used to copy the output report into remote host.
 
 ## Example
 
@@ -16,5 +15,6 @@ end
 ```
 
 * `show`, show process log on screen.
-* `export`, create reports with `txt` format.
-* `send copy_to: :host1`, copy output report into remote machine (host1).
+* [export](../dsl/export.md), create reports with `txt` format.
+* [send copy_to: :host1](../dsl/send.md), copy output report into remote machine (host1).
+* `host1`, is a set params defined into config file (host1_ip, host1_username, host1_password, etc.)

data/docs/learn/10-debug.md

@@ -2,10 +2,14 @@
 
 # debug
 
-* Debug your tests.
+`result.debug` is an instrucction used to debug your tests.
+
+## Introduction
+
+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).
 
 ```
-> tree examples/10-debug
+$ tree examples/10-debug
 
 examples/10-debug
 ├── config.yaml
@@ -14,11 +18,9 @@ examples/10-debug
 └── start.rb
 ```
 
-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).
-
-Sometimes we need to verify or check rb file consistency and syntax, and we will do it with `teuton check PATH/TO/PROJECT/FOLDER`.
+Sometimes we need to verify or check rb file consistency and syntax, and we will do it with `teuton check DIRPATH`.
 
-## Debug
+## Explication
 
 Every time we invoke `run` keywork, an OS command is executed. The output is showed on screen and saved into **result** internal object.
 

data/docs/learn/11-export.md

@@ -2,9 +2,12 @@
 
 # Export
 
-* [export](../dsl/export.md) keyword generate reports into diferents formats:
+[export](../dsl/export.md) keyword generates output reports into diferents formats.
+
+Available formats: colored_text, html, json, markdown, txt, xml, yaml.
+
+## Example
 
-Example
 ```ruby
 play do
   show
@@ -19,10 +22,10 @@ end
 * `export format: :html`, create reports with `html` format.
 * `export format: :json`, create reports with `json` format.
 
-Firs run `teuton examples/11-export`, then we have:
+Firs run `teuton examples/11-export`, then we have this files:
 
 ```
-❯ tree var/11-export
+$ tree var/11-export
 
 var/11-export
 ├── case-01.html

data/docs/learn/12-preserve.md

@@ -1,15 +1,18 @@
 [<< back](README.md)
 
-# Example: 09-preserve
+# preserve
+
+`preserve` is an option of `export` keyword used to keep older report copies.
 
 Every time we run teuton test, older output report files are overwritten with new reports. if you want to preserve old versions then use `preserve`.
 
-With `preserve` option we keep older copies.
+Usage: `export preserve: true`
+
+## Example
 
-1. [Execution section](#execution-section)
-2. [Result](#result)
+Example files in the `examples/12-preserve` folder.
 
-## Execution section
+**Execution section**
 
 Take a look at our test execution section (Play):
 ```ruby
@@ -19,15 +22,15 @@ play do
 end
 ```
 
-> More information about [export](../dsl/execution/export.md) keyword.
+> More information about [export](../dsl/export.md) keyword.
 
-## Result
+**Result**
 
-Example, executing `teuton run example/09-preserve` twice:
+Example, executing `teuton run example/12-preserve` twice:
 
 ```
 var
-└── learn-09-preserve
+└── 12-preserve
     ├── 20200519-113035
     │   ├── case-01.txt
     │   ├── moodle.csv
@@ -41,4 +44,4 @@ var
     └── resume.txt
 ```
 
-* The first time test was launched at 11:30, and second at 12:30 the same day.
+The first time test was launched at 11:30, and second at 12:30 the same day.

data/lib/teuton/case/dsl/expect_sequence.rb

@@ -37,8 +37,8 @@ class ExpectSequence
 
   def find_best_state
     @states.each do |state|
-      state[:score] = state[:steps].count { _1 }
-      state[:fails] = state[:steps].count { !_1 }
+      state[:score] = state[:steps].count { |value| value }
+      state[:fails] = state[:steps].count { |value| !value }
       state[:ok] = state[:fails].zero?
     end
     best = @states[0]

data/lib/teuton/case_manager/case_manager.rb

@@ -3,20 +3,20 @@ require_relative "../report/report"
 require_relative "../utils/project"
 require_relative "../utils/verbose"
 require_relative "../utils/configfile_reader"
+require_relative "check_cases"
 require_relative "export_manager"
 require_relative "send_manager"
 require_relative "show_report"
-require_relative "check_cases"
 require_relative "report"
 require_relative "utils"
 
 # * initialize
 # * play
 # Split into several files:
-# * case_manager/check_cases
-# * case_manager/export
-# * case_manager/hall_of_fame
-# * case_manager/report
+# * check_cases
+# * export_manager
+# * send_manager
+# * show_report
 class CaseManager
   include Utils
   include Verbose

data/lib/teuton/case_manager/dsl.rb

@@ -37,9 +37,9 @@ def use(filename)
   begin
     require_relative findfiles.first
     Project.value[:uses] << File.basename(findfiles.first)
-  rescue StandardError
-    puts "[ERROR] Unknown file : #{filename}"
-    puts "        Check line   : use '#{filename}'"
+  rescue => e
+    puts "[ERROR] #{e}:"
+    puts "        File not found! Fix line <use '#{filename}'>"
     exit 1
   end
 end

data/lib/teuton/case_manager/export_manager.rb

@@ -30,7 +30,7 @@ class ExportManager
     unless Formatter.available_formats.include? options[:format]
       puts Rainbow("[WARN] ExportManager:").yellow.bright
       puts Rainbow("       Unkown format <#{options[:format]}>. Fix line <export format: FORMAT>.").yellow.bright
-      puts Rainbow("       Available formats: #{Formatter.available_formats.join(",")}.").yellow.bright
+      puts Rainbow("       Available formats: #{Formatter.available_formats.join(", ")}.").yellow.bright
       puts Rainbow("[INFO] Using default format <txt>.").yellow.bright
       options[:format] = :txt
     end

data/lib/teuton/case_manager/report.rb

@@ -9,8 +9,6 @@ class CaseManager
   # Open main report (resume report)
   # @param config_filepath (String)
   def open_main_report(config_filepath)
-    # app = Application.instance
-
     @report.head[:tt_title] = "Teuton (#{Teuton::VERSION})"
     @report.head[:tt_scriptname] = trim(Project.value[:script_path])
     @report.head[:tt_configfile] = trim(config_filepath)
@@ -31,7 +29,6 @@ class CaseManager
     verboseln Rainbow("-" * 36).green
     verboseln " "
 
-    # app = Application.instance
     @cases.each do |c|
       line = {}
       if c.skip?

data/lib/teuton/check/show.rb

@@ -61,7 +61,7 @@ class ShowCheck
       end
       if Project.value[:macros].size.positive?
         st.add_row ["Macros", Project.value[:macros].size]
-        Project.value[:macros].each_key { st.add_row ["", it] }
+        Project.value[:macros].each_key { |value| st.add_row ["", value] }
       end
       st.add_row ["Groups", @stats[:groups]]
       st.add_row ["Targets", @stats[:targets]]
@@ -87,11 +87,12 @@ class ShowCheck
 
       if @stats[:sets].size.positive?
         st.add_row ["Sets", @stats[:sets].size]
-        @stats[:sets].each { st.add_row ["", it] }
+        @stats[:sets].each { |value| st.add_row ["", value] }
       end
       if @stats[:uploads].size.positive?
         st.add_row ["Uploads", @stats[:uploads].size]
-        @stats[:uploads].each { st.add_row ["", it] }
+        uploads = @stats[:uploads].select { _1 }
+        uploads.each { |value| st.add_row ["", value] }
       end
     end
     Logger.info my_screen_table.to_s + "\n"
@@ -114,7 +115,7 @@ class ShowCheck
         script_vars << k.to_s + "_password"
       end
     end
-    @stats[:gets].keys.each { script_vars << it }
+    @stats[:gets].keys.each { |value| script_vars << value }
     script_vars
   end
 end

data/lib/teuton/files/config.yaml

@@ -1,4 +1,4 @@
 ---
 global:
 cases:
-- tt_members: NAMES_TO-CHANGE
+- tt_members: TOCHANGE

data/lib/teuton/files/start.rb

@@ -1,7 +1,7 @@
-group "NAME-TO-CHANGE" do
-  target "DESC_TO-CHANGE"
-  run "COMMAND_TO-CHANGE"
-  expect "TEXT_TO-CHANGE"
+group "TOCHANGE" do
+  target "TOCHANGE"
+  run "TOCHANGE"
+  expect "TOCHANGE"
 end
 
 play do

data/lib/teuton/readme/dsl/getset.rb

@@ -14,13 +14,14 @@ module ReadmeDSL
   def gett(value)
     a = get(value)
     if @cases_params.include? value
-      "[" + value + "](#required-params)"
+      "[#{value}](#required-params)"
     elsif @setted_params[value]
-      "[" + value + "](#created-params)"
+      "[#{value}](#created-params)"
     elsif @global_params.include? value
-      "[" + a + "](#global-params)"
+      "[#{a}](#global-params)"
+    else
+      a
     end
-    a
   end
 
   def set(key, value)

data/lib/teuton/report/formatter/default/markdown.rb

@@ -0,0 +1,90 @@
+require_relative "array"
+
+class MarkdownFormatter < ArrayFormatter
+  def initialize(report)
+    super
+    @ext = "md"
+    @data = {}
+  end
+
+  def process(options = {})
+    build_data(options)
+    process_config
+    process_logs
+    process_groups
+    process_results
+    process_hof
+    deinit
+  end
+
+  private
+
+  def process_config
+    w "# CONFIGURATION\n\n"
+    w "| Param | Value |\n"
+    w "| ----- | ----- |\n"
+    @data[:config].sort.each { |key, value| w "| #{key} | #{value} |\n" }
+    w "\n"
+  end
+
+  def process_logs
+    return if @data[:logs].empty?
+
+    w "# LOGS\n\n"
+    @data[:logs].each { |line| w "* #{line}\n" }
+    w "\n"
+  end
+
+  def process_groups
+    return if @data[:groups].empty?
+
+    w "# GROUPS\n\n"
+    @data[:groups].each { |g| process_group g }
+    w "\n"
+  end
+
+  def process_results
+    w "# RESULTS\n\n"
+    w "| Param | Value |\n"
+    w "| ----- | ----- |\n"
+    @data[:results].sort.each { |key, value| w "| #{key} | #{value} |\n" }
+    w "\n"
+  end
+
+  def process_hof
+    return if @data[:hall_of_fame].size < 3
+
+    w "# HALL OF FAME\n\n"
+    w "| Grade | Amount |\n"
+    w "| ----- | ------ |\n"
+    @data[:hall_of_fame].each do |grade, amount|
+      if grade == @data[:results][:grade]
+        w "| **#{grade}** | **#{amount}** |\n"
+      else
+        w "| #{grade} | #{amount} |\n"
+      end
+    end
+    w "\n"
+  end
+
+  private
+
+  def process_group(group)
+    tab = "  "
+    w "* **#{group[:title]}**\n"
+    group[:targets].each do |i|
+      style = "**"
+      style = "" if i[:check]
+      w "#{tab * 1}* #{format("%02d", i[:target_id].to_i)}"
+      text = "#{i[:score]}/#{i[:weight]}"
+      w " #{style}(#{text})#{style}\n"
+      w "#{tab * 2} * Description : #{i[:description]}\n"
+      w "#{tab * 2} * Command     : #{i[:command]}\n"
+      w "#{tab * 2} * Output      : #{i[:output]}\n"
+      w "#{tab * 2} * Duration    : #{i[:duration]} (#{i[:conn_type]})\n"
+      w "#{tab * 2} * Alterations : #{i[:alterations]}\n"
+      w "#{tab * 2} * Expected    : #{i[:expected]}\n"
+      w "#{tab * 2} * Result      : #{i[:result]}\n"
+    end
+  end
+end

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

@@ -2,12 +2,14 @@ require "rainbow"
 require_relative "default/colored_text"
 require_relative "default/html"
 require_relative "default/json"
+require_relative "default/markdown"
 require_relative "default/txt"
 require_relative "default/xml"
 require_relative "default/yaml"
 require_relative "resume/colored_text"
 require_relative "resume/html"
 require_relative "resume/json"
+require_relative "resume/markdown"
 require_relative "resume/txt"
 require_relative "resume/yaml"
 require_relative "moodle_csv_formatter"
@@ -17,6 +19,7 @@ module Formatter
     colored_text: ColoredTextFormatter,
     html: HTMLFormatter,
     json: JSONFormatter,
+    markdown: MarkdownFormatter,
     txt: TXTFormatter,
     xml: XMLFormatter,
     yaml: YAMLFormatter,
@@ -24,13 +27,14 @@ module Formatter
     resume_colored_text: ResumeColoredTextFormatter,
     resume_html: ResumeHTMLFormatter,
     resume_json: ResumeJSONFormatter,
+    resume_markdown: ResumeMarkdownFormatter,
     resume_txt: ResumeTXTFormatter,
     resume_xml: ResumeTXTFormatter, # TODO
     resume_yaml: ResumeYAMLFormatter
   }
 
   def self.available_formats
-    LIST.keys.take(6)
+    LIST.keys.take(7)
   end
 
   def self.call(report, options, filename)

data/lib/teuton/report/formatter/resume/markdown.rb

@@ -0,0 +1,84 @@
+require_relative "array"
+
+class ResumeMarkdownFormatter < ResumeArrayFormatter
+  MIN_HALL_OF_FAME = 3
+
+  def initialize(report)
+    super
+    @ext = "md"
+    @data = {}
+  end
+
+  def process(options = {})
+    build_data(options)
+    process_config
+    process_cases
+    process_conn_errors
+    process_results
+    process_hof
+    deinit
+  end
+
+  private
+
+  def process_config
+    w "# CONFIGURATION\n\n"
+    w "| Param | Value |\n"
+    w "| ----- | ----- |\n"
+    @data[:config].each { |key, value| w("| #{key} | #{trim(value)} |\n") }
+    w "\n"
+  end
+
+  def process_cases
+    w "# CASES\n\n"
+    w "| CASE | MEMBERS | GRADE | STATE |\n"
+    w "| ---- | ------- | ----- | ----- |\n"
+    @data[:cases].each do |line|
+      grade = format("  %<grade>3d", {grade: line[:grade]})
+      w "| #{line[:id]} | #{line[:members]} | #{grade} | #{line[:letter]} |\n"
+    end
+    w "\n"
+  end
+
+  def process_conn_errors
+    lines = []
+    lines << "# CONN ERRORS"
+    lines << ""
+    lines << "| CASE | MEMBERS | HOST | ERROR |"
+    lines << "| ---- | ------- | ---- | ----- |"
+    @data[:cases].each do |line|
+      line[:conn_status].each_pair do |h, e|
+        lines << "| #{line[:id]} | #{line[:members]} | #{h} | **#{e}** |\n"
+      end
+    end
+
+    if lines.size > 4
+      w lines.join("\n")
+      w "\n\n"
+    end
+  end
+
+  def process_results
+    w "# RESULTS\n\n"
+    w "| Param | Value |\n"
+    w "| ----- | ----- |\n"
+    @data[:results].each { |key, value| w("| #{key} | #{value} |\n") }
+    w "\n"
+  end
+
+  def process_hof
+    return if @data[:hall_of_fame].size < MIN_HALL_OF_FAME
+
+    w "# HALL OF FAME\n\n"
+    w "| Grade | Amount |\n"
+    w "| ----- | ------ |\n"
+    @data[:hall_of_fame].each do |grade, amount|
+      if line[0] == @data[:results][:grade]
+        w " | **#{grade}** | **#{amount}** |\n"
+      else
+        w " | #{grade} | #{amount} |\n"
+      end
+    end
+    w "\n"
+  end
+end

data/lib/teuton/report/report.rb

@@ -9,14 +9,12 @@ class Report
   def initialize(id = "00")
     @id = id
     @filename = "case-#{@id}"
-    # @output_dir = Application.instance.output_basedir
     @output_dir = Project.value[:output_basedir]
     @head = {}
     @lines = []
-    @tail = {}
-    # @history save 1 letter for every target.
+    @tail = {unique_fault: 0}
+    # [String] with 1 char for every target in @lines
     # For example: "..F." means: good, good, fail and good
-    # I will use this in the future stats manager.
     @history = ""
   end
 
@@ -55,10 +53,7 @@ class Report
   # * fail_weight
   # * fail_counter
   def close
-    max = 0.0
-    good = 0.0
-    fail = 0.0
-    fail_counter = 0
+    max = good = fails = fail_counter = 0
     @lines.each do |i|
       next unless i.instance_of? Hash
 
@@ -67,14 +62,14 @@ class Report
         good += i[:weight]
         @history += Settings.letter[:good]
       else
-        fail += i[:weight]
+        fails += i[:weight]
         fail_counter += 1
         @history += Settings.letter[:bad]
       end
     end
     @tail[:max_weight] = max
     @tail[:good_weight] = good
-    @tail[:fail_weight] = fail
+    @tail[:fail_weight] = fails
     @tail[:fail_counter] = fail_counter
 
     i = good.to_f / max

data/lib/teuton/version.rb

@@ -1,5 +1,5 @@
 module Teuton
-  VERSION = "2.10.6"
+  VERSION = "2.10.8"
   APPNAME = "teuton"
   GEMNAME = "teuton"
   DOCKERNAME = "dvarrui/#{GEMNAME}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 2.10.6
+  version: 2.10.8
 platform: ruby
 authors:
 - David Vargas Ruiz
@@ -125,7 +125,7 @@ extra_rdoc_files:
 - README.md
 - docs/commands/README.md
 - docs/commands/check-example.md
-- docs/commands/howto-run-tests.md
+- docs/commands/run-tests.md
 - docs/devel/diagram.md
 - docs/dsl/README.md
 - docs/dsl/expect.md
@@ -189,7 +189,7 @@ files:
 - bin/teuton
 - docs/commands/README.md
 - docs/commands/check-example.md
-- docs/commands/howto-run-tests.md
+- docs/commands/run-tests.md
 - docs/devel/diagram.md
 - docs/dsl/README.md
 - docs/dsl/expect.md
@@ -320,6 +320,7 @@ files:
 - lib/teuton/report/formatter/default/colored_text.rb
 - lib/teuton/report/formatter/default/html.rb
 - lib/teuton/report/formatter/default/json.rb
+- lib/teuton/report/formatter/default/markdown.rb
 - lib/teuton/report/formatter/default/txt.rb
 - lib/teuton/report/formatter/default/xml.rb
 - lib/teuton/report/formatter/default/yaml.rb
@@ -329,6 +330,7 @@ files:
 - lib/teuton/report/formatter/resume/colored_text.rb
 - lib/teuton/report/formatter/resume/html.rb
 - lib/teuton/report/formatter/resume/json.rb
+- lib/teuton/report/formatter/resume/markdown.rb
 - lib/teuton/report/formatter/resume/txt.rb
 - lib/teuton/report/formatter/resume/yaml.rb
 - lib/teuton/report/report.rb
@@ -351,7 +353,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.9
+      version: 3.2.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="