teuton 2.10.8 → 2.11.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 2.10.8
+  version: 2.11.0
 platform: ruby
 authors:
 - David Vargas Ruiz
@@ -124,8 +124,15 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 - docs/commands/README.md
-- docs/commands/check-example.md
-- docs/commands/run-tests.md
+- docs/commands/check.md
+- docs/commands/config.md
+- docs/commands/help.md
+- docs/commands/new.md
+- docs/commands/readme.md
+- docs/commands/run.md
+- docs/config_file.md
+- docs/devel/README.md
+- docs/devel/contributions.md
 - docs/devel/diagram.md
 - docs/dsl/README.md
 - docs/dsl/expect.md
@@ -139,18 +146,11 @@ extra_rdoc_files:
 - docs/dsl/set.md
 - docs/dsl/show.md
 - docs/dsl/target.md
+- docs/es/Challenge-Server-Project.md
 - docs/es/README.md
-- docs/es/aprender/01-cmd_new.md
-- docs/es/aprender/02-target.md
-- docs/es/aprender/README.md
 - docs/es/exit_code.md
 - docs/es/guess_os.md
-- docs/ideas/Challenge-Server-Project.md
-- docs/ideas/contributions.md
-- docs/ideas/servidor-de-retos.md
-- docs/ideas/todo.md
-- docs/install/README.md
-- docs/install/modes_of_use.md
+- docs/es/servidor-de-retos.md
 - docs/install/s-node.md
 - docs/install/t-node.md
 - docs/learn/01-cmd_new.md
@@ -182,14 +182,23 @@ extra_rdoc_files:
 - docs/learn/27-run_script.md
 - docs/learn/28-upload.md
 - docs/learn/README.md
+- docs/modes_of_use.md
+- docs/tutorial/es/nginx/README.md
 - docs/videos.md
 files:
 - LICENSE
 - README.md
 - bin/teuton
 - docs/commands/README.md
-- docs/commands/check-example.md
-- docs/commands/run-tests.md
+- docs/commands/check.md
+- docs/commands/config.md
+- docs/commands/help.md
+- docs/commands/new.md
+- docs/commands/readme.md
+- docs/commands/run.md
+- docs/config_file.md
+- docs/devel/README.md
+- docs/devel/contributions.md
 - docs/devel/diagram.md
 - docs/dsl/README.md
 - docs/dsl/expect.md
@@ -203,18 +212,11 @@ files:
 - docs/dsl/set.md
 - docs/dsl/show.md
 - docs/dsl/target.md
+- docs/es/Challenge-Server-Project.md
 - docs/es/README.md
-- docs/es/aprender/01-cmd_new.md
-- docs/es/aprender/02-target.md
-- docs/es/aprender/README.md
 - docs/es/exit_code.md
 - docs/es/guess_os.md
-- docs/ideas/Challenge-Server-Project.md
-- docs/ideas/contributions.md
-- docs/ideas/servidor-de-retos.md
-- docs/ideas/todo.md
-- docs/install/README.md
-- docs/install/modes_of_use.md
+- docs/es/servidor-de-retos.md
 - docs/install/s-node.md
 - docs/install/t-node.md
 - docs/learn/01-cmd_new.md
@@ -246,6 +248,8 @@ files:
 - docs/learn/27-run_script.md
 - docs/learn/28-upload.md
 - docs/learn/README.md
+- docs/modes_of_use.md
+- docs/tutorial/es/nginx/README.md
 - docs/videos.md
 - lib/teuton.rb
 - lib/teuton/case/builtin/main.rb
@@ -284,14 +288,14 @@ files:
 - 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
 - lib/teuton/case_manager/export_manager.rb
-- lib/teuton/case_manager/hall_of_fame.rb
-- lib/teuton/case_manager/report.rb
+- lib/teuton/case_manager/ext/check_cases.rb
+- lib/teuton/case_manager/ext/hall_of_fame.rb
+- lib/teuton/case_manager/ext/report.rb
 - lib/teuton/case_manager/send_manager.rb
-- lib/teuton/case_manager/show_report.rb
-- lib/teuton/case_manager/utils.rb
+- lib/teuton/case_manager/show_resume_report.rb
+- lib/teuton/case_manager/stats_manager.rb
 - lib/teuton/check/checker.rb
 - lib/teuton/check/dsl/all.rb
 - lib/teuton/check/dsl/builtin.rb
@@ -302,7 +306,7 @@ files:
 - lib/teuton/check/main.rb
 - lib/teuton/check/show.rb
 - lib/teuton/cli.rb
