teuton 2.3.11 → 2.4.0

data/docs/learn/08-readme.md

@@ -1,6 +1,6 @@
 [<< back](README.md)
 
-# Example: 07-readme
+# Example: readme
 
 Create README files (with test instructions) from our test definition.
 
@@ -35,15 +35,15 @@ 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-08-readme > example/learn-08-readme/README.md
+teuton readme example/08-readme > example/08-readme/README.md
 ```
 
 ## Result
 
-**Let's see the output**: Content of `example/learn-08-readme/README.md` file.
+**Let's see the output**: Content of `example/08-readme/README.md` file.
 
 ---
-# learn-08-readme
+# 08-readme
 
 ## Customize readme output
 

data/docs/learn/13-include.md

@@ -2,13 +2,17 @@
 
 # Example: 13-include
 
-Until now, all the tests we have seen came with a configuration file (`config.yaml`) that contained all the parameters that will later be used in the test. It is also possible to have the information distributed among several configuration files.
+Use `tt-include` to include several config files into your main config file.
+
+## Explanation
+
+Until now, all the examples we have seen use one configuration file (`config.yaml`) that contain all the parameters required by the test. It is possible to save configuration distributed among several files.
 
 Suppose we have the following file structure.
 
 ```
 ├── config.yaml
-├── include_this_files
+├── moreconfigfiles
 │   ├── 02
 │   │   └── file02.yaml
 │   ├── file01.yaml
@@ -16,15 +20,15 @@ Suppose we have the following file structure.
 └── start.rb
 ```
 
-`config.yaml` will be the main config file. Using `tt_include` parameter, we define a folder where the rest of the configuration files will be.
+`config.yaml` will be the main config file. We have defined `tt_include` parameter with a folder wich contains more configuration files.
 
-In this example the contents of the files in the include_this_files folder will be included in the configuration:
+In this example the contents of all files in `moreconfigfiles` folder will be included when reading the config parameters:
 
 ```yaml
 ---
 # Fiel: config.yaml
 :global:
-  :tt_include: include_this_files
+  :tt_include: moreconfigfiles
 :cases:
 ```
 
@@ -41,19 +45,22 @@ CASE RESULTS
 +------+---------+-------+-------+
 ```
 
-Config files into `include_this_files` folder:
+Config files into `moreconfigfiles` folder:
 
 ```yaml
+# moreconfigfiles/file01.yaml
 :tt_members: file01
 :username: root
 ```
 
 ```yaml
+# moreconfigfiles/02/file02.yaml
 :tt_members: file02
 :username: quigon
 ```
 
 ```yaml
+# moreconfigfiles/file03.yml
 :tt_members: file03
 :username: vader
 ```

data/docs/learn/14-alias.md

@@ -2,7 +2,11 @@
 
 # Example: 14-alias
 
-Supongamos que tenemos un test como el siguiente:
+By using aliases we can adapt a configuration file, so that it can be used with many different tests.
+
+## Exanation
+
+Suppose we have a test like the following:
 
 ```ruby
 group "Using alias" do
@@ -16,14 +20,14 @@ group "Using alias" do
 end
 ```
 
-Tenemos sólo 2 targets pero podríamos tener muchos más.
+> REMEMBER:
+> * We only have 2 targets but we could have many more.
+> * `_username` is equivalent to `get(:username)`
 
-> Recordemos que `_username` es equivalente a `get(:username)`
-
-Sabemos que el fichero de configuración debe definir los valores para los parámetros `super` y `username`. Queremos aprovechar un fichero de configuración que ya teníamos de otro test, pero tiene el siguiente contenido:
+Our test requires the `super` parameter but the configuration file has named it as `superuser`. Our configuration file define values for `supername` and `username` parameters. Let's see:
 
 ```yaml
-# Version 1
+# First version
 # File: config.yaml
 global:
 cases:
@@ -32,10 +36,10 @@ cases:
   username: obiwan
 ```
 
