warning-shot 0.8.9

data/History.txt

@@ -0,0 +1,8 @@
+== 0.8.9 2008-02-26
+* 1 major enhancement:
+  * Real initial public release, I hope.
+
+== 0.8.8 2008-01-14
+
+* 1 major enhancement:
+  * Initial public release

data/License.txt

@@ -0,0 +1,24 @@
+* Copyright (c) 2007 Ripple Networks, Inc.
+* All rights reserved.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*     * Redistributions of source code must retain the above copyright
+*       notice, this list of conditions and the following disclaimer.
+*     * Redistributions in binary form must reproduce the above copyright
+*       notice, this list of conditions and the following disclaimer in the
+*       documentation and/or other materials provided with the distribution.
+*     * Neither the name of the <organization> nor the
+*       names of its contributors may be used to endorse or promote products
+*       derived from this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY RIPPLE NETWORKS, INC ``AS IS'' AND ANY
+* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL RIPPLE NETWORKS, INC BE LIABLE FOR ANY
+* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Manifest.txt

@@ -0,0 +1,44 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/warning-shot
+config/hoe.rb
+config/requirements.rb
+config/warning_shot/binaries.yml
+config/warning_shot/classes.yml
+config/warning_shot/filesystem.yml
+config/warning_shot/gems.yml
+config/warning_shot/preload.yml
+config/warning_shot/urls.yml
+config/warning_shot/scripts/shell/pre.sh
+config/warning_shot/scripts/ruby/pre.rb
+config/warning_shot/scripts/ruby/pre_example.rb
+config/warning_shot/scripts/ruby/example.rb
+config/warning_shot/scripts/ruby/post_example.rb
+config/warning_shot/scripts/ruby/post.rb
+images/ruby_ok.png
+images/ruby_fail.png
+lib/warning_shot.rb
+lib/warning_shot/dep_checker.rb
+lib/warning_shot/template_generator.rb
+lib/warning_shot/gem_handler.rb
+lib/warning_shot/config_parser.rb
+lib/warning_shot/test_script.rb
+lib/warning_shot/version.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_warning_shot.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,65 @@
+README
+
+
+INSTALLATION
+	gem install warning_shot
+	
+	
+USAGE
+	WarningShot can be used from the command line or in a capistrano script via the 'warning-shot' binary.
+	
+	Options are:
+
+	        --environment=RAILS_ENV      Environment to test in.
+	                                     Default: development
+	    -s, --strict                     URL Testing is only successful on 200 instead of 2xx
+	    -f, --flush                      Flush log before running
+	    -g, --gems                       Install/update all missing OR outdated gems
+	        --dir=DIR                    The root directory of the application to check.
+	                                     Default: .
+	        --log=LOG                    Path of log file.
+	                                     Default: (--dir path)/logs/warning_shot_(--environment).log
+	        --configs=PATH               Path to config files to use.
+	                                     Default: (--dir path)/config/warning_shot/
+	    -v, --verbose                    Output verbose information.
+	    -n, --growl                      Output final results via growlnotify (Requires growlnotify)
+	        --templates=[PATH]           Generates template files
+	                                     Default: Not Generated! (If specified, default is '.')
+	    -h, --help                       Show this help message.
+	
+	
+CONFIGURATION FILES
+	(Additional details are in each individual config file)
+	Configuration files can be generated with 'warning-shot --templates=/PATH/TO/TEMPLATES'.  This will
+	generate five configuration files:
+		- binaries.yml (Binary applications or scripts)
+		- classes.yml (Classes your application is dependent on, generally anything after 'requires')
+		- filesystem.yml (Specific files or directories to test existance of)
+		- gems.yml (Required gems and their versions)
+		- preload.yml (These are files that are needed for testing, they will be loaded with 'requires' before testing starts.)
+				A failed preload is fatal and will stop testing.
+		- urls.yml (Required URLs)
+	
+	Each config file contains a list of application environments as well as a 'global' environment.  Dependency
+	requirements can be placed in the applicable environment where the dependency exists, or can be added to the
+	'global' environment, which will use the dependency in all cases.
+	
+	Template generation will also create a 'scripts' directory for ruby and shell scripts (discussed next).
+	
+
+SCRIPTS
+	Scripts are available for more complex dependency testing, like testing web services, verifying network interfaces, etc.
+	
+	Currently only ruby scripts are supported (bash will be supported soon).  All scipts should extend "RippleNetworks::WarningShot::TestScript"
+	and implement a "run" method.  "run" should return whether the test passed or failed (true or false).
+	
+	Test scripts are run in a natural sort order with the exception of "pre" and "post" scripts.
+	
+	A master pre and post script exists (pre.rb and post.rb respectively) that will run before and after all other scripts.
+	This can be used to set up and tear down additional aspects of the test environment.
+	
+	Each script that you create can also have a pre and post script run by creating an additional script with the
+	prefix "pre_" or "post_" in the script directory.
+	
+	The scripts should return a TRUE of FALSE value to let WarningShot know if the test was considered a pass or not.  An array
+	can be returned [Boolean,String] of the result and message.  The message will be display if provided.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/warning-shot

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2007-12-12.
+#  Author: Cory O'Daniel
+#  Copyright (c) 2007. All rights reserved.
+
+
+require 'rubygems'
+require 'warning_shot'
+include RippleNetworks::WarningShot
+require 'optparse'
+
+OPTIONS = DepChecker::DEFAULTS.clone
+MANDATORY_OPTIONS = DepChecker::MANDATORY_OPTIONS.clone
+
+parser = OptionParser.new do |opts|
+  opts.banner = <<BANNER
+WarningShot - Application Dependency Checker
+
+Usage: #{File.basename($0)} [options]
+
+Options are:
+BANNER
+  opts.separator ""
+  opts.on("--environment=APP_ENV", DepChecker::ENVIRONMENT_MAP.keys,
+    "Environment to test in.",
+    "Default: #{OPTIONS[:environment]}") { |OPTIONS[:environment]| }
+  opts.on("-s", "--strict",
+    "URL Testing is only successful on 200 instead of 2xx") { |OPTIONS[:strict]| }
+  opts.on("-f", "--flush",
+    "Flush log before running") { |OPTIONS[:flush]| }
+  opts.on("-g", "--gems",
+    "Install/update all missing OR outdated gems") { |OPTIONS[:gems]| }
+  opts.on("--dir=DIR", String,
+    "The root directory of the application to check.",
+    "Default: #{OPTIONS[:dir]}") { |OPTIONS[:dir]| }
+  opts.on("--log=LOG", String,
+    "Path of log file.",
+    "Default: (--dir path)/logs/warning_shot_(--environment).log") { |OPTIONS[:log]| }
+  opts.on("--configs=PATH", String,
+    "Path to config files to use.",
+    "Default: (--dir path)/config/warning_shot/") { |OPTIONS[:configs]| }
+  opts.on("-v", "--verbose", 
+    "Output verbose information.") { |OPTIONS[:verbose]| }
+  opts.on("-n", "--growl",
+    "Output final results via growlnotify (Requires growlnotify)") { |OPTIONS[:growl]| }
+  opts.on("--templates=[PATH]",String,
+    "Generates template files",
+    "Default: Not Generated! (If specified, default is '.')") { |OPTIONS[:templates]| }
+  opts.on("-h", "--help",
+    "Show this help message.") { puts opts; exit }
+    
+  begin
+    opts.parse!(ARGV)
+  rescue OptionParser::InvalidOption => opio
+    puts opio
+    puts opts
+    exit
+  rescue OptionParser::InvalidArgument => opia
+    puts opia
+    puts opts
+    exit
+  end
+
+  if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |OPTIONS| options[option.to_sym].nil? }
+    puts opts; exit
+  end
+end
+
+if OPTIONS[:templates] == false
+  DepChecker.new(OPTIONS).run()
+else
+  DepChecker::generate_templates(OPTIONS[:templates])
+end