-- lib/teuton/files/README.md
+- lib/teuton/deprecated/utils.rb
 - lib/teuton/files/config.yaml
 - lib/teuton/files/start.rb
 - lib/teuton/files/template/case.html
@@ -332,10 +336,11 @@ files:
 - 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/xml.rb
 - lib/teuton/report/formatter/resume/yaml.rb
 - lib/teuton/report/report.rb
 - lib/teuton/skeleton.rb
-- lib/teuton/utils/configfile_reader.rb
+- lib/teuton/utils/config_file_reader.rb
 - lib/teuton/utils/logger.rb
 - lib/teuton/utils/name_file_finder.rb
 - lib/teuton/utils/project.rb

data/docs/commands/check-example.md

@@ -1,53 +0,0 @@
-[<< back](README.md)
-
-# Check Teuton Test
-
-| Param            | Description            | Default value |
-| ---------------- | ---------------------- | ------------- |
-| --no-panelconfig | Show check information | Enabled |
-| --panelconfig    | Only show config file recomended content | Disabled |
-| --cpath          | Specify path to config file | TEST-FOLDER/config.yaml |
-| --cname          | Specify name to config file | config.yaml |
-
-Usage: `teuton check PATH-TO-TEST-FOLDER`
-
-Example:
-
-```
-$ teuton check examples/02-target
-
-+----------------------------+
-| GROUP: Learn about targets |
-+----------------------------+
-(001) target      Create user obiwan
-      weight      2.0
-      run         'id obiwan' on localhost
-      expect      ["uid=", "(obiwan)", "gid="] (Array)
-
-(002) target      Delete user vader
-      weight      1.0
-      run         'id vader' on localhost
-      expect_fail
-
-+--------------+-------+
-| DSL Stats    | Count |
-+--------------+-------+
-| Groups       | 1     |
-| Targets      | 2     |
-| Runs         | 2     |
-|  * localhost | 2     |
-+--------------+-------+
-[WARN] Configfile not found
-       /home/.../examples/02-target/config.yaml
-[INFO] Recomended content:
----
-global:
-cases:
-- tt_members: VALUE
-```
-
-The check process notifies that
-* This test hasn't config file
-* and recommends content for our config file. But it isn't necessary for this example.
-* exit_code 0 = Syntax ok.
-* exit code 1 = Syntax ERROR.

data/docs/es/aprender/01-cmd_new.md

@@ -1,27 +0,0 @@
-
-[<< back](README.md)
-
-# Nuevo test
-
-Crear el esquelero para un nuevo proyecto: `teuton create foo`
-
-```
-> teuton new foo
-
-[INFO] Creating foo project skeleton
-* Create dir        => foo
-* Create file       => foo/config.yaml
-* Create file       => foo/start.rb
-```
-
-> NOTA: Lo ficheros se pueden crear manualmente.
-
-Este comando crea los siguientes ficheros:
-
-| Fichero/Directorio | Descripción      |
-| ------------------ | ---------------- |
-| foo                | Direcotrio base  |
-| foo/start.rb       | Script principal |
-| foo/config.yaml    | Fichero de configuración |
-
-Ahora es el momento de personalizar nuestros objetivos (targets).

data/docs/es/aprender/02-target.md

