teuton 2.4.4 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d08e48b0ba8d25877e8e77346605089c59c56553f659d26c16e457907594c5dc
-  data.tar.gz: 030e7290d52ddef0087e9d5f4c391f259fc88bd0c20ec4b47500e9ffcf6be6f5
+  metadata.gz: 8f53359ed5f8eae1b3a798630c5d56ae46076073bface7d3788de57b245a80cb
+  data.tar.gz: 366afd9ccee6db9bdf5756fe5954050231681763489bab11b1841e9279998c08
 SHA512:
-  metadata.gz: ad340ebd02ca80be898aff768e523f0b8773da4b3c92181db61efbde24a55b67ca02ba243f7f1217d947c28ff8bb3ba552c867ff17ada2d2097de2cf07dd5701
-  data.tar.gz: 258e6510a41d0d5e1218e2f42db26c2857207db389158efa69fa0125a4593fbf85f2165b8f1a16f072da8830b44f6803863ba513f4635740583c9ba7ee56d38f
+  metadata.gz: a40866560ec0d622b48322c0689dfe36cb9820cf565ce4258a8b71d38a1a3cc88e57f68e208c0d2a6c1a0787b7a2698af0446757bb2167fdf04d2bcd8002178f
+  data.tar.gz: 288e6105576a15ac25eb20d298bb552b77347b65a3a2df6632d0ef26063061c77c32ef02af88a6f7244790df9573b6e79d7e9fee8b0606006a41b0cd171a51c5

data/README.md

