rbkit 0.0.1 → 0.1.6

data/spec/object_space_dump_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+require 'support/have_message_matcher'
+require 'msgpack'
+
+describe "Objectspace dump" do
+  let(:payload) { Rbkit::MESSAGE_FIELDS[:payload] }
+  let(:event_type) { Rbkit::MESSAGE_FIELDS[:event_type] }
+  let(:object_id) { Rbkit::MESSAGE_FIELDS[:object_id] }
+  let(:class_name) { Rbkit::MESSAGE_FIELDS[:class_name] }
+  let(:file) { Rbkit::MESSAGE_FIELDS[:file] }
+  let(:line) { Rbkit::MESSAGE_FIELDS[:line] }
+  let(:size) { Rbkit::MESSAGE_FIELDS[:size] }
+  let(:references) { Rbkit::MESSAGE_FIELDS[:references] }
+  let(:message) do
+    message = @message_list[payload]
+      .find{|x| x[event_type] == Rbkit::EVENT_TYPES[:object_space_dump]}
+  end
+  let(:foo_info) do
+    message[payload].select{|x| x[class_name] == 'Foo'}
+  end
+  let(:bar_info) do
+    message[payload].select{|x| x[class_name] == 'Bar'}
+  end
+  let(:short_lived_bar_info) do
+    message[payload].select{|x| x[class_name] == 'ShortLivedBar'}
+  end
+  let(:array_info) do
+    message[payload]
+      .select{|obj| obj[object_id] == foo_info.first[references].last }
+  end
+  before(:all) do
+    Rbkit.start_profiling(enable_gc_stats: false, enable_object_trace: true)
+    @foo_obj_line = __LINE__ + 1
+    @foo_obj = Foo.new
+    Rbkit.send_objectspace_dump
+    packed_message = Rbkit.get_queued_messages
+    Rbkit.stop_server
+    @message_list  = MessagePack.unpack packed_message
+  end
+  it "should be part of message list" do
+    expect(@message_list)
+      .to have_message(Rbkit::EVENT_TYPES[:object_space_dump])
+      .with_count(1)
+  end
+
+  it 'should record objects only once' do
+    expect(foo_info.size).to eql 1
+    expect(bar_info.size).to eql 1
+    expect(short_lived_bar_info.size).to eql 1
+  end
+
+  it 'should record correct file info' do
+    expect(foo_info.first[file]).to eql __FILE__
+    expect(bar_info.first[file]).to eql foo_bar_source_file
+  end
+
+  it 'should record correct line info' do
+    expect(foo_info.first[line]).to eql @foo_obj_line
+    expect(bar_info.first[line]).to eql bar_obj_line
+    expect(array_info.first[line]).to eql array_line
+  end
+
+  it 'should record correct references' do
+    expect(foo_info.first[object_id]).to eql @foo_obj.object_id
+    expect(bar_info.first[object_id]).to eql @foo_obj.bar.object_id
+    expect(array_info.first[object_id]).to eql @foo_obj.array.object_id
+  end
+
+  it 'should record correct references' do
+    expect(foo_info.first[references]).to include(bar_info.first[object_id])
+    expect(foo_info.first[references]).to include(array_info.first[object_id])
+  end
+
+  it 'should record correct size' do
+    expect(array_info.first[size]).to be > 0
+  end
+end

