teuton 2.1.3 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a118fef48cafbf7a11e722dc32aefc5011e1a5729235f3121cae55f3bbfa4161
-  data.tar.gz: 8d1ce9d0f933059ec246a807f74300e517af4b50b71c5383e875832a62348437
+  metadata.gz: f56e4167c40780e0550622b1bf0a32a844dfb2095ce4decfefae6ef4ec3ee81c
+  data.tar.gz: 2837ebcb35eeb895e68f714ac14d91e2224df08590fa9820862f448913bcef85
 SHA512:
-  metadata.gz: 25ba06c39a87c6d7f03472490fc9d46be563b52ba42a1be7ecda267a8919e3ce7d056603b548958ba61e385df6eb4a5af3741540807fdc1574fdca3da7736f1f
-  data.tar.gz: 1ce63b708fea7a9e02bba3d753943aa89ff3ca8fb41f598bd4553d58ebdcded2483bea5471aa96278edee452772abb37044c2e86dfe9c355e5586d4317c3cc24
+  metadata.gz: a03c6981eb476d5337c3bcda5db95cfc35efb6f17ede323cc26ebc6027cf3095a66beb8715a20669b85dbb86b6f67a9217538f8438e47f2bff9eb3f924e5780d
+  data.tar.gz: 1e5118978596288b91f4c71ca4aef2ce7f9c4aa5e3b14f07bfc9f887b75a75456447b75b4da6ddc07e25d66f78867f90d9924568832463c2bcb321d8682cae54

data/README.md

@@ -1,5 +1,7 @@
 
