TestLinkClient 0.0.2 → 0.0.3

data/lib/TestLinkClient.rb

@@ -3,6 +3,13 @@ require 'xmlrpc/client'
 # Author:: Sadahiko Hantani (garyohosu@gmail.com)
 # Copyright:: Copyright (c) 2008 Sadahiko Hantani
 # License::   Distributes under GPL
+# 
+# ���藚��
+#- 0.01 2008/12/14 �V�K�쐬
+#- 0.02 2008/12/15 �擪�Ƀo�C�i���������Ă����̂ŏC��
+#- 0.03 2008/12/15 �R�����g��lj�
+# 
+
 
 class TestLinkClient
 #
@@ -46,6 +53,61 @@ class TestLinkClient
     @devKey = dev_key
   end
 
+
+#
+#=== �T�v
+#
+# reportTCResult(tpid,tcid,status,bid,notes,guess)
+#
+#=== ����
+#
+#+tpid+::
+# �e�X�g�v��ID
+#+tcid+::
+# �e�X�g�P�[�XID
+#+status+::
+# �e�X�g����  p:���� f:���s b:�u���b�N
+#+bid+::
+# �r���hID(�I�v�V����)
+#+notes+::
+# �m�[�g(�I�v�V����)
+#+guess+::
+# (�I�v�V����)
+#
+#=== �߂�l
+# ��
+# [{"message"=>"Success!", "status"=>true, "id"=>"2"}]
+#
+#=== ��O
+#
+#=== �ڍ�
+#
+# �e�X�g���ʂ�o�^����
+#
+#  message:���b�Z�[�W
+#  id:ID
+#  status:true ���� false ���s
+#
+#=== ��
+#
+# reportTCResult(tpid,bid,tcid,status) #=>[{"message"=>"Success!", "status"=>true, "id"=>"2"}]
+#
+  def reportTCResult(tpid,tcid,status,bid=nil,notes=nil,guess=nil)
+
+    args = {"devKey"=>@devKey,"testcaseid"=>tcid.to_i,"testplanid"=>tpid,"status"=>status,"buildid"=>bid}
+
+    if bid then
+      args["buildid"] = bid
+    end
+    if notes then #string
+      args["notes"] = notes
+    end
+    if guess then #bool
+      args["guess"] = guess
+    end
+    ret = @server.call("tl.reportTCResult",args)
+  end
+
 #
 #=== �T�v
 #
@@ -120,6 +182,46 @@ class TestLinkClient
     ret = @server.call("tl.getProjectTestPlans",args)
   end
 
+
+#
+#=== �T�v
+#
+# createBuild(testplanid,buildname,buildnotes)
+#
+#=== ����
+#
+#+testplanid+::
+# �e�X�g�v��ID
+#+buildname+::
+# �r���h��
+#+buildnotes+::
+# �r���h�m�[�g
+#
+#=== �߂�l
+# ��
+# [{"message"=>"Success!", "status"=>true, "id"=>"4"}]
+#
+#=== ��O
+#
+#=== �ڍ�
+#
+# �e�X�g�v���W�F�N�gID,�r���h���A�r���h�m�[�g��n���ƐV�K�r���h�𐶐�����
+#  -   :�r���hID
+#  name:�r���h��
+#  notes:�m�[�g
+#  id:�r���hID
+#  testproject_id:�e�X�g�v���W�F�N�gID
+#  active:�A�N�e�B�u���H
+#
+#=== ��
+#
+# createBuild(testplanid,buildname,buildnotes) #=>[{"message"=>"Success!", "status"=>true, "id"=>"2"}]
+#
+  def createBuild(testplanid,buildname,buildnotes)
+    args = {"devKey"=>@devKey,"testplanid"=>testplanid,"buildname"=>buildname,"buildnotes"=>buildnotes}     
+    ret = @server.call("tl.createBuild",args)
+  end
+
 #
 #=== �T�v
 #
@@ -188,12 +290,14 @@ class TestLinkClient
 #
 #=== �T�v
 #
-# getTestSuitesForTestPlan(tpid)
+# getTestCasesForTestSuite(tsid)
 #
 #=== ����
 #
-#+tpid+::
-# �e�X�g�v��ID
+#+tsid+::
+# �e�X�g�X�C�[�gID
+#+deep+::
+# �ċA�I�������s��(�I�v�V����) �f�t�H���g��True
 #
 #=== �߂�l
 # ��
@@ -203,24 +307,128 @@ class TestLinkClient
 #
 #=== �ڍ�
 #
