teuton 2.3.5 → 2.3.7

data/docs/learn/12-get_vars.md

@@ -0,0 +1,37 @@
+[<< back](README.md)
+
+# Example: 12-get_vars
+
+To read the variables from the configuration file we already have the `get` statement. Example, to read `dirname` we do `get(:dirname)`.
+
+**Example 1:** Using `get` to read vars.
+
+```ruby
+  # "get(:dirname)" reads dirname var from config file
+  target "Exist #{get(:dirname)} directory"
+  run "file #{get(:dirname)}"
+  expect_none "No such file or directory"
+```
+
+Since the "get" instruction is frequently used, It is good to have a fast path. Let's see another shorter way to read variables using the "_" operator.
+
+**Example 2:** Using `_` to read vars.
+
+```ruby
+  # "_dirname" is equivalet to "get(:dirname)"
+  target "Exist #{_dirname} directory"
+  run "file #{_dirname}"
+  expect_none "No such file or directory"
+```
+
+The Teuton language is a DSL built on top of the Ruby programming language, so we can also use variables like any programming language.
+
+**Example 3:** Using variables.
+
+```ruby
+  # "dirname" is a variable
+  dirname = get(:dirname)
+  target "Exist #{dirname} directory"
+  run "file #{dirname}"
+  expect_none "No such file or directory"
+```

data/docs/learn/13-include.md

@@ -0,0 +1,59 @@
+[<< back](README.md)
+
+# Example: 13-include
+
+Until now, all the tests we have seen came with a configuration file (`config.yaml`) that contained all the parameters that will later be used in the test. It is also possible to have the information distributed among several configuration files.
+
+Suppose we have the following file structure.
+
+```
+├── config.yaml
+├── include_this_files
+│   ├── 02
+│   │   └── file02.yaml
+│   ├── file01.yaml
+│   └── file03.yml
+└── start.rb
+```
+
+`config.yaml` will be the main config file. Using `tt_include` parameter, we define a folder where the rest of the configuration files will be.
+
+In this example the contents of the files in the include_this_files folder will be included in the configuration:
+
+```yaml
+---
+# Fiel: config.yaml
+:global:
+  :tt_include: include_this_files
+:cases:
+```
+
+If we execute the test we will see that 3 cases are processed. Which are defined in the files `file01.yaml`, `02/file02.yaml` and `file03.yml`.
+
+
+```
+CASE RESULTS
++------+---------+-------+-------+
+| CASE | MEMBERS | GRADE | STATE |
+| 01   | file02  | 0.0   | ?     |
+| 02   | file01  | 100.0 | ✔     |
+| 03   | file03  | 0.0   | ?     |
++------+---------+-------+-------+
+```
+
+Config files into `include_this_files` folder:
+
+```yaml
+:tt_members: file01
+:username: root
+```
+
+```yaml
+:tt_members: file02
+:username: quigon
+```
+
+```yaml
+:tt_members: file03
+:username: vader
+```

data/docs/learn/16-exit_codes.md

@@ -0,0 +1,24 @@
+[<< back](README.md)
+
+# Example: 16-exit_codes
+
+_I am sorry! We have not solved the problem of getting the exit code of the commands so that it works for any platform. But we can help you do this work._
+
+`result` stores information from the last command executed by a "run" action. [Offers many functions](../dsl/definition/result.md)) that transforms output data, but also we have been added tow more: first and last.
+
+## Description
+
+Take a look at this section:
+```ruby
+  target "Exist user root"
+  run "id root;echo $?"
+  expect_last "0"
+```
+
+It is posible to invoke the execution of several commands in sequence "cmd1;cmd2". Keep in mind that the last one must show the exit code. In the case of GNU/Linux is "echo $?", but it is different on others OOSS.
+
+All terminal output generated by `run` action is captured (Use `result.debug` to show result content into screen), and as we need only the last line, we use `expect_last "0"`.
+
+> More information about:
+> * [expect](../dsl/definition/expect.md) keyword.
+> * [result](../dsl/execution/result.md) keyword.

