fuzzbert 1.0.1 → 1.0.2

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Martin Boßlet
+Copyright (c) 2012-2013 Martin Boßlet
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,4 +1,4 @@
-# FuzzBert [![Build Status](https://secure.travis-ci.org/krypt/FuzzBert.png?branch=master)](http://travis-ci.org/krypt/FuzzBert)
+# FuzzBert [![Build Status](https://secure.travis-ci.org/krypt/FuzzBert.png?branch=master)](http://travis-ci.org/krypt/FuzzBert) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/krypt/FuzzBert)
 
 A random testing/fuzzer framework for Ruby.
 
@@ -162,7 +162,7 @@ fuzz "Define here as usual" do
 end
 ```
 
-Then tell fuzzbert by telling it about the custom handler:
+Now you just need to tell FuzzBert to use your custom handler:
 
     fuzzbert --handler MyHandler my/fuzzbert/file
 
@@ -189,8 +189,8 @@ fuzz "My Web App" do
 
   data "JSON generated from a template" do
     t = FuzzBert::Template.new '{ user: { id: ${id}, name: "${name}" } }'
-    t.set(:id) { FuzzBert::Generators.cycle(1..10000) }
-    t.set(:name) { FuzzBert::Generators.random }
+    t.set(:id, FuzzBert::Generators.cycle(1..10000))
+    t.set(:name) { "fixed" + FuzzBert::Generators.random_fixlen(2).call }
     t.generator
   end
 
@@ -198,8 +198,12 @@ end
 ```
 
 Simply specify your template variables using `${..}` and assign a callback for
-them via `set`. Of course you may escape the dollar sign with a back slash as
-usual.
+them via `set`. Of course you may escape the dollar sign with a backslash as
+usual. The Template#set method takes as its first argument the symbol
+representing the template variable. To specify the data to be generated, it
+either takes a second argument in form of a proc or lambda (to use the
+built-in generators for example, as in `:id` in the example) or it takes a
+block that allows to define the data ad-hoc (as in `:name`). 
 
 ## Mutators
 
@@ -252,6 +256,6 @@ connected to Ruby at all - have a look in the examples that ship with FuzzBert.
  
 ## License
 
-Copyright (c) 2012 Martin Boßlet. Distributed under the MIT License. See LICENSE for 
+Copyright (c) 2012-2013 Martin Boßlet. Distributed under the MIT License. See LICENSE for 
 further details.
 

data/lib/fuzzbert.rb

@@ -4,13 +4,28 @@
 
 FuzzBert - Random Testing / Fuzzing in Ruby
 
-Copyright (C) 2012
-Martin Bosslet <martin.bosslet@googlemail.com>
+Copyright (C) 2012-2013
+Martin Bosslet <martin.bosslet@gmail.com>
 All rights reserved.
 
-= License
-
-See the file 'LICENSE' for further details.
+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.
 
 =end
 

data/lib/fuzzbert/autorun.rb

@@ -11,7 +11,11 @@ module FuzzBert::AutoRun
   end
 
   def autorun
-    options, files = process_args(ARGV)
+    autorun_with_args(ARGV)
+  end
+
+  def autorun_with_args(argv)
+    options, files = process_args(argv)
     load_files(files)
     run(options)
   end
@@ -34,8 +38,26 @@ module FuzzBert::AutoRun
       orig_args = args.dup
 
       OptionParser.new do |opts|
-        opts.banner  = 'Usage: fuzzbert [OPTIONS] PATTERN [PATTERNS]'
-        opts.separator <<-EOS
+        add_banner(opts)
+
+        add_help(opts)
+        add_pool_size(opts, options)
+        add_limit(opts, options)
+        add_console(opts, options)
+        add_sleep_delay(opts, options)
+        add_handler(opts, options)
+        add_bug_dir(opts, options)
+
+        opts.parse! args
+      end
+
+      raise ArgumentError.new("No file pattern was given") if args.empty?
+      [options, args]
+    end
+
+    def add_banner(opts)
+      opts.banner  = 'Usage: fuzzbert [OPTIONS] PATTERN [PATTERNS]'
+      opts.separator <<-EOS
 
 Run your random tests by pointing fuzzbert to a single or many explicit files
 or by providing a pattern. The default pattern is 'fuzz/**/fuzz_*.rb, assuming
@@ -45,53 +67,65 @@ named fuzz located under the current directory that you are in.
 By default, fuzzbert will run the tests you specify forever, be sure to hit
 CTRL+C when you are done or specify a limit with '--limit'.
 
