test_linker 0.1.0

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.*
+LICENSE.rdoc

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1,4 @@
+--markup rdoc
+--title "test_linker Documentation"
+--protected
+--private

data/ChangeLog.rdoc

@@ -0,0 +1,8 @@
+=== 0.1.0 / 2011-03-24
+
+* Initial release:
+  * 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: TestLinkClient::Error
+  * Limited set of helper methods, attempting to fill in gaps from the API

data/Gemfile

@@ -0,0 +1,16 @@
+source :rubygems
+
+gemspec
+gem 'versionomy', '~> 0.4.0'
+
+group :development do
+  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 'rspec', '~> 2.5'
+  gem 'simplecov', '>= 0.4.0', :require => false
+  gem 'jeweler', '~> 1.5.0'
+  gem 'yard', '~> 0.6.0'
+end

data/LICENSE.rdoc

@@ -0,0 +1,20 @@
+Copyright (c) 2011 sloveless
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,128 @@
+= test_linker
+
+* {Homepage}[http://rubygems.org/gems/test_linker]
+* {Documentation}[http://rubydoc.info/gems/test_linker/frames]
+* {TestLink API Documentation}[http://testlink.org/api/phpdoc_generated/TestlinkAPI/TestlinkXMLRPCServer.html]
+
+== Description
+
+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).
+
+== 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
+
+== Examples
+
+  require 'test_linker'
+
+  server = 'http://testlink.pelco.org'
+  dev_key = "90b7941411928ae0a84d19f365a01a63"
+  tl_project = "!SSW Auto-Smoke Testing"
+
+  csv_file_name = "mtrx_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)
+
+  project_id = tl.test_project_id tl_project
+  test_plans = tl.find_test_plans(project_id, /NSM5200.+ISC West/)
+  puts "All test plans for project #{project_id}"
+  puts test_plans
+
+  builds = test_plans.collect do |test_plan|
+    tl.builds_for_test_plan(test_plan["id"])
+  end
+  builds.flatten!
+
+  overall = {}
+  overall[:pass] = 0
+  overall[:failed] = 0
+  overall[:blocked] = 0
+  overall[:pass_rates] =
+  results = {}
+
+  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.each_value do |test_case|
+      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]
+    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_file.write csv_line
+  end
+
+== Requirements
+
+* Rubies (tested)
+  * 1.9.2
+* Gems
+  * versionomy, ~> 0.4.0
+* Gems (development)
+  * bundler, ~> 1.0.0
+  * cucumber, ~> 0.10.0
+  * jeweler, ~> 1.5.0
+  * ore, ~> 0.7.2
+  * ore-core, ~> 0.1.4
+  * rspec, ~> 2.5.0
+  * yard, ~> 0.6.0
+
+Getting it all running (on the TestLink side):
+1. Enable automation in the TestLink config file:
+    config.inc.php => $tlCfg->api->enabled = TRUE;
+2. The user that needs to run the automated tests needs to generate a API key
+that will be used in creating the connection.  This is accomplished by logging
+in to TestLink and going to "Personal -> API Key -> Generate a new key".
+
+== Install
+
+  $ gem install test_linker
+
+== Copyright
+
+Copyright (c) 2011 sloveless
+
+See LICENSE.rdoc for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rake'
+
+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."
+  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
+end
+
+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
+end
+
+require 'ore/specification'
+require 'jeweler'
+Jeweler::Tasks.new(Ore::Specification.new)
+
+require 'yard'
+YARD::Rake::YardocTask.new
+task :doc => :yard
+

data/features/get_info.feature

@@ -0,0 +1,63 @@
+Feature: Get info from TestLink
+  As a TestLink API user
+  I want to get info from the TestLink server
+  So that I can use the info in reports and such
+
+  Scenario Outline: Get a list of projects
+    Given I have a TestLink server with API version <version>
+    When I ask for the list of projects
+    Then I get a list of projects
+
+  Scenarios: Known API versions
+    | version    |
+    | 1.0 Beta 5 |
+    | 1.0        |
+
+  Scenario Outline: Get a list of test plans
+    Given I have a TestLink server with API version <version>
+    When I ask for the list of projects
+    And I ask for the list of test plans
+    Then I get a list of test plans
+
+  Scenarios: Known API versions
+    | version    |
+    | 1.0 Beta 5 |
+    | 1.0        |
+
+  Scenario Outline: Get a list of test cases in a test plan
+    Given I have a TestLink server with API version <version>
+    And I have the list of projects
+    And I know the name of a project
+    And I have a list of test plans
+    When I ask for the list of test cases in that test plan
+    Then I get a list of test cases in that test plan
+
+  Scenarios: Known API versions
+    | version    |
+    | 1.0 Beta 5 |
+    | 1.0        |
+
+  Scenario: Get a test project by its name
+    Given I have a TestLink server with API version 1.0
+    And I know the name of a project
+    When I ask for that project by name
+    Then I get that project
+
+  Scenario: Get a test plan by its name
+    Given I have a TestLink server with API version 1.0
+    And I have the list of projects
+    And I know the name of a project
+    And I have a list of test plans
+    And I know the name of a test plan in that project
+    When I ask for that test plan by name
+    Then I get that test plan
+
+  Scenario: Get a test case by its ID
+    Given I have a TestLink server with API version 1.0
+    And I have the list of projects
+    And I know the name of a project
+    And I have a list of test plans
+    And I know the ID of a test case in that project
+    When I ask for that test case by ID
+    Then I get that test case
+

data/features/step_definitions/get_info_steps.rb

@@ -0,0 +1,78 @@
+Given /^I know the name of a project$/ do
+  @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.should_not be_nil
+end
+
+Given /^I have the list of projects$/ do
+  #When "I ask for the list of projects"
+  @project_list = @server.projects
+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"])
+end
+
+When /^I ask for the list of projects$/ do
+  @project_list = @server.projects
+end
+
+When /^I ask for the list of test plans$/ do
+  @test_plans = @server.project_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)
+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"])
+end
+
+Then /^I get a list of projects$/ do
+  @project_list.is_a?(Array).should be_true
+  @project_list.last.is_a?(Hash).should be_true
+end
+
+Then /^I get a list of test plans$/ do
+  @test_plans.class.should == Array
+  @test_plans.last.class.should == Hash
+end
+
+Then /^I get that project$/ do
+  @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
+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"])
+end
+
+When /^I ask for that test case by ID$/ do
+  pending # express the regexp above with the code you wish you had
+end
+
+Then /^I get that test case$/ do
+  pending # express the regexp above with the code you wish you had
+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"])
+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 }
+end

