teuton 2.1.11 → 2.2.2

data/lib/teuton/{project/laboratory → check}/show.rb

@@ -1,8 +1,8 @@
 require 'terminal-table'
 require 'rainbow'
 
-require_relative '../../application'
-require_relative '../configfile_reader'
+require_relative '../application'
+require_relative '../utils/configfile_reader'
 
 # Laboratory
 # * show_dsl
@@ -10,68 +10,23 @@ require_relative '../configfile_reader'
 # * show_config
 class Laboratory
   ##
-  # Display DSL on screen
-  def show_dsl
+  # Display DSL checking on screen
+  def show
     @verbose = true
     process_content
     show_stats
-    show_config
-  end
-
-  ##
-  # Display stats on screen
-  def show_stats
-    @stats[:hosts] = 0
-    @hosts.each_pair { |_k, v| @stats[:hosts] += v }
-
-    my_screen_table = Terminal::Table.new do |st|
-      st.add_row ['DSL Stats', 'Count']
-      st.add_separator
-      st.add_row ['Groups', @stats[:groups]]
-      st.add_row ['Targets', @stats[:targets]]
-      st.add_row ['Goto', @stats[:hosts]]
-      @hosts.each_pair { |k, v| st.add_row [" * #{k}", v] }
-      st.add_row ['Uniques', @stats[:uniques]]
-      st.add_row ['Logs', @stats[:uniques]]
-      st.add_row [' ', ' ']
-
-      st.add_row ['Gets', @stats[:gets]]
-      if @gets.count > 0
-        list = @gets.sort_by { |_k, v| v }
-        list.reverse_each { |item| st.add_row [" * #{item[0]}", item[1].to_s] }
-      end
-
-      st.add_row ['Sets', @stats[:sets]]
-      if @sets.count > 0
-        @sets.each_pair { |k, v| st.add_row [" * #{k}", v.to_s] }
-      end
-    end
-    verboseln my_screen_table.to_s + "\n"
+    revise_config_content
   end
 
   ##
-  # Display config on screen
-  def show_config
+  # Display config for teuton panel on screen
+  def show_panelconfig
     @verbose = false
     process_content
     @verbose = true
-    revise_config_content
+    recomended_panelconfig_content
   end
 
-#  def show_requests
-#    @verbose = false
-#    process_content
-#    @verbose = true
-#    my_screen_table = Terminal::Table.new do |st|
-#      st.add_row ['Lines', 'REQUEST description']
-#      st.add_separator
-#      @requests.each_with_index do |line, index|
-#        st.add_row ['%03d' % index, line]
-#      end
-#    end
-#    verboseln my_screen_table
-#  end
-
   private
 
   def verbose(text)
@@ -84,14 +39,16 @@ class Laboratory
 
   def process_content
     groups = Application.instance.groups
+    option = Application.instance.options
+
     verboseln ''
     groups.each do |t|
       @stats[:groups] += 1
-
-      msg = "GROUP: #{t[:name]}"
-      my_screen_table = Terminal::Table.new { |st| st.add_row [msg] }
-      verboseln my_screen_table
-
+      unless option[:panel]
+        msg = "GROUP: #{t[:name]}"
+        my_screen_table = Terminal::Table.new { |st| st.add_row [msg] }
+        verboseln my_screen_table
+      end
       instance_eval(&t[:block])
     end
   end
@@ -127,10 +84,16 @@ class Laboratory
     verboseln YAML.dump(output)
   end
 
+  def recomended_panelconfig_content
+    output = { global: {}, cases: nil }
+    script_vars = find_script_vars
+    script_vars.each { |i| output[:global][i] = 'VALUE' }
+    verboseln YAML.dump(output)
+  end
+
   ##
   # Revive and check config content
   def revise_config_content
-    @verbose = true
     my_screen_table = Terminal::Table.new do |st|
       st.add_row ['Revising CONFIG file']
     end
@@ -166,4 +129,35 @@ class Laboratory
       end
     end
   end
+
+  ##
+  # Display stats on screen
+  def show_stats
+    @stats[:hosts] = 0
+    @hosts.each_pair { |_k, v| @stats[:hosts] += v }
+
+    my_screen_table = Terminal::Table.new do |st|
+      st.add_row ['DSL Stats', 'Count']
+      st.add_separator
+      st.add_row ['Groups', @stats[:groups]]
+      st.add_row ['Targets', @stats[:targets]]
+      st.add_row ['Goto', @stats[:hosts]]
+      @hosts.each_pair { |k, v| st.add_row [" * #{k}", v] }
+      st.add_row ['Uniques', @stats[:uniques]]
+      st.add_row ['Logs', @stats[:uniques]]
+      st.add_row [' ', ' ']
+
+      st.add_row ['Gets', @stats[:gets]]
+      if @gets.count > 0
+        list = @gets.sort_by { |_k, v| v }
+        list.reverse_each { |item| st.add_row [" * #{item[0]}", item[1].to_s] }
+      end
+
+      st.add_row ['Sets', @stats[:sets]]
+      if @sets.count > 0
+        @sets.each_pair { |k, v| st.add_row [" * #{k}", v.to_s] }
+      end
+    end
+    verboseln my_screen_table.to_s + "\n"
+  end
 end

