tdi 0.1.6 → 0.1.7

data/lib/planner.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2013-2014 Globo.com
+# Copyright (C) 2013-2015 Globo.com
 #
 
 # This file is part of TDI.
@@ -92,7 +92,7 @@ def plan_compiler(opts, plan)
   compiled_plan = {}
 
   # Role.
-  # Ex: {"admin": {"desc": "...", "acl": {"domain1": {"port": 80}...}...}...}
+  # Ex: {"app": {"desc": "...", "acl": {"domain1": {"port": 80}...}...}...}
   plan.select { |key, val|
     val.is_a?(Hash)
   }.each_with_index do |(role_name, role_content), index|
@@ -169,7 +169,7 @@ def plan_inheriter(opts, plan)
   inherited_plan = {}
 
   # Role may inherit from role.
-  # Ex: {"admin": {"desc": "...", "inherits": "other_role", "acl": {"domain1": {"port": 80}...}...}...}
+  # Ex: {"app": {"desc": "...", "inherits": "other_role", "acl": {"domain1": {"port": 80}...}...}...}
   plan.select { |key, val|
     val.is_a?(Hash)
   }.each_with_index do |(role_name, role_content), index|
@@ -243,10 +243,12 @@ def plan_filter(opts, plan)
   filtered_plan = {}
   flag_err = false
 
-  # Ex: tdi -p admin
-  # Ex: tdi -p admin::acl
-  # Ex: tdi --plan fe
-  # Ex: tdi --plan admin::acl,solr,be
+  # Ex: -p admin
+  # Ex: -p admin::acl
+  # Ex: --plan app
+  # Ex: --plan app::acl
+  # Ex: --plan fe
+  # Ex: --plan admin::acl,app,fe
   if opts.plan?
     # Do filter.
     puts 'Filtering following test plan from input file:'.cyan if opts[:verbose] > 0

data/lib/rblank.rb

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

data/lib/rmerge.rb

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

data/lib/runner.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2013-2014 Globo.com
+# Copyright (C) 2013-2015 Globo.com
 #
 
 # This file is part of TDI.
@@ -19,6 +19,7 @@
 
 require 'os'
 require_relative 'tdi'
+require_relative 'util'
 
 # Run tests.
 def runner(opts, filename, plan)
@@ -59,7 +60,6 @@ def runner(opts, filename, plan)
     else
       puts "* #{role_name.capitalize} - #{role_content['desc']}".cyan
     end
-#    puts "Running tests for role: #{role_name}".cyan if opts[:verbose] > 0
     puts "Total test plans to run for this role: #{total_plans}".cyan if opts[:verbose] > 1
 
     # Test plan.
@@ -70,7 +70,6 @@ def runner(opts, filename, plan)
       total_cases = plan_content.select { |key, val| val.is_a?(Hash) }.size
 
       puts "* #{plan_name.upcase}".cyan
-#      puts "Test plan: #{role_name}::#{plan_name}".cyan if opts[:verbose] > 0
       puts "Total test cases to run for this plan: #{total_cases}".cyan if opts[:verbose] > 1
 
       if opts[:verbose] > 3
@@ -82,7 +81,7 @@ def runner(opts, filename, plan)
       # Test plan content (test cases).
       # Ex: {"domain1": {"port": 80}, "domain2": {"port": 80}...}
       if tdiplan.respond_to?(plan_name)
-        tdiplan.send(plan_name, plan_content)
+        tdiplan.send(plan_name, role_name, plan_name, plan_content)
       else
         puts "Skipping not supported test plan type \"#{plan_name}\" for \"#{role_name}::#{plan_name}\".".yellow
         tdiplan.skip = tdiplan.skip + total_cases
@@ -95,7 +94,40 @@ def runner(opts, filename, plan)
   # Summary.
   summary(opts, tdiplan)
 
+  # Report file.
+  report(opts, tdiplan)
+
   # Shred.
