teuton 2.9.5 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ce9e5fc4e8a37ff624e2c8dc16440236aed569cf1c6b77a49e9efbb6f2b1894
-  data.tar.gz: e2959aef5f909f245c27bf18868ffb7cfd0e7dee376da8f9620b1306f0d8b383
+  metadata.gz: 7936417ce11de28acf3bddee94dcf41b4848742eae8266cce8bf70792ff4e592
+  data.tar.gz: bf8175c24a48e80c6257ab90898b52421157a471010ac1e730b3926962394ef9
 SHA512:
-  metadata.gz: 60567daad6f01a946b227f5eba0c63813bcb9e2d1f466e3d0fbf5407e7e3d1efa120036df6cc29f4e63f627b0e638d3334f34f0182558fb20d66d35bedf113de
-  data.tar.gz: ed5569263c61fa81b42c4764793fe4e917d4395c115b2f95c4456813c62b5e0d86e02a68e79354babc9e2bc471678d6566c032e475bd1944563817163b65ee54
+  metadata.gz: 5a042452b9f025520bce19c4254e799ae9c51e5195804bc8a7d132c63d9271e7de3f03a9c14cb85b799635174a20cddc8a002bd43c565e91395d474059f82d1e
+  data.tar.gz: dd3051109b8b756709e34343bed5301140b33368f4fc3efed751f805960db29495ca9b84bfcaf36251715215a649e53be350cb4cee88e294d74285676a77e837

data/README.md

