test_linker 0.1.1 → 1.0.0

data/.infinity_test

@@ -0,0 +1,7 @@
+infinity_test do
+  notifications :growl do
+    show_images :mode => :mario_bros
+  end
+
+  use :rubies => %w(1.8.7 jruby 1.9.2 ree), :test_framework => :rspec
+end

data/.rspec

@@ -1 +1 @@
---colour --format documentation
+--colour --format documentation --tty

data/ChangeLog.rdoc

@@ -1,3 +1,29 @@
+=== 1.0.0 / 2011-05-08
+
+* Added support for new (old) Rubies:
+  * 1.8.7
+  * jruby 1.6.1
+  * ree 1.8.7
+* Hash keys are all now symbols.
+* Renamed methods:
+  * Wrapper#project_test_plans to Wrapper#test_plans.
+  * Wrapper#create_test_project to Wrapper#create_project.
+  * Wrapper#upload_test_project_attachment to Wrapper#upload_project_attachment.
+  * Wrapper#first_level_test_suites_for_test_project to Wrapper#first_level_test_suites_for_project.
+  * Helpers#test_project_id to Helpers#project_id.
+  * Helpers#test_project_by_name to Helpers#project_by_name.
+* New Helper method:
+  * #find_projects
+* Helper#find_projects and Helper#find_test_plans take a trailing parameter that
+  let's you specify which attribute to match on--that defaults to :name.
+* Added ability to log XMLRPC calls that go through Net::HTTP.
+* Development stuff:
+  * Stopped using ore for gem bundling; just use Jeweler now.
+
+=== 0.1.1 / 2011-03-24
+
+* Fixed dumb dependency on self to install.
+
 === 0.1.0 / 2011-03-24
 
 * Initial release:

data/Gemfile

@@ -4,13 +4,11 @@ source :rubygems
 gem 'versionomy', '~> 0.4.0'
 
 group :development do
+  gem 'bundler', '~> 1.0.0'
   gem 'cucumber', '~> 0.10.0'
-  gem 'rake',     '~> 0.8.7'
-  gem 'ore', '~> 0.7.2'
-  gem 'ore-core',  '~> 0.1.4'
-  gem 'ore-tasks', '~> 0.5.0'
+  gem 'fakeweb', '~> 1.3.0'
+  gem 'jeweler', '~> 1.6.0'
   gem 'rspec', '~> 2.5'
-  gem 'simplecov', '>= 0.4.0', :require => false
-  gem 'jeweler', '~> 1.5.0'
+  gem 'simplecov', '>= 0.4.0', :require => false if RUBY_VERSION >= "1.9"
   gem 'yard', '~> 0.6.0'
 end

data/README.rdoc

@@ -15,32 +15,37 @@ easier.  This supports TestLink APIs 1.0 Beta 5 (from TestLink 1.8.x) and 1.0
 == Features
 
 * Basic wrapper around existing XMLRPC functions.
