teuton 2.5.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f53359ed5f8eae1b3a798630c5d56ae46076073bface7d3788de57b245a80cb
-  data.tar.gz: 366afd9ccee6db9bdf5756fe5954050231681763489bab11b1841e9279998c08
+  metadata.gz: 7fa647498d568e303c8c02ea44277a595f3796a404a523daf6c1b0408110de97
+  data.tar.gz: b733858b7e97b373aca8477a359649b5e6614cdd60caffbdd052e450aa12dffa
 SHA512:
-  metadata.gz: a40866560ec0d622b48322c0689dfe36cb9820cf565ce4258a8b71d38a1a3cc88e57f68e208c0d2a6c1a0787b7a2698af0446757bb2167fdf04d2bcd8002178f
-  data.tar.gz: 288e6105576a15ac25eb20d298bb552b77347b65a3a2df6632d0ef26063061c77c32ef02af88a6f7244790df9573b6e79d7e9fee8b0606006a41b0cd171a51c5
+  metadata.gz: 60b94cd2ef2632e1fdbe81515909be71bce35d011f739ecc97806c1cfaa8115a7b743ee4369b54dffe366f1d7b06486fe451827c2fb4ce7fd37448fbf56b549b
+  data.tar.gz: 312bd19998b3ef68cc61780dda49cf1711033736a2593206501d5f428cd64780974a2adfc4198dd1097b178f6202637dcc10e11131c90495de553fc33547520f

data/docs/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 # Changelog
 
+* [version 2.5](changelog/v2.5.md)
+* [version 2.4](changelog/v2.4.md)
 * [version 2.3](changelog/v2.3.md)
 * [version 2.2](changelog/v2.2.md)
 * [version 2.1](changelog/v2.1.md)

data/docs/changelog/todo.md

@@ -2,17 +2,15 @@
 ## TO-DO
 
 New features:
-- Parse new input format, and detect parse errors
-- Teuton readme --lang=es
-- Export files with other langs
+- 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.6.md

@@ -0,0 +1,4 @@
+
+## [2.6.0]
+
+- [ADD] When running local or SSH commands, stdout and stderr are captured and readed by "expect" sentence.

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

@@ -0,0 +1,55 @@
+[<<back](../README.md)
+
+# Diagram
+
+```mermaid
+flowchart TB
+
+subgraph user
+  CLI --> Teuton
+end
+
+subgraph "create\nnew\nproject"
+  Teuton -- create --> Skeleton("Sekeleton\nFiles")
+end
+
+subgraph "Check\nproject files"
+  Teuton -- check --> Laboratory("Laboratory\nDSL\nShow\nBuiltin!")
+end
+
+subgraph "Create readme\nfrom project"
+  Teuton -- readme --> Readme("Readme\nDSL\nLang!")
+end
+
+subgraph manager
+  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
+  Verbose
+
+  Readme --> ConfigFileReader
+  Laboratory --> ConfigFileReader
+  CaseManager --> ConfigFileReader
+
+  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\nFormatter\nfiles/template")
+  Case --> Report
+end
+```

data/docs/learn/02-target.md

@@ -15,13 +15,31 @@ group "Learn about targets" do
 
   target "Create user david"
   run "id david"
-  expect "david"
+  expect ["uid=", "(david)", "gid="]
+
+  target "Delete user vader"
+  run "id vader"
+  expect ["id:", "vader", "no exist"]
 
 end
 ```
 
 > In this example, our localhost's OS is GNU/Linux (or any other compatible OS) because the command executed is `id david`.
 
+When the user exists, we expect this words: `uid=, (david), gid=`.
+
+```
+❯ id david
+uid=1000(david) gid=1000(david) grupos=1000(david)
+```
+
+But when user does not exist, we expect different words: `id:, vader, no exist`.
+
+```
+❯ id vader
+id: «vader»: no existe ese usuario
+```
+
 ## Execution section
 
 When we run this teuton test, the execution section (`play`) is processed. This seccion now contains this:
@@ -41,7 +59,7 @@ end
 Execute this command to run the test:
 
 ```console
-> teuton run examples/01-target
+> teuton run examples/02-target
 
 CASE RESULTS
 +------+-----------+-------+-------+
@@ -54,7 +72,7 @@ Report files are created into `var/02-target/` folder:
 
 ```console
 var
-└── 01-target
+└── 02-target
     ├── case-01.txt
     ├── moodle.csv
     └── resume.txt
@@ -63,35 +81,42 @@ var
 Let's see one report:
 
 ```
-> more var/02-target/case-01.txt
-
+❯ cat var/02-target/case-01.txt
 CONFIGURATION
 +-------------+-----------+
 | tt_members  | anonymous |
 | tt_sequence | false     |
 | tt_skip     | false     |
-| tt_testname | 01-target |
+| tt_testname | 02-target |
 +-------------+-----------+
 
+
 GROUPS
 - Learn about targets
     01 (1.0/1.0)
         Description : Create user david
         Command     : id david
         Duration    : 0.002 (local)
-        Alterations : find(david) & count
+        Alterations : find(uid=) & find((david)) & find(gid=) & count
+        Expected    : Greater than 0 (String)
+        Result      : 1 (Integer)
+    02 (1.0/1.0)
+        Description : Delete user vader
+        Command     : id vader
+        Duration    : 0.002 (local)
+        Alterations : find(id:) & find(vader) & find(no exist) & count
         Expected    : Greater than 0 (String)
         Result      : 1 (Integer)
 
 RESULTS
 +--------------+---------------------------+
 | case_id      | 01                        |
