teuton 2.4.3 → 2.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4737382a68bd95498f1fcfe7fab7dd674170ac21e56aeea7761cea9c7edb2c58
-  data.tar.gz: 00bbd221c4251ad369a3829eb67d32fce2d05c15a9af764f76874031bc26dc0f
+  metadata.gz: 23e6309b8f112199998d8afd4517a06ec5b80ec4d68421ef67ef87b3c63684ef
+  data.tar.gz: b0c17aefadc82be10bc1c52de45fdaa65f070046bc30bad7a0416803c62c5daf
 SHA512:
-  metadata.gz: bc557091ed6ae131bf925a0da452b34e01a64ee95ffa1cdc52f17742920614c8126ba66e5c2bd830f901dd3acbb8cc644be604ae267eddd60b3937915d3f3b83
-  data.tar.gz: 9cd807f54792d0cf64d53a5ff82d03ca8e7e3eaf49338d511948defeaa802731ee1c8cb96ec07192d2c415c8ef113ddd180a3ed60a0bf0421ba12d314b12b601
+  metadata.gz: dc3e324bb363b77302758a8210e02a6258d94e99c0797806c2e2f02894a970a6ca6977984abcc7cd647982c9752b7e5799c762684ca14131d06a1260ecb49eab
+  data.tar.gz: b0bed729989027e9916b214b7421f88a172ef522197d1a5f589c2a5424f54688d5ea3695a3cded4410f2a68d63d5ef1687374b740b90ce91450558f03a1bcc37

data/README.md