data/features/support/common.rb

@@ -0,0 +1,13 @@
+Given /^I have a TestLink server with API version (.+)$/ do |api_version|
+  if api_version == "1.0"
+    url = "http://ubuntu-desktop/testlink/"
+    dev_key = "b8c144a536f8233d24b04b8268bfac34"
+  else
+    url = "http://testlink/"
+    dev_key = "90b7941411928ae0a84d19f365a01a63"
+  end
+
+  @server = TestLinker.new(url, dev_key)
+  @server.api_version.should == api_version
+  @server.about.should match /#{api_version} /
+end

data/features/support/env.rb

@@ -0,0 +1,5 @@
+require 'simplecov'
+SimpleCov.start do
+  add_group "Library", "lib/"
+end
+require_relative '../../lib/test_linker'

data/gemspec.yml

@@ -0,0 +1,25 @@
+name: test_linker
+summary: "An interface to the TestLink XMLRPC API"
+description:
+  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).
+license: MIT
+authors: Steve Loveless, Randy Stoller, Sujin Philip, Vikram Raina
+email: steve.loveless@gmail.com
+homepage: http://rubygems.org/gems/test_linker
+has_yard: true
+dependencies:
+  versionomy: ~> 0.4.0
+
+development_dependencies:
+  bundler: ~> 1.0.0
+  cucumber: ~> 0.10.0
+  jeweler: ~> 1.5.0
+  ore: ~> 0.7.2
+  ore-core: ~> 0.1.4
+  rspec: ~> 2.5
+  simplecov: >= 0.4.0
+  yard: ~> 0.6.0

