teuton 2.1.10 → 2.3.1

data/lib/teuton/report/formatter/base_formatter.rb

@@ -2,25 +2,38 @@
 
 # BaseFormatter class
 class BaseFormatter
+  ##
+  # Initialize class
+  # @param report (Report) Format report data
   def initialize(report)
     @head = report.head
     @lines = report.lines
     @tail = report.tail
   end
 
+  ##
+  # Execute format action
+  def process
+    raise 'Empty method!'
+  end
+
+  ##
+  # Creates new output file
+  # @param filename (String) Path to output file
   def init(filename)
     @filename = filename
     @file = File.open(@filename, 'w')
   end
 
+  ##
+  # Write data into output file
+  # @param text (String) Text data to write into output file
   def w(text)
-    @file.write text.to_s # write into output file
-  end
-
-  def process
-    raise 'Empty method!'
+    @file.write text.to_s
   end
 
+  ##
+  # Close open output file
   def deinit
     @file.close
   end

data/lib/teuton/{project/skeleton.rb → skeleton.rb}

@@ -3,13 +3,7 @@
 require 'fileutils'
 require 'rainbow'
 
-# Skeleton class
-# * create
-# * create_main_dir_and_files
-# * create_assets_dir_and_files
-# * create_dir
-# * create_dirs
-# * copyfile
+# Skeleton module
 module Skeleton
   ##
   # Create teuton project skeleton
@@ -17,7 +11,7 @@ module Skeleton
   def self.create(project_dir)
     project_name = File.basename(project_dir)
     puts "\n[INFO] Creating #{Rainbow(project_name).bright} project skeleton"
-    source_basedir = File.join(File.dirname(__FILE__), '..')
+    source_basedir = File.dirname(__FILE__)
     create_dir project_dir
     create_main_dir_and_files(project_dir, source_basedir)
   end
@@ -26,7 +20,7 @@ module Skeleton
   # Create main dir and files
   # @param project_dir (String)
   # @param source_basedir (String)