@@ -5,11 +5,11 @@
 ![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 infraestructure as code._
+_Create Unit Test for your machines. Test your infrastructure as code._
 
 ![logo](./docs/images/logo.png)
 
-Teuton is an intrastructure test tool, useful for:
+Teuton is an infrastructure test tool, 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.

data/docs/changelog/v2.4.md

@@ -1,3 +1,15 @@
+## [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]
 

data/docs/commands/example_check.md

@@ -2,18 +2,23 @@
 
 # Check Teuton Test
 
-Objective: Revise Teuton test located into `example\01-target`.
+| 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 examples/01-target
+teuton check PATH-TO-TEST-FOLDER
 ```
 
 Example:
 
 ```bash
-❯ teuton check examples/01-target
+❯ teuton check examples/02-target
 
 +----------------------------+
 | GROUP: Learn about targets |
@@ -28,7 +33,7 @@ Example:
 +--------------+-------+
 | Groups       | 1     |
 | Targets      | 1     |
-| Goto         | 1     |
+| Runs         | 1     |
 |  * localhost | 1     |
 | Uniques      | 0     |
 | Logs         | 0     |
@@ -39,12 +44,18 @@ Example:
 +----------------------+
 | Revising CONFIG file |
 +----------------------+
-[WARN] File .../examples/01-target/config.yaml not found!
+[WARN] Configfile not found
+       /home/david/proy/repos/teuton.d/teuton/examples/02-target/config.yaml
 [INFO] Recomended content:
 ---
 :global:
 :cases:
 - :tt_members: VALUE
+
+Check OK!
 ```
 
-> The check process notifies that this Test Unit hasn't config file, and Teuton recommends content for config file. But it isn't necessary for this example.
+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!

data/docs/dsl/expect.md

@@ -25,7 +25,9 @@ expect 'obiwan' # Expect previous run command output contains obiwan text
 | expect_one "rogue" | only one line with "rogue" |
 | expect_one ["obiwan","kenobi"] | only one line with "obiwan" and "kenobi" |
 | expect_none "vader"| no line with "vader" |
-| expect_none ["darth", "vader"] | no line with "darth" and "vader" |
+| expect_none ["darth", "vader"] | no line with "darth" or "vader" |
+| expect_none | no output lines expected |
+| expect_nothing | no output lines expected |
 | expect /Obiwan\|obi-wan/ | one or more line/s with Obiwan or obi-wan. This example uses regular expresions. |
 
 ## Advanced

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

@@ -98,8 +98,10 @@ 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])
+      else
+        "SSH: NO CONNECTION!"
       end
     rescue Errno::EHOSTUNREACH
       @sessions[hostname] = :nosession
@@ -148,10 +150,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

@@ -69,15 +69,14 @@ class Laboratory
   end
 
   def recomended_config_content
-    verbose Rainbow("[WARN] File ").yellow
-    verbose Rainbow(@path[:config]).yellow.bright
-    verboseln Rainbow(" not found!").yellow
-    verboseln "[INFO] Recomended content:"
+    verboseln Rainbow("[WARN] Configfile not found").bright.yellow
+    verboseln Rainbow("       #{@path[:config]}").white
+    verboseln Rainbow("[INFO] Recomended content:").bright.yellow
     output = {global: nil, cases: []}
     output[:cases][0] = {}
     script_vars = find_script_vars
     script_vars.each { |i| output[:cases][0][i] = "VALUE" }
-    verboseln YAML.dump(output)
+    verboseln Rainbow(YAML.dump(output)).white
   end
 
   def recomended_panelconfig_content

data/lib/teuton/cli.rb

@@ -19,19 +19,17 @@ class CLI < Thor
   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 --panelconfig  , 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/utils/configfile_reader.rb

@@ -31,11 +31,11 @@ module ConfigFileReader
     begin
       data = YAML.load(File.open(filepath))
     rescue => e
-      puts "\n" + ("=" * 80)
-      puts "[ERROR] ConfigFileReader#read <#{filepath}>"
-      puts "        I suggest to revise file format!"
-      puts "        #{e.message}\n" + ("=" * 80)
-      raise "[ERROR] ConfigFileReader <#{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)
+      exit 1
     end
     data = convert_string_keys_to_symbol(data)
     data[:global] = data[:global] || {}

data/lib/teuton/utils/name_file_finder.rb

@@ -27,9 +27,7 @@ module NameFileFinder
     # COMPLEX MODE: We use start.rb as main RB file
     script_path = File.join(folder_path, "start.rb")
     unless File.exist? script_path
-      print Rainbow("[ERROR] File ").red
-      print Rainbow(script_path).bright.red
-      puts Rainbow(" not found!").red
+      warn Rainbow("[ERROR] File not found: #{script_path}").bright.red
       exit 1
     end
 
@@ -68,9 +66,8 @@ module NameFileFinder
     # SIMPLE MODE: We use script_path as main RB file
     # This must be fullpath to DSL script file
     if File.extname(script_path) != ".rb"
-      print Rainbow("[ERROR] Script ").red
-      print Rainbow(script_path).bright.red
-      puts Rainbow(" must have rb extension").red
+      warn Rainbow("[ERROR] .rb extension required!").bright.red
+      warn Rainbow("        #{script_path}").white
       exit 1
     end
 

data/lib/teuton/version.rb

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

data/lib/teuton.rb

@@ -27,8 +27,13 @@ module Teuton
 
     app = Application.instance
     lab = Laboratory.new(app.script_path, app.config_path)
-    lab.show unless options[:panelconfig]
-    lab.show_panelconfig if options[:panelconfig]
+    if options[:panelconfig]
+      lab.show_panelconfig
+    else
+      lab.show
+    end
+    puts Rainbow("Check OK!").green
+    exit 0
   end
 
   private_class_method def self.require_dsl_and_script(dslpath)
@@ -36,10 +41,11 @@ module Teuton
     require_relative dslpath
     begin
       require_relative app.script_path
-    rescue SyntaxError => e
-      puts e.to_s
-      puts Rainbow.new("[FAIL ] Reading file #{app.script_path}").red
-      puts Rainbow.new("[ERROR] Syntax Error!").red
+    rescue
+      warn e.to_s
+      warn Rainbow.new("[FAIL ] Reading file #{app.script_path}").red
+      warn Rainbow.new("[ERROR] Syntax Error!").red
+      exit 1
     end
   end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 2.4.3
+  version: 2.4.5
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-17 00:00:00.000000000 Z
+date: 2023-02-24 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: colorize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement