prepare release v0.4.7

Author: Luiko Czub

CHANGES.rst

@@ -1,8 +1,8 @@
 Changes in TestLink-API-Python-client Source Distribution
 =========================================================
 
-TestLink-API-Python-client UNDER DEVELOP v0.4.7
------------------------------------------------
+TestLink-API-Python-client release notes v0.4.7 (Jan. 2014)
+-----------------------------------------------------------
 
 new service methods - copy test cases #17
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -17,22 +17,34 @@ Example::
 
  >>> import testlink
  >>> tls = testlink.TestLinkHelper().connect(testlink.TestlinkAPIClient)
- >>> tc_info = tls.getTestCase(None, testcaseexternalid='NPROAPI3-2')
- [{'full_tc_external_id': 'NPROAPI3-2', ..., 'id': '5440',  'version': '2',  
-   'testsuite_id': '5415', 'tc_external_id': '2','testcase_id': '5425', ...}]
+ >>> tc_info = tls.getTestCase(None, testcaseexternalid='NPROAPI-3')
+ [{'full_tc_external_id': 'NPROAPI-3', ..., 'id': '5440',  'version': '2',  
+   'testsuite_id': '5415', 'tc_external_id': '3','testcase_id': '5425', ...}]
  >>> tls.copyTCnewTestCase(tc_info[0]['testcase_id'], testsuiteid=newSuiteID, 
                                           testcasename='a new test case name')
                                           
 Known limitations:
+
 - estimatedexecduration settings are not copied                                          
 
 implement missing 1.9.8 api methods - TestCase #11
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+new TestlinkAPIGeneric and TestlinkAPIClient api methods to modify test cases
+
 - addTestCaseToTestPlan, updateTestCase 
 - createTestCaseSteps, deleteTestCaseSteps
 
+Known TL 1.9.9 limitations:
+
+- 6109 createTestCaseSteps with action 'update' does not change existing steps
+- 6108 createTestCaseSteps creates steps without test case references
+- 6102 updateTestCase returns debug informations 
+- 6101 updateTestCase does not set modification timestamp
+
 implement missing 1.9.8 api methods - Attachments #13
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+new TestlinkAPIGeneric and TestlinkAPIClient api methods to upload attachments
+
 - uploadRequirementSpecificationAttachment, uploadRequirementAttachment
 - uploadTestProjectAttachment, uplodTestSuiteAttachment
 - uploadTestCaseAttachment
@@ -46,9 +58,15 @@ TestLink-API-Python-client is now installable via PyPI #15
 
 new api methods for Platforms implemented #10
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+new TestlinkAPIGeneric and TestlinkAPIClient api methods to handle platforms
+
 - createPlatform, getProjectPlatforms
 - addPlatformToTestPlan, removePlatformFromTestPlan
 
+Known TL 1.9.9 limitations:
+
+- 6076 addPlatformToTestPlan creates invalid platform links
+
 TestLink-API-Python-client release notes v0.4.5 (Nov. 2013)
 -----------------------------------------------------------
 

README.rst

@@ -19,14 +19,14 @@ TestLink-API-Python-client delivers two main classes
 - TestlinkAPIGeneric - Implements the TestLink API methods as generic PY methods
   with error handling
 - TestlinkAPIClient - Inherits from TestlinkAPIGeneric and defines service 
-  methods like "countProjects".
+  methods like "copyTCnewVersion".
 
 and the helper class
 
 - TestLinkHelper - search connection parameter from environment variables and 
   command line arguments
 
-How to talk with TestLink in a python shell: ::
+How to talk with TestLink in a python shell and copy a test case: ::
 
  set TESTLINK_API_PYTHON_SERVER_URL=http://[YOURSERVER]/testlink/lib/api/xmlrpc/v1/xmlrpc.php
  set TESTLINK_API_PYTHON_DEVKEY=[Users devKey generated by TestLink]
@@ -36,14 +36,11 @@ How to talk with TestLink in a python shell: ::
  >>> tls = testlink.TestLinkHelper().connect(testlink.TestlinkAPIClient)
  >>> tls.countProjects()
  3
-
- >>> tc_info = tls.getTestCase(None, testcaseexternalid='NPROAPI3-2')
- [{'full_tc_external_id': 'NPROAPI3-2', ..., 'id': '5440',  'version': '2',  
-   'testsuite_id': '5415', 'tc_external_id': '2','testcase_id': '5425', ...}]
-
+ >>> tc_info = tls.getTestCase(None, testcaseexternalid='NPROAPI-3')
+ [{'full_tc_external_id': 'NPROAPI-3', ..., 'id': '5440',  'version': '2',  
+   'testsuite_id': '5415', 'tc_external_id': '3','testcase_id': '5425', ...}]
  >>> tls.copyTCnewTestCase(tc_info[0]['testcase_id'], testsuiteid=newSuiteID, 
                                           testcasename='a new test case name')
- 
  >>> print tls.whatArgs('createTestPlan')
  createTestPlan(<testplanname>, <testprojectname>, [note=<note>], [active=<active>], 
                 [public=<public>], [devKey=<devKey>])

doc/install.rst

@@ -23,8 +23,8 @@ Create the user specific devKey inside TestLink, see
 Installing from PyPI
 --------------------
 
-TestLink-API-Python-client will be available in the Python Package Index (PyPI_) 
-with Release v0.4.6. It is recommended that you use `pip`_ to install. 
+TestLink-API-Python-client is available in the Python Package Index (PyPI_) 
+since Release v0.4.6. It is recommended that you use `pip`_ to install. 
 
 Install from PyPI using pip by running::
 

doc/usage.rst

