teuton 2.1.8 → 2.1.9

data/docs/dsl/execution/play.md

@@ -1,3 +1,7 @@
+[<< back](../../README.md)
+
+1. [Description](#description)
+2. [Usage](#usage)
 
 ## Description
 

data/docs/dsl/execution/send.md

@@ -1,3 +1,9 @@
+[<< back](../../README.md)
+
+1. [Description](#description)
+2. [Usage](#usage)
+3. [Parameters](#parameters)
+4. [Send several reports](#send-several-reports)
 
 ## Description
 
@@ -16,7 +22,19 @@ end
 * `host1`, it' the label that identified remote host. This information must be configured into config file.
 * `send :copy_to => :host1`, copy every case resport file into temp directory on remote host `host1`.
 
-## Other uses
+## Example
+
+Example 1: send `case-01-txt` file to remote Windows host.
+
+![](images/send-remote-dir-dot1.jpg)
+
+![](images/send-remote-dir-dot2.jpg)
+
+Example 2: send report file to remote "./Desktop" folder.
+
+![](images/send-remote-dir-desktop1.jpg)
+
+## Parameters
 
 | Action | Description |
 | ------ | ----------- |
@@ -27,11 +45,12 @@ end
 > * By default, `send` only works when remote OS type is UNIX base, like GNU/Linux, MACOS, BSD, etc.
 > * For Windows OS we must specified `:remote_dir`. Example: `send :copy_to => :host1, :remote_dir => "C:\\"`. This example will copy files on directory c:\ of host1 machine.
 
-## How to send several output files
+## Send several reports
 
 If you export several files using differents output formats, you will use several `export` orders. Then when invoke `send` order, this will send the last exported file.
 
 In this example we export json and txt files, but only send txt to remote hosts:
+
 ```ruby
 start do
   export :format => :json

data/docs/dsl/execution/show.md

@@ -1,3 +1,8 @@
+[<< back](../../README.md)
+
+1. [Description](#description)
+2. [Usage](#usage)
+3. [Parameters](#parameters)
 
 ## Description
 
@@ -7,15 +12,15 @@ When tests ends, `show` instruction shows on screen information about final resu
 
 ```ruby
 start do
-    show
+  show
 end
 ```
 
-## Other uses
+## Parameters
 
-| Action          | Description                             |
-| --------------- | --------------------------------------- |
-| `show`          | Same as `show :resume`. Default option. |
-| `show :resume`  | Show resumed information on screen.     |
-| `show :details` | Show details from every cases on screen.|
-| `show :all`     | Same as `show :resume` and `show :details`. |
+| Action         | Description                             |
+| -------------- | --------------------------------------- |
+| `show`         | Same as `show :resume`. Default option. |
+| `show :resume` | Show resumed information on screen.     |
+| `show :cases`  | Show information from every case on screen.|
+| `show :all`    | Same as `show :resume` and `show :details`. |

data/docs/dsl/setting/get.md

@@ -1,3 +1,8 @@
+[<< back](../README.md)
+
+1. [Description](#description)
+2. [Usage](#usage)
+3. [Examples](#examples)
 
 ## Description
 
@@ -6,12 +11,13 @@
 ## Usage
 
 ```ruby
-get(:param1)
+get(PARAM)
 ```
 
-## Example
+## Examples
+
+**Reading example**: Suppose we have this `config.yaml` content:
 
-Suppose we have this `config.yaml` content:
 ```yaml
 ---
 :global:
@@ -24,13 +30,23 @@ Suppose we have this `config.yaml` content:
   :username: obiwan
 ```
 
-Then:
+Supossing we are **case 01**, then:
 * `get(:username)` returns `obiwan`.
 * `get(:host1_username)`, returns `root`.
 
-We also can create new temporal params:
+**Writting example**: We also can create new temporal params:
+
 ```ruby
-set(:new_param, "Hello")
-var = get(:new_param)
+set(:greet, "Hello")
+var = get(:greet)
 ```
-So `var` value will be "Hello".
+
+So `var` value is "Hello".
+
+**Simpler reading example**: Other ways or reading param values:
+
+```ruby
+var = greet?
+```
+
+So `var` value is "Hello" too. `greet?` is an alias of `get(:greet)`.

data/docs/dsl/setting/set.md

@@ -1,3 +1,8 @@
+[<< back](../README.md)
+
+1. [Description](#description)
+2. [Usage](#usage)
+3. [Example](#example)
 
 ## Description
 
@@ -12,7 +17,7 @@ set(:param1, 'value')
 ## Example
 
 ```ruby
-set(:new_param, "Hello")
-var = get(:new_param)
+set(:greet, "Hello")
+var = get(:greet)
 ```
-So `var` value will be "Hello".
+So `var` value is "Hello".

data/docs/install/README.md

@@ -1,56 +1,49 @@
 [<< back](../../README.md)
 
-# Teuton installation
+# Installation
 
-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:
+> Definitions:
+> * **T-node**: Host where Teuton software is installed. Monitor S-NODE hosts.
+> * **S-node**: Host where SSH server is installed. This hosts are monitotized by T-NODE host.
+>
+> Read [Modes of use](modes_of_use.md) to know about different Teuton ways of using it.
 
-* **T-node**: This host has installed Teuton software.
-* **S-node**: This host has installed SSH server.
+## T-NODE installation
 
----
-# T-NODE
-
-* **Install** Teuton on machine with T-NODE role.
-Installation process:
+* **Install** Teuton (T-NODE role host):
     1. Install Ruby on your system.
     2. `gem install teuton`
-* Run `teuton version` to check that your installation is ok.
+* Run `teuton version` to check is fine.
 
-> **PROBLEMS**: If you have problems to find `teuton`command (OpenSUSE distro), try this:
+> **PROBLEMS**: If you don't find `teuton`command (OpenSUSE distro), try this:
 > * Option A:
->     * `ruby -v`, display your current ruby version. Supose it is 2.5.
+>     * `ruby -v`, display your current ruby version. Suppose 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`
+* **Update** with `gem teuton update`.
+* **Uninstall** with `gem uninstall teuton`
 
----
-# S-NODE
+## S-NODE installation
 
 * **Install** SSH server on every machine with S-NODE role.
 
 ---
 # Other installation ways
 
-## Using scripts
-
-[Installation using scripts](scripts.md)
+**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
+**Vagrant or Docker**. [Installation using Vagrant or Docker](vagrant_docker.md)
+* If you plan to install Teuton into virtual machines or containers.
 
-[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)
+**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/modes_of_use.md

@@ -1,38 +1,39 @@
-There are several **Teuton** ways of use: Classroom, Conquest and Standalone.
+[<< back](README.md)
 
-For every mode exists 2 types of nodes: T-Node and S-Node.
+# Modes of use
 
----
-
-## Classroom mode
-
-In this mode, a teacher use **Teuton** tool to evaluate the work done by their students into their real or virtual machines. The teacher need to access remotely to these machines.
-
-| Node | Description |
-| ---- | ----------- |
-| T    | Teacher install Teuton software into his machine, and he will connect remotely (using SSH) to every student machine. |
-| S    | Every student machine. |
+There are **Teuton** ways of use:
+1. Classroom
+2. Conquest and
+3. Standalone
 
 ---
+## 1. Classroom mode
 
-## Contest mode
+In this mode, teacher use **Teuton** tool to evaluate the work done by their students into their real or virtual machines. The teacher need to access remotely to these machines.
 
-We will hace a group of contestants who decide to do challenges and execute Teuton software into their own machines just to verify if satisfied the targets/goals of the challenge.
+| Host   | Description |
+| ------ | ----------- |
+| T-node | Teacher install Teuton software into his machine, and he will connect remotely (using SSH) to every student machine. |
+| S-node | Every student machine. |
 
-On every run, Teuton software send results to remote server configured with SSH (used by the contest judges).
+## 2. Contest mode
 
-| Node | Description                                                  |
-| ---- | ------------------------------------------------------------ |
-| T    | Every contest install Teuton software into their machine. Teuton wll connect via SSH to the server. |
-| S    | The server used by judges to save all the reports. |
+Group of contestants execute Teuton software into their own machines just to verify if satisfied the targets/goals of the contest challenge.
 
----
+On every run, Teuton software send results to contest judges server.
+Remote server is configured with SSH service.
+
+| Host   | Description                                                  |
+| ------ | ------------------------------------------------------------ |
+| T.node | Every contest install Teuton software into their machine. Teuton wll connect via SSH to the server. |
+| S-node | The server used by judges to save all the reports. |
 
-## Standalone mode
+## 3. Standalone mode
 
-Install Teuton software into our own machine, and execute the challenges as you want. It is a good way for standalone learning .
+Student install Teuton software into his own machine, and execute the challenges standalone. It is a good way for practice and learn alone.
 
-| Node | Descripción |
-| ---- | ----------- |
-| T    | Install Teuton software into our machine. |
-| S    | No necessary. |
+| Host   | Descripción |
+| ------ | ----------- |
+| T-node | Install Teuton software into our machine. |
+| S-node | No necessary. |

data/docs/install/scripts.md

@@ -1,18 +1,23 @@
 [<< back](README.md)
 
-# Teuton installation using scripts
-
-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.
-
-> Consult [tested OS](tested_os.md) to ensure if your favorite OS script installation has been tested.
+# Using scripts to install Teuton
+
+1. T-Node installation
+    * GNU/Linux
+    * MACOSX
+    * Windows
+2. S-Node installation
+    * GNU/Linux
+    * MACOSX
+    * Windows
+3. Tested OS list
 
 ---
-# T-NODE installation
+# 1. T-NODE installation
 
-## T-NODE: GNU/Linux installation
+* **T-node**: Host where Teuton software is installed. Monitor S-NODE hosts.
+
+## 1.1 T-NODE: GNU/Linux installation
 
 Run this command as `root` user:
 
@@ -20,17 +25,7 @@ Run this command as `root` user:
 wget -qO- https://raw.githubusercontent.com/teuton-software/teuton/devel/install/linux/linux_t-node_install.sh | bash
 ```
 
-## T-NODE: Mac OS X installation
-
-Run this command as admin user (member of `admin` group):
-
-```bash
-curl -sL https://raw.githubusercontent.com/teuton-software/teuton/devel/install/mac/macosx_t-node_install.sh | bash
-```
-
-> No `root` user.
-
-## T-NODE: Windows installation
+## 1.2 T-NODE: Windows installation
 
 Requirements:
 * Windows 7+ / Windows Server 2003+
@@ -39,34 +34,31 @@ 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/devel/install/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/windows_t-node_install.ps1'))
 ```
 
----
-
-# S-NODE installation
+## 1.3 T-NODE: Mac OS X installation
 
-This is, SSH server installation.
-
-> The user from T-NODE have to know admin password/user to establish SSH connections to S-NODE.
-
-## S-NODE: GNU/Linux installation
-
-Run this command as `root` user:
+Run this command as admin user (member of `admin` group):
 
 ```bash
-wget -qO- https://raw.githubusercontent.com/teuton-software/teuton/devel/install/linux/linux_s-node_install.sh | bash
+curl -sL https://raw.githubusercontent.com/teuton-software/teuton/devel/install/mac/macosx_t-node_install.sh | bash
 ```
 
-## S-NODE: Mac OS X installation
+---
+# 2. S-NODE installation
+
+* **S-node**: Host where SSH server is installed. This hosts are monitotized by T-NODE host.
+
+## 2.1 S-NODE: GNU/Linux installation
 
 Run this command as `root` user:
 
 ```bash
-curl -sL https://raw.githubusercontent.com/teuton-software/teuton/devel/install/mac/macosx_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: Windows installation
+## 2.2 S-NODE: Windows installation
 
 Requirements:
 * Windows 7+ / Windows Server 2003+
@@ -77,3 +69,28 @@ 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/devel/install/windows/windows_s-node_install.ps1'))
 ```
+
+## 2.3 S-NODE: Mac OS X installation
+
+Run this command as `root` user:
+
+```bash
+curl -sL https://raw.githubusercontent.com/teuton-software/teuton/devel/install/mac/macosx_s-node_install.sh | bash
+```
+
+---
+# 3. Tested OS list
+
+| Type      | O.S.      | Version        | Arch   | T-node | S-node |
+| --------- | --------- | -------------- | ------ | ------ | ------ |
+| GNU/Linux | 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     |
+| Microsoft | Windows   | 7 Enterprise   | x86    | Ok     |        |
+|           | Windows   | 10 Pro         | x86-64 | Ok     | Ok     |
+|           | Windows   | Server 2012 R2 | x86-64 |        |        |
+| Apple     | Mac OS X  | Capitán (10.11.6) | x86-64 | Ok  | Ok     |
+|           | Mac OS X  | Sierra (10.12)    | x86-64 | Ok  |        |

data/docs/install/vagrant_docker.md

@@ -0,0 +1,56 @@
+[<< back](README.md)
+
+# Vagrant and Docker installation
+
+1. Vagrant
+2. Docker
+
+---
+# 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.
+
+# 2. Install using Docker
+
+First:
+* Install `docker` on your host.
+
+Second, choose:
+* Pulling docker image from remote or
+* Rebuild local docker image.
+
+## 2.1 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`
+
+## 2.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.