-        EOS
-
-        opts.version = FuzzBert::VERSION
+      EOS
 
-        opts.on '-h', '--help', 'Run ' do
-          puts opts
-          exit
-        end
-
-        opts.on '--pool-size SIZE', Integer, "Sets the number of concurrently running processes to SIZE. Default is 4." do |n|
-          options[:pool_size] = n.to_i
-        end
-
-        opts.on '--limit LIMIT', Integer, "Instead of running permanently, fuzzing will be stopped after running LIMIT of instances." do |n|
-          options[:limit] = n.to_i
-        end
+      opts.version = FuzzBert::VERSION
+    end
 
-        opts.on '--console', "Output the failing cases including data on the console instead of saving them in a file." do
-          options[:handler] = FuzzBert::Handler::Console.new
-        end
+    def add_help(opts)
+      opts.on '-h', '--help', 'Run ' do
+        puts opts
+        exit
+      end
+    end
 
-        opts.on '--sleep-delay SECONDS', Float, "Specify the number of SECONDS that the main process sleeps before checking that the limit has been reached. Default is 1." do |f|
-          options[:sleep_delay] = f.to_f
-        end
+    def add_pool_size(opts, options)
+      opts.on '--pool-size SIZE', Integer, "Sets the number of concurrently running processes to SIZE. Default is 4." do |n|
+        options[:pool_size] = n.to_i
+      end
+    end
 
-        opts.on '--handler CLASS', String, "Specify the full path to a CLASS that will serve as your Handler." do |path|
-          #lazy initialization: the Handler must be defined in one of the fuzzer files
-          options[:handler] = Class.new do
-            @@path = path
+    def add_limit(opts, options)
+      opts.on '--limit LIMIT', Integer, "Instead of running permanently, fuzzing will be stopped after running LIMIT of instances." do |n|
+        options[:limit] = n.to_i
+      end
+    end
 
-            def handle(id, data, pid, status)
-              @inner ||= Object.const_get(@@path).new
-              @inner.handle(id, data, pid, status)
-            end
-          end.new
-        end
+    def add_console(opts, options)
+      opts.on '--console', "Output the failing cases including data on the console instead of saving them in a file." do
+        options[:handler] = FuzzBert::Handler::Console.new
+      end
+    end
 
-        opts.on '--bug-dir DIRECTORY', String, "The DIRECTORY where the resulting bug files will be stored. Default is the current directory." do |dir|
-          raise ArgumentError.new "#{dir} is not a directory" unless Dir.exists?(dir)
-          options[:handler] = FuzzBert::Handler::FileOutput.new(dir)
-        end
+    def add_sleep_delay(opts, options)
+      opts.on '--sleep-delay SECONDS', Float, "Specify the number of SECONDS that the main process sleeps before checking that the limit has been reached. Default is 1." do |f|
+        options[:sleep_delay] = f.to_f
+      end
+    end
 
-        opts.parse! args
+    def add_handler(opts, options)
+      opts.on '--handler CLASS', String, "Specify the full path to a CLASS that will serve as your Handler." do |path|
+        #lazy initialization: the Handler must be defined in one of the fuzzer files
+        options[:handler] = Class.new do
+          @@path = path
+
+          def handle(error_data)
+            @inner ||= class_for_name(@@path).new
+            @inner.handle(error_data)
+          end
+
+          def class_for_name(path)
+            path.split('::').inject(Object) { |mod, class_name| mod.const_get(class_name) }
+          end
+        end.new
       end
+    end
 
-      raise ArgumentError.new("No file pattern was given") if args.empty?
-      [options, args]
+    def add_bug_dir(opts, options)
+      opts.on '--bug-dir DIRECTORY', String, "The DIRECTORY where the resulting bug files will be stored. Default is the current directory." do |dir|
+        raise ArgumentError.new "#{dir} is not a directory" unless Dir.exists?(dir)
+        options[:handler] = FuzzBert::Handler::FileOutput.new(dir)
+      end
     end
 
 end

data/lib/fuzzbert/error_handler.rb

@@ -56,6 +56,10 @@ module FuzzBert::Handler
   class Console
     include FuzzBert::Handler::ConsoleHelper
 
+    def initialize
+      $stdout.sync = true
+    end
+
     def handle(error_data)
       puts "#{error_data[:id]} failed. Data: #{error_data[:data].inspect}"
       info(error_data)

data/lib/fuzzbert/executor.rb

@@ -54,31 +54,48 @@ class FuzzBert::Executor
 
     def trap_child_exit
       trap(:CHLD) do 
