jaribio_formatter 0.1.0

data/spec/lib/jaribio/rspec_formatter_spec.rb

@@ -0,0 +1,179 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+require 'base64'
+require 'digest/md5'
+require 'stringio'
+
+describe "Jaribio::RSpecFormatter" do
+  let(:output) { StringIO.new }
+  let(:example_group) { RSpec::Core::ExampleGroup.describe("object") }
+
+  describe "#get_example_key" do
+    def verify_key_and_description(example, expected_key, expected_description)
+      key, desc = formatter.send(:get_example_key, example)
+      key.should == expected_key
+      desc.should == expected_description
+    end
+
+    let(:formatter) do 
+      formatter = Jaribio::RSpecFormatter.new(output)
+      g = example_group
+      formatter.instance_eval { 
+        @example_group = g
+      }
+      formatter
+    end
+
+    it "uses example group full description as key when jaribio_key not defined" do
+      group = example_group.describe("method")
+      example = group.example("example 1")
+      formatter.instance_eval {
+        @example_group = group
+      }
+      verify_key_and_description(example, Base64.strict_encode64(Digest::MD5.digest('object method')), 'object method')
+    end
+
+    it "gets jaribio_key from example" do
+      example = example_group.example("example 1", :jaribio_key => 'abc123')
+      verify_key_and_description(example, 'abc123', 'object example 1')
+    end
+
+    it "gets jaribio_key from example group" do
+      group = RSpec::Core::ExampleGroup.describe("object", 
+                                                 :jaribio_key => 'abc123')
+      formatter.instance_eval { 
+        @example_group = group
+      }
+      example = group.example("example 1")
+      verify_key_and_description(example, 'abc123', 'object')
+    end
+
+    it "gets jaribio_key from parent group" do
+      group = example_group.describe("method", :jaribio_key => 'group123')
+      group2 = group.describe("context")
+      example = group2.example("example 1")
+      formatter.instance_eval { 
+        @example_group = group2
+      }
+      verify_key_and_description(example, 'group123', 'object method')
+    end
+
+    it "gets jaribio_key from example when example group has different key" do
+      group = example_group.describe("method", :jaribio_key => 'group123')
+      example = group.example("example 1", :jaribio_key => 'abc123')
+      formatter.instance_eval {
+        @example_group = group
+      }
+      verify_key_and_description(example, 'abc123', 'object method example 1')
+    end
+  end
+
+  describe "#results" do
+    let(:formatter) { Jaribio::RSpecFormatter.new(output) }
+
+    before do
+      example_group.example("example 1") { fail } 
+      example_group.example("example 2", :jaribio_key => 'e2') { fail } 
+      g1 = example_group.describe("subgroup", :jaribio_key => 'g1')
+      g1.example("example 1") { fail } 
+      g1.example("example 2", :jaribio_key => 'g1e2') { fail } 
+      g2 = example_group.describe("subgroup2")
+      g2.example("example 1") { 1.should eq(1) }
+      g2.example("example 2") { fail }
+      g2.example("example 3") { 1.should eq(1) }
+      example_group.run(formatter)
+    end
+
+    it "is a hash with all keys found while testing" do
+      formatter.results.keys.sort.should eql [
+        'e2', 'g1', 'g1e2', 
+        Base64.strict_encode64(Digest::MD5.digest('object')), 
+        Base64.strict_encode64(Digest::MD5.digest('object subgroup2'))].sort
+    end
+
+    it "results are a hash of key to Jaribio::Record values" do
+      formatter.results.should eql({
+        'e2' => Jaribio::Record.new(:key => 'e2', :description => 'object example 2', :state => Jaribio::Record::FAIL), 
+        'g1' => Jaribio::Record.new(:key => 'g1', :description => 'object subgroup', :state => Jaribio::Record::FAIL), 
+        'g1e2' => Jaribio::Record.new(:key => 'g1e2', :description => 'object subgroup example 2', :state => Jaribio::Record::FAIL), 
+        Base64.strict_encode64(Digest::MD5.digest('object')) => Jaribio::Record.new(:key => Base64.strict_encode64(Digest::MD5.digest('object')), :description => 'object', :state => Jaribio::Record::FAIL), 
+        Base64.strict_encode64(Digest::MD5.digest('object subgroup2')) => Jaribio::Record.new(:key => Base64.strict_encode64(Digest::MD5.digest('object subgroup2')), :description => 'object subgroup2', :state => Jaribio::Record::FAIL),
+      })
+    end
+  end
+
+  describe "#close" do
+    let(:formatter) { Jaribio::RSpecFormatter.new(output) }
+
+    before do
+      RSpec.configuration.should_receive(:jaribio_url).at_least(:once).and_return('http://localhost/jaribio')
+      RSpec.configuration.should_receive(:jaribio_api_key).at_least(:once).and_return('api_key')
+      RSpec.configuration.should_receive(:jaribio_timeout).at_least(:once).and_return(10)
+    end
+
+    it "creates missing test cases" do
+      Jaribio::Record.any_instance.stub(:save)
+      RSpec.configuration.should_receive(:jaribio_auto_create).and_return(true)
+      RSpec.configuration.should_receive(:jaribio_plans).and_return([])
+
+      Jaribio::TestCase.should_receive(:find).and_return(nil)
+      test_case = double("Jaribio::TestCase")
+      Jaribio::TestCase.should_receive(:new).and_return(test_case)
+      test_case.should_receive(:save)
+
+      example = example_group.example("example 1", :jaribio_key => 'abc123') { fail } 
+      example_group.run(formatter)
+      formatter.close()
+    end
+
+    it "finds configured plans" do
+      Jaribio::Record.any_instance.stub(:save)
+      RSpec.configuration.should_receive(:jaribio_auto_create).and_return(false)
+      RSpec.configuration.should_receive(:jaribio_plans).twice.and_return([1])
+
+      plan = double("Jaribio::Plan")
+      plan.should_receive(:open?).and_return(true)
+      Jaribio::Plan.should_receive(:find).with(1).once.and_return(plan)
+
+      example = example_group.example("example 1", :jaribio_key => 'abc123') { fail } 
+      example_group.run(formatter)
+      formatter.close()
+    end
+
+    it "has output indicating when a specified key does not exist in Jaribio" do
+      RSpec.configuration.should_receive(:jaribio_auto_create).and_return(false)
+      RSpec.configuration.should_receive(:jaribio_plans).and_return([])
+
+
+      example = example_group.example("example 1", :jaribio_key => 'abc123') { fail }
+      example_group.run(formatter)
+      formatter.close()
+      output.string.should =~ /Test case abc123 not found/
+    end
+
+  end
+
+  describe "can configure" do
+    before do
+      RSpec.configure do |c|
+        c.jaribio_auto_create = true
+      end
+    end
+    
+    it "jaribio url" do 
+      RSpec.configuration.should respond_to :jaribio_url
+    end
+
+    it "jaribio api key" do
+      RSpec.configuration.should respond_to :jaribio_api_key
+    end
+
+    it "test case creation" do
+      RSpec.configuration.jaribio_auto_create.should be_true
+    end
+
+    it "specific plans" do
+      RSpec.configuration.should respond_to :jaribio_plans
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,61 @@
+begin
+  require 'simplecov'
+  SimpleCov.start
+rescue LoadError
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'jaribio_formatter'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+# Copied from rspec-core
+def sandboxed(&block)
+    @orig_config = RSpec.configuration
+    @orig_world  = RSpec.world
+    new_config = RSpec::Core::Configuration.new
+    new_world  = RSpec::Core::World.new(new_config)
+    RSpec.instance_variable_set(:@configuration, new_config)
+    RSpec.instance_variable_set(:@world, new_world)
+    # reconfigure for jaribio
+    Jaribio::RSpecFormatter.configure()
+    object = Object.new
+    object.extend(RSpec::Core::SharedExampleGroup)
+
+    (class << RSpec::Core::ExampleGroup; self; end).class_eval do
+      alias_method :orig_run, :run
+      def run(reporter=nil)
+        @orig_mock_space = RSpec::Mocks::space
+        RSpec::Mocks::space = RSpec::Mocks::Space.new
+        orig_run(reporter || NullObject.new)
+      ensure
+        RSpec::Mocks::space = @orig_mock_space
+      end
+    end
+
+    object.instance_eval(&block)
+  ensure
+    (class << RSpec::Core::ExampleGroup; self; end).class_eval do
+      remove_method :run
+      alias_method :run, :orig_run
+      remove_method :orig_run
+    end
+
+    RSpec.instance_variable_set(:@configuration, @orig_config)
+    RSpec.instance_variable_set(:@world, @orig_world)
+  end
+
+RSpec.configure do |config|
+  config.around {|example| sandboxed { example.run }}
+
+  config.add_formatter 'Jaribio::RSpecFormatter', 
+    File.join(File.dirname(__FILE__), 'jaribio.txt')
+  config.jaribio_url = 'http://jaribio.dev'
+  config.jaribio_api_key = 'kpwLvp4JNSMpxskZSypq'
+  config.jaribio_auto_create = true
+  config.jaribio_timeout = 30
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: jaribio_formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- C. Brian Jones
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: &70094911775320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70094911775320
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70094911774840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *70094911774840
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70094911774360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *70094911774360
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70094911773840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70094911773840
+description: Provide the necessary code to record execution results in Jaribio while
+  running tests in RSpec
+email: cbjones1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jaribio/execution.rb
+- lib/jaribio/formatter/version.rb
+- lib/jaribio/plan.rb
+- lib/jaribio/record.rb
+- lib/jaribio/remote_object.rb
+- lib/jaribio/rspec_formatter.rb
+- lib/jaribio/test_case.rb
+- lib/jaribio_formatter.rb
+- spec/jaribio.txt
+- spec/lib/jaribio/coverage/assets/0.5.3/app.js
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/blank.gif
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_close.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_loading.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_nav_left.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_nav_right.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_shadow_e.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_shadow_n.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_shadow_ne.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_shadow_nw.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_shadow_s.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_shadow_se.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_shadow_sw.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_shadow_w.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_title_left.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_title_main.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_title_over.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_title_right.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancybox-x.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancybox-y.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancybox.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/jquery.fancybox-1.3.1.css
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/jquery.fancybox-1.3.1.pack.js
+- spec/lib/jaribio/coverage/assets/0.5.3/favicon_green.png
+- spec/lib/jaribio/coverage/assets/0.5.3/favicon_red.png
+- spec/lib/jaribio/coverage/assets/0.5.3/favicon_yellow.png
+- spec/lib/jaribio/coverage/assets/0.5.3/highlight.css
+- spec/lib/jaribio/coverage/assets/0.5.3/highlight.pack.js
+- spec/lib/jaribio/coverage/assets/0.5.3/jquery-1.6.2.min.js
+- spec/lib/jaribio/coverage/assets/0.5.3/jquery.dataTables.min.js
+- spec/lib/jaribio/coverage/assets/0.5.3/jquery.timeago.js
+- spec/lib/jaribio/coverage/assets/0.5.3/jquery.url.js
+- spec/lib/jaribio/coverage/assets/0.5.3/loading.gif
+- spec/lib/jaribio/coverage/assets/0.5.3/magnify.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-bg_flat_75_ffffff_40x100.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_65_ffffff_1x400.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_75_dadada_1x400.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-icons_222222_256x240.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-icons_2e83ff_256x240.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-icons_454545_256x240.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-icons_888888_256x240.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-icons_cd0a0a_256x240.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/jquery-ui-1.8.4.custom.css
+- spec/lib/jaribio/coverage/assets/0.5.3/stylesheet.css
+- spec/lib/jaribio/coverage/index.html
+- spec/lib/jaribio/execution_spec.rb
+- spec/lib/jaribio/plan_spec.rb
+- spec/lib/jaribio/record_spec.rb
+- spec/lib/jaribio/remote_object_spec.rb
+- spec/lib/jaribio/rspec_formatter_spec.rb
+- spec/spec_helper.rb
+- README.rdoc
+- Rakefile
+- jaribio_formatter.gemspec
+homepage: https://github.com/bithckr/Jaribio/tree/master/jaribio_formatter
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2018755072061309350
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.10
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Jaribio test framework formatters
+test_files:
+- spec/jaribio.txt
+- spec/lib/jaribio/coverage/assets/0.5.3/app.js
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/blank.gif
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_close.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_loading.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_nav_left.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_nav_right.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_shadow_e.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_shadow_n.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_shadow_ne.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_shadow_nw.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_shadow_s.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_shadow_se.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_shadow_sw.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_shadow_w.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_title_left.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_title_main.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_title_over.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancy_title_right.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancybox-x.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancybox-y.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/fancybox.png
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/jquery.fancybox-1.3.1.css
+- spec/lib/jaribio/coverage/assets/0.5.3/fancybox/jquery.fancybox-1.3.1.pack.js
+- spec/lib/jaribio/coverage/assets/0.5.3/favicon_green.png
+- spec/lib/jaribio/coverage/assets/0.5.3/favicon_red.png
+- spec/lib/jaribio/coverage/assets/0.5.3/favicon_yellow.png
+- spec/lib/jaribio/coverage/assets/0.5.3/highlight.css
+- spec/lib/jaribio/coverage/assets/0.5.3/highlight.pack.js
+- spec/lib/jaribio/coverage/assets/0.5.3/jquery-1.6.2.min.js
+- spec/lib/jaribio/coverage/assets/0.5.3/jquery.dataTables.min.js
+- spec/lib/jaribio/coverage/assets/0.5.3/jquery.timeago.js
+- spec/lib/jaribio/coverage/assets/0.5.3/jquery.url.js
+- spec/lib/jaribio/coverage/assets/0.5.3/loading.gif
+- spec/lib/jaribio/coverage/assets/0.5.3/magnify.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-bg_flat_75_ffffff_40x100.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_65_ffffff_1x400.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_75_dadada_1x400.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-icons_222222_256x240.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-icons_2e83ff_256x240.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-icons_454545_256x240.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-icons_888888_256x240.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/images/ui-icons_cd0a0a_256x240.png
+- spec/lib/jaribio/coverage/assets/0.5.3/smoothness/jquery-ui-1.8.4.custom.css
+- spec/lib/jaribio/coverage/assets/0.5.3/stylesheet.css
+- spec/lib/jaribio/coverage/index.html
+- spec/lib/jaribio/execution_spec.rb
+- spec/lib/jaribio/plan_spec.rb
+- spec/lib/jaribio/record_spec.rb
+- spec/lib/jaribio/remote_object_spec.rb
+- spec/lib/jaribio/rspec_formatter_spec.rb
+- spec/spec_helper.rb