teuton 2.8.0 → 2.9.0

data/lib/teuton/utils/verbose.rb

@@ -2,7 +2,7 @@ require_relative "project"
 
 module Verbose
   def verboseln(text)
-    verbose(text + "\n")
+    verbose(text.to_s + "\n")
   end
 
   def verbose(text)

data/lib/teuton/version.rb

@@ -1,5 +1,5 @@
 module Teuton
-  VERSION = "2.8.0"
+  VERSION = "2.9.0"
   APPNAME = "teuton"
   GEMNAME = "teuton"
   DOCKERNAME = "dvarrui/#{GEMNAME}"

data/lib/teuton.rb

@@ -8,15 +8,16 @@ module Teuton
 
   def self.check(projectpath, options = {})
     Project.add_input_params(projectpath, options)
-    require_dsl_and_script("teuton/check/laboratory") # Define DSL
-    lab = Laboratory.new(
+    require_dsl_and_script("teuton/check/main")
+    require_relative "teuton/check/checker"
+    checker = Checker.new(
       Project.value[:script_path],
       Project.value[:config_path]
     )
     if options["onlyconfig"]
-      lab.show_onlyconfig
+      checker.show_onlyconfig
     else
-      lab.show
+      checker.show
     end
   end
 
@@ -28,7 +29,7 @@ module Teuton
 
   def self.readme(projectpath, options = {})
     Project.add_input_params(projectpath, options)
-    require_dsl_and_script("teuton/readme/readme") # Define DSL
+    require_dsl_and_script("teuton/readme/main") # Define DSL
     readme = Readme.new(
       Project.value[:script_path],
       Project.value[:config_path]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-15 00:00:00.000000000 Z
+date: 2023-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -124,18 +124,9 @@ extensions: []
 extra_rdoc_files:
 - README.md
 - LICENSE
-- docs/CHANGELOG.md
+- docs/changelog/changelog.1.md
+- docs/changelog/changelog.2.md
 - docs/changelog/todo.md
-- docs/changelog/v2.0.md
-- docs/changelog/v2.1.md
-- docs/changelog/v2.2.md
-- docs/changelog/v2.3.md
-- docs/changelog/v2.4.md
-- docs/changelog/v2.5.md
-- docs/changelog/v2.6.md
-- docs/changelog/v2.7.md
-- docs/changelog/v2.8.md
-- docs/changelog/version2.1.md
 - docs/commands/README.md
 - docs/commands/example_check.md
 - docs/commands/example_run.md
@@ -188,25 +179,19 @@ extra_rdoc_files:
 - docs/learn/22-result.md
 - docs/learn/23-test-code.md
 - docs/learn/24-test-sql.md
+- docs/learn/25-expect-result.md
+- docs/learn/26-expect_sequence.md
+- docs/learn/27-run_script.md
+- docs/learn/28-upload.md
 - docs/learn/README.md
-- docs/learn/videos.md
 - docs/videos.md
 files:
 - LICENSE
 - README.md
 - bin/teuton
-- docs/CHANGELOG.md
+- docs/changelog/changelog.1.md
+- docs/changelog/changelog.2.md
 - docs/changelog/todo.md
-- docs/changelog/v2.0.md
-- docs/changelog/v2.1.md
-- docs/changelog/v2.2.md
-- docs/changelog/v2.3.md
-- docs/changelog/v2.4.md
-- docs/changelog/v2.5.md
-- docs/changelog/v2.6.md
-- docs/changelog/v2.7.md
-- docs/changelog/v2.8.md
-- docs/changelog/version2.1.md
 - docs/commands/README.md
 - docs/commands/example_check.md
 - docs/commands/example_run.md
@@ -259,8 +244,11 @@ files:
 - docs/learn/22-result.md
 - docs/learn/23-test-code.md
 - docs/learn/24-test-sql.md
+- docs/learn/25-expect-result.md
+- docs/learn/26-expect_sequence.md
+- docs/learn/27-run_script.md
+- docs/learn/28-upload.md
 - docs/learn/README.md
-- docs/learn/videos.md
 - docs/videos.md
 - lib/teuton.rb
 - lib/teuton/case/builtin/main.rb
@@ -272,24 +260,32 @@ files:
 - lib/teuton/case/case.rb
 - lib/teuton/case/close.rb
 - lib/teuton/case/config.rb
-- lib/teuton/case/deprecated/runner.rb
-- lib/teuton/case/deprecated/utils.rb
 - lib/teuton/case/dsl/all.rb
 - lib/teuton/case/dsl/expect.rb
+- lib/teuton/case/dsl/expect_exitcode.rb
+- lib/teuton/case/dsl/expect_sequence.rb
 - lib/teuton/case/dsl/getset.rb
-- lib/teuton/case/dsl/goto.rb
+- lib/teuton/case/dsl/host.rb
 - lib/teuton/case/dsl/log.rb
 - lib/teuton/case/dsl/macro.rb
+- lib/teuton/case/dsl/run.rb
+- lib/teuton/case/dsl/run_script.rb
 - lib/teuton/case/dsl/send.rb
 - lib/teuton/case/dsl/target.rb
 - lib/teuton/case/dsl/unique.rb
-- lib/teuton/case/execute/copy_ssh.rb
+- lib/teuton/case/dsl/upload.rb
+- lib/teuton/case/dsl/weight.rb
 - lib/teuton/case/execute/execute_base.rb
 - lib/teuton/case/execute/execute_local.rb
 - lib/teuton/case/execute/execute_manager.rb
 - lib/teuton/case/execute/execute_ssh.rb
 - lib/teuton/case/execute/execute_telnet.rb
+- lib/teuton/case/host.rb
 - lib/teuton/case/play.rb
+- lib/teuton/case/result/ext_array.rb
+- lib/teuton/case/result/ext_compare.rb
+- lib/teuton/case/result/ext_filter.rb
+- lib/teuton/case/result/result.rb
 - lib/teuton/case_manager/case_manager.rb
 - lib/teuton/case_manager/check_cases.rb
 - lib/teuton/case_manager/dsl.rb
@@ -299,19 +295,33 @@ files:
 - lib/teuton/case_manager/send_manager.rb
 - lib/teuton/case_manager/show_report.rb
 - lib/teuton/case_manager/utils.rb
-- lib/teuton/check/builtin.rb
-- lib/teuton/check/dsl.rb
-- lib/teuton/check/laboratory.rb
+- lib/teuton/check/checker.rb
+- lib/teuton/check/dsl/all.rb
+- lib/teuton/check/dsl/builtin.rb
+- lib/teuton/check/dsl/expect.rb
+- lib/teuton/check/dsl/expect_sequence.rb
+- lib/teuton/check/dsl/getset.rb
+- lib/teuton/check/dsl/run.rb
+- lib/teuton/check/main.rb
 - lib/teuton/check/show.rb
 - lib/teuton/cli.rb
+- lib/teuton/deprecated/application.rb
+- lib/teuton/deprecated/application_test.rb
+- lib/teuton/deprecated/runner.rb
+- lib/teuton/deprecated/utils.rb
 - lib/teuton/files/README.md
 - lib/teuton/files/config.yaml
 - lib/teuton/files/start.rb
 - lib/teuton/files/template/case.html
 - lib/teuton/files/template/resume.html
-- lib/teuton/readme/dsl.rb
+- lib/teuton/readme/dsl/all.rb
+- lib/teuton/readme/dsl/expect.rb
+- lib/teuton/readme/dsl/getset.rb
+- lib/teuton/readme/dsl/run.rb
 - lib/teuton/readme/lang.rb
+- lib/teuton/readme/main.rb
 - lib/teuton/readme/readme.rb
+- lib/teuton/readme/result.rb
 - lib/teuton/report/formatter/base_formatter.rb
 - lib/teuton/report/formatter/default/array.rb
 - lib/teuton/report/formatter/default/colored_text.rb
@@ -330,14 +340,10 @@ files:
 - lib/teuton/report/formatter/resume/yaml.rb
 - lib/teuton/report/report.rb
 - lib/teuton/skeleton.rb
-- lib/teuton/utils/application.rb
 - lib/teuton/utils/configfile_reader.rb
+- lib/teuton/utils/logger.rb
 - lib/teuton/utils/name_file_finder.rb
 - lib/teuton/utils/project.rb
-- lib/teuton/utils/result/ext_array.rb
-- lib/teuton/utils/result/ext_compare.rb
-- lib/teuton/utils/result/ext_filter.rb
-- lib/teuton/utils/result/result.rb
 - lib/teuton/utils/settings.rb
 - lib/teuton/utils/verbose.rb
 - lib/teuton/version.rb

data/docs/CHANGELOG.md

@@ -1,10 +0,0 @@
-[<< back](../README.md)
-
-# Changelog
-
-* [version 2.5](changelog/v2.5.md)
-* [version 2.4](changelog/v2.4.md)
-* [version 2.3](changelog/v2.3.md)
-* [version 2.2](changelog/v2.2.md)
-* [version 2.1](changelog/v2.1.md)
-* [version 2.0](changelog/v2.0.md)

data/docs/changelog/v2.0.md

@@ -1,18 +0,0 @@
-[<< back](../CHANGELOG.md)
-
-# 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

@@ -1,54 +0,0 @@
-[<< back](../CHANGELOG.md)
-
-# CHANGELOG teuton v 2.1
-
-# 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'
-```
-
-# 3. 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.
-
-# 4. 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

data/docs/changelog/v2.2.md

@@ -1,42 +0,0 @@
-[<< back](../CHANGELOG.md)
-
-# Teuton (version 2.2)
-
-## New features
-
-* Let's see new features examples:
-    * 10 result and moodle_id
-    * 11 get_vars
-    * 12 alias
-    * 13 include (tt_include config param)
-    * 14 macros
-
-**Configuration file**
-
-* Por defecto los valores de clave de los ficheros de configuración serán Strings en lugar de símbolos, aunque lo símbolos seguirán funcionando.
-
-**get_vars: To think - We are not sure about this***
-
-* "get" keyword simplification: Simplify getting and setting params process. For example: `_username_`, may be alias for `get(:username)`. Then
-
-```
-target "Create user #{_username_}"
-run "id #{_username_}"
-expect_one _username_
-```
-Same as
-
-```
-target "Create user "+get(:username)
-run "id " + get(:username)
-expect_one get(:username)
-```
-
-* Promocinar el proyecto:
-    * Documentar y hacer videos.
-    * Charlas y talleres
-
-## Fixed
-
-* Solucionar fallo en --cname
-* Revisar doc options como cpanel

data/docs/changelog/v2.3.md

@@ -1,10 +0,0 @@
-
-## [2.3.11]
-
-- Issue #18
-
-## [2.3.9]
-
-Bug fixed:
-- Remove warnings from linter
-- Remove warning about thor gem version. Upgrade gem to 1.2

data/docs/changelog/v2.4.md

@@ -1,41 +0,0 @@
-## [2.4.5]
-
--- FIX: "expect_nothing" was always TRUE when SSH/Telnet connections fails!
-   Now when SSH/Telnet connections fails result contains "SSH: NO CONNECTION!"
-   So "expect_nothing" will fail.
-
-## [2.4.4]
-
--- Modify: teuton check output colors and exit codes.
-   exit code 0 = check OK
-   exit code 1 = check error
--- Fix teuton check docs.
-
-## [2.4.3]
-
-- Fix: "expect_none" without params works as "expect result.count.eq 0"
-- Add: "expect_nothing" that works as "expect result.count.eq 0".
-
-## [2.4.2]
-
-- Fix bug with result.grep_v(Array)
-
-## [2.4.0]
-
-New features:
-- Hide feedback from reports: `export feedback: false`
-- Add new DSL keyword: expect_last, expect_fisrt
-- Remove os gem.
-- Change test output colors to green as use others test tools.
-- Change show DSL params. Accepts one param "verbose: NUMBER" to adjust verbosity output level on screen.
-
-New doc and example:
-- 14-alias
-- 16-exit_codes
-
-Bug fixed:
-- All "expect*" keywords must require 2 arguments. The second is optional.
-
-Revise
-- Remove colors to log text
-- teuton readme: macros, getvars, expect_last, expect_first

data/docs/changelog/v2.5.md

@@ -1,6 +0,0 @@
-
-## [2.5.0]
-
-- ADD: "tt_moodle_max_score" global configuration param. Teuton grades (0-100) are divided by this value when exporting data into "moodle.csv" output file.
-- UPDATE: Revise documentation. Doc learn 10,11, 12,13 y 14. 10 result and moodle_id, 12 alias, 13 include, 14 macro, Doc tt_include
-- UPDATE: Internal changes. Remove Colorize gem and replace with Rainbow.

data/docs/changelog/v2.6.md

@@ -1,4 +0,0 @@
-
-## [2.6.0]
-
-- [ADD] When running local or SSH commands, stdout and stderr are captured and readed by "expect" sentence.

data/docs/changelog/v2.7.md

@@ -1,23 +0,0 @@
-
-## [2.7.3] 20230607
-
-- [FIX] Hall of fame now use Project class instead of Application.
-
-## [2.7.2] 20230607
-
-- [FIX] Fixed an issue that appeared when exporting reports without feedback after failing to connect to remote computer.
-
-## [2.7.1]
-
-- [FIX] Fixed an issue that appeared when executing test and fail connection to remote computer.
-
-## [2.7.0]
-
-New features:
-- [ADD] "teuton config PROJECTPATH" will suggest suitable configuration for the project.
-- [ADD] Every one line command output is registered into reports.
-- [ADD] "expect_exit 1", check last command exit code is equal to 1.
-
-Internal changes:
-* Application class splited into Settings and Project classes
-* Create SendManager similar to ExportManager

data/docs/changelog/v2.8.md

@@ -1,11 +0,0 @@
-
-## [2.8.0] 20230630
-
-expect:
-- [ADD] "expect_ok" as "expect_exit 0 ".
-- [ADD] "expect_fail" as "expect_exit NUMBER" where NUMBER > 0.
-- [FIX] expect evaluation fail when there is no remote connection.
-
-send:
-- [UPDATE] Rename "remote_dir" send param to "dir".
-- [UPDATE] send output messages

data/docs/changelog/version2.1.md

@@ -1,4 +0,0 @@
-
-# TEUTON (version 2.1)
-
-Goto to [version 2.1](https://github.com/teuton-software/teuton/tree/devel).

data/docs/learn/videos.md

@@ -1,13 +0,0 @@
-
-By now there are no English videos. We are sorry!
-But if you want to see Spanish videos, here you are:
-
-Teuton (v2.0):
-* [CHAPI19 - Charla Teuton](https://youtu.be/KFWQDfNAFxI?t=12221)
-
-Sysadmingame (Teuton v1.0)
-* [Sysadmingame (1 de 3): Instalación del programa](https://youtu.be/dnyMq9_KDco)
-* [Sysadmingame (2 de 3): Crear un caso simple](https://youtu.be/0e2g5Izvc6c)
-* [Sysadmingame (3 de 3): Crear un caso complejo](https://youtu.be/ebEK6OXH8kQ)
-* [CHAPI16 - Charla sysadmingame](https://youtu.be/cNJaB5xzHHQ)
-

data/lib/teuton/case/execute/copy_ssh.rb

@@ -1,70 +0,0 @@
-require "net/ssh"
-require "net/sftp"
-require "rainbow"
-require_relative "../../utils/project"
-require_relative "../../utils/verbose"
-require_relative "execute_base"
-
-class CopySSH < ExecuteBase
-  def call(host, localfilename)
-    # Check params
-    unless config.get("#{host}_route".to_sym) == "NODATA"
-      log("'copy script' requires direct host access!", :error)
-      return false
-    end
-
-    host = host.to_s
-
-    begin
-      if sessions[host].nil?
-        # Open new SSH session
-        ip = config.get("#{host}_ip".to_sym).to_s
-        username = config.get("#{host}_username".to_sym).to_s
-        password = config.get("#{host}_password".to_sym).to_s
-        port = config.get("#{host}_port".to_sym).to_i
-        port = 22 if port.zero?
-
-        sessions[host] = Net::SSH.start(
-          ip,
-          username,
-          port: port,
-          password: password,
-          keepalive: true,
-          timeout: 30,
-          non_interactive: true
-        )
-      end
-      if sessions[host].instance_of? Net::SSH::Connection::Session
-        copy_to(host, localfilename)
-      else
-        "SSH: NO CONNECTION!"
-      end
-    rescue => e
-      sessions[host] = :nosession
-      conn_status[host] = :error
-      log("[#{e.class}] SSH on <#{username}@#{ip}>", :error)
-    end
-  end
-
-  def copy_to(host, localfilename)
-    ip = get((host + "_ip").to_sym)
-    username = get((host + "_username").to_sym).to_s
-    password = get((host + "_password").to_sym).to_s
-    port = get((host + "_port").to_sym).to_i
-    port = 22 if port.zero?
-
-    localfilepath = File.join(Dir.pwd, localfilename)
-    remotefilepath = File.join(".", File.basename(localfilename))
-
-    # Upload a file or directory to the remote host
-    begin
-      Net::SFTP.start(ip, username, password: password, port: port) do |sftp|
-        sftp.upload!(localfilepath, remotefilepath)
-      end
-    rescue
-      log("copy file: #{localfilename} => #{remotefilepath}", :error)
-      return false
-    end
-    true
-  end
-end

data/lib/teuton/check/dsl.rb

@@ -1,112 +0,0 @@
-# frozen_string_literal: true
-
-class Laboratory
-  # Include Teuton DSL keywords into Laboratory class
-  def readme(_text)
-    # Usefull for "teuton readme" command action.
-  end
-
-  def target(desc, args = {})
-    @stats[:targets] += 1
-    @targetid += 1
-    weight = args[:weight] || 1.0
-    verboseln format("(%03<targetid>d) target      %<desc>s", targetid: @targetid, desc: desc)
-    verboseln "      weight      #{weight}"
-  end
-  alias goal target
-
-  def expect(cond)
-    verboseln "      alter       #{result.alterations}" unless result.alterations.empty?
-    verboseln "      expect      #{cond} (#{cond.class})"
-    verboseln ""
-  end
-
-  def expect_first(cond)
-    verboseln "      alter        #{result.alterations}" unless result.alterations.empty?
-    verboseln "      expect_first #{cond} (#{cond.class})"
-    verboseln ""
-  end
-
-  def expect_last(cond)
-    verboseln "      alter        #{result.alterations}" unless result.alterations.empty?
-    verboseln "      expect_last #{cond} (#{cond.class})"
-    verboseln ""
-  end
-
-  def expect_none(cond)
-    verboseln "      alter       #{result.alterations}" unless result.alterations.empty?
-    verboseln "      expect_none #{cond} (#{cond.class})"
-    verboseln ""
-  end
-
-  def expect_one(cond)
-    verboseln "      alter       #{result.alterations}" unless result.alterations.empty?
-    verboseln "      expect_one  #{cond} (#{cond.class})"
-    verboseln ""
-  end
-
-  def get(varname)
-    @stats[:gets] += 1
-
-    if @gets[varname]
-      @gets[varname] += 1
-    else
-      @gets[varname] = 1
-    end
-
-    "get(#{varname})"
-  end
-
-  def run(command, args = {})
-    args[:exec] = command
-    host = :localhost
-    host = args[:on] if args[:on]
-    goto(host, args)
-  end
-
-  def goto(host = :localhost, args = {})
-    result.reset
-    args[:on] = host unless args[:on]
-
-    if @hosts[host]
-      @hosts[host] += 1
-    else
-      @hosts[host] = 1
-    end
-    verboseln "      run         '#{args[:exec]}' on #{args[:on]}"
-  end
-
-  # Check macros and _get_vars
-  def method_missing(method, *args, &block)
-    a = method.to_s
-    if args.nil? && block.nil?
-      instance_eval("get(:#{a[0, a.size - 1]})", __FILE__, __LINE__) if a[a.size - 1] == "?"
-    end
-  end
-
-  def gett(option)
-    get(option)
-  end
-
-  def unique(key, _value)
-    @stats[:uniques] += 1
-
-    verboseln "    ! Unique      value for <#{key}>"
-    verboseln ""
-  end
-
-  def log(text = "", type = :info)
-    @stats[:logs] += 1
-    verboseln "      log    [#{type}]: " + text.to_s
-  end
-
-  def set(key, value)
-    @stats[:sets] += 1
-
-    key = ":" + key.to_s if key.instance_of? Symbol
-    value = ":" + value.to_s if value.instance_of? Symbol
-
-    @sets[key] = value
-    "set(#{key},#{value})"
-  end
-end