-        begin
-          while exitval = Process.wait2(-1, Process::WNOHANG)
-            pid = exitval[0]
-            status = exitval[1]
-            data_ary = @data_cache.delete(pid)
-            unless status.success?
-              handle({ 
-                id: data_ary[0], 
-                data: data_ary[1], 
-                pid: pid, 
-                status: status
-              }) unless interrupted(status)
-            end
-            @n += 1
-            if @limit == -1 || @n < @limit
-              run_instance(*@producer.next) 
-            else
-              @running = false
-            end
-          end
-        rescue Errno::ECHILD
+        while_child_exits do |exitval|
+          pid = exitval[0]
+          status = exitval[1]
+          data_ary = @data_cache.delete(pid)
+
+          handle({ 
+            id: data_ary[0], 
+            data: data_ary[1], 
+            pid: pid, 
+            status: status
+          }) if status_failed?(status)
+
+          start_new_child
         end
       end
     end
 
+    def while_child_exits
+      while exitval = Process.wait2(-1, Process::WNOHANG)
+        yield exitval
+      end
+    rescue Errno::ECHILD
+      # fine
+    end
+
+    def status_failed?(status)
+      !status.success? && !interrupted(status)
+    end
+
+    def start_new_child
+      @n += 1
+      if limit_reached?
+        run_instance(*@producer.next) 
+      else
+        @running = false
+      end
+    end
+
+    def limit_reached?
+      @limit == -1 || @n < @limit
+    end
+
     def trap_interrupt
       trap(:INT) do
         exit! (1) if @exiting

data/lib/fuzzbert/rake_task.rb

@@ -65,13 +65,8 @@ class FuzzBert::RakeTask < ::Rake::TaskLib
   private
 
     def command
-      cmd_parts = []
-      cmd_parts << RUBY
-      cmd_parts << ruby_opts
-      cmd_parts << "-S" << fuzzbert_path
-      cmd_parts << fuzzbert_opts
-      cmd_parts << pattern
-      cmd_parts.flatten.reject(&blank).join(" ")
+      cmd = [RUBY, ruby_opts, '-S', fuzzbert_path, fuzzbert_opts, pattern]
+      cmd.flatten.reject(&blank).join(" ")
     end
 
     def blank

data/lib/fuzzbert/template.rb

@@ -8,13 +8,13 @@ class FuzzBert::Template
     @callbacks = {}
   end
 
-  def set(name, &blk)
-    @callbacks[name] = blk
+  def set(name, cb=nil, &blk)
+    @callbacks[name] = cb || blk
   end
 
   def to_data
     "".tap do |buf|
-      @template.each { |t| buf << t.to_data(@callbacks) }
+      @template.each { |t| buf << t.to_data(@callbacks).to_s }
     end
   end
 

data/spec/autorun_spec.rb

@@ -49,5 +49,60 @@ describe FuzzBert::AutoRun do
     end
   end
 
+  describe "command line" do
+
+    def relative_path(filename)
+      File.expand_path(filename, File.dirname(File.expand_path(__FILE__)))
+    end
+
+    let (:fuzz_nothing) { relative_path('fuzz/fuzz_nothing.rb') }
+    let (:single_test_args) { ['--pool-size', '1', '--limit', '1', '--sleep-delay', '0.05'] }
+
+    it "accepts pool-size, limit and sleep-delay" do 
+      args = single_test_args + [fuzz_nothing]
+      -> { FuzzBert::AutoRun.autorun_with_args(args) }.should_not raise_error
+    end
+
+    it "accepts console" do 
+      args = single_test_args + ['--console', fuzz_nothing]
+      -> { FuzzBert::AutoRun.autorun_with_args(args) }.should_not raise_error
+    end
+
+    it "accepts bug-dir" do
+      args = single_test_args + ['--bug-dir', '.', fuzz_nothing]
+      -> { FuzzBert::AutoRun.autorun_with_args(args) }.should_not raise_error
+    end
+
+    it "accepts a custom handler" do
+      args = single_test_args + ['--handler', 'FuzzBert::Spec::CustomHandler', relative_path('fuzz/fuzz_custom_handler.rb')]
+      -> { FuzzBert::AutoRun.autorun_with_args(args) }.should_not raise_error
+      FuzzBert::Spec::CustomHandler.called.should be_true
+    end
+
+    it "accepts multiple single files" do
+      args = [
+        '--pool-size', '1',
+        '--limit', '2',
+        '--sleep-delay', '0.05',
+        '--handler', 'FuzzBert::Spec::CustomHandler',
+        fuzz_nothing, relative_path('fuzz/fuzz_custom_handler.rb')
+      ]
+      -> { FuzzBert::AutoRun.autorun_with_args(args) }.should_not raise_error
+      FuzzBert::Spec::CustomHandler.called.should be_true
+    end
+
+    it "accepts a pattern" do
+      args = [
+        '--pool-size', '1',
+        '--limit', '2',
+        '--sleep-delay', '0.05',
+        '--handler', 'FuzzBert::Spec::CustomHandler',
+        relative_path('fuzz/**/fuzz_*.rb')
+      ]
+      -> { FuzzBert::AutoRun.autorun_with_args(args) }.should_not raise_error
+      FuzzBert::Spec::CustomHandler.called.should be_true
+    end
+  end
+
 end
 

