teuton 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 118f06096e18d4e4e8a820460912f2585fa6cb2a22297defd54f45a59306cc37
-  data.tar.gz: 871b5189621de21ecf4c3de56434a7ded8c20fe486459c7bc3f7605b5c3c07ee
+  metadata.gz: 6be2bd8d7d03e7b38cb06020f6ade96798f5879c24cd5289976074e5ac3e1538
+  data.tar.gz: a96bd68b4b70daddf6d4ba979613ba1e5e546e610e90c0d5817b568dbf3b7844
 SHA512:
-  metadata.gz: 523106ae12c17ff1fc1de7d43b276c51c17c3c92cf7e0498f12fcd665650dc4e98bc0decf8569985a81baa1cc83dc3dccb26f9a81102f072034fb0fa26199219
-  data.tar.gz: 456521fc910d9f2fa4787c05239a40701c3366584c897723e213032351c4bfed79a3216d97e60758c3cbafcf05099d60b1a425b61483ca75bf86f1dc61a0826c
+  metadata.gz: 65789b7321e8799298357c421a741dc9ca67ff41c2abd7e64e87528902e285673e819d7355c8a31c4e984df07f2789c43c0268715d5702f416651544a21a0276
+  data.tar.gz: cb219ecb9b826e4c5e7f5216b58a497cb9761fb03d37fa20f1d78fb7b79f7003048523f5492f63087a9e22d4476061fe3857c4219eb52903fba7b90f693fd4a6

data/README.md

@@ -1,37 +1,28 @@
 
-# TEUTON Software
+# TEUTON Software (version 2.1)
 
-_Create Unit Test for your machines.
-Test your infraestructure as code._
+_Create Unit Test for your machines, and
+test your infraestructure as code._
 
-![logo](./docs/logo.png)
+![logo](./docs/images/logo.png)
 
-Intrastructure test, useful for:
+Teuton is an intrastructure test tool, useful for:
 * Sysadmin teachers to evaluate students remote machines.
 * Sysadmin apprentices to evaluate their learning process as a game.
 * Professional sysadmin to monitor remote machines.
 
-Allow us:
+Teuton allow us:
 * Write test units for real or virtual machines using simple DSL.
 * Check compliance with requirements on remote machines.
 
 # Documentation
 