@@ -4,7 +4,7 @@
 [![Gem Version](https://badge.fury.io/rb/teuton.svg)](https://badge.fury.io/rb/teuton)
 ![GitHub](https://img.shields.io/github/license/dvarrui/teuton)
 
-_Create Unit Test for your machines. Test your infrastructure as code._
+_Test your infrastructure as code._
 
 ![logo](./docs/images/logo.png)
 
@@ -25,7 +25,7 @@ gem install teuton
 
 # Usage
 
-Executing `teuton` command to run example test:
+Use `teuton run TESTPATH` command to run test:
 
 ```console
 > teuton run examples/01-target
@@ -41,7 +41,7 @@ CASE RESULTS
 
 # Features
 
-* Simple DSL to define your tests: `target`, `run`,`expect` and more.
+* Use simple DSL to define your tests: `target`, `run`,`expect` and more.
 * Remote devices only require SSH or Telnet service installed.
 * Output format: txt, html, json, yaml, etc.
 * Multiplatform.

data/docs/commands/README.md

@@ -6,66 +6,38 @@ Available command functions:
 1. [Show help](#1-show-help)
 2. [Show version](#2-show-version)
 3. [Create new test](#3-create-new-test)
-4. [Check teuton test](#4-check-teuton-test)
-5. [Run teuton test](#5-run-teuton-test)
+4. [Check test](#4-check-test)
+5. [Run test](#5-run-test)
+6. [Show test info as README file](#6-show-test-info-as-readme-file)
 
 # 1. Show help
 
-```bash
-teuton
-```
-
-Example:
-
-```bash
-> teuton
-Commands:
-  teuton [run] [OPTIONS] DIRECTORY  # Run challenge from directory
-  teuton check [OPTIONS] DIRECTORY  # Test or check challenge contents
-  teuton help [COMMAND]             # Describe available commands or one specific command
-  teuton new DIRECTORY              # Create skeleton for a new project
-  teuton readme DIRECTORY           # Create README.md file from challenge contents
-  teuton version                    # Show the program version
-
-```
+Show help about command functions.
 
-Alias:
+Usage: 
+* `teuton help`
+* `teuton help FUNCTION_NAME`
 
-* `teuton h`
-* `teuton -h`
-* `teuton --help`
+Alias: `teuton h`,`teuton -h`, `teuton --help`
 
 # 2. Show version
 
-```bash
-teuton version
-```
-
-Example:
-
-```bash
-$ teuton version                               
-teuton (version 2.2.0)
-```
+Show current version.
 
-Alias:
+Usage: `teuton version`
 
-* `teuton v`
-* `teuton -v`
-* `teuton --version`
+Alias: `teuton v`, `teuton -v`, `teuton --version`
 
 # 3. Create new test
 
-Create teuton test skeleton.
+Create test skeleton.
 
-```bash
-teuton new foo
-```
+Usage: `teuton new foo`
 
 Example:
 
 ```console
-> teuton new foo
+$ teuton new foo
 
 [INFO] Creating foo project skeleton
 * Create dir        => foo
@@ -78,24 +50,18 @@ This command will create the next structure:
 | File/Directory  | Description    |
 | --------------- | -------------- |
 | foo             | Base directory |
-| foo/start.rb    | Main Script    |
+| foo/start.rb    | Main file with test definitions |
 | foo/config.yaml | YAML configuration file |
 
-Alias:
-
-* `teuton n foo`
-* `teuton -n foo`
-* `teuton --new foo`
+Alias: `teuton n foo`, `teuton -n foo`, `teuton --new foo`
 
-# 4. Check teuton test
+# 4. Check test
 
-```console
-teuton check DIRPATH
-```
+Check test and config files from DIRPATH folder.
 
-Description: this command check teuton test and config files located into DIRPATH folder.
+Usage: `teuton check DIRPATH`
 
-[Example](example_check.md)
+[Example](check-example.md)
 
 | Command                      | Description |
 | ---------------------------- | ----------- |
@@ -104,39 +70,18 @@ Description: this command check teuton test and config files located into DIRPAT
 | teuton check path/to/file/foo.rb | Test content of foo.rb and foo.yaml files. |
 | teuton check path/to/file/foo.rb --cname=demo | Test content of foo.rb and demo.yaml files.|
 
-Alias:
-
-* `teuton c foo`
-* `teuton -c foo`
-* `teuton --check foo`
+Alias: `teuton c foo`, `teuton -c foo`, `teuton --check foo`
 
-# 5. Run teuton test
+# 5. Run test
 
-```bash
-teuton run DIRPATH
-```
+Read about [how to run tests](howto-run-tests.md)
 
-Description: this command run teuton test located into DIRPATH folder.
+# 6. Show test info as README file
 
-[Example](example_run.md)
-
-Alias:
-
-* `teuton foo`
-
-# 6. Show README
-
-```bash
-teuton readme DIRPATH
-```
+Create a readme file for the exercise.
 
-Read test and config files content, and display information about
-what kind of problem/exercise it is going to be evaluated. The students need this
-information to resolv the problem/exercise into their machines.
+Usage: `teuton readme DIRPATH > README.md`
 
-The teacher could write this information or may use this command to generate automaticaly.
+This function reads test and config files, and generate Markdown output with guidelines and target descriptions about the exercise.
 
-Alias:
-* `teuton r DIRPATH`
-* `teuton -r DIRPATH`
-* `teuton --readme DIRPATH`
+Alias: `teuton r DIRPATH`, `teuton -r DIRPATH`, `teuton --readme DIRPATH`

data/docs/commands/{example_check.md → check-example.md}

@@ -9,16 +9,12 @@
 | --cpath          | Specify path to config file | TEST-FOLDER/config.yaml |
 | --cname          | Specify name to config file | config.yaml |
 
-Usage:
-
-```
-teuton check PATH-TO-TEST-FOLDER
-```
+Usage: `teuton check PATH-TO-TEST-FOLDER`
 
 Example:
 
 ```bash
-❯ teuton check examples/02-target
+$ teuton check examples/02-target
 
 +----------------------------+
 | GROUP: Learn about targets |

data/docs/commands/{example_run.md → howto-run-tests.md}

@@ -1,21 +1,25 @@
 
 [<< back](README.md)
 
-1. [Run test](#1-run-test)
-2. [Command options](#2-command-options)
+# Run test
+
+Run test located into DIRPATH folder.
+
+Usage: `teuton run DIRPATH`
+
+Alias: `teuton foo`
+
+1. [Example](#1-example)
+2. [Options](#2-options)
 3. [Choosing config file](#3-choosing-config-file)
 
-# 1. Run test
+# 1. Example
 
 Running Teuton test located into `example/01-target` folder.
 
 ```bash
-teuton run example/01-target
-```
-
-Example:
+$ teuton run example/01-target
 
-```bash
 ------------------------------------
 Started at 2023-01-21 13:32:24 +0000
 F
@@ -29,10 +33,12 @@ CASE RESULTS
 +------+-----------+-------+-------+
 ```
 
-# 2. Command options
+> Output files are saved into `var/01-target` folder.
+
+# 2. Options
 
 ```
-> teuton help run
+$ teuton help run
 
 Usage:
   teuton [run] [OPTIONS] DIRECTORY

data/docs/install/README.md

@@ -2,14 +2,18 @@
 
 # Installation
 
-There are 2 types of nodes (hosts), so there are 2 installations:
+**Teuton installation**
 
-| ID | Software | Description |
-| -- | -------- | ----------- |
-| **T-node** | [Teuton installation](t-node.md) | T-NODE host monitors one or severals S-NODE hosts |
-| **S-node** | [SSH server installation](s-node.md) | S-NODE hosts are monitorized by T-NODE host |
+We call a device with Teuton installed as t-node. [T-NODE](t-node.md) host monitors one or severals S-NODE hosts.
+1. Install Ruby on your system.
+2. `gem install teuton`
 
-> Read [modes of use](modes_of_use.md) to know more about differents T-NODE/S-NODE schemes.
+**SSH server installation**
+
+We call e device with SSH/Telnet service as s-node. [S-NODE](s-node.md) hosts are monitorized by T-NODE host.
+1. Install SSH service.
+
+Read [modes of use](modes_of_use.md) to know more about differents T-NODE/S-NODE schemes.
 
 ## Tested OS list
 

data/docs/install/s-node.md

@@ -6,7 +6,7 @@ Install SSH server on every machine with S-NODE role.
 
 **S-node**: Host where SSH server is installed. This hosts are monitorized by T-NODE host.
 
-**S-node GNU/Linux installation**
+**GNU/Linux installation**
 
 Run this command as `root` user:
 
@@ -14,7 +14,7 @@ Run this command as `root` user:
 wget -qO- https://raw.githubusercontent.com/teuton-software/teuton/master/install/linux/s-node_install.sh | bash
 ```
 
-**S-node Windows installation**
+**Windows installation**
 
 Requirements:
 * Windows 7+ / Windows Server 2003+
@@ -26,7 +26,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/s-node_install.ps1'))
 ```
 
-**S-node Mac OS X installation**
+**Mac OS X installation**
 
 Run this command as `root` user:
 

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/13-feedback.md

@@ -37,12 +37,13 @@ Executing `teuton run examples/13-feedback`, we get this output:
 
 ```
 GROUPS
-- Preserve output reports
+- Hide feedback messages from output
     01 (1.0/1.0)
-        Description : Exits user Obiwan
-        Command     : ********
-        Duration    : 0.002 (local)
-        Alterations : *******************
-        Expected    : ************** (String)
-        Result      : ******** (String)
+        Description : Service SSH disabled
+        Command     : *********************
+        Output      : *********
+        Duration    : 0.011 (local)
+        Alterations : **********************
+        Expected    : **************
+        Result      : ********
 ```

data/lib/teuton/case/case.rb

@@ -15,15 +15,11 @@ class Case
   include DSL
   include Verbose
 
-  attr_accessor :action # Updated by ExecuteManager
-  attr_accessor :result # Updated by ExecuteManager
-  attr_accessor :sessions # Updated by ExecuteManager
-  attr_accessor :conn_status # Updated by ExecuteManager
-
-  attr_reader :id
-  attr_reader :config # Readed by ExecuteManager
-  attr_reader :uniques
-  attr_reader :skip
+  # Updated by ExecuteManager
+  attr_accessor :action, :result, :sessions, :conn_status
+  # Readed by ExecuteManager
+  attr_reader :id, :config, :uniques, :skip
+
   @@id = "01" # First case ID value
 
   def initialize(config)

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 { it }).size
-      state[:fails] = (state[:steps].select { !it }).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/send.rb

@@ -2,7 +2,7 @@
 
 module DSL
   # * send, tempfile, tempdir, remote_tempdir, remote_tempfile
-  def send(args = {})
+  def send(logfile, args = {})
     return if skip?
 
     return unless args[:copy_to]
@@ -10,10 +10,10 @@ module DSL
     host = args[:copy_to].to_s
     return unless @conn_status[host].nil?
 
-    ip = get((host + "_ip").to_sym)
-    username = get((host + "_username").to_sym).to_s
-    password = get((host + "_password").to_sym).to_s
-    port = get((host + "_port").to_sym).to_i
+    ip = get(:"#{host}_ip")
+    username = get(:"#{host}_username").to_s
+    password = get(:"#{host}_password").to_s
+    port = get(:"#{host}_port").to_i
     port = 22 if port.zero?
 
     filename = "#{@report.filename}.#{@report.format}"
@@ -32,11 +32,16 @@ module DSL
       Net::SFTP.start(ip, username, password: password, port: port) do |sftp|
         sftp.upload!(localfilepath, remotefilepath)
       end
-      msg = Rainbow("==> Case #{get(:tt_members)}: report (#{remotefilepath}) copy to (#{ip})").green
+      msg = Rainbow("==> [ OK ] Case #{get(:tt_members)}: report (#{remotefilepath}) copy to (#{ip})").green
       verboseln(msg)
-    rescue
-      msg = Rainbow("==> [FAIL] #{get(:tt_members)}: 'scp #{localfilepath}' to #{remotefilepath}").red
+      logfile.write "#{msg}\n"
+      logfile.flush
+    rescue => e
+      msg = Rainbow("==> [FAIL] Case #{get(:tt_members)}: 'scp #{localfilepath}' to #{remotefilepath}").red
+      msg += "\n--> [ERROR] #{e}"
       verboseln(msg)
+      logfile.write "#{msg}\n"
+      logfile.flush
     end
   end
 

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/dsl.rb

@@ -1,24 +1,15 @@
 require_relative "../utils/project"
 require_relative "case_manager"
 
-def use(filename)
-  filename += ".rb"
-  rbfiles = File.join(Project.value[:project_path], "**", filename)
-  files = Dir.glob(rbfiles)
-  findfiles = []
-  files.sort.each { |f| findfiles << f if f.include?(filename) }
-  begin
-    require_relative findfiles.first
-    Project.value[:uses] << File.basename(findfiles.first)
-  rescue
-    puts "[ERROR] Unknown file : #{filename}"
-    puts "        Check line   : use '#{filename}'"
-    exit 1
-  end
-end
+# DSL instructions that apply equally to all cases.
+# Therefore, they are stored globally in the case manager.
+# * define_macro
+# * group
+# * play
+# * use
 
 def define_macro(name, *args, &block)
-  Project.value[:macros][name] = {args: args, block: block}
+  Project.value[:macros][name] = { args: args, block: block }
 end
 alias def_macro define_macro
 alias defmacro define_macro
@@ -27,7 +18,7 @@ alias defmacro define_macro
 # @param name (String) Group name
 # @param block (Block) Tests code
 def group(name, &block)
-  Project.value[:groups] << {name: name, block: block}
+  Project.value[:groups] << { name: name, block: block }
 end
 alias task group
 
@@ -36,3 +27,19 @@ def play(&block)
   CaseManager.new.play(&block)
 end
 alias start play
+
+def use(filename)
+  filename += ".rb"
+  rbfiles = File.join(Project.value[:project_path], "**", filename)
+  files = Dir.glob(rbfiles)
+  findfiles = []
+  files.sort.each { |f| findfiles << f if f.include?(filename) }
+  begin
+    require_relative findfiles.first
+    Project.value[:uses] << File.basename(findfiles.first)
+  rescue StandardError
+    puts "[ERROR] Unknown file : #{filename}"
+    puts "        Check line   : use '#{filename}'"
+    exit 1
+  end
+end

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
@@ -21,9 +22,7 @@ class ExportManager
     end
 
     options = strings2symbols(args)
-    if options[:format].nil?
-      options[:format] = default_format
-    end
+    options[:format] = default_format if options[:format].nil?
 
     # Step 1: Export case reports
     threads = []
@@ -57,13 +56,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 " "