faultinjection 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-01-10
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Keisuke Fukuda
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,36 @@
+#*scratch*#18552Tu2#
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/fault_injection.rb
+lib/fault_injection/fault_condition.rb
+lib/fault_injection/parser.rb
+lib/fault_injection/version.rb
+log/debug.log
+script/destroy
+script/generate
+script/makemanifest.rb
+script/txt2html
+setup.rb
+spec/compile_spec.rb
+spec/fault_condition_call_spec.rb
+spec/fault_injection_spec.rb
+spec/line_condition_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/target_00.rb
+spec/target_01.rb
+spec/target_02.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake
+tasks/website.rake
+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,72 @@
+fault_injection.rb
+
+** FAQ
+
+  * What is it?
+
+    - A 'fault injection' tool for ruby.
+
+  * What is a 'fault injection'? What is it used for?
+
+    - Fault injection is one of testing techniques.
+      It makes easier to test your application's error handling behavior or
+      to improve the coverage of your tests.
+      See http://en.wikipedia.org/wiki/Fault_injection for more details.
+
+  * Can I use it in my application code?
+
+    - No. It is for your testing code.
+
+  * Can I use it everywhere in my test code?
+
+    - You should not. It is for some limited situation that rarely
+      happen or difficult to set up (ex. IOError).
+      If you can make 'evil situation' easily, that's better ;)
+
+** Installing
+
+$ sudo gem install faultinjection
+
+** Sample codes
+
+  # sample.rb
+  class Foo
+    def foo
+      puts "I love injection"
+    end
+
+    def bar
+      10 / 2  # this is line 7
+    end
+  end
+  __END__
+
+  # test.rb
+  require 'fault_injection'
+  include FaultInjection
+
+  inject "Foo#foo > Kernel#puts", IOError, "IO error"
+
+  f = Foo.new
+  f.foo #=> IOError
+
+  inject "sample.rb:7",ZeroDivisionError
+
+  f.bar #=> ZeroDivisionError
+  __END__
+
+
+** License
+
+This code is free to use under the terms of the MIT license. 
+
+** Contact
+
+The SVN repository is available at http://faultinjection.rubyforge.org/svn/
+
+Comments are welcome. Feel free to Send an email to keisukefukuda@gmail.com
+(Please include 'ruby' or 'fault_injection' in the title).
+
+
+Thank you for using fault_injection.rb
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+task :test => :spec

data/config/hoe.rb

@@ -0,0 +1,71 @@
+require 'fault_injection/version'
+
+AUTHOR = 'FIXME full name'  # can also be an array of Authors
+EMAIL = "FIXME email"
+DESCRIPTION = "description of gem"
+GEM_NAME = 'faultinjection' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'faultinjection' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+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 = FaultInjection::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'fault_injection 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 'fault_injection'

data/lib/fault_injection/fault_condition.rb

@@ -0,0 +1,108 @@
+module FaultInjection
+  
+  class FaultConditionBase
+	attr_accessor :error_class
+	attr_accessor :message
+	attr_accessor :probability
+	attr_accessor :limit_times
+
+	def initialize
+	  @probability ||= 1
+	  @limit_times ||= -1
+	end
+	
+	def should_raise_on(*args)
+	  return false if @limit_times == 0
+	  
+	  b = _should_raise_on(*args)
+
+	  if @probability < 1
+		b = b && rand(0) < @probability
+	  end
+
+	  @limit_times -= 1 if b
+
+	  b
+	end
+
+	private
+	
+	def _should_raise_on(*args)
+	  false
+	end
+  end
+  
+  class FaultConditionLine < FaultConditionBase
+	attr_accessor :file
+	attr_accessor :line
+	
+	def initialize(file,line,prob=1)
+	  @file = file
+	  @line = line
+	  self.probability = prob
+
+	  if @line <= 0
+		raise ArgumentError,"line number must be greater than 0."
+	  end
+
+	  if prob < 0 or prob > 1
+		raise ArgumentError, "Probability must be between 0 and 1."
+	  end
+	  
+	  super()
+	end
+
+	private
+	def _should_raise_on *args
+	  if args.size == 2
+		file,line = *args
+		reg = Regexp.new(Regexp.escape(@file) + '$')
+		return reg.match(file) && line == @line
+		
+	  else
+		false
+	  end
+	end
+  end
+
+  class FaultConditionCall < FaultConditionBase
+	# representing method chain(callee first)
+	#   [ [class,'method_name'],
+	#     [class,'method_name'],
+	#              ...
+	#     [class,'method_name'] ]
+	attr_accessor :stack_pattern
+
+	def initialize
+	  @stack_pattern = []
+
+	  super()
+	end
+
+	def add_callee(klass,method)
+	  @stack_pattern.unshift [klass,method]
+	end
+
+	private
+	def _should_raise_on *args
+	  return false if @stack_pattern.nil? or @stack_pattern.size == 0
+	  
+	  if args[0].instance_of? Array
+		stack = args[0]
+		#STDERR.puts @stack_pattern.map{|e| "#{e[0]}##{e[1]}"}.join("\n")
+		
+		return false if stack.size < @stack_pattern.size
+
+		@stack_pattern.each_index do |i|
+		  e = @stack_pattern[i]
+		  b = stack[-i-1]
+		  return false if e[0] != b[0].to_s.to_sym or e[1] != b[1].to_sym
+		end
+		
+		true
+	  else
+		false
+	  end
+	end
+  end
+end

