teuton 2.7.3 → 2.9.0

data/lib/teuton/readme/main.rb

@@ -0,0 +1,27 @@
+require_relative "../utils/project"
+require_relative "readme"
+
+def use(filename)
+  filename += ".rb"
+  rbfiles = File.join(Project.value[:project_path], "**", filename)
+  files = Dir.glob(rbfiles)
+  use = []
+  files.sort.each { |f| use << f if f.include?(filename) }
+  require_relative use[0]
+  Project.value[:uses] << use[0]
+end
+
+def define_macro(name, *args, &block)
+  Project.value[:macros][name] = {args: args, block: block}
+end
+
+def group(name, &block)
+  Project.value[:groups] << {name: name, block: block}
+end
+alias task group
+
+def start(&block)
+  # don't do nothing
+end
+# alias_method "play", "start" # REVISE THIS
+alias play start

data/lib/teuton/readme/readme.rb

@@ -1,44 +1,19 @@
+require_relative "../utils/logger"
 require_relative "../utils/project"
 require_relative "../utils/configfile_reader"
-require_relative "../utils/result/result"
+require_relative "../case/dsl/macro"
 require_relative "../version"
-require_relative "dsl"
+require_relative "dsl/all"
 require_relative "lang"
-
-def use(filename)
-  filename += ".rb"
-  rbfiles = File.join(Project.value[:project_path], "**", filename)
-  files = Dir.glob(rbfiles)
-  use = []
-  files.sort.each { |f| use << f if f.include?(filename) }
-  require_relative use[0]
-  Project.value[:uses] << use[0]
-end
-
-def define_macro(name, *args, &block)
-  puts "macro: #{name}"
-  Project.value[:macros][name] = {args: args, block: block}
-end
-
-def group(name, &block)
-  Project.value[:groups] << {name: name, block: block}
-end
-alias task group
-
-def start(&block)
-  # don't do nothing
-end
-# alias_method "play", "start" # REVISE THIS
-alias play start
+require_relative "result"
 
 class Readme
-  # Creates README.md file from RB script file
+  include DSL
+  include ReadmeDSL
   attr_reader :result
   attr_reader :data
 
   def initialize(script_path, config_path)
-    # script_path Path to main rb file (start.rb)
-    # config_path Path to main config file (config.yaml)
     @path = {}
     @path[:script] = script_path
     @path[:dirname] = File.dirname(script_path)
@@ -57,13 +32,11 @@ class Readme
   private
 
   def reset
-    # app = Application.instance
     @config = ConfigFileReader.read(Project.value[:config_path])
     @verbose = Project.value[:verbose]
-    @result = Result.new
+    @result = ReadmeResult.new
     @data = {}
     @data[:macros] = []
-    @data[:logs] = []
     @data[:groups] = []
     @data[:play] = []
     reset_action
@@ -74,11 +47,11 @@ class Readme
   end
 
   def process_content
-    Project.value[:groups].each do |g|
-      @current = {name: g[:name], readme: [], actions: []}
+    Project.value[:groups].each do |group|
+      @current = {name: group[:name], readme: [], actions: []}
       @data[:groups] << @current
       reset_action
-      instance_eval(&g[:block])
+      instance_eval(&group[:block])
     end
   end
 
@@ -88,12 +61,11 @@ class Readme
 
   def show_head
     puts "```"
-    puts format(Lang.get(:testname), Project.value[:test_name])
     puts format(Lang.get(:date), Time.now)
     puts format(Lang.get(:version), Teuton::VERSION)
     puts "```"
     puts "\n"
-    puts "# #{Project.value[:test_name]}\n"
+    puts "# Test: #{Project.value[:test_name]}\n"
 
     i = 1
     unless @required_hosts.empty?
@@ -114,7 +86,6 @@ class Readme
       @cases_params.sort!
       puts Lang.get(:params)
       @cases_params.uniq.each { |i| puts format("* %s", i) }
-      puts "\n> NOTE: Save every 'param: value' into config file."
     end
   end
 
