jaribio_formatter 0.1.0

data/README.rdoc

@@ -0,0 +1,50 @@
+= jaribio-formatter
+
+This gem contains:
+
+* Jaribio::RSpecFormatter - An RSpec formatter that when configured appropriately will record test case execution for automated tests in jaribio.
+
+== RSpec Configuration
+
+  RSpec.configure do |config|
+    # Can add the formatter here or on command line of rspec
+    config.add_formatter 'Jaribio::RSpecFormatter',
+      File.join(File.dirname(__FILE__), 'jaribio.txt')
+
+    # Configure the url to the installation of jaribio
+    config.jaribio_url = 'https://localhost/jaribio'
+
+    # Configure a jaribio api key, obtained from a user's profile page
+    config.jaribio_api_key = 'asdf1234'
+
+    # Optional, by default all open plans are updated
+    # Configure only specific plans to be updated.
+    config.jaribio_plans = [1, 2, 3]
+
+    # Optional, by default this is false and the formatter will not create 
+    # missing test cases
+    config.jaribio_auto_create = true
+  end
+
+== TODO
+
+Eventually would like to include support for:
+
+* test::unit
+* cucumber
+
+== Contributing to jaribio-formatter
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 bjones. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler/gem_tasks'
+require 'jaribio/formatter/version'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "jaribio_formatter #{Jaribio::Formatter::VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Disabling some tasks we can't/don't want to ever run
+task(:release).clear_prerequisites.clear_actions

data/jaribio_formatter.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jaribio/formatter/version"
+
+Gem::Specification.new do |s|
+  s.name = "jaribio_formatter"
+  s.version = Jaribio::Formatter::VERSION
+  s.date = Time.now.utc.strftime("%Y-%m-%d")
+  s.authors = ["C. Brian Jones"]
+  s.email = "cbjones1@gmail.com"
+  s.homepage = "https://github.com/bithckr/Jaribio/tree/master/jaribio_formatter"
+  s.license = "MIT"
+  s.summary = %Q{Jaribio test framework formatters}
+  s.description = %Q{Provide the necessary code to record execution results in Jaribio while running tests in RSpec}
+  s.files = Dir.glob("{lib,spec}/**/*") + %w(README.rdoc Rakefile jaribio_formatter.gemspec)
+  s.test_files = Dir.glob("{spec}/**/*")
+  s.require_paths = ["lib"]
+  s.required_rubygems_version = ">= 1.8.10"
+
+  s.add_runtime_dependency 'activeresource', '~> 3.1.1'
+
+  s.add_development_dependency 'rake', '~> 0.9.2.2'
+  s.add_development_dependency 'rdoc', '3.12'
+  s.add_development_dependency 'rspec', '~> 2.8.0'
+end

data/lib/jaribio/execution.rb

@@ -0,0 +1,9 @@
+require 'jaribio/plan'
+require 'jaribio/test_case'
+require 'cgi'
+
+module Jaribio
+  class Execution < RemoteObject
+    self.prefix = '/plans/:plan_id/cases/:test_case_id/'
+  end
+end

data/lib/jaribio/formatter/version.rb

@@ -0,0 +1,5 @@
+module Jaribio
+  module Formatter
+    VERSION = '0.1.0'
+  end
+end

data/lib/jaribio/plan.rb

@@ -0,0 +1,13 @@
+require 'jaribio/remote_object'
+
+module Jaribio
+  class Plan < RemoteObject
+    def open?
+      if self.respond_to?(:closed_at)
+        return (closed_at == nil or closed_at > Time.now)
+      end
+      true
+    end
+  end
+end
+

data/lib/jaribio/record.rb