-| start_time   | 2022-12-24 13:31:28 +0000 |
-| finish_time  | 2022-12-24 13:31:28 +0000 |
-| duration     | 0.001880141               |
+| start_time   | 2023-04-10 09:09:30 +0100 |
+| finish_time  | 2023-04-10 09:09:30 +0100 |
+| duration     | 0.003863242               |
 | unique_fault | 0                         |
-| max_weight   | 1.0                       |
-| good_weight  | 1.0                       |
+| max_weight   | 2.0                       |
+| good_weight  | 2.0                       |
 | fail_weight  | 0.0                       |
 | fail_counter | 0                         |
 | grade        | 100                       |

data/docs/learn/03-remote_hosts.md

@@ -43,7 +43,7 @@ Define 1 target (item to be checked):
 group "Remote hosts" do
   target "Create user david"
   run "id david", on: :host1
-  expect "david"
+  expect [ "uid=", "(david)", "gid=" ]
 end
 ```
 

data/docs/learn/04-config.md

@@ -24,7 +24,7 @@ group "Reading params from config file" do
 
   target "Create user #{get(:username)}"
   run "id #{get(:username)}"
-  expect get(:username)
+  expect [ "uid=", "("+get(:username)+")", "gid=" ]
 
 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 |
@@ -14,7 +14,7 @@ Check Teuton test syntax and show statistics.
 (001) target      Create user get(username)
       weight      1.0
       run         'id get(username)' on host1
-      expect      get(username) (String)
+      expect      ["uid=", "(get(username))", "gid="] (Array)
 
 +----------------------------+
 | GROUP: Using file: network |
@@ -32,6 +32,7 @@ Check Teuton test syntax and show statistics.
 +-------------+-------+
 | DSL Stats   | Count |
 +-------------+-------+
+| Uses        | 2     |
 | Groups      | 2     |
 | Targets     | 3     |
 | Runs        | 3     |
@@ -44,7 +45,4 @@ Check Teuton test syntax and show statistics.
 |  * hostname | 2     |
 | Sets        | 0     |
 +-------------+-------+
-+----------------------+
-| Revising CONFIG file |
-+----------------------+
 ```

data/docs/learn/07-target_weight.md

@@ -19,15 +19,13 @@ end
 ```
 
 ```
-❯ teuton check examples/07-target_weight
-
 +--------------------------+
 | GROUP: Using file: users |
 +--------------------------+
 (001) target      Create user get(username)
       weight      1.0
       run         'id get(username)' on host1
-      expect      get(username) (String)
+      expect      ["uid=", "(get(username))", "gid="] (Array)
 
 +----------------------------+
 | GROUP: Using file: network |

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/docs/learn/README.md

@@ -17,7 +17,7 @@ Learn how write your own Teuton tests:
 1. [Export other FORMATS](11-export.md)
 1. [PRESERVE old reports](12-preserve.md)
 1. [Hide FEEDBACK from reports](13-feedback.md)
-1. [MOODLE ID](14-moodle_id.md)
+1. [MOODLE](14-moodle_id.md)
 1. [Build README from test](15-readme.md)
 1. [INCLUDE more configuration files](16-include.md)
 1. [ALIAS](17-alias.md)

data/lib/teuton/case/case.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative "../utils/project"
+require_relative "../utils/verbose"
+require_relative "../utils/result/result"
+require_relative "../report/report"
+require_relative "dsl/all"
+require_relative "config"
+require_relative "close"
+require_relative "play"
+require_relative "builtin/main"
+
+class Case
+  # Case: export, filename, grade, members,skip
+  include DSL
+  include Verbose
+
+  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)
+    @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)
+    @report.output_dir = File.join("var", @config.global[:tt_testname])
+
+    # Default configuration
+    @skip = false
+    @skip = get(:tt_skip) unless get(:tt_skip) == "NODATA"
+    unless Project.value[:options]["case"].nil?
+      @skip = true
+      @skip = false if Project.value[:options]["case"].include? @id.to_i
+    end
+    @debug = Project.debug?
+    @verbose = Project.value[:verbose]
+
+    @tmpdir = File.join("var", @config.get(:tt_testname), "tmp", @id.to_s)
+    # ensure_dir @tmpdir # REVISE: When we will need this? Samba?
+
+    @unique_values = {}
+    @result = Result.new
+    @action_counter = 0
+    @action = {
+      id: 0,
+      weight: 1.0,
+      description: "No description!",
+      groupname: nil
+    }
+    @uniques = []
+    @sessions = {} # Store opened sessions for this case
+    @conn_status = {}
+    tempfile :default
+  end
+
+  def export(format)
+    return if skip?
+
+    @report.export format
+  end
+
+  def filename
+    # called from: close_main_report
+    @report.filename
+  end
+
+  def grade
+    return 0.0 if skip
+
+    @report.tail[:grade]
+  end
+
+  def members
+    return "-" if skip
+
+    @report.head[:tt_members] || "noname"
+  end
+
+  alias_method :skip?, :skip
+end

data/lib/teuton/{case_manager/case → 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_manager/case → 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_manager/case → case/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_manager/case/dsl/main.rb → case/dsl/all.rb}

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require_relative "expect"
 require_relative "getset"
 require_relative "goto"

data/lib/teuton/{case_manager/case → 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