@@ -122,7 +93,7 @@ class Readme
     @data[:groups].each do |group|
       next if group[:actions].empty?
 
-      puts "\n## #{group[:name].capitalize}\n\n"
+      puts "\n## #{group[:name].capitalize}\n"
       group[:readme].each { |line| puts "#{line}\n" }
       previous_host = nil
       group[:actions].each_with_index do |item, index|
@@ -133,10 +104,8 @@ class Readme
           previous_host = item[:host] || "null"
           puts format(Lang.get(:goto), previous_host.upcase)
         end
-
-        weight = ""
-        weight = "(x#{item[:weight]}) " if item[:weight].to_i != 1
-        last = (item[:target].end_with?(".") ? "" : ".")
+        weight = "(x#{item[:weight]}) "
+        last = item[:target].end_with?(".", ":") ? "" : "."
         puts "* #{weight}#{item[:target]}#{last}"
         item[:readme].each { |line| puts "    * #{line}\n" }
       end
@@ -144,21 +113,25 @@ class Readme
   end
 
   def show_tail
-    return if @global_params.empty?
+    return if (@global_params.size + @setted_params.size).zero?
 
     puts "\n---"
     puts "# ANEXO"
-    puts "\n## Global params"
-    puts Lang.get(:global)
-    puts "\n"
-    puts "| Global param | Value |"
-    puts "| --- | --- |"
-    @global_params.each_pair { |k, v| puts "|#{k}|#{v}|" }
-    puts "\n## Created params"
-    puts Lang.get(:created)
-    puts "\n"
-    puts "| Created params | Value |"
-    puts "| --- | --- |"
-    @setted_params.each_pair { |k, v| puts "|#{k}|#{v}|" }
+    puts "\n## Params"
+
+    if @global_params.size.positive?
+      puts Lang.get(:global_params)
+      puts "\n"
+      puts "| Param | Value |"
+      puts "| --- | --- |"
+      @global_params.each_pair { |k, v| puts "|#{k}|#{v}|" }
+    end
+    if @setted_params.size.positive?
+      puts Lang.get(:created_params)
+      puts "\n"
+      puts "| Param | Value |"
+      puts "| --- | --- |"
+      @setted_params.each_pair { |k, v| puts "|#{k}|#{v}|" }
+    end
   end
 end

data/lib/teuton/readme/result.rb

@@ -0,0 +1,7 @@
+require_relative "../case/result/result"
+
+class ReadmeResult < Result
+  def debug
+    # Nothing to do
+  end
+end

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

@@ -94,8 +94,8 @@ class TXTFormatter < ArrayFormatter
       w "#{tab * 4}Output      : #{i[:output]}\n"
       w "#{tab * 4}Duration    : #{i[:duration]} (#{i[:conn_type]})\n"
       w "#{tab * 4}Alterations : #{i[:alterations]}\n"
-      w "#{tab * 4}Expected    : #{i[:expected]} (#{i[:expected].class})\n"
-      w "#{tab * 4}Result      : #{i[:result]} (#{i[:result].class})\n"
+      w "#{tab * 4}Expected    : #{i[:expected]}\n"
+      w "#{tab * 4}Result      : #{i[:result]}\n"
     end
   end
 end

data/lib/teuton/utils/configfile_reader.rb

@@ -30,11 +30,15 @@ module ConfigFileReader
   def self.read_yaml(filepath)
     begin
       data = YAML.load(File.open(filepath))
+      # data = YAML.safe_load(
+      #   File.open(filepath),
+      #   permitted_classes: [Array, Date, Hash, Symbol]
+      # )
     rescue => e
-      $stderr.puts "\n" + ("=" * 80)
-      $stderr.puts "[ERROR] ConfigFileReader#read <#{filepath}>"
-      $stderr.puts "        I suggest to revise file format!"
-      $stderr.puts "        #{e.message}\n" + ("=" * 80)
+      warn "\n" + ("=" * 80)
+      warn "[ERROR] ConfigFileReader#read <#{filepath}>"
+      warn "        I suggest to revise file format!"
+      warn "        #{e.message}\n" + ("=" * 80)
       exit 1
     end
     data = convert_string_keys_to_symbol(data)