-Podemos comprobar que nuestro test require el parámetro `super` pero el fichero de configuración lo ha nombrado como `superuser`.
+We would like to take advantage of a configuration file that we already had from another test, without big changes. So we add an `alias`:
 
 ```yaml
-# Version 2
+# Alias Version
 # File: config.yaml
 alias:
   super: :superuser
@@ -45,3 +49,5 @@ cases:
   superuser: root
   username: obiwan
 ```
+
+Now our test will work correctly. Calling `get(:super)` will return the same value as doing `get(:superuser).

data/docs/learn/README.md

@@ -1,9 +1,9 @@
 
 [<< back](../../README.md)
 
-1. [Learning](#learning)
-2. [Examples](#examples)
-3. [Videos](#videos)
+* [Learning](#learning)
+* [Examples](#examples)
+* [Videos](#videos)
 
 # Learning
 
@@ -21,16 +21,16 @@ Learn how to use Teuton language to write your own tests:
 - [11 - Moodle ID](11-moodle_id.md)
 - [12 - Get vars](12-get_vars.md)
 - [13 - Include](13-include.md)
-- Example 14 - Alias
-- Example 15 - Macros
-- [Example 16 - Exit codes](16-exit_codes.md)
+- [14 - Alias](14-alias.md)
+- 15 - Macros
+- [16 - Exit codes](16-exit_codes.md)
 - [Videos](videos.md)
 
 # Examples
 
 More examples
 * Let's see examples at [teuton-tests](https://github.com/dvarrui/teuton-tests) GitHub repository.
-* Ask us by email at `teuton.software@protonmail.com` or Twitter at `@SoftwareTeuton`.
+* Ask us by email at `teuton.software@protonmail.com`.
 * [ES - CHAPI19: Teuton demo](https://github.com/dvarrui/proyectos-de-ejemplo/tree/master/charlas/teuton)
 
 # Videos

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

@@ -2,6 +2,7 @@
 
 require_relative "../../application"
 require_relative "../../report/report"
+require_relative "../../report/show"
 require_relative "../utils"
 require_relative "main"
 require_relative "result/result"
@@ -17,7 +18,6 @@ require_relative "builtin/main"
 # * grade
 # * members
 # * skip
-# * show
 # * read_filename ???
 class Case
   include DSL
@@ -100,10 +100,6 @@ class Case
 
   alias skip? skip
 
-  def show
-    @report.show
-  end
-
   private
 
   def read_filename(filename)

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "colorize"
-
 module DSL
   # expect <condition>, :weight => <value>
   def expect(input, args = {})
@@ -10,7 +8,7 @@ module DSL
     elsif input.instance_of?(String) || input.instance_of?(Regexp) || input.instance_of?(Array)
       expect_any input
     else
-      puts "[TypeError] expect #{input} (#{input.class})"
+      puts Rainbow("[TypeError] expect #{input} (#{input.class})").red
     end
   end
 
@@ -30,7 +28,7 @@ module DSL
     app = Application.instance
     c = app.letter[:bad]
     c = app.letter[:good] if cond
-    verbose c.colorize(:green)
+    verbose Rainbow(c).green
   end
 
   def expect_any(input, args = {})

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

@@ -1,5 +1,4 @@
-# frozen_string_literal: true
-
+require "rainbow"
 ##
 # Define DSL#log function
 module DSL

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

@@ -37,9 +37,11 @@ module DSL
       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}")
+      msg = Rainbow("[ OK  ] #{(get(:tt_members)[0, 15]).ljust(16)} : #{remotefilepath}").green
+      verboseln(msg)
     rescue
-      verboseln("=> [ERROR] #{(get(:tt_members)[0, 15]).ljust(16)} : scp #{localfilepath} => #{remotefilepath}")
+      msg = Rainbow("[ERROR] #{(get(:tt_members)[0, 15]).ljust(16)} : scp #{localfilepath} => #{remotefilepath}").red
+      verboseln(msg)
     end
   end
 

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

@@ -9,10 +9,9 @@
 class Case
   def play
     if skip?
-      verbose "Skipping case <#{@config.get(:tt_members)}>\n"
+      verbose Rainbow("S").green
       return false
     end
-    # TODO: Delete old reports???
     start_time = Time.now
     if get(:tt_sequence) == true
       play_in_sequence

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

@@ -11,11 +11,14 @@ class Case
     ip = @config.get("#{host}_ip".to_sym)
 
     if protocol.to_s.downcase == "local" || host.to_s == "localhost"
-      run_cmd_localhost # Protocol force => local
+      # Protocol force => local
+      run_cmd_localhost
     elsif protocol.to_s.downcase == "ssh"
-      run_cmd_remote_ssh(host) # Protocol force => ssh
+      # Protocol force => ssh
+      run_cmd_remote_ssh(host)
     elsif protocol.to_s.downcase == "telnet"
-      run_cmd_remote_telnet(host) # Protocol force => telnet
+      # Protocol force => telnet
+      run_cmd_remote_telnet(host)
     elsif ip.to_s.downcase == "localhost" || ip.to_s.include?("127.0.0.")
       run_cmd_localhost
     elsif ip == "NODATA"
@@ -101,17 +104,14 @@ class Case
     rescue Errno::EHOSTUNREACH
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :host_unreachable
-      verbose Rainbow(Application.instance.letter[:error]).red.bright
       log("Host #{ip} unreachable!", :error)
     rescue Net::SSH::AuthenticationFailed
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :error_authentication_failed
-      verbose Rainbow(Application.instance.letter[:error]).red.bright
       log("SSH::AuthenticationFailed!", :error)
     rescue Net::SSH::HostKeyMismatch
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :host_key_mismatch
-      verbose Rainbow(Application.instance.letter[:error]).red.bright
       log("SSH::HostKeyMismatch!", :error)
       log("* The destination server's fingerprint is not matching " \
           "what is in your local known_hosts file.", :error)
@@ -121,7 +121,6 @@ class Case
     rescue => e
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :error
-      verbose Rainbow(Application.instance.letter[:error]).red.bright
       log("[#{e.class}] SSH on <#{username}@#{ip}>" \
           " exec: #{@action[:command]}", :error)
     end

data/lib/teuton/case_manager/case_manager.rb

@@ -1,13 +1,12 @@
-# frozen_string_literal: true
-
+require "rainbow"
 require "singleton"
 require_relative "../application"
 require_relative "../report/report"
+require_relative "../report/show"
 require_relative "../utils/configfile_reader"
 require_relative "case/case"
 require_relative "export_manager"
 require_relative "main"
-require_relative "utils"
 
 # This class does all the job
 # Organize the hole job, sending orders to others classes
@@ -18,13 +17,11 @@ require_relative "utils"
 # * case_manager/export
 # * case_manager/hall_of_fame
 # * case_manager/report
-# * case_manager/show
 class CaseManager
   include Singleton
   include Utils
+  attr_reader :report, :cases
 
-  ##
-  # Initialize CaseManager
   def initialize
     @cases = []
     @report = Report.new(0)
@@ -50,12 +47,11 @@ class CaseManager
   # @param args (Hash) Export options
   def export(args = {})
     if args.class != Hash
-      puts "[ERROR] CaseManager#export: Argument = <#{args}>, " \
-           "class = #{args.class}"
-      puts "        Usage: export :format => :colored_text"
+      puts "[ERROR] CaseManager#export: Argument error!"
+      puts "  Source : export #{args} <#{args.class}>"
+      puts "  Usage  : export format: 'txt'"
       raise "[ERROR] CaseManager#export: Argument error!"
     end
-    # Export report files
     ExportManager.run(@report, @cases, args)
   end
 
@@ -65,8 +61,16 @@ class CaseManager
   def send(args = {})
     threads = []
     puts ""
-    puts "[INFO] Sending files...#{args}"
+    # puts Rainbow("-" * 50).green
+    puts Rainbow("[INFO] Sending files...#{args}").color(:green)
     @cases.each { |c| threads << Thread.new { c.send(args) } }
     threads.each(&:join)
+    puts Rainbow("[INFO] Finished").color(:green)
+    # puts Rainbow("-" * 50).green
+  end
+
+  def show(options = {verbose: 1})
+    verbose = options[:verbose]
+    ShowReport.new(@report).call(verbose)
   end
 end

data/lib/teuton/case_manager/check_cases.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: true
+require_relative "hall_of_fame"
 
 class CaseManager
   private
@@ -32,18 +32,16 @@ class CaseManager
     close_main_report(start_time)
   end
 
-  ##
-  # Run all cases
   def run_all_cases
     start_time = Time.now
+    verboseln Rainbow("-" * 36).green
+    verboseln Rainbow("Started at #{start_time}").green
     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("==> Teuton: Running in parallel (#{start_time})").yellow.bright
-      threads = []
       # Run all cases in parallel
+      threads = []
       @cases.each { |c| threads << Thread.new { c.play } }
       threads.each(&:join)
     end
@@ -75,6 +73,6 @@ class CaseManager
     @cases.each { |c| threads << Thread.new { c.close uniques } }
     threads.each(&:join)
 
-    build_hall_of_fame
+    HallOfFame.new(@cases).call
   end
 end

data/lib/teuton/case_manager/dsl.rb

@@ -24,7 +24,7 @@ end
 alias def_macro define_macro
 alias defmacro define_macro
 
-# Define a group of tests
+# Define a group of [target/run/expect]s
 # @param name (String) Group name
 # @param block (Block) Tests code
 def group(name, &block)

data/lib/teuton/case_manager/export_manager.rb

@@ -8,22 +8,22 @@ module ExportManager
   # @param main_report (Report)
   # @param cases (Array)
   # @param input (Hash) Selected export options
-  def self.run(main_report, cases, input)
-    args = strings2symbols(input)
+  def self.run(main_report, cases, args)
+    options = strings2symbols(args)
+    if options[:format].nil?
+      options[:format] = Application.instance.default[:format]
+    end
 
-    # default :mode=>:all, :format=>:txt
-    format = args[:format] || Application.instance.default[:format]
-    mode = args[:mode] || :all
     # Step 1: Export case reports
-    if %i[details all].include? mode
-      threads = []
-      cases.each { |c| threads << Thread.new { c.export format } }
-      threads.each(&:join)
-    end
+    threads = []
+    cases.each { |c| threads << Thread.new { c.export(options) } }
+    threads.each(&:join)
+
     # Step 2: Export resume report
-    main_report.export_resume format if %i[resume all].include? mode
+    main_report.export_resume(options)
+
     # Step 3: Preserve files if required
-    preserve_files if args[:preserve] == true
+    preserve_files if options[:preserve] == true
   end
 
   ##
@@ -42,7 +42,7 @@ module ExportManager
   end
 
   ##
-  # Preserve output files for current project
+  # Preserve output files for current project execution
   private_class_method def self.preserve_files
     app = Application.instance
     t = Time.now
@@ -55,6 +55,4 @@ module ExportManager
     FileUtils.mkdir(logdir)
     Dir.glob(File.join(srcdir, "**.*")).each { |file| FileUtils.cp(file, logdir) }
   end
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/MethodLength
 end

data/lib/teuton/case_manager/hall_of_fame.rb

@@ -1,26 +1,30 @@
 require_relative "../application"
 
 class CaseManager
-  private
+  class HallOfFame
+    def initialize(cases)
+      @cases = cases
+    end
 
-  def build_hall_of_fame
-    celebrities = {}
+    def call
+      celebrities = {}
 
-    @cases.each do |c|
-      grade = c.grade # report.tail[:grade]
-      label = if celebrities[grade]
-        celebrities[grade] + "*"
-      else
-        "*"
+      @cases.each do |c|
+        grade = c.grade # report.tail[:grade]
+        label = if celebrities[grade]
+          celebrities[grade] + "*"
+        else
+          "*"
+        end
+        celebrities[grade] = label unless c.skip
       end
-      celebrities[grade] = label unless c.skip
-    end
 
-    a = celebrities.sort_by { |key, _value| key }
-    list = a.reverse
+      a = celebrities.sort_by { |key, _value| key }
+      list = a.reverse
 
-    app = Application.instance
-    app.options[:case_number] = @cases.size
-    app.hall_of_fame = list
+      app = Application.instance
+      app.options[:case_number] = @cases.size
+      app.hall_of_fame = list
+    end
   end
 end

data/lib/teuton/case_manager/main.rb

@@ -1,4 +1,3 @@
 require_relative "check_cases"
-require_relative "hall_of_fame"
 require_relative "report"
-require_relative "show"
+require_relative "utils"

data/lib/teuton/case_manager/report.rb

@@ -25,8 +25,8 @@ class CaseManager
     @report.tail[:duration] = finish_time - start_time
 
     duration = format("%3.3f", (finish_time - start_time))
-    verbose Rainbow("\n==> Teuton: Duration=#{duration}").yellow.bright
-    verboseln Rainbow(" (#{finish_time})").yellow.bright
+    verboseln Rainbow("\nFinished in #{duration} seconds").green
+    verboseln Rainbow("-" * 36).green
     verboseln " "
 
     app = Application.instance
@@ -37,7 +37,7 @@ class CaseManager
           skip: true,
           id: "-",
           grade: 0.0,
-          letter: "",
+          letter: "S",
           members: "-",
           conn_status: {},
           moodle_id: "",

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

@@ -1,18 +1,17 @@
-# frozen_string_literal: true
-
 class BaseFormatter
   def initialize(report)
-    @head = report.head
-    @lines = report.lines
-    @tail = report.tail
+    @head = report.head.clone
+    @lines = report.lines.clone
+    @tail = report.tail.clone
+    @ext = "unkown"
   end
 
-  def process
+  def process(options = {})
     raise "Empty method!"
   end
 
   def init(filename)
-    @filename = filename
+    @filename = "#{filename}.#{@ext}"
     @file = File.open(@filename, "w")
   end
 

data/lib/teuton/report/formatter/{array_formatter.rb → default/array.rb}

@@ -1,6 +1,5 @@
-# frozen_string_literal: true
-
-require_relative "base_formatter"
+require_relative "../base_formatter"
+require_relative "../../../application"
 
 class ArrayFormatter < BaseFormatter
   def initialize(report)
@@ -8,26 +7,28 @@ class ArrayFormatter < BaseFormatter
     @data = {}
   end
 
-  def process
-    build_data
+  def process(options = {})
+    build_data(options)
     w @data.to_s # Write data into ouput file
     deinit
   end
 
-  def build_data
+  def build_data(options)
     build_initial_data
-    build_history_data
+    build_history_data(options)
     build_final_data
     build_hof_data
   end
 
+  private
+
   def build_initial_data
     head = {}
     @head.each { |key, value| head[key] = value }
     @data[:config] = head
   end
 
-  def build_history_data
+  def build_history_data(options)
     @data[:logs] = []
     groups = []
     title = nil
@@ -54,12 +55,22 @@ class ArrayFormatter < BaseFormatter
       target[:score] = value
       target[:weight] = i[:weight]
       target[:description] = i[:description]
-      target[:command] = i[:command]
+
       target[:conn_type] = i[:conn_type]
       target[:duration] = i[:duration]
+
+      target[:command] = i[:command]
       target[:alterations] = i[:alterations]
       target[:expected] = i[:expected]
       target[:result] = i[:result]
+
+      if options[:feedback] == false
+        target[:command] = "*" * i[:command].size
+        target[:alterations] = "*" * i[:alterations].size
+        target[:expected] = "*" * i[:expected].size
+        target[:result] = "*" * i[:result].size
+      end
+
       targets << target
     end
 
@@ -82,4 +93,28 @@ class ArrayFormatter < BaseFormatter
     app.hall_of_fame.each { |line| fame[line[0]] = line[1] }
     @data[:hall_of_fame] = fame
   end
+
+  def config
+    @data[:config]
+  end
+
+  def results
+    @data[:results]
+  end
+
+  def logs
+    @data[:logs]
+  end
+
+  def groups
+    @data[:groups]
+  end
+
+  def hall_of_fame
+    @data[:hall_of_fame]
+  end
+
+  def version
+    Application::VERSION
+  end
 end

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

@@ -0,0 +1,7 @@
+require_relative "txt"
+
+class ColoredTextFormatter < TXTFormatter
+  def initialize(report)
+    super(report, true)
+  end
+end