teuton 3.0.2 → 3.1.0

data/docs/commands/config.md

@@ -6,7 +6,6 @@ _Help to create config file._
 
 Usage:
 * `teuton config DIRECTORY`
-* `teuton config --server DIRECTORY`
 
 ## Suggest config content
 
@@ -42,79 +41,3 @@ cases:
   host1_username: TOCHANGE
   host1_password: TOCHANGE
 ```
-
-## Init Config Server
-
-_Initialize Config Server, so students connect and help to build config file content._
-
-* Project files:
-```
-foo
-├── config.yaml
-└── start.rb
-```
-
-```yaml
-# File: foo/config.yaml
----
-global:
-cases:
-- tt_members: TOCHANGE
-  tt_moodle_id: TOCHANGE
-```
-
-* `teuton config --server foo`, init config server.
-```
---------------------------------------------------
-   ConfigServer URL: http://192.168.1.42:8080
-
-   Project path : foo
-   Global params (0)
-   Cases params (2)
-   * tt_members
-   * tt_moodle_id
---------------------------------------------------
-== Sinatra (v4.2.1) has taken the stage on 8080 for development with backup from Puma
-Puma starting in single mode...
-* Puma version: 7.1.0 ("Neon Witch")
-* Ruby version: ruby 3.2.8 (2025-03-26 revision 13f495dc2c) [x86_64-linux]
-*  Min threads: 0
-*  Max threads: 5
-*  Environment: development
-*          PID: 18938
-* Listening on http://0.0.0.0:8080
-Use Ctrl-C to stop
-```
-
-* Now students connect to host 192.168.1.42 and send their configuracion values.
-* Student host:
-
-![](images/config01.png)
-
-* Teacher host:
-
-![](images/config02.png)
-
-* When all students submit their data, the teacher presses CTRL-C to end the service
-* The received data is saved in separate files within the `config.d` subfolder
-* Project files:
-```
-foo
-├── config.d
-│   ├── from_127.0.0.1.yaml
-│   ├── from_192.168.1.14.yaml
-│   └── from_192.168.1.28.yaml
-├── config.yaml
-└── start.rb
-```
-
-* And now the main configuration file (config.yaml) has the following content:
-    * Global param `tt_include: config.d`. 
-    * No cases in main config file. Read case data from files into `config.d` subfolder.
-
-```yaml
----
-global:
-  tt_include: config.d
-cases: []
-```

data/docs/config_file.md

@@ -65,17 +65,18 @@ It is posible to add as many parameters as you need. But remember that parameter
 
 It is posible to add all the parameters you need into your configuration file, but some parameter names has special meaning. Reserved parameter names begin with prefix `tt_`.
 
-| Param name           | Section | Status       | Descripction |
-| -------------------- | ------- | ------------ | ------------ |
-| **tt_members**       | cases   | **Required** | Student name if it is an individual assignment or names of the members if it is a group assignment |
- **tt_moodle_id**      | cases   | Optional     | Student identifier on the Moodle platform. Example: student's Moodle email address |
-| **tt_moodle_max_score** | global | Optional   | Default value: 100. The grades generated by Teuton have values ​​between 0 and 100. But by changing this parameter to 10, for exmaple, the values are adjusted to between 0 and 10 before saving the grades into the moodle.csv file |
-| **tt_include**       | global  | Optional     | The contents of the files within the directory defined by the parameter are added to our main configuration file |
-| **tt_sequence**      | global  | Optional     | By default, all cases are evaluated in parallel unless sequential mode is enabled. Sequential mode is useful for debugging processes.|
-| **tt_source_ip**     | cases   | Auto         | Automatically filled in during remote setup. This value is completed when the student sends their configuration remotely.|
-| **tt_source_file**   | cases   | Auto         | Automatically filled in during the configuration loading. This value is populated when the configuration files from the folder defined by the tt_include parameter are read. |
-| **tt_skip**          |         | Optional     | False by default. To skip a case and not evaluate it, set the value to true. |
-| **tt_testname**      | global  | Optional     | Customize your test name |
+| Param name              | Section | Status       | Descripction |
+| ----------------------- | ------- | ------------ | ------------ |
+| **tt_members**          | cases   | **REQUIRED** | Student name if it is an individual assignment or names of the members if it is a group assignment |
+| **tt_moodle_id**        | cases   | Optional     | Student identifier on the Moodle platform. Example: student's Moodle email address |
+| **tt_include**          | global  | Optional     | The contents of the files within the directory defined by the parameter are added to our main configuration file |
+| **tt_moodle_max_score** | global  | Optional   | Default value: 100. The grades generated by Teuton have values ​​between 0 and 100. But by changing this parameter to 10, for exmaple, the values are adjusted to between 0 and 10 before saving the grades into the moodle.csv file |
+| **tt_output_dir**        | globsal | Optional    | Change default output directory (`var/TESNAME`)|
+| **tt_sequence**         | global  | Optional     | By default, all cases are evaluated in parallel unless sequential mode is enabled. Sequential mode is useful for debugging processes.|
+| **tt_testname**         | global  | Optional     | Change default test name |
+| **tt_source_ip**        | cases   | AUTO         | Automatically filled in during remote setup. This value is completed when the student sends their configuration remotely.|
+| **tt_source_file**      | cases   | AUTO         | Automatically filled in during the configuration loading. This value is populated when the configuration files from the folder defined by the tt_include parameter are read. |
+| **tt_skip**             |         | Optional     | False by default. To skip a case and not evaluate it, set the value to true. |
 
 ## Host properties
 
@@ -83,14 +84,14 @@ Parameters used to define the properties of each host must begin with an identif
 
 Lits of available host properties:
 
-| Param name      | Required | Default value | Description |
-| --------------- | -------- | ------------- | ----------- |
-| HOSTID_ip       | Yes      |               | IP address or hostname of the host identified by HOSTID |
-| HOSTID_username | No       |               | User account to access HOSTID |
-| HOSTID_password | No       |               | Password to access HOSTID |
-| HOSTID_protocol | No       | ssh           | Available options: ssh (default), telnet |
-| HOSTID_port     | No       | 22/23         | Default value: 22 (ssh), 23 (telnet) |
-| HOSTID_route    | No       |               | This option is used to configure a gateway to access HOSTID |
+| Param name      | Required | Default | Description |
+| --------------- | -------- | ------- | ----------- |
+| HOSTID_ip       | Yes      |         | IP address or hostname of the host identified by HOSTID |
+| HOSTID_username | No       |         | User account to access HOSTID |
+| HOSTID_password | No       |         | Password to access HOSTID |
+| HOSTID_protocol | No       | ssh     | Available options: ssh (default), telnet |
+| HOSTID_port     | No       | 22/23   | Default value: 22 (ssh), 23 (telnet) |
+| HOSTID_route    | No       |         | This option is used to configure a gateway to access HOSTID |
 
 We can create as many host configurations as different devices are required to complete the activity.
 

data/docs/learn/03-remote_hosts.md

@@ -21,10 +21,10 @@ cases:
 - tt_members: student_2
   host1_ip: 192.168.1.202
   host1_password: secret_2
+  tt_skip: true
 - tt_members: student_3
   host1_ip: 127.0.0.1
   host1_password: secret_3
-  tt_skip: true
 ```
 
 Every remote host defines its owns params:
