rgot 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bd2d7a31146606c28b7b373c1f05632088ba374
-  data.tar.gz: 14a9e7bf677e9eb24ea70d3710a48f6383d8b7ad
+  metadata.gz: b55640e6b13205e65a7e08765579b3566f43b385
+  data.tar.gz: 2b9727ef0256af4d11d272f2c4aa255ecf91053c
 SHA512:
-  metadata.gz: b912a04b6c18f16b8660d2eefb0a50a0444fd1fd60c7d68292d2fdab77f4bf6de63874f86d05346749bbf5c397a195b5247da17089a71c0558dd2b22ce9dde1b
-  data.tar.gz: cc789d6941cb34fc8b0fc1acb1c5844d3a157c69811b5c08e83c04126cdfd38e563fb8f7a1ebaee0c495aa72c1d4f2dc91b815e4ec695c18a84b07caa130ea39
+  metadata.gz: ce0a920a44014f5b876382e6091018a1b447d9acd96e460e9077640e07047907221cc4b9946f849b09efcc0cbf65b881b78e8d88b100cf197ac2ebf53eb865c7
+  data.tar.gz: 516c281575d0fa554698adb4cd2e69af664670dba015922c31c7f9dcf67f874715adbd190cf3482e2bd9a08d99a10a50d6e44dcd728cf875ca783516e6bbbfea

data/README.md

@@ -83,6 +83,12 @@ module FooTest
 end
 ```
 
+```
+$ rgot foo_test.rb --bench .
+benchmark_something	14400000	81.392 ns/op
+ok	FooTest	2.782s
+```
+
 `b.n` is automatically adjusted.
 
 ## Example
@@ -141,14 +147,17 @@ But all file should be have one module (like golang package name).
 
 ```ruby
 module XxxTest
+  # ...
 end
 ```
 
 ## Method name
 
-Method name should be set 'test_*' for testing.
+Method name should be set `test_*` for testing.
 
-And benchmark method should be set 'benchmark_*'.
+And benchmark method should be set `benchmark_*`.
+
+And example method should be set `example_*`.
 
 ```ruby
 module XxxTest
@@ -157,10 +166,13 @@ module XxxTest
 
   def benchmark_any_name(b)
   end
+
+  def example_any_name
+  end
 end
 ```
 
-# Command
+# Command line interface
 
 ```
 $ rgot -h
@@ -169,6 +181,8 @@ Usage: rgot [options]
         --bench [regexp]             benchmark
         --benchtime [sec]            benchmark running time
         --timeout [sec]              set timeout sec to testing
+        --cpu [count,...]            set cpu counts of comma splited
+        --thread [count,...]         set thread counts of comma splited
         --require [path]             load some code before running
         --load-path [path]           Specify $LOAD_PATH directory
 ```
@@ -217,6 +231,41 @@ Run testing with benchmark.
 
 Set `someone` if you only run benchmark to match `someone` method.(e.g. benchmark_someone_1)
 
+### Parallel benchmark
+
+Benchmark for parallel performance.
+
+`--cpu` option set process counts (default 1).
+
+And `--thread` option set thread counts (default 1).
+
+Benchmark fork, run and report each by process counts.
+
+(**process** and **thread** means ruby/linux process)
+
+```ruby
+module FooTest
+  def benchmark_any_func(b)
+    b.run_parallel do |pb|
+      # pb is instance of Rgot::PB
+      # call some time by b.n
+      while pb.next
+        some_func()
+      end
+    end
+  end
+end
+```
+
+```
+$ rgot foo_test.rb --bench . --cpu=2,4 --thread=2,4
+benchmark_any_func-2(2)	40	13363604.899 ns/op
+benchmark_any_func-2(4)	160	7125845.113 ns/op
+benchmark_any_func-4(2)	160	7224815.534 ns/op
+benchmark_any_func-4(4)	320	3652431.962 ns/op
+ok	FooTest	3.061s
+```
+
 ## Timeout
 
 ```
