teuton 2.6.0 → 2.7.1

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/{result → 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

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.6.0"
+  VERSION = "2.7.1"
   APPNAME = "teuton"
   GEMNAME = "teuton"
   DOCKERNAME = "dvarrui/#{GEMNAME}"

data/lib/teuton.rb

@@ -1,18 +1,19 @@
-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)
+    Skeleton.new.create(path_to_new_dir)
   end
 
   def self.check(projectpath, options = {})
-    Application.instance.add_input_params(projectpath, options)
+    Project.add_input_params(projectpath, options)
     require_dsl_and_script("teuton/check/laboratory") # Define DSL
-
-    app = Application.instance
-    lab = Laboratory.new(app.script_path, app.config_path)
-    if options[:onlyconfig]
+    lab = Laboratory.new(
+      Project.value[:script_path],
+      Project.value[:config_path]
+    )
+    if options["onlyconfig"]
       lab.show_onlyconfig
     else
       lab.show
@@ -20,28 +21,28 @@ module Teuton
   end
 
   def self.run(projectpath, options = {})
-    Application.instance.add_input_params(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 = {})
-    # Create Readme file for a teuton test
-    Application.instance.add_input_params(projectpath, options)
+    Project.add_input_params(projectpath, options)
     require_dsl_and_script("teuton/readme/readme") # Define DSL
-
-    app = Application.instance
-    readme = Readme.new(app.script_path, app.config_path)
+    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
-      warn e.to_s
-      warn Rainbow.new("[FAIL ] Reading file #{app.script_path}").red
+      require_relative Project.value[:script_path]
+    rescue => e
+      warn e
+      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.6.0
+  version: 2.7.1
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-10 00:00:00.000000000 Z
+date: 2023-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -133,6 +133,7 @@ extra_rdoc_files:
 - 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
@@ -202,6 +203,7 @@ files:
 - 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
@@ -259,7 +261,6 @@ files:
 - docs/learn/videos.md
 - docs/videos.md
 - lib/teuton.rb
-- lib/teuton/application.rb
 - lib/teuton/case/builtin/main.rb
 - lib/teuton/case/builtin/package.rb
 - lib/teuton/case/builtin/service.rb
@@ -269,7 +270,9 @@ files:
 - lib/teuton/case/case.rb
 - lib/teuton/case/close.rb
 - lib/teuton/case/config.rb
-- lib/teuton/case/dsl.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
@@ -278,8 +281,13 @@ files:
 - lib/teuton/case/dsl/send.rb
 - lib/teuton/case/dsl/target.rb
 - lib/teuton/case/dsl/unique.rb
+- lib/teuton/case/execute/copy_ssh.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/runner.rb
 - lib/teuton/case_manager/case_manager.rb
 - lib/teuton/case_manager/check_cases.rb
 - lib/teuton/case_manager/dsl.rb
@@ -319,13 +327,16 @@ files:
 - lib/teuton/report/formatter/resume/txt.rb
 - lib/teuton/report/formatter/resume/yaml.rb
 - lib/teuton/report/report.rb
-- lib/teuton/result/ext_array.rb
-- lib/teuton/result/ext_compare.rb
-- lib/teuton/result/ext_filter.rb
-- lib/teuton/result/result.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/dsl.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "dsl/expect"
-require_relative "dsl/getset"
-require_relative "dsl/goto"
-require_relative "dsl/log"
-require_relative "dsl/macro"
-require_relative "dsl/send"
-require_relative "dsl/target"
-require_relative "dsl/unique"