teuton 2.1.10 → 2.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83d8d3b0d1a64b86f4a565eed4570dbf658d3257472623c2f62f17f22ee3b5f5
-  data.tar.gz: e04f854b375a25f3ca221e425dc318cde2a37719f7569caa78355cb25874971b
+  metadata.gz: 44f3001566143676b26e8158eea1da85634bd99235f5bb2c3945b55be7196785
+  data.tar.gz: ab250c0be8fe812a5abd50907d5dc92480d8e17925655ddc69754d93ec8968ec
 SHA512:
-  metadata.gz: 6169cd172479737fbb4e306ce4b9fe61c69245e5bdf4a757a21d1ab4c99921c364ec971458a59b19aa09a32587db98c99a07ad2650974d996cccf9926490de5e
-  data.tar.gz: a4ff2da0ae22db62cbf2e4197f53ba4be346f36b535c341cc205f339c9906ed4b0e866048158793cc74395e19c922c0cc792330bd8afe73cfb9796750a314170
+  metadata.gz: 32a509c81ccdcdfb097cc20f7edabbecdc21508d1983715b9ba1281624b803c8adc543aa0684706a3a43ab833d6d3cbeb02a75bc01870dce26c5b03c63f3a578
+  data.tar.gz: 824cba77a3d8b82e43c74c3750247de3d86e831dfdd90a807145ce1ab4447f0c469a20aca84f632aaed2b1f47f638462c61a1efa7cc67072482f965599a4cdc5

data/docs/dsl/execution/export.md

