tdi 0.1.6 → 0.1.7

data/doc/json/http.json

@@ -0,0 +1,38 @@
+{
+  "app": {
+    "desc": "Test role",
+    "http": {
+      "globoesporte.globo.com": {
+        "match": "<html"
+      },
+
+      "http://globoesporte.com": {
+        "code": 301,
+        "expect_header": "Location: http://globoesporte.globo.com/"
+      },
+
+      "http://api.sde.globo.com/docs": {
+        "code" : 301
+      },
+
+      "https://api.sde.globo.com/path/to/resource": {
+        "code" : 401
+      },
+
+      "doesnotexist.globo.com": {},
+
+      "https://api.cartola.globo.com/mercado/status.json": {},
+
+      "https://api.cartola.globo.com/wrong-url": {},
+
+      "http://g1.globo.com": {
+        "code": 301,
+        "match": "<html"
+      },
+
+      "http://g1.globo.com/index.html": {
+        "match": "<html"
+      }
+    }
+  }
+}

data/doc/json/ssh.json

@@ -0,0 +1,16 @@
+{
+  "app": {
+    "desc": "Test role",
+    "ssh": {
+      "timeout": 7,
+
+      "u_remote@localhost": {
+        "local_user": "u_local"
+      },
+
+      "u_remote2@localhost": {
+        "local_user": ["u_local", "u_local2"]
+      }
+    }
+  }
+}

data/helper/acl.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2013-2014 Globo.com
+# Copyright (C) 2013-2015 Globo.com
 #
 
 # This file is part of TDI.
@@ -17,13 +17,14 @@
 # You should have received a copy of the GNU General Public License
 # along with TDI.  If not, see <http://www.gnu.org/licenses/>.
 
+require_relative '../lib/util'
 require 'socket'
 require 'timeout'
 require 'resolv'
 
 class TDIPlan < TDI