@@ -0,0 +1,86 @@
+require 'jaribio/plan'
+require 'jaribio/test_case'
+require 'cgi'
+
+module Jaribio
+  class Record
+    PASS = 1
+    FAIL = 2
+
+    attr_accessor :key, :description, :state, :error, :output
+
+    def initialize(args = {})
+      self.key = args[:key] 
+      self.description = args[:description]
+      self.state = args[:state]
+      self.error = args[:error]
+      self.output = args[:output] || $stdout
+    end
+
+    def failed?
+      self.state != PASS
+    end
+
+    def ==(other)
+      (self.key == other.key and 
+       self.description == other.description and 
+       self.state == other.state)
+    end
+
+    def eql?(other)
+      self == other
+    end
+
+    def save(plans = [])
+      begin
+        test_case = Jaribio::TestCase.find(CGI::escape(self.key))
+      rescue ActiveResource::ResourceNotFound
+        output.puts "# Test case #{self.key} not found"
+        return
+      end
+      if (test_case.nil?)
+        output.puts "# Test case #{self.key} not found"
+        return
+      end
+
+      return unless test_case.attributes.has_key?(:plans)
+      plan_ids = Hash[ test_case.plans.map { |x| [x.id, 1] } ]
+
+      # Configured plans in this block
+      plans.each do |plan|
+        # verify test case is part of this plan
+        next unless plan_ids.has_key?(plan.id)
+
+        # create execution
+        create_execution(test_case, plan)
+      end
+
+      # No configured plans, try to update any open plan for each test case
+      if (plans.size == 0)
+        test_case.plans.each do |plan|
+          create_execution(test_case, plan)
+        end
+      end
+    end
+
+    private
+
+    def create_execution(test_case, plan)
+      return unless plan.open?
+      execution = Jaribio::Execution.new(
+        :status_code => self.state,
+        :results => self.error
+      )
+      execution.prefix_options = {:plan_id => plan.id, :test_case_id => test_case.id}
+      begin
+        execution.save()
+        output.puts "# Saving execution of #{test_case.unique_key} - #{test_case.name} for plan #{plan.id} - #{plan.name}"
+      rescue Exception => e
+        output.puts "# Error saving execution of #{test_case.unique_key} - #{test_case.name} for plan #{plan.id} - #{plan.name}: #{e.message}"
+        output.puts e.backtrace
+      end
+      return execution
+    end
+
+  end
+end

data/lib/jaribio/remote_object.rb

@@ -0,0 +1,28 @@
+require 'active_resource'
+require 'active_support/core_ext/class/attribute_accessors'
+
+module Jaribio
+  class RemoteObject < ActiveResource::Base
+    cattr_accessor :api_key
+
+    # use json, not xml
+    self.format = :json
+
+    class << self
+      # Override query_string to automatically add the api_key
+      def query_string(options)
+        options = {} if options.nil?
+        options[:api_key] = api_key unless api_key.nil?
+        super(options)
+      end
+
+      def configure(config)
+        self.site = config.jaribio_url
+        self.api_key = config.jaribio_api_key
+        # set timeout (does not affect DNS lookups generally)
+        self.timeout = config.jaribio_timeout
+      end
+    end
+
+  end
+end

data/lib/jaribio/rspec_formatter.rb

