Merge branch 'master' with Py3 changes into proxy #38

Conflicts:
	CHANGES.rst
	README.rst
	src/testlink/testlinkhelper.py
	src/testlink/version.py

Author: Luiko Czub

.gitignore

@@ -1,3 +1,5 @@
+.tox
+.idea
 .project
 .pydevproject
 .settings/

.travis.yml

@@ -0,0 +1,15 @@
+language: python
+python:
+  - "2.6"
+  - "2.7"
+  - "3.3"
+  - "3.4"
+
+  # command to install dependencies
+install:
+  - if [[ $TRAVIS_PYTHON_VERSION == '2.6' ]]; then pip install unittest2; fi
+  - if [[ $TRAVIS_PYTHON_VERSION == '2.6' ]]; then pip install argparse; fi
+  - pip install .
+
+# command to run tests
+script: py.test test/utest-offline

CHANGES.rst

@@ -1,19 +1,59 @@
 Changes in TestLink-API-Python-client Source Distribution
 =========================================================
 
-PreRelease TestLink-API-Python-client with proxy support
---------------------------------------------------------
+TestLink-API-Python-client v0.6.1 - Under Develop 
+------------------------------------------------------------
 
-Pull Request - Proxy configuration support in TestLinkHelper #36 
+Proxy configuration support in TestLinkHelper - pull request #36 
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Pull Request from Maberi allows proxy configuration using TestLinkHelper.
+Integrates `Maberi <https://github.com/Maberi/TestLink-API-Python-client>`_ 
+pull request `#36 <https://github.com/lczub/TestLink-API-Python-client/pull/36>`_ 
 
-Adds a new --proxy option in command line.
-Recognizes "http_proxy" environment variable.
+- allows easy proxy configuration using TestLinkHelper
+- Adds a new --proxy option in command line.
+- Recognizes "http_proxy" environment variable.
 
 
-TestLink-API-Python-client release notes v0.5.2 (Oct. 2014) 
+TestLink-API-Python-client release notes v0.6.0 (Dec. 2014) 
+------------------------------------------------------------
+
+support for TestLink release 1.9.12 and py26, py27, py33 and py34
+
+python 3 support - pull requests #33 #37
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Integrates `manojklm <https://github.com/manojklm/TestLink-API-Python-client>`_ 
+pull requests 
+`#33 <https://github.com/lczub/TestLink-API-Python-client/pull/33>`_ 
+and `#37 <https://github.com/lczub/TestLink-API-Python-client/pull/37>`_
+
+- add source and unittest support for py33 and py34  
+- extend py26 support for unittest2
+- add *.travis.yml* configuration for `Travis CI <http://docs.travis-ci.com/>`_ 
+- add *tox.ini* configuration for `Tox <http://tox.readthedocs.org>`_  
+
+Track now TestLink-API-Python-client build results on Travis CI - see
+https://travis-ci.org/lczub/TestLink-API-Python-client 
+
+extend upload attachments - handling file path #40
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+uploading attachments excepts now also a file path as parameter. 
+
+still supported 0.5.2 behavior - file descriptor::
+
+ a_file_obj=open(A_VALID_FILE_PATH)
+ newAttachment = myTestLink.uploadExecutionAttachment(a_file_obj, A_Result_ID, 
+                                  'Attachment Title', 'Attachment Description')
+
+new supported 0.6.0 behaviour - file path::
+
+ a_file_path=A_VALID_FILE_PATH
+ newAttachment = myTestLink.uploadExecutionAttachment(a_file_path, A_Result_ID, 
+                                   'Attachment Title', 'Attachment Description')
+
+TestLink-API-Python-client release notes v0.5.2 (Oct. 2014)
 -----------------------------------------------------------
 support for TestLink release 1.9.12
 
@@ -29,7 +69,7 @@ new TestlinkAPIGeneric and TestlinkAPIClient api method
 examples see `<example/TestLinkExample.py>`_  
 
 implement 1.9.12 new api method - getTestCaseBugs #30
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 new TestlinkAPIGeneric and TestlinkAPIClient api method
 
@@ -41,11 +81,11 @@ new TestlinkAPIGeneric and TestlinkAPIClient api method
 examples see `<example/TestLinkExample.py>`_  
 
 TestLink-API-Python-client release notes v0.5.1 (Aug. 2014) 
-------------------------------------------------------------
+-----------------------------------------------------------
 support for TestLink release 1.9.11
 
 implement 1.9.11 api change - getLastExecutionResult #27
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 TestlinkAPIGeneric and TestlinkAPIClient api method getLastExecutionResult() 
 accepts now following additional optional arguments
@@ -59,7 +99,7 @@ example:
   [{ ... , 'tcversion_id': '8929', ... , 'bugs': [{'bug_id': '4711'}], ... }]
 
 implement 1.9.11 new api method - assignTestCaseExecutionTask #26
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 new TestlinkAPIGeneric and TestlinkAPIClient api method
 