-Read [Teuton Wiki](https://github.com/teuton-software/teuton/wiki) documentation.
-
-* [Installation](https://github.com/teuton-software/teuton/wiki/Installation)
-    * [Modes](https://github.com/teuton-software/teuton/wiki/Modes-of-use)
-    * [Installation scripts](https://github.com/teuton-software/teuton/wiki/Installation-using-scripts)
-    * [Vagrant](https://github.com/teuton-software/teuton/wiki/Installation-using-Vagrant)
-    * [Manual](https://github.com/teuton-software/teuton/wiki/Manual-installation)
-* [Learning](https://github.com/teuton-software/teuton/wiki/Learning)
-    * [Quick demo](https://github.com/teuton-software/teuton/wiki/Quick-demo)
-    * [Example 01 - Target](https://github.com/teuton-software/teuton/wiki/Example-01---Target)
-    * [Example 02 - Configfile](https://github.com/teuton-software/teuton/wiki/Example-02---Config-file)
-    * [Example 03 - Remote hosts](https://github.com/teuton-software/teuton/wiki/Example-03---Remote-hosts)
-    * [Example 04 - Use](https://github.com/teuton-software/teuton/wiki/Example-04---Use)
-* [Commands](https://github.com/teuton-software/teuton/wiki/Commands)
-* [DSL keywords](https://github.com/teuton-software/teuton/wiki/DSL-keywords)
+Teuton [documentation](./docs).
+
+* [Installation](docs/install/install.md)
+* [Learning](docs/learn/README.md)
+* [Commands](docs/commands/commands.md)
+* [DSL keywords](docs/dsl/keywords.md)
 
 # Features
 

data/docs/Challenge-Server-Project.md

@@ -0,0 +1,50 @@
+**Introducción**
+
+Esta idea surgió a partir de varias conversaciones con _"Sergi"_.
+
+Hablábamos mucho sobre _"ProgramaMe"_. Esto es un concurso donde los alumnos resuelven los retos de programación(Java, Python) en sus propias máquinas; y al terminar, el fichero con el programa, lo suben a la web central de _"ProgramaME"_. Aquí ProgramaMe se los corrige y puntúa.
+A a los dos nos gusta mucho el proyecto de concurso de retos ProgramaMe... pero... queríamos incorporar otra línea de retos pero NO de programación. Esto es, retos de admnistradores de sistemas.
+
+Si te interesa el tema, sigue leyendo que te proponemos una solución uniendo productos que ya existen y de licencia libre.
+
+---
+
+# Servidor
+
+Para empezar necesitaremos un servidor o una máquina con IP pública.
+La llamaremos (`castillo`). Esto normalmente se contrata.
+
+En `castillo` instalaremos un servidor Web, donde pondremos descargar:
+* `Aldeas`:
+    * Una aldea es una máquinas virtual con el software `teuton` preinstalado.
+    * Habrán aldeas Debian, OpenSUSE, Ubuntu, etc.
+* `Retos`.
+    * Habrá un conjunto de retos clasificados por dificultad.
+    * Para cada reto tendremos: Un documento de texto y un fichero rb.
+    * El documento de texto será una explicación/descripción del reto.
+    * El fichero rb serán las instrucciones para verificar el reto.
+* `Aventuras`
+    * Las aventuras serán un conjunto organizado de retos.
+
+---
+
+# El profesor
+
+* Tendrá el aula preparada con ordenadores para cada alumno y con el Virtual Box instalado.
+* Elegirá una aventura donde inscribirá a sus alumnos y dará comienzo el juego.
+
+---
+
+# Los alumnos
+
+1. Los alumnos empiezan descargando la `aldea` que necesitan.
+2. Entran en la MV `aldea`.
+3. Descargan también la `aventura` escogida (conjunto organizado de retos)
+4. reto = 1
+5. Resolvemos el reto
+    * Leen la descripción/información del reto.
+    * Realizan el reto dentro de la `aldea`.
+    * Ejecutan `teuton` para el reto actual. Los resultados de envían automáticamente desde la `aldea` hasta el `castillo`
+6. Los alumnos pueden consultar su puntuación y la clasificación desde la web del `castillo`. Si no les gusta el resultado pueden volver al punto 5 y repetirlo.
+7. reto = reto + 1
+8. Ir al paso 5. Así hasta que se acabe el tiempo o que se acaben los retos.

data/docs/changelog/servidor-de-retos.md

@@ -0,0 +1,53 @@
+
+# Proyecto: Servidor de retos
+
+**Introducción**
+
+Esta idea surgió a partir de varias conversaciones con _"Sergi"_.
+
+Hablábamos mucho sobre _"ProgramaMe"_. Esto es un concurso donde los alumnos resuelven los retos de programación(Java, Python) en sus propias máquinas; y al terminar, el fichero con el programa, lo suben a la web central de _"ProgramaME"_. Aquí ProgramaMe se los corrige y puntúa.
+A a los dos nos gusta mucho el proyecto de concurso de retos ProgramaMe... pero... queríamos incorporar otra línea de retos pero NO de programación. Esto es, retos de admnistradores de sistemas.
+
+Si te interesa el tema, sigue leyendo que te proponemos una solución uniendo productos que ya existen y de licencia libre.
+
+---
+
+# Servidor
+
+Para empezar necesitaremos un servidor o una máquina con IP pública.
+La llamaremos (`castillo`). Esto normalmente se contrata.
+
+En `castillo` instalaremos un servidor Web, donde pondremos descargar:
+* `Aldeas`:
+    * Una aldea es una máquinas virtual con el software `teuton` preinstalado.
+    * Habrán aldeas Debian, OpenSUSE, Ubuntu, etc.
+* `Retos`.
+    * Habrá un conjunto de retos clasificados por dificultad.
+    * Para cada reto tendremos: Un documento de texto y un fichero rb.
+    * El documento de texto será una explicación/descripción del reto.
+    * El fichero rb serán las instrucciones para verificar el reto.
+* `Aventuras`
+    * Las aventuras serán un conjunto organizado de retos.
+
+---
+
+# El profesor
+
+* Tendrá el aula preparada con ordenadores para cada alumno y con el Virtual Box instalado.
+* Elegirá una aventura donde inscribirá a sus alumnos y dará comienzo el juego.
+
+---
+
+# Los alumnos
+
+1. Los alumnos empiezan descargando la `aldea` que necesitan.
+2. Entran en la MV `aldea`.
+3. Descargan también la `aventura` escogida (conjunto organizado de retos)
+4. reto = 1
+5. Resolvemos el reto
+    * Leen la descripción/información del reto.
+    * Realizan el reto dentro de la `aldea`.
+    * Ejecutan `teuton` para el reto actual. Los resultados de envían automáticamente desde la `aldea` hasta el `castillo`
+6. Los alumnos pueden consultar su puntuación y la clasificación desde la web del `castillo`. Si no les gusta el resultado pueden volver al punto 5 y repetirlo.
+7. reto = reto + 1
+8. Ir al paso 5. Así hasta que se acabe el tiempo o que se acaben los retos.

data/docs/changelog/todo.md

@@ -0,0 +1,46 @@
+
+# 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 Spanish docs (ES - Mejorar la documentación en español)
+* Revise English documents. Update english version with changes done into spanish version.
+* 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) educational test.
+* Upload your own educational test to this repository.
+
+## Section C
+
+* `goto :host1, :puppet => "Puppet instructions"`
+* `goto :host1, :chef => "Chef instructions"`
+* `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/changelog/v2.0.md

@@ -0,0 +1,17 @@
+
+# CHANGELOG
+
+## 2019
+
+|Date      |Version |Changes |
+|--------- |------- |------- |
+| August 2019 | 2.0.4 | TEUTON project grew up and was divided into the folowing repositories: teuton, challenges, panel, resources and vagrant. Documentation has been moved into respository teuton wiki. Only maintain English docs. |
+|January 2019 |1.10.0   | SysadminGame change his name by TEUTON. "project" command replaced by "teuton". Challenges (Teuton scripts) moved to "teuton-challenges" github repository. Execute "rake get_challenges" to get sample teuton challenges |
+
+## 2017
+
+|Date      |Version |Changes |
+|--------- |------- |------- |
+|July 2017 |1.0.0   | New stable version |
+|June 2017 |0.22.1  | * Now it's posible to use config files with YAML and JSON format |
+|          |        | * Preparing migration of CLI command to use Thor gem |

data/docs/changelog/v2.1.md

@@ -0,0 +1,139 @@
+
+# CHANGELOG teuton v 2.1
+
+## Done
+
+### 1. Export grades on csv file using Moodle format
+
+* Automaticaly exports `moodle.csv` file with all cases grades, using adecuate format so it could be imported directly into Moodle platform.
+* We need to configure some params like this:
+
+```
+---
+:global:
+:cases:
+- :tt_members: ...
+  :tt_moodle_id: User Moodle Identity
+```
+
+### 2. readme keyword
+
+We currently use the "teuton readme pry-folder" command to export README file from the challenge.
+
+* This example shows how to use readme keyword to add group description or target description:
+
+```
+group "GROUPNAME" do
+  readme "Description for this group"
+
+  target "target1"
+  readme "Description for this target"
+  goto :host, :exec => 'id root'
+  expec_one 'root'
+```
+
+---
+
+## Working
+
+### Remote temp folder
+
+Modify send keyword so it could works with all OS. Now only work with GNU/Linux. So we need to detect remote OS, then choose remote teuton folder where uploading files.
+
+* First goto open new session to remote host. And then:
+    1. Detect remote OSTYPE: (a) GNU/Linux and MAC using "uname -a", (b) Windows using "ver" command.
+    2. Create teuton remote uploading folder: (a) /tmp/teuton for GNU/Linux and MAC, (b) %windir%/temp/teuton for Windows.
+* Every time we send files to remote host we will use this remote folder.
+
+### Readme
+
+* Pass usefull information into README.md:
+```
+readme do
+  title ...
+  intro ...
+  author ...
+  requirements ...
+  tags ...
+end
+```
+
+---
+
+## Pending
+
+### moodle.csv and save partial grades.
+
+* Before play challenge read previous moodle.cvs. Then play challenge and when creates new moodle.csv... we could preseve old cases(grades) 100% for example.
+
+### expect keyword
+
+* `expect_equal "camaleon"`, same as `expect result.equal "camaleon"`.
+* `expect_not_equal "lagarto"`, same as not expect equal.
+* `expect regexp("val1|var2")`, regexp function creates regular expresion from String.
+* `expect result.ok?`, result from previous goto exec.
+* `result.exit_code`, exit code from previous goto exec.
+
+### get keyword simplification
+
+* Simplify getting and setting params process. For example: `_username`, may be alias for `get(:username)`. Then
+
+```
+target "Create user _username"
+goto :host1, :exec => "id _username"
+expect_one _username
+```
+Same as
+```
+target "Create user "+get(:username)
+goto :host1, :exec => "id "+get(:username)
+expect_one get(:username)
+```
+
+* Review docs and replace `"id #{get(:username)}"` by something line `"id "+get(:username)`.
+
+### Reports and export keyword
+
+* Work on more output formats: CSV, HTML, XML.
+    * `export :format=>:html, :prefix => IAN`
+    * `export :format=>:xml, :prefix => IAN`
+    * `export :format=>:csv, :prefix => IAN`
+* Improve RESUME report or create stat-report, with stat information:
+    * the worst target/task/case,
+    * the best target/task/case,
+    * the slowest target/task/case,
+    * the fastest target/task/case, etc.
+    * Related targets: group of targets that always have the same state in every case.
+
+### File extension
+
+* Change ".rb" file extension by ".tt" for example. To avoid users think on ruby when using teuton files.
+* So move "ruby language" documentation to other section like "expert mode"...
+* Change "start,rb" or "play.rb" name to "run.tt".
+
+### loop keyword
+
+* Create keyword to do loops without using ruby style:
+```
+loop i: 1..5 do
+ puts i
+end
+
+loop :a => [3,5,7] do
+  puts a
+end
+```
+
+### Teuton web server
+
+* It coud be posible read students credential directly from config.yaml information..
+
+### Feedback
+
+Add new features to DSL
+* `feedback or advise "Some usefull information"` provide this information when studends demand help.
+
+### Installation process
+* 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.

data/docs/commands/commands.md

@@ -0,0 +1,10 @@
+
+# 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)    |

data/docs/commands/create_skeleton.md

@@ -0,0 +1,31 @@
+
+# Create skeleton
+
+Create skeleton for a new "foo" project: `teuton create foo`
+
+## Execution
+
+```bash
+$ teuton create foo
+
+[INFO] Create project <foo>
+* Create dir        => foo
+* Create dir        => foo/assets
+* Create file       => foo/start.rb
+* Create file       => foo/config.yaml
+* Create file       => foo/.gitignore
+* Create file       => foo/README.md
+```
+
+## Skeleton
+
+This command will create:
+
+| File/Directory  | Description    |
+| --------------- | -------------- |
+| foo             | Base directory |
+| foo/assets      | Base directory for other resources (images and text files) |
+| foo/start.rb    | Main Script    |
+| foo/config.yaml | YAML configuration file |
+| foo/.gitignore  | Prevent uploading YAML files to git repository |
+| foo/README.md   | Statement of our practice |

data/docs/commands/help.md

@@ -0,0 +1,13 @@
+Running `teuton` without params will show you usage information:
+
+```bash
+$ teuton
+Commands:
+ teuton [play] [--export=FORMAT] DIRECTORY  # Run challenge from directory
+ teuton create DIRECTORY                    # Create skeleton for a new project
+ teuton download                            # Download Teuton challenges from git repo
+ teuton help [COMMAND]                      # Describe available commands or one specific command
+ teuton test DIRECTORY                      # Check challenge contents
+ teuton update                              # Update TEUTON from git repo
+ teuton version                             # Show the program version
+```

data/docs/commands/revise_test.md

@@ -0,0 +1,46 @@
+
+# Revise Test Unit
+
+## Example 01
+
+Revising Test Unit called `learn\learn-01-target`:
+
+```bash
+$ teuton test learn/learn-01-target
+[INFO] ScriptPath => /home/david/proy/repos/teuton.d/challenges/learn/learn-01-target/start.rb
+[INFO] ConfigPath => /home/david/proy/repos/teuton.d/challenges/learn/learn-01-target/config.yaml
+[INFO] TestName   => learn-01-target
+
++------------------------+
+| GROUP: learn-01-target |
++------------------------+
+(001) target      Create user <david>
+     weight      1.0
+     goto        localhost and {:exec=>"id david"}
+     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 /home/david/proy/repos/teuton.d/challenges/learn/learn-01-target/config.yaml not found!
+[INFO] Recomended content:
+---
+:global:
+:cases:
+- :tt_members: VALUE
+```
+
+Notice that this Test Unit hasn't config file, and Teuton suggests us content for our config.file. But it isn't necessary for this example.

data/docs/commands/run_test_unit.md

@@ -0,0 +1,78 @@
+
+# Run Test Unit
+
+We use `teuton play` command to run a Test Unit (or challenge).
+
+This command executes challenge (Test Unit) from specified directory. By default, show progress on the screen.
+
+## Help
+
+Run `teuton help play` to see help.
+
+Usage:
+* teuton [play] [OPTIONS] DIRECTORY
+
+Options:
+* [--export=EXPORT], select output format.
+* [--cname=CNAME], select other config file name.
+* [--cpath=CPATH], select absolute path to config file.    
+* [--case=CASE], select cases to be tested.      
+
+## Usage
+
+| ID | Command              | Descriptiont |
+| -- | -------------------- | ------------ |
+| 01 | teuton foo           | Run foo/start.rb, with config file foo/config.yaml |
+| 02 | teuton play foo      | Run foo/start.rb, with config file foo/config.yaml |
+| 03 | ruby teuton foo      | Same as 01 on Windows OS |
+| 04 | ruby teuton play foo | Same as 02 on WIndows OS |
+| 05 | teuton . | Run ./start.rb with ./config.yaml file |
+| 06 | teuton play --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 play --cname=class foo | Run foo/start.rb with foo/class.yaml config file |
+| 08 | teuton foo/demo42.rb | Run foo/demo42.rb with foo/demo42.yaml config file |
+| 08 | teuton play --cpath=current/class.yaml foo | Run foo/start.rb with current/class.yaml config file |
+| 10 | teuton play --case=6,16 foo | Run foo/start.rb with foo/config.yaml config file but only for case id 6 and 16 |
+
+---
+
+## Example
+
+Running example 01:
+
+```bash
+$ teuton learn/learn-01-target
+[INFO] ScriptPath => /home/david/proy/repos/teuton.d/challenges/learn/learn-01-target/start.rb
+[INFO] ConfigPath => /home/david/proy/repos/teuton.d/challenges/learn/learn-01-target/config.yaml
+[INFO] TestName   => learn-01-target
+
+==================================
+Executing [teuton] (version 2.1.0)
+[INFO] Running in parallel (2019-10-04 23:44:19 +0100)
+Starting case <anonymous>
+* Processing <learn-01-target> .
+
+[INFO] Duration = 0.006568696 (2019-10-04 23:44:19 +0100)
+==================================
+
+INITIAL CONFIGURATIONS
++---------------+-------------------------------------------------------+
+| tt_title      | Executing [teuton] (version 2.1.0)                    |
+| tt_scriptname | ...teuton.d/challenges/learn/learn-01-target/start.rb |
+| tt_configfile | ...ton.d/challenges/learn/learn-01-target/config.yaml |
+| tt_testname   | learn-01-target                                       |
+| tt_sequence   | false                                                 |
++---------------+-------------------------------------------------------+
+
+CASE RESULTS
++---------+-------+-------+-----------+
+| CASE ID | GRADE | STATE | MEMBERS   |
+| case_01 | 100.0 |       | anonymous |
++---------+-------+-------+-----------+
+
+FINAL VALUES
++-------------+---------------------------+
+| start_time  | 2019-10-04 23:44:19 +0100 |
+| finish_time | 2019-10-04 23:44:19 +0100 |
+| duration    | 0.006568696               |
++-------------+---------------------------+
+```

data/docs/commands/show_version.md

@@ -0,0 +1,9 @@
+```bash
+$ teuton version                               
+teuton (version 2.0.0)
+```
+
+**Alias:**
+* `teuton v`
+* `teuton -v`
+* `teuton --version`