@@ -3,21 +3,16 @@
 
 [![Gem Version](https://badge.fury.io/rb/teuton.svg)](https://badge.fury.io/rb/teuton)
 ![GitHub](https://img.shields.io/github/license/dvarrui/teuton)
-![Gem](https://img.shields.io/gem/dv/teuton/2.4.0)
 
 _Create Unit Test for your machines. Test your infrastructure as code._
 
 ![logo](./docs/images/logo.png)
 
-Teuton is an infrastructure test tool, useful for:
+Infrastructure test, useful for:
 * Sysadmin teachers who want to evaluate students remote machines.
 * Sysadmin apprentices who want to evaluate their learning process as a game.
 * Professional sysadmin who want to monitor remote machines.
 
-Teuton allow us:
-* Write unit tests for real or virtual devices, using simple DSL.
-* Check compliance with requirements on local or remote devices.
-
 # Installation
 
 Install Ruby and then:
@@ -40,18 +35,19 @@ CASE RESULTS
 | CASE | MEMBERS   | GRADE | STATE |
 | 01   | anonymous | 100.0 | ✔     |
 +------+-----------+-------+-------+
-
 ```
 
 # Features
 
-* [Free Software License](LICENSE).
+* Simple DSL to define your tests: `target`, `run`,`expect` and more.
+* Remote devices only require SSH or Telnet service installed.
+* Output format: txt, html, json, yaml, etc.
 * Multiplatform.
-* Remote machines/devices only require SSH or Telnet service installed.
+* [Free Software License](LICENSE).
 
 # Documentation
 
-* [Learn](docs/learn/README.md)
+* [Getting started](docs/learn/README.md)
 * [Language reference](docs/dsl/README.md)
 * [Commands](docs/commands/README.md)
 * [Installation](docs/install/README.md)

data/docs/changelog/todo.md

@@ -10,18 +10,9 @@ Revise:
 * verify get(:key) and get('key') works fine!
 * Formatter: xml,
 
-Revise documentation:
-* Doc learn 10,11, 12,13 y 14
-* 10 result and moodle_id
-* 12 alias
-* 13 include
-* 14 macro
-* Doc tt_include
-
 Internal changes:
 * Application to Settings
 * Laboratory to Checker
-* Colorize to Rainbow
 * Unify messages ERROR, INFO, WARN. etc
 * Create SendManager as ExportManager?
 * Add tt_label as alias of tt_members

data/docs/changelog/v2.4.md

@@ -1,3 +1,9 @@
+## [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.

data/docs/changelog/v2.5.md

@@ -0,0 +1,6 @@
+
+## [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/commands/example_check.md

@@ -51,11 +51,10 @@ Example:
 :global:
 :cases:
 - :tt_members: VALUE
-
-Check OK!
 ```
 
 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.
-* Syntax is OK!
+* exit_code 0 = Syntax ok.
+* exit code 1 = Syntax ERROR.

data/docs/install/README.md

@@ -1,8 +1,8 @@
 [<< back](../../README.md)
 
-# Installation process
+# Installation
 
-There are 2 types of nodes/hosts:
+There are 2 types of nodes/hosts, so there are 2 installations:
 
 | ID | Software | Description |
 | -- | -------- | ----------- |
@@ -20,6 +20,7 @@ Read [modes of use](modes_of_use.md) to know more about differents T-NODE/S-NODE
 |           | 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     |

data/docs/learn/14-moodle_id.md

@@ -8,7 +8,7 @@ Teuton generates a file called `moodle.csv` with the grades of each student into
 
 ## tt_moodle_id
 
-Add a new field called `tt_moodle_id` to each case in "config.yaml". Fill it with the student's identification (For example, the email registered on the Moodle, or ID number, etc.).
+Add a new field called `tt_moodle_id` to each case in "config.yaml". Fill it with the student's Moodle identification. For example, registered email on or ID number on Moodle platform.
 
 Example:
 
@@ -21,4 +21,22 @@ cases:
   tt_moodle_id: obiwan@starwars.com
 ```
 
-Now, when running test "moodle.csv" will be generated with all student grades.
+Now, when after test execution, use "moodle.csv" output file to load students grades and feedback into your Moodle platform.
+
+## tt_moodle_max_score
+
+By default, teuton evaluates grades from 0 to 100. So grade max score is 100.0 by default. Sometimes teachers configure their moodle tasks with diferents max score, so it is necesary adjust Teuton output grades with Moodle input grades.
+
+We use `tt_moodle_max_score` to customize Moodle max score. So when Teuton export `moodle.csv` values, divides Teuton grades by this value.
+
+Example:
+
+```
+global:
+  tt_moodle_max_score: 10
+cases:
+- tt_members: Darth Vader
+  tt_moodle_id: vader@starwars.com
+- tt_members: Obiwan Kenobi
+  tt_moodle_id: obiwan@starwars.com
+```

data/lib/teuton/application.rb

@@ -70,9 +70,9 @@ class Application
     Rainbow.enabled = @options["color"]
     @options["panel"] = false if @options["panel"].nil?
 
-    return if @options["case"].nil?
-
-    a = @options["case"].split(",")
-    @options["case"] = a.collect!(&:to_i)
+    unless @options["case"].nil?
+      numbers = @options["case"].split(",")
+      @options["case"] = numbers.collect!(&:to_i)
+    end
   end
 end

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

@@ -98,8 +98,13 @@ class Case
           non_interactive: true
         )
       end
-      if @sessions[hostname].instance_of? Net::SSH::Connection::Session
-        text = @sessions[hostname].exec!(@action[:command])
+      text = if @sessions[hostname].instance_of? Net::SSH::Connection::Session
+        @sessions[hostname].exec!(@action[:command])
+        # ssh.exec!("ls -l /home/jamis") do |channel, stream, data|
+        #   stdout << data if stream == :stdout
+        # end
+      else
+        "SSH: NO CONNECTION!"
       end
     rescue Errno::EHOSTUNREACH
       @sessions[hostname] = :nosession
@@ -148,10 +153,11 @@ class Case
         # "Prompt" => Regexp.new(username[1, 40]))
         # "Prompt" => /[$%#>] \z/n)
         h.login(username, password)
-        text = ""
         h.cmd(@action[:command]) { |i| text << i }
         h.close
         @sessions[hostname] = :ok
+      else
+        text = "TELNET: NO CONNECTION!"
       end
     rescue Net::OpenTimeout
       @sessions[hostname] = :nosession

data/lib/teuton/check/show.rb

@@ -16,7 +16,7 @@ class Laboratory
     revise_config_content
   end
 
-  def show_panelconfig
+  def show_onlyconfig
     @verbose = false
     process_content
     @verbose = true
@@ -69,9 +69,9 @@ class Laboratory
   end
 
   def recomended_config_content
-    verboseln Rainbow("[WARN] Configfile not found").bright.yellow
-    verboseln Rainbow("       #{@path[:config]}").white
-    verboseln Rainbow("[INFO] Recomended content:").bright.yellow
+    warn Rainbow("[WARN] Configfile not found").bright.yellow
+    warn Rainbow("       #{@path[:config]}").white
+    warn Rainbow("[INFO] Recomended content:").bright.yellow
     output = {global: nil, cases: []}
     output[:cases][0] = {}
     script_vars = find_script_vars
@@ -80,18 +80,14 @@ class Laboratory
   end
 
   def recomended_panelconfig_content
-    output = {global: {}, cases: nil}
+    output = {global: nil, cases: [{}]}
     script_vars = find_script_vars
-    script_vars.each { |i| output[:global][i] = "VALUE" }
+    # script_vars.each { |i| output[:global][i] = "VALUE" }
+    script_vars.each { |i| output[:cases][0][i] = "VALUE" }
     verboseln YAML.dump(output)
   end
 
   def revise_config_content
-    my_screen_table = Terminal::Table.new do |st|
-      st.add_row ["Revising CONFIG file"]
-    end
-    verboseln my_screen_table
-
     unless File.exist?(@path[:config])
       recomended_config_content
       return

data/lib/teuton/cli.rb

@@ -15,23 +15,22 @@ class CLI < Thor
   end
 
   map ["c", "-c", "--check"] => "check"
-  option :panelconfig, type: :boolean
+  option :onlyconfig, type: :boolean
+  option :color, type: :boolean
   option :cname, type: :string
   option :cpath, type: :string
   desc "check [OPTIONS] DIRECTORY", "Check test and config file content"
-  long_desc <<-LONGDESC
+  long_desc <<~LONGDESC
+
+    (1) teuton check PATH/TO/DIR , Check content of start.rb and config.yaml files.
 
-  (1) teuton check path/to/dir/foo
-  , Check content of start.rb and config.yaml files.
+    (2) teuton check PATH/TO/DIR --cname=demo , Check content of start.rb and demo.yaml files:
 
-  (2) teuton check path/to/dir/foo --cname=demo
-  , Check content of start.rb and demo.yaml files.
+    (3) teuton check PATH/TO/DIR --onlyconfig  , Only show config file recomendations
 
-  (3) teuton check path/to/file/foo.rb
-  , Check content of foo.rb and foo.yaml files.
+    (4) teuton check PATH/TO/DIR/foo.rb , Check content of foo.rb and foo.yaml files.
 
-  (4) teuton check path/to/file/foo.rb --cname=demo
-  , Check content of foo.rb and demo.yaml files.
+    (5) teuton check PATH/TO/DIR/foo.rb --cname=demo , Check content of foo.rb and demo.yaml files.
 
   LONGDESC
   def check(projectpath)

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

@@ -16,13 +16,18 @@ class MoodleCSVFormatter < ResumeArrayFormatter
   private
 
   def process_cases
+    max = @data[:config][:tt_moodle_max_score] || 100.0
+    grade_adjust = max.to_f / 100.0
     # MoodleID, Grade, Feedback
     w "MoodleID, TeutonGrade, TeutonFeedback\n"
     @data[:cases].each do |line|
       moodle_id = line[:moodle_id]
       moodle_id = line[:moodle_id].split(",") if moodle_id.instance_of? String
       moodle_id.each do |id|
-        w "#{id.strip},#{line[:grade]},#{line[:moodle_feedback]}\n" unless line[:skip]
+        unless line[:skip]
+          grade = line[:grade].to_f * grade_adjust
+          w "#{id.strip},#{grade},#{line[:moodle_feedback]}\n"
+        end
       end
     end
   end

data/lib/teuton/version.rb

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

data/lib/teuton.rb

@@ -27,13 +27,11 @@ module Teuton
 
     app = Application.instance
     lab = Laboratory.new(app.script_path, app.config_path)
-    if options[:panelconfig]
-      lab.show_panelconfig
+    if options[:onlyconfig]
+      lab.show_onlyconfig
     else
       lab.show
     end
-    puts Rainbow("Check OK!").green
-    exit 0
   end
 
   private_class_method def self.require_dsl_and_script(dslpath)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 2.4.4
+  version: 2.5.0
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-23 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -131,6 +131,7 @@ extra_rdoc_files:
 - docs/changelog/v2.2.md
 - docs/changelog/v2.3.md
 - docs/changelog/v2.4.md
+- docs/changelog/v2.5.md
 - docs/changelog/version2.1.md
 - docs/commands/README.md
 - docs/commands/example_check.md
@@ -197,6 +198,7 @@ files:
 - docs/changelog/v2.2.md
 - docs/changelog/v2.3.md
 - docs/changelog/v2.4.md
+- docs/changelog/v2.5.md
 - docs/changelog/version2.1.md
 - docs/commands/README.md
 - docs/commands/example_check.md