@@ -322,10 +371,10 @@ Automatic number calculated by running time.
 Recommend to this idiom.
 
 ```ruby
-def benchmark_someone(b)
+def benchmark_something(b)
   i = 0
   while i < b.n
-    someone()
+    something()
     i += 1
   end
 end
@@ -335,6 +384,18 @@ end
 
 Reset benchmark timer
 
+```ruby
+def benchmark_something(b)
+  obj = heavy_prepare_method()
+  b.reset_timer # you can ignore time of havy_prepare_method()
+  i = 0
+  while i < b.n
+    obj.something()
+    i += 1
+  end
+end
+```
+
 ## Rgot::B#start_timer
 
 Start benchmark timer
@@ -342,3 +403,31 @@ Start benchmark timer
 ## Rgot::B#stop_timer
 
 Stop benchmark timer
+
+## Rgot::B#run_parallel
+
+Start parallel benchmark using `fork` and `Thread.new`.
+
+This method should be call with block.
+
+The block argument is instance of Rgot::PB.
+
+# Rgot::PB (Parallel Benchmark)
+
+## Rgot::PB#next
+
+Should be call this when parallel benchmark.
+
+Repeat while return false.
+
+Recommend this idiom.
+
+```ruby
+def benchmark_foo(b)
+  b.run_parallel do |pb|
+    while pb.next
+      some_func()
+    end
+  end
+end
+```

data/bin/rgot

@@ -21,6 +21,12 @@ parser = OptionParser.new do |o|
   o.on '--timeout [sec]', "set timeout sec to testing" do |arg|
     opts[:timeout] = arg
   end
+  o.on '--cpu [count,...]', "set cpu counts of comma splited" do |arg|
+    opts[:cpu] = arg
+  end
+  o.on '--thread [count,...]', "set thread counts of comma splited" do |arg|
+    opts[:thread] = arg
+  end
   o.on '--require [path]', "load some code before running" do |arg|
     opts[:require_paths] << arg
   end
@@ -91,9 +97,19 @@ modules.each do |test_module|
     at_exit {
       template = "%s\t%s\t%.3fs"
 
-      if $!.kind_of?(SystemExit) && $!.success?
-        puts sprintf(template, "ok", test_module, Rgot.now - duration)
+      case $!
+      when SystemExit
+        if $!.success?
+          # exit 0
+          puts sprintf(template, "ok", test_module, Rgot.now - duration)
+        else
+          # exit 1
+          puts sprintf(template, "FAIL", test_module, Rgot.now - duration)
+        end
+      when NilClass
+        # not raise, not exit
       else
+        # any exception
         puts sprintf(template, "FAIL", test_module, Rgot.now - duration)
       end
     }

data/lib/rgot.rb

@@ -4,6 +4,8 @@ module Rgot
   require 'rgot/m'
   require 'rgot/t'
   require 'rgot/b'
+  require 'rgot/pb'
+  require 'rgot/benchmark_result'
   require 'rgot/example_parser'
 
   class OptionError < StandardError
@@ -31,5 +33,9 @@ module Rgot
         Time.now
       end
     end
+
+    def benchmark(opts={}, &block)
+      B.new(nil, nil, opts).run(&block)
+    end
   end
 end

data/lib/rgot/b.rb

@@ -1,16 +1,15 @@
 module Rgot
   class B < Common
     attr_accessor :n
-    def initialize(benchmark_module, name, opts)
+    def initialize(benchmark_module, name, opts={})
       super()
       @n = 1
       @module = benchmark_module
       @name = name
       @opts = opts
-      @benchtime = @opts.fetch(:benchtime, 1).to_f
       @timer_on = false
       @duration = 0
-      @module.extend @module
+      @module.extend @module if @module
     end
 
     def start_timer
@@ -34,43 +33,61 @@ module Rgot
       @duration = 0
     end
 
-    def run
+    def run(&block)
       n = 1
-      run_n(n)
-      while !failed? && @duration < @benchtime && @n < 1e9
-        if @duration < (@benchtime / 100.0)
-          n *= 100
-        elsif @duration < (@benchtime / 10.0)
-          n *= 10
-        elsif @duration < (@benchtime / 5.0)
-          n *= 5
-        elsif @duration < (@benchtime / 2.0)
-          n *= 2
+      benchtime = @opts.fetch(:benchtime, 1).to_f
+      run_n(n.to_i, block)
+      while !failed? && @duration < benchtime && @n < 1e9
+        if @duration < (benchtime / 100.0)
+          @n *= 100
+        elsif @duration < (benchtime / 10.0)
+          @n *= 10
+        elsif @duration < (benchtime / 5.0)
+          @n *= 5
+        elsif @duration < (benchtime / 2.0)
+          @n *= 2
         else
-          n *= 1.2
+          if @n.to_i == 1
+            break
+          end
+          @n *= 1.2
         end
-        run_n(n)
+        run_n(@n.to_i, block)
       end
+
+      BenchmarkResult.new(n: @n, t: @duration)
     end
 
-    def report
-      printf("%s\t%d\t%.3f ns/op\n", @name, @n, @duration / @n * 1_000_000_000)
+    def run_parallel
+      raise LocalJumpError, "no block given" unless block_given?
+
+      @opts[:procs].times do
+        fork {
+          Array.new(@opts[:threads]) {
+            Thread.new {
+              yield PB.new(bn: @n)
+            }.tap { |t| t.abort_on_exception = true }
+          }.each(&:join)
+        }
+      end
+      @n *= @opts[:procs] * @opts[:threads]
+      Process.waitall
     end
 
     private
 
-    def run_n(n)
+    def run_n(n, block=nil)
       GC.start
       i = 0
       @n = n
       reset_timer
       start_timer
-      call
+      if block
+        block.call(self)
+      else
+        @module.instance_method(@name).bind(@module).call(self)
+      end
       stop_timer
     end
-
-    def call
-      @module.instance_method(@name).bind(@module).call(self)
-    end
   end
 end

data/lib/rgot/benchmark_result.rb

@@ -0,0 +1,15 @@
+module Rgot
+  class BenchmarkResult
+    # Ruby-2.0.0 wants default value of keyword_argument
+    def initialize(n: nil, t: nil)
+      raise ArgumentError, "missing keyword: n" unless n
+      raise ArgumentError, "missing keyword: t" unless t
+      @n = n
+      @t = t
+    end
+
+    def to_s
+      sprintf("%d\t%.3f ns/op", @n, @t / @n * 1_000_000_000)
+    end
+  end
+end

data/lib/rgot/m.rb

@@ -3,11 +3,29 @@ require 'stringio'
 module Rgot
   class M
     # Ruby-2.0.0 wants default value of keyword_argument
-    def initialize(tests: [], benchmarks: [], examples: [], opts: {})
+    def initialize(tests: nil, benchmarks: nil, examples: nil, opts: {})
+      raise ArgumentError, "missing keyword: tests" unless tests
+      raise ArgumentError, "missing keyword: benchmarks" unless benchmarks
+      raise ArgumentError, "missing keyword: examples" unless examples
+
       @tests = tests
       @benchmarks = benchmarks
       @examples = examples
       @opts = opts
+      @cpu_list = @opts.fetch(:cpu, "1").split(',').map { |i|
+        j = i.to_i
+        if j == 0
+          raise OptionError, "expect integer string, got #{i.inspect}"
+        end
+        j
+      }
+      @thread_list = @opts.fetch(:thread, "1").split(',').map { |i|
+        j = i.to_i
+        if j == 0
+          raise OptionError, "expect integer string, got #{i.inspect}"
+        end
+        j
+      }
     end
 
     def run
@@ -51,11 +69,23 @@ module Rgot
       @benchmarks.each do |bench|
         next unless /#{@opts[:bench]}/ =~ bench.name
 
-        b = B.new(bench.module, bench.name.to_sym, @opts)
-        b.run
-        b.report
-        if b.failed?
-          ok = false
+        @cpu_list.each do |procs|
+          @thread_list.each do |threads|
+            opts = @opts.dup
+            opts[:procs] = procs
+            opts[:threads] = threads
+            b = B.new(bench.module, bench.name.to_sym, opts)
+
+            benchname = bench.name.to_s
+            benchname << "-#{procs}" if 1 < procs
+            benchname << "(#{threads})" if 1 < threads
+            print "#{benchname}\t"
+            result = b.run
+            puts result
+            if b.failed?
+              ok = false
+            end
+          end
         end
       end
       ok
@@ -88,6 +118,8 @@ module Rgot
     end
 
     def capture
+      raise LocalJumpError, "no block given" unless block_given?
+
       orig_out, orig_err = $stdout, $stderr
       out, err = StringIO.new, StringIO.new
       $stdout, $stderr = out, err

data/lib/rgot/pb.rb

@@ -0,0 +1,15 @@
+module Rgot
+  class PB
+    attr_accessor :bn
+
+    # Ruby-2.0.0 wants default value of keyword_argument
+    def initialize(bn: nil)
+      raise ArgumentError, "missing keyword: bn" unless bn
+      @bn = bn
+    end
+
+    def next
+      (0 < @bn).tap { @bn -= 1 }
+    end
+  end
+end

data/lib/rgot/version.rb

@@ -1,3 +1,3 @@
 module Rgot
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rgot
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - ksss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-15 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,9 +55,11 @@ files:
 - bin/rgot
 - lib/rgot.rb
 - lib/rgot/b.rb
+- lib/rgot/benchmark_result.rb
 - lib/rgot/common.rb
 - lib/rgot/example_parser.rb
 - lib/rgot/m.rb
+- lib/rgot/pb.rb
 - lib/rgot/t.rb
 - lib/rgot/version.rb
 - rgot.gemspec
@@ -81,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby + Golang Testing = Rgot