teuton 2.1.8 → 2.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfb81fb786d0111b84d43f68a98b222639f37cc620fcf1156bf8722416f78a25
-  data.tar.gz: 71ba4a3325eb5d2ed76b64efbe9476fc77d82794d620416482a7ac57b835f692
+  metadata.gz: c3c302d5d5b9c2d2f2dc70ca29ae86a2841306b32d0274948fd2b801f1171e28
+  data.tar.gz: f3cab7959971634f856db2ec691760a1c25cda19cfaa922c6ab6fe90aa366bd0
 SHA512:
-  metadata.gz: 599b8e1e1dece4f9a3afad33c1d7e71417a280f31ed7e78632d62d8b2819d8cb99d04409b152a1e1cabfa90191e244863ca02593fbe44638ddd9fde9bdb682d7
-  data.tar.gz: d781970ef1d69087099915f6474df31af872fd64823e2643279407df6f9a83731127696c91bb5b8a0627b3543d0cfb6dac8c2db29b0edb006a64222a589ea01d
+  metadata.gz: 5875b36ddc9caebcf9e28fc5d01cf2b3eaa9f4c8220f8e19f85f7b79af5647518703a8f69f83435a158b9e92a568f8aa5a699f8b38f80936eba030a270fc4199
+  data.tar.gz: 638adf64c88bf2f481ac7e10e4b427266c64c5ced38d47ed9f86456e0f53196adfe45402ef4114ba319f586fd54a80e7253cdf9aedf2dc37f28b570761f7bdfc

data/README.md

@@ -17,25 +17,22 @@ Teuton allow us:
 * Write test units for real or virtual machines using simple DSL.
 * Check compliance with requirements on remote machines.
 
