teuton 2.5.0 → 2.7.0

data/lib/teuton/{application.rb → utils/application.rb}

@@ -1,5 +1,5 @@
 require "singleton"
-require_relative "utils/name_file_finder"
+require_relative "name_file_finder"
 
 class Application
   include Singleton
@@ -33,7 +33,11 @@ class Application
     @running_basedir = Dir.getwd
     @output_basedir = "var"
     @default = {name: "teuton", format: :txt, debug: false}
-    @options = {"lang" => "en"}
+    @options = {
+      "lang" => "en",
+      "color" => true,
+      "panel" => false
+    }
     @verbose = true
 
     @global = {}
@@ -65,10 +69,14 @@ class Application
   # * Read color input option
   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?
+
+    finder = NameFileFinder.new(@options)
+    finder.find_filenames_for(projectpath)
+    @project_path = finder.project_path
+    @script_path = finder.script_path
+    @config_path = finder.config_path
+    @test_name = finder.test_name
 
     unless @options["case"].nil?
       numbers = @options["case"].split(",")

data/lib/teuton/utils/name_file_finder.rb

@@ -1,10 +1,24 @@
 require "rainbow"
 
-module NameFileFinder
+class NameFileFinder
+  attr_reader :options
+  attr_reader :project_path
+  attr_reader :script_path
+  attr_reader :config_path
+  attr_reader :test_name
+
+  def initialize(options = {})
+    @options = options
+    @project_path = nil
+    @script_path = nil
+    @config_path = nil
+    @test_name = nil
+  end
+
   ##
   # Find project filenames from input project relative path
   # @param relprojectpath (String)
-  def self.find_filenames_for(relprojectpath)
+  def find_filenames_for(relprojectpath)
     projectpath = File.absolute_path(relprojectpath)
 
     # Define:
@@ -20,10 +34,10 @@ module NameFileFinder
     true
   end
 
-  ##
-  # Find project filenames from input folder path
-  # @param folder_path (String)
-  def self.find_filenames_from_directory(folder_path)
+  private
+
+  def find_filenames_from_directory(folder_path)
+    # Find project filenames from input folder path
     # COMPLEX MODE: We use start.rb as main RB file
     script_path = File.join(folder_path, "start.rb")
     unless File.exist? script_path
@@ -31,38 +45,34 @@ module NameFileFinder
       exit 1
     end
 
-    app = Application.instance
-    app.project_path = folder_path
-    app.script_path = script_path
-    app.test_name = folder_path.split(File::SEPARATOR)[-1]
+    @project_path = folder_path
+    @script_path = script_path
+    @test_name = folder_path.split(File::SEPARATOR)[-1]
 
     find_configfilename_from_directory(folder_path)
   end
 
-  ##
-  # Find project config filename from input folder path
-  # @param folder_path (String)
-  def self.find_configfilename_from_directory(folder_path)
+  def find_configfilename_from_directory(folder_path)
+    # Find project config filename from input folder path
     # COMPLEX MODE: We use config.yaml by default
-    app = Application.instance
     config_path = ""
 
-    if app.options["cpath"].nil?
+    if options["cpath"].nil?
       config_name = "config"
       # Config name file is introduced by cname arg option from teuton command
-      config_name = app.options["cname"] unless app.options["cname"].nil?
+      config_name = options["cname"] unless options["cname"].nil?
       config_path = File.join(folder_path, "#{config_name}.json")
       unless File.exist? config_path
         config_path = File.join(folder_path, "#{config_name}.yaml")
       end
     else
       # Config path file is introduced by cpath arg option from teuton command
-      config_path = app.options["cpath"]
+      config_path = options["cpath"]
     end
-    app.config_path = config_path
+    @config_path = config_path
   end
 
-  def self.find_filenames_from_rb(script_path)
+  def find_filenames_from_rb(script_path)
     # SIMPLE MODE: We use script_path as main RB file
     # This must be fullpath to DSL script file
     if File.extname(script_path) != ".rb"