data/config/hoe.rb

@@ -0,0 +1,71 @@
+require 'warning_shot/version'
+
+AUTHOR = ["Cory O'Daniel"]
+EMAIL = "codaniel @nospam@ rippletv.com"
+DESCRIPTION = "Application Dependency Checker"
+GEM_NAME = 'warning-shot' 
+RUBYFORGE_PROJECT = 'warning-shot'
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "coryodaniel"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = RippleNetworks::WarningShot::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'warning_shot documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = [] # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'warning_shot'

data/config/warning_shot/binaries.yml

@@ -0,0 +1,10 @@
+--- 
+:test:
+:global: 
+ - /usr/sbin/sendmail
+ - ls
+:development: []
+:qa: []
+:production: []
+  
+#Binaries found using 'which'

data/config/warning_shot/classes.yml

@@ -0,0 +1,12 @@
+#These are classes your application is dependent upon, ie things that appear after "requires"
+# in your source code.  After the environment is booted (RAILS, MERB) these will be tested to
+# see if they are accessible via "requires".  They should be listed just as they are
+# in your source code
+---
+:global:
+ - yaml
+:development: []
+:test: []
+:qa: []
+:production: []
+  

data/config/warning_shot/filesystem.yml

@@ -0,0 +1,8 @@
+---
+:test: []
+:global: 
+ - "/tmp"
+:development: []
+:qa: []
+:production: []
+  

data/config/warning_shot/gems.yml

@@ -0,0 +1,15 @@
+# rake: => Will verify exists or install newest
+# rake:0.4.0 => Will verify 0.4.0 or install that version
+# rake:>0.4.0 => Will verify/install anything after 0.4.0
+# rake:>0.0.0 => Will verify/install newest
+# rake:>= 0.3.0 => will verify/install 0.3.0 or later
+# rake:<1.0 => will verify/install less than 1.0
+--- 
+:global: 
+ - rake:=0.7.3
+:test: []
+:development: []
+:qa: []
+:stage: []
+:production: []
+  