@@ -23,7 +23,8 @@ Ask the TestLink API Client, what arguments a API method expects: ::
  tlh = testlink.TestLinkHelper()
  tls = tlh.connect(testlink.TestlinkAPIClient)
  print tls.whatArgs('createTestPlan')
- > createTestPlan(<testplanname>, <testprojectname>, [note=<note>], [active=<active>], [public=<public>], [devKey=<devKey>])
+ > createTestPlan(<testplanname>, <testprojectname>, [note=<note>], [active=<active>], 
+                  [public=<public>], [devKey=<devKey>])
  >  create a test plan 
 
 or generate a description of all implemented API method: ::
@@ -34,8 +35,40 @@ or generate a description of all implemented API method: ::
  for m in testlink.testlinkargs._apiMethodsArgs.keys():
  	print tls.whatArgs(m), '\n'
 
+Copy test cases
+---------------
 
-Run Examples
+Copy an existing test case into another test suite with changed name::
+
+ >>> import testlink
+ >>> tls = testlink.TestLinkHelper().connect(testlink.TestlinkAPIClient)
+ >>> tc_info = tls.getTestCase(None, testcaseexternalid='NPROAPI-3')
+ [{'full_tc_external_id': 'NPROAPI-3', ..., 'id': '5440',  'version': '2',  
+   'testsuite_id': '5415', 'tc_external_id': '3','testcase_id': '5425', ...}]
+ >>> tls.copyTCnewTestCase(tc_info[0]['testcase_id'], testsuiteid=newSuiteID, 
+                                          testcasename='a new test case name')
+                                          
+Create a new test case version with changed summary and importance::
+                                          
+ >>> import testlink
+ >>> tls = testlink.TestLinkHelper().connect(testlink.TestlinkAPIClient)
+ >>> tc_info = tls.getTestCase(None, testcaseexternalid='NPROAPI-3')
+ [{'full_tc_external_id': 'NPROAPI-3', ..., 'id': '5440',  'version': '2',  
+   'testsuite_id': '5415', 'tc_external_id': '3','testcase_id': '5425', ...}]
+ >>> tls.copyTCnewVersion(tc_info[0]['testcase_id'], summary='new summary', 
+                                                     importance='1')
+                                                      
+Default is, that the last version of a test case is used for the copy. 
+If a different version should be used, specify the required version as second 
+argument. Examples::
+
+ >>> tls.copyTCnewTestCase(tc_info[0]['testcase_id'], 1, testsuiteid=newSuiteID, 
+                                          testcasename='a new test case name')
+ >>> tls.copyTCnewVersion(tc_info[0]['testcase_id'], 1, summary='new summary', 
+                                                        importance='1')
+                                                       
+
+Run examples
 ------------
 
 Running example, how to use the class TestlinkAPIClient, with connection 

setup.py

@@ -31,14 +31,14 @@
 - TestlinkAPIGeneric - Implements the TestLink API methods as generic PY methods
   with error handling
 - TestlinkAPIClient - Inherits from TestlinkAPIGeneric and defines service 
-  methods like "countProjects".
+  methods like "copyTCnewVersion".
 
 and the helper class
 
 - TestLinkHelper - search connection parameter from environment variables and 
   command line arguments
   
-How to talk with TestLink in a python shell: ::
+How to talk with TestLink in a python shell and copy a test case: ::
 
  set TESTLINK_API_PYTHON_SERVER_URL=http://[YOURSERVER]/testlink/lib/api/xmlrpc/v1/xmlrpc.php
  set TESTLINK_API_PYTHON_DEVKEY=[Users devKey generated by TestLink]
@@ -47,10 +47,14 @@
  >>> tls = testlink.TestLinkHelper().connect(testlink.TestlinkAPIClient)
  >>> tls.countProjects()
  3
- >>> tls.getTestCase(None, testcaseexternalid='NPROAPI3-1')
- [{'full_tc_external_id': 'NPROAPI3-1', 'node_order': '0', 'is_open': '1', 'id': '2757', ...}]
+ >>> tc_info = tls.getTestCase(None, testcaseexternalid='NPROAPI-3')
+ [{'full_tc_external_id': 'NPROAPI-3', ..., 'id': '5440',  'version': '2',  
+   'testsuite_id': '5415', 'tc_external_id': '3','testcase_id': '5425', ...}]
+ >>> tls.copyTCnewTestCase(tc_info[0]['testcase_id'], testsuiteid=newSuiteID, 
+                                          testcasename='a new test case name')
  >>> print tls.whatArgs('createTestPlan')
- createTestPlan(<testplanname>, <testprojectname>, [note=<note>], [active=<active>], [public=<public>], [devKey=<devKey>])
+ createTestPlan(<testplanname>, <testprojectname>, [note=<note>], [active=<active>], 
+                [public=<public>], [devKey=<devKey>])
    create a test plan 
 
 More information about this library can be found on the Wiki_ 

src/testlink/testlinkapi.py

@@ -1,7 +1,7 @@
 #! /usr/bin/python
 # -*- coding: UTF-8 -*-
 
-#  Copyright 2011-2013 Olivier Renault, James Stock, TestLink-API-Python-client developers
+#  Copyright 2011-2013 Luiko Czub, Olivier Renault, James Stock, TestLink-API-Python-client developers
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -41,7 +41,7 @@ class TestlinkAPIClient(TestlinkAPIGeneric):
     """   
 
     __slots__ = ['stepsList']
-    __author__ = 'Olivier Renault, James Stock, TestLink-API-Python-client developers'
+    __author__ = 'Luiko Czub, Olivier Renault, James Stock, TestLink-API-Python-client developers'
 
     def __init__(self, server_url, devKey):
         """ call super for init generell slots, init sepcial slots for teststeps