data/lib/test_linker.rb

@@ -0,0 +1,130 @@
+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 'versionomy'
+
+class TestLinker
+  include TestLinker::Wrapper
+  include TestLinker::Helpers
+
+  class << self
+
+    # @return [Boolean] Returns if logging is enabled or not.
+    def log?
+      @log ||= false
+    end
+
+    # @param [Boolean] do_logging false to turn logging off; true to turn it
+    #   back on.
+    def log=(do_logging)
+      @log = do_logging
+    end
+
+    # @return [Logger,?] Returns a Logger unless you use a different type of
+    #   logging object.
+    def logger
+      @logger ||= Logger.new STDOUT
+    end
+
+    # @param [?] logging_object Call this to use a different type of logger
+    #   than Logger.
+    def logger=(logging_object)
+      @logger = logging_object
+    end
+
+    # @return [Symbol] The method name to send to the logging object in order to
+    #   log messages.
+    def log_level
+      @log_level ||= :debug
+    end
+
+    # @param [Symbol] The method name to send to the logging object in order to
+    #   log messages.
+    def log_level=(level)
+      @log_level = level
+    end
+
+    # @param [String] message The string to log.
+    def log message
+      logger.send(log_level, message) if log?
+    end
+  end
+
+  # Default value for timing out after not receiving an XMLRPC response from
+  # the server.
+  DEFAULT_TIMEOUT = 30
+
+  # Path the the XMLRPC interface (via the xmlrpc.php file) on the server.
+  DEFAULT_API_PATH = "/lib/api/xmlrpc.php"
+
+  # @param [String] server_url URL to access TestLink API
+  # @param [String] dev_key User key to access TestLink API
+  # @param [Hash] options
+  # @option options [String] api_path Alternate path to the xmlrpc.php file on
+  #   the server.
+  # @option options [Fixnum] timeout Seconds to timeout after not receiving a
+  #   response from the server.
+  # @option options [String] version Force a different API version.
+  def initialize(server_url, dev_key, options={})
+    api_path   = options[:api_path] || DEFAULT_API_PATH
+    timeout    = options[:timeout] || DEFAULT_TIMEOUT
+    @dev_key   = dev_key
+    server_url = server_url + api_path
+    @server    = XMLRPC::Client.new_from_uri(server_url, nil, timeout)
+    @version   = Versionomy.parse(options[:version] || api_version)
+  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.
+  #
+  # @example Call a new method
+  #   result = make_call("tl.getWidgets", { "testplanid" => 123 }, "1.5")
+  #   raise TestLinker::Error, result["message"] if result["code"]
+  #   return result
+  # @param [String] method_name The XMLRPC method to call.
+  # @param [Hash] arguments The arguments to send to the server.
+  # @param [String] method_supported_in_version The version of the API the
+  #   method was added.
+  # @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
+    TestLinker.log "API Version: #{method_supported_in_version}"
+    TestLinker.log "Calling method: '#{method_name}' with args '#{arguments}'"
+    response = @server.call(method_name, arguments)
+    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']}"
+    end
+
+    response
+  end
+
+  private
+
+  # Raises if the version set in @version doesn't meet the comparison with the
+  # passed-in version.  Returns nil if @version isn't set, since there's
+  # nothing to do (and something might have called to set @version).
+  #
+  # @private
+  # @param [Symbol] comparison
+  # @param [String] version
+  def ensure_version_is(comparison, version)
+    message = "Method not supported in version #{@version}."
+
+    if @version.nil?
+      return
+    elsif comparison == :less_than && @version >= version
+      raise TestLinker::Error, message
+    elsif comparison == :greater_than_or_equal_to && @version < version
+      raise TestLinker::Error, message
+    end
+  end
+end