data/spec/fuzz/fuzz_custom_handler.rb

@@ -0,0 +1,20 @@
+require 'fuzzbert'
+
+module FuzzBert::Spec
+  class CustomHandler
+    @@called = false
+    
+    def self.called
+      @@called
+    end
+
+    def handle(error_data)
+      @@called = true
+    end
+  end
+end
+
+fuzz "failing" do
+  deploy { |data| raise "boo!" }
+  data("some") { -> {"a"} }
+end

data/spec/fuzz/fuzz_nothing.rb

@@ -0,0 +1,6 @@
+require 'fuzzbert'
+
+fuzz "nothing" do
+  deploy { |data| }
+  data("some") { -> {"a"} }
+end

data/spec/template_spec.rb

@@ -16,6 +16,13 @@ describe FuzzBert::Template do
       t.to_data.should == "abc"
     end
 
+    it "takes an optional proc to define the callback" do
+      t = FuzzBert::Template.new "a${var}c"
+      cb = -> { "b" }
+      t.set(:var, cb)
+      t.to_data.should == "abc"
+    end
+
     it "takes only Symbols to reference the template variables" do
       t = FuzzBert::Template.new "a${var}c"
       t.set("var") { "b" }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fuzzbert
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-17 00:00:00.000000000 Z
+date: 2013-03-05 00:00:00.000000000 Z
 dependencies: []
 description: A random testing / fuzzer framework for Ruby.
 email: Martin.Bosslet@gmail.com
@@ -19,30 +19,32 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- lib/fuzzbert.rb
-- lib/fuzzbert/generators.rb
-- lib/fuzzbert/test_suite.rb
 - lib/fuzzbert/rake_task.rb
+- lib/fuzzbert/generation.rb
 - lib/fuzzbert/generator.rb
-- lib/fuzzbert/error_handler.rb
-- lib/fuzzbert/version.rb
+- lib/fuzzbert/test_suite.rb
 - lib/fuzzbert/autorun.rb
+- lib/fuzzbert/template.rb
+- lib/fuzzbert/generators.rb
 - lib/fuzzbert/test.rb
-- lib/fuzzbert/generation.rb
-- lib/fuzzbert/container.rb
+- lib/fuzzbert/version.rb
+- lib/fuzzbert/error_handler.rb
+- lib/fuzzbert/mutator.rb
 - lib/fuzzbert/executor.rb
-- lib/fuzzbert/template.rb
 - lib/fuzzbert/dsl.rb
-- lib/fuzzbert/mutator.rb
+- lib/fuzzbert/container.rb
+- lib/fuzzbert.rb
 - LICENSE
 - README.md
+- spec/template_spec.rb
+- spec/dsl_spec.rb
 - spec/generator_spec.rb
-- spec/test_spec.rb
-- spec/executor_spec.rb
 - spec/mutator_spec.rb
+- spec/executor_spec.rb
 - spec/autorun_spec.rb
-- spec/dsl_spec.rb
-- spec/template_spec.rb
+- spec/fuzz/fuzz_custom_handler.rb
+- spec/fuzz/fuzz_nothing.rb
+- spec/test_spec.rb
 - bin/fuzzbert
 homepage: https://github.com/krypt/FuzzBert
 licenses:
@@ -65,15 +67,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Fuzz your applications and libraries with minimal effort.
 test_files:
+- spec/template_spec.rb
+- spec/dsl_spec.rb
 - spec/generator_spec.rb
-- spec/test_spec.rb
-- spec/executor_spec.rb
 - spec/mutator_spec.rb
+- spec/executor_spec.rb
 - spec/autorun_spec.rb
-- spec/dsl_spec.rb
-- spec/template_spec.rb
+- spec/fuzz/fuzz_custom_handler.rb
+- spec/fuzz/fuzz_nothing.rb
+- spec/test_spec.rb