-  def acl(plan)
-    plan.select { |key, val|
+  def acl(role_name, plan_name, plan_content)
+    plan_content.select { |key, val|
       val.is_a?(Hash)
     }.each_pair do |case_name, case_content|
       # Parse.
@@ -36,26 +37,36 @@ class TDIPlan < TDI
 
       # ACL.
       ports.each do |port|
+        # Initialize vars.
+        addr = nil
+        res_str = "#{host}:#{port}"
+        res_dict = {host: host, addr: addr, port: port, origin_network: origin_network(host)}
+
         begin
+          addr = Resolv.getaddress(host)
+          res_str = "#{host}/#{addr}:#{port}"
+          res_dict = {host: host, addr: addr, port: port, origin_network: origin_network(host)}
+
           timeout(timeout_limit) do
             begin
-
-              Resolv.getaddress(host)
-              sock = TCPSocket.open(host, port)
+              sock = TCPSocket.open(addr, port)
               sock.close
-              success "ACL (#{user}): #{host}:#{port}"
-            rescue Errno::ECONNREFUSED
-              warning "ACL (#{user}): #{host}:#{port}"
-            rescue Errno::ECONNRESET, Errno::ETIMEDOUT
-              failure "ACL (#{user}): Connection Refused #{host}:#{port}"
-            rescue Resolv::ResolvError => re
-              failure "ACL (#{user}): #{re.message}"
-            rescue Resolv::ResolvTimeout => rt
-              failure "ACL (#{user}): #{rt.message}"
+              res_msg = "ACL (#{user}): #{res_str}"
+              success role_name, plan_name, res_msg, res_dict
+            rescue Errno::ECONNREFUSED, Errno::ECONNRESET => e
+              res_msg = "ACL (#{user}): #{res_str} (#{e.message})"
+              warning role_name, plan_name, res_msg, res_dict
+            rescue => e
+              res_msg = "ACL (#{user}): #{res_str} (#{e.message})"
+              failure role_name, plan_name, res_msg, res_dict
             end
           end
-        rescue Timeout::Error
-          failure "ACL (#{user}): Timed out (#{timeout_limit}s) #{host}:#{port}"
+        rescue Timeout::Error => e
+          res_msg = "ACL (#{user}): #{res_str} (Timed out (#{timeout_limit}s) #{e.message})"
+          failure role_name, plan_name, res_msg, res_dict
+        rescue => e
+          res_msg = "ACL (#{user}): #{res_str} (#{e.message})"
+          failure role_name, plan_name, res_msg, res_dict
         end
       end
     end

data/helper/file.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2013-2014 Globo.com
+# Copyright (C) 2013-2015 Globo.com
 #
 
 # This file is part of TDI.
@@ -21,8 +21,8 @@ require 'fileutils'
 require 'etc'
 
 class TDIPlan < TDI
-  def file(plan)
-    plan.select { |key, val|
+  def file(role_name, plan_name, plan_content)
+    plan_content.select { |key, val|
       val.is_a?(Hash)
     }.each_pair do |case_name, case_content|
       # Parse.
@@ -51,7 +51,7 @@ class TDIPlan < TDI
         exit 1
       end
 
-      # Apply the test to a
+      # Apply permissions test.
       def testPerm filename, perm, type
         # Perm.
         begin
@@ -89,8 +89,7 @@ class TDIPlan < TDI
       else
         df_path = path
       end
-      fs_location_query_cmd = "df -P #{df_path} | tail -n 1 | awk '{print $1}'"
-      device = `#{fs_location_query_cmd}`
+      device = %x(df -P #{df_path} | tail -n 1 | awk '{print $1}')
 
       case location
       when 'local'
@@ -103,10 +102,12 @@ class TDIPlan < TDI
       end
 
       # Verdict.
+      res_msg = "FILE (#{user}): #{path} => #{perm} #{type} #{location}"
+      res_dict = case_content
       if @flag_success
-        success "FILE (#{user}): #{path} => #{perm} #{type} #{location}"
+        success role_name, plan_name, res_msg, res_dict
       else
-        failure "FILE (#{user}): #{path} => #{perm} #{type} #{location}"
+        failure role_name, plan_name, res_msg, res_dict
       end
     end
 

data/helper/http.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2013-2014 Globo.com
+# Copyright (C) 2013-2015 Globo.com
 #
 
 # This file is part of TDI.
@@ -17,125 +17,125 @@
 # You should have received a copy of the GNU General Public License
 # along with TDI.  If not, see <http://www.gnu.org/licenses/>.
 
+require_relative '../lib/util'
 require 'net/http'
-require "net/https"
+require 'net/https'
 require 'timeout'
 require 'uri'
 require 'resolv'
 
 class TDIPlan < TDI
-
-  def _parse(uri,params)
-
-    # Normalizing
+  def _parse(uri, params)
+    # Normalizing.
     if not uri =~ /^https?:\/\//
-        uri = 'http://' + uri.to_s
+      uri = 'http://' + uri.to_s
     end
 
-    # URI
+    # URI.
     _uri = URI(uri)
-    ssl  = _uri.scheme.eql?("https")
+    ssl  = _uri.scheme.eql?('https')
     host = _uri.host
     port = _uri.port
     path = _uri.path.empty? ? '/' : _uri.path
 
-    # Params
+    # Params.
     code = params['code'].nil? ? 200 : params['code'].to_i
     match = params['match']
     expect_header = params['expect_header']
     timeout_limit = params['timeout'].nil? ? 2 : params['timeout'].to_i
 
     if not params['proxy'].nil?
-        proxy_addr, proxy_port = params['proxy'].split(/:/)
-        proxy_port = 3128 unless not proxy_port.nil?
+      proxy, proxy_port = params['proxy'].split(/:/)
+      proxy_port = 3128 unless not proxy_port.nil?
     end
 
     if not params['expect_header'].nil?
-        expect_header_key = params['expect_header'].split(':').first
-        expect_header_value = nil
-        if params['expect_header'].include?(':')
-            expect_header_value = params['expect_header'][params['expect_header'].index(':')+1..-1].strip
-        end
+      expect_header_key = params['expect_header'].split(':').first
+      expect_header_value = nil
+      if params['expect_header'].include?(':')
+        expect_header_value = params['expect_header'][params['expect_header'].index(':')+1..-1].strip
+      end
     end
 
-    return host, port, path, proxy_addr, proxy_port, code, match, expect_header_key, expect_header_value, ssl, timeout_limit
+    return host, port, path, proxy, proxy_port, code, match, expect_header_key, expect_header_value, ssl, timeout_limit
   end
 
-  def http(plan)
-    plan.select { |key, val|
+  def http(role_name, plan_name, plan_content)
+    plan_content.select { |key, val|
       val.is_a?(Hash)
-    }.each_pair do |case_name,case_content|
-
-      host, port, path, proxy_addr, proxy_port, code, match, expect_header_key, expect_header_value, ssl, timeout_limit = _parse(case_name,case_content)
+    }.each_pair do |case_name, case_content|
+      # Parse params.
+      host, port, path, proxy, proxy_port, code, match, expect_header_key, expect_header_value, ssl, timeout_limit = _parse(case_name, case_content)
 
-      # User
+      # User.
       user = Etc.getpwuid(Process.euid).name
 
+      # Initialize vars.
+      addr = nil
+      proxy_addr = nil
+      res_str = case_name
+      res_dict = {url: case_name, origin_network: origin_network(host)}
       response = nil
 
-      if not proxy_addr.nil? and not proxy_port.nil?
-        begin
-          Resolv.getaddress(proxy_addr)
-          http = Net::HTTP::Proxy(proxy_addr, proxy_port)
+      begin
+        addr = Resolv.getaddress(host)
 
+        if not proxy.nil? and not proxy_port.nil?
+          proxy_addr = Resolv.getaddress(proxy)
+          http = Net::HTTP::Proxy(proxy, proxy_port)
           timeout(timeout_limit) do
             begin
-              Resolv.getaddress(host)
-              http.start(host,port,:use_ssl => ssl, :verify_mode => OpenSSL::SSL::VERIFY_NONE) { |http|
+              http.start(host, port, use_ssl: ssl, verify_mode: OpenSSL::SSL::VERIFY_NONE) { |http|
                 response = http.get(path)
               }
-            rescue Errno::ECONNREFUSED, Errno::ECONNRESET
-              warning "HTTP (#{user}): #{case_name} - Connection reset or refused."
+            rescue Errno::ECONNREFUSED, Errno::ECONNRESET => e
+              res_msg = "HTTP (#{user}): #{res_str} (#{e.message})"
+              warning role_name, plan_name, res_msg, res_dict
             end
           end
-        rescue Resolv::ResolvError => re
-          failure "HTTP (#{user}): #{re.message}"
-        rescue Resolv::ResolvTimeout => rt
-          failure "HTTP (#{user}): #{rt.message}"
-        rescue Timeout::Error
-          failure "HTTP (#{user}): #{case_name} - Timed out (#{timeout_limit}s)."
-        end
 
-      else
-        begin
-          Resolv.getaddress(host)
+        else
           http = Net::HTTP.new(host, port)
-
           if ssl
-              http.use_ssl = true
-              http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+            http.use_ssl = true
+            http.verify_mode = OpenSSL::SSL::VERIFY_NONE
           end
-
           timeout(timeout_limit) do
             begin
               http.start() { |http|
                 response = http.get(path)
               }
-            rescue Errno::ECONNREFUSED, Errno::ECONNRESET
-              warning "HTTP (#{user}): #{case_name} - Connection reset or refused."
+            rescue Errno::ECONNREFUSED, Errno::ECONNRESET => e
+              res_msg = "HTTP (#{user}): #{res_str} (#{e.message})"
+              warning role_name, plan_name, res_msg, res_dict
             end
           end
-        rescue Resolv::ResolvError => re
-          failure "HTTP (#{user}): #{re.message}"
-        rescue Resolv::ResolvTimeout => rt
-          failure "HTTP (#{user}): #{rt.message}"
-        rescue Timeout::Error
-          failure "HTTP (#{user}): #{case_name} - Timed out."
         end
+      rescue Timeout::Error => e
+        res_msg = "HTTP (#{user}): #{res_str} (Timed out (#{timeout_limit}s) #{e.message})"
+        failure role_name, plan_name, res_msg, res_dict
+      rescue => e
+        res_msg = "HTTP (#{user}): #{res_str} (#{e.message})"
+        failure role_name, plan_name, res_msg, res_dict
       end
 
       if not response.nil?
-          if not match.nil? and not response.body.chomp.include?(match.chomp)
-            failure "HTTP (#{user}): #{case_name} - Expected string '#{match.chomp}'"
-          elsif not expect_header_key.nil? and not expect_header_value.nil? and not response[expect_header_key].eql?(expect_header_value)
-            failure "HTTP (#{user}): #{case_name} - Expected header with content '#{expect_header_key}: #{expect_header_value}'"
-          elsif not expect_header_key.nil? and response[expect_header_key].nil?
-            failure "HTTP (#{user}): #{case_name} - Expected header '#{expect_header_key}'"
-          elsif not code.nil? and (response.code.to_i != code)
-            failure "HTTP (#{user}): #{case_name} - Expected HTTP #{code}"
-          else
-            success "HTTP (#{user}): #{case_name}"
-          end
+        if not match.nil? and not response.body.chomp.include?(match.chomp)
+          res_msg = "HTTP (#{user}): #{res_str} (Expect string '#{match.chomp}')"
+          failure role_name, plan_name, res_msg, res_dict
+        elsif not expect_header_key.nil? and not expect_header_value.nil? and not response[expect_header_key].eql?(expect_header_value)
+          res_msg = "HTTP (#{user}): #{res_str} (Expect header with content '#{expect_header_key}: #{expect_header_value}')"
+          failure role_name, plan_name, res_msg, res_dict
+        elsif not expect_header_key.nil? and response[expect_header_key].nil?
+          res_msg = "HTTP (#{user}): #{res_str} (Expect header '#{expect_header_key}')"
+          failure role_name, plan_name, res_msg, res_dict
+        elsif not code.nil? and (response.code.to_i != code)
+          res_msg = "HTTP (#{user}): #{res_str} (Expect HTTP response code #{code})"
+          failure role_name, plan_name, res_msg, res_dict
+        else
+          res_msg = "HTTP (#{user}): #{res_str}"
+          success role_name, plan_name, res_msg, res_dict
+        end
       end
     end
   end

data/helper/ssh.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2013-2014 Globo.com
+# Copyright (C) 2013-2015 Globo.com
 #
 
 # This file is part of TDI.
@@ -17,12 +17,13 @@
 # You should have received a copy of the GNU General Public License
 # along with TDI.  If not, see <http://www.gnu.org/licenses/>.
 
+require_relative '../lib/util'
 require 'net/ssh'
 require 'resolv'
 
 class TDIPlan < TDI
-  def ssh(plan)
-    plan.select { |key, val|
+  def ssh(role_name, plan_name, plan_content)
+    plan_content.select { |key, val|
       val.is_a?(Hash)
     }.each_pair do |case_name, case_content|
       # Validate.
@@ -35,6 +36,7 @@ class TDIPlan < TDI
       remote_user = case_name.split('@').first
       host = case_name.split('@').last
       local_users = [case_content['local_user']].flatten
+      timeout_limit = case_content['timeout'].nil? ? 5 : case_content['timeout'].to_i
 
       # Users.
       local_users.each do |local_user|
@@ -57,21 +59,30 @@ class TDIPlan < TDI
           exit 1
         end
 
+        # Initialize vars.
+        addr = nil
+        res_str = "#{remote_user}@#{host}"
+        res_dict = {local_user: local_user, remote_user: remote_user, host: host, addr: addr, origin_network: origin_network(host)}
+
         begin
-          timeout(5) do
-            Resolv.getaddress(host)
+          addr = Resolv.getaddress(host)
+          res_str = "#{remote_user}@#{host}/#{addr}"
+          res_dict = {local_user: local_user, remote_user: remote_user, host: host, addr: addr, origin_network: origin_network(host)}
+
+          timeout(timeout_limit) do
             ssh_session = Net::SSH.start(host,
                                          remote_user,
-                                         :auth_methods => ['publickey'])
+                                         auth_methods: ['publickey'])
             ssh_session.close
-            success "SSH (#{local_user}): #{remote_user}@#{host}"
+            res_msg = "SSH (#{local_user}): #{res_str}"
+            success role_name, plan_name, res_msg, res_dict
           end
-        rescue Resolv::ResolvError => re
-          failure "SSH (#{local_user}): #{re.message}"
-        rescue Resolv::ResolvTimeout => rt
-          failure "SSH (#{local_user}): #{rt.message}"
+        rescue Timeout::Error => e
+          res_msg = "SSH (#{local_user}): #{res_str} (Timed out (#{timeout_limit}s) #{e.message})"
+          failure role_name, plan_name, res_msg, res_dict
         rescue => e
-          failure "SSH (#{local_user}): #{remote_user}@#{host} (#{e.message})"
+          res_msg = "SSH (#{local_user}): #{res_str} (#{e.message})"
+          failure role_name, plan_name, res_msg, res_dict
         end
       end
     end