@@ -71,44 +81,29 @@ module NameFileFinder
       exit 1
     end
 
-    app = Application.instance
-    app.project_path = File.dirname(script_path)
-    app.script_path = script_path
-    app.test_name = File.basename(script_path, ".rb")
-
+    @project_path = File.dirname(script_path)
+    @script_path = script_path
+    @test_name = File.basename(script_path, ".rb")
     find_configfilenames_from_rb(script_path)
   end
 
-  def self.find_configfilenames_from_rb(script_path)
+  def find_configfilenames_from_rb(script_path)
     # SIMPLE MODE: We use script_path as main RB file
     # This must be fullpath to DSL script file
-    app = Application.instance
-
     config_path = ""
-    if app.options["cpath"].nil?
+    if options["cpath"].nil?
       config_name = File.basename(script_path, ".rb")
       # Config name file is introduced by cname arg option from teuton command
-      config_name = app.options["cname"] unless app.options["cname"].nil?
+      config_name = options["cname"] unless options["cname"].nil?
 
-      config_path = File.join(app.project_path, config_name + ".json")
+      config_path = File.join(@project_path, config_name + ".json")
       unless File.exist? config_path
-        config_path = File.join(app.project_path, config_name + ".yaml")
+        config_path = File.join(@project_path, config_name + ".yaml")
       end
     else
       # Config path file is introduced by cpath arg option from teuton command
-      config_path = app.options["cpath"]
+      config_path = options["cpath"]
     end
-    app.config_path = config_path
-  end
-
-  def self.verboseln(text)
-    verbose(text + "\n")
-  end
-
-  def self.verbose(text)
-    return unless Application.instance.verbose
-    return if Application.instance.options["quiet"]
-
-    print text
+    @config_path = config_path
   end
 end

data/lib/teuton/utils/project.rb

@@ -0,0 +1,73 @@
+# Development in progress...
+
+require_relative "name_file_finder"
+
+class Project
+  def self.init
+    @project = {}
+    @project[:running_basedir] = Dir.getwd
+    @project[:output_basedir] = "var"
+    @project[:name] = "teuton"
+    @project[:format] = :txt
+    @project[:debug] = false
+    @project[:options] = {
+      "color" => true,
+      "lang" => "en",
+      "panel" => false,
+      "quiet" => false
+    }
+    @project[:verbose] = true
+    @project[:global] = {} # Hash of Global configuration params
+    @project[:ialias] = {} # Hash of Internal alias
+    @project[:macros] = {} # Hash of macros
+    @project[:groups] = [] # Array of groups
+    @project[:uses] = []   # TODO: Array of files used
+    @project[:hall_of_fame] = []
+  end
+
+  def self.value
+    @project
+  end
+
+  init
+
+  def self.debug?
+    value[:debug]
+  end
+
+  def self.name
+    value[:name]
+  end
+
+  def self.quiet?
+    return true if value[:options]["quiet"]
+    return true unless value[:verbose]
+
+    false
+  end
+
+  def self.verbose
+    value[:verbose]
+  end
+
+  ##
+  # Preprocess input options:
+  # * Convert input case options String to an Array of integers
+  # * Read color input option
+  def self.add_input_params(projectpath, options)
+    value[:options].merge! options
+    Rainbow.enabled = value[:options]["color"]
+
+    finder = NameFileFinder.new(value[:options])
+    finder.find_filenames_for(projectpath)
+    value[:project_path] = finder.project_path
+    value[:script_path] = finder.script_path
+    value[:config_path] = finder.config_path
+    value[:test_name] = finder.test_name
+
+    unless value[:options]["case"].nil?
+      numbers = value[:options]["case"].split(",")
+      value[:options]["case"] = numbers.collect!(&:to_i)
+    end
+  end
+end

data/lib/teuton/{case_manager/case → utils}/result/ext_array.rb

