tdi 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f667efd818c32c1de975332ee09be3747289808
-  data.tar.gz: 0cf62be71c8cfec8340700096c3e6dd971973c17
+  metadata.gz: 244daf4e0163efb156bc527c7b1f47d0a8f0aaa5
+  data.tar.gz: b6d43ee88862a8e6a51423b697cf8c53f4c3145d
 SHA512:
-  metadata.gz: cb7abf813d5c473abe06ca6ac4b180fc558bdaf2ff79c0132723b4593bca85acc69770a25b12ce29fee99fc23b73c274d1e88a75510b728a44f27d7cd793b06b
-  data.tar.gz: 35b2f359c3a5ad88ff0ed98c233bcc28f33a90f93b1cbed45716774ccb5f07978ed722cf9f0ee08e6b3d4aa1a2d102859a007b99b2081e108673508ff3524d69
+  metadata.gz: 3b26b2de5ab7ba6d092856a85deb9b374de6eb4f8633a78694c69167202fc1b55faf644fb22ef71b0100292c1b151c085cc7d664d43d35cb69a935eb8de2ec0f
+  data.tar.gz: 62b798baccb34ff7dbbb9cfe70b67575e79d3812e4458c3cf4c31c2b71f537db6724c5840c44844e0439e77beae64e5e2582d2b0a646cf7c3cdd5c683766df43

data/README.md

@@ -40,6 +40,9 @@ Examples:
     tdi tdi.json -n
     tdi tdi.json --nofail
 
+    tdi tdi.json -w
+    tdi tdi.json --warnfail
+
     tdi tdi.json -p app
     tdi tdi.json --plan app
     tdi tdi.json --plan app::acl
@@ -60,6 +63,7 @@ Examples:
 Options:
 
     -n, --nofail          No fail mode.
+    -w, --warnfail        Fail if any warning.
     -p, --plan            Test plan list.
     -r, --reportfile      Report file to save test plan status.
     -s, --shred           Wipe out the test plan, leaving no trace behind.
@@ -247,7 +251,10 @@ tdi_plan = {
   :app => {
     :desc => 'Test role',
     :acl => {'localhost' => {:port => [22, 80]}},
-    :http => {'globo.com' => {:code => 301}},
+    :http => {
+      'globo.com' => {:code => 301},
+      'noexist.globo.com' => {:code => 200},
+    },
   }
 }
 
