fork_break 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fork_break.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Petter Remen
+
+MIT License
+
+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/README.md

@@ -0,0 +1,109 @@
+# ForkBreak
+
+Fork with breakpoints, for testing multiprocess behaviour.
+
+Testing multiprocess behaviour is difficult and requires a way to synchronize processes at
+specific execution points. This gem allows the parent process to control the behaviour of child processes using
+breakpoints. It was originally built for testing the behaviour of database transactions and locking mechanisms.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fork_break'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fork_break
+
+## Usage
+
+A simple example
+
+```ruby
+process = ForkBreak::Process.new do |breakpoints|
+  sleep(1)
+  breakpoints << :after_sleep_1
+  sleep(2)
+  breakpoints << :after_sleep_2
+end
+
+def time(&block)
+  before = Time.now
+  block.call
+  (Time.now - before).round
+end
+
+puts time { process.run_until(:after_sleep_1).wait } # => 1
+puts time { process.run_until(:after_sleep_2).wait } # => 2
+puts time { process.finish.wait } # => 0
+```
+
+You can also get access to the breakpoints by including ForkBreak::Breakpoints, allowing you to test
+existing classes with minor changes. The following test the behaviour of using a file as a counter, with
+and without file locks.
+
+```ruby
+class FileCounter
+  include ForkBreak::Breakpoints
+
+  def self.open(path, use_lock = true)
+    file = File.open(path, File::RDWR|File::CREAT, 0600)
+    return new(file, use_lock)
+  end
+
+  def initialize(file, use_lock = true)
+    @file = file
+    @use_lock = use_lock
+  end
+
+  def increase
+
+    breakpoints << :before_lock
+
+    @file.flock(File::LOCK_EX) if @use_lock
+    value = @file.read.to_i + 1
+
+    breakpoints << :after_read
+
+    @file.rewind
+    @file.write("#{value}\n")
+    @file.flush
+    @file.truncate(@file.pos)
+  end
+end
+
+def counter_after_synced_execution(counter_path, with_lock)
+  process1, process2 = 2.times.map do
+    ForkBreak::Process.new do
+      FileCounter.open(counter_path, with_lock).increase
+    end
+  end
+
+  process1.run_until(:after_read).wait
+
+  # process2 can't wait for read since it will block
+  process2.run_until(:before_lock).wait
+  process2.run_until(:after_read) && sleep(0.1)
+
+  process1.finish.wait # Finish process1
+  process2.finish.wait # Finish process2
+
+  File.read(counter_path).to_i
+end
+
+puts counter_after_synced_execution("counter_with_lock",    true)  # => 2
+puts counter_after_synced_execution("counter_without_lock", false) # => 1
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/fork_break.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Petter Remen"]
+  gem.email         = ["petter.remen@gmail.com"]
+  gem.description   = %q{Testing multiprocess behaviour is difficult and requires a way to synchronize processes at
+specific execution points. This gem allows the parent process to control the behaviour of child processes using
+breakpoints. It was originally built for testing the behaviour of database transactions and locking mechanisms. }
+  gem.summary       = %q{Fork with breakpoints for syncing child process execution}
+  gem.homepage      = "http://github.com/remen/fork_break"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "fork_break"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.1.0"
+  gem.add_dependency "fork"
+  gem.add_development_dependency "rspec"
+end

data/lib/fork_break.rb

@@ -0,0 +1,70 @@
+require 'fork'
+
+module ForkBreak
+  class BreakpointNotReachedError < StandardError ; end
+
+  module Breakpoints
+    def breakpoints
+      return ForkBreak::Process.breakpoint_setter
+    end
+  end
+
+  class Process
+    class << self
+      attr_accessor :breakpoint_setter
+    end
+
+    def initialize(debug = false, &block)
+      @debug = debug
+      @fork = Fork.new(:return, :to_fork, :from_fork) do |child_fork|
+        self.class.breakpoint_setter = breakpoints = BreakpointSetter.new(child_fork, debug)
+
+        breakpoints << :forkbreak_start
+        block.call(breakpoints)
+        breakpoints << :forkbreak_end
+
+        self.class.breakpoint_setter = nil
+      end
+    end
+
+    def run_until(breakpoint)
+      @next_breakpoint = breakpoint
+      @fork.execute unless @fork.pid
+      puts "Parent is sending object #{breakpoint} to #{@fork.pid}" if @debug
+      @fork.send_object(breakpoint)
+      self
+    end
+
+    def wait
+      loop do
+        brk = @fork.receive_object
+        puts "Parent is receiving object #{brk} from #{@fork.pid}" if @debug
+        if brk == @next_breakpoint
+          return self
+        elsif brk == :forkbreak_end
+          raise BreakpointNotReachedError.new("Never reached breakpoint #{@next_breakpoint.inspect}")
+        end
+      end
+    end
+
+    def finish
+      run_until(:forkbreak_end)
+    end
+  end
+
+  class BreakpointSetter
+    def initialize(fork, debug = false)
+      @fork = fork
+      @next_breakpoint = :forkbreak_start
+      @debug = debug
+    end
+
+    def <<(symbol)
+      @fork.send_object(symbol)
+      if symbol == @next_breakpoint
+        @next_breakpoint = @fork.receive_object unless symbol == :forkbreak_end
+        puts "#{@fork.pid} received #{@next_breakpoint}" if @debug
+      end
+    end
+  end
+end

data/spec/fork_break_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+require 'tmpdir'
+
+module ForkBreak
+  describe Process do
+    it "works as intented" do
+      Dir.mktmpdir do |tmpdir|
+        first_file = File.join(tmpdir, "first_file")
+        second_file = File.join(tmpdir, "second_file")
+        process = Process.new do |breakpoints|
+          FileUtils.touch(first_file)
+          breakpoints << :after_first_file
+          FileUtils.touch(second_file)
+        end
+        File.exists?(first_file).should be_false
+        File.exists?(second_file).should be_false
+        
+        process.run_until(:after_first_file).wait
+        File.exists?(first_file).should be_true
+        File.exists?(second_file).should be_false
+
+        process.finish.wait
+        File.exists?(first_file).should be_true
+        File.exists?(second_file).should be_true
+      end
+    end
+  
+    it "raises an error (on wait) if a breakpoint is not encountered" do
+      foo = Process.new do |breakpoints|
+        if false
+          breakpoints << :will_not_run
+        end
+      end
+      expect do
+        foo.run_until(:will_not_run).wait
+      end.to raise_error(BreakpointNotReachedError)
+    end
+
+    it "works for the documentation example" do
+      class FileCounter
+        include ForkBreak::Breakpoints
+
+        def self.open(path, use_lock = true)
+          file = File.open(path, File::RDWR|File::CREAT, 0600)
+          return new(file, use_lock)
+        end
+
+        def initialize(file, use_lock = true)
+          @file = file
+          @use_lock = use_lock
+        end
+
+        def increase
+          breakpoints << :before_lock
+          @file.flock(File::LOCK_EX) if @use_lock
+          value = @file.read.to_i + 1
+          breakpoints << :after_read
+          @file.rewind
+          @file.write("#{value}\n")
+          @file.flush
+          @file.truncate(@file.pos)
+        end
+      end
+
+      def counter_after_synced_execution(counter_path, with_lock)
+        process1, process2 = 2.times.map do
+          ForkBreak::Process.new do
+            FileCounter.open(counter_path, with_lock).increase
+          end
+        end
+
+        process1.run_until(:after_read).wait
+
+        # process2 can't wait for read since it will block
+        process2.run_until(:before_lock).wait
+        process2.run_until(:after_read) && sleep(0.1)
+
+        process1.finish.wait # Finish process1
+        process2.finish.wait # Finish process2
+
+        File.read(counter_path).to_i
+      end
+
+      Dir.mktmpdir do |tmpdir|
+        counter_path = File.join(tmpdir, "counter")
+
+        counter_after_synced_execution(counter_path, with_lock = true).should == 2
+
+        File.unlink(counter_path)
+        counter_after_synced_execution(counter_path, with_lock = false).should == 1
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'fork_break' # and any other gems you need
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: fork_break
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Petter Remen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fork
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Testing multiprocess behaviour is difficult and requires a way to
+  synchronize processes at
+
+  specific execution points. This gem allows the parent process to control the behaviour
+  of child processes using
+
+  breakpoints. It was originally built for testing the behaviour of database transactions
+  and locking mechanisms. '
+email:
+- petter.remen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fork_break.gemspec
+- lib/fork_break.rb
+- spec/fork_break_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/remen/fork_break
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Fork with breakpoints for syncing child process execution
+test_files:
+- spec/fork_break_spec.rb
+- spec/spec_helper.rb