@@ -73,7 +73,11 @@ CONN ERRORS
 
 ```
 
-Notice that case-03 is 100% and conection works. It is running on localhost because has localhost IP (127.0.0.1).
+Notice that:
+
+* `case-01` is 0% because remote host is unreachable.
+* `case-02` is 0% because `tt_skip: true` param.
+* `case-03` is 100% and conection works. It is running on localhost because has localhost IP (127.0.0.1).
 
 Results:
 
@@ -90,6 +94,11 @@ var/03-remote_hosts
 ## tt_skip param
 
 To disable a case, add skip param to config file. Example: `tt_skip: true`.
-* `tt_skip` it is false by default.
-* `tt_skip: false` ignore this case.
-* `tt_skip: true`, evaluate this case.
+
+* By default, `tt_skip: false`, so all cases are processed.
+* `tt_skip: false`
+    - defined in `case` section, ignore that case.
+    - defined in `global` section, ignore all cases by default.
+* `tt_skip: true`
+    - defined in `case` section, evaluate that case.
+    - defined in `global` section, evaluate all cases by default.

data/docs/learn/04-config.md

@@ -8,6 +8,7 @@ By default, `config.yaml` is our config file. Example:
 
 ```yaml
 global:
+  tt_output_dir: var/04-config/default
 cases:
 - tt_members: student_1
   username: david