@@ -0,0 +1,219 @@
+require 'jaribio/record'
+require 'rspec/core'
+require 'cgi'
+require 'base64'
+require 'digest/md5'
+
+module Jaribio
+  class RSpecFormatter
+
+    attr_reader :output, :results, :example_group
+
+    def initialize(output)
+      @output = output || StringIO.new
+      @results = {}
+    end
+
+    def start(example_count)
+    end
+
+    def example_group_started(example_group)
+      @example_group = example_group
+    end
+
+    def example_group_finished(example_group)
+    end
+
+    def example_started(example)
+    end
+
+    # 
+    # Mark example as passed via unique key
+    #
+    def example_passed(example)
+      record_result(example)
+    end
+
+    def example_pending(example)
+    end
+
+    # 
+    # Mark example as failed via unique key
+    #
+    def example_failed(example)
+      record_result(example, true)
+    end
+
+    def message(message)
+    end
+
+    def stop
+    end
+
+    def start_dump()
+    end
+
+    def dump_pending()
+    end
+
+    def dump_failures()
+    end
+
+    def dump_summary(duration, example_count, failure_count, pending_count)
+      output.puts "1..#{results.size}"
+      results.each_with_index do |data, index|
+        result = data[1]
+        status = (result.failed?) ? "not ok" : "ok"
+        count = index + 1
+        output.puts "#{status} #{count} - (#{result.key}) #{result.description}"
+      end
+    end
+
+    # no-op
+    def seed(seed)
+    end
+
+    # 
+    # Update Jaribio
+    # - configured to update pass/fail?
+    # - configured to output a report (for the purpose of updating your specs)
+    # - configured to generate plan/suite/test case?
+    #
+    def close()
+      Jaribio::RemoteObject.configure(configuration)
+      # create missing test cases, the new test cases are not automatically
+      # added to any plan
+      if RSpec.configuration.jaribio_auto_create
+        results.values.each do |record|
+          begin
+            test_case = Jaribio::TestCase.find(CGI::escape(record.key))
+          rescue ActiveResource::ResourceNotFound
+          end
+          if (test_case.nil?)
+            test_case = Jaribio::TestCase.new(
+              :name => record.description,
+              :unique_key => record.key,
+              :automated => true
+            )
+            begin
+              test_case.save
+              output.puts "# Created test case with unique key #{record.key}"
+            rescue Exception => e
+              output.puts "# Error creating test case #{record.key}: #{e.message}"
+              output.puts e.backtrace
+            end
+          end
+        end
+      end
+
+      plans = []
+      # create executions for specific plans only
+      if RSpec.configuration.jaribio_plans.size > 0
+        RSpec.configuration.jaribio_plans.each do |plan_id|
+          begin
+            plan = Jaribio::Plan.find(plan_id)
+            if plan.open?
+              plans << plan
+            else
+              output.puts "# RSpec configuration includes closed plan #{plan_id}"
+            end
+          rescue ActiveResource::ResourceNotFound
+            output.puts "# RSpec configuration of jaribio_plans includes unknown plan_id #{plan_id}"
+          end
+        end
+      end
+
+      results.each_value do |record|
+        record.save(plans)
+      end
+    end
+
+    protected
+
+    def configuration
+      RSpec.configuration
+    end
+
+    def record_result(example, failed = false)
+      key, desc = get_example_key(example)
+      if (@results.has_key?(key))
+        failed = failed || @results[key].failed?
+      end
+      error = nil
+      if (example.execution_result.has_key?(:exception))
+        exception = example.execution_result[:exception]
+        unless (exception.nil?)
+          error = "#{exception.message}\n#{exception.backtrace}"
+        end
+      end
+      record = Record.new(:key => key, :description => desc, :state => failed ? Jaribio::Record::FAIL : Jaribio::Record::PASS, :error => error, :output => output)
+      @results[key] = record
+    end
+
+    # 
+    # Should this return?
+    # - jaribio_key if set (and desc based on that)
+    # - otherwise
+    # -- example_group full description (md5)
+    #
+    def get_example_key(example)
+      key, desc = find_jaribio_key(example)
+      if (key.nil?)
+        key = example_group.metadata[:example_group][:full_description]
+        desc = key
+        key = Base64.strict_encode64(Digest::MD5.digest(key))
+      end
+      return key, desc
+    end
+
+    #
+    # metadata of a group is shared with descendants
+    # must check ancestors until key not found (if it is found)
+    #
+    def find_jaribio_key(example)
+      key, desc = nil, nil
+      if defined? example.metadata and example.metadata.has_key?(:jaribio_key)
+        key = example.metadata[:jaribio_key]
+        desc = example.full_description
+      end
+      group = example_group
+      while (key.nil? and defined? group) do
+        key = group.metadata[:jaribio_key]
+        desc = group.metadata[:example_group][:full_description]
+        break if group.top_level?
+        group = group.superclass
+      end
+
+      # after finding the first instance of the key, continue
+      # checking up the chain to be sure this where it is defined
+      while (defined? key)
+        if group.metadata.has_key?(:jaribio_key)
+          if (group.metadata[:jaribio_key] != key)
+            break
+          else
+            desc = group.metadata[:example_group][:full_description]
+          end
+        else
+          break
+        end
+        break if group.top_level?
+        group = group.superclass
+      end
+
+      return key, desc
+    end
+
+    def self.configure()
+      RSpec.configure do |c|
+        c.add_setting :jaribio_url
+        c.add_setting :jaribio_api_key
+        c.add_setting :jaribio_plans, :default => []
+        c.add_setting :jaribio_auto_create, :default => false
+        c.add_setting :jaribio_timeout, :default => 5
+      end
+    end
+  end
+
+  RSpecFormatter.configure
+end
+

data/lib/jaribio/test_case.rb

@@ -0,0 +1,5 @@
+module Jaribio
+  class TestCase < RemoteObject
+    self.collection_name = 'cases'
+  end
+end

data/lib/jaribio_formatter.rb

@@ -0,0 +1,3 @@
+%w(remote_object execution plan test_case rspec_formatter record formatter/version).each do |file|
+  require File.expand_path(File.join(File.dirname(__FILE__), 'jaribio', file))
+end

data/spec/jaribio.txt

