teuton 2.4.1 → 2.4.3

data/docs/learn/{10-result.md → 22-result.md}

@@ -1,6 +1,6 @@
 [<< back](README.md)
 
-# Example: 10-result
+# result
 
 Sometimes it can be useful to look at the information returned by the "run" command. For this we use the **"result" object**.
 
@@ -20,11 +20,11 @@ end
 
 **Example 2:** When we are debugging our test and we want to see the content of the "result" object on the screen, we will use `result.debug`.
 
-```
+```ruby
 group "Checking users" do
   users = ["root", "vader"]
 
-  users.each do |name|
+  for name in users do
     target "Exists username #{name}"
     run "id #{name}"
     result.debug

data/docs/learn/23-test-code.md

@@ -0,0 +1,54 @@
+[<<back](README.md)
+
+# Test code
+
+Let's test code using teuton.
+
+**Example:**
+
+* Ask students to make a program that performs addition and multiplication.
+* Define targets `sum` and `mul`:
+
+```ruby
+# File: start.rb
+group "Test code example" do
+  # Reading filepath from config file
+  filepath = "./#{get(:folder)}/#{get(:filename)}"
+
+  target "Sum"
+  run "#{filepath} 3 4"
+  expect [ "Sum", "7" ] # Using Array/List of required items
+
+  target "Mul"
+  run "#{filepath} 3 4"
+  expect /Mul\s+=\s+12/ # Using a regular expresion
+end
+```
+
+* Define config params:
+
+```yaml
+# File: config.yaml
+---
+global:
+  folder: examples/23-test-code/code
+cases:
+- tt_members: student_1
+  filename: math_1.py
+- tt_members: student_2
+  filename: math_2b.py
+```
+
+* Put students files into `code` folder.
+* Now run Teuton test:
+
+```
+❯ teuton examples/23-test-code
+
+CASE RESULTS
++------+-----------+-------+-------+
+| CASE | MEMBERS   | GRADE | STATE |
+| 01   | student_1 | 100.0 | ✔     |
+| 02   | student_2 | 100.0 | ✔     |
++------+-----------+-------+-------+
+```

data/docs/learn/24-test-sql.md

@@ -0,0 +1,69 @@
+[<<back](README.md)
+
+# Test SQL and database
+
+**Exercise**
+
+* Ask students to make a Sqlite Database. Create a table called `characters` with `name` varchar, and `rol` varchar.
+* Database example:
+
+```
+❯ sqlite3 examples/24-test-sql/database_01.db
+
+sqlite> .schema characters
+CREATE TABLE characters ( name varchar(255), rol varchar(255));
+
+sqlite> select * from characters;
+Obiwan|Jedi
+```
+
+* Query example:
+
+```
+❯ cat examples/24-test-sql/query_01.sql
+
+select * from characters where rol='Jedi';
+```
+
+**Teuton test**
+
+* Define targets:
+
+```ruby
+group "Test SQL and database" do
+  database = "#{get(:folder)}/#{get(:database)}"
+  query = "#{get(:folder)}/#{get(:query)}"
+
+  target "Database schema"
+  run "sqlite3 #{database} '.schema characters'"
+  expect "name varchar", "rol varchar"
+
+  target "Query Jedi"
+  run "sqlite3 #{database} '.read #{query}'"
+  expect "Obiwan", "Jedi"
+end
+```
+
+* Configure params:
+
+```yaml
+---
+global:
+  folder: examples/24-test-sql
+cases:
+- tt_members: student_1_name
+  database: database_01.db
+  query: query_01.sql
+```
+
+**Test output**
+
+```
+❯ teuton examples/24-test-sql                                   
+
+CASE RESULTS
++------+----------------+-------+-------+
+| CASE | MEMBERS        | GRADE | STATE |
+| 01   | student_1_name | 100.0 | ✔     |
++------+----------------+-------+-------+
+```

data/docs/learn/README.md

@@ -1,27 +1,33 @@
-
 [<< back](../../README.md)
 
 # Learn
 
 Learn how write your own Teuton tests:
 