@@ -35,9 +35,9 @@ class Result
     @content.empty
   end
 
-  alias count! count
-  alias length count
-  alias len count
-  alias size count
-  alias empty? empty
+  alias_method :count!, :count
+  alias_method :length, :count
+  alias_method :len, :count
+  alias_method :size, :count
+  alias_method :empty?, :empty
 end

data/lib/teuton/{case_manager/case → utils}/result/result.rb

@@ -15,14 +15,19 @@ require_relative "ext_filter"
 # * value
 class Result
   attr_reader :content
-  attr_accessor :exitstatus
+  attr_accessor :exitcode
+  attr_writer :alterations
 
   def initialize
     reset
   end
 
   def alterations
-    @alterations.join(" & ")
+    if @alterations.is_a? String
+      @alterations
+    else
+      @alterations.join(" & ")
+    end
   end
 
   def content=(content)
@@ -47,17 +52,14 @@ class Result
   def reset
     @content_backup = []
     @content = []
-    @exitstatus = nil
+    @exitcode = -1
     @value = nil
     @expected = nil
     @alterations = []
   end
 
   def ok?
-    # REVISE THIS
-    return false if @exitstatus.nil?
-
-    @exitstatus.zero?
+    @exitcode.zero?
   end
 
   def restore
@@ -66,7 +68,7 @@ class Result
     @content_backup = temp
     @content = temp.clone
   end
-  alias restore! restore
+  alias_method :restore!, :restore
 
   def value
     @content[0]

data/lib/teuton/utils/settings.rb

@@ -0,0 +1,12 @@
+class Settings
+  def self.letter
+    {
+      good: ".",
+      bad: "F",
+      error: "?",
+      none: " ",
+      ok: "\u{2714}",
+      cross: "\u{2716}"
+    }
+  end
+end

data/lib/teuton/utils/verbose.rb

@@ -1,4 +1,4 @@
-require_relative "../application"
+require_relative "project"
 
 module Verbose
   def verboseln(text)
@@ -6,7 +6,7 @@ module Verbose
   end
 
   def verbose(text)
-    return if Application.instance.quiet?
+    return if Project.quiet?
 
     print text
   end

data/lib/teuton/version.rb

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

data/lib/teuton.rb

@@ -1,47 +1,48 @@
-require_relative "teuton/application"
+require_relative "teuton/utils/project"
 
 module Teuton
   def self.create(path_to_new_dir)
     require_relative "teuton/skeleton"
-    Skeleton.create(path_to_new_dir)
-  end
-
-  def self.run(projectpath, options = {})
-    Application.instance.add_input_params(projectpath, options)
-    require_dsl_and_script("teuton/case_manager/dsl") # Define DSL keywords
-  end
-
-  def self.readme(projectpath, options = {})
-    # Create Readme file for a teuton test
-    Application.instance.add_input_params(projectpath, options)
-    require_dsl_and_script("teuton/readme/readme") # Define DSL keywords
-
-    app = Application.instance
-    readme = Readme.new(app.script_path, app.config_path)
-    readme.show
+    Skeleton.new.create(path_to_new_dir)
   end
 
   def self.check(projectpath, options = {})
-    Application.instance.add_input_params(projectpath, options)
-    require_dsl_and_script("teuton/check/laboratory") # Define DSL keywords
-
-    app = Application.instance
-    lab = Laboratory.new(app.script_path, app.config_path)
-    if options[:onlyconfig]
+    Project.add_input_params(projectpath, options)
+    require_dsl_and_script("teuton/check/laboratory") # Define DSL
+    lab = Laboratory.new(
+      Project.value[:script_path],
+      Project.value[:config_path]
+    )
+    if options["onlyconfig"]
       lab.show_onlyconfig
     else
       lab.show
     end
   end
 