data/docs/learn/README.md

@@ -8,28 +8,30 @@
 # Learning
 
 Learn how to use Teuton language to write your own tests:
-- [Example 01 - Target](example-01-target.md)
-- [Example 02 - Config file](example-02-config.md)
-- [Example 03 - Remote hosts](example-03-remote-hosts.md)
-- [Example 04 - Create new test](example-04-new-test.md)
-- [Example 05 - Use](example-05-use.md)
-- [Example 06 - Debug](example-06-debug.md)
-- [Example 07 - Log](example-07-log.md)
-- [Example 08 - Readme](example-08-readme.md)
-- [Example 09 - Preserve](example-09-preserve.md)
-- Example 10 - Result and Moodle
-- Example 11 - Get vars
-- Example 12 - Include
-- Example 13 - Alias
-- Example 14 - Macros
+- [01 - Target](01-target.md)
+- [02 - Config file](02-config.md)
+- [03 - Remote hosts](03-remote_hosts.md)
+- [04 - Create new test](04-new_test.md)
+- [05 - Use](05-use.md)
+- [06 - Debug](06-debug.md)
+- [07 - Log](07-log.md)
+- [08 - Readme](08-readme.md)
+- [09 - Preserve](09-preserve.md)
+- [10 - Result object](10-result.md)
+- [11 - Moodle ID](11-moodle_id.md)
+- [12 - Get vars](12-get_vars.md)
+- [13 - Include](13-include.md)
+- Example 14 - Alias
+- Example 15 - Macros
+- [Example 16 - Exit codes](16-exit_codes.md)
 - [Videos](videos.md)
 
 # Examples
 
 More examples
-* Let's see examples at [teuton-challenges](https://github.com/teuton-software/teuton-challenges) GitHub repository.
+* Let's see examples at [teuton-tests](https://github.com/dvarrui/teuton-tests) GitHub repository.
 * Ask us by email at `teuton.software@protonmail.com` or Twitter at `@SoftwareTeuton`.