@@ -15,7 +16,7 @@ cases:
   username: fran
 ```
 
-> **How to choose another config file?** Read this [document](../commands/run-test.md#3-choosing-config-file).
+> **How to choose another config file?** Read this [document](../commands/run.md#3-choosing-config-file).
 
 By default, `start.rb` it's our main execution file. Example:
 
@@ -47,7 +48,7 @@ CASE RESULTS
 Reports:
 
 ```
-var/04-config
+var/04-config/default
 ├── case-01.txt
 ├── case-02.txt
 ├── moodle.csv
@@ -57,57 +58,56 @@ var/04-config
 Let's see case 01 report.
 
 ```
-$ more var/04-config/case-01.txt
+$ more var/04-config/default/case-01.txt
 
 CONFIGURATION
-+-------------+------------+
-| tt_members  | student_1  |
-| tt_sequence | false      |
-| tt_skip     | false      |
-| tt_testname | 04-config  |
-| username    | david      |
-+-------------+------------+
++----------------+--------------------------------+
+| tt_config_path | examples/04-config/config.yaml |
+| tt_members     | student_1                      |
+| tt_output_dir  | var/04-config/default          |
+| tt_script_path | examples/04-config/start.rb    |
+| tt_sequence    | false                          |
+| tt_skip        | false                          |
+| username       | david                          |
++----------------+--------------------------------+
+
 
 GROUPS
 - Reading params from config file
     01 (1.0/1.0)
         Description : Create user david
         Command     : id david
-        Duration    : 0.002 (local)
-        Alterations : find(david) & count
-        Expected    : Greater than 0 (String)
-        Result      : 1 (Integer)
+        Output      : uid=1000(david) gid=1000(david) grupos=1000(david),478(wheel),...
+        Duration    : 0.005 (local)
+        Alterations : find(uid=) & find((david)) & find(gid=) & count
+        Expected    : Greater than 0
+        Result      : 1
 
 RESULTS
 +--------------+---------------------------+
-| case_id      | 01                        |
-| start_time   | 2023-01-25 20:46:13 +0000 |
-| finish_time  | 2023-01-25 20:46:13 +0000 |
-| duration     | 0.001778546               |
 | unique_fault | 0                         |
+| case_id      | 01                        |
+| start_time   | 2026-10-10 17:05:22 +0100 |
+| finish_time  | 2026-10-10 17:05:22 +0100 |
+| duration     | 0.005137538               |
 | max_weight   | 1.0                       |
 | good_weight  | 1.0                       |
-| fail_weight  | 0.0                       |
+| fail_weight  | 0                         |
 | fail_counter | 0                         |
 | grade        | 100                       |
-+--------------+---------------------------+```
++--------------+---------------------------+
 ```
 
 ## Using differents configuration files
 
-Example with 3 differents config files (yaml files):
+Execute the same test but using diferents config files. Config files available:
 
-```
-$ tree examples/04-config
+* config.yaml
+* rock.yaml
+* starwars.yaml
 