+  def self.run(projectpath, options = {})
+    # Application.instance.add_input_params(projectpath, options)
+    Project.add_input_params(projectpath, options)
+    require_dsl_and_script("teuton/case_manager/dsl") # Define DSL
+  end
+
+  def self.readme(projectpath, options = {})
+    Project.add_input_params(projectpath, options)
+    require_dsl_and_script("teuton/readme/readme") # Define DSL
+    readme = Readme.new(
+      Project.value[:script_path],
+      Project.value[:config_path]
+    )
+    readme.show
+  end
+
   private_class_method def self.require_dsl_and_script(dslpath)
-    app = Application.instance
     require_relative dslpath
     begin
-      require_relative app.script_path
-    rescue
+      require_relative Project.value[:script_path]
+    rescue => e
       warn e.to_s
-      warn Rainbow.new("[FAIL ] Reading file #{app.script_path}").red
+      warn Rainbow.new("[FAIL ] Reading file #{Project.value[:script_path]}").red
       warn Rainbow.new("[ERROR] Syntax Error!").red
       exit 1
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.7.0
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-05 00:00:00.000000000 Z
+date: 2023-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -132,10 +132,13 @@ extra_rdoc_files:
 - docs/changelog/v2.3.md
 - docs/changelog/v2.4.md
 - docs/changelog/v2.5.md
+- docs/changelog/v2.6.md
+- docs/changelog/v2.7.md
 - docs/changelog/version2.1.md
 - docs/commands/README.md
 - docs/commands/example_check.md
 - docs/commands/example_run.md
+- docs/diagram.md
 - docs/dsl/README.md
 - docs/dsl/expect.md
 - docs/dsl/export.md
@@ -199,10 +202,13 @@ files:
 - docs/changelog/v2.3.md
 - docs/changelog/v2.4.md
 - docs/changelog/v2.5.md
+- docs/changelog/v2.6.md
+- docs/changelog/v2.7.md
 - docs/changelog/version2.1.md
 - docs/commands/README.md
 - docs/commands/example_check.md
 - docs/commands/example_run.md
+- docs/diagram.md
 - docs/dsl/README.md
 - docs/dsl/expect.md
 - docs/dsl/export.md
@@ -255,39 +261,40 @@ files:
 - docs/learn/videos.md
 - docs/videos.md
 - lib/teuton.rb
-- lib/teuton/application.rb
-- lib/teuton/case_manager/case/builtin/main.rb
-- lib/teuton/case_manager/case/builtin/package.rb
-- lib/teuton/case_manager/case/builtin/service.rb
-- lib/teuton/case_manager/case/builtin/teuton_file.rb
-- lib/teuton/case_manager/case/builtin/teuton_host.rb
-- lib/teuton/case_manager/case/builtin/user.rb
-- lib/teuton/case_manager/case/case.rb
-- lib/teuton/case_manager/case/close.rb
-- lib/teuton/case_manager/case/config.rb
-- lib/teuton/case_manager/case/dsl/expect.rb
-- lib/teuton/case_manager/case/dsl/getset.rb
-- lib/teuton/case_manager/case/dsl/goto.rb
-- lib/teuton/case_manager/case/dsl/log.rb
-- lib/teuton/case_manager/case/dsl/macro.rb
-- lib/teuton/case_manager/case/dsl/main.rb
-- lib/teuton/case_manager/case/dsl/send.rb
-- lib/teuton/case_manager/case/dsl/target.rb
-- lib/teuton/case_manager/case/dsl/unique.rb
-- lib/teuton/case_manager/case/main.rb
-- lib/teuton/case_manager/case/play.rb
-- lib/teuton/case_manager/case/result/ext_array.rb
-- lib/teuton/case_manager/case/result/ext_compare.rb
-- lib/teuton/case_manager/case/result/ext_filter.rb
-- lib/teuton/case_manager/case/result/result.rb
-- lib/teuton/case_manager/case/runner.rb
+- lib/teuton/case/builtin/main.rb
+- lib/teuton/case/builtin/package.rb
+- lib/teuton/case/builtin/service.rb
+- lib/teuton/case/builtin/teuton_file.rb
+- lib/teuton/case/builtin/teuton_host.rb
+- lib/teuton/case/builtin/user.rb
+- lib/teuton/case/case.rb
+- lib/teuton/case/close.rb
+- lib/teuton/case/config.rb
+- lib/teuton/case/deprecated/runner.rb
+- lib/teuton/case/deprecated/utils.rb
+- lib/teuton/case/dsl/all.rb
+- lib/teuton/case/dsl/expect.rb
+- lib/teuton/case/dsl/getset.rb
+- lib/teuton/case/dsl/goto.rb
+- lib/teuton/case/dsl/log.rb
+- lib/teuton/case/dsl/macro.rb
+- lib/teuton/case/dsl/send.rb
+- lib/teuton/case/dsl/target.rb
+- lib/teuton/case/dsl/unique.rb
+- lib/teuton/case/execute/execute_base.rb
+- lib/teuton/case/execute/execute_local.rb
+- lib/teuton/case/execute/execute_manager.rb
+- lib/teuton/case/execute/execute_ssh.rb
+- lib/teuton/case/execute/execute_telnet.rb
+- lib/teuton/case/play.rb
 - lib/teuton/case_manager/case_manager.rb
 - lib/teuton/case_manager/check_cases.rb
 - lib/teuton/case_manager/dsl.rb
 - lib/teuton/case_manager/export_manager.rb
 - lib/teuton/case_manager/hall_of_fame.rb