data/spec/rbkit_helpful_messages_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe 'Messages printed by Rbkit on errors' do
+  let(:error_message) {
+    "Rbkit server couldn't bind to socket, check if it is already" \
+      " running. Profiling data will not be available."
+  }
+
+  context 'when Rbkit.start_server is run twice' do
+    it 'should print helpful message and return false the second time' do
+      expect($stderr).to receive(:puts).with(error_message).once
+      expect(Rbkit.start_server).to be_truthy
+      expect(Rbkit.start_server).to be_falsey
+      Rbkit.stop_server
+    end
+  end
+  context 'when Rbkit.start_profiling is run twice' do
+    it 'should print helpful message and return false the second time' do
+      expect($stderr).to receive(:puts).with(error_message).once
+      expect(Rbkit.start_profiling).to be_truthy
+      expect(Rbkit.start_profiling).to be_falsey
+      Rbkit.stop_server
+    end
+  end
+  context 'when Rbkit.stop_server is run without starting the server' do
+    it 'should print helpful message and return false' do
+      expect($stderr).to receive(:puts).with("Cannot stop Rbkit server. Is it running?").once
+      expect(Rbkit.stop_server).to be_falsey
+    end
+  end
+  context 'when Rbkit.stop_server is run twice' do
+    it 'should print helpful message and return false the second time' do
+      expect($stderr).to receive(:puts).with("Cannot stop Rbkit server. Is it running?").once
+      expect(Rbkit.start_server).to be_truthy
+      expect(Rbkit.stop_server).to be_truthy
+      expect(Rbkit.stop_server).to be_falsey
+    end
+  end
+  context 'during normal operation' do
+    it 'should not print anything' do
+      expect($stderr).not_to receive(:puts)
+      expect(Rbkit.start_server).to be_truthy
+      expect(Rbkit.stop_server).to be_truthy
+      expect(Rbkit.start_server).to be_truthy
+      expect(Rbkit.stop_server).to be_truthy
+    end
+  end
+  context 'after a series of failed attempts' do
+    it 'should be able to resume normal operation' do
+      allow($stderr).to receive(:puts)
+      expect(Rbkit.stop_server).to be_falsey
+      expect(Rbkit.start_server).to be_truthy
+      expect(Rbkit.start_server).to be_falsey
+      expect(Rbkit.stop_server).to be_truthy
+      expect(Rbkit.stop_server).to be_falsey
+
+      expect(Rbkit.start_server).to be_truthy
+      expect(Rbkit.stop_server).to be_truthy
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,12 +1,17 @@
-require "pry"
-require "simplecov"
-SimpleCov.start do
-  add_filter "/spec/"
-end
-
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'rbkit'
+require 'support/foo_bar_sample_class'
+Rbkit.enable_test_mode
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
+
+  config.before(:all) { GC.start }
   # 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.

data/spec/start_server_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe 'Rbkit.start_server' do
+  before(:all) do
+    Rbkit.start_server
+    @foo_obj = Foo.new
+    @messages = Rbkit.get_queued_messages
+    Rbkit.stop_server
+  end
+  it 'should not send any messages' do
+    expect(@messages).to be_nil
+  end
+  context 'when pub port is out of range' do
+    it 'should raise ArgumentError' do
+      expect{ Rbkit.start_server(pub_port: 1023) }
+        .to raise_error(ArgumentError, 'Invalid port value')
+      expect{ Rbkit.start_server(pub_port: 65001) }
+        .to raise_error(ArgumentError, 'Invalid port value')
+    end
+  end
+  context 'when request port is out of range' do
+    it 'should raise ArgumentError' do
+      expect{ Rbkit.start_server(request_port: 1023) }
+        .to raise_error(ArgumentError, 'Invalid port value')
+      expect{ Rbkit.start_server(request_port: 65001) }
+        .to raise_error(ArgumentError, 'Invalid port value')
+    end
+  end
+end

data/spec/status_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'msgpack'
+
+describe 'status' do
+  describe 'object_space_enabled field' do
+    context "when object trace is disabled" do
+      before do
+        Rbkit.start_profiling(enable_object_trace: false)
+        @status = Rbkit.status
+        Rbkit.stop_server
+      end
+      it 'should set object_trace_enabled to 0' do
+        expect(@status[:object_trace_enabled]).to eql 0
+      end
+    end
+    context "when object trace is enabled" do
+      before do
+        Rbkit.start_profiling(enable_object_trace: true)
+        @status = Rbkit.status
+        Rbkit.stop_server
+      end
+      it 'should set object_trace_enabled to 0' do
+        expect(@status[:object_trace_enabled]).to eql 1
+      end
+    end
+  end
+
+  describe 'pwd field' do
+    let(:field) { Rbkit.status[:pwd] }
+    it 'should be equal to PWD' do
+      expect(field).to eql Dir.pwd
+    end
+  end
+
+  describe "process_name field" do
+    let(:process_name) { Rbkit.status[:process_name] }
+    it "should have process name" do
+      expect(process_name).to eql Process.argv0
+    end
+  end
+
+  describe 'pid field' do
+    let(:field) { Rbkit.status[:pid] }
+    it 'should be equal to Process PID' do
+      expect(field).to eql Process.pid
+    end
+  end
+end

data/spec/support/foo_bar_sample_class.rb