-examples/04-config
-├── config.yaml
-├── rock.yaml
-├── start.rb
-└── starwars.yaml
-```
+**Example 1**: Run test usign default config file (`config.yaml`). Output files saved in `tt_output_dir: var/04-config/defautl`.
 
-**Example 1**: Run test usign default config file (`config.yaml`).
 ```
 $ teuton run examples/04-config
 
@@ -119,7 +119,8 @@ CASE RESULTS
 +------+-----------+-------+-------+
 ```
 
-**Example 2**: Run test using `example/04-config/starwars.yaml` config file. 
+**Example 2**: Run test using `example/04-config/starwars.yaml` config file. Output files saved in `tt_output_dir: var/04-config/starwars`.
+
 ```
 $ teuton run --cname=starwars examples/04-config
 
@@ -131,7 +132,8 @@ CASE RESULTS
 +------+------------+-------+-------+
 ```
 
-**Example 3**: Run test using `example/04-config/rock.yaml` config file.
+**Example 3**: Run test using `example/04-config/rock.yaml` config file. Output files saved in `tt_output_dir: var/04-config/rock`.
+
 ```
 $ teuton run --cpath=examples/04-config/rock.yaml examples/04-config
 

data/docs/learn/05-use.md

@@ -60,3 +60,31 @@ group "Using file: network" do
   expect "www.google.es has address "
 end
 ```
+
+## `tt_testname` param
+
+The `tt_testname: 05-import_files` param changes the default test name.
+
+```yaml
+# File: config.yaml
+---
+global:
+  host1_username: root
+  tt_testname: '05-import_files'
+cases:
+...
+```
+
+So, output files are saved into `var/05-import_files` instead of `05-use`:
+
+```
+> tree var 
+
+var
+└── 05-import_files
+    ├── case-01.txt
+    ├── case-02.txt
+    ├── case-03.txt
+    ├── moodle.csv
+    └── resume.txt
+```

data/lib/teuton/case/case.rb

@@ -34,7 +34,7 @@ class Case
 
     # Define Case Report
     @report = Report.new(@id)
-    @report.output_dir = File.join("var", @config.global[:tt_testname])
+    @report.output_dir = Project.value[:output_dir]
 
     # Default configuration
     @skip = false
@@ -45,7 +45,7 @@ class Case
     end
     @verbose = Project.value[:verbose]
 
-    @tmpdir = File.join("var", @config.get(:tt_testname), "tmp", @id.to_s)
+    @tempdir = File.join(Project.value[:output_dir], "tmp", @id.to_s)
 
     @unique_values = {}
     @result = Result.new

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

@@ -52,14 +52,14 @@ module DSL
     name = input
     name = "teuton.tmp" if input == :default
 
-    @action[:tempfile] = File.join(@tmpdir, name)
+    @action[:tempfile] = File.join(@tempdir, name)
     @action[:remote_tempfile] = File.join(remote_tempdir, name)
 
     @action[:tempfile]
   end
 
   def tempdir
-    @tmpdir
+    @tempdir
   end
 
   def remote_tempfile

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

@@ -4,10 +4,10 @@ require_relative "../../utils/verbose"
 module DSL
   def upload(localfilter, args = {})
     abslocalfilter = if File.absolute_path? localfilter
-                       localfilter
-                     else
-                       File.join(Project.value[:project_path], localfilter)
-                     end
+      localfilter
+    else
+      File.join(Project.value[:project_path], localfilter)
+    end
 
     Dir.glob(abslocalfilter).each do |abslocalpath|
       upload_one(abslocalpath, args)
@@ -29,7 +29,7 @@ module DSL
           host.ip, host.username, password: host.password, port: host.port
         ) { |sftp| sftp.upload!(localpath, remotepath) }
         verbose(Rainbow(Settings.letter[:upload]).green)
-      rescue StandardError => e
+      rescue => e
         log("Upload #{localfile} to #{host.ip}:#{remotepath}", :warn)
         log(e.to_s, :warn)
         verbose(Rainbow("!").green)

data/lib/teuton/case_manager/export_manager.rb

@@ -24,9 +24,7 @@ class ExportManager
 
     # Step 1: Validate options
     options = strings2symbols(args)
-    if options[:format].nil?
-      options[:format] = Project.value[:format]
-    end
+    options[:format] = Project.value[:format] if options[:format].nil?
 
     unless Formatter.available_formats.include? options[:format]
       puts Rainbow("[WARN] ExportManager: Unkown format!").yellow.bright
@@ -74,7 +72,7 @@ class ExportManager
   def preserve_files
     srcdir = File.join(
       Project.value[:output_basedir],
-      Project.value[:test_name]
+      Project.value[:testname]
     )
 
     t = Time.now

data/lib/teuton/case_manager/ext/check_cases.rb

@@ -7,27 +7,23 @@ require_relative "../../utils/project"
 module CheckCasesExtension
   def check_cases!
     # Start checking every single case
-    app = Project.value
     # Load configurations from config file
     configdata = ConfigFileReader.call(Project.value[:config_path])
-    app[:ialias] = configdata[:alias]
-    app[:global] = configdata[:global]
-    app[:global][:tt_testname] = app[:global][:tt_testname] || app[:test_name]
-    app[:global][:tt_sequence] = false if app[:global][:tt_sequence].nil?
+    Project.add_config(configdata)
 
     # Create out dir
-    outdir = app[:global][:tt_outdir] || File.join("var", app[:global][:tt_testname])
-    FileUtils.mkdir_p(outdir) unless Dir.exist?(outdir)
-    @report.output_dir = outdir
+    output_dir = Project.value[:output_dir]
+    FileUtils.mkdir_p(output_dir) unless Dir.exist?(output_dir)
+    @report.output_dir = output_dir
 
     # Fill report head
-    open_main_report(app[:config_path])
+    open_main_report(Project.value[:config_path])
 
     # create cases and run
     configdata[:cases].each { |config| @cases << Case.new(config) }
     start_time = run_all_cases # run cases
 
-    # TODO: merge these 2 methdos
+    # TODO: merge these 2 methods
     # TODO: CloseManager.call ???
     uniques = collect_uniques_for_all_cases
     close_reports_for_all_cases(uniques)

data/lib/teuton/case_manager/ext/report.rb

@@ -1,6 +1,7 @@
 require "rainbow"
 require_relative "../../utils/project"
 require_relative "../../utils/settings"
+require_relative "../../version"
 
 module ReportExtension
   ##
@@ -42,7 +43,7 @@ module ReportExtension
         }
       else
         line[:skip] = false
-        line[:id] = format("%<id>02d", { id: c.id.to_i })
+        line[:id] = format("%<id>02d", {id: c.id.to_i})
         line[:letter] = Settings.letter[:cross] if c.grade.zero?
         line[:letter] = Settings.letter[:error] if c.grade < 50.0
         line[:letter] = Settings.letter[:ok] if c.grade.to_i == 100

data/lib/teuton/case_manager/send_manager.rb

@@ -3,7 +3,7 @@ require_relative "../utils/project"
 
 class SendManager
   def initialize
-    logpath = File.join(Project.value[:output_basedir], Project.value[:test_name], "send.log")
+    logpath = File.join(Project.value[:output_basedir], Project.value[:testname], "send.log")
     @logfile = File.open(logpath, "a")
   end
 

data/lib/teuton/case_manager/stats_manager.rb

@@ -2,7 +2,7 @@ require_relative "../utils/project"
 
 class StatsManager
   def initialize
-    filepath = File.join(Project.value[:output_basedir], Project.value[:test_name], "stats.txt")
+    filepath = File.join(Project.value[:output_basedir], Project.value[:testname], "stats.txt")
     @file = File.open(filepath, "w")
   end
 

data/lib/teuton/cli.rb

@@ -113,4 +113,8 @@ class CLI < Thor
     # Respond to missing methods name
     super
   end
+
+  def self.exit_on_failure?
+    true
+  end
 end

data/lib/teuton/readme/readme.rb

@@ -11,8 +11,7 @@ class Readme
   include DSL
   include ReadmeDSL
 
-  attr_reader :result
-  attr_reader :data
+  attr_reader :result, :data
 
   def initialize(script_path, config_path)
     @path = {}
@@ -66,7 +65,7 @@ class Readme
     puts format(Lang.get(:version), Teuton::VERSION)
     puts "```"
     puts "\n"