-# �e�X�g�v��ID��n���ƃe�X�g�X�C�[�g�̏ڍ׏���Ԃ�
-#  name:�e�X�g�X�C�[�g��
-#  id:��ID
+# �e�X�g�X�C�[�gID��n���ƃe�X�g�P�[�X�̏ڍ׏���Ԃ�
+#  name:�e�X�g�P�[�X��
+#  id:�e�X�g�P�[�XID
+#  node_type_id:
+#  parent_id:
+#  node_order:
 #
 #=== ��
 #
-# getTestSuitesForTestPlan(tpid) #=>{"name"=>"testsuite1", "id"=>"36"}
+# getTestCasesForTestSuite(tsid) #=>{"name"=>"testsuite1", "id"=>"36"}
 #
-  def getTestCasesForTestSuite(ts)
-    args = {"devKey"=>@devKey,"testsuiteid"=>ts}     
+  def getTestCasesForTestSuite(ts,deep=nil)
+    args = {"devKey"=>@devKey,"testsuiteid"=>ts}
+
+    if deep then #
+      args["deep"] = deep
+    end
+
     ret = @server.call("tl.getTestCasesForTestSuite",args)
   end  
 
-  def getTestCasesForTestPlan(tpid)
-    args = {"devKey"=>@devKey,"testplanid"=>tpid}     
+#
+#=== �T�v
+#
+# getTestCasesForTestPlan(tpid,tcid,bldid,keyid,execid,assignedto,executestatus)
+#
+#=== ����
+#
+#+tpid+::�e�X�g�v��ID
+#+tcid+::�e�X�g�P�[�XID�i�I�v�V�����j
+#+bldid+::�r���hID�i�I�v�V�����j
+#+keyid+::�L�[ID�i�I�v�V�����j
+#+executed+::�i�I�v�V�����j
+#+assignedto+::�i�I�v�V�����j
+#+executestatus+::�i�I�v�V�����j
+#
+#=== �߂�l
+# ��
+#{"45"=>{"exec_status"=>"n", "status"=>"", "name"=>"testcase1", "assigner_id"=>"", "urgency"=>"2", "exec_id"=>"", "type"=>"", "exec_on_tplan"=>"", "executed"=>"", "external_id"=>"4", "z"=>"100", "tc_id"=>"45", "version"=>"1", "tcversion_id"=>"46", "execution_order"=>"40", "user_id"=>"", "feature_id"=>"19", "tcversion_number"=>"", "testsuite_id"=>"44", "active"=>"1"}, "41"=>{"exec_status"=>"p", "status"=>"", "name"=>"testcase3", "assigner_id"=>"", "urgency"=>"2", "exec_id"=>"42", "type"=>"", "exec_on_tplan"=>"43", "executed"=>"42", "external_id"=>"3", "z"=>"100", "tc_id"=>"41", "version"=>"1", "tcversion_id"=>"42", "execution_order"=>"30", "user_id"=>"", "feature_id"=>"18", "tcversion_number"=>"1", "testsuite_id"=>"36", "active"=>"1"}}
+#=== ��O
+#
+#=== �ڍ�
+#
+# �e�X�g�v��ID��n���ƃe�X�g�P�[�X�̏ڍ׏���Ԃ�
+#  -   :�e�X�g�P�[�XID
+#  exec_status:���s���� p or f or b
+#  status:
+#  name:�e�X�g�P�[�X��
+#  assigner_id:
+#  urgency:
+#  exec_id:
+#  type:
+#  exec_on_tplan:
+#  executed:
+#  external_id:
+#  z:
+#  tc_id:�e�X�g�P�[�XID
+#  version:�e�X�g�P�[�X�o�[�W����
+#  tcversion_id:�e�X�g�P�[�X�o�[�W����ID
+#  execution_order:
+#  user_id:
+#  feature_id:
+#  tcversion_number:
+#  testsuite_id:�e�X�g�X�C�[�gID
+#  active:�A�N�e�B�u���H
+#
+#=== ��
+#
+# getTestCasesForTestPlan(tpid) #=>{"45"=>{"exec_status"=>"n", "status"=>"", "name"=>"testcase1", "assigner_id"=>"", "urgency"=>"2", "exec_id"=>"", "type"=>"", "exec_on_tplan"=>"", "executed"=>"", "external_id"=>"4", "z"=>"100", "tc_id"=>"45", "version"=>"1", "tcversion_id"=>"46", "execution_order"=>"40", "user_id"=>"", "feature_id"=>"19", "tcversion_number"=>"", "testsuite_id"=>"44", "active"=>"1"}, "41"=>{"exec_status"=>"p", "status"=>"", "name"=>"testcase3", "assigner_id"=>"", "urgency"=>"2", "exec_id"=>"42", "type"=>"", "exec_on_tplan"=>"43", "executed"=>"42", "external_id"=>"3", "z"=>"100", "tc_id"=>"41", "version"=>"1", "tcversion_id"=>"42", "execution_order"=>"30", "user_id"=>"", "feature_id"=>"18", "tcversion_number"=>"1", "testsuite_id"=>"36", "active"=>"1"}}
+#
+  def getTestCasesForTestPlan(tpid,tcid=nil,bldid=nil,keyid=nil,executed=nil,assignedto=nil,executestatus=nil)
+    args = {"devKey"=>@devKey,"testplanid"=>tpid}
+    if tcid then
+      args["testcaseid"] = tcid
+    end
+    if bldid then
+      args["buildid"] = bldid
+    end
+    if keyid then
+      args["keywordid"] = keyid
+    end
+    if executed then #boolean
+      args["executed"] = executed
+    end
+    if assignedto then
+      args["assignedto"] = assignedto
+    end
+    if executestatus then #string
+      args["executestatus"] = executestatus
+    end
     ret = @server.call("tl.getTestCasesForTestPlan",args)
   end  
 