data/lib/fault_injection/parser.rb

@@ -0,0 +1,31 @@
+# Command examples
+# 
+# parser.rb:30  => line 30 in parser.rb
+#
+module FaultInjection
+  class Parser
+	def self.compile src
+	  method_pat = '([A-Z][A-Za-z0-9_]*)(?:#|::)([a-z_][a-zA-Z0-9_]*)'
+	  src.gsub!(/\s/,'')
+	  
+	  if src =~ /([A-Za-z0-9_.~-]+):(\d+)/
+		return FaultConditionLine.new($1,$2.to_i)
+
+	  else
+		methods = src.split(">")
+		methods.map! do |e|
+		  unless e =~ Regexp.new(method_pat)
+			raise ArgumentError,"Invalid method name:'#{e}'"
+		  end
+
+		  [$1.to_sym,$2.to_sym]
+		end
+
+		c = FaultConditionCall.new
+		c.stack_pattern = methods.reverse # callee first
+		
+		return c
+	  end
+	end
+  end
+end

data/lib/fault_injection/version.rb

@@ -0,0 +1,9 @@
+module FaultInjection #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/fault_injection.rb

@@ -0,0 +1,121 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'fault_injection/fault_condition.rb'
+require 'fault_injection/parser.rb'
+
+module FaultInjection
+  @@injected_faults = nil
+  @@method_stack = Array.new
+  
+  def inject_fault(*args)
+	FaultInjection.inject_fault *args
+  end
+  
+  def self.inject_fault(command,error_class=RuntimeError,msg="injected fault")
+	unless error_class <= Exception
+	  raise ArgumentError, "Error class must be a subclass of Exception"
+	end
+
+	cond = nil
+
+	if String === command
+	  cond = Parser.compile(command)
+	  cond.error_class = error_class
+	  cond.message = msg
+	  
+	elsif Hash === command and command.key?(:line) and command.key?(:file)
+	  cond = inject_fault_on_line(command[:file],
+								  command[:line],
+								  error_class,msg)
+	elsif Array === command
+	  cond = inject_fault_on_trace(command,error_class,msg)
+	else
+	  raise "Unknown Command"
+	end
+	
+	if @@injected_faults.nil?
+	  @@injected_faults = Array.new
+	  set_trace_func method(:fault).to_proc
+	end
+
+	raise "[BUG] Internal Error. Please report this to the author :)" if cond.nil?
+	
+	@@injected_faults << cond
+  end
+
+  # delete all injected faults.
+  def self.clear
+	@@injected_faults = nil
+	set_trace_func Proc.new{}
+  end
+
+  # Same as FaultInjection::clear
+  def clear
+	FaultInjection.clear
+  end
+  
+  private
+
+  # Create fault condition on file:line.
+  def self.inject_fault_on_line(file,line,error_class,msg)
+	if line <= 0
+	  raise ArgumentError,"line number must not be less than 0"
+	end
+	
+	cond = FaultConditionLine.new(file,line)
+	cond.error_class = error_class
+	cond.message = msg
+	
+	cond
+  end
+
+  # Create fault condition on method call trace
+  def self.inject_fault_on_trace(trace,error_class,msg)
+	trace = trace.flatten
+
+	if trace.size == 0 or trace.size % 2 != 0 
+	  raise ArgumentError, "command must be array of class/method pair."
+	end
+
+	cond = FaultConditionCall.new
+
+	while trace.size > 0
+	  klass = trace.shift.to_sym
+	  method = trace.shift.to_sym
+
+	  cond.add_callee klass,method
+	end
+	
+	cond.error_class = error_class
+	cond.message = msg
+
+	cond
+  end
+  
+  # Callback function called by ruby interpreter.
+  def self.fault(event,file,line,id,binidng,klass)
+	return if @@injected_faults.nil?
+	
+	if event == "line"
+	  #puts "event = '#{event}', file = #{file}, line = #{line}"
+	  
+	  @@injected_faults.each do |f|
+		if f.should_raise_on(file,line)
+		  raise f.error_class, f.message, caller(4)
+		end
+	  end
+
+	elsif event == "call" or event == "c-call"
+		
+	  @@injected_faults.each do |f|
+		if f.should_raise_on(@@method_stack)
+		  raise f.error_class, f.message, caller(4)		
+		end
+	  end
+	  @@method_stack.push([klass,id])
+	  
+	elsif event == "return" or event == "c-return"
+	  @@method_stack.pop
+	end
+  end
+end

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/makemanifest.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/ruby
+
+base_dir = File.join(File.dirname(__FILE__), "..")
+glob_pattern = File.join("**", "*")
+exclude_patterns = [
+  /^pkg/,/^doc/,
+]
+
+Dir.chdir(base_dir)
+files = Dir.glob(glob_pattern).delete_if do |fname|
+  File.directory?(fname) or
+  exclude_patterns.find do |pattern|
+    pattern =~ fname
+  end
+end
+manifest = File.new("Manifest.txt", "w")
+manifest.puts files.sort.join("\n")
+manifest.close
+
+puts "Manifest.txt updated"

data/script/txt2html

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+begin
+  require 'newgem'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/fault_injection/version.rb'
+
+version  = FaultInjection::VERSION::STRING
+download = 'http://rubyforge.org/projects/fault_injection'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.rhtml')
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)