data/lib/teuton/cli.rb

@@ -1,39 +1,110 @@
+
 require 'thor'
-require_relative 'application'
-require_relative 'project/project'
-require_relative 'project/skeleton.rb'
-require_relative 'cli/main'
+require_relative 'version'
+require_relative '../teuton'
 
-##
-# Command Line User Interface
 class CLI < Thor
   map ['h', '-h', '--help'] => 'help'
 
-  map ['c', '-c', '--create', 'create'] => 'new'
+  map ['v', '-v', '--version'] => 'version'
+  desc 'version', 'Show the program version'
+  def version
+    puts "#{Teuton::APPNAME} (version #{Teuton::VERSION})"
+  end
+
+  map ['n', '-n', '--new'] => 'new'
   desc 'new DIRECTORY', 'Create skeleton for a new project'
   long_desc <<-LONGDESC
   Create files for a new project.
+  LONGDESC
+  def new(projectpath)
+    Teuton.create(projectpath)
+  end
+
+  map ['c', '-c', '--check'] => 'check'
+  option :panelconfig, type: :boolean
+  option :cname, type: :string
+  option :cpath, type: :string
+  desc 'check [OPTIONS] DIRECTORY',
+       'Check test and config file content'
+  long_desc <<-LONGDESC
+
+  (1) teuton check path/to/dir/foo
+  , Check content of start.rb and config.yaml files.
 
-  Example:
+  (2) teuton check path/to/dir/foo --cname=demo
+  , Check content of start.rb and demo.yaml files.
+
+  (3) teuton check path/to/file/foo.rb
+  , Check content of foo.rb and foo.yaml files.
+
+  (4) teuton check path/to/file/foo.rb --cname=demo
+  , Check content of foo.rb and demo.yaml files.
 
-  #{$PROGRAM_NAME} create dir/foo
   LONGDESC
-  ##
-  # Command: create new Teuton project
-  def new(path_to_new_dir)
-    Skeleton.create(path_to_new_dir)
+  def check(projectpath)
+    Teuton.check(projectpath, options)
+  end
+
+  map ['--run', 'run'] => 'play'
+  option :export, type: :string
+  option :cname, type: :string
+  option :cpath, type: :string
+  option :case, type: :string
+  option :color, type: :boolean
+  option :quiet, type: :boolean
+  desc '[run] [OPTIONS] DIRECTORY',
+       'Run test from directory'
+  long_desc <<-LONGDESC
+  This function execute challenge from specified directory.
+  By default, show progress on the screen.
+
+  Let's see others options:
+
+  (1) teuton foo, run challenge from foo/start.rb with foo/config.yaml config file.
+
+  (2) teuton run foo, same as (1).
+
+  (3) teuton run --export=json foo, run challenge and export using json format.
+  Others output formats availables are: txt, html, yaml, json and colored_text.
+
+  (4) teuton run --cname=demo foo, run challenge from foo/start.rb with foo/demo.yaml config file.
+
+  (5) teuton foo/demo.rb, Run challenge from foo/demo.rb with foo/demo.yaml config file.
+
+  LONGDESC
+  def play(filepath)
+    Teuton.run(filepath, options)
+  end
+
+  map ['--readme'] => 'readme'
+  option :lang, type: :string
+  desc 'readme DIRECTORY',
+       'Show README extracted from test contents'
+  long_desc <<-LONGDESC
+
+  (1) teuton readme foo
+  , Create README.md from foo/start.rb.
+
+  (2) teuton readme foo/demo.rb
+  , Create README.md from foo/demo.rb.
+  LONGDESC
+
+  def readme(projectpath)
+    # Create README from teuton test
+    Teuton.readme(projectpath, options)
   end
 
   ##
   # These inputs are equivalents:
   # * teuton dir/foo
   # * teuton run dir/foo
-  # * teuton play dir/foo
   def method_missing(method, *_args, &_block)
     play(method.to_s)
   end
 
   def respond_to_missing?(method_name, include_private = false)
+    # Respond to missing methods name
     super
   end
 end