+
+#
+#=== �T�v
+#
+# getTestCaseIDByName(testcasename,testsuitename)
+#
+#=== ����
+#
+#+testcasename+::
+# �e�X�g�P�[�X��
+#+testsuitename+::
+# �e�X�g�X�C�[�g��(�I�v�V����)
+#
+#=== �߂�l
+# ��
+# {"name"=>"testsuite1", "id"=>"36"}
+#
+#=== ��O
+#
+#=== �ڍ�
+#
+# �e�X�g�P�[�X���A�e�X�g�X�C�[�g����n���ƃe�X�g�P�[�XID��Ԃ�
+#  name:�e�X�g�P�[�X��
+#  id:�e�X�g�P�[�XID
+#
+#=== ��
+#
+# getTestCaseIDByName(tsid) #=>[{"name"=>"testcase1", "id"=>"37"}]
+#
   def getTestCaseIDByName(testcasename,testsuitename = nil)
     args = {"devKey"=>@devKey,"testcasename"=>testcasename}
 
@@ -230,31 +438,192 @@ class TestLinkClient
 
     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)
+#
+#=== �T�v
+#
+# createTestCase()
+#
+#=== ����
+#
+#=== �߂�l
+#
+#=== ��O
+#
+#=== �ڍ�
+#
+# �e�X�g�P�[�X�����쐬����(������)
+#
+#=== ��
+#
+# createTestCase() #=>
+#
+  def createTestCase()#������
+    args = {"devKey"=>@devKey}
+    ret = @server.call("tl.createTestCase",args)
+  end
+#
+#=== �T�v
+#
+# createTestProject()
+#
+#=== ����
+#
+#=== �߂�l
+#
+#=== ��O
+#
+#=== �ڍ�
+#
+# �e�X�g�v���W�F�N�g���쐬����(������(�����s��))
+#
+#=== ��
+#
+# createTestProject() #=>
+#
+  def createTestProject()#�����s��
+    args = {"devKey"=>@devKey}
+    ret = @server.call("tl.createTestProject",args)
   end  
+#
+#=== �T�v
+#
+# getTestCaseCustomFieldDesignValue()
+#
+#=== ����
+#
+#=== �߂�l
+#
+#=== ��O
+#
+#=== �ڍ�
+#
+# �J�X�^���t�B�[���h�̒l�𓾂�(�g�p���@�s��)
+#
+#=== ��
+#
+# getTestCaseCustomFieldDesignValue() #=>
+#
+  def getTestCaseCustomFieldDesignValue()
+    args = {"devKey"=>@devKey}
+    ret = @server.call("tl.getTestCaseCustomFieldDesignValue",args)
+  end  
+
+#
+#=== �T�v
+#
+# about()
+#
+#=== ����
+#
+#    �Ȃ�
+#
+#=== �߂�l
+#
+# "Testlink API Version: 1.0 Beta 3 written by Asiel Brumfield\n contribution by TestLink development Team"
+#
+#=== ��O
+#
+#=== �ڍ�
+#
+# Testlink API�̏�񂪕Ԃ�
+#
+#=== ��
+#
+# about() #=>Testlink API Version: 1.0 Beta 3 written by Asiel Brumfield\n contribution by TestLink development Team
+#
+  def about
+    ret = @server.call("tl.about")
+  end
 
-#Hello!
+#
+#=== �T�v
+#
+# sayHello()
+#
+#=== ����
+#
+#    �Ȃ�
+#
+#=== �߂�l
+#
+# "Hello!"
+#
+#=== ��O
+#
+#=== �ڍ�
+#
+# "Hello!"���Ԃ�
+# ����m�F�p
+#
+#=== ��
+#
+# sayHello() #=>"Hello!"
+#
   def sayHello
     ret = @server.call("tl.sayHello")
   end
 