+  shred(opts, filename, tdiplan)
+
+  puts 'Running tests... done.'.green if opts[:verbose] > 1
+
+  ret = tdiplan.plan_passed? ? 0 : 1
+  ret = 0 if opts.nofail?
+  ret
+end
+
+# Display test summary.
+def summary(opts, tdiplan)
+  puts '=' * 79
+  puts "Total: #{tdiplan.total}  |  Skip: #{tdiplan.skip}  |  Pass: #{tdiplan.pass}  |  Warn: #{tdiplan.warn}  |  Fail: #{tdiplan.fail}"
+end
+
+# Generate report file.
+def report(opts, tdiplan)
+  if opts[:verbose] > 2
+    puts 'Report:'.cyan
+    a_p tdiplan.report
+  end
+
+  if opts.reportfile?
+    puts "Generating report file: \"#{opts[:reportfile]}\"".cyan if opts[:verbose] > 1
+    File.open(opts[:reportfile], 'w') { |file| file.write(JSON.pretty_generate(tdiplan.report)) }
+  end
+end
+
+# Remove tdi plan file.
+def shred(opts, filename, tdiplan)
   if opts.shred?
     puts "Shreding and removing test plan file: \"#{filename}\"...".cyan if opts[:verbose] > 2
     if OS.linux?
@@ -112,16 +144,4 @@ def runner(opts, filename, plan)
       puts "ERR: Shreding and removing test plan file: \"#{filename}\".".light_magenta
     end
   end
-
-  puts 'Running tests... done.'.green if opts[:verbose] > 1
-
-  ret = tdiplan.plan_passed? ? 0 : 1
-  ret = 0 if opts.nofail?
-  ret
-end
-
-# Display test summary.
-def summary(opts, tdiplan)
-  puts '=' * 79
-  puts "Total: #{tdiplan.total}  |  Skip: #{tdiplan.skip}  |  Pass: #{tdiplan.pass}  |  Warn: #{tdiplan.warn}  |  Fail: #{tdiplan.fail}"
 end

data/lib/tdi.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 '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
+  attr_accessor :skip, :pass, :warn, :fail, :report
 
   def initialize
     @plan_passed = true
@@ -32,21 +33,32 @@ class TDI
     @pass = 0
     @warn = 0
     @fail = 0
+    @report = {hostname: Socket.gethostname}
   end
 
-  def success(msg)
+  def update_report(status, role_name, plan_name, res_dict)
+    @report[role_name] = {} unless @report.has_key?(role_name)
+    @report[role_name][plan_name] = [] unless @report[role_name].has_key?(plan_name)
+    res_dict[:status] = status
+    @report[role_name][plan_name] << res_dict
+  end
+
+  def success(role_name, plan_name, res_msg, res_dict)
+    update_report(:pass, role_name, plan_name, res_dict)
     # I like the seventies.
-    printf("%-70s [ %s ]\n", msg, 'PASS'.light_green )
+    printf("%-70s [ %s ]\n", res_msg, 'PASS'.light_green)
     @pass += 1
   end
 
-  def warning(msg)
-    printf("%-70s [ %s ]\n", msg, 'WARN'.light_yellow )
+  def warning(role_name, plan_name, res_msg, res_dict)
+    update_report(:warn, role_name, plan_name, res_dict)
+    printf("%-70s [ %s ]\n", res_msg, 'WARN'.light_yellow)
     @warn += 1
   end
 
-  def failure(msg)
-    printf("%-70s [ %s ]\n", msg, 'FAIL'.light_red )
+  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

data/lib/tdi/version.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2013-2014 Globo.com
+# Copyright (C) 2013-2015 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.1.6'
+  VERSION = '0.1.7'
 end

data/lib/util.rb