data/lib/teuton/{project/readme → readme}/lang.rb

@@ -1,5 +1,5 @@
 
-require_relative '../../application'
+require_relative '../application'
 
 module Lang
   def self.get(key)

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../../application'
-require_relative '../configfile_reader'
-require_relative '../../case_manager/case/result/result'
+require_relative '../application'
+require_relative '../utils/configfile_reader'
+require_relative '../case_manager/case/result/result'
 require_relative 'dsl'
 require_relative 'lang'
 
@@ -44,6 +44,19 @@ class Readme
     reset
   end
 
+  ##
+  # Show README on screen
+  def show
+    process_content
+    show_head
+    show_content
+    show_tail
+  end
+
+  private
+
+  ##
+  # Reset attributes
   def reset
     app = Application.instance
     @config = ConfigFileReader.read(app.config_path)
@@ -73,13 +86,6 @@ class Readme
     @action = { readme: [] }
   end
 
-  def show
-    process_content
-    show_head
-    show_content
-    show_tail
-  end
-
   ##
   # Show README head
   def show_head
@@ -97,23 +103,21 @@ class Readme
       puts Lang::get(:hosts)
       puts "\n"
       puts '| ID | Host | Configuration |'
-      puts '| -- | ---- | ------------- |'
+      puts '| --- | --- | --- |'
       @required_hosts.each_pair do |k, v|
         c = []
         v.each_pair { |k2,v2| c << "#{k2}=#{v2}" }
-        puts "|#{i}|#{k.upcase}|#{c.join(', ')}|"
+        puts "| #{i} | #{k.upcase} | #{c.join(', ')} |"
         i += 1
       end
       puts "\n> NOTE: SSH Service installation is required on every host."
     end
 
     unless @cases_params.empty?
-      @cases_params.uniq!.sort!
+      @cases_params.sort!
       puts Lang::get(:params)
       @cases_params.uniq.each { |i| puts format('* %s', i) }
-      puts "\n> NOTE:"
-      puts "> * Teuton software must known this information!"
-      puts "> * Save every ':param: value' into config file."
+      puts "\n> NOTE: Save every ':param: value' into config file."
     end
   end
 
@@ -156,13 +160,13 @@ class Readme
     puts Lang::get(:global)
     puts "\n"
     puts '| Global param | Value |'
-    puts '| ------------ | ----- |'
+    puts '| --- | --- |'
     @global_params.each_pair { |k,v| puts "|#{k}|#{v}|" }
     puts "\n\#\# Created params"
     puts Lang::get(:created)
     puts "\n"
     puts '| Created params | Value |'
-    puts '| -------------- | ----- |'
+    puts '| --- | --- |'
     @setted_params.each_pair { |k,v| puts "|#{k}|#{v}|" }
   end
 end

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

@@ -2,13 +2,19 @@
 
 require_relative 'base_formatter'
 
+##
 # ArrayFormatter class: format report data into an array
 class ArrayFormatter < BaseFormatter
+  ##
+  # Initialize class
+  # @param report (Report) Format report data into Array
   def initialize(report)
     super(report)
     @data = {}
   end
 
+  ##
+  # Execute format action
   def process
     build_data
     w @data.to_s # Write data into ouput file
@@ -28,6 +34,8 @@ class ArrayFormatter < BaseFormatter
     @data[:config] = head
   end
 
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
   def build_history_data
     @data[:logs] = []
     groups = []
@@ -46,7 +54,8 @@ class ArrayFormatter < BaseFormatter
         end
 
         target = {}
-        target[:target_id]   = format('%02d', i[:id])
+        # target[:target_id]   = format('%02d', i[:id])
+        target[:target_id]   = format('%<id>02d', id: i[:id])
         target[:check]       = i[:check]
         target[:score]       = value
         target[:weight]      = i[:weight]
@@ -66,6 +75,8 @@ class ArrayFormatter < BaseFormatter
     groups << { title: title, targets: targets } unless title.nil?
     @data[:groups] = groups
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
 
   def build_final_data
     tail = {}
@@ -77,6 +88,7 @@ class ArrayFormatter < BaseFormatter
     app = Application.instance
     @data[:hall_of_fame] = {}
     return if app.options[:case_number] < 3
+
     fame = {}
     app.hall_of_fame.each { |line| fame[line[0]] = line[1] }
     @data[:hall_of_fame] = fame

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,12 +20,11 @@ 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' },
       { source: 'files/start.rb', target: 'start.rb' }
-      # { source: 'files/gitignore', target: '.gitignore' }
     ]
     items.each do |item|
       source = File.join(source_basedir, item[:source])
@@ -43,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
@@ -56,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
@@ -80,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