teuton 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d4dba357b30b42efc7a32e8389bd6c7dfa98e835f46907d2f4a3dbe7e5942e8
-  data.tar.gz: 0bb5add96b17f02f791568d02e2fc8ca698cc9138c9e25e9075d2e686fb6ba88
+  metadata.gz: 7fa647498d568e303c8c02ea44277a595f3796a404a523daf6c1b0408110de97
+  data.tar.gz: b733858b7e97b373aca8477a359649b5e6614cdd60caffbdd052e450aa12dffa
 SHA512:
-  metadata.gz: 694a956fde1cb64e76d78bf4513df7f011001654aef7d305c9ac54ea0df6748b945d8b0b69514c7172c2e56404093824dd59636f54e647b33d0b068d9d3ef5eb
-  data.tar.gz: 4a8d0fa96fdc396d2da7cd129b1458525abe0d6acb15944f965a3facc692980cd76c33d2321a4997a5e03e3af087eea020054ff308b62d37a9b848778d6c8b79
+  metadata.gz: 60b94cd2ef2632e1fdbe81515909be71bce35d011f739ecc97806c1cfaa8115a7b743ee4369b54dffe366f1d7b06486fe451827c2fb4ce7fd37448fbf56b549b
+  data.tar.gz: 312bd19998b3ef68cc61780dda49cf1711033736a2593206501d5f428cd64780974a2adfc4198dd1097b178f6202637dcc10e11131c90495de553fc33547520f

data/docs/changelog/todo.md

@@ -1,20 +1,16 @@
 
-
 ## TO-DO
 
 New features:
-- Parse new input format, and detect parse errors
-- Teuton readme --lang=es
-- Export files with other langs
-- Snode Dockerfile
+- Teuton readme --lang=es and export files with other langs
+- Snode Dockerfile with SSH server
+- Auto Parse new input format, and detect parse errors
 
 Revise:
 * verify get(:key) and get('key') works fine!
-* Formatter: xml,
+* Formatter: xml
 
 Internal changes:
-* Application to Settings
 * Laboratory to Checker
 * Unify messages ERROR, INFO, WARN. etc
-* Create SendManager as ExportManager?
 * Add tt_label as alias of tt_members

data/docs/changelog/v2.7.md

@@ -0,0 +1,11 @@
+
+## [2.7.0]
+
+New features:
+- [ADD] "teuton config PROJECTPATH" will suggest suitable configuration for the project.
+- [ADD] Every one line command output is registered into reports.
+- [ADD] "expect_exit 1", check last command exit code is equal to 1.
+
+Internal changes:
+* Application class splited into Settings and Project classes
+* Create SendManager similar to ExportManager

data/docs/diagram.md

@@ -13,42 +13,43 @@ subgraph "create\nnew\nproject"
   Teuton -- create --> Skeleton("Sekeleton\nFiles")
 end
 
-subgraph "check\nproject files"
+subgraph "Check\nproject files"
   Teuton -- check --> Laboratory("Laboratory\nDSL\nShow\nBuiltin!")
 end
 
-subgraph "create readme\nfrom project"
+subgraph "Create readme\nfrom project"
   Teuton -- readme --> Readme("Readme\nDSL\nLang!")
 end
 
 subgraph manager
-  Teuton -- require --> manager/DSL
+  Teuton -- run --> manager/DSL
   manager/DSL -- play --> CaseManager("CaseManager\ncheck_cases\nExportManager\nSendManager\nShowReport")
   ReportManager --> HallOfFame
 end
 
+subgraph "case folder"
+  CaseManager --> Case("Case\nConfig\nClose\nPlay\nRunner\ncase/DSL\ncase/builtin!")
+end
+
 subgraph utils
-  manager/DSL -- use/macros/groups --> Application("Application\nNameFileFinder")
+  Verbose
+
   Readme --> ConfigFileReader
   Laboratory --> ConfigFileReader
   CaseManager --> ConfigFileReader
-  Verbose
-end
-
-subgraph "case folder"
-  CaseManager --> Case("Case\nConfig\nClose\nPlay\nRunner")
-  Case --> case/DSL
-end
 
-subgraph "result class"
   Laboratory --> Result
   Readme --> Result("Result\next_array\next_compare\next_filter")
   Case --> Result
+
+  Laboratory --> Application
+  Readme --> Application
+  manager/DSL -- use/macros/groups --> Application("Application\nNameFileFinder")
+  Case --> Application
 end
 
 subgraph report
-  CaseManager --> Report
-  Report --> Formatter
-  Formatter --> files/template
+  CaseManager --> Report("Report\nFormatter\nfiles/template")
+  Case --> Report
 end
 ```

data/docs/learn/06-cmd_check.md

@@ -3,10 +3,10 @@
 
 # check test
 
-Check Teuton test syntax and show statistics.
+Check Teuton check syntax and show statistics.
 
 ```
-❯ teuton check examples/05-use
+❯ teuton check examples/05-use     
 
 +--------------------------+
 | GROUP: Using file: users |
@@ -32,6 +32,7 @@ Check Teuton test syntax and show statistics.
 +-------------+-------+
 | DSL Stats   | Count |
 +-------------+-------+
+| Uses        | 2     |
 | Groups      | 2     |
 | Targets     | 3     |
 | Runs        | 3     |

data/docs/learn/21-exit_codes.md

@@ -1,24 +1,17 @@
 [<< back](README.md)
 
-# Example: 16-exit_codes
+# Example: 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, and also exitcode is captured.
 
-`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.
+## Example
 
-## 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.
+  run "id root"
+  expect_exit 0
 
-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.
+  target "No user vader"
+  run "id vader"
+  expect_exit 1
+```

data/lib/teuton/case/case.rb

@@ -1,67 +1,60 @@
 # frozen_string_literal: true
 
-require_relative "../application"
+require_relative "../utils/project"
+require_relative "../utils/verbose"
+require_relative "../utils/result/result"
 require_relative "../report/report"
-require_relative "../case_manager/utils"
-require_relative "../result/result"
-require_relative "dsl"
+require_relative "dsl/all"
 require_relative "config"
 require_relative "close"
 require_relative "play"
-require_relative "runner"
 require_relative "builtin/main"
 
-# Case class
-# * initialize
-# * export
-# * filename
-# * grade
-# * members
-# * skip
-# * read_filename ???
 class Case
+  # Case: export, filename, grade, members,skip
   include DSL
-  include Utils
+  include Verbose
 
-  attr_accessor :result
-  attr_accessor :action # TODO: why not reader only???
-  attr_reader :id, :config, :uniques, :conn_status
+  attr_accessor :action # Updated by ExecuteManager
+  attr_accessor :result # Updated by ExecuteManager
+  attr_accessor :sessions # Updated by ExecuteManager
+  attr_accessor :conn_status # Updated by ExecuteManager
+
+  attr_reader :id
+  attr_reader :config   # Readed by ExecuteManager
+  attr_reader :uniques
   attr_reader :skip
   @@id = "01" # First case ID value
 
   def initialize(config)
-    app = Application.instance
-    @config = Case::Config.new(local: config, global: app.global)
-    @groups = app.groups
+    @config = Case::Config.new(
+      local: config,
+      global: Project.value[:global]
+    )
+    @groups = Project.value[:groups]
 
     @id = @@id
     @@id = @@id.next
 
     # Define Case Report
     @report = Report.new(@id)
-    # TODO: Move folder creation from case to parent classes?
     @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?
+    unless Project.value[:options]["case"].nil?
       @skip = true
-      @skip = false if app.options["case"].include? @id.to_i
+      @skip = false if Project.value[:options]["case"].include? @id.to_i
     end
+    @debug = Project.debug?
+    @verbose = Project.value[:verbose]
 
-    @conn_status = {}
     @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")
 
     @unique_values = {}
     @result = Result.new
-
-    @debug = Application.instance.debug
-    @verbose = Application.instance.verbose
-
     @action_counter = 0
     @action = {
       id: 0,
@@ -71,6 +64,7 @@ class Case
     }
     @uniques = []
     @sessions = {} # Store opened sessions for this case
+    @conn_status = {}
     tempfile :default
   end
 
@@ -81,6 +75,7 @@ class Case
   end
 
   def filename
+    # called from: close_main_report
     @report.filename
   end
 
@@ -97,18 +92,4 @@ class Case
   end
 
   alias_method :skip?, :skip
-
-  private
-
-  def read_filename(filename)
-    begin
-      file = File.open(filename, "r")
-      item = file.readlines
-      file.close
-      item.map! { |i| i.sub(/\n/, "") }
-    rescue
-      item = []
-    end
-    item
-  end
 end

data/lib/teuton/case/close.rb

@@ -2,6 +2,8 @@
 
 class Case
   def close(uniques)
+    # Invoked from check_cases!
+
     fails = 0
     @uniques.each do |key|
       next unless uniques[key].include?(id) && uniques[key].count > 1

data/lib/teuton/case/config.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../application"
+require_relative "../utils/project"
 
 # Class Case::Config
 # * get
@@ -13,8 +13,8 @@ class Case
     attr_reader :ialias, :global, :local, :running
 
     def initialize(args)
-      @ialias = args[:alias] || Application.instance.ialias.clone
-      @global = args[:global] || Application.instance.global.clone
+      @ialias = args[:alias] || Project.value[:ialias].clone
+      @global = args[:global] || Project.value[:global].clone
       @local = args[:local] || {}
       @running = {}
 

