teuton 2.1.8 → 2.1.9

data/docs/developers/03-encoding.md

@@ -1,153 +0,0 @@
-
-# 03 - Encoding (Charset)
-
----
-
-# 1. Introducción
-
-Supongamos que tenemos la siguiente instrucción de SysadminGame:
-
-`goto :host1, :exec => "whoami"`
-
-Con esta instrucción se abre una conexión remota al equipo `:host1` y se ejecuta el comando `whoami`.
-Luego el texto obtenido se guarda en una variable String que luego se convierte en un Array con cada
-una de las líneas del texto de salida del comando. Ejemplo:
-
-```
-# Si text es el texto devuelto por el comando entonces output es un Array de Strings
-output = text.split("\n")
-```
-
-La variable String de ruby trabaja con codificación 'UTF-8'. En el momento de ejecutar
-`text.split("\n")` se espera que text esté codificado 'UTF-8'. En caso contrario tenemos un error.
-
----
-
-# 2. Problema
-
-Cuando ejecutamos:
-
-`goto :win1, :exec => "get-windowsfeature -name rds-rd-server"`
-
-siendo `:win1` un Windows 2012 server tenemos un error.
-
-Si ejecutamos el comando manualmente obtenemos la siguiente salida:
-
-```
-david@camaleon:~/proy/tools/sysadmin-game> ssh administrador@192.168.1.114 'get-windowsfeature -name rds-rd-server'
-administrador@192.168.1.114's password:
-
-Display Name                                            Name                   
-------------                                            ----                   
-    [ ] Host de sesi�n de Escritorio remoto             RDS-RD-Server          
-```
-
-Como podemos comprobar, este comando genera una salida con tildes codificada en ISO-8859-1. Y ahí están el problema.
-
----
-
-# 3. Solución
-
-La solución que se propone es poner la siguiente instrucción en esos casos:
-
-`goto :win1, :exec => "get-windowsfeature -name rds-rd-server", :encoding => "ISO-8859-1"`
-
-Esto es, para las salidas de los comandos que requieran conversión de tipo, se debe
-especificar con `:encoding` el tipo de codificación que se recibirá. Luego ésta se convierte
-internamente a 'UTF-8' y a partir de ahí todo funcionará correctamente.
-
----
-
-# 4. Comentarios
-
-Entiendo que es una molestia indicar la codificación en algunos comandos/servidores especiales. Pero por ahora no se puede asumir que siempre se recibirán los caracteres con la misma codificación.
-
----
-
-# 5. ¿Cómo averiguar el encoding (charset) de forma automática?
-
-Hablando con _Albérica_, el problema anterior, ella comenta la idea de buscar la forma de encontrar el `encoding`  de forma automática. Me pongo a pensar y escribo lo siguiente:
-
-> **Leer el encoding de los ficheros y cómo cambiarlo**
->
-> En ciertas ocasiones es necesario [cambiar el encoding de una archivo](http://lacapa8v2.blogspot.com/2012/07/como-saber-y-cambiar-el-charset.html#.XDvPZqHLfQo), Con el comando file y la opción mime se puede saber el charset de un archivo.
-> Veamos un ejemplo:
->
->     $ file --mime test.html
->     test.html: text/plain; charset=iso-8859-1
->
-> Para cambiar el charset, usaremos el comando iconv:
->
->     $ iconv --from-code=iso-8859-1 --to-code=utf-8 test.html > test_new.html
-
-**¿Qué pasa con la salida de los comandos de un OpenSUSE en español?**
-
-Me aseguro que tengo el sistema operativo en español:
-```
-> locale
-
-LANG=es_ES.utf8
-LC_CTYPE=es_ES.utf8
-LC_NUMERIC="es_ES.utf8"
-LC_TIME="es_ES.utf8"
-LC_COLLATE="es_ES.utf8"
-LC_MONETARY="es_ES.utf8"
-LC_MESSAGES="es_ES.utf8"
-LC_PAPER="es_ES.utf8"
-LC_NAME="es_ES.utf8"
-LC_ADDRESS="es_ES.utf8"
-LC_TELEPHONE="es_ES.utf8"
-LC_MEASUREMENT="es_ES.utf8"
-LC_IDENTIFICATION="es_ES.utf8"
-LC_ALL=
-```
-Ahora vamos a comprobar el charset de la salida de algún comando:
-```
-$ pwd > /tmp/pwd.tmp
-$ file --mime /tmp/pwd.tmp
-pwd.tmp: text/plain; charset=us-ascii
-```
-
-> Interesante... La salida de los comandos tienen charset `us-ascii`,
-a pesar de que mi sistema está en español.
->
-> Me pregunto ¿funcionarán todos los comandos de la misma forma? Lo lógico es pensar que sí. En dicho caso podremos asumir que todos los comandos de GNU/Linux generan la salida con enconding us-ascii.
-
-**¿Qué pasa con los comandos de W2012 en español?**
-
-Averiguar el encoding que está usando por el terminal:
-```
-$ ssh administrador@192.168.1.114 'chcp' > chcp.tmp
-administrador@192.168.1.114's password:
-
-$ more /tmp/chcp.tmp
-P�gina de c�digos activa: 850
-
-$ file --mime /tmp/chcp.tmp
-/tmp/chcp.tmp: text/plain; charset=iso-8859-1
-```
-
-O sea, que según el comando tiene charser `850` y luego el resultado del comando está en `iso-8859-1`. Pero no queda claro porque hay comandos que generan la salida en una codificación y otros en otra. Veamos:
-
-```
-$ ssh administrador@192.168.1.114 'pwd' > win.tmp
-administrador@192.168.1.114's password:
-
-$ file --mime win.tmp
-win.tmp: text/plain; charset=us-ascii
-
-$ ssh administrador@192.168.1.114 'chcp' > chcp.tmp
-administrador@192.168.1.114's password:
-
-$ ssh administrador@192.168.1.114 'get-windowsfeature -name rds-rd-server' > gwf.tmp
-administrador@192.168.1.114's password:
-
-$ file --mime /tmp/gwf.tmp
-/tmp/gwf.tmp: text/plain; charset=iso-8859-1
-```
-
-> Pues la salida de los comandos de W2012 son:
-> * `us-ascii` algunas veces, y otras en
-> * `iso-8859-1`
->
-> ¿De qué depende? ¿Qué comandos usan cada encoding?

data/docs/developers/comparative.md

@@ -1,17 +0,0 @@
-
-# Infrastructure test comparison
-
-
-| Features | Teuton | Testinfra | Goss |
-| -------- | ------ | --------- | ---- |
-| URL      | https://github.com/teuton-software/teuton | https://testinfra.readthedocs.io/en/latest/index.html | https://github.com/aelsabbahy/goss |
-| License  | GPL v.3 | Apache license 2.0 | Apache license 2.0 |
-| Programming language | Ruby | Python | Go |
-| Platforms | Multiplatform | Multiplatform | GNU/Linux |
-| Remote connections | SSH, Telnet | SSH | ? |
-| Installed on | Master | Slave |  |
-| Test Units Lenguage definition | Teuton DSL | Python | YAML |
-| Configuration input files | YAML, JSON | Python | YAML |
-| Output formats      | Documentation, TXT, YAML, JSON, silent | ? | rspecish, documentation, JSON, TAP, JUnit, nagios, silent |
-| Builtin functions | Yes | Yes | ... |
-| Function creation | Yes | ?   | ? |

data/docs/dsl/_Sidebar.md

@@ -1,30 +0,0 @@
-
-# Keywords (DSL)
-
-- [[DSL keywords]]
-
-Definition
-
-- [[group]]
-- [[target]]
-- [[goto]]
-- [[run]]
-- [[result]]
-- [[expect]]
-- [[result]]
-
-Execution
-
-- [[play]]
-- [[show]]
-- [[export]]
-- [[send]]
-
-Settings
-
-- [[get]]
-- [[set]]
-
----
-
-- [[Home]]

data/docs/dsl/definition/goto.md

@@ -1,112 +0,0 @@
-
-## Description
-
-Connect to remote host and executes command. The commadn output is saved into result object.
-
-## Usage
-
-```ruby
-goto :host1, :exec => "id fran"
-goto :host1, :execute => "id fran"
-```
-
-> ADVISE: I know that programers dislike `goto` sentence, but this is diferent. Think of it as english speaker, not as developer.
-
-* This example connect to remote host identified by `host1`. Then we execute the command into it and save the output commadn into result object.
-* `host1` is a lbal that identifies specific machine. Host information (ip, username, password, protocol) cames from config file.
-
-## Examples
-
-Execute `id obiwan` comand into remote host `linux1`.
-```Ruby
-  goto :linux1, :exec => "id obiwan"
-  goto :linux1, :execute => "id obiwan"
-  goto :linux1, exec: "id obiwan"
-  goto :linux1, execute: "id obiwan"
-```
-
-Execute `id david` command into `localhost`.
-
-```Ruby
-  goto :localhost, :exec => "id david"
-  goto :localhost, :execute => "id david"
-  run "id david"
-```
-
-## Protocol
-
-**SSH connection**
-
-By default, when invoking `goto :host1` sentence, Teuton try to open remote SSH session. This config files examples do the same:
-
-Sample 1:
-```
----
-:config:
----
-:global:
-:cases:
-- :tt_members: Student1
-  :host1_ip: 1.1.1.1
-  :host1_username: student
-  :host1_password: secret
-```
-
-Sample 2:
-```
----
-:config:
----
-:global:
-:cases:
-- :tt_members: Student1
-  :host1_ip: 1.1.1.1
-  :host1_username: student
-  :host1_password: secret
-  :host1_protocol: ssh
-```
-
-**Telnet connection**
-
-If you need to use telnet, then it's necessary specified that into config file. For example:
-```
----
-:global:
-:cases:
-- :tt_members: Student2
-  :host1_ip: 2.2.2.2
-  :host1_username: student
-  :host1_password: secret
-  :host1_protocol: telnet
-```
-
-**Localhost**
-
-If our hostname is localhost, or the IP is 127.0.0.X, then Teuton will assume that you want to run your command on local system, and no session is opened. This examples are the same:
-
-```
-goto :localhost, :exec => "id david"
-```
-
-And
-
-```
-run "id david"
-```
-
-**SSH to localhost**
-
-> NOTE: Only works on Teuton version >= 2.1.X
-
-If you want to open SSH session to your localhost, then force SSH protocol into your config file, like this:
-
-```
----
-:global:
-:cases:
-- :tt_members: Student3
-  :host1_ip: 127.0.0.1
-  :host1_username: student
-  :host1_password: secret
-  :host1_protocol: ssh
-```

data/docs/dsl/definition/run.md

@@ -1,23 +0,0 @@
-
-## Description
-
-Execute command on localhost and save output into result object.
-
-**Alias**: In fact it's the same as doing `goto :localhost, :execute => "COMMAND"`.
-
-> Then, why have another instruction? Because there are people who like doing this way.
-
-## Usage
-
-```ruby
-run "id david"
-```
-
-## Example
-
-```ruby
-run "id david"
-```
-
-* This instruction execute "id david" command on local machine, and save results into `result` object.
-* Local machine is where the `Teuton` program is running.

data/docs/install/tested_os.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 | 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

@@ -1,9 +0,0 @@
-[<< back](README.md)
-
-# Teuton installation using 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`.
-* Choose and download [Vagrantfile](../../install/vagrant).
-* Run `vagrant up` to create your Virtual Machine.

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

@@ -1,174 +0,0 @@
-[<< back](README.md)
-
-# Example: learn-02-config
-
-* Learn how to use config file.
-* Tests use params defined into config files.
-* It's good idea save variable data separated into external config file.
-
-> This example is on GitHub repository at `examples/learn-02-config`.
-
----
-## Config file
-
-By default, `config.yaml` is our config file. Let's an example:
-
-```yaml
----
-:global:
-:cases:
-- :tt_members: Student-name-1
-  :username: david
-- :tt_members: Student-name-2
-  :username: fran
-```
-
-## Definitions
-
-By default, `start.rb` it's our main execution file.
-
-```ruby
-group "learn 02 config" do
-
-  target "Create user " + get(:username)
-  run "id " + get(:username)
-  expect get(:username)
-
-end
-```
-
-In this section we define targets using keywords: target, run, expect and get.
-
-* **get** keyword is used to read param from configuracion file. It's posible personalize tests separated for every case.
-
-> Localhost's OS must be GNU/Linux (any other compatible OS) because the command used is `id david`.
-
-## Main execution block
-
-```ruby
-play do
-  show
-  export
-end
-```
-
-Runing this example and see `show` keyword output:
-
-```bash
- $ teuton learn/learn-02-config
-[INFO] ScriptPath => learn/learn-02-config/start.rb
-[INFO] ConfigPath => learn/learn-02-config/config.yaml
-[INFO] TestName   => learn-02-config
-==================================
-Executing [teuton] (version 2.0.1)
-[INFO] Running in parallel (2019-06-20 11:20:49 +0100)
-.id: «darth-maul»: no existe ese usuario
-F
-[INFO] Duration = 0.008375141 (2019-06-20 11:20:49 +0100)
-
-
-==================================
-INITIAL CONFIGURATIONS
-+---------------+------------------------------------------------------------------------------+
-| tt_title      | Executing [teuton] (version 2.0.1)                                           |
-| tt_scriptname | learn/learn-02-config/start.rb    |
-| tt_configfile | learn/learn-02-config/config.yaml |
-| tt_testname   | learn-02-config                                              |
-| tt_sequence   | false                                                                        |
-+---------------+------------------------------------------------------------------------------+
-CASE RESULTS
-+---------+-------------+----------------+
-| Case ID | % Completed | Members        |
-| Case_01 | 100%        | Student-name-1 |
-| Case_02 |   0% ?      | Student-name-2 |
-+---------+-------------+----------------+
-FINAL VALUES
-+-------------+---------------------------+
-| start_time  | 2019-06-20 11:20:49 +0100 |
-| finish_time | 2019-06-20 11:20:49 +0100 |
-| duration    | 0.008375141               |
-+-------------+---------------------------+
-HALL OF FAME
-+-----+---+
-| 100 | * |
-| 0   | * |
-+-----+---+
-
-```
----
-
-## Results
-
-Output reports are saved into `var/learn-02-config/` directory. Detail output report is created for every case.
-
-```
-var/learn-02-config
-├── case-01.txt
-├── case-02.txt
-└── resume.txt
-```
-
-Let's see `export` keyword output for case 01.
-
-```
-$ more var/learn-02-config/case-01.txt
-
-CONFIGURATIONS
-+------------+----------------+
-| tt_members | Student-name-1 |
-| username   | root           |
-| tt_skip    | false          |
-+------------+----------------+
-
-TEST
-======================
-GROUP: learn 02 config
- 01 (1.0/1.0)
-     Description : Checking user <root>
-     Command     : id root
-     Duration    : 0.003 (local)
-     Alterations : find(root) & count
-     Expected    : Greater than 0 (String)
-     Result      : 1 (Integer)
-
-RESULTS
-+--------------+---------------------------+
-| case_id      | 1                         |
-| start_time_  | 2019-06-20 12:29:41 +0100 |
-| finish_time  | 2019-06-20 12:29:42 +0100 |
-| duration     | 0.003650038               |
-| unique_fault | 0                         |
-| max_weight   | 1.0                       |
-| good_weight  | 1.0                       |
-| fail_weight  | 0.0                       |
-| fail_counter | 0                         |
-| grade        | 100                       |
-+--------------+---------------------------+
-```
-
----
-## Using other config file names
-
-**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:**
-But it's posible run `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 run `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 run `teuton run foo/mazingerz.rb`, this will search for:
-* `foo/mazingerz.rb` test file and
-* `foo/mazingerz.yaml` config file.