----
 # Documentation
 
 * [Installation](https://github.com/teuton-software/teuton/tree/devel/docs/install/README.md)
     1. Install Ruby on your system.
-    2. `gem install teuton`
+    1. `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)
+* [Teuton language](https://github.com/teuton-software/teuton/tree/devel/docs/dsl/README.md)
 
----
 # Features
 
 * [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.
+* Multiplatform.
+* Remote machines only require SSH or Telnet service installed.
+* Developed using ruby language.
 
----
 # Contact
 
 * **Email**: `teuton.software@protonmail.com`

data/bin/check_teuton

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+
+module CheckTeuton
+  ##
+  # Start check_teuton
+  # @param arg (String) First input argument
+  def self.start(arg)
+    show_help if arg.nil? or arg == 'help'
+    run(arg)
+  end
+
+  ##
+  # Show help
+  def self.show_help()
+    puts "check_teuton"
+    puts "  help              => Show this help"
+    puts "  PATH/TO/CASE/YAML => Read yaml for Nagios/Icinga"
+    exit 0
+  end
+
+  def self.run(filename)
+    unless File.exist?(filename)
+      puts "UNKNOWN - File not found! (#{filename})"
+      exit 3
+    end
+    data = YAML.load(File.read(filename))
+    testname = data[:config][:tt_testname]
+    grade = data[:results][:grade].to_i
+    if grade == 100
+      puts "OK - #{testname}/case-#{data[:results][:case_id]} Grade=100%"
+      exit 0
+    elsif grade < 50
+      puts "CRITICAL - #{testname}/case-#{data[:results][:case_id]} Grade=0%"
+      exit 2
+    end
+    puts "WARNING - #{testname}/case-#{data[:results][:case_id]} Grade=#{grade}%"
+    exit 1
+  end
+end
+
+CheckTeuton.start(ARGV[0])

data/docs/changelog/contributions.md

@@ -0,0 +1,32 @@
+
+# TO-DO list
+
+List of things to do, classified into 3 sections:
+* (A) I know read and write.
+* (B) I work as IT teacher
+* (C) I want to program ruby language
+
+> I write this list without any criteria.
+> Only an unordered list of interesting/usefull things to be done.
+
+## Section A
+
+Documentation
+
+* Revise documentation.
+* Make videos showing how to use this tool
+    * Video about download and install this tool
+    * Test installation scripts
+    * Vídeo with Windows installation.
+    * Video using examples 01 to 05...
+* Write a special documentation for novice
+
+## Section B
+
+* Create your own (simple or complex) teuton tests.
+* Upload your own tests to github.com/teuton-software/challenge repository.
+
+## Section C
+
+* Contact with us to help develop this tool :-)
+

data/docs/changelog/v2.1.md

@@ -137,3 +137,25 @@ Add new features to DSL
 * Use Bundler to install gems instead of rake.
 * It will be usefull use sysadming-game as gem? And install it with `gem install teuton`.
 * Vagrant: test how to use vagrant machines as case hosts.
+
+---
+Info sobre novedades de la versión 2.1
+1. Teuton readme y dsl readme
+2. Macros de define macro
+3. Export yaml y html
+4. Teuton --no-color
+5 teuton run --case
+6 teuton run --cname
+7 teuton run --cpath
+8 actualizar formatos de salida
+9 instalación mediante gemas
+10 teuton panel
+11 teuton client y server
+12 nuevos nombres de comandos...
+13 cambio de goto a run
+....
+
+* config -> host_port
+* teuton run into
+* resume.html
+* txt format -> remove conn_errors when errors = 0

data/docs/changelog/v2.2.md

@@ -0,0 +1,29 @@
+
+Para la 2.2 entonces:
+1. Metadatis con tags y búsqueda. Facilitar a los usuarios encontrar retos.
+2. Teuton run con estado para la corrección progresiva. Esto da juego a diferentes formas de usar la herramienta. 
+3. Teuton web para recibir peticiones de los clientes... ?!
+4. Editor de ficheros de configuración.... una especie de asistente de ayuda..  
+5. Editor de tests ?! .... lo veo complejo... a menos que se empiece por una versión simplificada.. 
+6. Empaquetar tests para facilitar su movilidad . Esto se combina muy bien con la opción de búsqueda de retos.... pensar en firma gpg o md5 de comprobación etc..  
+7  crear una" librería " de las macros más frecuentes?!... una ayuda para facilitar la creación de test... esto se puede emparejar con el editor de test... 
+8 actualizar las pruebas con vagrant para la versión actual. Mejora de la calidad del código. 
+9. Documentar y hacer videos. 
+10. Tener foros de la comunidad o presencia en reddit o stackoverflow.... o algo parecido???
+...
+Esta es una lista de ideas para la versión 2.2 y que no se me olvide... lo podemos ir ajustando 😊
+
+
+* `result.test("...")`
+* `send :email_to => :members_emails`
+
+Gamification
+* When students demand help they could recibe some advises.
+* Define a loop of executions of our activity. For example:
+  every 5 minutes, run the activity, and repeat this 10 times.
+  `start :times=>10, :duration=>5 do`      
+* More ideas: bonus, lives, etc.
+
+Create 2 evaluation modes:
+1. Evaluate targets (current mode): `start :score=>:targets do ...`
+1. Evaluate task: `start :score=>:tasks do ...`

data/docs/commands/README.md

@@ -1,10 +1,108 @@
+[<< back](../../README.md)
 
 # Commands
 
-| Command               | Description                            |
-| --------------------- | -------------------------------------- |
-| teuton                | [Show help](help.md)                   |
-| teuton version        | [Show version](show_version.md)        |
-| teuton create DIRPATH | [Create skeleton project](create_skeleton.md) into DIRPATH |
-| teuton play DIRPATH   | [Run a Test Unit](run_test_unit.md) contained into DIRPATH |
-| teuton test DIRPATH   | [Revise Test without run it](revise_test.md)    |
+Available command functions:
+1. Show help
+2. Show version
+3. Create new test skeleton
+4. Check teuton test
+5. Run teuton test
+    * Running Teuton test
+    * Command options
+    * Choosing other config file name
+
+# 1. Show help
+
+Usage:
+
+```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
+
+```
+
+# 2. Show version
+
+Usage:
+
+```bash
+teuton version
+```
+
+Example:
+
+```bash
+$ teuton version                               
+teuton (version 2.1.9)
+```
+
+Alias:
+* `teuton v`
+* `teuton -v`
+* `teuton --version`
+
+# 3. Create new test skeleton
+
+Usage:
+
+```bash
+teuton new foo
+```
+
+Example:
+
+```bash
+> teuton new foo
+
+[INFO] Creating foo project skeleton
+* Create dir        => foo
+* Create file       => foo/config.yaml
+* Create file       => foo/start.rb
+* Create file       => foo/.gitignore
+```
+
+This command will create the next structure:
+
+| File/Directory  | Description    |
+| --------------- | -------------- |
+| foo             | Base directory |
+| foo/start.rb    | Main Script    |
+| foo/config.yaml | YAML configuration file |
+| foo/.gitignore  | By default, ignore YAML files to be upload on git repository |
+
+# 5. Check teuton test
+
+Usage:
+
+```bash
+teuton check DIRPATH
+```
+
+Description: this command check teuton test source files,located into DIRPATH folder.
+
+[Example](example_check.md)
+
+# 4. Run teuton test
+
+Usage:
+
+```bash
+teuton run DIRPATH
+```
+
+Description: this command run teuton test located into DIRPATH folder.
+
+[Example](example_run.md)

data/docs/commands/example_check.md

@@ -0,0 +1,54 @@
+[<< back](README.md)
+
+# Check Teuton Test
+
+Objective: Revise Teuton test located into `example\learn-01-target`.
+
+Usage:
+
+```
+teuton check examples/learn-01-target
+```
+
+Example:
+
+```bash
+> teuton check examples/learn-01-target
+[INFO] ScriptPath => examples/learn-01-target/start.rb
+[INFO] ConfigPath => examples/learn-01-target/config.yaml
+[INFO] Pwd        => /mnt/home/leap/proy/repos/teuton.d/teuton
+[INFO] TestName   => learn-01-target
+
++----------------------------+
+| GROUP: Learn about targets |
++----------------------------+
+(001) target      Create user david
+      weight      1.0
+      run         'id david' on localhost
+      expect      david (String)
+
++--------------+-------+
+| DSL Stats    | Count |
++--------------+-------+
+| Groups       | 1     |
+| Targets      | 1     |
+| Goto         | 1     |
+|  * localhost | 1     |
+| Uniques      | 0     |
+| Logs         | 0     |
+|              |       |
+| Gets         | 0     |
+| Sets         | 0     |
++--------------+-------+
++----------------------+
+| Revising CONFIG file |
++----------------------+
+[WARN] File /mnt/home/leap/proy/repos/teuton.d/teuton/examples/learn-01-target/config.yaml not found!
+[INFO] Recomended content:
+---
+:global:
+:cases:
+- :tt_members: VALUE
+```
+
+> The check process notifies that this Test Unit hasn't config file, and Teuton recommends content for config file. But it isn't necessary for this example.

data/docs/commands/example_run.md

@@ -0,0 +1,112 @@
+
+[<< back](README.md)
+
+1. [Run test](#1-run-test)
+2. [Command options](#2-command-options)
+3. [Choosing config file](#3-choosing-config-file)
+
+# 1. Run test
+
+Description: Running Teuton test located into `example/learn-01-target` folder.
+
+Usage:
+
+```bash
+teuton run example/learn-01-target
+```
+
+Example:
+
+```bash
+> teuton run examples/learn-01-target
+[INFO] ScriptPath => examples/learn-01-target/start.rb
+[INFO] ConfigPath => examples/learn-01-target/config.yaml
+[INFO] Pwd        => /mnt/home/leap/proy/repos/teuton.d/teuton
+[INFO] TestName   => learn-01-target
+
+==================================
+Executing [teuton] (version 2.1.9)
+[INFO] Running in parallel (2020-04-19 14:09:41 +0100)
+.
+[INFO] Duration = 0.004    (2020-04-19 14:09:41 +0100)
+==================================
+
+INITIAL CONFIGURATIONS
++---------------+-------------------------------------------+
+| tt_title      | Executing [teuton] (version 2.1.9)        |
+| tt_scriptname | examples/learn-01-target/start.rb         |
+| tt_configfile | examples/learn-01-target/config.yaml      |
+| tt_pwd        | /mnt/home/leap/proy/repos/teuton.d/teuton |
+| tt_testname   | learn-01-target                           |
+| tt_sequence   | false                                     |
++---------------+-------------------------------------------+
+
+CASE RESULTS
++------+-----------+-------+-------+
+| CASE | MEMBERS   | GRADE | STATE |
+| 01   | anonymous | 100.0 |       |
++------+-----------+-------+-------+
+
+FINAL VALUES
++-------------+---------------------------+
+| start_time  | 2020-04-19 14:09:41 +0100 |
+| finish_time | 2020-04-19 14:09:41 +0100 |
+| duration    | 0.004231917               |
++-------------+---------------------------+
+```
+
+# 2. Command options
+
+Usage: `teuton help run`
+
+```
+Usage:
+  teuton [run] [OPTIONS] DIRECTORY
+
+Options:
+  [--export=EXPORT]        
+  [--cname=CNAME]          
+  [--cpath=CPATH]          
+  [--case=CASE]            
+  [--color], [--no-color]  
+  [--quiet], [--no-quiet]     
+```
+
+| ID | Command              | Descriptiont |
+| -- | -------------------- | ------------ |
+| 01 | teuton foo           | Run foo/start.rb, with config file foo/config.yaml |
+| 02 | teuton run foo      | Run foo/start.rb, with config file foo/config.yaml |
+| 03 | ruby teuton foo      | Same as 01 on Windows OS |
+| 04 | ruby teuton run foo | Same as 02 on WIndows OS |
+| 05 | teuton . | Run ./start.rb with ./config.yaml file |
+| 06 | teuton run --export=json foo | Run foo/start.rb and force json format during exporting. Others output formats availables are: txt, colored_text, json, yaml |
+| 07 | teuton run --cname=rock foo | Run foo/start.rb with foo/rock.yaml config file |
+| 08 | teuton foo/demo42.rb | Run foo/demo42.rb with foo/demo42.yaml config file |
+| 08 | teuton run --cpath=starwars/jedi.yaml foo | Run foo/start.rb with starwars/jedi.yaml config file |
+| 09 | teuton run --case=6,16 foo | Run foo/start.rb with foo/config.yaml config file but only for case id '06' and '16' |
+
+# 3. Choosing config file
+
+**Default names:**:
+By default, when you run `teuton run foo`, this will search for:
+* `foo/start.rb` test file and
+* `foo/config.yaml` config file.
+
+**Using cname param:**
+It's posible execute `teuton run --cname=rock foo`, and choose diferent config file into projet folder:
+* `foo/start.rb` test file and
+* `foo/rock.yaml` config file.
+
+> `cname` param searchs YAML config file into the same project folder.
+
+**Using cpath param:**
+An also, it's posible execute `teuton run --cpath=/home/david/startwars.yaml foo`, and choose config file using its absolute path:
+* `foo/start.rb` test file and
+* `/home/david/starwars.yaml` config file.
+
+> `cpath` param selects YAML config file, from the specified path.
+
+**Using diferent main rb name:**
+When you execute `teuton run foo/mazingerz.rb`, this will search for:
+* `foo/mazingerz.rb` test file and
+* `foo/mazingerz.yaml` config file.