@@ -1,131 +0,0 @@
-[<< back](README.md)
-
-# target
-
-Un [target](../../dsl/target.md) es el objetivo que queremos evaluar. Los objetivos se definen dentro de una sección `group`.
-
-## Target definition
-
-Cada proceso de evaluación consta de 3 partes:
-
-* [target](../../dsl/target.md): Descripción del elemento que va a ser evaluado.
-* [run](../../dsl/run.md): Ejecutar el comando `id obiwan` en la máquina local.
-* [expect](../../dsl/expect.md): Verificar que el resultado del comando devuelve el valor esperado.
-
-```ruby
-group "Aprender sobre los targets" do
-
-  target "Existe el usuario <obiwan>"
-  run "id obiwan"
-  expect ["uid=", "(obiwan)", "gid="]
-
-  target "No existe el usuario <vader>"
-  run "id vader"
-  expect_fail
-end
-```
-
-> En este ejemplo estamo usando un SO GNU/Linux en la máquina local porque queremos ejecutar el comando `id obiwan`.
-
-Cuando el usuario existe, esperamos encontrar estas palabras en la salida del comando: `uid=, (obiwan), gid=`.
-
-```
-> id obiwan
-uid=1000(obiwan) gid=1000(obiwan) grupos=1000(obiwan)
-```
-
-Pero cuando el usuario no existe, se esperan una salida de error.
-
-```
-> id vader
-id: «vader»: no such user
-
-> echo $?
-1
-
-```
-
-## Section de ejecución
-
-Cuando se ejecuta el test, se procesa la sección `play`, la cual contiene las siguientes instrucciones:
-
-* [show](../../dsl/show.md): mostrar por pantalla información del proceso.
-* [export](../../dsl/export.md): generar informes de salida.
-
-```ruby
-play do
-  show
-  export
-end
-```
-
-## Ejemplo
-
-Usa este comando para ejecutar el test:
-
-```console
-> teuton run examples/02-target
-
-CASE RESULTS
-+------+-----------+-------+-------+
-| CASE | MEMBERS   | GRADE | STATE |
-| 01   | anonymous | 100.0 | ✔     |
-+------+-----------+-------+-------+
-```
-
-Los informes de salida se crean en la carpeta `var/02-target/`:
-
-```console
-var
-└── 02-target
-    ├── case-01.txt
-    ├── moodle.csv
-    └── resume.txt
-```
-
-Veamos el contenido:
-
-```
-> cat var/02-target/case-01.txt
-
-CONFIGURATION
-+-------------+-----------+
-| tt_members  | anonymous |
-| tt_sequence | false     |
-| tt_skip     | false     |
-| tt_testname | 02-target |
-+-------------+-----------+
-
-GROUPS
-- Learn about targets
-    01 (0.0/1.0)
-        Description : Create user obiwan
-        Command     : id obiwan
-        Output      : id: «obiwan»: no existe ese usuario
-        Duration    : 0.002 (local)
-        Alterations : find(uid=) & find((obiwan)) & find(gid=) & count
-        Expected    : Greater than 0
-        Result      : 0
-    02 (1.0/1.0)
-        Description : Delete user vader
-        Command     : id vader
-        Output      : id: «vader»: no existe ese usuario
-        Duration    : 0.002 (local)
-        Alterations : Read exit code
-        Expected    : Greater than 0
-        Result      : 1
-
-RESULTS
-+--------------+---------------------------+
-| case_id      | 01                        |
-| start_time   | 2023-06-16 08:42:13 +0100 |
-| finish_time  | 2023-06-16 08:42:13 +0100 |
-| duration     | 0.004527443               |
-| unique_fault | 0                         |
-| max_weight   | 2.0                       |
-| good_weight  | 1.0                       |
-| fail_weight  | 1.0                       |
-| fail_counter | 1                         |
-| grade        | 50                        |
-+--------------+---------------------------+
-```

data/docs/es/aprender/README.md

