faultinjection 0.0.1

data/spec/compile_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'fault_injection.rb'
+
+include FaultInjection
+
+describe Parser do
+  it "should return FaultConditionLine on 'foo.rb:32'" do
+	c = Parser.compile('foo.rb:32')
+	c.instance_of?(FaultConditionLine).should be_true
+	c.line.should be_eql(32)
+	c.file.should be_eql('foo.rb')
+  end
+
+  it "can parse 'Class#method' format." do
+	c = Parser.compile('Array#size')
+	c.instance_of?(FaultConditionCall).should be_true
+	c.stack_pattern.should be_eql([[:Array,:size]])
+  end
+
+  it "should raise NameError with invalid class" do
+	Proc.new{
+	  c = Parser.compile("00#size")
+	}.should raise_error(ArgumentError)
+  end
+
+  it "should raise NameError with invalid method" do
+	Proc.new{
+	  c = Parser.compile("Array#3")
+	}
+  end
+
+  it "can parse multiple method chain" do
+	c = Parser.compile("Array#push > String#size")
+	c.instance_of?(FaultConditionCall).should be_true
+
+	c.stack_pattern.should be_eql([[:String,:size],[:Array,:push]])
+  end
+end

data/spec/fault_condition_call_spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'fault_injection.rb'
+
+include FaultInjection
+
+class Foo
+  def foo
+  end
+end
+
+class Bar
+  def bar
+	f = Foo.new
+	f.foo
+  end
+end
+
+describe FaultConditionCall do
+
+  it "matches method calling backtrace" do
+	c = FaultConditionCall.new
+	c.stack_pattern = [[:Array,:each]]
+	c.should_raise_on([[:Array,:each]]).should be_true
+
+	c.should_raise_on([[:Hash,:keys],
+						[:Array,:each]]).should be_true
+
+	c.should_raise_on([[:Integer,:to_f]]).should_not be_true
+
+	c.stack_pattern = [
+					   [:Array,:each], # callee first
+					   [:Hash, :keys],
+					   [:Integer, :to_s]
+					  ]
+	c.should_raise_on([[:Array,:each]]).should_not be_true
+	c.should_raise_on(c.stack_pattern.reverse).should be_true
+	bt = [
+		  [:String,:size], # caller first
+		  [:Integer, :to_s],
+		  [:Hash, :keys],
+		  [:Array,:each]
+		 ]
+	c.should_raise_on(bt).should be_true
+  end
+end

data/spec/fault_injection_spec.rb

@@ -0,0 +1,89 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'fault_injection.rb'
+
+include FaultInjection
+$LOAD_PATH << File.dirname(__FILE__)
+
+describe "Argument Checking" do
+  it "raises if a line number is less than 0" do
+	Proc.new{
+	  inject_fault({:file => 'target_00.rb',:line => -5})
+	}.should raise_error(ArgumentError)
+  end
+
+  it "raises if a err_class is not a subclass of Exception" do
+	Proc.new {
+	  inject_fault({:file => 'target_00.rb',:line => 1}, 3)
+	}.should raise_error(ArgumentError)
+  end
+end
+
+describe "'File & line' fault-injection." do
+  require 'target_00.rb'
+
+  after(:each) do
+	clear
+  end
+  
+  it "works on Hash format for file & line specification" do
+	Proc.new{ target_func_00 }.should_not raise_error
+	inject_fault({:file => 'target_00.rb', :line => 9})
+
+	begin
+	  target_func_00
+	  violate "target_func_00 must raise RuntimeError"
+	rescue
+	  $!.instance_of?(RuntimeError).should be_true
+	  $!.backtrace[0].should match(/target_00\.rb/)
+	  $target_00['one'].should be_eql(1)
+	  $target_00['two'].should be_nil
+	  $target_00['three'].should be_nil
+	end
+  end
+  
+  it "works on 'file:line' format injection command." do
+	Proc.new{ target_func_00 }.should_not raise_error
+	
+	inject_fault "target_00.rb:9", SecurityError, "This is a error"
+	Proc.new{
+	  target_func_00
+	}.should raise_error(SecurityError,"This is a error")
+	
+  end
+end
+
+describe "Method tracing fault-injection" do
+  require 'target_02.rb'
+
+  after(:each) do
+	clear
+  end
+  
+  it "should check arguments in Array format command." do
+	Proc.new{ Bar.new.bar }.should_not raise_error
+
+	Proc.new{ inject_fault([]) }.should raise_error(ArgumentError)
+	Proc.new{ inject_fault([:Array]) }.should raise_error(ArgumentError)
+  end
+
+  it "should inject faults properly with Array format command" do
+	Proc.new{ Bar.new.bar }.should_not raise_error
+	
+	# raise on method calling chane, "Bar#bar --> Foo#foo"
+	inject_fault [:Bar,:bar,:Foo,:foo],RangeError
+	Proc.new{ Bar.new.bar }.should raise_error(RangeError)
+  end
+end
+
+describe "Specifying Exception class" do
+  require 'target_01.rb'
+  
+  it "can inject fault with specified Exception class" do
+ 	inject_fault({:file => 'target_01.rb', :line => 3},ArgumentError)
+	
+ 	Proc.new{ target_func_01 }.should raise_error(ArgumentError)
+
+	clear
+  end
+end
+