-- [01 - Target](01-target.md)
-- [02 - Config file](02-config.md)
-- [03 - Remote hosts](03-remote_hosts.md)
-- [04 - Create new test](04-new_test.md)
-- [05 - Use](05-use.md)
-- [06 - Debug](06-debug.md)
-- [07 - Log](07-log.md)
-- [08 - Readme](08-readme.md)
-- [09 - Preserve](09-preserve.md)
-- [10 - Result object](10-result.md)
-- [11 - Moodle ID](11-moodle_id.md)
-- [12 - Get vars](12-get_vars.md)
-- [13 - Include](13-include.md)
-- [14 - Alias](14-alias.md)
-- 15 - Macros
-- [16 - Exit codes](16-exit_codes.md)
-- [17 - Hide feedback](17-hide-feedback.md)
+1. [Creating NEW test](01-cmd_new.md)
+1. [Evaluating TARGET](02-target.md)
+1. [Checking REMOTE HOSTS](03-remote_hosts.md)
+1. [Reading CONFIG file](04-config.md)
+1. [Using several files](05-use.md)
+1. [CHECK test syntax](06-cmd_check.md)
+1. [Target WEIGHT](07-target_weight.md)
+1. [UNIQUE values](08-unique_values.md)
+1. [SEND report copies to remote hosts](09-send.md)
+1. [DEBUG results](10-debug.md)
+1. [Export other FORMATS](11-export.md)
+1. [PRESERVE old reports](12-preserve.md)
+1. [Hide FEEDBACK from reports](13-feedback.md)
+1. [MOODLE ID](14-moodle_id.md)
+1. [Build README from test](15-readme.md)
+1. [INCLUDE more configuration files](16-include.md)
+1. [ALIAS](17-alias.md)
+1. [LOG messages](18-log.md)
+1. [Don't get params, just read vars](19-read_vars.md)
+1. [MACROS](20-macros.md)
+1. [Checking exit codes](21-exit_codes.md)
+1. [RESULT object](22-result.md)
+1. [Test code](23-test-code.md)
+1. [Test SQL and database](24-test-sql.md)
 
 Mores examples at [teuton-tests](https://github.com/dvarrui/teuton-tests) GitHub repository.
 

data/lib/teuton/application.rb

@@ -1,13 +1,8 @@
-# frozen_string_literal: true
-
 require "singleton"
-require_relative "version"
 require_relative "utils/name_file_finder"
 
-# This Singleton contains application params
 class Application
   include Singleton
-  include Teuton
 
   attr_reader :letter
   attr_reader :running_basedir, :output_basedir

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

@@ -99,7 +99,7 @@ class Case
     @report.head[:tt_members] || "noname"
   end
 
-  alias skip? skip
+  alias_method :skip?, :skip
 
   private
 

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

@@ -54,8 +54,15 @@ module DSL
     expect2 input, expected: output
   end
 
-  def expect_none(input, args = {})
-    if input.instance_of? Array
+  # def expect_none(input, args = {})
+  def expect_nothing(args = {})
+    expect2 result.count.eq(0), args
+  end
+
+  def expect_none(input = nil, args = {})
+    if input.nil?
+      # nothing to do
+    elsif input.instance_of? Array
       input.each { |i| result.find(i) }
     else
       result.find(input)

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

@@ -31,5 +31,5 @@ module DSL
     run_cmd_on(host)
     @action[:duration] = (Time.now - start_time).round(3)
   end
-  alias on goto
+  alias_method :on, :goto
 end

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

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

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

@@ -12,5 +12,5 @@ module DSL
     w = args[:weight] || 1.0
     weight(w)
   end
-  alias goal target
+  alias_method :goal, :target
 end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# This is an extension of Result class
+# Extension of Result class
 class Result
   def eq(input)
     # Return true when content is equal than input
@@ -22,10 +22,10 @@ class Result
     end
     value == input
   end
-  alias eq? eq
-  alias equal eq
-  alias equal? eq
-  alias is_equal? eq
+  alias_method :eq?, :eq
+  alias_method :equal, :eq
+  alias_method :equal?, :eq
+  alias_method :is_equal?, :eq
 
   def neq(external)
     @expected = "Not equal to #{external}"
@@ -44,9 +44,9 @@ class Result
     end
     internal != external
   end
-  alias neq? neq
-  alias not_equal neq
-  alias not_equal? neq
+  alias_method :neq?, :neq
+  alias_method :not_equal, :neq
+  alias_method :not_equal?, :neq
 
   def ge(input)
     @expected = "Greater or equal to #{input}"
@@ -65,8 +65,8 @@ class Result
     end
     value >= input
   end
-  alias greater_or_equal ge
-  alias greater_or_equal? ge
+  alias_method :greater_or_equal, :ge
+  alias_method :greater_or_equal?, :ge
 
   def gt(input)
     @expected = "Greater than #{input}"
@@ -85,8 +85,8 @@ class Result
     end
     value > input
   end
-  alias greater gt
-  alias greater_than gt
+  alias_method :greater, :gt
+  alias_method :greater_than, :gt
 
   def le(input)
     @expected = "Lesser or equal to #{input}"
@@ -106,8 +106,8 @@ class Result
     end
     value <= input
   end
-  alias lesser_or_equal le
-  alias lesser_or_equal? le
+  alias_method :lesser_or_equal, :le
+  alias_method :lesser_or_equal?, :le
 
   def lt(input)
     @expected = "Lesser than #{input}"
@@ -126,9 +126,9 @@ class Result
     end
     value < input
   end
-  alias lesser lt
-  alias smaller lt
-  alias lesser_than lt
+  alias_method :lesser, :lt
+  alias_method :smaller, :lt
+  alias_method :lesser_than, :lt
 
   # Return 'true' if the parameter value is near to the target value.
   # To get this we consider a 10% desviation or less, as an acceptable result.
@@ -142,8 +142,7 @@ class Result
 
     false
   end
-  alias near_to near_to?
-  alias near? near_to?
-  alias near near_to?
+  alias_method :near_to, :near_to?
+  alias_method :near?, :near_to?
+  alias_method :near, :near_to?
 end
-# rubocop:enable Metrics/ClassLength

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# This is an extension of Result class
+# Result class extension
 class Result
   # TODO: Error line 102 undefined include? method for 0 Fixnum...
   def find(filter)
@@ -15,9 +15,9 @@ class Result
     end
     self
   end
-  alias grep find
-  alias grep! find
-  alias find! find
+  alias_method :grep, :find
+  alias_method :grep!, :find
+  alias_method :find!, :find
 
   def first
     @alterations << "first"
@@ -25,14 +25,21 @@ class Result
     self
   end
 
-  def not_find(p_filter)
-    @alterations << "not_find(#{p_filter})"
+  def not_find(filter)
+    @alterations << "not_find(#{filter})"
     return self if @content.size.zero?
 
-    @content.reject! { |i| i.include?(p_filter) }
+    case filter.class.to_s
+    when "Array"
+      filter.each { |i| not_find(i.to_s) }
+    when "String" || "Integer"
+      @content.reject! { |i| i.include?(filter.to_s) }
+    when "Regexp"
+      @content.reject! { |i| filter.match(i) }
+    end
     self
   end
-  alias grep_v not_find
+  alias_method :grep_v, :not_find
 
   def since(filter)
     @alterations << "since(#{filter})"

data/lib/teuton/check/show.rb

@@ -131,7 +131,7 @@ class Laboratory
       st.add_separator
       st.add_row ["Groups", @stats[:groups]]
       st.add_row ["Targets", @stats[:targets]]
-      st.add_row ["Goto", @stats[:hosts]]
+      st.add_row ["Runs", @stats[:hosts]]
       @hosts.each_pair { |k, v| st.add_row [" * #{k}", v] }
       st.add_row ["Uniques", @stats[:uniques]]
       st.add_row ["Logs", @stats[:uniques]]

data/lib/teuton/files/config.yaml

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

data/lib/teuton/files/start.rb

@@ -1,7 +1,7 @@
-group "GROUP NAME" do
-  target "TARGET_1 DESCRIPTION"
-  run "COMMAND_1"
-  expect "TEXT_1"
+group "NAME-TO-CHANGE" do
+  target "DESC_TO-CHANGE"
+  run "COMMAND_TO-CHANGE"
+  expect "TEXT_TO-CHANGE"
 end
 
 play do

data/lib/teuton/readme/dsl.rb

@@ -87,10 +87,18 @@ class Readme
   end
 
   # If a method call is missing, then delegate to concept parent.
-  def method_missing(method, args = {})
+  # def method_missing(method, args = {})
+  def method_missing(method, *args, &block)
     m = method.to_s
     if m[0] == "_"
       instance_eval("get(:#{m[1, m.size - 1]})", __FILE__, __LINE__)
+    elsif not Application.instance.macros[m].nil?
+      puts "macro exec: #{m}"
+      code = ""
+      args[0].keys.each { |key| code += "set(:#{key}, '#{args[0][key]}')\n" }
+      puts code
+      # instance_eval(code)
+      # Application.instance.macros[m].call
     end
   end
 

data/lib/teuton/readme/readme.rb

@@ -1,6 +1,7 @@
 require_relative "../application"
 require_relative "../utils/configfile_reader"
 require_relative "../case_manager/case/result/result"
+require_relative "../version"
 require_relative "dsl"
 require_relative "lang"
 
@@ -14,6 +15,11 @@ def use(filename)
   require_relative use[0]
 end
 
+def define_macro(name, *args, &block)
+  puts "macro: #{name}"
+  Application.instance.macros[name] = {args: args, block: block}
+end
+
 def group(name, &block)
   Application.instance.groups << {name: name, block: block}
 end
@@ -58,6 +64,7 @@ class Readme
     @verbose = app.verbose
     @result = Result.new
     @data = {}
+    @data[:macros] = []
     @data[:logs] = []
     @data[:groups] = []
     @data[:play] = []
@@ -86,7 +93,7 @@ class Readme
     puts "```"
     puts format(Lang.get(:testname), app.test_name)
     puts format(Lang.get(:date), Time.now)
-    puts format(Lang.get(:version), Application::VERSION)
+    puts format(Lang.get(:version), Teuton::VERSION)
     puts "```"
     puts "\n"
     puts "# #{app.test_name}\n"

data/lib/teuton/report/show.rb

@@ -1,6 +1,14 @@
 require "rainbow"
+require "terminal-table"
 require_relative "../application"
 
+# | Verbosity level | Description |
+# | :-------------: | ----------- |
+# | 0               | No output   |
+# | 1               | Default output messages |
+# | 2               | Show hall of fame |
+# | 3               | Show final values |
+# | 4               | Show Initial values |
 class ShowReport
   def initialize(report)
     @report = report

data/lib/teuton/version.rb

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