TestLinkClient 0.0.1

data/lib/TestLinkClient.rb

@@ -0,0 +1,308 @@
+#!/usr/bin/env ruby 
+require 'xmlrpc/client'
+# Author:: Sadahiko Hantani (garyohosu@gmail.com)
+# Copyright:: Copyright (c) 2008 Sadahiko Hantani
+# License::   Distributes under GPL
+
+class TestLinkClient
+#
+#=== 概要
+#
+# initialize
+#
+#=== 引数
+#
+#+server_url+::
+# TestLink Server URL
+#+dev_key+::
+# Personal API access key 
+#+api_path+::
+# xmlrpc.php path (Option) 
+#
+#=== 戻り値
+#
+# なし
+#
+#=== 例外
+#
+#=== 詳細
+#
+#  TestLinkを設置したサーバーのURLとPersonal API access keyを設定します。
+#  Personal API access keyを入手するには以下を実行してください。
+#  
+#1. TestLinkのconfig.inc.phpを変更します
+#    /** SOAP API availability (disabled by default) */
+#    $tlCfg->api_enabled = TRUE;
+#2. user_api_keyを取得
+#    TestLinkを開き「Personal」を開く。
+#    「Generate a new key」ボタンをクリック
+#    Personal API access key = xxxxxxxxxxxxxxxxxxxxxxxxxxxx
+#
+#=== 例
+#  client = TestLinkClient.new("http://foo.org/testlink_18RC1","413a5f43341axxxxxx91f166501740ec")
+#
+  def initialize(server_url,dev_key,api_path = "/lib/api/xmlrpc.php")
+    @server = XMLRPC::Client.new2(server_url + api_path)
+    @devKey = dev_key
+  end
+
+#
+#=== 概要
+#
+# getProjects
+#
+#=== 引数
+#
+# なし
+#
+#=== 戻り値
+#
+# 現在のテストプロジェクト情報が返ります
+# 例
+#[{"name"=>"project", "prefix"=>"test", "tc_counter"=>"15", "option_automation"=>"1", "option_priority"=>"1", "notes"=>"", "id"=>"1", "color"=>"", "option_reqs"=>"1", "active"=>"0"}, {"name"=>"testproject2", "prefix"=>"tp2", "tc_counter"=>"6", "option_automation"=>"1", "option_priority"=>"1", "notes"=>"<p>comment</p>","id"=>"35", "color"=>"", "option_reqs"=>"1", "active"=>"1"}]
+#
+#=== 詳細
+#
+# プロジェクト毎に以下の値を得ることができます
+#
+# name:テストプロジェクト名
+# prefix:プレフィックス
+# tc_counter:テストケース数
+# option_automation:automationを使用するか
+# option_priority:優先度を使用するか
+# notes:ノート
+# id:テストプロジェクトID
+# color:
+# option_reqs:要件管理を使用するか
+# active:アクティブプロジェクトか
+#
+#=== 例
+# getProjects #=>[{"name"=>"project", "prefix"=>"test", "tc_counter"=>"15", "option_automation"=>"1", "option_priority"=>"1", "notes"=>"", "id"=>"1", "color"=>"", "option_reqs"=>"1", "active"=>"0"}]
+#
+  def getProjects
+    args = {"devKey"=>@devKey}
+    ret = @server.call("tl.getProjects",args)
+  end
+
+#
+#=== 概要
+#
+# getProjectTestPlans(pid)
+#
+#=== 引数
+#
+#+pid+::
+# テストプロジェクトID
+#
+#=== 戻り値
+# 例
+# [{"3"=>{"name"=>"test plan", "notes"=>"note", "id"=>"3", "testproject_id"=>"1", "active"=>"1"}}]
+#
+#=== 例外
+#
+#=== 詳細
+#
+# テストプロジェクトIDを渡すとテスト計画の詳細情報を返す
+#
+#  -   :テスト計画ID
+#  name:テスト計画名
+#  notes:ノート
+#  id:自ID
+#  testproject_id:テストプロジェクトID
+#  active:アクティブか
+#
+#=== 例
+#
+# getProjectTestPlans(pid) #=>[{"3"=>{"name"=>"test plan", "notes"=>"note", "id"=>"3", "testproject_id"=>"1", "active"=>"1"}}]
+#
+  def getProjectTestPlans(pid)
+    args = {"devKey"=>@devKey,"testprojectid"=>pid}     
+    ret = @server.call("tl.getProjectTestPlans",args)
+  end
+
+#
+#=== 概要
+#
+# getBuildsForTestPlan(tpid)
+#
+#=== 引数
+#
+#+tpid+::
+# テスト計画ID
+#
+#=== 戻り値
+# 例
+# [{"name"=>"build1", "notes"=>"", "id"=>"1", "is_open"=>"1", "testplan_id"=>"3", "active"=>"1"}]
+#
+#=== 例外
+#
+#=== 詳細
+#
+# テスト計画IDを渡すとビルドの詳細情報を返す
+#  name:ビルド名
+#  notes:ノート
+#  id:自ID
+#  is_open:オープンか？
+#  testplan_id:テスト計画ID
+#  active:アクティブか
+#
+#=== 例
+#
+# getBuildsForTestPlan(tpid) #=>[{"name"=>"build1", "notes"=>"", "id"=>"1", "is_open"=>"1", "testplan_id"=>"3", "active"=>"1"}]
+#
+  def getBuildsForTestPlan(tpid)
+    args = {"devKey"=>@devKey,"testplanid"=>tpid}     
+    ret = @server.call("tl.getBuildsForTestPlan",args)
+  end  
+
+#
+#=== 概要
+#
+# getTestSuitesForTestPlan(tpid)
+#
+#=== 引数
+#
+#+tpid+::
+# テスト計画ID
+#
+#=== 戻り値
+# 例
+# {"name"=>"testsuite1", "id"=>"36"}
+#
+#=== 例外
+#
+#=== 詳細
+#
+# テスト計画IDを渡すとテストスイートの詳細情報を返す
+#  name:テストスイート名
+#  id:自ID
+#
+#=== 例
+#
+# getTestSuitesForTestPlan(tpid) #=>{"name"=>"testsuite1", "id"=>"36"}
+#
+  def getTestSuitesForTestPlan(tpid)
+    args = {"devKey"=>@devKey,"testplanid"=>tpid}     
+    ret = @server.call("tl.getTestSuitesForTestPlan",args)
+  end  
+#
+#=== 概要
+#
+# getTestSuitesForTestPlan(tpid)
+#
+#=== 引数
+#
+#+tpid+::
+# テスト計画ID
+#
+#=== 戻り値
+# 例
+# {"name"=>"testsuite1", "id"=>"36"}
+#
+#=== 例外
+#
+#=== 詳細
+#
+# テスト計画IDを渡すとテストスイートの詳細情報を返す
+#  name:テストスイート名
+#  id:自ID
+#
+#=== 例
+#
+# getTestSuitesForTestPlan(tpid) #=>{"name"=>"testsuite1", "id"=>"36"}
+#
+  def getTestCasesForTestSuite(ts)
+    args = {"devKey"=>@devKey,"testsuiteid"=>ts}     
+    ret = @server.call("tl.getTestCasesForTestSuite",args)
+  end  
+
+  def getTestCasesForTestPlan(tpid)
+    args = {"devKey"=>@devKey,"testplanid"=>tpid}     
+    ret = @server.call("tl.getTestCasesForTestPlan",args)
+  end  
+
+  def getTestCaseIDByName(testcasename,testsuitename = nil)
+    args = {"devKey"=>@devKey,"testcasename"=>testcasename}
+
+    if testsuitename then
+	    args["testsuitename"] = testsuitename
+    end
+
+    ret = @server.call("tl.getTestCaseIDByName",args)
+  end  
+
+  def reportTCResult(tpid,bid,tcid,status)
+    args = {"devKey"=>@devKey,"testcaseid"=>tcid.to_i,"testplanid"=>tpid,"status"=>status,"buildid"=>bid}
+    ret = @server.call("tl.reportTCResult",args)
+  end  
+
+#Hello!
+  def sayHello
+    ret = @server.call("tl.sayHello")
+  end
+
+#You said: message
+  def repeat(message)
+    args = {"str"=>message}
+    ret = @server.call("tl.repeat",args)
+  end
+
+# Testlink API Version: 1.0 Beta 3 written by Asiel Brumfield
+# contribution by TestLink development Team
+  def about
+    ret = @server.call("tl.about")
+  end
+
+######################################
+
+  def getProjectID
+    args = {"devKey"=>@devKey}
+    ret = @server.call("tl.getProjects",args)
+    ret.each{|prj|
+      if prj["active"] == "1" then
+         return prj["id"]
+      end
+    }
+    raise "ProjectID error"
+  end
+
+  def getTestPlanID(pid)
+    args = {"devKey"=>@devKey,"testprojectid"=>pid}     
+    ret = @server.call("tl.getProjectTestPlans",args)
+    ret.each{|tp|
+      tp.each{|id,val|
+        if val["active"] == "1" then
+          return val["id"]
+        end
+      }
+    }
+    raise "TestPlanID error"
+  end
+
+  def getBuildID(tpid)
+    args = {"devKey"=>@devKey,"testplanid"=>tpid}     
+    ret = @server.call("tl.getBuildsForTestPlan",args)
+    ret.each{|val|
+      if val["active"] == "1" then
+        return val["id"]
+      end
+    }
+    raise "BuildID error"
+  end  
+
+  def getTestSuiteID(tpid)
+    args = {"devKey"=>@devKey,"testplanid"=>tpid}     
+    ret = @server.call("tl.getTestSuitesForTestPlan",args)
+  end  
+
+  def reportTCResultByTCName(testcasename,testsuitename,status)
+    pid = getProjectID
+    tpid = getTestPlanID(pid)
+    bid = getBuildID(tpid)
+    ret = getTestCaseIDByName(testcasename,testsuitename)
+    tcInfo = ret[0]
+    tcid = tcInfo["id"]
+    ret = reportTCResult(tpid,bid,tcid,status)
+  end
+end
+ 

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification 
+name: TestLinkClient
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- SADAHIKO Hantani
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-12 00:00:00 +09:00
+default_executable: 
+dependencies: []
+
+description: 
+email: garyohosu@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/TestLinkClient.rb
+has_rdoc: false
+homepage: http://ruby.g.hatena.ne.jp/garyo/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 0.9.5
+signing_key: 
+specification_version: 2
+summary: TestLink XMLRPC Client
+test_files: []
+