teuton 2.9.4 → 2.9.6

data/docs/install/t-node.md

@@ -30,7 +30,7 @@ Option B:
 
 If you don't know how to install Ruby on your system, execute this script to run automatical installation for your OS.
 
-**T-node GNU/Linux installation**
+**GNU/Linux installation**
 
 Run this command as `root` user:
 
@@ -38,7 +38,7 @@ Run this command as `root` user:
 wget -qO- https://raw.githubusercontent.com/teuton-software/teuton/master/install/linux/t-node_install.sh | bash
 ```
 
-**T-node Windows installation**
+**Windows installation**
 
 Requirements:
 * Windows 7+ / Windows Server 2003+
@@ -50,7 +50,7 @@ Run this command on **PowerShell (PS)** as `Administrator` user:
 Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/teuton-software/teuton/master/install/windows/t-node_install.ps1'))
 ```
 
-**T-node Mac OS X installation**
+**Mac OS X installation**
 
 Run this command as admin user (member of `admin` group):
 
@@ -58,14 +58,83 @@ Run this command as admin user (member of `admin` group):
 curl -sL https://raw.githubusercontent.com/teuton-software/teuton/master/install/mac/t-node_install.sh | bash
 ```
 
-# 4. Vagrant/Docker
+# 4. Vagrant and Docker installation
 
 Choose this way if you plan to install Teuton into virtual machines or containers, and you are familiar with Vagrant and Docker technologies.
 
-[Installation using Vagrant or Docker](vagrant_docker.md)
+## 4.1 Install using Vagrant
+
+* First, install `Vagrant` and `VirtualBox` on your host.
+* Create directory for vagrant project. For example, `mkdir teuton-vagrant`.
+* Move into that directory: `cd teuton-vagrant`.
+* Choose and download [Vagrantfile](../../install/vagrant).
+* Run `vagrant up` to create your Virtual Machine.
+
+## 4.2 Install using Docker
+
+First:
+* Install `docker` on your host.
+
+Second, choose:
+* Pulling docker image from remote or
+* Rebuild local docker image.
+
+## 4.2 Pulling docker images from remote
+
+Run this command to pull **dvarrui/teuton** image from Docker Hub and create "teuton" container:
+
+`docker run --name teuton -v /home/teuton -i -t dvarrui/teuton /bin/bash`
+
+## 4.2 Rebuild local docker image
+
+1. Create Dockerfile like this:
+
+```
+FROM debian:latest
+
+MAINTAINER teuton 2.1
+
+RUN apt-get update
+RUN apt-get install -y apt-utils
+RUN apt-get install -y vim tree
+RUN apt-get install -y ruby
+RUN gem install teuton
+RUN mkdir /home/teuton
+
+EXPOSE 80
+
+WORKDIR /home/teuton
+CMD ["/bin/bash"]
+```
+
+1. Build local docker image **dvarrui/teuton** with `docker build -t dvarrui/teuton .`
+1. Create **teuton** container with `docker run --name teuton -v /home/teuton -i -t dvarrui/teuton /bin/bash`.
+
+> Notice `/home/teuton` folder is persistent volume.
 
 # 5. Source code
 
 If you want to install Teuton by your own, or there are not installation scripts for your OS, and you don't want to use Vagrant then... here you have information how to install all the required packages for Teuton.
 
-[Manual installation](manual.md)
+Manual installation:
+1. Git installation
+    * Install Git.
+    * Run `git --version` to show current version
+1. Ruby installation
+    * Install ruby.
+    * Run `ruby -v` to show current version (2.1.3p242+)
+1. Rake installation
+    * Run `gem install rake`, then
+    * `rake --version` to show current version (10.4.2+).
+1. Download this project
+    * (a) `git clone https://github.com/dvarrui/teuton.git` or
+    * (b) Download and unzip [file](https://github.com/dvarrui/teuton-panel/archive/master.zip).
+1. Move into Teuton folder
+    * Run `cd teuton`
+1. Gems installation.
+    * `rake install:gems`, to install required gems.
+1. Only for developers
+    * Run `rake install:debian` or
+    * `rake install:opensuse`, install gem for developers.
+1. Final check
+    * `rake`

data/docs/learn/02-target.md

@@ -2,10 +2,11 @@
 
 # target
 
-A [target](../dsl/target.md) is a feature you want to check. Targets are defined into `group` sections and every evaluation has 3 parts:
+A [target](../dsl/target.md) is a feature you want to check. Targets are defined into `group` sections.
 
 ## Target definition
 
+Every evaluation has 3 parts:
 * [target](dsl/target.md): Description of the element to be tested.
 * [run](../dsl/run.md): Execute a command `id obiwan` on localhost.
 * [expect](../dsl/expect.md): Verify that the result contains expected value.
@@ -32,7 +33,7 @@ When the user exists, we expect this words: `uid=, (obiwan), gid=`.
 uid=1000(obiwan) gid=1000(obiwan) grupos=1000(obiwan)
 ```
 
-But when user does not exist, we expect different words: `id:, vader, no exist`.
+But when user does not exist, we expect command fail.
 
 ```
 > id vader

data/lib/teuton/case/config.rb

@@ -55,7 +55,7 @@ class Case
       key2 = @ialias[words[0].to_sym]
       return "NODATA" unless key2
 
-      get("#{key2}_#{words[1]}".to_sym, level)
+      get(:"#{key2}_#{words[1]}", level)
     end
 
     def search_array_alias(keys, level)

data/lib/teuton/case/dsl/expect.rb

@@ -23,7 +23,7 @@ module DSL
     @action_counter += 1
     @action[:id] = @action_counter
     if @result.exitcode < 0
-      # When exitcode is less than zero, it is because there has been 
+      # When exitcode is less than zero, it is because there has been
       # an error in the remote connection (SSH or Telnet)
       @action[:check] = false
       @action[:result] = @action[:output]

data/lib/teuton/case/dsl/expect_sequence.rb

@@ -38,8 +38,8 @@ class ExpectSequence
 
   def find_best_state
     @states.each do |state|
-      state[:score] = (state[:steps].select { _1 }).size
-      state[:fails] = (state[:steps].select { !_1 }).size
+      state[:score] = state[:steps].select { it }.size
+      state[:fails] = state[:steps].select { !it }.size
       state[:ok] = (state[:fails] == 0)
     end
     best = @states[0]

data/lib/teuton/case/dsl/run_script.rb

@@ -5,7 +5,7 @@ module DSL
   def run_script(script, args = {})
     items = script.split(" ")
     if items.size == 1
-      shell = args[:shell] || (get(:shell) != "NODATA" ? get(:shell) : nil)
+      shell = args[:shell] || ((get(:shell) != "NODATA") ? get(:shell) : nil)
       script = "#{shell} #{script}" if shell
       script = "#{script} #{args[:args]} " if args[:args]
     end

data/lib/teuton/case/dsl/unique.rb

@@ -4,6 +4,6 @@ module DSL
   def unique(key, value)
     return if value.nil?
 
-    @uniques << "#{key}=#{value}".to_sym
+    @uniques << :"#{key}=#{value}"
   end
 end

data/lib/teuton/case/execute/execute_base.rb

@@ -41,8 +41,8 @@ class ExecuteBase
 
     # TODO: text.gsub!('\r', '')
     if [:default, "UTF-8"].include? encoding
-      text.encode!("UTF-8", invalid: :replace, :undef => :replace, :replace => '')
-      return text.split("\n") 
+      text.encode!("UTF-8", invalid: :replace, undef: :replace, replace: "")
+      return text.split("\n")
     end
 
     # Convert text from input ENCODING to UTF-8

data/lib/teuton/case/execute/execute_manager.rb

@@ -31,8 +31,8 @@ class ExecuteManager
   end
 
   def run_on(host)
-    protocol = config.get("#{host}_protocol".to_sym)
-    ip = config.get("#{host}_ip".to_sym)
+    protocol = config.get(:"#{host}_protocol")
+    ip = config.get(:"#{host}_ip")
 
     if protocol.to_s.downcase == "local" || host.to_s == "localhost"
       # Protocol force => local

data/lib/teuton/case/execute/execute_ssh.rb

@@ -9,24 +9,24 @@ class ExecuteSSH < ExecuteBase
   def call(input_hostname)
     action[:conn_type] = :ssh
     hostname = input_hostname.to_s
-    ip = config.get("#{hostname}_ip".to_sym).to_s
-    username = config.get("#{hostname}_username".to_sym).to_s
-    password = config.get("#{hostname}_password".to_sym).to_s
-    port = config.get("#{hostname}_port".to_sym).to_i
+    ip = config.get(:"#{hostname}_ip").to_s
+    username = config.get(:"#{hostname}_username").to_s
+    password = config.get(:"#{hostname}_password").to_s
+    port = config.get(:"#{hostname}_port").to_i
     port = 22 if port.zero?
 
-    unless config.get("#{hostname}_route".to_sym) == "NODATA"
+    unless config.get(:"#{hostname}_route") == "NODATA"
       # Reconfigure command with gateway. Example host1_route: IP.
       # hostname2 = hostname ¿not used?
       ip2 = ip
       username2 = username
       password2 = password
       command2 = action[:command]
-      hostname = config.get("#{hostname}_route".to_sym)
-      ip = config.get("#{hostname}_ip".to_sym).to_s
-      username = config.get("#{hostname}_username".to_sym).to_s
-      password = config.get("#{hostname}_password".to_sym).to_s
-      ostype = config.get("#{hostname}_ostype".to_sym).to_s
+      hostname = config.get(:"#{hostname}_route")
+      ip = config.get(:"#{hostname}_ip").to_s
+      username = config.get(:"#{hostname}_username").to_s
+      password = config.get(:"#{hostname}_password").to_s
+      ostype = config.get(:"#{hostname}_ostype").to_s
 
       action[:command] = if ostype.downcase.start_with? "win"
         "echo y | plink #{username2}@#{ip2} -ssh -pw #{password2} \"#{command2}\""

data/lib/teuton/case/execute/execute_telnet.rb

@@ -12,7 +12,7 @@ class ExecuteTelnet < ExecuteBase
     port = config.get((hostname + "_port").to_sym)
     mode = true
     if port.to_i == 0
-      port = "23" 
+      port = "23"
       mode = false
     end
     text = ""

data/lib/teuton/case/host.rb

@@ -34,11 +34,11 @@ class Case
 
     def init(id)
       @id = id.to_sym
-      @ip = @config.get("#{@id}_ip".to_sym).to_s
-      @username = @config.get("#{@id}_username".to_sym).to_s
-      @password = @config.get("#{@id}_password".to_sym).to_s
+      @ip = @config.get(:"#{@id}_ip").to_s
+      @username = @config.get(:"#{@id}_username").to_s
+      @password = @config.get(:"#{@id}_password").to_s
 
-      @protocol = @config.get("#{@id}_protocol".to_sym).to_s.downcase
+      @protocol = @config.get(:"#{@id}_protocol").to_s.downcase
       if @protocol == "nodata"
         @protocol = if @ip == "localhost" || @ip.start_with?("127.0.0.")
           "local"
@@ -47,12 +47,12 @@ class Case
         end
       end
 
-      @port = @config.get("#{@id}_port".to_sym).to_i
+      @port = @config.get(:"#{@id}_port").to_i
       if @port.zero?
         default = {"local" => 0, "ssh" => 22, "telnet" => 23}
         @port = default[@protocol]
       end
-      @route = @config.get("#{@id}_route".to_sym)
+      @route = @config.get(:"#{@id}_route")
     end
 
     def init_default

data/lib/teuton/case_manager/case_manager.rb

@@ -20,6 +20,7 @@ require_relative "utils"
 class CaseManager
   include Utils
   include Verbose
+
   attr_reader :report, :cases
 
   def initialize

data/lib/teuton/case_manager/export_manager.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "rainbow"
+require_relative "../utils/project"
 
 ##
 # Execute "export" order: Export every case report
@@ -57,13 +58,20 @@ class ExportManager
   ##
   # Preserve output files for current project execution
   def preserve_files
-    app = Application.instance
+    srcdir = File.join(
+      Project.value[:output_basedir],
+      Project.value[:test_name]
+    )
+
     t = Time.now
-    data = {year: t.year, month: t.month, day: t.day, hour: t.hour, min: t.min, sec: t.sec}
+    data = {
+      year: t.year, month: t.month, day: t.day,
+      hour: t.hour, min: t.min, sec: t.sec
+    }
     subdir = format("%<year>s%<month>02d%<day>02d-" \
                     "%<hour>02d%<min>02d%<sec>02d", data)
-    logdir = File.join(app.output_basedir, app.global[:tt_testname], subdir)
-    srcdir = File.join(app.output_basedir, app.global[:tt_testname])
+    logdir = File.join(srcdir, subdir)
+
     puts "[INFO] Preserving files => #{logdir}"
     FileUtils.mkdir(logdir)
     Dir.glob(File.join(srcdir, "**.*")).each { |file| FileUtils.cp(file, logdir) }

data/lib/teuton/case_manager/report.rb

@@ -26,7 +26,7 @@ class CaseManager
     @report.tail[:finish_time] = finish_time
     @report.tail[:duration] = finish_time - start_time
 
-    duration = format("%3.3f", (finish_time - start_time))
+    duration = format("%3.3f", finish_time - start_time)
     verboseln Rainbow("\nFinished in #{duration} seconds").green
     verboseln Rainbow("-" * 36).green
     verboseln " "

data/lib/teuton/case_manager/show_report.rb

@@ -1,6 +1,5 @@
 require "rainbow"
 require "terminal-table"
-# require_relative "../utils/application"
 require_relative "../utils/project"
 
 # | Verbosity level | Description |

data/lib/teuton/check/dsl/all.rb

@@ -6,7 +6,7 @@ require_relative "run"
 module CheckDSL
   def log(text = "", type = :info)
     @stats[:logs] += 1
-    prefix = type == :info ? "" : "#{type.to_s.upcase}: "
+    prefix = (type == :info) ? "" : "#{type.to_s.upcase}: "
     Logger.info "      log         #{prefix}" + text.to_s
   end
 

data/lib/teuton/check/show.rb

@@ -61,7 +61,7 @@ class ShowCheck
       end
       if Project.value[:macros].size.positive?
         st.add_row ["Macros", Project.value[:macros].size]
-        Project.value[:macros].each_key { st.add_row ["", _1] }
+        Project.value[:macros].each_key { st.add_row ["", it] }
       end
       st.add_row ["Groups", @stats[:groups]]
       st.add_row ["Targets", @stats[:targets]]
@@ -87,11 +87,11 @@ class ShowCheck
 
       if @stats[:sets].size.positive?
         st.add_row ["Sets", @stats[:sets].size]
-        @stats[:sets].each { st.add_row ["", _1] }
+        @stats[:sets].each { st.add_row ["", it] }
       end
       if @stats[:uploads].size.positive?
         st.add_row ["Uploads", @stats[:uploads].size]
-        @stats[:uploads].each { st.add_row ["", _1] }
+        @stats[:uploads].each { st.add_row ["", it] }
       end
     end
     Logger.info my_screen_table.to_s + "\n"
@@ -114,7 +114,7 @@ class ShowCheck
         script_vars << k.to_s + "_password"
       end
     end
-    @stats[:gets].keys.each { script_vars << _1 }
+    @stats[:gets].keys.each { script_vars << it }
     script_vars
   end
 end

data/lib/teuton/deprecated/runner.rb

@@ -9,8 +9,8 @@ class Case
   # 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)
+    protocol = @config.get(:"#{host}_protocol")
+    ip = @config.get(:"#{host}_ip")
 
     if protocol.to_s.downcase == "local" || host.to_s == "localhost"
       # Protocol force => local
@@ -59,24 +59,24 @@ class Case
   def run_cmd_remote_ssh(input_hostname)
     @action[:conn_type] = :ssh
     hostname = input_hostname.to_s
-    ip = @config.get("#{hostname}_ip".to_sym).to_s
-    username = @config.get("#{hostname}_username".to_sym).to_s
-    password = @config.get("#{hostname}_password".to_sym).to_s
-    port = @config.get("#{hostname}_port".to_sym).to_i
+    ip = @config.get(:"#{hostname}_ip").to_s
+    username = @config.get(:"#{hostname}_username").to_s
+    password = @config.get(:"#{hostname}_password").to_s
+    port = @config.get(:"#{hostname}_port").to_i
     port = 22 if port.zero?
 
-    unless @config.get("#{hostname}_route".to_sym) == "NODATA"
+    unless @config.get(:"#{hostname}_route") == "NODATA"
       # Reconfigure command with gateway. Example host1_route: IP.
       # hostname2 = hostname ¿not used?
       ip2 = ip
       username2 = username
       password2 = password
       command2 = @action[:command]
-      hostname = @config.get("#{hostname}_route".to_sym)
-      ip = @config.get("#{hostname}_ip".to_sym).to_s
-      username = @config.get("#{hostname}_username".to_sym).to_s
-      password = @config.get("#{hostname}_password".to_sym).to_s
-      ostype = @config.get("#{hostname}_ostype".to_sym).to_s
+      hostname = @config.get(:"#{hostname}_route")
+      ip = @config.get(:"#{hostname}_ip").to_s
+      username = @config.get(:"#{hostname}_username").to_s
+      password = @config.get(:"#{hostname}_password").to_s
+      ostype = @config.get(:"#{hostname}_ostype").to_s
 
       @action[:command] = if ostype.downcase.start_with? "win"
         "echo y | plink #{username2}@#{ip2} -ssh -pw #{password2} \"#{command2}\""

data/lib/teuton/readme/dsl/getset.rb

@@ -14,11 +14,11 @@ module ReadmeDSL
   def gett(value)
     a = get(value)
     if @cases_params.include? value
-      "[#{value}](#required-params)"
+      "[" + value + "](#required-params)"
     elsif @setted_params[value]
-      "[#{value}](#created-params)"
+      "[" + value + "](#created-params)"
     elsif @global_params.include? value
-      "[#{a}](#global-params)"
+      "[" + a + "](#global-params)"
     end
     a
   end

data/lib/teuton/readme/dsl/run.rb

@@ -2,21 +2,21 @@ module ReadmeDSL
   def goto(host = :localhost, args = {})
     unless host == :localhost
       b = {}
-      a = "#{host}_ip".to_sym
+      a = :"#{host}_ip"
       if @config[:global][a].nil? && !@setted_params.include?(a)
         @cases_params << a
       end
       b[:ip] = @config[:global][a] if @config[:global][a]
       b[:ip] = @setted_params[a] if @setted_params[a]
 
-      a = "#{host}_username".to_sym
+      a = :"#{host}_username"
       if @config[:global][a].nil? && !@setted_params.include?(a)
         @cases_params << a
       end
       b[:username] = @config[:global][a] if @config[:global][a]
       b[:username] = @setted_params[a] if @setted_params[a]
 
-      a = "#{host}_password".to_sym
+      a = :"#{host}_password"
       if @config[:global][a].nil? && !@setted_params.include?(a)
         @cases_params << a
       end

data/lib/teuton/readme/readme.rb

@@ -10,6 +10,7 @@ require_relative "result"
 class Readme
   include DSL
   include ReadmeDSL
+
   attr_reader :result
   attr_reader :data
 

data/lib/teuton/report/formatter/default/array.rb

@@ -3,7 +3,7 @@ require_relative "../../../utils/project"
 
 class ArrayFormatter < BaseFormatter
   def initialize(report)
-    super(report)
+    super
     @data = {}
   end
 

data/lib/teuton/report/formatter/default/html.rb

@@ -3,7 +3,7 @@ require_relative "yaml"
 
 class HTMLFormatter < YAMLFormatter
   def initialize(report)
-    super(report)
+    super
     @ext = "html"
     @data = {}
     basedir = File.join(File.dirname(__FILE__), "..", "..", "..")

data/lib/teuton/report/formatter/default/json.rb

@@ -1,9 +1,10 @@
-require "json/pure"
+# require "json/pure"
+require "json"
 require_relative "array"
 
 class JSONFormatter < ArrayFormatter
   def initialize(report)
-    super(report)
+    super
     @ext = "json"
   end
 

data/lib/teuton/report/formatter/default/xml.rb

@@ -3,7 +3,7 @@ require_relative "../../../version"
 
 class XMLFormatter < BaseFormatter
   def initialize(report)
-    super(report)
+    super
     @ext = "xml"
   end
 

data/lib/teuton/report/formatter/default/yaml.rb

@@ -3,7 +3,7 @@ require_relative "array"
 
 class YAMLFormatter < ArrayFormatter
   def initialize(report)
-    super(report)
+    super
     @ext = "yaml"
   end
 

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

@@ -2,7 +2,7 @@ require_relative "resume/array"
 
 class MoodleCSVFormatter < ResumeArrayFormatter
   def initialize(report)
-    super(report)
+    super
     @ext = "csv"
     @data = {}
   end

data/lib/teuton/report/formatter/resume/array.rb

@@ -3,7 +3,7 @@ require_relative "../../../utils/project"
 
 class ResumeArrayFormatter < BaseFormatter
   def initialize(report)
-    super(report)
+    super
     @data = {}
   end
 

data/lib/teuton/report/formatter/resume/html.rb

@@ -4,7 +4,7 @@ require_relative "yaml"
 
 class ResumeHTMLFormatter < ResumeYAMLFormatter
   def initialize(report)
-    super(report)
+    super
     @ext = "html"
     @data = {}
     basedir = File.join(File.dirname(__FILE__), "..", "..", "..")

data/lib/teuton/report/formatter/resume/json.rb

@@ -1,9 +1,10 @@
-require "json/pure"
+# require "json/pure"
+require "json"
 require_relative "array"
 
 class ResumeJSONFormatter < ResumeArrayFormatter
   def initialize(report)
-    super(report)
+    super
     @ext = "json"
     @data = {}
   end

data/lib/teuton/report/formatter/resume/yaml.rb

@@ -2,7 +2,7 @@ require_relative "array"
 
 class ResumeYAMLFormatter < ResumeArrayFormatter
   def initialize(report)
-    super(report)
+    super
     @ext = "yaml"
     @data = {}
   end

data/lib/teuton/report/report.rb

@@ -28,7 +28,7 @@ class Report
     report = Report.new
     attrs = %i[id filename output_dir head lines tail format]
     attrs.each do |attr|
-      attr_set = "#{attr}=".to_sym
+      attr_set = :"#{attr}="
       report.send(attr_set, send(attr).clone)
     end
 
@@ -42,7 +42,7 @@ class Report
 
   def export_resume(options)
     format = options[:format]
-    @format = "resume_#{format}".to_sym
+    @format = :"resume_#{format}"
     options[:format] = @format
     filepath = File.join(@output_dir, @filename)
     Formatter.call(self, options, filepath)

data/lib/teuton/utils/configfile_reader.rb

@@ -1,5 +1,6 @@
+# require "json/pure"
+require "json"
 require "yaml"
-require "json/pure"
 
 ##
 # Functions that read data from ConfigFile using YAML or JSON formats

data/lib/teuton/version.rb

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