@@ -71,7 +111,7 @@ examples see `<example/TestLinkExample.py>`_
 
 
 TestLink-API-Python-client release notes v0.5.0 (Jul. 2014) 
-------------------------------------------------------------
+-----------------------------------------------------------
 support for TestLink release 1.9.10
 
 new service methods - list keywords #25
@@ -111,7 +151,7 @@ accepts now following additional optional arguments (usable with TL >= 1.9.10)
 - parameter getkeywords
 
 implement 1.9.10 api change - reportTCResult #24
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 TestlinkAPIGeneric and TestlinkAPIClient api method reportTCResult() 
 accepts now following additional optional arguments (usable with TL >= 1.9.10) 
@@ -120,7 +160,7 @@ accepts now following additional optional arguments (usable with TL >= 1.9.10)
 
 
 implement missing 1.9.8 api method - CustomField #12
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 new TestlinkAPIGeneric and TestlinkAPIClient api methods
 
@@ -167,7 +207,7 @@ new TestlinkAPIGeneric and TestlinkAPIClient service method to return connection
 - connectionInfo()
 
 implement missing 1.9.8 api method - miscellaneous #14
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 new TestlinkAPIGeneric and TestlinkAPIClient api methods
 

MANIFEST.in

@@ -1,4 +1,4 @@
-include MANIFEST.in LICENSE-2.0.txt README.rst CHANGES.rst
+include MANIFEST.in LICENSE-2.0.txt README.rst CHANGES.rst tox.ini
 recursive-include src *.py
 recursive-include example *.py
 recursive-include example *.png

README.rst

@@ -6,6 +6,12 @@ James Stock, Olivier Renault, Luiko Czub, TestLink-API-Python-client developers
 
 License `Apache License 2.0`_
 
+.. image:: https://travis-ci.org/lczub/TestLink-API-Python-client.svg?branch=proxy
+    :target: https://travis-ci.org/lczub/TestLink-API-Python-client
+    
+.. contents::
+   :local:    
+
 Introduction
 ------------
 
@@ -69,6 +75,10 @@ examples/
 
 tests/
     Unit Tests for TestLink API Python Client
+    
+`tox.ini`_
+    Configuration for multi Python version testing via `Tox`_
+    
 
 Help
 ----
@@ -81,7 +91,7 @@ how existing code can be adapted
 
 TestLink-API-Python-client developers
 -------------------------------------
-*   `James Stock`_, `Olivier Renault`_, `lczub`_
+*   `James Stock`_, `Olivier Renault`_, `lczub`_, `manojklm`_ (PY3)
 *   `g4l4drim`_, `pade`_, `anton-matosov`_, `citizen-stig`_, `charz`_, `Maberi`_
 *   anyone forgotten?
 
@@ -94,6 +104,8 @@ TestLink-API-Python-client developers
 .. _Usage: doc/usage.rst
 .. _TestlinkAPIGeneric: example/TestLinkExampleGenericApi.py
 .. _TestlinkAPIClient: example/TestLinkExample.py
+.. _tox.ini: tox.ini
+.. _Tox: http://tox.readthedocs.org/en/latest/
 .. _Issues: https://github.com/lczub/TestLink-API-Python-client/issues
 .. _Olivier Renault: https://github.com/orenault/TestLink-API-Python-client
 .. _pade: https://github.com/pade/TestLink-API-Python-client
@@ -103,4 +115,5 @@ TestLink-API-Python-client developers
 .. _anton-matosov: https://github.com/anton-matosov/TestLink-API-Python-client
 .. _citizen-stig: https://github.com/citizen-stig/TestLink-API-Python-client
 .. _charz: https://github.com/charz/TestLink-API-Python-client.git
-.. _Maberi: https://github.com/Maberi/TestLink-API-Python-client.git
+.. _manojklm: https://github.com/manojklm/TestLink-API-Python-client
+.. _Maberi: https://github.com/Maberi/TestLink-API-Python-client.git

doc/install.rst

@@ -1,15 +1,18 @@
 TestLink-API-Python-client Installation
 =======================================
 
+.. contents::
+   :local:
+
 Preconditions
 -------------
 
-Currently the combinations Python 2.6.6/2.7.8 and TestLink 1.9.12 are tested.
+Currently the combinations Python 2.6.9/2.7.9/3.3.5/3.4.2 and TestLink 1.9.12 are tested.
 
 - Other combination might work - feedback is welcome :-) 
 
 To use TestLink-API-Python-client under Py26, the module **argparse** must be 
-installed additionally (Py27 already includes this)::
+installed additionally (Py27, Py33 and Py34 already includes this)::
 
     pip install argparse
 
@@ -66,21 +69,21 @@ Check, if Python could talk with TestLink using the connection parameter
 as init parameter::
 
     python
-	>>> import testlink
-	>>> tls = testlink.TestlinkAPIClient(SERVER_URL, DEVKEY)
-	>>> tls.about()
-	' Testlink API Version: 1.0 initially ....'
-	
-or by defining the connection parameter as environment variables::	
-	
+    >>> import testlink
+    >>> tls = testlink.TestlinkAPIClient(SERVER_URL, DEVKEY)
+    >>> tls.about()
+    ' Testlink API Version: 1.0 initially ....'
+
+or by defining the connection parameter as environment variables::
+
     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]
     python