data/config/warning_shot/preload.yml

@@ -0,0 +1,10 @@
+#These are pathes to ruby files that you may want to load before testing starts.  
+#Any files that may be needed for ruby scripts or whatever.  
+#These are loaded with "requires"
+---
+:global: []
+:development: []
+:test: []
+:qa: []
+:production: []
+

data/config/warning_shot/scripts/ruby/example.rb

@@ -0,0 +1,19 @@
+#This is an example script
+class Example < RippleNetworks::WarningShot::TestScript
+  
+  def initialize()
+  end
+  
+=begin rdoc
+  *Name*:: run
+  *Access*:: public
+  *Description*:: Performs test
+  ===Returns
+  *Description*:: Result of test
+  *Datatype*:: boolean
+=end
+  def run()
+    return [true,"This test passed."]
+  end
+  
+end

data/config/warning_shot/scripts/ruby/post.rb

@@ -0,0 +1,18 @@
+#Post script will run after all other scripts
+class Post < RippleNetworks::WarningShot::TestScript
+  def initialize()
+  end
+
+=begin rdoc
+  *Name*:: run
+  *Access*:: public
+  *Description*:: Performs test
+  ===Returns
+  *Description*:: Result of test
+  *Datatype*:: boolean
+=end
+  def run()
+    return true
+  end
+
+end

data/config/warning_shot/scripts/ruby/post_example.rb

@@ -0,0 +1,18 @@
+#post_example will run after example.rb
+class PostExample < RippleNetworks::WarningShot::TestScript
+  def initialize()
+  end
+
+=begin rdoc
+  *Name*:: run
+  *Access*:: public
+  *Description*:: Performs test
+  ===Returns
+  *Description*:: Result of test
+  *Datatype*:: boolean
+=end
+  def run()
+    return true
+  end
+
+end

data/config/warning_shot/scripts/ruby/pre.rb

@@ -0,0 +1,18 @@
+#Pre Script will run before all other scripts
+class Pre < RippleNetworks::WarningShot::TestScript
+  def initialize()
+  end
+
+=begin rdoc
+  *Name*:: run
+  *Access*:: public
+  *Description*:: Performs test
+  ===Returns
+  *Description*:: Result of test
+  *Datatype*:: boolean
+=end
+  def run()
+    return true
+  end
+
+end

data/config/warning_shot/scripts/ruby/pre_example.rb

@@ -0,0 +1,19 @@
+#pre_example will run before the example.rb script
+class PreExample < RippleNetworks::WarningShot::TestScript
+  
+  def initialize()
+  end
+
+=begin rdoc
+  *Name*:: run
+  *Access*:: public
+  *Description*:: Performs test
+  ===Returns
+  *Description*:: Result of test
+  *Datatype*:: boolean
+=end
+  def run()
+    return true
+  end
+  
+end

data/config/warning_shot/urls.yml

@@ -0,0 +1,9 @@
+--- 
+:test: []
+:global: 
+ - "http://www.google.com"
+ - "http://www.yahoo.com"
+:development: []
+:qa: []
+:production: []
+  

data/lib/warning_shot/config_parser.rb

@@ -0,0 +1,46 @@
+module RippleNetworks
+  module WarningShot
+    class ConfigParser
+      require 'yaml'
+      include RippleNetworks::WarningShot
+      
+      def ConfigParser.run(ws)
+
+        env_interned = ws.options[:environment].intern
+        configs_not_found = 0
+
+        DepChecker::DEP_FILES.each do |config_file|
+
+          file_path = File.join(ws.options[:configs],%{#{config_file}.yml})
+
+          begin
+            yaml = YAML::load(File.open(file_path,"r"))
+
+            #Default missing environments to []
+            global = (yaml[:global].nil? || yaml[:global] === true)? [] : yaml[:global]
+            running_env = (yaml[env_interned].nil? || yaml[env_interned] === true)? [] : yaml[env_interned]
+
+            #Merge :global and current mode, make unique
+            ws.configs[config_file] = global.concat(running_env)
+            ws.configs[config_file].uniq!
+
+            ws.record("LOADED: #{config_file}.yml")
+          rescue Errno::ENOENT => e
+            ws.configs[config_file] = {}
+            configs_not_found += 1
+            ws.record("NOT FOUND: #{config_file}.yml",:warning)
+          rescue Exception => e
+            ws.record(e.inspect)
+            ws.configs[config_file] = {} 
+            ws.record("MALFORMED: #{config_file}.yml",:error)
+          end
+        end
+
+        if configs_not_found == DepChecker::DEP_FILES.size
+          ws.record("No configuration files found!\n\t\tTo generate run 'warning-shot --templates=PATH'",:info)
+        end
+      end
+      
+    end
+  end
+end