@@ -0,0 +1,110 @@
+#
+# Copyright (C) 2013-2015 Globo.com
+#
+
+# This file is part of TDI.
+
+# TDI is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# TDI is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with TDI.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'awesome_print'
+require 'socket'
+require 'ipaddress'
+require 'resolv'
+
+# Awesome Print config.
+def a_p(obj)
+  ap obj, {
+    indent: 2,
+    index: false,
+    color: {
+      args:       :pale,
+      array:      :white,
+      bigdecimal: :blue,
+      class:      :yellow,
+      date:       :greenish,
+      falseclass: :red,
+      fixnum:     :blue,
+      float:      :blue,
+      hash:       :blue,
+      keyword:    :cyan,
+      method:     :purpleish,
+      nilclass:   :red,
+      rational:   :blue,
+      string:     :green,
+      struct:     :pale,
+      symbol:     :cyanish,
+      time:       :greenish,
+      trueclass:  :green,
+      variable:   :cyanish,
+    }
+  }
+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') }.
+    map do |ifaddr|
+      ip = IPAddress::IPv4.new("#{ifaddr.addr.ip_address}/#{ifaddr.netmask.ip_address}")
+      {
+        interface: ifaddr.name,
+        net: ip.network.to_string,
+        network: ip.network.address,
+        netmask: ip.netmask,
+        prefix: ip.prefix,
+        broadcast: ip.broadcast.address,
+        ipv4: ip.address,
+      }
+    end
+end
+
+# Return the origin network to be used when trying to connect to a remote
+# service.
+#
+# Stolen from:
+#
+# https://coderrr.wordpress.com/2008/05/28/get-your-local-ip-address/
+#
+# The above code does NOT make a connection or send any packets. Since UDP is a
+# stateless protocol connect() merely makes a system call which figures out how
+# to route the packets based on the address and what interface (and therefore IP
+# address) it should bind to. addr() returns an array containing the family
+# (AF_INET), local port, and local address (which is what we want) of the socket.
+# This is a good alternative to `ifconfig`/`ipconfig` solutions because it
+# doesn’t spawn a shell and it works the same on all systems.
+def origin_network(remote)
+  orig, Socket.do_not_reverse_lookup = Socket.do_not_reverse_lookup, true
+
+  host = remote # host (name or IP)
+  if IPAddress.valid?(remote)
+    addr = remote # use address (already IP)
+  else
+    addr = Resolv.getaddress(remote) rescue nil # get address (resolve name to IP)
+  end
+
+  UDPSocket.open do |s|
+    begin
+      s.connect(remote, 1)
+      res = {from: local_networks.each.select { |locnet| locnet[:ipv4].eql?(s.addr.last) }.first}
+    rescue
+      res = {from: nil}
+    end
+
+    res[:to] = {host: host, addr: addr}
+
+    return res
+  end
+
+ensure
+  Socket.do_not_reverse_lookup = orig
+end

data/tdi.gemspec

@@ -29,4 +29,6 @@ validating your deployed infrastructure and external dependencies.)
   spec.add_runtime_dependency 'colorize'
   spec.add_runtime_dependency 'timeout', '0.0.0'
   spec.add_runtime_dependency 'net-ssh'
+  spec.add_runtime_dependency 'awesome_print'
+  spec.add_runtime_dependency 'ipaddress'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tdi
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Rogério Carvalho Schneider
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-10 00:00:00.000000000 Z
+date: 2015-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -124,6 +124,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ipaddress
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   Test Driven Infrastructure acceptance helpers for
   validating your deployed infrastructure and external dependencies.
@@ -145,6 +173,10 @@ files:
 - README.md
 - Rakefile
 - bin/tdi
+- doc/json/acl.json
+- doc/json/file.json
+- doc/json/http.json
+- doc/json/ssh.json
 - helper/acl.rb
 - helper/file.rb
 - helper/http.rb
@@ -155,6 +187,7 @@ files:
 - lib/runner.rb
 - lib/tdi.rb
 - lib/tdi/version.rb
+- lib/util.rb
 - tdi.gemspec
 homepage: https://github.com/globocom/tdi
 licenses: