refactor ProxiedTransport - first draft to fix #127

two separate transport classes, one for py27 support other for py3x

Author: Luiko Czub

src/testlink/proxiedtransport.py

@@ -0,0 +1,43 @@
+#! /usr/bin/python
+# -*- coding: UTF-8 -*-
+
+#  Copyright 2014-2020 Mario Benito, Luiko Czub, 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.
+#  You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+# ------------------------------------------------------------------------
+# XMLRPC ProxiedTransport for Py27 as described in 
+# https://docs.python.org/2.7/library/xmlrpclib.html#example-of-client-usage
+# ------------------------------------------------------------------------
+
+import xmlrpclib, httplib
+
+class ProxiedTransport(xmlrpclib.Transport):
+    ''' XMLRPC ProxiedTransport for Py27 as described in 
+        https://docs.python.org/2.7/library/xmlrpclib.html#example-of-client-usage 
+    '''
+    
+    def set_proxy(self, proxy):
+        self.proxy = proxy
+
+    def make_connection(self, host):
+        self.realhost = host
+        h = httplib.HTTPConnection(self.proxy)
+        return h
+
+    def send_request(self, connection, handler, request_body):
+        connection.putrequest("POST", 'http://%s%s' % (self.realhost, handler))
+
+    def send_host(self, connection, host):
+        connection.putheader('Host', self.realhost)
+

src/testlink/proxiedtransport2.py

@@ -0,0 +1,46 @@
+#! /usr/bin/python
+# -*- coding: UTF-8 -*-
+
+#  Copyright 2020 Luiko Czub, 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.
+#  You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+# ------------------------------------------------------------------------
+
+from http.client import HTTPConnection
+from xmlrpc.client import Transport
+from urllib.parse import urlparse, urlunparse
+
+class ProxiedTransport(Transport):
+    ''' XMLRPC ProxiedTransport for Py37+ as described in 
+        https://docs.python.org/3.8/library/xmlrpc.client.html#example-of-client-usage
+    '''
+    
+    def set_proxy(self, host, port=None, headers=None):
+        ''' if host includes a port definition (e.g. http://myHost:1111) 
+            this will be used instead the optional PORT arg
+        '''
+        
+        u1 = urlparse(host)
+        uport  = u1.port
+        u2 = u1._replace(netloc=u1.hostname)
+        uhost  = urlunparse(u2)
+
+        self.proxy = uhost, uport or port
+        self.proxy_headers = headers
+
+    def make_connection(self, host):
+        connection = HTTPConnection(*self.proxy)
+        connection.set_tunnel(host, headers=self.proxy_headers)
+        self._connection = host, connection
+        return connection

src/testlink/proxiedtransport3.py

@@ -21,15 +21,15 @@
 IS_PY3 = sys.version_info[0] > 2
 if not IS_PY3:
     # importing required py2 modules
-    import xmlrpclib
+    import xmlrpclib as xmlrpc_client
     # in py 3 encodestring is deprecated and an alias for encodebytes
     # see issue #39 and compare py2 py3 doc 
     # https://docs.python.org/2/library/base64.html#base64.encodestring
     # https://docs.python.org/3/library/base64.html#base64.encodebytes
     from base64 import encodestring as encodebytes
 else:
     # importing required py3 modules
-    import xmlrpc.client as xmlrpclib
+    import xmlrpc.client as xmlrpc_client
     from base64 import encodebytes
 
 from platform import python_version    
@@ -68,9 +68,7 @@ def __init__(self, server_url, devKey, **args):
         allow_none=args.get('allow_none',False)
         use_datetime = args.get('use_datetime', False)
         context = args.get('context', None)
-        # named arg context is used, cause in Py36 it is place in a different 
-        # order as in Py27 and Py35
-        self.server = xmlrpclib.Server(server_url, transport, encoding,
+        self.server = xmlrpc_client.ServerProxy(server_url, transport, encoding,
                                        verbose, allow_none, use_datetime, 
                                        context=context)
         self.devKey = devKey
@@ -2070,11 +2068,11 @@ def _callServer(self, methodNameAPI, argsAPI=None):
                 response = getattr(self.server.tl, methodNameAPI)()
             else:
                 response = getattr(self.server.tl, methodNameAPI)(argsAPI)
-        except (IOError, xmlrpclib.ProtocolError) as msg:
+        except (IOError, xmlrpc_client.ProtocolError) as msg:
             new_msg = 'problems connecting the TestLink Server %s\n%s' %\
             (self._server_url, msg) 
             raise testlinkerrors.TLConnectionError(new_msg)
-        except xmlrpclib.Fault as msg:
+        except xmlrpc_client.Fault as msg:
             new_msg = 'problems calling the API method %s\n%s' %\
             (methodNameAPI, msg) 
             raise testlinkerrors.TLAPIError(new_msg)

src/testlink/testlinkapigeneric.py

@@ -1,7 +1,7 @@
 #! /usr/bin/python
 # -*- coding: UTF-8 -*-
 
-#  Copyright 2012-2019 Luiko Czub, TestLink-API-Python-client developers
+#  Copyright 2012-2020 Luiko Czub, 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.
@@ -17,11 +17,17 @@
 #
 # ------------------------------------------------------------------------
 
-import os
+import os, sys
 from argparse import ArgumentParser
 from .version import VERSION
 import ssl
 
+IS_PY3 = sys.version_info[0] > 2
+if IS_PY3:
+    from .proxiedtransport3 import ProxiedTransport
+else:
+    from .proxiedtransport2 import ProxiedTransport
+
 class TestLinkHelper(object):
     """ Helper Class to find out the TestLink connection parameters.
     a) TestLink Server URL of XML-RPC
@@ -131,7 +137,6 @@ def setParamsFromArgs(self, usage=DEFAULT_DESCRIPTION, args=None):
     def _getProxiedTransport(self):
         """ creates and return a ProxiedTransport with self._proxy settings """
 
-        from .proxiedtransport import ProxiedTransport
         a_pt = ProxiedTransport()
         a_pt.set_proxy(self._proxy)
         return a_pt

src/testlink/testlinkhelper.py

@@ -1,7 +1,7 @@
 #! /usr/bin/python
 # -*- coding: UTF-8 -*-
 
-#  Copyright 2013-2019 TestLink-API-Python-client developers
+#  Copyright 2013-2020 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.
@@ -17,5 +17,5 @@
 #
 # ------------------------------------------------------------------------
 
-VERSION = '0.8.1-fix131'
+VERSION = '0.8.1-fix127'
 TL_RELEASE = '1.9.20-fixed'

src/testlink/version.py

@@ -1,7 +1,7 @@
 #! /usr/bin/python
 # -*- coding: UTF-8 -*-
 
-#  Copyright 2018-2019 Luiko Czub, TestLink-API-Python-client developers
+#  Copyright 2018-2020 Luiko Czub, 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.
@@ -25,7 +25,7 @@
 #from conftest import api_general_client, api_generic_client
 
 def test_IS_PY3_same_state():
-    from testlink.proxiedtransport import IS_PY3 as proxie_is_py3
+    from testlink.testlinkhelper import IS_PY3 as proxie_is_py3
     from testlink.testlinkapigeneric import IS_PY3 as tl_is_py3
     assert proxie_is_py3 == tl_is_py3
 

test/utest-offline/test_py3_vs_py2.py

@@ -21,7 +21,8 @@
 # this test works WITHOUT an online TestLink Server
 # no calls are send to a TestLink Server
 
-import pytest
+import pytest, sys
+IS_PY3 = sys.version_info[0] > 2
 
 class DummyTestLinkAPI(object):
     """ Dummy for Simulation TestLinkAPICLient. 
@@ -140,22 +141,50 @@ def test_connect(api_helper_class):
     assert 'DEVKEY-51' == a_tl_api.devKey
     assert {} == a_tl_api.args
 
-def test_getProxiedTransport(api_helper_class):
-    """ create a ProxiedTransportTestLink API dummy """
-    a_helper = api_helper_class('SERVER-URL-61', 'DEVKEY-61', 'PROXY-61')
+def test_getProxiedTransport_py2(api_helper_class):
+    """ create a TestLink Helper with ProxiedTransport - py27 """
+    if IS_PY3:
+        pytest.skip("py27 specific test")
+        
+    a_helper = api_helper_class('SERVER-URL-611', 'DEVKEY-611', 'PROXY-611:8080')
                                    #'http://fast.proxy.com.de/')
     a_pt = a_helper._getProxiedTransport()
     assert 'ProxiedTransport' == a_pt.__class__.__name__
-    assert 'PROXY-61' == a_pt.proxy
+    assert 'PROXY-611:8080' == a_pt.proxy
 
+def test_getProxiedTransport_py3(api_helper_class):
+    """ create a TestLink Helper with ProxiedTransport - py3x """
+
+    if not IS_PY3:
+        pytest.skip("py3 specific test")
+    
+    a_helper = api_helper_class('SERVER-URL-612', 'DEVKEY-612', 'http://PROXY-612:8080')
+                                   #'http://fast.proxy.com.de/')
+    a_pt = a_helper._getProxiedTransport()
+    assert 'ProxiedTransport' == a_pt.__class__.__name__
+    assert ('http://proxy-612', 8080) == a_pt.proxy
 
-def test_connect_with_proxy(api_helper_class):
-    """ create a TestLink API dummy with ProxiedTransport"""
-    a_helper = api_helper_class('SERVER-URL-71', 'DEVKEY-71', 'PROXY-71')
+def test_connect_with_proxy2(api_helper_class):
+    """ create a TestLink API dummy with ProxiedTransport - py27"""
+    if IS_PY3:
+        pytest.skip("py27 specific test")
+
+    a_helper = api_helper_class('SERVER-URL-711', 'DEVKEY-711', 'PROXY-71:8080')
     a_tl_api = a_helper.connect(DummyTestLinkAPI)
-    assert 'SERVER-URL-71' == a_tl_api.server
-    assert 'DEVKEY-71' == a_tl_api.devKey
-    assert 'PROXY-71' == a_tl_api.args['transport'].proxy
+    assert 'SERVER-URL-711' == a_tl_api.server
+    assert 'DEVKEY-711' == a_tl_api.devKey
+    assert 'PROXY-711' == a_tl_api.args['transport'].proxy
+
+def test_connect_with_proxy3(api_helper_class):
+    """ create a TestLink API dummy with ProxiedTransport - py3x"""
+    if not IS_PY3:
+        pytest.skip("py3 specific test")
+    
+    a_helper = api_helper_class('SERVER-URL-712', 'DEVKEY-712', 'https://PROXY-712:8080')
+    a_tl_api = a_helper.connect(DummyTestLinkAPI)
+    assert 'SERVER-URL-712' == a_tl_api.server
+    assert 'DEVKEY-712' == a_tl_api.devKey
+    assert ('https://proxy-712', 8080) == a_tl_api.args['transport'].proxy
 
 def test_connect_ignoring_proxy_env(api_helper_class, monkeypatch):
     """ create a TestLink API dummy ignoring PROXY env - pullRequest #121 """