-* [CHAPI19 - Spanish Teuton demo](https://github.com/dvarrui/proyectos-de-ejemplo/tree/master/charlas/teuton)
+* [ES - CHAPI19: Teuton demo](https://github.com/dvarrui/proyectos-de-ejemplo/tree/master/charlas/teuton)
 
 # Videos
 
@@ -37,7 +39,7 @@ By now there are no English videos. We are sorry!
 But if you want to see Spanish videos, here you are:
 
 Teuton (v2.0):
-* [CHAPI19 - Charla Teuton](https://youtu.be/KFWQDfNAFxI?t=12221)
+* [ES - CHAPI19: Charla Teuton](https://youtu.be/KFWQDfNAFxI?t=12221)
 
 Sysadmingame (Teuton v1.0)
 * [Sysadmingame (1 de 3): Instalación del programa](https://youtu.be/dnyMq9_KDco)

data/lib/teuton/application.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-require 'singleton'
-require_relative 'version'
-require_relative 'utils/name_file_finder'
+require "singleton"
+require_relative "version"
+require_relative "utils/name_file_finder"
 
 # This Singleton contains application params
 class Application
   include Singleton
   include Teuton
 
-  attr_reader   :letter
-  attr_reader   :running_basedir, :output_basedir
-  attr_reader   :default
+  attr_reader :letter
+  attr_reader :running_basedir, :output_basedir
+  attr_reader :default
   attr_accessor :options
   attr_accessor :verbose
   attr_accessor :global # Global configuration params
@@ -27,11 +27,18 @@ class Application
   end
 
   def reset
-    @letter = { good: '.', bad: 'F', error: '?', none: ' ' }
+    @letter = {
+      good: ".",
+      bad: "F",
+      error: "?",
+      none: " ",
+      ok: "\u{2714}",
+      cross: "\u{2716}"
+    }
     @running_basedir = Dir.getwd
-    @output_basedir = 'var'
-    @default = { name: 'teuton', format: :txt, debug: false }
-    @options = { 'lang' => 'en' }
+    @output_basedir = "var"
+    @default = {name: "teuton", format: :txt, debug: false}
+    @options = {"lang" => "en"}
     @verbose = true
 
     @global = {}
@@ -51,7 +58,7 @@ class Application
   end
 
   def quiet?
-    return true if Application.instance.options['quiet']
+    return true if Application.instance.options["quiet"]
     return true unless Application.instance.verbose
 
     false
@@ -64,13 +71,13 @@ class Application
   def add_input_params(projectpath, options)
     @options.merge! options
     NameFileFinder.find_filenames_for(projectpath)
-    @options['color'] = true if @options['color'].nil?
-    Rainbow.enabled = @options['color']
-    @options['panel'] = false if @options['panel'].nil?
+    @options["color"] = true if @options["color"].nil?
+    Rainbow.enabled = @options["color"]
+    @options["panel"] = false if @options["panel"].nil?
 
-    return if @options['case'].nil?
+    return if @options["case"].nil?
 
-    a = @options['case'].split(',')
-    @options['case'] = a.collect!(&:to_i)
+    a = @options["case"].split(",")
+    @options["case"] = a.collect!(&:to_i)
   end
 end

data/lib/teuton/case_manager/case/builtin/main.rb

@@ -1,8 +1,7 @@
-
-require_relative 'teuton_host'
+require_relative "teuton_host"
 
 class Case
-  def host(host = 'localhost')
+  def host(host = "localhost")
     TeutonHost.new(self, host)
   end
 end

data/lib/teuton/case_manager/case/builtin/package.rb

@@ -1,4 +1,3 @@
-
 class Package
   def initialize(teuton_host, param)
     @teuton_host = teuton_host
@@ -10,12 +9,12 @@ class Package
   def installed?
     @parent.target("Package #{@param} installed?")
     @parent.run "whereis #{@param}", on: @host
-    @parent.expect_one [ 'bin', @param ]
+    @parent.expect_one ["bin", @param]
   end
 
   def not_installed?
     @parent.target("Package #{@param} not installed?")
     @parent.run "whereis #{@param}", on: @host
-    @parent.expect_none [ 'bin' , @param ]
+    @parent.expect_none ["bin", @param]
   end
 end

data/lib/teuton/case_manager/case/builtin/service.rb

@@ -1,4 +1,3 @@
-
 class Service
   def initialize(teuton_host, param)
     @teuton_host = teuton_host
@@ -10,24 +9,24 @@ class Service
   def is_running?
     @parent.target("Service #{@param} is running?")
     @parent.run "systemctl status #{@param}", on: @host
-    @parent.expect_one ['Active:', 'running' ]
+    @parent.expect_one ["Active:", "running"]
   end
 
   def is_inactive?
     @parent.target("Service #{@param} is inactive?")
     @parent.run "systemctl status #{@param}", on: @host
-    @parent.expect_one ['Active:', 'inactive' ]
+    @parent.expect_one ["Active:", "inactive"]
   end
 
   def is_enable?
     @parent.target("Service #{@param} is enable?")
     @parent.run "systemctl status #{@param}", on: @host
-    @parent.expect_one ['Loaded:', 'enable' ]
+    @parent.expect_one ["Loaded:", "enable"]
   end
 
   def is_disable?
     @parent.target("Service #{@param} is disable?")
     @parent.run "systemctl status #{@param}", on: @host
-    @parent.expect_one ['Loaded:', 'disable' ]
+    @parent.expect_one ["Loaded:", "disable"]
   end
 end

data/lib/teuton/case_manager/case/builtin/teuton_file.rb

@@ -1,4 +1,3 @@
-
 class TeutonFile
   def initialize(teuton_host, param)
     @teuton_host = teuton_host
@@ -11,18 +10,18 @@ class TeutonFile
   def exist?
     @parent.target("File #{@param} exists?")
     @parent.run "file #{@param}", on: @host
-    @parent.expect @result.grep_v('cannot open').grep(@param).count.eq 1
+    @parent.expect @result.grep_v("cannot open").grep(@param).count.eq 1
   end
 
   def directory?
     @parent.target("File #{@param} is directory?")
     @parent.run "file #{@param}", on: @host
-    @parent.expect @result.grep_v('cannot open').grep(@param).grep('directory').count.eq 1
+    @parent.expect @result.grep_v("cannot open").grep(@param).grep("directory").count.eq 1
   end
 
   def regular?
     @parent.target("File #{@param} is regular?")
     @parent.run "file #{@param}", on: @host
-    @parent.expect @result.grep(@param).grep('directory').count.eq 0
+    @parent.expect @result.grep(@param).grep("directory").count.eq 0
   end
 end

data/lib/teuton/case_manager/case/builtin/teuton_host.rb

@@ -1,14 +1,13 @@
-
-require_relative 'teuton_file'
-require_relative 'package'
-require_relative 'service'
-require_relative 'user'
+require_relative "teuton_file"
+require_relative "package"
+require_relative "service"
+require_relative "user"
 
 class TeutonHost
   attr_reader :parent
   attr_reader :host
 
-  def initialize(parent, host = 'localhost')
+  def initialize(parent, host = "localhost")
     @parent = parent
     @host = host
   end

data/lib/teuton/case_manager/case/builtin/user.rb

@@ -1,4 +1,3 @@
-
 class User
   def initialize(teuton_host, param)
     @teuton_host = teuton_host
@@ -10,7 +9,7 @@ class User
   def exists?
     @parent.target("User #{@param} exists?")
     @parent.run "id #{@param}", on: @host
-    @parent.expect_one [ 'uid=', @param ]
+    @parent.expect_one ["uid=", @param]
   end
 
   def is_member_of?(groupname)

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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require_relative '../../application'
-require_relative '../../report/report'
-require_relative '../utils'
-require_relative 'main'
-require_relative 'result/result'
-require_relative 'builtin/main'
+require_relative "../../application"
+require_relative "../../report/report"
+require_relative "../utils"
+require_relative "main"
+require_relative "result/result"
+require_relative "builtin/main"
 
 # TODO: split Case class into several classes:
 # * Case, Action?, Session?, RunCommand class
@@ -26,7 +26,8 @@ class Case
   attr_accessor :result
   attr_accessor :action # TODO: why not reader only???
   attr_reader :id, :config, :uniques, :conn_status
-  @@id = '01' # First case ID value
+  attr_reader :skip
+  @@id = "01" # First case ID value
 
   ##
   # Initialize case from specified config
@@ -41,21 +42,21 @@ class Case
 
     # Define Case Report
     @report = Report.new(@id)
-    @report.output_dir = File.join('var', @config.global[:tt_testname])
+    @report.output_dir = File.join("var", @config.global[:tt_testname])
     ensure_dir @report.output_dir
 
     # Default configuration
     @skip = false
-    @skip = get(:tt_skip) unless get(:tt_skip) == 'NODATA'
-    unless app.options['case'].nil?
+    @skip = get(:tt_skip) unless get(:tt_skip) == "NODATA"
+    unless app.options["case"].nil?
       @skip = true
-      @skip = false if app.options['case'].include? @id.to_i
+      @skip = false if app.options["case"].include? @id.to_i
     end
 
     @conn_status = {}
-    @tmpdir = File.join('var', @config.get(:tt_testname), 'tmp', @id.to_s)
+    @tmpdir = File.join("var", @config.get(:tt_testname), "tmp", @id.to_s)
     # ensure_dir @tmpdir # REVISE: When we will need this? Samba?
-    @remote_tmpdir = File.join('/', 'tmp')
+    @remote_tmpdir = File.join("/", "tmp")
 
     @unique_values = {}
     @result = Result.new
@@ -64,10 +65,12 @@ class Case
     @verbose = Application.instance.verbose
 
     @action_counter = 0
-    @action = { id: 0,
-                weight: 1.0,
-                description: 'No description!',
-                groupname: nil }
+    @action = {
+      id: 0,
+      weight: 1.0,
+      description: "No description!",
+      groupname: nil
+    }
     @uniques = []
     @sessions = {} # Store opened sessions for this case
     tempfile :default
@@ -101,17 +104,14 @@ class Case
   ## Return case members
   # @return members
   def members
-    return '-' if skip
+    return "-" if skip
 
-    @report.head[:tt_members] || 'noname'
+    @report.head[:tt_members] || "noname"
   end
 
   ##
   # Return case skip value
   # @return skip
-  def skip
-    @skip
-  end
   alias skip? skip
 
   ##
@@ -124,13 +124,13 @@ class Case
 
   def read_filename(filename)
     begin
-      file = File.open(filename, 'r')
+      file = File.open(filename, "r")
       item = file.readlines
       file.close
-      item.map! { |i| i.sub(/\n/, '') }
-      return item
-    rescue StandardError
-      return []
+      item.map! { |i| i.sub(/\n/, "") }
+    rescue
+      item = []
     end
+    item
   end
 end

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

@@ -17,11 +17,11 @@ class Case
   private
 
   def log_unique_message(key, value)
-    log('UNIQUE:', :error)
+    log("UNIQUE:", :error)
     begin
       log("   ├── Value     => #{key}", :error)
       log("   └── Conflicts => #{value}", :error)
-    rescue StandardError => e
+    rescue => e
       log(key, :error)
       log(e.to_s, :error)
     end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../../application'
+require_relative "../../application"
 
 # Class Case::Config
 # * get
@@ -8,14 +8,14 @@ require_relative '../../application'
 # * unset
 # * missing_method
 class Case
-  # This class manage configuration for only one case
   class Config
+    # This class manage configuration for only one case
     attr_reader :ialias, :global, :local, :running
 
     def initialize(args)
-      @ialias  = args[:alias] || Application.instance.ialias.clone
-      @global  = args[:global] || Application.instance.global.clone
-      @local   = args[:local]  || {}
+      @ialias = args[:alias] || Application.instance.ialias.clone
+      @global = args[:global] || Application.instance.global.clone
+      @local = args[:local] || {}
       @running = {}
 
       # Set defaults values
@@ -24,7 +24,7 @@ class Case
 
     # Read param Option from [running, config or global] Hash data
     def get(option, level = 0)
-      return 'NODATA' if level > 3
+      return "NODATA" if level > 3
 
       return @running[option] if @running[option]
 
@@ -46,19 +46,19 @@ class Case
     private
 
     def search_alias(key, level)
-      if @ialias[key].class == Array
+      if @ialias[key].instance_of? Array
         return search_array_alias(@ialias[key], level)
       elsif [Integer, String, Symbol].include? @ialias[key].class
         return get(@ialias[key])
       end
-      
-      words = key.to_s.split('_')
-      return 'NODATA' if words.size < 2
 
-      return 'NODATA' unless %w[ip hostname username password].include? words[1]
+      words = key.to_s.split("_")
+      return "NODATA" if words.size < 2
+
+      return "NODATA" unless %w[ip hostname username password].include? words[1]
 
       key2 = @ialias[words[0].to_sym]
-      return 'NODATA' unless key2
+      return "NODATA" unless key2
 
       get("#{key2}_#{words[1]}".to_sym, level)
     end
@@ -66,13 +66,13 @@ class Case
     def search_array_alias(keys, level)
       values = []
       keys.each do |k|
-        if k.class == Symbol
+        if k.instance_of? Symbol
           values << get(k, level + 1)
           next
         end
         values << k
       end
-      values.join('')
+      values.join("")
     end
   end
 end