@@ -0,0 +1,15 @@
+1..10
+ok 1 - (wRq7gMRkRJeHnqZxkqkDng==) Jaribio::Plan#open?
+ok 2 - (tccJHXEmFLwXeHzoPzRG+g==) Jaribio::Record#failed?
+ok 3 - (I6JDDF4nqkrcAwC3ZGArJw==) Jaribio::Record#eql?
+ok 4 - (9AfA585llnqxPxpEXNJcGg==) Jaribio::Record#save
+ok 5 - (pBw77Ov/D/ZvKtAqJOMp8g==) Jaribio::RemoteObject#query_string
+ok 6 - (QNi21vVeqvCyXIIg2/hlSA==) Jaribio::RemoteObject#configure
+ok 7 - (XXpQMW5Ii4t2f6WSeWhxZg==) Jaribio::RSpecFormatter#get_example_key
+ok 8 - (1ytapaYfeTdvJQ/dZzKSXg==) Jaribio::RSpecFormatter#results
+ok 9 - (XcEQFeZVa+8E6UUmVFGjuw==) Jaribio::RSpecFormatter#close
+ok 10 - (Gz4dbtEYCTJAgQrD4iEhGg==) Jaribio::RSpecFormatter can configure
+# Saving execution of XXpQMW5Ii4t2f6WSeWhxZg== - Jaribio::RSpecFormatter#get_example_key for plan 5 - jaribio_formatter
+# Saving execution of 1ytapaYfeTdvJQ/dZzKSXg== - Jaribio::RSpecFormatter#results for plan 5 - jaribio_formatter
+# Saving execution of XcEQFeZVa+8E6UUmVFGjuw== - Jaribio::RSpecFormatter#close for plan 5 - jaribio_formatter
+# Saving execution of Gz4dbtEYCTJAgQrD4iEhGg== - Jaribio::RSpecFormatter can configure for plan 5 - jaribio_formatter

data/spec/lib/jaribio/coverage/assets/0.5.3/app.js

@@ -0,0 +1,88 @@
+$(document).ready(function() {
+  // Configuration for fancy sortable tables for source file groups
+  $('.file_list').dataTable({
+    "aaSorting": [[ 1, "asc" ]],
+    "bPaginate": false,
+    "bJQueryUI": true,
+    "aoColumns": [
+			null,
+		  { "sType": "percent" },
+			null,
+			null,
+			null,
+			null,
+      null
+		]
+  });
+  
+  // Syntax highlight all files up front - deactivated
+  // $('.source_table pre code').each(function(i, e) {hljs.highlightBlock(e, '  ')});
+  
+  // Syntax highlight source files on first toggle of the file view popup
+  $("a.src_link").click(function() {
+    // Get the source file element that corresponds to the clicked element
+    var source_table = $($(this).attr('href'));
+    
+    // If not highlighted yet, do it!
+    if (!source_table.hasClass('highlighted')) {
+      source_table.find('pre code').each(function(i, e) {hljs.highlightBlock(e, '  ')});
+      source_table.addClass('highlighted');
+    };
+  });
+  
+  // Set-up of popup for source file views
+  $("a.src_link").fancybox({
+		'hideOnContentClick': true,
+		'centerOnScroll': true,
+		'width': '90%',
+		'padding': 0,
+		'transitionIn': 'elastic'
+  });
+	
+	// Hide src files and file list container after load
+  $('.source_files').hide();
+  $('.file_list_container').hide();
+  
+  // Add tabs based upon existing file_list_containers
+  $('.file_list_container h2').each(function(){
+    var container_id = $(this).parent().attr('id');
+    var group_name = $(this).find('.group_name').first().html();
+    var covered_percent = $(this).find('.covered_percent').first().html();
+    
+    $('.group_tabs').append('<li><a href="#' + container_id + '">' + group_name + ' ('+ covered_percent +')</a></li>');
+  });
+
+  $('.group_tabs a').each( function() {
+    $(this).addClass($(this).attr('href').replace('#', ''));
+  });
+  
+  // Make sure tabs don't get ugly focus borders when active
+  $('.group_tabs a').live('focus', function() { $(this).blur(); });
+  
+  var favicon_path = $('link[rel="shortcut icon"]').attr('href');
+  $('.group_tabs a').live('click', function(){
+    if (!$(this).parent().hasClass('active')) {
+      $('.group_tabs a').parent().removeClass('active');
+      $(this).parent().addClass('active');
+      $('.file_list_container').hide();
+      $(".file_list_container" + $(this).attr('href')).show();
+      window.location.href = window.location.href.split('#')[0] + $(this).attr('href').replace('#', '#_');
+      
+      // Force favicon reload - otherwise the location change containing anchor would drop the favicon...
+      // Works only on firefox, but still... - Anyone know a better solution to force favicon on local file?
+      $('link[rel="shortcut icon"]').remove();
+      $('head').append('<link rel="shortcut icon" type="image/png" href="'+ favicon_path +'" />');
+    };
+    return false;
+  });
+  
+  if (jQuery.url.attr('anchor')) {
+    $('.group_tabs a.'+jQuery.url.attr('anchor').replace('_', '')).click();
+  } else {
+    $('.group_tabs a:first').click();
+  };
+  
+  $("abbr.timeago").timeago();
+  $('#loading').fadeOut();
+  $('#wrapper').show();
+});