data/lib/teuton/case/{runner.rb → deprecated/runner.rb}

@@ -6,6 +6,8 @@ require_relative "dsl/log"
 class Case
   private
 
+  # READ: @config
+  # WRITE: @action, @result, @session
   def run_cmd_on(host)
     protocol = @config.get("#{host}_protocol".to_sym)
     ip = @config.get("#{host}_ip".to_sym)
@@ -30,15 +32,13 @@ class Case
 
   def run_cmd_localhost
     @action[:conn_type] = :local
-    i = my_execute(@action[:command], @action[:encoding])
-    @result.exitstatus = i[:exitstatus]
-    @result.content = i[:content]
+    resp = my_execute(@action[:command], @action[:encoding])
+    @result.exitcode = resp[:exitcode]
+    @result.content = resp[:content]
   end
 
-  ##
-  # Run remote command
-  # @param input_hostname (Symbol or String)
   def run_cmd_remote(input_hostname)
+    # @param input_hostname (Symbol or String)
     hostname = input_hostname.to_s
     i = (hostname + "_protocol").to_sym
     protocol = @config.get(i) if @config.get(i)
@@ -86,6 +86,7 @@ class Case
     end
 
     text = ""
+    exitcode = 0
     begin
       if @sessions[hostname].nil?
         @sessions[hostname] = Net::SSH.start(
@@ -100,23 +101,24 @@ class Case
       end
       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
+      exitcode = text.exitstatus
     rescue Errno::EHOSTUNREACH
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :host_unreachable
+      exitcode = -1
       log("Host #{ip} unreachable!", :error)
     rescue Net::SSH::AuthenticationFailed
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :error_authentication_failed
+      exitcode = -1
       log("SSH::AuthenticationFailed!", :error)
     rescue Net::SSH::HostKeyMismatch
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :host_key_mismatch
+      exitcode = -1
       log("SSH::HostKeyMismatch!", :error)
       log("* The destination server's fingerprint is not matching " \
           "what is in your local known_hosts file.", :error)
@@ -126,11 +128,12 @@ class Case
     rescue => e
       @sessions[hostname] = :nosession
       @conn_status[hostname] = :error
+      exitcode = -1
       log("[#{e.class}] SSH on <#{username}@#{ip}>" \
           " exec: #{@action[:command]}", :error)
     end
     output = encode_and_split(@action[:encoding], text)
-    # revise: @result.exitstatus = text.exitstatus
+    @result.exitcode = exitcode
     @result.content = output
     @result.content.compact!
   end
@@ -180,6 +183,7 @@ class Case
           " ip=<#{ip}>, HOSTID=<#{hostname}>", :warn)
     end
     output = encode_and_split(@action[:encoding], text)
+    @result.exitcode = -1
     @result.content = output
     @result.content.compact!
   end

data/lib/teuton/case/deprecated/utils.rb

@@ -0,0 +1,40 @@
+require "open3"
+require "rainbow"
+require_relative "../utils/project"
+
+module Utils
+  def encode_and_split(encoding, text)
+    # Convert text to UTF-8 deleting unknown chars
+    text ||= "" # Ensure text is not nil
+    flag = [:default, "UTF-8"].include? encoding
+    return text.encode("UTF-8", invalid: :replace).split("\n") if flag
+
+    # Convert text from input ENCODING to UTF-8
+    ec = Encoding::Converter.new(encoding.to_s, "UTF-8")
+    begin
+      text = ec.convert(text)
+    rescue => e
+      warn "[ERROR] #{e}"
+      warn "        Suggest declare text encoding, for example:"
+      warn "        run 'command', on: :host, :encoding => 'ISO-8859-1'"
+    end
+
+    text.split("\n")
+  end
+
+  def my_execute(cmd, encoding = "UTF-8")
+    # TODO: mover a la clase ExecuteManager
+    return {exitstatus: 0, content: ""} if Project.debug?
+
+    begin
+      text, status = Open3.capture2e(cmd)
+      exitstatus = status.exitstatus
+    rescue => e
+      verbose Rainbow("!").green
+      text = e.to_s
+      exitstatus = 1
+    end
+    content = encode_and_split(encoding, text)
+    {exitstatus: exitstatus, content: content}
+  end
+end

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

@@ -0,0 +1,8 @@
+require_relative "expect"
+require_relative "getset"
+require_relative "goto"
+require_relative "log"
+require_relative "macro"
+require_relative "send"
+require_relative "target"
+require_relative "unique"

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

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module DSL
+  # expect, expect2, expect_any, expect_first, expect_last
+  # expect_nothing, expect_none, expect_one
+
   # expect <condition>, :weight => <value>
   def expect(input, args = {})
     if input.instance_of?(TrueClass) || input.instance_of?(FalseClass)