data/spec/line_condition_spec.rb

@@ -0,0 +1,81 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'fault_injection.rb'
+
+include FaultInjection
+
+describe FaultConditionLine do
+  it "raise if invalid arguments are specified" do
+	Proc.new{
+	  FaultConditionLine.new({:file=>'foo.rb', :line=>-5})
+	}.should raise_error(ArgumentError)
+  end
+
+  it "implements attr_accessors" do
+	c = FaultConditionLine.new("foo.rb",300)
+	c.file.should be_eql("foo.rb")
+	c.line.should be_eql(300)
+  end
+
+  it "matches file name and line numbers" do
+	c = FaultConditionLine.new("foo.rb",300)
+	c.should_raise_on("foo.rb",300).should be_true
+	c.should_raise_on("foo.rb",305).should_not be_true
+	c.should_raise_on("bar.rb",300).should_not be_true
+	c.should_raise_on("bar.rb",199).should_not be_true
+
+	c.should_raise_on("dir/foo.rb",300).should be_true
+	c.should_raise_on("dir/bar.rb",300).should_not be_true
+	c.should_raise_on("dir/foo.rb",390).should_not be_true
+
+	c.should_raise_on(caller).should_not be_true
+  end
+
+  it "can inject a fault with probability" do
+	c = FaultConditionLine.new("foo.rb",99)
+	c.probability = 0.5
+	
+	try_count = 3000
+	raise_count = 0
+	try_count.times { raise_count += 1 if c.should_raise_on('foo.rb',99) }
+	
+	probab = raise_count.to_f / try_count
+	probab.should be_close(0.5,0.05)
+	
+	c.should_raise_on('bar.rb',99).should_not be_true
+  end
+  
+  it "can inject a fault with count limit." do
+	c = FaultConditionLine.new('foo.rb',99)
+	c.limit_times = 5
+
+	5.times do
+	  c.should_raise_on('foo.rb',99).should be_true
+	  c.should_raise_on('foo.rb',100).should_not be_true
+	end
+
+	c.limit_times.should be_eql(0)
+	c.should_raise_on('foo.rb',99).should_not be_true
+	c.should_raise_on('foo.rb',100).should_not be_true
+  end
+
+  it "can inject a fault with both count limit and probability" do
+	try_count = 3000
+	
+	c = FaultConditionLine.new("foo.rb",99)
+	c.probability = 0.5
+	c.limit_times = try_count
+
+	raise_count = 0
+	all_count   = 0
+	while raise_count < try_count
+	  all_count += 1
+	  raise_count += 1 if c.should_raise_on('foo.rb',99)
+	end
+	
+	probab = raise_count.to_f / all_count
+	probab.should be_close(0.5,0.05)
+
+	c.limit_times.should be_eql(0)
+	c.should_raise_on('foo.rb',99).should_not be_true	
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH << File.dirname(__FILE__) + '/../lib'
+
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+

data/spec/target_00.rb

@@ -0,0 +1,11 @@
+
+def target_func_00
+  if $target_00.nil? or $target_00.keys.size > 0
+	$target_00 = Hash.new
+  end
+
+  # This comment is line 7
+  $target_00['one'] = 1
+  $target_00['two'] = 2
+  $target_00['three'] = 3
+end

data/spec/target_01.rb

@@ -0,0 +1,5 @@
+def target_func_01
+  a = 1 + 1
+  b = 2 + 2
+  c = 3 + 3
+end

data/spec/target_02.rb

@@ -0,0 +1,13 @@
+class Foo
+  def foo
+	return 3**3 # do something
+  end
+end
+
+class Bar
+  def bar
+	f = Foo.new
+	f.foo
+  end
+end
+

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+# begin
+#   require 'spec'
+# rescue LoadError
+#   require 'rubygems'
+#   require 'spec'
+# end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/*_spec.rb']
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/website/index.html