@@ -0,0 +1,24 @@
+class Bar;end
+class ShortLivedBar;end
+class Foo
+  attr_reader :array, :bar
+  def initialize
+    @bar = Bar.new
+    ShortLivedBar.new #not reference outside this scope
+    @array = [1, 2, 3, 4, 5, 6, 7]
+  end
+end
+
+def foo_bar_source_file
+  __FILE__
+end
+
+def bar_obj_line
+  # Warning! Hardcoded line number below ¯\_(ツ)_/¯
+  6
+end
+
+def array_line
+  # Warning! Hardcoded line number below ¯\_(ツ)_/¯
+  8
+end

data/spec/support/have_message_matcher.rb

@@ -0,0 +1,26 @@
+RSpec::Matchers.define :have_message do |event_type|
+  match do |unpacked_message_list|
+    messages = unpacked_message_list[Rbkit::MESSAGE_FIELDS[:payload]].select do |event|
+      event[Rbkit::MESSAGE_FIELDS[:event_type]] == event_type
+    end
+
+    if @count
+      @size = messages.size
+      messages.size == @count
+    else
+      !messages.empty?
+    end
+  end
+
+  failure_message do |unpacked_message_list|
+    if @count
+      "Expected message to contain #{@count} #{event_type} event(s) but contains #{@size}."
+    else
+      "Expected message to contain atleast one #{event_type} event."
+    end
+  end
+
+  chain :with_count do |count|
+    @count = count
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbkit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Hemant Kumar
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-21 00:00:00.000000000 Z
+date: 2015-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -63,9 +63,14 @@ extra_rdoc_files: []
 files:
 - ".bundle/config"
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
+- docs/EVENT_FORMAT.md
 - docs/debugging.md
 - docs/design.md
 - experiments/benchmark.rb
@@ -80,18 +85,38 @@ files:
 - experiments/zmq_client.rb
 - experiments/zmq_server.rb
 - ext/extconf.rb
+- ext/rbkit_allocation_info.c
+- ext/rbkit_allocation_info.h
+- ext/rbkit_event.c
+- ext/rbkit_event.h
+- ext/rbkit_event_packer.c
+- ext/rbkit_event_packer.h
 - ext/rbkit_message_aggregator.c
 - ext/rbkit_message_aggregator.h
 - ext/rbkit_object_graph.c
 - ext/rbkit_object_graph.h
+- ext/rbkit_test_helper.c
+- ext/rbkit_test_helper.h
 - ext/rbkit_tracer.c
 - ext/rbkit_tracer.h
 - lib/rbkit.rb
+- lib/rbkit/rbkit_gc.rb
 - lib/rbkit/timer.rb
 - lib/rbkit/version.rb
+- logo.png
 - rbkit.gemspec
-- schema/tracing_info.md
+- setup.rb
+- spec/gc_stat_spec.rb
+- spec/hash_event_spec.rb
+- spec/obj_created_spec.rb
+- spec/obj_destroyed_spec.rb
+- spec/object_space_dump_spec.rb
+- spec/rbkit_helpful_messages_spec.rb
 - spec/spec_helper.rb
+- spec/start_server_spec.rb
+- spec/status_spec.rb
+- spec/support/foo_bar_sample_class.rb
+- spec/support/have_message_matcher.rb
 homepage: http://rbkit.codemancers.com
 licenses:
 - MIT
@@ -104,7 +129,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -117,4 +142,15 @@ signing_key:
 specification_version: 4
 summary: Ruby profiler for rest of us
 test_files:
+- spec/gc_stat_spec.rb
+- spec/hash_event_spec.rb
+- spec/obj_created_spec.rb
+- spec/obj_destroyed_spec.rb
+- spec/object_space_dump_spec.rb
+- spec/rbkit_helpful_messages_spec.rb
 - spec/spec_helper.rb
+- spec/start_server_spec.rb
+- spec/status_spec.rb
+- spec/support/foo_bar_sample_class.rb
+- spec/support/have_message_matcher.rb
+has_rdoc: 

data/schema/tracing_info.md

@@ -1,8 +0,0 @@
-## How we send tracing information ##
-
-1. For now Tracing information is sent via simple strings like:
-
-        obj_created <klass_name> <object_id_in_hex>
-        obj_destroyed <klass_name> <object_id_in_hex>
-        gc_start
-        gc_end_s