@@ -16,18 +19,16 @@ module DSL
     @action_counter += 1
     @action[:id] = @action_counter
     @action[:check] = cond
-    @action[:result] = @result.value
 
-    @action[:alterations] = @result.alterations
-    @action[:expected] = @result.expected
-    @action[:expected] = args[:expected] if args[:expected]
+    @action[:result] = (args[:value] || @result.value)
 
+    @action[:alterations] = @result.alterations
+    @action[:expected] = (args[:expected] || @result.expected)
     @report.lines << @action.clone
     weight(1.0)
 
-    app = Application.instance
-    c = app.letter[:bad]
-    c = app.letter[:good] if cond
+    c = Settings.letter[:bad]
+    c = Settings.letter[:good] if cond
     verbose Rainbow(c).green
   end
 
@@ -40,6 +41,22 @@ module DSL
     expect2 result.count.gt(0), args
   end
 
+  def expect_exit(value)
+    @result.alterations = "Read exit code"
+    real_value = result.exitcode
+    cond = if value.is_a? Range
+      expect_value = "With range #{value}"
+      value.to_a.include? real_value
+    elsif value.is_a? Array
+      expect_value = "Inside list #{value}"
+      value.include? real_value
+    else
+      expect_value = value
+      (real_value == value.to_i)
+    end
+    expect2 cond, value: real_value, expected: expect_value
+  end
+
   def expect_first(input, args = {})
     @result.first
     output = input
@@ -54,7 +71,6 @@ module DSL
     expect2 input, expected: output
   end
 
-  # def expect_none(input, args = {})
   def expect_nothing(args = {})
     expect2 result.count.eq(0), args
   end
@@ -79,8 +95,8 @@ module DSL
     expect2 result.count.eq(1), args
   end
 
-  # Set weight value for the action
   def weight(value = nil)
+    # Set weight value for the action
     if value.nil?
       @action[:weight]
     elsif value == :default

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

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "../runner"
+require_relative "../execute/execute_manager"
 
-# Case class -> DSL module:
-# * goto
-# * run
 module DSL
   ##
-  # DLS run: It's the same as goto :localhost
+  # DSL run and goto
+  # run: It's the same as goto :localhost
   # @param command (String)
   # @param args (Hash)
   def run(command, args = {})
@@ -17,7 +15,7 @@ module DSL
     goto(host, args)
   end
 
-  # Run command from the host identify as pHostname
+  # Run command from the host identify as "host"
   # goto :host1, :execute => "command"
   def goto(host = :localhost, args = {})
     @result.reset
@@ -27,9 +25,12 @@ module DSL
     tempfile(args[:tempfile]) if args[:tempfile]
     @action[:encoding] = args[:encoding] || "UTF-8"
 
-    start_time = Time.now
-    run_cmd_on(host)
-    @action[:duration] = (Time.now - start_time).round(3)
+    ExecuteManager.new(self).call(host)
+    @action[:output] = if @result.content.size < 2
+      @result.value.clone
+    else
+      "(#{@result.content.size} lines)"
+    end
   end
   alias_method :on, :goto
 end

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

@@ -1,6 +1,5 @@
 require "rainbow"
-##
-# Define DSL#log function
+
 module DSL
   ##
   # Record log message

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../../application"
+require_relative "../../utils/project"
 
 # DSL module methods: assert, missing_method
 module DSL
@@ -9,7 +9,7 @@ module DSL
   # @param name (String) Macro name
   # @param input (Hash) Macro params
   def macro(name, input = {})
-    macros = Application.instance.macros
+    macros = Project.value[:macros]
     unless macros[name]
       log("Macro #{name} not found!", :error)
       return

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

@@ -1,12 +1,7 @@
 # frozen_string_literal: true
 
-# Case->DSL#
-# * send
-# * tempfile
-# * tempdir
-# * remote_tempdir
-# * remote_tempfile
 module DSL
+  # * send, tempfile, tempdir, remote_tempdir, remote_tempfile
   def send(args = {})
     return if skip?
 
@@ -52,7 +47,7 @@ module DSL
     name = "teuton.tmp" if input == :default
 
     @action[:tempfile] = File.join(@tmpdir, name)
-    @action[:remote_tempfile] = File.join(@remote_tmpdir, name)
+    @action[:remote_tempfile] = File.join(remote_tempdir, name)
 
     @action[:tempfile]
   end
@@ -66,6 +61,6 @@ module DSL
   end
 
   def remote_tempdir
-    @remote_tmpdir
+    File.join("/", "tmp") # TODO: Remove this?
   end
 end