-	>>> import testlink
-	>>> tls = testlink.TestLinkHelper(testlink.TestlinkAPIClient)
-	>>> tls.about()
-	' Testlink API Version: 1.0 initially ....'
-	
+    >>> import testlink
+    >>> tls = testlink.TestLinkHelper(testlink.TestlinkAPIClient)
+    >>> tls.about()
+    ' Testlink API Version: 1.0 initially ....'
+
 Changed SERVER_URL with TestLink 1.9.7
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -108,7 +111,7 @@ with connection parameter as environment variables
 - TESTLINK_API_PYTHON_SERVER_URL and TESTLINK_API_PYTHON_DEVKEY 
 
 
-    
+
 .. _PyPI: https://pypi.python.org/pypi
 .. _pip: http://www.pip-installer.org    
 .. _SourceForge: http://sourceforge.net/projects/testlink-api-python-client/files/latest/download

doc/usage.rst

@@ -1,6 +1,9 @@
 TestLink-API-Python-client Usage
 ================================
 
+.. contents::
+   :local:
+
 How to talk with TestLink in a python shell
 -------------------------------------------
 
@@ -33,7 +36,7 @@ or generate a description of all implemented API method: ::
  tlh = testlink.TestLinkHelper()
  tls = tlh.connect(testlink.TestlinkAPIClient)
  for m in testlink.testlinkargs._apiMethodsArgs.keys():
- 	print tls.whatArgs(m), '\n'
+     print(tls.whatArgs(m), '\n')
 
 Copy test cases
 ---------------
@@ -97,10 +100,28 @@ alternative optional args, default reporter (user for devKey)
  >>> tls = testlink.TestLinkHelper().connect(testlink.TestlinkAPIGeneric)
  >>> exTCID = tls.getTestCase(testcaseid=a_TestCaseID)[0]['full_tc_external_id']
  >>> tls.reportTCResult(a_TestPlanID, 'b', testcaseexternalid=exTCID, 
-                        buildid='a build name', platformname='a platform name') 
+                        buildid='a build name', platformname='a platform name')
 
+Upload attachments
+------------------
+
+uploading attachments can be done in two different ways
+
+with a file descriptor::
+
+ a_file_obj=open(A_VALID_FILE_PATH)
+ newAttachment = myTestLink.uploadExecutionAttachment(a_file_obj, A_Result_ID, 
+                                  'Attachment Title', 'Attachment Description')
+
+
+with a file path::
+
+ a_file_path=A_VALID_FILE_PATH
+ newAttachment = myTestLink.uploadExecutionAttachment(a_file_path, A_Result_ID, 
+                                  'Attachment Title', 'Attachment Description')
+                         
 List keywords
--------------------
+-------------
 
 Using the api method - keywords for all test cases of one test suite
 
@@ -141,6 +162,9 @@ parameter defined as environment variables [2]_: ::
  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]
  python example\TestLinkExampleGenericApi.py
+
+.. [1] TestLinkExample.py creates a new test project NEW_PROJECT_API-[CountProjects+1]. 
+.. [2] TestLinkExampleGenericApi.py creates a new test project PROJECT_API_GENERIC-[CountProjects+1]. 
  
 Run unittests
 -------------
@@ -158,6 +182,8 @@ Run unittests without TestLink Server interaction: ::
  [PYENV]\testlink\Scripts\activate
  cd test\utest
  python -m unittest discover -s test\utest-offline
+ 
+Under Py26, unittest2_ must be used.  
+ 
+.. _unittest2: https://pypi.python.org/pypi/unittest2
 
-.. [1] TestLinkExample.py creates a new test project NEW_PROJECT_API-[CountProjects+1]. 
-.. [2] TestLinkExampleGenericApi.py creates a new test project PROJECT_API_GENERIC-[CountProjects+1]. 

example/Last7DaysTestCases.py

@@ -21,6 +21,7 @@
 # which have been created during the last 7 days
 
 
+from __future__ import print_function
 from testlink import TestlinkAPIClient, TestLinkHelper
 import time
 
@@ -45,8 +46,8 @@ def iterTCasesfromTProject(api, TProjName, date1, date2):
     currentTime = time.localtime() 
     oldTime     = time.localtime(time.time() - 3600 * 24 * 7)
 
-    print '%s test cases created between %s and %s' % \
+    print('%s test cases created between %s and %s' % \
             (projName, time.strftime('%Y-%m-%d', oldTime),  
-             time.strftime('%Y-%m-%d', currentTime))
+             time.strftime('%Y-%m-%d', currentTime)))
     for TCdata in iterTCasesfromTProject(tlapi, projName, oldTime, currentTime):
-        print '  %(name)s %(version)s %(creation_ts)s' % TCdata
+        print('  %(name)s %(version)s %(creation_ts)s' % TCdata)