-  def self.create_main_dir_and_files(project_dir, source_basedir)
+  private_class_method def self.create_main_dir_and_files(project_dir, source_basedir)
     # Directory and files: Ruby script, Configfile, gitignore
     items = [
       { source: 'files/config.yaml', target: 'config.yaml' },
@@ -42,7 +36,7 @@ module Skeleton
   ##
   # Create dir
   # @param dirpath (String)
-  def self.create_dir(dirpath)
+  private_class_method def self.create_dir(dirpath)
     if Dir.exist? dirpath
       puts "* Exists dir!       => #{Rainbow(dirpath).yellow}"
     else
@@ -55,18 +49,12 @@ module Skeleton
     end
   end
 
-  ##
-  # Create dirs
-  # @param args (Array)
-  def self.create_dirs(*args)
-    args.each { |arg| create_dir arg }
-  end
-
   ##
   # Copy file
   # @param source (String) Source file
   # @param dest (String) Dest file
-  def self.copyfile(source, dest)
+  # rubocop:disable Metrics/MethodLength
+  private_class_method def self.copyfile(source, dest)
     if File.exist? dest
       puts "* Exists file!      => #{Rainbow(dest).yellow}"
     else
@@ -79,4 +67,5 @@ module Skeleton
       end
     end
   end
+  # rubocop:enable Metrics/MethodLength
 end

data/lib/teuton/utils/configfile_reader.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'json/pure'
+
+##
+# Functions that read data from ConfigFile using YAML or JSON formats
+module ConfigFileReader
+  ##
+  # Read config file
+  # @param filepath (String) Path to config file
+  # @return Hash with config data
+  def self.read(filepath)
+    unless File.exist?(filepath)
+      data = {}
+      data[:global] = {}
+      data[:alias] = {}
+      data[:cases] = [{ tt_members: 'anonymous' }]
+      return data
+    end
+    return read_yaml(filepath) if File.extname(filepath) == '.yaml'
+
+    return read_json(filepath) if File.extname(filepath) == '.json'
+
+    raise "[ERROR] ConfigFileReader: #{filepath}"
+  end
+
+  ##
+  # Read YAML config file
+  # @param filepath (String) Path to YAML config file
+  # @return Hash with config data
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Security/YAMLLoad
+  def self.read_yaml(filepath)
+    begin
+      data = YAML.load(File.open(filepath))
+    rescue StandardError => e
+      puts "\n" + ('=' * 80)
+      puts "[ERROR] ConfigFileReader#read <#{filepath}>"
+      puts '        I suggest to revise file format!'
+      puts "        #{e.message}\n" + ('=' * 80)
+      raise "[ERROR] ConfigFileReader <#{e}>"
+    end
+    data = convert_string_keys_to_symbol(data)
+    data[:global] = data[:global] || {}
+    data[:alias] = data[:alias] || {}
+    data[:cases] = data[:cases] || []
+    read_included_files!(filepath, data)
+    data
+  end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Security/YAMLLoad
+
+  ##
+  # Read JSON config file
+  # @param filepath (String) Path to JSON config file
+  # @return Hash with config data
+  def self.read_json(filepath)
+    data = JSON.parse(File.read(filepath), symbolize_names: true)
+    data = convert_string_keys_to_symbol(data)
+    data[:global] = data[:global] || {}
+    data[:alias] = data[:alias] || {}
+    data[:cases] = data[:cases] || []
+    read_included_files!(filepath, data)
+    data
+  end
+
+  ##
+  # Read all configuration files from "filepath" folder.
+  # @param filepath (String) Folder with config files
+  # @param data (Hash) Input configuration
+  # rubocop:disable Security/YAMLLoad
+  private_class_method def self.read_included_files!(filepath, data)
+    return if data[:global][:tt_include].nil?
+
+    include_dir = data[:global][:tt_include]
+    if include_dir == File.absolute_path(include_dir)
+      basedir = include_dir
+    else
+      basedir = File.join(File.dirname(filepath), data[:global][:tt_include])
+    end
+    files = Dir.glob(File.join(basedir, '**/*.yaml'))
+    files += Dir.glob(File.join(basedir, '**/*.yml'))
+    files.each { |file|
+      begin
+        data[:cases] << YAML.load(File.open(file))
+      rescue StandardError => e
+        puts "\n" + ('=' * 80)
+        puts "[ERROR] ConfigFileReader#read <#{file}>"
+        puts '        I suggest to revise file format!'
+        puts "        #{e.message}\n" + ('=' * 80)
+      end
+    }
+  end
+  # rubocop:enable Security/YAMLLoad
+
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
+  private_class_method def self.convert_string_keys_to_symbol(input)
+    return input if input.class != Hash
+
+    output = {}
+    input.each_pair do |key, value|
+      key2 = key
+      key2 = key.to_sym if key.class
+      value2 = value
+      if value.class == Hash
+        value2 = convert_string_keys_to_symbol(value)
+      elsif value.class == Array
+        value2 = []
+        value.each { |i| value2 << convert_string_keys_to_symbol(i) }
+      end
+      output[key2] = value2
+    end
+    output
+  end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
+end

data/lib/teuton/{project → utils}/name_file_finder.rb

@@ -3,8 +3,9 @@
 require 'rainbow'
 require_relative '../application'
 
-# Project:
-# * find_filenames_for, verbose, verboseln
+##
+# NameFileFinder module
+# Methods: find_filenames_for, verbose, verboseln
 module NameFileFinder
   ##
   # Find project filenames from input project relative path
@@ -28,6 +29,8 @@ module NameFileFinder
   ##
   # Find project filenames from input folder path
   # @param folder_path (String)
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
   def self.find_filenames_from_directory(folder_path)
     # COMPLEX MODE: We use start.rb as main RB file
     script_path = File.join(folder_path, 'start.rb')
@@ -45,15 +48,20 @@ module NameFileFinder
 
     find_configfilename_from_directory(folder_path)
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
 
   ##
   # Find project config filename from input folder path
   # @param folder_path (String)
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Style/IfUnlessModifier
   def self.find_configfilename_from_directory(folder_path)
     # COMPLEX MODE: We use config.yaml by default
     app = Application.instance
-
     config_path = ''
+
     if app.options['cpath'].nil?
       config_name = 'config'
       # Config name file is introduced by cname arg option from teuton command
@@ -68,7 +76,12 @@ module NameFileFinder
     end
     app.config_path = config_path
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Style/IfUnlessModifier
 
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
   def self.find_filenames_from_rb(script_path)
     # SIMPLE MODE: We use script_path as main RB file
     # This must be fullpath to DSL script file
@@ -86,7 +99,12 @@ module NameFileFinder
 
     find_configfilenames_from_rb(script_path)
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
 
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Style/IfUnlessModifier
   def self.find_configfilenames_from_rb(script_path)
     # SIMPLE MODE: We use script_path as main RB file
     # This must be fullpath to DSL script file
@@ -108,32 +126,33 @@ module NameFileFinder
     end
     app.config_path = config_path
   end
-
-  def self.puts_input_info_on_screen
-    app = Application.instance
-
-    verbose Rainbow('[INFO] ScriptPath => ').blue
-    verboseln Rainbow(trim(app.script_path)).blue.bright
-    verbose Rainbow('[INFO] ConfigPath => ').blue
-    verboseln Rainbow(trim(app.config_path)).blue.bright
-    verbose Rainbow('[INFO] Pwd        => ').blue
-    verboseln Rainbow(app.running_basedir).blue.bright
-    verbose Rainbow('[INFO] TestName   => ').blue
-    verboseln Rainbow(trim(app.test_name)).blue.bright
-  end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Style/IfUnlessModifier
+
+  #  def self.puts_input_info_on_screen
+  #    app = Application.instance
+  #
+  #    verbose Rainbow('[INFO] ScriptPath => ').blue
+  #    verboseln Rainbow(trim(app.script_path)).blue.bright
+  #    verbose Rainbow('[INFO] ConfigPath => ').blue
+  #    verboseln Rainbow(trim(app.config_path)).blue.bright
+  #    verbose Rainbow('[INFO] Pwd        => ').blue
+  #    verboseln Rainbow(app.running_basedir).blue.bright
+  #    verbose Rainbow('[INFO] TestName   => ').blue
+  #    verboseln Rainbow(trim(app.test_name)).blue.bright
+  #  end
 
   ##
   # Trim string text when is too long
-  # @param input (String)
-  # @return String
-  def self.trim(input)
-    return input unless input.to_s.start_with? Dir.pwd.to_s
-
-    output = input.to_s
-    offset = (Dir.pwd).length + 1
-    output = "#{input[offset, input.size]}"
-    output.to_s
-  end
+  #  def self.trim(input)
+  #    return input unless input.to_s.start_with? Dir.pwd.to_s
+  #
+  #    output = input.to_s
+  #    offset = (Dir.pwd).length + 1
+  #    output = "#{input[offset, input.size]}"
+  #    output.to_s
+  #  end
 
   def self.verboseln(text)
     verbose(text + "\n")
@@ -142,6 +161,7 @@ module NameFileFinder
   def self.verbose(text)
     return unless Application.instance.verbose
     return if Application.instance.options['quiet']
+
     print text
   end
 end

data/lib/teuton/version.rb

@@ -0,0 +1,8 @@
+
+module Teuton
+  VERSION = '2.3.1'
+  APPNAME = 'teuton'
+  GEMNAME = 'teuton'
+  DOCKERNAME = "dvarrui/#{GEMNAME}"
+  HOMEPAGE = "https://github.com/teuton-software/teuton"
+end

data/lib/teuton.rb

@@ -1,47 +1,54 @@
+# frozen_string_literal: true
+
 require_relative 'teuton/application'
-require_relative 'teuton/project/project'
-require_relative 'teuton/project/skeleton'
+require_relative 'teuton/skeleton'
 
-##
-# Main Teuton functions
 module Teuton
-  ##
-  # Create new Teuton project
   def self.create(path_to_new_dir)
     Skeleton.create(path_to_new_dir)
   end
 
-  ##
-  # Play (run) Teuton project.
-  # @param path_to_rb_file [String] Path to main rb file.
-  # @param options [Hash] Options like
-  # * :export [String]
-  # * :cname [String]
-  # * :cpath [String]
-  # * :case [String]
-  # * :quiet [Boolean]
-  def self.play(path_to_rb_file, options = {})
-    Project.play(path_to_rb_file, options)
+  # Run test
+  # @param projectpath (String) Path to teuton test
+  # @param options (Array) Array of input options
+  def self.run(projectpath, options = {})
+    Application.instance.add_input_params(projectpath, options)
+    require_dsl_and_script('teuton/case_manager/dsl') # Define DSL keywords
   end
 
-  ##
-  # Generate readme for Teuton project.
-  # @param path_to_rb_file [String] Path to main rb file.
-  def self.readme(path_to_rb_file)
-    Project.readme(path_to_rb_file, options)
+  # Create Readme file for a test
+  # @param projectpath (String) Path to teuton test
+  # @param options (Array) Array of input options
+  def self.readme(projectpath, options = {})
+    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
   end
 
-  ##
-  # Simulate play Teuton project, check syntax and display stats.
-  # @param path_to_rb_file [String] Path to main rb file.
-  def self.check(path_to_rb_file)
-    Project.check(path_to_rb_file, options)
+  # Check teuton test syntax
+  # @param projectpath (String) Path to teuton test
+  # @param options (Array) Array of input options
+  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)
+    lab.show unless options[:panelconfig]
+    lab.show_panelconfig if options[:panelconfig]
   end
 
-  ##
-  # Display Teuton version
-  def self.version
-    print Rainbow(Application::NAME).bright.blue
-    puts  ' (version ' + Rainbow(Application::VERSION).green + ')'
+  private_class_method def self.require_dsl_and_script(dslpath)
+    app = Application.instance
+    require_relative dslpath
+    begin
+      require_relative app.script_path
+    rescue SyntaxError => e
+      puts e.to_s
+      puts Rainbow.new("[ FAIL ] SyntaxError into file #{app.script_path}").red
+    end
   end
 end