data/lib/teuton/utils/logger.rb

@@ -0,0 +1,32 @@
+require "rainbow"
+
+class Logger
+  @verbose = true
+
+  def self.verbose=(value)
+    @verbose = value
+  end
+
+  def self.verbose
+    @verbose
+  end
+
+  def self.info(message)
+    puts message if @verbose
+  end
+
+  def self.warn(message)
+    text = Rainbow(message).bright.yellow
+    info(text)
+  end
+
+  def self.error(message)
+    text = Rainbow(message).bright.red
+    info(text)
+  end
+
+  def self.debug(message)
+    text = Rainbow(message).white
+    info(text)
+  end
+end

data/lib/teuton/utils/verbose.rb

@@ -2,7 +2,7 @@ require_relative "project"
 
 module Verbose
   def verboseln(text)
-    verbose(text + "\n")
+    verbose(text.to_s + "\n")
   end
 
   def verbose(text)

data/lib/teuton/version.rb

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

data/lib/teuton.rb

@@ -8,15 +8,16 @@ module Teuton
 
   def self.check(projectpath, options = {})
     Project.add_input_params(projectpath, options)
-    require_dsl_and_script("teuton/check/laboratory") # Define DSL
-    lab = Laboratory.new(
+    require_dsl_and_script("teuton/check/main")
+    require_relative "teuton/check/checker"
+    checker = Checker.new(
       Project.value[:script_path],
       Project.value[:config_path]
     )
     if options["onlyconfig"]
-      lab.show_onlyconfig
+      checker.show_onlyconfig
     else
-      lab.show
+      checker.show
     end
   end
 
@@ -28,7 +29,7 @@ module Teuton
 
   def self.readme(projectpath, options = {})
     Project.add_input_params(projectpath, options)
-    require_dsl_and_script("teuton/readme/readme") # Define DSL
+    require_dsl_and_script("teuton/readme/main") # Define DSL
     readme = Readme.new(
       Project.value[:script_path],
       Project.value[:config_path]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 2.7.3
+  version: 2.9.0
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-07 00:00:00.000000000 Z
+date: 2023-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -124,17 +124,9 @@ extensions: []
 extra_rdoc_files:
 - README.md
 - LICENSE
-- docs/CHANGELOG.md
+- docs/changelog/changelog.1.md
+- docs/changelog/changelog.2.md
 - docs/changelog/todo.md
-- docs/changelog/v2.0.md
-- docs/changelog/v2.1.md
-- docs/changelog/v2.2.md
-- docs/changelog/v2.3.md
-- docs/changelog/v2.4.md
-- docs/changelog/v2.5.md
-- docs/changelog/v2.6.md
-- docs/changelog/v2.7.md
-- docs/changelog/version2.1.md
 - docs/commands/README.md
 - docs/commands/example_check.md
 - docs/commands/example_run.md
@@ -187,24 +179,19 @@ extra_rdoc_files:
 - docs/learn/22-result.md
 - docs/learn/23-test-code.md
 - docs/learn/24-test-sql.md
+- docs/learn/25-expect-result.md
+- docs/learn/26-expect_sequence.md
+- docs/learn/27-run_script.md
+- docs/learn/28-upload.md
 - docs/learn/README.md
-- docs/learn/videos.md
 - docs/videos.md
 files:
 - LICENSE
 - README.md
 - bin/teuton
-- docs/CHANGELOG.md
+- docs/changelog/changelog.1.md
+- docs/changelog/changelog.2.md
 - docs/changelog/todo.md
-- docs/changelog/v2.0.md
-- docs/changelog/v2.1.md
-- docs/changelog/v2.2.md
-- docs/changelog/v2.3.md
-- docs/changelog/v2.4.md
-- docs/changelog/v2.5.md
-- docs/changelog/v2.6.md
-- docs/changelog/v2.7.md
-- docs/changelog/version2.1.md
 - docs/commands/README.md
 - docs/commands/example_check.md
 - docs/commands/example_run.md
@@ -257,8 +244,11 @@ files:
 - docs/learn/22-result.md
 - docs/learn/23-test-code.md
 - docs/learn/24-test-sql.md
+- docs/learn/25-expect-result.md
+- docs/learn/26-expect_sequence.md
+- docs/learn/27-run_script.md
+- docs/learn/28-upload.md
 - docs/learn/README.md
-- docs/learn/videos.md
 - docs/videos.md
 - lib/teuton.rb
 - lib/teuton/case/builtin/main.rb
@@ -270,24 +260,32 @@ files:
 - lib/teuton/case/case.rb
 - lib/teuton/case/close.rb
 - lib/teuton/case/config.rb
-- lib/teuton/case/deprecated/runner.rb
-- lib/teuton/case/deprecated/utils.rb
 - lib/teuton/case/dsl/all.rb
 - lib/teuton/case/dsl/expect.rb
+- lib/teuton/case/dsl/expect_exitcode.rb
+- lib/teuton/case/dsl/expect_sequence.rb
 - lib/teuton/case/dsl/getset.rb
-- lib/teuton/case/dsl/goto.rb
+- lib/teuton/case/dsl/host.rb
 - lib/teuton/case/dsl/log.rb
 - lib/teuton/case/dsl/macro.rb
+- lib/teuton/case/dsl/run.rb
+- lib/teuton/case/dsl/run_script.rb
 - lib/teuton/case/dsl/send.rb
 - lib/teuton/case/dsl/target.rb
 - lib/teuton/case/dsl/unique.rb
-- lib/teuton/case/execute/copy_ssh.rb
+- lib/teuton/case/dsl/upload.rb
+- lib/teuton/case/dsl/weight.rb
 - lib/teuton/case/execute/execute_base.rb
 - lib/teuton/case/execute/execute_local.rb
 - lib/teuton/case/execute/execute_manager.rb
 - lib/teuton/case/execute/execute_ssh.rb
 - lib/teuton/case/execute/execute_telnet.rb
+- lib/teuton/case/host.rb
 - lib/teuton/case/play.rb
+- lib/teuton/case/result/ext_array.rb
+- lib/teuton/case/result/ext_compare.rb
+- lib/teuton/case/result/ext_filter.rb
+- lib/teuton/case/result/result.rb
 - lib/teuton/case_manager/case_manager.rb
 - lib/teuton/case_manager/check_cases.rb
 - lib/teuton/case_manager/dsl.rb
@@ -297,19 +295,33 @@ files:
 - lib/teuton/case_manager/send_manager.rb
 - lib/teuton/case_manager/show_report.rb
 - lib/teuton/case_manager/utils.rb
-- lib/teuton/check/builtin.rb
-- lib/teuton/check/dsl.rb
-- lib/teuton/check/laboratory.rb
+- lib/teuton/check/checker.rb
+- lib/teuton/check/dsl/all.rb
+- lib/teuton/check/dsl/builtin.rb
+- lib/teuton/check/dsl/expect.rb
+- lib/teuton/check/dsl/expect_sequence.rb
+- lib/teuton/check/dsl/getset.rb
+- lib/teuton/check/dsl/run.rb
+- lib/teuton/check/main.rb
 - lib/teuton/check/show.rb
 - lib/teuton/cli.rb
+- lib/teuton/deprecated/application.rb
+- lib/teuton/deprecated/application_test.rb
+- lib/teuton/deprecated/runner.rb
+- lib/teuton/deprecated/utils.rb
 - lib/teuton/files/README.md
 - lib/teuton/files/config.yaml
 - lib/teuton/files/start.rb
 - lib/teuton/files/template/case.html
 - lib/teuton/files/template/resume.html
-- lib/teuton/readme/dsl.rb
+- lib/teuton/readme/dsl/all.rb
+- lib/teuton/readme/dsl/expect.rb
+- lib/teuton/readme/dsl/getset.rb
+- lib/teuton/readme/dsl/run.rb
 - lib/teuton/readme/lang.rb
+- lib/teuton/readme/main.rb
 - lib/teuton/readme/readme.rb
+- lib/teuton/readme/result.rb
 - lib/teuton/report/formatter/base_formatter.rb
 - lib/teuton/report/formatter/default/array.rb
 - lib/teuton/report/formatter/default/colored_text.rb
@@ -328,14 +340,10 @@ files:
 - lib/teuton/report/formatter/resume/yaml.rb
 - lib/teuton/report/report.rb
 - lib/teuton/skeleton.rb
-- lib/teuton/utils/application.rb
 - lib/teuton/utils/configfile_reader.rb
+- lib/teuton/utils/logger.rb
 - lib/teuton/utils/name_file_finder.rb
 - lib/teuton/utils/project.rb
-- lib/teuton/utils/result/ext_array.rb
-- lib/teuton/utils/result/ext_compare.rb
-- lib/teuton/utils/result/ext_filter.rb
-- lib/teuton/utils/result/result.rb
 - lib/teuton/utils/settings.rb
 - lib/teuton/utils/verbose.rb
 - lib/teuton/version.rb

data/docs/CHANGELOG.md

@@ -1,10 +0,0 @@
-[<< back](../README.md)
-
-# Changelog
-
-* [version 2.5](changelog/v2.5.md)
-* [version 2.4](changelog/v2.4.md)
-* [version 2.3](changelog/v2.3.md)
-* [version 2.2](changelog/v2.2.md)
-* [version 2.1](changelog/v2.1.md)
-* [version 2.0](changelog/v2.0.md)

data/docs/changelog/v2.0.md

@@ -1,18 +0,0 @@
-[<< back](../CHANGELOG.md)
-
-# CHANGELOG
-
-## 2019
-
-|Date      |Version |Changes |
-|--------- |------- |------- |
-| August 2019 | 2.0.4 | TEUTON project grew up and was divided into the folowing repositories: teuton, challenges, panel, resources and vagrant. Documentation has been moved into respository teuton wiki. Only maintain English docs. |
-|January 2019 |1.10.0   | SysadminGame change his name by TEUTON. "project" command replaced by "teuton". Challenges (Teuton scripts) moved to "teuton-challenges" github repository. Execute "rake get_challenges" to get sample teuton challenges |
-
-## 2017
-
-|Date      |Version |Changes |
-|--------- |------- |------- |
-|July 2017 |1.0.0   | New stable version |
-|June 2017 |0.22.1  | * Now it's posible to use config files with YAML and JSON format |
-|          |        | * Preparing migration of CLI command to use Thor gem |

data/docs/changelog/v2.1.md

@@ -1,54 +0,0 @@
-[<< back](../CHANGELOG.md)
-
-# CHANGELOG teuton v 2.1
-
-# 1. Export grades on csv file using Moodle format
-
-* Automaticaly exports `moodle.csv` file with all cases grades, using adecuate format so it could be imported directly into Moodle platform.
-* We need to configure some params like this:
-
-```
----
-:global:
-:cases:
-- :tt_members: ...
-  :tt_moodle_id: User Moodle Identity
-```
-
-# 2. readme keyword
-
-We currently use the "teuton readme pry-folder" command to export README file from the challenge.
-
-* This example shows how to use readme keyword to add group description or target description:
-
-```
-group "GROUPNAME" do
-  readme "Description for this group"
-
-  target "target1"
-  readme "Description for this target"
-  goto :host, :exec => 'id root'
-  expec_one 'root'
-```
-
-# 3. Installation process
-
-* Use Bundler to install gems instead of rake.
-* It will be usefull use sysadming-game as gem? And install it with `gem install teuton`.
-* Vagrant: test how to use vagrant machines as case hosts.
-
-# 4. Info sobre novedades de la versión 2.1
-
-1. Teuton readme y dsl readme
-2. Macros de define macro
-3. Export yaml y html
-4. Teuton --no-color
-5. teuton run --case
-6. teuton run --cname
-7. teuton run --cpath
-8. actualizar formatos de salida
-9. instalación mediante gemas
-10. teuton panel
-11. teuton client y server
-12. nuevos nombres de comandos...
-13. cambio de goto a run

data/docs/changelog/v2.2.md

@@ -1,42 +0,0 @@
-[<< back](../CHANGELOG.md)
-
-# Teuton (version 2.2)
-
-## New features
-
-* Let's see new features examples:
-    * 10 result and moodle_id
-    * 11 get_vars
-    * 12 alias
-    * 13 include (tt_include config param)
-    * 14 macros
-
-**Configuration file**
-
-* Por defecto los valores de clave de los ficheros de configuración serán Strings en lugar de símbolos, aunque lo símbolos seguirán funcionando.
-
-**get_vars: To think - We are not sure about this***
-
-* "get" keyword simplification: Simplify getting and setting params process. For example: `_username_`, may be alias for `get(:username)`. Then
-
-```
-target "Create user #{_username_}"
-run "id #{_username_}"
-expect_one _username_
-```
-Same as
-
-```
-target "Create user "+get(:username)
-run "id " + get(:username)
-expect_one get(:username)
-```
-
-* Promocinar el proyecto:
-    * Documentar y hacer videos.
-    * Charlas y talleres
-
-## Fixed
-
-* Solucionar fallo en --cname
-* Revisar doc options como cpanel

data/docs/changelog/v2.3.md

@@ -1,10 +0,0 @@
-
-## [2.3.11]
-
-- Issue #18
-
-## [2.3.9]
-
-Bug fixed:
-- Remove warnings from linter
-- Remove warning about thor gem version. Upgrade gem to 1.2

data/docs/changelog/v2.4.md

@@ -1,41 +0,0 @@
-## [2.4.5]
-
--- FIX: "expect_nothing" was always TRUE when SSH/Telnet connections fails!
-   Now when SSH/Telnet connections fails result contains "SSH: NO CONNECTION!"
-   So "expect_nothing" will fail.
-
-## [2.4.4]
-
--- Modify: teuton check output colors and exit codes.
-   exit code 0 = check OK
-   exit code 1 = check error
--- Fix teuton check docs.
-
-## [2.4.3]
-
-- Fix: "expect_none" without params works as "expect result.count.eq 0"
-- Add: "expect_nothing" that works as "expect result.count.eq 0".
-
-## [2.4.2]
-
-- Fix bug with result.grep_v(Array)
-
-## [2.4.0]
-
-New features:
-- Hide feedback from reports: `export feedback: false`
-- Add new DSL keyword: expect_last, expect_fisrt
-- Remove os gem.
-- Change test output colors to green as use others test tools.
-- Change show DSL params. Accepts one param "verbose: NUMBER" to adjust verbosity output level on screen.
-
-New doc and example:
-- 14-alias
-- 16-exit_codes
-
-Bug fixed:
-- All "expect*" keywords must require 2 arguments. The second is optional.
-
-Revise
-- Remove colors to log text
-- teuton readme: macros, getvars, expect_last, expect_first

data/docs/changelog/v2.5.md

@@ -1,6 +0,0 @@
-
-## [2.5.0]
-
-- ADD: "tt_moodle_max_score" global configuration param. Teuton grades (0-100) are divided by this value when exporting data into "moodle.csv" output file.
-- UPDATE: Revise documentation. Doc learn 10,11, 12,13 y 14. 10 result and moodle_id, 12 alias, 13 include, 14 macro, Doc tt_include
-- UPDATE: Internal changes. Remove Colorize gem and replace with Rainbow.

data/docs/changelog/v2.6.md

@@ -1,4 +0,0 @@
-
-## [2.6.0]
-
-- [ADD] When running local or SSH commands, stdout and stderr are captured and readed by "expect" sentence.