-- lib/teuton/case_manager/main.rb
 - lib/teuton/case_manager/report.rb
+- lib/teuton/case_manager/send_manager.rb
+- lib/teuton/case_manager/show_report.rb
 - lib/teuton/case_manager/utils.rb
 - lib/teuton/check/builtin.rb
 - lib/teuton/check/dsl.rb
@@ -319,10 +326,16 @@ files:
 - lib/teuton/report/formatter/resume/txt.rb
 - lib/teuton/report/formatter/resume/yaml.rb
 - lib/teuton/report/report.rb
-- lib/teuton/report/show.rb
 - lib/teuton/skeleton.rb
+- lib/teuton/utils/application.rb
 - lib/teuton/utils/configfile_reader.rb
 - lib/teuton/utils/name_file_finder.rb
+- lib/teuton/utils/project.rb
+- lib/teuton/utils/result/ext_array.rb
+- lib/teuton/utils/result/ext_compare.rb
+- lib/teuton/utils/result/ext_filter.rb
+- lib/teuton/utils/result/result.rb
+- lib/teuton/utils/settings.rb
 - lib/teuton/utils/verbose.rb
 - lib/teuton/version.rb
 homepage: https://github.com/teuton-software/teuton

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

@@ -1,117 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../application"
-require_relative "../../report/report"
-require_relative "../../report/show"
-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
-
-# Case class
-# * initialize
-# * export
-# * filename
-# * grade
-# * members
-# * skip
-# * read_filename ???
-class Case
-  include DSL
-  include Utils
-
-  attr_accessor :result
-  attr_accessor :action # TODO: why not reader only???
-  attr_reader :id, :config, :uniques, :conn_status
-  attr_reader :skip
-  @@id = "01" # First case ID value
-
-  ##
-  # Initialize case from specified config
-  # @param config (Hash)
-  def initialize(config)
-    app = Application.instance
-    @config = Case::Config.new(local: config, global: app.global)
-    @groups = app.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?
-      @skip = true
-      @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)
-    # 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,
-      weight: 1.0,
-      description: "No description!",
-      groupname: nil
-    }
-    @uniques = []
-    @sessions = {} # Store opened sessions for this case
-    tempfile :default
-  end
-
-  def export(format)
-    return if skip?
-
-    @report.export format
-  end
-
-  def filename
-    @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
-
-  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