@@ -1,36 +0,0 @@
-[<< back](../README.md)
-
-# Aprender
-
-Aprender a escribir tus propios test:
-
-1. [Crear un NUEVO 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](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)
-1. [expect vs result](25-expect-result.md) TODO
-1. [EXPECT_SEQUENCE](26-expect_sequence.md)
-1. [RUN_SCRIPT](27-run_script.md)
-1. [UPLOAD](28-upload.md)
-
-Mores examples at [teuton-tests](https://github.com/dvarrui/teuton-tests) GitHub repository.

data/docs/ideas/todo.md

@@ -1,44 +0,0 @@
-
-# TODO list
-
-## Add
-
-* Option roadmap_ok_only. When expect returns false... test stop. The rest of targets are forced to fails.
-* `expect_equal "camaleon"`, same as `expect result.equal "camaleon"`.
-* **FEATURE** Define a loop of executions of our activity. For example:
-  every 5 minutes, run the activity, and repeat this 10 times.
-  `start :times=>10, :every=>5 do`
-* Script to set **static IP**
-* Change export to show **command output** into reports.   
-* **TEST**: actualizar las pruebas con vagrant para la versión actual. Mejora de la calidad del código.
-* **DOCS** PROMOCIONAR.  Documentar y hacer videos. Tener foros de la comunidad o presencia en reddit o stackoverflow.... o algo parecido???
-* Create 2 evaluation modes:
-    1. Evaluate targets (current mode): `start eval: :targets`
-    1. Evaluate task: `start eval: :groups` and perhaps add group weight?
-    1. config file with `tt_eval: groups`
-
-Improve RESUME report or create stat-report, with stat information:
-* the worst target/task/case,
-* the best target/task/case,
-* the slowest target/task/case,
-* the fastest target/task/case, etc.
-* Related targets: group of targets that always have the same state in every case.
-
-## Ideas
-
-Esta es una lista de ideas para que no se me olvide... lo podemos ir ajustando 😊
-
-1. TEST-EN-CADENA (smart-shell): es un proyecto en curso que trabajará en colaboración ceon teuton. Detecta las acciones del usuario dentro de la shell y automáticamente lanza el test para validar el cumplimiento de los objetivos. Si se supera un % se pasa al siguiente test.
-2. SERVIDOR TEUTON: Teuton web para recibir peticiones de los clientes... ?! Enganchar con teuton-server y teuton-client. NO. quizás mejor enfoque. Tener un servidor dedicado con una página Web para lanzar test desde el propio servidor.
-3. Editor de ficheros de configuración.... una especie de asistente de ayuda.. no le veo mucho sentido tener un editor específico pero si al ejecutar un reto si hay valores con NODATA... entonces que pregunte al usuario y complete la
-configuración sobre la marcha???
-4. Editor de tests ?! .... lo veo complejo... a menos que se empiece por una versión simplificada.. El DSL es tan sencillo que no le veo sentido a un editor de retos. Pero si podemos aprovechar y crear una" librería " de los módulos más frecuentes?!... una ayuda para facilitar la creación de test... esto se puede emparejar con el editor de test...
-5. `send :email_to => :members_emails`... esto requiere que cada caso tenga un email y que además el profesor tenga configurado el acceso a su cuenta de correo... para poder enviar copias de los informes....
-6. When students demand help they could recibe some advises. More ideas: bonus, lives, etc.
-7. save partial grades. Before play challenge read previous moodle.cvs. Then play challenge and when creates new moodle.csv... we could preseve old cases(grades) 100% for example.
-
-# Propuestas de sdelquin
-
-- Docker en vez de vagrant?? → https://www.cloudbees.com/blog/ssh-into-a-docker-container-how-to-execute-your-commands
-- Tablas "bonitas" en terminal → https://github.com/piotrmurach/tty-markdown#17-table
-- Documentación en https://readthedocs.org/ ??

data/docs/install/README.md

@@ -1,38 +0,0 @@
-[<< back](../../README.md)
-
-# Installation
-
-**Teuton installation**
-
-We call a device with Teuton installed as t-node. [T-NODE](t-node.md) host monitors one or severals S-NODE hosts.
-1. Install Ruby on your system.
-2. `gem install teuton`
-
-> If you are using ed25519 for the SSH server, then you may need:
-> * `gem install ed25519 -v 1.2`
-> * `gem install bcrypt_pbkdf -v 1.0`
-> This gems requires install `ruby-devel` OS package.
-
-**SSH server installation**
-
-We call e device with SSH/Telnet service as s-node. [S-NODE](s-node.md) hosts are monitorized by T-NODE host.
-1. Install SSH service.
-
-Read [modes of use](modes_of_use.md) to know more about differents T-NODE/S-NODE schemes.
-
-## Tested OS list
-
-| Type      | O.S.      | Version        | Arch   | T-node | S-node |
-| --------- | --------- | -------------- | ------ | ------ | ------ |
-| GNU/Linux | CentOS    | 7              | x86-64 |        |        |
-|           | Debian    | 9.7.0          | x86-64 | Ok     |        |
-|           | Fedora    | Workstation 29 | x84-64 | Ok     |        |
-|           | LinuxMint | 18.3           | x86-64 | Ok     |        |
-|           | openSUSE  | Leap 15        | x86-64 | Ok     | Ok     |
-|           | openSUSE  | Tumbleweed     | x86-64 | Ok     | Ok     |
-|           | Ubuntu    | 18.04          | x86-64 | Ok     | Ok     |
-| Microsoft | Windows   | 7 Enterprise   | x86    | Ok     |        |
-|           | Windows   | 10 Pro         | x86-64 | Ok     | Ok     |
-|           | Windows   | Server 2012 R2 | x86-64 |        |        |
-| Apple     | Mac OS X  | Capitán (10.11.6) | x86-64 | Ok  | Ok     |
-|           | Mac OS X  | Sierra (10.12)    | x86-64 | Ok  |        |

data/lib/teuton/case_manager/hall_of_fame.rb

@@ -1,29 +0,0 @@
-require_relative "../utils/project"
-
-class CaseManager
-  class HallOfFame
-    def initialize(cases)
-      @cases = cases
-    end
-
-    def call
-      celebrities = {}
-
-      @cases.each do |acase|
-        next if acase.skip
-
-        grade = acase.grade
-        label = if celebrities[grade]
-          celebrities[grade] + "*"
-        else
-          "*"
-        end
-        celebrities[grade] = label
-      end
-
-      Project.value[:options][:case_number] = @cases.size
-      ordered_list = celebrities.sort_by { |key, _value| key }
-      Project.value[:hall_of_fame] = ordered_list.reverse
-    end
-  end
-end

data/lib/teuton/files/README.md

@@ -1,9 +0,0 @@
-
-# README.md file
-
-Build your README.md file automaticaly from challenges internal data.
-
-Use:
-```
-teuton readme PROJECT_DIR > PROJECT_DIR/README.md
-```

data/lib/teuton/utils/configfile_reader.rb

@@ -1,135 +0,0 @@
-# require "json/pure"
-require "json"
-require "yaml"
-
-##
-# Functions that read data from ConfigFile using YAML or JSON formats
-module ConfigFileReader
-  ##
-  # Read config file
-  # @param filepath (String) Path to config file
-  # @return Hash with config data
-  def self.read(filepath)
-    unless File.exist?(filepath)
-      data = {}
-      data[:global] = {}
-      data[:alias] = {}
-      data[:cases] = [{tt_members: "anonymous"}]
-      return data
-    end
-    return read_yaml(filepath) if File.extname(filepath) == ".yaml"
-
-    return read_json(filepath) if File.extname(filepath) == ".json"
-
-    raise "[ERROR] ConfigFileReader: #{filepath}"
-  end
-
-  ##
-  # Read YAML config file
-  # @param filepath (String) Path to YAML config file
-  # @return Hash with config data
-  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
-      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[:global] = data[:global] || {}
-    data[:alias] = data[:alias] || {}
-    data[:cases] = data[:cases] || []
-    read_included_files!(filepath, data)
-    data
-  end
-
-  ##
-  # Read JSON config file
-  # @param filepath (String) Path to JSON config file
-  # @return Hash with config data
-  def self.read_json(filepath)
-    data = JSON.parse(File.read(filepath), symbolize_names: true)
-    data = convert_string_keys_to_symbol(data)
-    data[:global] = data[:global] || {}
-    data[:alias] = data[:alias] || {}
-    data[:cases] = data[:cases] || []
-    read_included_files!(filepath, data)
-    data
-  end
-
-  ##
-  # Read all configuration files from "filepath" folder.
-  # @param filepath (String) Folder with config files
-  # @param data (Hash) Input configuration
-  private_class_method def self.read_included_files!(filepath, data)
-    return if data[:global][:tt_include].nil?
-
-    include_dir = data[:global][:tt_include]
-    basedir = if include_dir == File.absolute_path(include_dir)
-      include_dir
-    else
-      File.join(File.dirname(filepath), data[:global][:tt_include])
-    end
-    exts = {
-      yaml: ['.yaml', '.YAML', '.yml', '.YML'],
-      json: ['.json', '.JSON']
-      }
-    files = Dir.glob(File.join(basedir, "**/*"))
-    files.each { |filename|
-      begin
-        ext = File.extname(filename)
-        if exts[:yaml].include? ext
-          begin
-            data[:cases] << YAML.load(File.open(filename))
-          rescue
-            msg = "[ERROR] Loading configuration file(#{filename})"
-            warn msg
-          end
-        elsif exts[:json].include? ext
-          begin
-            data[:cases] = JSON.parse(File.read(filename), symbolize_names: true)
-          rescue
-            msg = "[ERROR] Loading configuration file(#{filename})"
-            warn msg
-          end
-        elsif File.file? filename
-          msg = "[ERROR] Loading configuration files: " \
-              " No yaml/json valid extension " \
-              " (#{file})"
-          warn msg
-        end
-      rescue => e
-        puts "\n" + ("=" * 80)
-        puts "[ERROR] ConfigFileReader#read <#{file}>"
-        puts "        I suggest to revise file format!"
-        puts "        #{e.message}\n" + ("=" * 80)
-      end
-    }
-  end
-
-  private_class_method def self.convert_string_keys_to_symbol(input)
-    return input if input.class != Hash
-
-    output = {}
-    input.each_pair do |key, value|
-      key2 = key
-      key2 = key.to_sym if key.class
-      value2 = value
-      if value.instance_of? Hash
-        value2 = convert_string_keys_to_symbol(value)
-      elsif value.instance_of? Array
-        value2 = []
-        value.each { |i| value2 << convert_string_keys_to_symbol(i) }
-      end
-      output[key2] = value2
-    end
-    output
-  end
-end