@@ -263,19 +270,50 @@ tdi_plan = {
   'app': {
     'desc': 'Test role',
     'acl': {'localhost': {'port': [22, 80]}},
-    'http': {'globo.com': {'code': 301}},
+    'http': {
+      'globo.com': {'code': 301},
+      'noexist.globo.com': {'code': 200},
+    },
   }
 }
 
 open('tdi.json', 'w').write(json.dumps(tdi_plan, indent=2))
 ```
 
-### Validate
+### Validating your plan file
 
 Use JSONLint site to validate your JSONs.
 
 http://jsonlint.com/
 
+## Running test plans and their possible `return codes`
+
+Return codes are:
+
+* `0` if all `success`
+
+![success](https://raw.githubusercontent.com/globocom/tdi/master/doc/output/success.png)
+
+* `0` by default even if warning (warning should not generate a validation error)
+
+![warning](https://raw.githubusercontent.com/globocom/tdi/master/doc/output/warning.png)
+
+* `1` if any `failure`
+
+![failure](https://raw.githubusercontent.com/globocom/tdi/master/doc/output/failure.png)
+
+* `2` if any `warning` plus option `-w` or `--warnfail`
+
+![warnfail](https://raw.githubusercontent.com/globocom/tdi/master/doc/output/warnfail.png)
+
+* `3` if both `failure` and `warning` plus option `-w` or `--warnfail`
+
+![both](https://raw.githubusercontent.com/globocom/tdi/master/doc/output/both.png)
+
+* `0` regardless failure or warning if `-n` or `--nofail`
+
+![nofail](https://raw.githubusercontent.com/globocom/tdi/master/doc/output/nofail.png)
+
 ## Contributors
 
 [People](https://github.com/globocom/tdi/graphs/contributors)

data/bin/tdi

@@ -13,14 +13,14 @@
 #
 # === Authors
 #
-# Rogério Carvalho Schneider <rogerio.schneider@corp.globo.com>
+# Rogério Carvalho Schneider <schneider@corp.globo.com>
 # Leonardo Martins de Lima <leonardo.martins@corp.globo.com>
 # Diogo Kiss <diogokiss@corp.globo.com>
 # Francisco Corrêa <francisco@corp.globo.com>
 #
 # === Copyright
 #
-# Copyright (C) 2013-2015 Globo.com
+# Copyright (C) 2013-2017 Globo.com
 #
 
 # This file is part of TDI.
@@ -170,6 +170,9 @@ Examples:
     tdi tdi.json -n
     tdi tdi.json --nofail
 
+    tdi tdi.json -w
+    tdi tdi.json --warnfail
+
     tdi tdi.json -p app
     tdi tdi.json --plan app
     tdi tdi.json --plan app::acl
@@ -190,6 +193,7 @@ Examples:
 Options:
 EOS
     on :n, :nofail, 'No fail mode.'
+    on :w, :warnfail, 'Fail if any warning.'
     on :p, :plan, 'Test plan list.', as: Array, argument: :optional
     on :r, :reportfile, 'Report file to save test plan status.', argument: :required
     on :s, :shred, 'Wipe out the test plan, leaving no trace behind.'

data/helper/acl.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2013-2015 Globo.com
+# Copyright (C) 2013-2017 Globo.com
 #
 
 # This file is part of TDI.

data/helper/file.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2013-2015 Globo.com
+# Copyright (C) 2013-2017 Globo.com
 #
 
 # This file is part of TDI.
@@ -64,41 +64,66 @@ class TDIPlan < TDI
         rescue
           @flag_success = false if perm.eql?('rw')
         ensure
-          # Cleanup, if type is directory (remove tempfile).
-          FileUtils.rm(filename) if type.eql?('directory') rescue nil
+          # Cleanup. If type is directory, remove tempfile.
+          if type.eql?('directory')
+            FileUtils.rm(filename) rescue nil
+          end
         end
       end
 
       # Type.
       case type
       when 'directory'
+        # Access?
+        # Must exist, be readable and executable.
+        @flag_success = File.exist?(path) && File.readable?(path) && File.executable?(path)
+        @flag_success = File.exist?(path) && File.readable?(path) && File.executable?(path) && File.writable?(path) if perm.eql?('rw')
+
         # Path.
         filename = "#{path}/#{ENV['HOSTNAME']}.rw"
-        testPerm filename, perm, type
+        testPerm filename, perm, type if @flag_success # must be accessible or false positive may manifest
       when 'file'
+        # Access?
+        # Must exist and be readable.
+        @flag_success = File.exist?(path) && File.readable?(path)
+        @flag_success = File.exist?(path) && File.readable?(path) && File.writable?(path) if perm.eql?('rw')
+
         # Path.
         filename = path
-        testPerm filename, perm, type
+        testPerm filename, perm, type if @flag_success # must be accessible or false positive may manifest
       when 'link'
-          @flag_success = File.symlink?(path)
-          @flag_success = File.exist?(path) if @flag_success
+        # Access?
+        # Must exist and be readable. Target must also exist.
+        @flag_success = File.symlink?(path) && File.exist?(path) && File.readable?(path)
+        @flag_success = File.symlink?(path) && File.exist?(path) && File.readable?(path) && File.writable?(path) if perm.eql?('rw')
       else
         puts "ERR: Invalid file plan format \"#{type}\". Type must be \"directory\", \"file\" or \"link\".".light_magenta
         exit 1
       end
 
       # Location.
-      mount_p = Filesystem.mount_point(path)
-      mount_t = Filesystem.mounts.select { |mount| mount.mount_point.eql?(mount_p) }.first.mount_type
-
-      case location
-      when 'local'
-        @flag_success = false if REMOTE_FS_LIST.include?(mount_t)
-      when 'nfs'
-        @flag_success = false unless mount_t.eql?('nfs')
-      else
-        puts "ERR: Invalid file plan format \"#{location}\". Location must be \"local\" or \"nfs\".".light_magenta
-        exit 1
+      if @flag_success
+        mount_p = File.realpath(path)
+        mount_t = nil
+        while !mount_p.eql?('/') && mount_t.nil?
+          mount_t = Filesystem.mounts.select { |mount| mount.mount_point.eql?(mount_p) }.first
+          mount_t = mount_t.mount_type unless mount_t.nil?
+          mount_p = File.expand_path("#{mount_p}/../") # pop leaf dir before next iteration
+        end
+        if mount_t.nil?
+          mount_p = '/'
+          mount_t = Filesystem.mounts.select { |mount| mount.mount_point.eql?(mount_p) }.first.mount_type
+        end
+
+        case location
+        when 'local'
+          @flag_success = false if REMOTE_FS_LIST.include?(mount_t)
+        when 'nfs'
+          @flag_success = false unless mount_t.eql?('nfs')
+        else
+          puts "ERR: Invalid file plan format \"#{location}\". Location must be \"local\" or \"nfs\".".light_magenta
+          exit 1
+        end
       end
 
       # Verdict.

data/helper/http.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2013-2015 Globo.com
+# Copyright (C) 2013-2017 Globo.com
 #
 
 # This file is part of TDI.
@@ -75,7 +75,11 @@ class TDIPlan < TDI
       addr = nil
       proxy_addr = nil
       res_str = case_name
-      res_dict = {url: case_name, net: origin_network(host)}
+      if proxy.nil?
+        res_dict = {url: case_name, net: origin_network(host)}
+      else
+        res_dict = {url: case_name, net: origin_network(proxy)}
+      end
       res_dict[:proxy] = "#{proxy}:#{proxy_port}" unless proxy.nil?
       headers = nil
       response = nil
@@ -88,6 +92,13 @@ class TDIPlan < TDI
       begin
         addr = getaddress(host).to_s
 
+        # Update report information to keep :to key pointing to the actual host,
+        # not to the proxy host. Add :via key with proxy network data.
+        unless proxy.nil?
+          res_dict[:net][:via] = res_dict[:net][:to]
+          res_dict[:net][:to] = {host: host, addr: addr}
+        end
+
         if not proxy.nil? and not proxy_port.nil?
           proxy_addr = getaddress(proxy).to_s
           http = Net::HTTP::Proxy(proxy, proxy_port)

data/helper/ssh.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2013-2015 Globo.com
+# Copyright (C) 2013-2017 Globo.com
 #
 
 # This file is part of TDI.

data/lib/planner.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2013-2015 Globo.com
+# Copyright (C) 2013-2017 Globo.com
 #
 
 # This file is part of TDI.
@@ -132,9 +132,9 @@ def plan_compiler(opts, plan)
         end
 
         # Test case compile.
-        new_case_content = role_content.reject { |key, val| UNMERGEABLE_KEY_LIST.include?(key) or val.is_a?(Hash) }
-        new_case_content.merge!(plan_content.reject { |key, val| UNMERGEABLE_KEY_LIST.include?(key) or val.is_a?(Hash) })
-        new_case_content.merge!(case_content.reject { |key, val| UNMERGEABLE_KEY_LIST.include?(key) or val.is_a?(Hash) })
+        new_case_content = role_content.reject { |key, val| UNMERGEABLE_KEY_LIST.include?(key) || val.is_a?(Hash) }
+        new_case_content.merge!(plan_content.reject { |key, val| UNMERGEABLE_KEY_LIST.include?(key) || val.is_a?(Hash) })
+        new_case_content.merge!(case_content.reject { |key, val| UNMERGEABLE_KEY_LIST.include?(key) || val.is_a?(Hash) })
 
         # Test case (new, merged).
         compiled_plan[role_name][plan_name][case_name] = new_case_content
@@ -209,7 +209,7 @@ def plan_inheriter(opts, plan)
       unless i_plan.nil?
         i_role_name, i_plan_name = role_plan_split(i_plan)
 
-        if i_role_name.nil? or i_plan_name.nil?
+        if i_role_name.nil? || i_plan_name.nil?
           puts "ERR: Invalid inheritance \"#{i_plan}\". Must match pattern \"role::plan\".".light_magenta
           exit 1
         end

data/lib/rblank.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2013-2015 Globo.com
+# Copyright (C) 2013-2017 Globo.com
 #
 
 # This file is part of TDI.

data/lib/rmerge.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2013-2015 Globo.com
+# Copyright (C) 2013-2017 Globo.com
 #
 
 # This file is part of TDI.

data/lib/runner.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2013-2015 Globo.com
+# Copyright (C) 2013-2017 Globo.com
 #
 
 # This file is part of TDI.
@@ -30,7 +30,7 @@ def runner(opts, filename, plan)
   # Ex: {"common": {"desc": "...", "acl": {"domain1": {"port": 80}...}...}...}
   plan.select { |role_name, role_content|
     if role_content.is_a?(Hash)
-      UNTESTABLE_ROLE_LIST.include?(role_name) or role_content['notest'].eql?('true')
+      UNTESTABLE_ROLE_LIST.include?(role_name) || role_content['notest'].eql?('true')
     end
   }.each_pair do |role_name, role_content|
     puts "Skipping reserved or disabled role: #{role_name}".yellow if opts[:verbose] > 0
@@ -39,7 +39,7 @@ def runner(opts, filename, plan)
   # Remove untestable roles.
   plan.reject! { |role_name, role_content|
     if role_content.is_a?(Hash)
-      UNTESTABLE_ROLE_LIST.include?(role_name) or role_content['notest'].eql?('true')
+      UNTESTABLE_ROLE_LIST.include?(role_name) || role_content['notest'].eql?('true')
     end
   }
   total_roles = plan.select { |key, val| val.is_a?(Hash) }.size
@@ -102,8 +102,14 @@ def runner(opts, filename, plan)
 
   puts 'Running tests... done.'.green if opts[:verbose] > 1
 
-  ret = tdiplan.plan_passed? ? 0 : 1
+  ret = 0
+  ret += 1 if tdiplan.fail > 0
+  ret += 2 if opts.warnfail? && tdiplan.warn > 0
   ret = 0 if opts.nofail?
+  # 1 if failures
+  # 2 if warnings (only if -w/--warnfail is active)
+  # 3 if both (only if -w/--warnfail is active)
+  # 0 if none or if -n/--nofail is active
   ret
 end
 

data/lib/tdi.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2013-2015 Globo.com
+# Copyright (C) 2013-2017 Globo.com
 #
 
 # This file is part of TDI.
@@ -21,14 +21,9 @@ require 'socket'
 require_relative 'tdi/version'
 
 class TDI
-  attr_accessor :plan_passed, :case_passed
-  alias :plan_passed? :plan_passed
-  alias :case_passed? :case_passed
   attr_accessor :skip, :pass, :warn, :fail, :report
 
   def initialize
-    @plan_passed = true
-    @case_passed = true
     @skip = 0
     @pass = 0
     @warn = 0
@@ -59,8 +54,6 @@ class TDI
   def failure(role_name, plan_name, res_msg, res_dict)
     update_report(:fail, role_name, plan_name, res_dict)
     printf("%-70s [ %s ]\n", res_msg, 'FAIL'.light_red)
-    @plan_passed = false
-    @case_passed = false
     @fail += 1
   end
 

data/lib/tdi/version.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2013-2015 Globo.com
+# Copyright (C) 2013-2017 Globo.com
 #
 
 # This file is part of TDI.
@@ -18,5 +18,5 @@
 # along with TDI.  If not, see <http://www.gnu.org/licenses/>.
 
 module Tdi
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
 end

data/lib/util.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2013-2015 Globo.com
+# Copyright (C) 2013-2017 Globo.com
 #
 
 # This file is part of TDI.
@@ -52,7 +52,7 @@ end
 
 # Return a list of local networks and it's details.
 def local_networks
-  Socket.getifaddrs.each.select { |ifaddr| ifaddr.addr.ipv4? and ! ifaddr.name.start_with?('lo') }.
+  Socket.getifaddrs.each.select { |ifaddr| ifaddr.addr.ipv4? && !ifaddr.name.start_with?('lo') }.
     map do |ifaddr|
       ip = IPAddress::IPv4.new("#{ifaddr.addr.ip_address}/#{ifaddr.netmask.ip_address}")
       {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tdi
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Rogério Carvalho Schneider
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-13 00:00:00.000000000 Z
+date: 2017-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -157,6 +157,12 @@ files:
 - doc/json/file.json
 - doc/json/http.json
 - doc/json/ssh.json
+- doc/output/both.png
+- doc/output/failure.png
+- doc/output/nofail.png
+- doc/output/success.png
+- doc/output/warnfail.png
+- doc/output/warning.png
 - helper/acl.rb
 - helper/file.rb
 - helper/http.rb