-    puts "# Test: #{Project.value[:test_name]}\n"
+    puts "# Test: #{Project.value[:testname]}\n"
 
     i = 1
     unless @required_hosts.empty?
@@ -83,11 +82,11 @@ class Readme
       puts "\n> NOTE: SSH Service installation is required on every host."
     end
 
-    unless @cases_params.empty?
-      @cases_params.sort!
-      puts Lang.get(:params)
-      @cases_params.uniq.each { |i| puts format("* %s", i) }
-    end
+    return if @cases_params.empty?
+
+    @cases_params.sort!
+    puts Lang.get(:params)
+    @cases_params.uniq.each { |i| puts format("* %s", i) }
   end
 
   def show_content
@@ -98,9 +97,7 @@ class Readme
       group[:readme].each { |line| puts "#{line}\n" }
       previous_host = nil
       group[:actions].each_with_index do |item, index|
-        if item[:host].nil? && index.positive?
-          item[:host] = group[:actions][0][:host]
-        end
+        item[:host] = group[:actions][0][:host] if item[:host].nil? && index.positive?
         if previous_host.nil? || item[:host] != previous_host
           previous_host = item[:host] || "null"
           puts format(Lang.get(:goto), previous_host.upcase)
@@ -127,12 +124,12 @@ class Readme
       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 |"