-# TEUTON Software (version 2.1)
+[![Gem Version](https://badge.fury.io/rb/teuton.svg)](https://badge.fury.io/rb/teuton)
+
+# TEUTON (version 2.1)
 
 _Create Unit Test for your machines, and
 test your infraestructure as code._
@@ -15,22 +17,25 @@ Teuton allow us:
 * Write test units for real or virtual machines using simple DSL.
 * Check compliance with requirements on remote machines.
 
+---
 # Documentation
 
-Teuton [documentation](./docs).
-
-* [Installation](docs/install/install.md)
-* [Learning](docs/learn/README.md)
-* [Commands](docs/commands/commands.md)
-* [DSL keywords](docs/dsl/keywords.md)
+* [Installation](https://github.com/teuton-software/teuton/tree/devel/docs/install/README.md)
+    1. Install Ruby on your system.
+    2. `gem install teuton`
+* [Learning](https://github.com/teuton-software/teuton/tree/devel/docs/learn/README.md)
+* [Commands](https://github.com/teuton-software/teuton/tree/devel/docs/commands/README.md)
+* [DSL keywords](https://github.com/teuton-software/teuton/tree/devel/docs/dsl/README.md)
 
+---
 # Features
 
-* [Free Software License](LICENSE).
-* Multiplatform [installation](https://github.com/teuton-software/teuton/wiki/Installation).
+* [Free Software License](https://github.com/teuton-software/teuton/tree/devel/LICENSE).
+* Multiplatform .
 * Use SSH or Telnet protocol to connect to remote machines.
 * Developed using the ruby language.
 
+---
 # Contact
 
 * **Email**: `teuton.software@protonmail.com`

data/bin/teuton

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
-require 'teuton/command'
-TeutonCommand.start(ARGV)
+require_relative 'teuton/cli'
+CLI.start(ARGV)

data/docs/install/README.md

@@ -0,0 +1,53 @@
+
+There are different Teuton [Modes of use](modes_of_use.md). For every mode there are 2 node types and every node has their own installation script:
+
+* **T-node**: This host has installed Teuton software.
+* **S-node**: This host has installed SSH server.
+
+---
+# T-NODE
+
+* **Install** Teuton on machine with T-NODE role.
+Installation process:
+    1. Install Ruby on your system.
+    2. `gem install teuton`
+* Run `teuton version` to check that your installation is ok.
+
+> **PROBLEMS**: If you have problems to find `teuton`command (OpenSUSE distro), try this:
+> * Option A:
+>     * `ruby -v`, display your current ruby version. Supose it is 2.5.
+>     * Run `teuton.ruby2.5`, instead of `teuton`.
+> * Option B:
+>     * `find /usr/lib64/ruby -name teuton`, to find absolute path to teuton command.
+>     * `sudo ln -s /PATH/TO/bin/teuton /usr/local/bin/teuton`, to create symbolic link to teuton command.
+
+* **Update** Teuton with `gem teuton update`.
+* **Uninstall** Teuton with `gem uninstall teuton`
+
+---
+# S-NODE
+
+* **Install** SSH server on every machine with S-NODE role.
+
+---
+# Other installation ways
+
+## Using scripts
+
+[Installation using scripts](scripts.md)
+* Use our scripts to run automatical installation for your OS.
+* Use this way if you don't know how to install Ruby on your system.
+
+## Using Vagranfiles
+
+[Installation using Vagrant](vagrant.md)
+* If you plan to install Teuton into virtual machines, and have Vagrant installed into your real machine, this is the easier way for you.
+
+## Manual
+
+[Manual installation](manual.md)
+* If you don't need help, and want to install Teuton by your own, or there are not installation scripts for your favorite OS, and you don't want to use Vagrant then... here you have information how to install all the required packages for Teuton.
+
+Let's us known your installation difficulties.
+
+Thanks!

data/docs/install/manual.md

@@ -0,0 +1,38 @@
+
+There are diferents Teuton [Modes of use](Modes of use). For every mode there are 2 node typesm and every node has their own installation script:
+
+* **T-node**: This host has installed Teuton software.
+* **S-node**: This host has installed SSH server.
+
+---
+# T-NODE: 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`
+
+---
+
+# S-NODE: Manual installation
+
+* Install SSH server on your host.
+
+> How to [install SSH on Windows](windows-ssh)

data/docs/install/{scripts_install.md → scripts.md}

@@ -14,7 +14,7 @@ There are different Teuton [Modes of use](modes_of_use.md). For every mode there
 Run this command as `root` user:
 
 ```bash
-wget -qO- https://raw.githubusercontent.com/teuton-software/teuton/master/bin/linux_t-node_install.sh | bash
+wget -qO- https://raw.githubusercontent.com/teuton-software/teuton/devel/install/linux/linux_t-node_install.sh | bash
 ```
 
 ## T-NODE: Mac OS X installation
@@ -22,7 +22,7 @@ wget -qO- https://raw.githubusercontent.com/teuton-software/teuton/master/bin/li
 Run this command as admin user (member of `admin` group):
 
 ```bash
-curl -sL https://raw.githubusercontent.com/teuton-software/teuton/master/bin/macosx_t-node_install.sh | bash
+curl -sL https://raw.githubusercontent.com/teuton-software/teuton/devel/install/mac/macosx_t-node_install.sh | bash
 ```
 
 > No `root` user.
@@ -36,7 +36,7 @@ Requirements:
 Run this command on **PowerShell (PS)** as `Administrator` user:
 
 ```powershell
-Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/teuton-software/teuton/master/bin/windows_t-node_install.ps1'))
+Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/teuton-software/teuton/devel/install/windows_t-node_install.ps1'))
 ```
 
 ---
@@ -52,7 +52,7 @@ This is, SSH server installation.
 Run this command as `root` user:
 
 ```bash
-wget -qO- https://raw.githubusercontent.com/teuton-software/teuton/master/bin/linux_s-node_install.sh | bash
+wget -qO- https://raw.githubusercontent.com/teuton-software/teuton/devel/install/linux/linux_s-node_install.sh | bash
 ```
 
 ## S-NODE: Mac OS X installation
@@ -60,7 +60,7 @@ wget -qO- https://raw.githubusercontent.com/teuton-software/teuton/master/bin/li
 Run this command as `root` user:
 
 ```bash
-curl -sL https://raw.githubusercontent.com/teuton-software/teuton/master/bin/macosx_s-node_install.sh | bash
+curl -sL https://raw.githubusercontent.com/teuton-software/teuton/devel/install/mac/macosx_s-node_install.sh | bash
 ```
 
 ## S-NODE: Windows installation
@@ -72,5 +72,5 @@ Requirements:
 Run this command on **PowerShell (PS)** as `Administrator` user:
 
 ```powershell
-Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/teuton-software/teuton/master/bin/windows_s-node_install.ps1'))
+Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/teuton-software/teuton/devel/install/windows/windows_s-node_install.ps1'))
 ```

data/docs/install/tested_os.md

@@ -0,0 +1,25 @@
+## GNU/Linux
+
+| O.S.      | Version        | Arch   | T-node | S-node |
+| --------- | -------------- | ------ | ------ | ------ |
+| CentOS    | 7              | x86-64 |        |        |
+| Debian    | 9.7.0          | x86-64 | Ok     |        |
+| Fedora    | Workstation 29 | x84-64 | Ok     |        |
+| LinuxMint | 18.3           | x86-64 | Ok     |        |
+| openSUSE  | Leap 15        | x86-64 | Ok     | Ok     |
+| Ubuntu    | 18.04          | x86-64 | Ok     | Ok     |
+
+## Windows
+
+| O.S.    | Version        | Arch   | Nodo-T | Nodo-S |
+| ------- | -------------- | ------ | ------ | ------ |
+| Windows | 7 Enterprise   | x86    | Ok     |        |
+| Windows | 10 Pro         | x86-64 | Ok     | Ok     |
+| Windows | Server 2012 R2 | x86-64 |        |        |
+
+## Mac OS X
+
+| O.S     | Version               | Arch   | T-Node | S-Node |
+| -------- | -------------------- | ------ | ------ | ------ |
+| Mac OS X | El Capitán (10.11.6) | x86-64 | Ok     | Ok     |
+| Mac OS X | Sierra (10.12)       | x86-64 | Ok     |        |

data/docs/install/vagrant.md

@@ -0,0 +1,8 @@
+
+# Install with Vagrant
+
+* First, you must have `Vagrant` installed.
+* Create directory for your vagrant project. For example, `mkdir teuton-vagrant`.
+* Move into that directory: `cd teuton-vagrant`.
+* Download required [Vagrantfile](../../install/vagrant).
+* Run `vagrant up` to create your Virtual Machine.

data/docs/learn/example-01-target.md

@@ -2,7 +2,7 @@
 Let's learn how to create our first target.
 A target is a feature you want to measure or check.
 
-> This example is on GitHub repository `teuton-challenge` at `learn/learn-01-target/`.
+> This example is on GitHub repository at `examples/learn-01-target/`.
 
 ## Definitions (Group section)
 

data/docs/learn/example-02-configfile.md

@@ -2,7 +2,7 @@
 Learn how to use config file into your tests.
 Tests can use params defined into config files. It's good idea save variable data separated into external config file.
 
-> This example is on GitHub repository `teuton-challenge` at `learn/learn-02-config`.
+> This example is on GitHub repository at `examples/learn-02-config`.
 
 ## Config file (`config.yaml`)
 

data/docs/learn/example-03-remote-hosts.md

@@ -4,7 +4,7 @@ Learn how to:
 * Export reports using other output formats.
 * Checking remote machine (host1) with Windows OS.
 
-> This example is on GitHub repository `teuton-challenge` at `learn/learn-03-remote-hosts`.
+> This example is on GitHub repository at `examples/learn-03-remote-hosts`.
 
 ## Config file (`config.yaml`)
 

data/docs/learn/example-04-use.md

@@ -3,7 +3,7 @@ Learn how to:
 * Organize huge amount of groups/targets into several files.
 * Checking Windows OS infrastructure (host1).
 
-> This example is on GitHub repository `teuton-challenge` at `learn/learn-04-use`.
+> This example is on GitHub repository at `examples/learn-04-use`.
 
 ## Tree directory
 

data/docs/learn/example-05-debug.md

@@ -3,7 +3,7 @@ Learn how to:
 * Check test syntax.
 * Debug your tests.
 
-> This example is on GitHub repository `teuton-challenge` at `learn/learn-05-debug`.
+> This example is on GitHub repository at `examples/learn-05-debug`.
 
 ## Tree directory
 

data/lib/teuton/application.rb

@@ -4,7 +4,7 @@ require 'singleton'
 class Application
   include Singleton
 
-  VERSION = '2.1.3' # Application version
+  VERSION = '2.1.4' # Application version
   NAME = 'teuton'   # Application name
 
   attr_reader   :letter

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

@@ -46,10 +46,12 @@ class Case
     private
 
     def search_alias(key, level)
-      return search_array_alias(@ialias[key],level) if @ialias[key].class == Array
-
-      return get(@ialias[key]) if [Integer, String, Symbol].include? @ialias[key].class
-
+      if @ialias[key].class == Array
+        return search_array_alias(@ialias[key], level)
+      elsif [Integer, String, Symbol].include? @ialias[key].class
+        return get(@ialias[key])
+      end
+      
       words = key.to_s.split('_')
       return 'NODATA' if words.size < 2
 
@@ -61,14 +63,14 @@ class Case
       get("#{key2}_#{words[1]}".to_sym, level)
     end
 
-    def search_array_alias(keys,level)
+    def search_array_alias(keys, level)
       values = []
       keys.each do |k|
         if k.class == Symbol
           values << get(k, level + 1)
-        else
-          values << k
+          next
         end
+        values << k
       end
       values.join('')
     end

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

@@ -2,7 +2,9 @@
 
 require_relative '../runner'
 
-# Case->DSL#goto
+# Case class -> DSL module:
+# * goto
+# * run
 module DSL
   # Run command from the host identify as pHostname
   # goto :host1, :execute => "command"
@@ -13,21 +15,14 @@ module DSL
     tempfile(args[:tempfile]) if args[:tempfile]
     @action[:encoding] = args[:encoding] || 'UTF-8'
 
-    protocol = @config.get("#{host}_protocol".to_sym)
-    ip = @config.get("#{host}_ip".to_sym)
     start_time = Time.now
-    if (protocol == 'NODATA' || protocol.nil?) &&
-       (host.to_s == 'localhost' || host.to_s.include?('127.0.0.') || ip.include?('127.0.0.'))
-      run_local_cmd
-    elsif ip == 'NODATA'
-      log("#{host} IP not found!", :error)
-    else
-      run_remote_cmd host
-    end
+    run_cmd_on(host)
     @action[:duration] = (Time.now - start_time).round(3)
   end
   alias on goto
 
+  ##
+  # DLS run: It's the same as goto :localhost
   def run(command, args = {})
     args[:exec] = command.to_s
     goto(:localhost, args)

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

@@ -1,14 +1,22 @@
 # frozen_string_literal: true
 
-# DSL#log
+##
+# Case class -> DSL module : log function
 module DSL
+  ##
+  # Record log message
+  # @param text (String)
+  # @param type (Symbol) Values :info, :warn or :error
+  # rubocop:disable Style/FormatStringToken
   def log(text = '', type = :info)
     s = ''
     s = Rainbow('WARN!').color(:yellow) if type == :warn
     s = Rainbow('ERROR').bg(:red) if type == :error
     t = Time.now
-    f = format('%02d:%02d:%02d', t.hour, t.min, t.sec)
+#    f = format('%02d:%02d:%02d', t.hour, t.min, t.sec)
+    f = '%02d:%02d:%02d' % [t.hour, t.min, t.sec]
     @report.lines << "[#{f}] #{s}: #{text}"
   end
+  # rubocop:enable Style/FormatStringToken
   alias msg log
 end

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

@@ -2,6 +2,7 @@
 require 'net/ssh'
 require 'net/sftp'
 require 'net/telnet'
+require_relative 'dsl/log'
 
 # Class Case
 # * run_local_cmd
@@ -12,14 +13,38 @@ class Case
 
   private
 
-  def run_local_cmd()
+  def run_cmd_on(host)
+    protocol = @config.get("#{host}_protocol".to_sym)
+    ip = @config.get("#{host}_ip".to_sym)
+
+    if (protocol.to_s.downcase == 'local' || host.to_s == 'localhost')
+      run_cmd_localhost() # Protocol force => local
+    elsif protocol.to_s.downcase == 'ssh'
+      run_cmd_remote_ssh(host) # Protocol force => ssh
+    elsif protocol.to_s.downcase == 'telnet'
+        run_cmd_remote_telnet(host) # Protocol force => telnet
+    elsif (ip.to_s.downcase == 'localhost' || ip.to_s.include?('127.0.0.'))
+      run_cmd_localhost()
+    elsif ip == 'NODATA'
+      log("#{host} IP not found!", :error)
+    else
+      run_cmd_remote_ssh host
+    end
+  end
+
+  ##
+  # Run command on local machine
+  def run_cmd_localhost()
     @action[:conn_type] = :local
     i = my_execute( @action[:command], @action[:encoding] )
     @result.exitstatus = i[:exitstatus]
     @result.content = i[:content]
   end
 
-  def run_remote_cmd(input_hostname)
+  ##
+  # Run remote command
+  # @param input_hostname (Symbol or String)
+  def run_cmd_remote(input_hostname)
     hostname = input_hostname.to_s
     i = (hostname + '_protocol').to_sym
     protocol = @config.get(i) if @config.get(i)
@@ -27,15 +52,17 @@ class Case
     protocol = protocol.to_sym
     case protocol
     when :ssh
-      run_remote_cmd_ssh(input_hostname)
+      run_cmd_remote_ssh(input_hostname)
     when :telnet
-      run_remote_cmd_telnet(input_hostname)
+      run_cmd_remote_telnet(input_hostname)
+    when :local
+      run_cmd_localhost()
     else
       log("Protocol #{protocol} unknown! Use ssh or telnet.", :error)
     end
   end
 
-  def run_remote_cmd_ssh(input_hostname)
+  def run_cmd_remote_ssh(input_hostname)
     @action[:conn_type] = :ssh
     hostname = input_hostname.to_s
     ip = @config.get((hostname + '_ip').to_sym)
@@ -86,7 +113,7 @@ class Case
     @result.content.compact!
   end
 
-  def run_remote_cmd_telnet(input_hostname)
+  def run_cmd_remote_telnet(input_hostname)
     @action[:conn_type] = :telnet
     app = Application.instance
     hostname = input_hostname.to_s

data/lib/teuton/case_manager/show.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../application'
 
 # CaseManager#show

data/lib/teuton/case_manager/utils.rb

@@ -13,9 +13,10 @@ module Utils
     true
   end
 
+  # rubocop:disable Metrics/MethodLength
   def encode_and_split(encoding, text)
     # Convert text to UTF-8 deleting unknown chars
-    text = text || '' # Ensure text is not nil
+    text ||= '' # Ensure text is not nil
     flag = [:default, 'UTF-8'].include? encoding
     return text.encode('UTF-8', invalid: :replace).split("\n") if flag
 
@@ -30,6 +31,7 @@ module Utils
 
     text.split("\n")
   end
+  # rubocop:enable Metrics/MethodLength
 
   def my_execute(cmd, encoding = 'UTF-8')
     return { exitstatus: 0, content: '' } if Application.instance.debug

data/lib/teuton/{command → cli}/main.rb

@@ -3,5 +3,4 @@
 require_relative 'play'
 require_relative 'readme'
 require_relative 'test'
-require_relative 'update'
 require_relative 'version'

data/lib/teuton/{command → cli}/play.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-# Teuton#play
-class TeutonCommand < Thor
-  map ['p', '-p', 'play', '--play'] => 'play'
+# CLI#play
+class CLI < Thor
+  map ['p', '-p', 'play', '--play', '--run', 'run'] => 'play'
   option :export, type: :string
   option :cname, type: :string
   option :cpath, type: :string
   option :case, type: :string
   option :quiet, type: :boolean
-  desc '[play] [OPTIONS] DIRECTORY',
+  desc '[run] [OPTIONS] DIRECTORY',
        'Run challenge from directory'
   long_desc <<-LONGDESC
   This function execute challenge from specified directory.

data/lib/teuton/{command → cli}/readme.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-# Teuton#readme
-class TeutonCommand < Thor
-  map ['r', '-r', '--readme'] => 'readme'
+# CLI#readme
+class CLI < Thor
+  map ['--readme'] => 'readme'
   option :lang, type: :string
   desc 'readme DIRECTORY',
        'Create README.md file from challenge contents'

data/lib/teuton/{command → cli}/test.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-# Teuton#test
-class TeutonCommand < Thor
-  map ['t', '-t', '--test'] => 'test'
+# CLI#test
+class CLI < Thor
+  map ['t', '-t', '--test', 'test'] => 'check'
   option :c, type: :boolean
   option :cname, type: :string
   option :cpath, type: :string
-  desc 'test [OPTIONS] DIRECTORY',
+  desc 'check [OPTIONS] DIRECTORY',
        'Test or check challenge contents'
   long_desc <<-LONGDESC
 
@@ -32,7 +32,7 @@ class TeutonCommand < Thor
   ##
   # Verify or test Teuton test units syntax
   # @param path_to_rb_file [String] Route to main rb Teuton file
-  def test(path_to_rb_file)
+  def check(path_to_rb_file)
     Project.test(path_to_rb_file, options)
   end
 end

data/lib/teuton/{command → cli}/version.rb

@@ -3,9 +3,11 @@
 require 'rainbow'
 
 # Class method Teuton#version
-class TeutonCommand < Thor
+class CLI < Thor
   map ['v', '-v', '--version'] => 'version'
   desc 'version', 'Show the program version'
+  ##
+  # Display version
   def version
     print Rainbow(Application::NAME).bright.blue
     puts  ' (version ' + Rainbow(Application::VERSION).green + ')'

data/lib/teuton/{command.rb → cli.rb}

@@ -1,24 +1,16 @@
 require 'thor'
 require_relative 'application'
 require_relative 'project/project'
-require_relative 'project/project_creator.rb'
-require_relative 'command/main'
+require_relative 'project/skeleton.rb'
+require_relative 'cli/main'
 
 ##
 # Command Line User Interface
-class TeutonCommand < Thor
+class CLI < Thor
   map ['h', '-h', '--help'] => 'help'
 
-  def method_missing(method, *_args, &_block)
-    play(method.to_s)
-  end
-
-  def respond_to_missing?(method_name, include_private = false)
-    super
-  end
-
-  map ['c', '-c', '--create'] => 'create'
-  desc 'create DIRECTORY', 'Create skeleton for a new project'
+  map ['c', '-c', '--create', 'create'] => 'new'
+  desc 'new DIRECTORY', 'Create skeleton for a new project'
   long_desc <<-LONGDESC
   Create files for a new project.
 
@@ -27,8 +19,20 @@ class TeutonCommand < Thor
   #{$PROGRAM_NAME} create dir/foo
   LONGDESC
   ##
-  # Command create new Teuton project
-  def create(path_to_new_dir)
-    ProjectCreator.create(path_to_new_dir)
+  # Command: create new Teuton project
+  def new(path_to_new_dir)
+    Skeleton.create(path_to_new_dir)
+  end
+
+  ##
+  # These inputs are equivalents:
+  # * teuton 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)
+    super
   end
 end

data/lib/teuton/project/laboratory/laboratory.rb

@@ -9,21 +9,31 @@ require_relative 'show'
 require_relative 'dsl'
 require_relative 'builtin'
 
+##
+# DSL use: import filename instructions
+# @param filename (String)
 def use(filename)
   filename += '.rb'
   app = Application.instance
-  rbfiles = File.join(app.project_path, "**", filename)
+  rbfiles = File.join(app.project_path, '**', filename)
   files = Dir.glob(rbfiles)
   use = []
   files.sort.each { |f| use << f if f.include?(filename) }
   require_relative use[0]
 end
 
+##
+# DSL group: Define a group of test
+# @param name (String or Symbol)
+# @param block (Proc)
 def group(name, &block)
   Application.instance.groups << { name: name, block: block }
 end
 alias task group
 
+##
+# DSL start: Define main teuton test execution
+# @param block (Proc)
 def start(&block)
   # don't do nothing
 end

data/lib/teuton/project/project.rb

@@ -33,10 +33,10 @@ module Project
 
   def self.process_input_case_option
     options = Application.instance.options
-    unless options['case'].nil?
-      a = options['case'].split(',')
-      options['case'] = a.collect! { |i| i.to_i }
-    end
+    return if options['case'].nil?
+
+    a = options['case'].split(',')
+    options['case'] = a.collect!(&:to_i)
   end
 
   def self.readme(pathtofile, options)

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

@@ -31,21 +31,21 @@ class Readme
     unless host == :localhost
       b = {}
       a = "#{host}_ip".to_sym
-      if @config[:global][a].nil? && (not @setted_params.include?(a))
+      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
-      if @config[:global][a].nil? && (not @setted_params.include?(a))
+      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
-      if @config[:global][a].nil? && (not @setted_params.include?(a))
+      if @config[:global][a].nil? && !@setted_params.include?(a)
         @cases_params << a
       end
       b[:password] = @config[:global][a] if @config[:global][a]
@@ -62,7 +62,7 @@ class Readme
     goto(:localhost, args)
   end
 
-  def expect(_cond, args = {})
+  def expect(_cond, _args = {})
     @current[:actions] << @action
     result.reset
   end
@@ -92,6 +92,7 @@ class Readme
     a = get(value)
     return "[#{value}](\#required-params)" if @cases_params.include? value
     return "[#{value}](\#created-params)" if @setted_params[value]
+
     "[#{a}](\#global-params)" if @global_params.include? value
   end
 

data/lib/teuton/project/readme/lang.rb

@@ -6,7 +6,7 @@ module Lang
     lang = {}
     lang['en'] = {
       version:  'Teuton version : %s',
-      testname: 'Challenge name : %s',
+      testname: 'Test unit name : %s',
       date:     'Date           : %s',
       hosts:    "\n\#\#\# Required hosts\n",
       params:   "\n\#\#\# Required params\n",
@@ -16,7 +16,7 @@ module Lang
     }
     lang['es'] = {
       version:  'Versión de Teuton : %s',
-      testname: 'Nombre del reto   : %s',
+      testname: 'Nombre del test   : %s',
       date:     'Fecha             : %s',
       hosts:    "\n\#\#\# Máquinas que se necesitan\n",
       params:   "\n\#\#\# Parámetros de necesarios\n",

data/lib/teuton/project/readme/readme.rb

@@ -107,6 +107,7 @@ class Readme
     puts format(Lang::get(:date), Time.now)
     puts format(Lang::get(:version), Application::VERSION)
     puts '```'
+    puts "\n---\n"
     puts "# README.md\n"
 
     i = 1

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

@@ -3,23 +3,20 @@
 require 'fileutils'
 require 'rainbow'
 
-# Project#create
+# Skeleton class
 # * create
 # * create_main_dir_and_files
 # * create_assets_dir_and_files
 # * create_dir
 # * create_dirs
 # * copyfile
-module ProjectCreator
+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__), '..')
     create_dir project_dir
-
     create_main_dir_and_files(project_dir, source_basedir)
-    create_assets_dir_and_files(project_dir, source_basedir)
   end
 
   def self.create_main_dir_and_files(project_dir, source_basedir)
@@ -27,7 +24,7 @@ module ProjectCreator
     items = [
       { source: 'files/config.yaml', target: 'config.yaml' },
       { source: 'files/start.rb', target: 'start.rb' },
-      { source: 'files/README.md', target: 'README.md' },
+    # { source: 'files/README.md', target: 'README.md' },
       { source: 'files/gitignore', target: '.gitignore' }
     ]
     items.each do |item|
@@ -37,16 +34,6 @@ module ProjectCreator
     end
   end
 
-  def self.create_assets_dir_and_files(project_dir, source_basedir)
-    # Assets Directory and files
-    project_assets_dir = File.join(project_dir, 'assets')
-    create_dir project_assets_dir
-#    source = File.join(source_basedir, 'lib/files/README.md')
-#    target = File.join(project_dir, 'README.md')
-#    copyfile(source, target) # README.md
-    puts ''
-  end
-
   def self.create_dir(dirpath)
     if Dir.exist? dirpath
       puts "* Exists dir!       => #{Rainbow(dirpath).yellow}"

data/lib/teuton.rb

@@ -1,6 +1,6 @@
 require_relative 'teuton/application'
 require_relative 'teuton/project/project'
-require_relative 'teuton/project/project_creator'
+require_relative 'teuton/project/skeleton'
 
 ##
 # Main Teuton functions
@@ -8,7 +8,7 @@ module Teuton
   ##
   # Create new Teuton project
   def self.create(path_to_new_dir)
-    ProjectCreator.create(path_to_new_dir)
+    Skeleton.create(path_to_new_dir)
   end
 
   ##

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.1.4
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-09 00:00:00.000000000 Z
+date: 2020-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -156,11 +156,11 @@ extra_rdoc_files:
 - docs/learn/example-05-debug.md
 - docs/learn/example-11-first-test.md
 - docs/learn/videos.md
-- docs/learn/learning.md
 - docs/learn/example-02-configfile.md
 - docs/learn/example-04-use.md
 - docs/learn/quick-demo.md
 - docs/learn/example-01-target.md
+- docs/learn/README.md
 - docs/changelog/v2.1.md
 - docs/changelog/todo.md
 - docs/changelog/servidor-de-retos.md
@@ -169,7 +169,7 @@ extra_rdoc_files:
 - docs/commands/help.md
 - docs/commands/revise_test.md
 - docs/commands/create_skeleton.md
-- docs/commands/commands.md
+- docs/commands/README.md
 - docs/commands/run_test_unit.md
 - docs/dsl/definition/run.md
 - docs/dsl/definition/goto.md
@@ -177,7 +177,6 @@ extra_rdoc_files:
 - docs/dsl/definition/target.md
 - docs/dsl/definition/group.md
 - docs/dsl/definition/expect.md
-- docs/dsl/keywords.md
 - docs/dsl/execution/export.md
 - docs/dsl/execution/play.md
 - docs/dsl/execution/send.md
@@ -185,17 +184,18 @@ extra_rdoc_files:
 - docs/dsl/_Sidebar.md
 - docs/dsl/setting/set.md
 - docs/dsl/setting/get.md
+- docs/dsl/README.md
 - docs/Challenge-Server-Project.md
 - docs/developers/comparative.md
 - docs/developers/03-encoding.md
 - docs/developers/01-telnet.md
 - docs/developers/02-ssh.md
+- docs/install/vagrant.md
 - docs/install/modes_of_use.md
-- docs/install/tested_od.md
-- docs/install/vagrant_install.md
-- docs/install/scripts_install.md
-- docs/install/manual_install.md
-- docs/install/install.md
+- docs/install/tested_os.md
+- docs/install/scripts.md
+- docs/install/README.md
+- docs/install/manual.md
 files:
 - LICENSE
 - README.md
@@ -205,7 +205,7 @@ files:
 - docs/changelog/todo.md
 - docs/changelog/v2.0.md
 - docs/changelog/v2.1.md
-- docs/commands/commands.md
+- docs/commands/README.md
 - docs/commands/create_skeleton.md
 - docs/commands/help.md
 - docs/commands/revise_test.md
@@ -215,6 +215,7 @@ files:
 - docs/developers/02-ssh.md
 - docs/developers/03-encoding.md
 - docs/developers/comparative.md
+- docs/dsl/README.md
 - docs/dsl/_Sidebar.md
 - docs/dsl/definition/expect.md
 - docs/dsl/definition/goto.md
@@ -226,22 +227,21 @@ files:
 - docs/dsl/execution/play.md
 - docs/dsl/execution/send.md
 - docs/dsl/execution/show.md
-- docs/dsl/keywords.md
 - docs/dsl/setting/get.md
 - docs/dsl/setting/set.md
-- docs/install/install.md
-- docs/install/manual_install.md
+- docs/install/README.md
+- docs/install/manual.md
 - docs/install/modes_of_use.md
-- docs/install/scripts_install.md
-- docs/install/tested_od.md
-- docs/install/vagrant_install.md
+- docs/install/scripts.md
+- docs/install/tested_os.md
+- docs/install/vagrant.md
+- docs/learn/README.md
 - docs/learn/example-01-target.md
 - docs/learn/example-02-configfile.md
 - docs/learn/example-03-remote-hosts.md
 - docs/learn/example-04-use.md
 - docs/learn/example-05-debug.md
 - docs/learn/example-11-first-test.md
-- docs/learn/learning.md
 - docs/learn/quick-demo.md
 - docs/learn/videos.md
 - lib/teuton.rb
@@ -280,13 +280,12 @@ files:
 - lib/teuton/case_manager/report.rb
 - lib/teuton/case_manager/show.rb
 - lib/teuton/case_manager/utils.rb
-- lib/teuton/command.rb
-- lib/teuton/command/main.rb
-- lib/teuton/command/play.rb
-- lib/teuton/command/readme.rb
-- lib/teuton/command/test.rb
-- lib/teuton/command/update.rb
-- lib/teuton/command/version.rb
+- lib/teuton/cli.rb
+- lib/teuton/cli/main.rb
+- lib/teuton/cli/play.rb
+- lib/teuton/cli/readme.rb
+- lib/teuton/cli/test.rb
+- lib/teuton/cli/version.rb
 - lib/teuton/files/README.md
 - lib/teuton/files/config.yaml
 - lib/teuton/files/gitignore
@@ -298,12 +297,10 @@ files:
 - lib/teuton/project/laboratory/show.rb
 - lib/teuton/project/name_file_finder.rb
 - lib/teuton/project/project.rb
-- lib/teuton/project/project_creator.rb
 - lib/teuton/project/readme/dsl.rb
 - lib/teuton/project/readme/lang.rb
 - lib/teuton/project/readme/readme.rb
-- lib/teuton/rake_function/check.rb
-- lib/teuton/rake_function/install.rb
+- lib/teuton/project/skeleton.rb
 - lib/teuton/report/close.rb
 - lib/teuton/report/formatter/array_formatter.rb
 - lib/teuton/report/formatter/base_formatter.rb
@@ -328,7 +325,7 @@ homepage: https://github.com/teuton-software/teuton
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message: Thanks for installing!
 rdoc_options: []
 require_paths:
 - lib

data/docs/install/install.md

@@ -1,32 +0,0 @@
-
-> We recommend you, start reading about [Modes of use](modes_of_use.md), and learn the differences between T-node and S-node before installation.
-
----
-# Installation
-
-**T-NODE installation**: Install Teuton on machine with T-NODE role.
-Installation process:
-
-1. Install Ruby on your system.
-2. `gem install teuton`
-
-Run `teuton version` to check that your installation is ok.
-
-**S-NODE installation**: Install SSH server on every machine with S-NODE role.
-
----
-# Other installation ways
-
-[Installation using scripts](scripts_install.md)
-* Use our scripts to run automatical installation for your OS.
-* Use this way if you don't know how to install Ruby on your system.
-
-[Installation using Vagrant](vagrant_install.md)
-* If you plan to install Teuton into virtual machines, and have Vagrant installed into your real machine, this is the easier way for you.
-
-[Manual installation](manual_install.md)
-* If you don't need help, and want to install Teuton by your own, or there are not installation scripts for your favorite OS, and you don't want to use Vagrant then... here you have information how to install all the required packages for Teuton.
-
-Let's us known your installation difficulties.
-
-Thanks!

data/docs/install/manual_install.md

@@ -1,25 +0,0 @@
-There are diferents Teuton [Modes of use](Modes of use). For every mode there are 2 node typesm and every node has their own installation script:
-
-* **T-node**: This host has installed Teuton software.
-* **S-node**: This host has installed SSH server.
-
----
-
-# T-NODE: Manual installation
-
-| ID | Action            | Details |
-| -- | ----------------- | ----------- |
-| 1  | Git installation  | Run `git --version` to show current version |
-| 2  | Ruby installation | Run `ruby -v` to show current version (2.1.3p242+) |
-| 3  | Rake installation | Run `gem install rake`, then `rake --version` to show current version (10.4.2+). |
-| 4  | Download this project | (a) `git clone https://github.com/dvarrui/teuton.git` (b) Download and unzip [file](https://github.com/dvarrui/teuton-panel/archive/master.zip). |
-| 5  | Gems installation | Run `cd teuton` and `rake gems` |
-| 6  | Final check       | `rake` |
-
----
-
-# S-NODE: Manual installation
-
-* Install SSH server on your host.
-
-> How to [install SSH on Windows](windows-ssh)

data/docs/install/tested_od.md

@@ -1,25 +0,0 @@
-## GNU/Linux
-
-| O.S.      | Version        | Arch   | T-node | S-node |
-| --------- | -------------- | ------ | ------ | ------ |
-| CentOS    | 7              | x86-64 | [?]    | [?]    |
-| Debian    | 9.7.0          | x86-64 | [X]    | [?]    |
-| Fedora    | Workstation 29 | x84-64 | [?]    | [?]    |
-| LinuxMint | 18.3           | x86-64 | [X]    | [?]    |
-| openSUSE  | Leap 15        | x86-64 | [X]    | [X]    |
-| Ubuntu    | 18.04          | x86-64 | [X]    | [X]    |
-
-## Windows
-
-| O.S.    | Version        | Arch   | Nodo-T | Nodo-S |
-| ------- | -------------- | ------ | ------ | ------ |
-| Windows | 7 Enterprise   | x86    | [X]    | [?]    |
-| Windows | 10 Pro         | x86-64 | [X]    | [X]    |
-| Windows | Server 2012 R2 | x86-64 | [?]    | [?]    |
-
-## Mac OS X
-
-| O.S     | Version               | Arch   | T-Node | S-Node |
-| -------- | -------------------- | ------ | ------ | ------ |
-| Mac OS X | El Capitán (10.11.6) | x86-64 | [X]    | [X]    |
-| Mac OS X | Sierra (10.12)       | x86-64 | [X]    | [?]    |

data/docs/install/vagrant_install.md

@@ -1,15 +0,0 @@
-* First, you must have `Vagrant` installed.
-* Create directory for your vagrant project. For example, `mkdir teuton-vagrant`.
-* Move into that directory: `cd teuton-vagrant`.
-* Download required Vagrantfile:
-
-| Vagrantfile        | URL |
-| ------------------ | ----|
-| T-Node OpenSUSE VM | https://raw.githubusercontent.com/teuton-software/vagrant/master/t-node/opensuse/Vagrantfile |
-| S-Node OpenSUSE VM | https://raw.githubusercontent.com/teuton-software/vagrant/master/s-node/opensuse/Vagrantfile |
-
-* Run `vagrant up` to run the Virtual Machine.
-
-**Notice:** If you plan to build T-node and S-node VMs, then you need to use separated directories for every Vagranfile.
-
-> There are more Vagrantfile files for others OS at https://github.com/teuton-software/vagrant/ repository.

data/lib/teuton/command/update.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require 'rainbow'
-
-# Class method Teuton#update
-class TeutonCommand < Thor
-  map ['--update', '-u', 'u'] => 'update'
-  desc 'update', 'Update TEUTON from git repo'
-  long_desc <<-LONGDESC
-  Update TEUTON project, downloading files from git repo.
-  Execute "cd PATH/TO/TEUTON/DIR && git pull".
-
-  Alias: teuton u, teuton -u, teuton --update
-
-  LONGDESC
-  def update
-    dir = File.absolute_path(File.join(File.dirname(__FILE__), '..', '..'))
-    ok = system("cd #{dir} && git pull")
-    if ok
-      puts Rainbow('[ OK ] teuton update').green.bright
-      exit(0)
-    else
-      puts Rainbow('[FAIL] teuton update').red.bright
-      exit(1)
-    end
-  end
-end

data/lib/teuton/rake_function/check.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-# Method RakeFunction#check
-module RakeFunction
-  def self.check(gems)
-    puts "[INFO] Version #{Application::VERSION}"
-    check_gems gems
-    check_tests
-  end
-
-  def self.check_gems(gems)
-    fails = filter_uninstalled_gems(gems)
-    puts "[ERROR] Gems to install!: #{fails.join(',')}" unless fails == []
-  end
-
-  def self.check_tests
-    testfile = File.join('.', 'tests', 'all.rb')
-    a = File.read(testfile).split("\n")
-    b = a.select { |i| i.include? '_test' }
-
-    d = File.join('.', 'tests', '**', '*_test.rb')
-    e = Dir.glob(d)
-
-    unless b.size == e.size
-      puts "[FAIL] Some ruby tests are not executed by #{testfile}"
-    end
-
-    puts "[INFO] Running #{testfile}"
-    system(testfile)
-  end
-
-  def self.filter_uninstalled_gems(list)
-    cmd = `gem list`.split("\n")
-    names = cmd.map { |i| i.split(' ')[0] }
-    fails = []
-    list.each { |i| fails << i unless names.include?(i) }
-    fails
-  end
-end

data/lib/teuton/rake_function/install.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-# Methods Module RakeFunction
-# * opensuse
-# * debian
-# * install_gems
-module RakeFunction
-  def self.opensuse(packages)
-    names = %w[openssh make gcc ruby-dev]
-    options = '--non-interactive'
-    names.each do |n|
-      system("zypper #{options} install #{n}")
-    end
-    install_gems packages, '--no-ri'
-    create_symbolic_link
-  end
-
-  def self.debian(packages)
-    names = %w[ssh make gcc ruby-dev]
-    names.each { |name| system("apt-get install -y #{name}") }
-    install_gems packages, '--no-ri'
-    create_symbolic_link
-  end
-
-  def self.install_gems(list, options = '')
-    fails = filter_uninstalled_gems(list)
-    if !fails.empty?
-      puts "[INFO] Installing gems (options = #{options})..."
-      fails.each do |name|
-        system("gem install #{name} #{options}")
-      end
-    else
-      puts '[ OK ] Gems installed'
-    end
-  end
-end