teuton 0.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d55a24ec355421cd07d663355e689bc8edd0d4c80c498510d018a629580eb90
-  data.tar.gz: e640a71a276ce35f26aa4fc6412c836e4405df58a6c08e212f9046639280e486
+  metadata.gz: b8888bb5a43b357d2968cdcf354d1bad4851649f282a4ef1d24f7ad26ba04243
+  data.tar.gz: 2c476f06e9b429c19c4fc87c0fd783b30fd4931bf2887fcf7fe834c86463e028
 SHA512:
-  metadata.gz: 6008a3dbeef623139d4e6cbe73b54755e055756ce643d5bb3b8e46c42ecf1cba349cd3cd88274d8b188a94de89d06a03182269d8783ebfa8b13ad79669bbd865
-  data.tar.gz: 69128f5748c9cef8fa9b13c84c7c134dfb085709ba7c2c43b7d40033f974c2e088d6f28e8cbb67f37bd97ccae6be530bf9779dcc4fd30fec3795b36ca6988dcf
+  metadata.gz: b0ca5960c2334209ae1bf9058cb017554664b58b1d7b7854b647efb9bf240e09098d4a939f0325b3056910029251412b76aea57a06d72db20a3e1febe091266f
+  data.tar.gz: e6a0f6a97d6a77a4c7e7ad9286de04de2145c15d40be0b781f9d7f98db5d28cdc662ff570cb7e4573c264f03cac6bd56946935d32852eafbee9bb9647b343ac3

data/README.md

@@ -0,0 +1,46 @@
+
+# TEUTON Software
+
+_Create Unit Test for your machines.
+Test your infraestructure as code._
+
+![logo](./docs/logo.png)
+
+Intrastructure test, 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:
+* 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)
+
+# Features
+
+* [Free Software License](LICENSE).
+* Multiplatform [installation](https://github.com/teuton-software/teuton/wiki/Installation).
+* Use SSH or Telnet protocol to connect to remote machines.
+* Developed using the ruby language.
+
+# Contact
+
+* **Email**: `teuton.software@protonmail.com`
+* **Twitter**: `@SoftwareTeuton`

data/lib/teuton/command/download.rb

@@ -20,7 +20,13 @@ class Teuton < Thor
   def download
     repo = 'teuton-challenges'
     puts "[INFO] Downloading <#{repo}> repo..."
-    system("git clone https://github.com/teuton-software/#{repo}.git")
-    puts "[INFO] Your files are into <#{Rainbow(repo).bright}> directory..."
+    ok = system("git clone https://github.com/teuton-software/#{repo}.git")
+    if ok
+      puts "[INFO] Your files are into <#{Rainbow(repo).bright}> directory..."
+    else
+      puts Rainbow('[ERROR] Ensure: ').red
+      puts Rainbow('  1. Git is installed.').red
+      puts Rainbow('  2. Your Internet connection is working.').red
+    end
   end
 end

data/lib/teuton/report/close.rb

@@ -2,6 +2,13 @@
 
 # Close Show methods for Report class.
 class Report
+  ##
+  # Calculate final values:
+  # * grade
+  # * max_weight
+  # * good_weight,d
+  # * fail_weight
+  # * fail_counter
   def close
     app = Application.instance
     max = 0.0

data/lib/teuton/report/formatter/yaml_formatter.rb

@@ -3,13 +3,20 @@
 require 'yaml'
 require_relative 'array_formatter'
 
-# YAMLFormatter class
+##
+# YAMLFormatter class receive a [Report] and generates YAML output.
 class YAMLFormatter < ArrayFormatter
+  ##
+  # Class constructor
+  # @param report [Report] Parent object that contains data to be exported.
   def initialize(report)
     super(report)
     @data = {}
   end
 
+  ##
+  # Process data from parent object and export it into YAML format.
+  # @return [nil]
   def process
     build_data
     w @data.to_yaml # Write data into ouput file

data/lib/teuton/report/report.rb

@@ -5,19 +5,30 @@ require_relative 'formatter/formatter_factory'
 require_relative 'show'
 require_relative 'close'
 
-=begin
- This class maintain the results of every case, in a structured way.
- * report/show.rb
- * report/close.rb
-=end
-
+##
+# This class maintain the results of every case, in a structured way.
+# * report/show.rb
+# * report/close.rb
 class Report
+  # @!attribute id
+  #   @return [Integer] It is the [Case] number. Zero indicates Resume Report.
   attr_accessor :id, :filename, :output_dir
-  attr_accessor :head, :lines, :tail
-  attr_reader :history
+  # @!attribute head
+  #   @return [Hash] Report head information.
+  attr_accessor :head
+  # @!attribute lines
+  #   @return [Array] Report body information.
+  attr_accessor :lines
+  # @!attribute tail
+  #   @return [Hash] Report tail information.
+  attr_accessor :tail
+  # @!attribute format
+  #   @return [Symbol] Indicate export format.
   attr_reader :format
-
-  def initialize(id=0)
+  attr_reader :history
+  ##
+  # Class constructor
+  def initialize(id = 0)
     @id = id
     number = '0' + @id.to_s
     number = @id.to_s if @id > 9
@@ -32,6 +43,9 @@ class Report
     @history = ''
   end
 
+  ##
+  # Export [Case] data to specified format.
+  # @param format [Symbol] Select export format. Default value is :txt.
   def export(format = :txt)
     @format = format
     filepath = File.join(@output_dir, @filename + '.' \
@@ -41,6 +55,9 @@ class Report
     formatter.process
   end
 
+  ##
+  # Export resumed data from all Cases, to specified format.
+  # @param format [Symbol] Select export format. Default value is :txt.
   def export_resume(format = :txt)
     @format = "resume_#{format.to_s}".to_sym
     filepath = File.join(@output_dir, @filename + '.' \

data/lib/teuton/report/show.rb

@@ -2,6 +2,8 @@
 
 # Show methods for Report class.
 class Report
+  ##
+  # Display [Report] information on screen
   def show
     show_initial_configurations
     if @filename.to_s.include? 'resume'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-12 00:00:00.000000000 Z
+date: 2019-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.20'
-- !ruby/object:Gem::Dependency
-  name: timeout
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -150,15 +136,27 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.74'
-description: "  Intrastructure Test Software.\n\n  Installation: https://github.com/teuton-software/teuton/wiki/Installation-using-scripts\n
-  \ \n"
+description: |2
+    Intrastructure Test Software.
+
+    Some dependencies require compilation.
+    Ensure these packages are installed into your local hosts:
+    [ALL] ruby, make, gcc
+    [Debian] ssh, ruby-dev
+    [OpenSUSE] openssh, ruby-devel
+
+    Read Teuton documentation: https://github.com/teuton-software/teuton/wiki/
 email: teuton.software@protonmail.com
 executables:
 - teuton
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- docs/logo.png
 files:
+- README.md
 - bin/teuton
+- docs/logo.png
 - lib/teuton.rb
 - lib/teuton/application.rb
 - lib/teuton/case_manager/case/builtin/main.rb