-* Allow for calling methods via Ruby style (#projects) or XMLRPC style (#getProjects)
-* Support for TestLink API versions 1.0 Beta 5 and 1.0
-* Only one error/exception type: TestLinker::Error
-* Limited set of helper methods, attempting to fill in gaps from the API
+* Allow for calling methods via Ruby style (#projects) or XMLRPC style (#getProjects).
+* Support for TestLink API versions 1.0 Beta 5 and 1.0.
+* Only one error/exception type: TestLinker::Error.
+* Limited set of helper methods, attempting to fill in gaps from the API.
 
 == Examples
 
+Get results to a CSV file:
+
   require 'test_linker'
+  require 'pp'
 
-  server = 'http://testlink.pelco.org'
+  server = 'http://testlink'
   dev_key = "90b7941411928ae0a84d19f365a01a63"
-  tl_project = "!SSW Auto-Smoke Testing"
+  tl_project = "My nifty project"
+  tl = TestLinker.new(server, dev_key)
 
-  csv_file_name = "mtrx_report.csv"
+  # Write out the CSV headers
+  csv_file_name = "report.csv"
   csv_file = File.new(csv_file_name, "w")
-  csv_file.write "Build,Passed,Failed,Blocked,Skipped,TOTAL,Overall %,Overall % (+B)\n"
-
-  tl = TestLinker.new(server, dev_key)
+  csv_file.write "Build,Passed,Failed,Blocked,TOTAL,Overall %,Overall % (+B)\n"
 
-  project_id = tl.test_project_id tl_project
-  test_plans = tl.find_test_plans(project_id, /NSM5200.+ISC West/)
+  # Get the list of test plans that I want to report on
+  project_id = tl.project_id tl_project
+  test_plans = tl.find_test_plans(project_id, /^Component.+1.0/)
   puts "All test plans for project #{project_id}"
-  puts test_plans
+  pp test_plans
 
+  # Get a list of all builds from those test plans
   builds = test_plans.collect do |test_plan|
-    tl.builds_for_test_plan(test_plan["id"])
+    tl.builds_for_test_plan(test_plan[:id])
   end
   builds.flatten!
 
@@ -48,66 +53,62 @@ easier.  This supports TestLink APIs 1.0 Beta 5 (from TestLink 1.8.x) and 1.0
   overall[:pass] = 0
   overall[:failed] = 0
   overall[:blocked] = 0
-  overall[:pass_rates] =
   results = {}
 
+  # Total up results for each build and write to the CSV file
   builds.each do |build|
     results[:pass] = 0
     results[:failed] = 0
     results[:blocked] = 0
-    results[:skipped] = 0
 
-    test_cases = tl.test_cases_for_test_plan(build["testplan_id"],
-      { "buildid" => build["id"] })
+    test_cases = tl.test_cases_for_test_plan(build[:testplan_id],
+      { :buildid => build[:id] })
 
     test_cases.each_value do |test_case|
-      case test_case["exec_status"]
+      case test_case[:exec_status]
       when "p"
         results[:pass] += 1
       when "f"
         results[:failed] += 1
       when "b"
         results[:blocked] += 1
-      when "s"
-        results[:skipped] += 1
       end
     end
 
     overall[:pass] += results[:pass]
     overall[:failed] += results[:failed]
     overall[:blocked] += results[:blocked]
-    build_total = results[:pass] + results[:failed] + results[:blocked] +
-        results[:skipped]
+    build_total = results[:pass] + results[:failed] + results[:blocked]
+        
     overall_rate = "%2.2f" % (overall[:pass] * 100 / (overall[:pass] +
         overall[:failed]).to_f)
-    overall[:pass_rates] << overall_rate.to_f
     overall_rate_plus_blocked = "%2.2f" % (overall[:pass] * 100 / (overall[:pass] +
         overall[:failed] + overall[:blocked]).to_f)
 
-    result_array = [
-      ['Passed', 'Failed', 'Blocked', 'Skipped', 'TOTAL', 'Overall %', 'Overall % (+B)'],
-      [results[:pass], results[:failed], results[:blocked], results[:skipped],
-        build_total, overall_rate, overall_rate_plus_blocked]
-    ]
-
-    csv_line = "#{build["name"]},#{results[:pass]},#{results[:failed]},#{results[:blocked]},"
-    csv_line << "#{results[:skipped]},#{build_total},#{overall_rate},#{overall_rate_plus_blocked}\n"
+    csv_line = "#{build[:name]},#{results[:pass]},#{results[:failed]},#{results[:blocked]},"
+    csv_line << "#{build_total},#{overall_rate},#{overall_rate_plus_blocked}\n"
     csv_file.write csv_line
   end
+  
+  csv_file.close
+
 
 == Requirements
 
 * Rubies (tested)
+  * 1.8.7
   * 1.9.2
+  * jruby 1.6.1
+  * ree 1.8.7
 * Gems
   * versionomy, ~> 0.4.0
 * Gems (development)
   * bundler, ~> 1.0.0
   * cucumber, ~> 0.10.0
+  * fakeweb, ~> 1.3.0
   * jeweler, ~> 1.5.0
-  * ore, ~> 0.7.2
-  * ore-core, ~> 0.1.4
   * rspec, ~> 2.5.0
+  * simplecov, >= 0.4.0
   * yard, ~> 0.6.0
 
 Getting it all running (on the TestLink side):

data/Rakefile

@@ -1,48 +1,51 @@
-require 'rake'
+require 'rubygems'
+require 'bundler'
 
 begin
-  gem 'ore-tasks', '~> 0.4'
-  require 'ore/tasks'
-
-  Ore::Tasks.new
-rescue LoadError => e
-  STDERR.puts e.message
-  STDERR.puts "Run `gem install ore-tasks` to install 'ore/tasks'."
-end
-begin
-  require 'bundler'
-rescue LoadError => e
-  STDERR.puts e.message
-  STDERR.puts "Run `gem install bundler` to install Bundler."
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
 
-begin
-  Bundler.setup(:development)
-rescue Bundler::BundlerError => e
-  STDERR.puts e.message
-  STDERR.puts "Run `bundle install` to install missing gems."
-  exit e.status_code
+require 'rake'
+
+$:.unshift Dir.pwd + "/lib"
+require 'test_linker'
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "test_linker"
+  gem.version = TestLinker::VERSION
+  gem.homepage = "http://github.com/turboladen/test_linker"
+  gem.license = "MIT"
+  gem.summary = %Q{An interface to the TestLink XMLRPC API}
+  gem.description = %Q{This is a Ruby wrapper around the TestLink XMLRPC API, thus allowing access to
+  your TestLink test projects, plans, cases, and results using Ruby.  We've added
+  a few helper methods as well to allow for getting at more of your data a little
+  easier.  This supports TestLink APIs 1.0 Beta 5 (from TestLink 1.8.x) and 1.0
+  (from TestLink 1.9.x)..}
+  gem.email = "steve.loveless@gmail.com"
+  gem.authors = ["turboladen"]
+  gem.add_bundler_dependencies
 end
+Jeweler::RubygemsDotOrgTasks.new
 
-begin
-  gem 'rspec', '~> 2.5'
-  require 'rspec/core/rake_task'
-
-  RSpec::Core::RakeTask.new
-  task :test => :spec
-  task :default => :spec
-rescue LoadError => e
-  task :spec do
-    abort "Please run `gem install rspec` to install RSpec."
-  end
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-require 'ore/specification'
-require 'jeweler'
-Jeweler::Tasks.new(Ore::Specification.new)
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+task :default => :spec
 
 require 'yard'
 YARD::Rake::YardocTask.new
-task :doc => :yard
-

data/features/step_definitions/get_info_steps.rb

@@ -1,10 +1,10 @@
 Given /^I know the name of a project$/ do
-  @test_project_name = @server.projects.last["name"]
+  @test_project_name = @server.projects.last[:name]
   @test_project_name.should_not be_nil
 end
 
 Given /^I know the name of a test plan in that project$/ do
-  @original_test_plan_name = @test_plans.last["name"]
+  @original_test_plan_name = @test_plans.last[:name]
   @original_test_plan_name.should_not be_nil
 end
 
@@ -15,7 +15,7 @@ end
 
 Given /^I have a list of test plans$/ do
   #When "I ask for the list of test plans"
-  @test_plans = @server.project_test_plans(@project_list.last["id"])
+  @test_plans = @server.test_plans(@project_list.last[:id])
 end
 
 When /^I ask for the list of projects$/ do
@@ -23,16 +23,16 @@ When /^I ask for the list of projects$/ do
 end
 
 When /^I ask for the list of test plans$/ do
-  @test_plans = @server.project_test_plans(@project_list.last["id"])
+  @test_plans = @server.test_plans(@project_list.last[:id])
 end
 
 When /^I ask for that project by name$/ do
-  @requested_test_project_name = @server.test_project_by_name(@test_project_name)
+  @requested_test_project_name = @server.project_by_name(@test_project_name)
 end
 
 When /^I ask for that test plan by name$/ do
-  @requested_test_plan_name = @server.test_plan_by_name(@original_test_plan_name,
-    @project_list.last["name"])
+  @requested_test_plan_name = @server.test_plan_by_name(@project_list.last[:name], @original_test_plan_name)
+  
 end
 
 Then /^I get a list of projects$/ do
@@ -46,16 +46,16 @@ Then /^I get a list of test plans$/ do
 end
 
 Then /^I get that project$/ do
-  @requested_test_project_name.last["name"].should == @test_project_name
+  @requested_test_project_name.last[:name].should == @test_project_name
 end
 
 Then /^I get that test plan$/ do
-  @requested_test_plan_name.first["name"].should == @original_test_plan_name
+  @requested_test_plan_name.first[:name].should == @original_test_plan_name
 end
 
 Given /^I know the ID of a test case in that project$/ do
   pending
-  @test_cases = @server.test_cases_for_test_plan(@test_plans.last["id"])
+  @test_cases = @server.test_cases_for_test_plan(@test_plans.last[:id])
 end
 
 When /^I ask for that test case by ID$/ do
@@ -68,11 +68,11 @@ end
 
 When /^I ask for the list of test cases in that test plan$/ do
   @test_cases = @server.test_cases_for_test_plan(
-      @test_plans.last.values.last["id"])
+      @test_plans.last.values.last[:id])
 end
 
 Then /^I get a list of test cases in that test plan$/ do
   @test_cases.should_not be_nil
   @test_cases.class.should == Hash
-  @test_cases.each_value {|v| v["name"].class.should == String }
+  @test_cases.each_value {|v| v[:name].class.should == String }
 end

data/features/support/env.rb

@@ -1,5 +1,9 @@
-require 'simplecov'
-SimpleCov.start do
-  add_group "Library", "lib/"
+if RUBY_VERSION > '1.9'
+  require 'simplecov'
+  
+  SimpleCov.start do
+    add_group "Library", "lib/"
+  end
 end
-require_relative '../../lib/test_linker'
+
+require File.expand_path(File.dirname(__FILE__) + '/../../lib/test_linker')

data/lib/core_ext/hash_patch.rb

@@ -0,0 +1,24 @@
+class Hash
+  def symbolize_keys
+    inject({ }) do |options, (key, value)|
+      new_key = case key
+      when String
+        Integer(key) rescue key.to_sym
+      end
+      
+      new_value = case value
+      when Hash then value.symbolize_keys
+      when String
+        Integer(value) rescue value
+      else value
+      end
+      
+      options[new_key] = new_value
+      options
+    end
+  end
+
+  def symbolize_keys!
+    self.replace(self.symbolize_keys)
+  end
+end

data/lib/core_ext/xmlrpc_client_patch.rb

@@ -0,0 +1,7 @@
+require 'xmlrpc/client'
+
+class XMLRPC::Client
+  def set_debug(new_logger=$stderr)
+    @http.set_debug_output(new_logger)
+  end
+end

data/lib/test_linker.rb

@@ -1,11 +1,14 @@
-require_relative 'test_linker/wrapper'
-require_relative 'test_linker/version'
-require_relative 'test_linker/error'
-require_relative 'test_linker/helpers'
-require 'xmlrpc/client'
 require 'logger'
+require 'rubygems'
 require 'versionomy'
 
+require File.expand_path(File.dirname(__FILE__) + '/core_ext/hash_patch')
+require File.expand_path(File.dirname(__FILE__) + '/test_linker/wrapper')
+require File.expand_path(File.dirname(__FILE__) + '/test_linker/version')
+require File.expand_path(File.dirname(__FILE__) + '/test_linker/error')
+require File.expand_path(File.dirname(__FILE__) + '/test_linker/helpers')
+require File.expand_path(File.dirname(__FILE__) + '/core_ext/xmlrpc_client_patch')
+
 class TestLinker
   include TestLinker::Wrapper
   include TestLinker::Helpers
@@ -77,6 +80,25 @@ class TestLinker
     @version   = Versionomy.parse(options[:version] || api_version)
   end
 
+  # @return [Boolean] Returns if logging of XMLRPC requests/responses is
+  #   enabled or not.
+  def log_xml?
+    @log_xml ||= false
+  end
+
+  # @param [Boolean] do_logging false to turn XMLRPC logging off; true to
+  #   turn it back on.
+  def log_xml=(do_logging)
+    if do_logging == true
+      puts "WARNING: Net::HTTP warns against using this in production, so you probably shouldn't!!"
+      @server.set_debug(TestLinker.logger)
+    elsif do_logging == false
+      @server.set_debug(nil)
+    end
+
+    @log_xml = do_logging
+  end
+
   # Makes the call to the server with the given arguments.  Note that this also
   # allows for calling XMLRPC methods on the server that haven't yet been
   # implemented as Ruby methods here.
@@ -92,18 +114,29 @@ class TestLinker
   # @return The return type depends on the method call.
   def make_call(method_name, arguments, method_supported_in_version)
     ensure_version_is :greater_than_or_equal_to, method_supported_in_version
+    
+    arguments.merge!({ :devKey => @dev_key }) unless arguments.has_key? :devKey
+    
     TestLinker.log "API Version: #{method_supported_in_version}"
-    TestLinker.log "Calling method: '#{method_name}' with args '#{arguments}'"
+    TestLinker.log "Calling method: '#{method_name}' with args '#{arguments.inspect}'"
     response = @server.call(method_name, arguments)
+    
+    TestLinker.log "response class: #{response.class}"
+    if response.is_a?(Array) && response.first.is_a?(Hash)
+      response.each { |r| r.symbolize_keys! }
+    elsif response.is_a? Hash
+      response.symbolize_keys!
+    end
+
     TestLinker.log "Received response:"
     TestLinker.log response
 
     if @version.nil?
       return response
-    elsif response.is_a?(Array) && response.first['code']
-      raise TestLinker::Error, "#{response.first['code']}: #{response.first['message']}"
+    elsif response.is_a?(Array) && response.first[:code]
+      raise TestLinker::Error, "#{response.first[:code]}: #{response.first[:message]}"
     end
-
+    
     response
   end