-      puts "| ----- |"
-      @setted_params.each_pair { |k, v| puts "|#{k}|" }
-    end
+    return unless @setted_params.size.positive?
+
+    puts Lang.get(:created_params)
+    puts "\n"
+    puts "| Param |"
+    puts "| ----- |"
+    @setted_params.each_pair { |k, v| puts "|#{k}|" }
   end
 end

data/lib/teuton/utils/config_file_reader.rb

@@ -93,7 +93,7 @@ module ConfigFileReader
       File.join(File.dirname(filepath), data[:global][:tt_include])
     end
     filepaths = Dir.glob(File.join(basedir, "**/*"))
-    filepaths.each { |filepath|
+    filepaths.each do |filepath|
       if File.directory?(filepath)
         next
       elsif is_yaml_file? filepath
@@ -104,15 +104,16 @@ module ConfigFileReader
         warn "[WARN] Ignore config file <#{filepath}>. No yaml or json extension!"
         next
       end
-    }
+    end
   end
 
   def self.read_included_yaml_file(filepath)
     begin
       data = YAML.load(File.open(filepath))
     rescue => e
-      warn "[ERROR] ConfigFileReader.read_included_yaml: #{e}"
-      warn "[ERROR] Loading configuration file! <#{filename}>"
+      warn "[ERROR] Reading configurations from yaml:"
+      warn "[ERROR] - File : #{filepath}"
+      warn "[ERROR] - Type : #{e}"
       exit 1
     end
     data[:tt_source_file] = relative_path(filepath)
@@ -123,8 +124,9 @@ module ConfigFileReader
     begin
       data = JSON.parse(File.read(filepath), symbolize_names: true)
     rescue => e
-      warn "[ERROR] ConfigFileReader.read_included_json: #{e}"
-      warn "[ERROR] Loading configuration file! <#{filename}>"
+      warn "[ERROR] Reading configurations from json:"
+      warn "[ERROR] - File : #{filepath}"
+      warn "[ERROR] - Type : #{e}"
       exit 1
     end
     data[:tt_source_file] = relative_path(filepath)