+#
+#=== �T�v
+#
+# repeat(message)
+#
+#=== ����
+#
+#+message+::
+# ���b�Z�[�W
+#
+#=== �߂�l
+#
+# "You said: xxxxx"
+#
+#=== ��O
+#
+#=== �ڍ�
+#
+# ���M�������b�Z�[�W��Ԃ�
+# ����m�F�p
+#
+#=== ��
+#
+# repeat("message") #=>"You said: message"
+#
 #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
 
 ######################################
+#
+#  �ȉ��Ǝ��֐�
+#
+######################################
+
+
 
+#
+#=== �T�v
+#
+# getProjectID
+#
+#=== ����
+#
+# �Ȃ�
+#
+#=== �߂�l
+#
+# �ŏ��Ɍ��‚������A�N�e�B�u�ȃe�X�g�v���W�F�N�gID
+# �� 3
+#
+#=== �ڍ�
+#
+# �ŏ��Ɍ��‚������A�N�e�B�u�ȃe�X�g�v���W�F�N�gID���Ԃ�܂�
+#
+#=== ��
+# getProjectID #=>3
+#
   def getProjectID
     args = {"devKey"=>@devKey}
     ret = @server.call("tl.getProjects",args)
@@ -266,8 +635,30 @@ class TestLinkClient
     raise "ProjectID error"
   end
 
+#
+#=== �T�v
+#
+# getTestPlanID(pid)
+#
+#=== ����
+#
+#+pid+::
+# �e�X�g�v���W�F�N�gID
+#
+#=== �߂�l
+#
+# �ŏ��Ɍ��‚������A�N�e�B�u�ȃe�X�g�v��ID
+# �� 3
+#
+#=== �ڍ�
+#
+# �ŏ��Ɍ��‚������A�N�e�B�u�ȃe�X�g�v��ID���Ԃ�܂�
+#
+#=== ��
+# getTestPlanID(3) #=>4
+#
   def getTestPlanID(pid)
-    args = {"devKey"=>@devKey,"testprojectid"=>pid}     
+    args = {"devKey"=>@devKey,"testprojectid"=>pid}
     ret = @server.call("tl.getProjectTestPlans",args)
     ret.each{|tp|
       tp.each{|id,val|
@@ -279,6 +670,28 @@ class TestLinkClient
     raise "TestPlanID error"
   end
 
+#
+#=== �T�v
+#
+# getBuildID(tpid)
+#
+#=== ����
+#
+#+tpid+::
+# �e�X�g�v��ID
+#
+#=== �߂�l
+#
+# �ŏ��Ɍ��‚������A�N�e�B�u�ȃr���hID
+# �� 3
+#
+#=== �ڍ�
+#
+# �ŏ��Ɍ��‚������A�N�e�B�u�ȃr���hID���Ԃ�܂�
+#
+#=== ��
+# getBuildID(tpid) #=>4
+#
   def getBuildID(tpid)
     args = {"devKey"=>@devKey,"testplanid"=>tpid}     
     ret = @server.call("tl.getBuildsForTestPlan",args)
@@ -290,11 +703,32 @@ class TestLinkClient
     raise "BuildID error"
   end  
 
-  def getTestSuiteID(tpid)
-    args = {"devKey"=>@devKey,"testplanid"=>tpid}     
-    ret = @server.call("tl.getTestSuitesForTestPlan",args)
-  end  
-
+#
+#=== �T�v
+#
+# reportTCResultByTCName(testcasename,testsuitename,status)
+#
+#=== ����
+#
+#+testcasename+::
+# �e�X�g�P�[�X��
+#+testsuitename+::
+# �e�X�g�X�C�[�g��
+#+status+::
+#  �e�X�g���� p:���� f:���s b:�u���b�N
+#
+#=== �߂�l
+#
+# �����E���s��Ԃ�
+# �� [{"message"=>"Success!", "status"=>true, "id"=>"1638"}]
+#
+#=== �ڍ�
+#
+# �e�X�g�P�[�X���y�уe�X�g�X�C�[�g���Ŏw�肵���e�X�g�P�[�X�Ɏ������ʂ�o�^����
+#
+#=== ��
+# reportTCResultByTCName(testcasename,testsuitename,"p") #=>[{"message"=>"Success!", "status"=>true, "id"=>"1638"}]
+#
   def reportTCResultByTCName(testcasename,testsuitename,status)
     pid = getProjectID
     tpid = getTestPlanID(pid)
@@ -302,7 +736,7 @@ class TestLinkClient
     ret = getTestCaseIDByName(testcasename,testsuitename)
     tcInfo = ret[0]
     tcid = tcInfo["id"]
-    ret = reportTCResult(tpid,bid,tcid,status)
+    ret = reportTCResult(tpid,tcid,status,bid)
   end
 end
- 
+ 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: TestLinkClient
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - SADAHIKO Hantani