@@ -1,22 +1,14 @@
 [<< back](../../README.md)
 
 1. [Description](#description)
-2. [Usage](#usage)
-3. [Example](#example)
-4. [Formats](#formats)
+2. [Example](#example)
+3. [Options](#options)
+4. [Usage](#usage)
 
 ## Description
 
 Create reports and save then into `var/TEST-NAME` folder.
 
-## Usage
-
-```ruby
-play do
-    export
-end
-```
-
 ## Example
 
 Run export and build reports using txt output format by default:
@@ -35,13 +27,28 @@ play do
 end
 ```
 
-## Formats
+## Options
+
+1. **format**: txt, html, yaml. json, colored_text (txt with colors).
+2. **preserve**: true, false.
+
+## Usage
 
-| Command                  | Description |
-| ------------------------ | ----------- |
-| `export`                 | Export report files using default ouput format |
-| `export :format => :txt` | Export file using TXT ouput format |
-| `export :format => :html` | Export file using HTML ouput format |
-| `export :format => :yaml` | Export file using YAML ouput format |
-| `export :format => :json` | Export file using JSON ouput format |
-| `export :format => :colored_text` | Export file using colored TXT ouput format |
+|    | Command                  | Description |
+| -- | ------------------------ | ----------- |
+| 01 | `export`                 | Export report files using default ouput format |
+| 02 | `export :format => :txt` | Export file using TXT ouput format |
+| 03 | `export :format => :html` | Export file using HTML ouput format |
+| 04 | `export :format => :yaml` | Export file using YAML ouput format |
+| 05 | `export :format => :json` | Export file using JSON ouput format |
+| 06 | `export :format => :colored_text` | Export file using colored TXT ouput format |
+| 07 | `export :preserve => true` | Same as 01 example buy preserving report copies |
+| 08 | `export :format => :html, :preserve => true` | Same as 03 example but preserving report copies |
+| 09 | `export format: :html, preserve: true` | Same as 08 example |
+| 12 | `export format: "txt"` | Same as 02 |
+| 13 | `export format: "html"` | Same as 03 |
+| 14 | `export format: "yaml"` | Same as 04 |
+| 15 | `export format: "json"` | Same as 05 |
+| 16 | `export format: "colored_text"` | Same as 06 |
+| 17 | `export preserve: true` | Same as 07 |
+| 18 | `export format: "html", preserve: true` | Same as 08 |

data/docs/learn/README.md

@@ -14,8 +14,8 @@ Learn how to use Teuton language to write your own tests:
 - [Example 04 - Use](example-04-use.md)
 - [Example 05 - Debug](example-05-debug.md)
 - [Example 06 - Log](example-06-log.md)
-- Example 07 - Preserve
-- Example 08 - Readme
+- [Example 07 - Readme](example-07-readme.md)
+- [Example 08 - Preserve](example-08-preserve.md)
 - Example 09 - Macros
 - Example 10 - Alias
 - [Example 11 - Create your first test](example-11-first-test.md)

data/docs/learn/example-07-readme.md

@@ -0,0 +1,59 @@
+[<< back](README.md)
+
+1. [Definition section](#definition-section)
+2. [Execute command](#execute-command)
+3. [Result](#result)
+
+# Example: learn-07-readme
+
+Create README files (with test instructions) from our test definition.
+
+> This example is on GitHub repository at `examples/learn-07-readme/`.
+
+## Definition section
+
+Take a look at our test definition section (Group):
+```ruby
+group "Customize readme output" do
+  readme "This is our example 07."
+  readme "And here we'll see how to use readme keyword"
+
+  target "Create user david."
+  readme "Help: you can use 'useradd' command to create users."
+  readme "Remember: Only root is permitted to create new users."
+
+  run "id david"
+  expect "david"
+
+end
+```
+
+> In this example, localhost's OS must be GNU/Linux (any other compatible OS) because the command used is `id david`.
+
+There exists some `readme` instructions after `group` and `target` lines.
+
+## Execute command
+
+To generate automatically a README file from previous test, execute this:
+
+```
+teuton readme example/learn-07-readme > example/learn-07-readme/README.md
+```
+
+## Result
+
+**Let's see the output**: Content of `example/learn-07-readme/README.md` file.
+
+---
+# learn-07-readme
+
+## Customize readme output
+
+This is our example 07.
+And here we'll see how to use readme keyword
+
+Go to [LOCALHOST](#required-hosts) host, and do next:
+* Create user david.
+    * Help: you can use 'useradd' command to create users.
+    * Remember: Only root is permitted to create new users.
+---

data/docs/learn/example-08-preserve.md

@@ -0,0 +1,41 @@
+[<< back](README.md)
+
+1. [Execution section](#execution-section)
+2. [Result](#result)
+
+# Example: learn-08-preserve
+
+Older output report files are overwritten with new reports, every time we run teuton test. With `preserve` option we keep copies.
+
+> This example is on GitHub repository at `examples/learn-08-preserve/`.
+
+## Execution section
+
+Take a look at our test execution section (Play):
+```ruby
+play do
+  show
+  export preserve: true
+end
+```
+
+> More information about [export](../dsl/execution/export.md) keyword.
+## Result
+
+Example, executing `teuton run example/learn-08-preserve` twice:
+
+```
+var
+└── learn-08-preserve
+    ├── 20200519-113035
+    │   ├── case-01.txt
+    │   ├── moodle.csv
+    │   └── resume.txt
+    ├── 20200520-113039
+    │   ├── case-01.txt
+    │   ├── moodle.csv
+    │   └── resume.txt
+    ├── case-01.txt
+    ├── moodle.csv
+    └── resume.txt
+```

data/lib/teuton/application.rb

@@ -6,7 +6,7 @@ require 'singleton'
 class Application
   include Singleton
 
-  VERSION = '2.1.10' # Application version
+  VERSION = '2.1.11' # Application version
   NAME = 'teuton' # Application name
 
   attr_reader   :letter

data/lib/teuton/case_manager/case/builtin/main.rb

@@ -1,24 +1,8 @@
 
-require_relative 'package'
-require_relative 'service'
-require_relative 'user'
+require_relative 'teuton_host'
 
 class Case
-  def package(param)
-    @package = @package || Package.new(self)
-    @package.param = param
-    @package
-  end
-
-  def service(param)
-    @service = @service || Service.new(self)
-    @service.param = param
-    @service
-  end
-
-  def user(param)
-    @user = @user || User.new(self)
-    @user.param = param
-    @user
+  def host(host = 'localhost')
+    TeutonHost.new(self, host)
   end
 end

data/lib/teuton/case_manager/case/builtin/package.rb

@@ -1,20 +1,21 @@
 
 class Package
-  attr_accessor :param
-
-  def initialize(parent)
-    @parent = parent
+  def initialize(teuton_host, param)
+    @teuton_host = teuton_host
+    @parent = teuton_host.parent
+    @host = teuton_host.host
+    @param = param
   end
 
   def installed?
     @parent.target("Package #{@param} installed?")
-    @parent.run "whereis #{@param}"
+    @parent.run "whereis #{@param}", on: @host
     @parent.expect_one [ 'bin', @param ]
   end
 
   def not_installed?
     @parent.target("Package #{@param} not installed?")
-    @parent.run "whereis #{@param}"
+    @parent.run "whereis #{@param}", on: @host
     @parent.expect_none [ 'bin' , @param ]
   end
 end

data/lib/teuton/case_manager/case/builtin/service.rb

@@ -1,32 +1,33 @@
 
 class Service
-  attr_accessor :param
-
-  def initialize(parent)
-    @parent = parent
+  def initialize(teuton_host, param)
+    @teuton_host = teuton_host
+    @parent = teuton_host.parent
+    @host = teuton_host.host
+    @param = param
   end
 
   def is_running?
     @parent.target("Service #{@param} is running?")
-    @parent.run "systemctl status #{@param}"
+    @parent.run "systemctl status #{@param}", on: @host
     @parent.expect_one ['Active:', 'running' ]
   end
 
   def is_inactive?
     @parent.target("Service #{@param} is inactive?")
-    @parent.run "systemctl status #{@param}"
+    @parent.run "systemctl status #{@param}", on: @host
     @parent.expect_one ['Active:', 'inactive' ]
   end
 
   def is_enable?
     @parent.target("Service #{@param} is enable?")
-    @parent.run "systemctl status #{@param}"
+    @parent.run "systemctl status #{@param}", on: @host
     @parent.expect_one ['Loaded:', 'enable' ]
   end
 
   def is_disable?
     @parent.target("Service #{@param} is disable?")
-    @parent.run "systemctl status #{@param}"
+    @parent.run "systemctl status #{@param}", on: @host
     @parent.expect_one ['Loaded:', 'disable' ]
   end
 end

data/lib/teuton/case_manager/case/builtin/teuton_file.rb

@@ -0,0 +1,28 @@
+
+class TeutonFile
+  def initialize(teuton_host, param)
+    @teuton_host = teuton_host
+    @parent = teuton_host.parent
+    @result = @parent.result
+    @host = teuton_host.host
+    @param = param
+  end
+
+  def exist?
+    @parent.target("File #{@param} exists?")
+    @parent.run "file #{@param}", on: @host
+    @parent.expect @result.grep_v('cannot open').grep(@param).count.eq 1
+  end
+
+  def directory?
+    @parent.target("File #{@param} is directory?")
+    @parent.run "file #{@param}", on: @host
+    @parent.expect @result.grep_v('cannot open').grep(@param).grep('directory').count.eq 1
+  end
+
+  def regular?
+    @parent.target("File #{@param} is regular?")
+    @parent.run "file #{@param}", on: @host
+    @parent.expect @result.grep(@param).grep('directory').count.eq 0
+  end
+end

data/lib/teuton/case_manager/case/builtin/teuton_host.rb

@@ -0,0 +1,31 @@
+
+require_relative 'teuton_file'
+require_relative 'package'
+require_relative 'service'
+require_relative 'user'
+
+class TeutonHost
+  attr_reader :parent
+  attr_reader :host
+
+  def initialize(parent, host = 'localhost')
+    @parent = parent
+    @host = host
+  end
+
+  def file(param)
+    TeutonFile.new(self, param)
+  end
+
+  def package(param)
+    Package.new(self, param)
+  end
+
+  def service(param)
+    Service.new(self, param)
+  end
+
+  def user(param)
+    User.new(self, param)
+  end
+end

data/lib/teuton/case_manager/case/builtin/user.rb

@@ -1,20 +1,21 @@
 
 class User
-  attr_accessor :param
-
-  def initialize(parent)
-    @parent = parent
+  def initialize(teuton_host, param)
+    @teuton_host = teuton_host
+    @parent = teuton_host.parent
+    @host = teuton_host.host
+    @param = param
   end
 
   def exists?
     @parent.target("User #{@param} exists?")
-    @parent.run "id #{@param}"
-    @parent.expect_one @param
+    @parent.run "id #{@param}", on: @host
+    @parent.expect_one [ 'uid=', @param ]
   end
 
   def is_member_of?(groupname)
     @parent.target("User #{@param} is member of #{groupname}?")
-    @parent.run "id #{@param}"
+    @parent.run "id #{@param}", on: @host
     @parent.expect_one [@param, groupname]
   end
 end

data/lib/teuton/case_manager/case/case.rb

@@ -115,7 +115,7 @@ class Case
   alias skip? skip
 
   ##
-  # Show case
+  # Show case report data on screen
   def show
     @report.show
   end

data/lib/teuton/case_manager/case/dsl/log.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 ##
-# Case class -> DSL module : log function
+# Define DSL#log function
 module DSL
   ##
   # Record log message

data/lib/teuton/case_manager/case/dsl/macro.rb

@@ -31,7 +31,9 @@ module DSL
   # * Invoke macro (assert)
   def method_missing(method, args = {})
     a = method.to_s
-    return instance_eval("get(:#{a[0, a.size - 1]})") if a[a.size - 1] == '?'
+    if a.start_with?('_') && a.end_with?('_')
+      return instance_eval("get(:#{a[1, a.size - 2]})")
+    end
     return macro a[6, a.size], args if a[0,6]=='macro_'
     macro a, args
   end

data/lib/teuton/case_manager/dsl.rb

@@ -1,6 +1,8 @@
 require_relative '../application'
 require_relative 'case_manager'
 
+# Define filename to be used into our test
+# @param filename (String) Filename to be required
 def use(filename)
   filename += '.rb'
   app = Application.instance
@@ -12,17 +14,25 @@ def use(filename)
   app.uses << File.basename(findfiles.first)
 end
 
+# Define macro. That's a name to predefined target-run-expect evaluation.
+# @param name (String) macro name
+# @param block (Block) macro code
 def define_macro(name, *args, &block)
   Application.instance.macros[name] = { args: args, block: block }
 end
 alias def_macro define_macro
 alias defmacro define_macro
 
+# Define a group of tests
+# @param name (String) Group name
+# @param block (Block) Tests code
 def group(name, &block)
   Application.instance.groups << { name: name, block: block }
 end
 alias task group
 
+# Start test
+# @param block (Block) Extra code executed at the end.
 def play(&block)
   CaseManager.instance.play(&block)
 end

data/lib/teuton/case_manager/export_manager.rb

@@ -9,9 +9,18 @@ module ExportManager
   # Run export function
   # @param main_report (Report)
   # @param cases (Array)
-  # @param args (Hash) Selected export options
+  # @param input (Hash) Selected export options
   # rubocop: disable Metrics/AbcSize
-  def self.run(main_report, cases, args)
+  def self.run(main_report, cases, input)
+    args = {}
+    input.each_pair do |key, value|
+      if value.class == String
+        args[key] = value.to_sym
+      else
+        args[key] = value
+      end
+    end
+
     # default :mode=>:all, :format=>:txt
     format = args[:format] || Application.instance.default[:format]
     mode = args[:mode] || :all

data/lib/teuton/project/skeleton.rb

@@ -31,6 +31,7 @@ module Skeleton
     items = [
       { source: 'files/config.yaml', target: 'config.yaml' },
       { source: 'files/start.rb', target: 'start.rb' }
+      # { source: 'files/gitignore', target: '.gitignore' }
     ]
     items.each do |item|
       source = File.join(source_basedir, item[:source])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 2.1.10
+  version: 2.1.11
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-10 00:00:00.000000000 Z
+date: 2020-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -154,11 +154,13 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 - docs/learn/example-03-remote-hosts.md
+- docs/learn/example-07-readme.md
 - docs/learn/example-05-debug.md
 - docs/learn/example-02-config.md
 - docs/learn/example-11-first-test.md
 - docs/learn/videos.md
 - docs/learn/example-06-log.md
+- docs/learn/example-08-preserve.md
 - docs/learn/example-04-use.md
 - docs/learn/example-01-target.md
 - docs/learn/README.md
@@ -228,6 +230,8 @@ files:
 - docs/learn/example-04-use.md
 - docs/learn/example-05-debug.md
 - docs/learn/example-06-log.md
+- docs/learn/example-07-readme.md
+- docs/learn/example-08-preserve.md
 - docs/learn/example-11-first-test.md
 - docs/learn/videos.md
 - lib/teuton.rb
@@ -235,11 +239,12 @@ files:
 - lib/teuton/case_manager/case/builtin/main.rb
 - lib/teuton/case_manager/case/builtin/package.rb
 - lib/teuton/case_manager/case/builtin/service.rb
+- lib/teuton/case_manager/case/builtin/teuton_file.rb
+- lib/teuton/case_manager/case/builtin/teuton_host.rb
 - lib/teuton/case_manager/case/builtin/user.rb
 - lib/teuton/case_manager/case/case.rb
 - lib/teuton/case_manager/case/close.rb
 - lib/teuton/case_manager/case/config.rb
-- lib/teuton/case_manager/case/dsl/deprecated.rb
 - lib/teuton/case_manager/case/dsl/expect.rb
 - lib/teuton/case_manager/case/dsl/getset.rb
 - lib/teuton/case_manager/case/dsl/goto.rb

data/lib/teuton/case_manager/case/dsl/deprecated.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-# DSL#request, DSL#target2
-module DSL
-  def request(text)
-    raise "Deprecated request #{text}"
-    # do nothing by now
-  end
-
-  def command(p_command, args = {})
-    @action[:command] = p_command
-    tempfile(args[:tempfile]) if args[:tempfile]
-  end
-end