@@ -0,0 +1,138 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      fault_injection.rb
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <!--
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+  -->
+</head>
+<body>
+<div id="main">
+
+    <h1>fault_injection.rb</h1>
+    <div style="text-align:right;">
+      Last version: <a href="http://rubyforge.org/projects/fault_injection" class="numbers">0.0.1</a>
+    </div>
+    <h2>Overview</h2>
+
+
+	<h3>What is it?</h3>
+
+
+	<p>A &#8216;fault injection&#8217; tool for ruby.</p>
+
+
+	<h3>What is a &#8216;fault injection&#8217;? What is it used for?</h3>
+
+
+	<p>Fault injection is one of testing techniques.
+It makes easier to test your application&#8217;s error handling behavior or
+to improve the coverage of your tests.</p>
+
+
+	<p>See <a herf="http://en.wikipedia.org/wiki/Fault_injection">
+http://en.wikipedia.org/wiki/Fault_injection
+</a> for more details.</p>
+
+
+	<h3>Can I use it in my application code?</h3>
+
+
+	<p>No. It is for your testing code.</p>
+
+
+	<h3>Can I use it everywhere in my test code?</h3>
+
+
+	<p>You should not. It is for some limited situation that rarely
+happen or difficult to set up (ex. IOError).
+If you can make &#8216;evil situation&#8217; easily, that&#8217;s better ;)</p>
+
+
+	<h2>Installing</h2>
+
+
+	<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">faultinjection</span></pre></p>
+
+
+	<h2>Sample codes</h2>
+
+
+	<p><pre class='syntax'>
+
+<span class="comment"># sample.rb</span>
+<span class="keyword">class </span><span class="class">Foo</span>
+  <span class="keyword">def </span><span class="method">foo</span>
+    <span class="ident">puts</span> <span class="punct">&quot;</span><span class="string">I love injection</span><span class="punct">&quot;</span>
+  <span class="keyword">end</span>
+
+  <span class="keyword">def </span><span class="method">bar</span>
+    <span class="number">10</span> <span class="punct">/</span> <span class="number">2</span>  <span class="comment"># this is line 7</span>
+  <span class="keyword">end</span>
+<span class="keyword">end</span>
+
+<span class="comment"># test.rb</span>
+<span class="ident">require</span> <span class="punct">'</span><span class="string">fault_injection</span><span class="punct">'</span>
+<span class="ident">include</span> <span class="constant">FaultInjection</span>
+
+<span class="ident">inject</span> <span class="punct">&quot;</span><span class="string">Foo#foo &gt; Kernel#puts</span><span class="punct">&quot;,</span> <span class="constant">IOError</span><span class="punct">,</span> <span class="punct">&quot;</span><span class="string">IO error</span><span class="punct">&quot;</span>
+
+<span class="ident">f</span> <span class="punct">=</span> <span class="constant">Foo</span><span class="punct">.</span><span class="ident">new</span>
+<span class="ident">f</span><span class="punct">.</span><span class="ident">foo</span> <span class="comment">#=&gt; IOError</span>
+
+<span class="ident">inject</span> <span class="punct">&quot;</span><span class="string">sample.rb:7</span><span class="punct">&quot;,</span><span class="constant">ZeroDivisionError</span>
+
+<span class="ident">f</span><span class="punct">.</span><span class="ident">bar</span> <span class="comment">#=&gt; ZeroDivisionError</span>
+
+</pre></p>
+
+
+	<h2>License</h2>
+
+
+	<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+
+
+	<h2>Contact</h2>
+
+
+	<p>The <span class="caps">SVN</span> repository is available at http://faultinjection.rubyforge.org/svn/ for anonymous access.</p>
+
+
+	<p>Comments are welcome. Feel free to Send an email to keisukefukuda.spam@gmail.com</p>
+
+
+	<p>(Please remove &#8221;.spam&#8221; from the address for anti-spam, and include &#8216;ruby&#8217; or &#8216;fault_injection&#8217; in the title)</p>
+    <p class="coda">
+      <a href="keisukefukuda.spam@gmail.com">Keisuke Fukuda</a>, 11th January 2008<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>

data/website/index.txt

@@ -0,0 +1,74 @@
+h1. fault_injection.rb
+
+h2. Overview
+
+h3. What is it?
+
+A 'fault injection' tool for ruby.
+
+h3. 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 <a herf="http://en.wikipedia.org/wiki/Fault_injection">
+http://en.wikipedia.org/wiki/Fault_injection
+</a> for more details.
+
+h3. Can I use it in my application code?
+
+No. It is for your testing code.
+
+h3. 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 ;)
+
+h2. Installing
+
+<pre syntax="ruby">sudo gem install faultinjection</pre>
+
+h2. Sample codes
+
+<pre syntax="ruby">
+
+# sample.rb
+class Foo
+  def foo
+    puts "I love injection"
+  end
+
+  def bar
+    10 / 2  # this is line 7
+  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
+
+</pre>
+
+h2. License
+
+This code is free to use under the terms of the MIT license. 
+
+h2. Contact
+
+The SVN repository is available at http://faultinjection.rubyforge.org/svn/ for anonymous access.
+
+Comments are welcome. Feel free to Send an email to keisukefukuda.spam@gmail.com
+
+(Please remove ".spam" from the address for anti-spam, and include 'ruby' or 'fault_injection' in the title)
+