revert renaming TestlinkAPIClient <- TestLinkAPIClient

Commit f423c7c changed the class name from *TestlinkAPIClient* to 
*TestLinkAPIClient* (small L to BIG L). Cause Python acts case
sensitive, this change has the effect, that existing code will no more
run - it will not find the class anymore. For compatibility reasons this
change is reverted till a decision, if this meaningful change should be
realised.
orenault#2

Author: Luiko Czub

README.md

@@ -49,16 +49,25 @@ python example\TestLinkExample.py
                --devKey [Users devKey generated by TestLink]
 ```
 
-### Run nosetests with environment variables
+### Run unittests with TestLink Server interaction
 
 ```
 [PYENV]\testlink\Scripts\activate
-pip install nosetest
 set TESTLINK_API_PYTHON_SERVER_URL=http://[YOURSERVER]/testlink/lib/api/xmlrpc.php
 set TESTLINK_API_PYTHON_DEVKEY=[Users devKey generated by TestLink]
-nosetests test\test.py
+cd test\utest
+python -m unittest testlinkapicallservertest testlinkapi_online_test
 ```
 
+### Run unittests without TestLink Server interaction
+
+```
+[PYENV]\testlink\Scripts\activate
+cd test\utest
+python -m unittest testlinkhelpertest testlinkapi_offline_test
+```
+
+
 Download
 --------
 

example/TestLinkExample.py

@@ -26,7 +26,7 @@
                                            |   
                                            --- 5 automated test steps
 """                                       
-from testlink import TestLinkAPIClient, TestLinkHelper
+from testlink import TestlinkAPIClient, TestLinkHelper
 import sys
 
 # precondition a)
@@ -42,7 +42,7 @@
 tl_helper.setParamsFromArgs('''Shows how to use the TestLinkAPI.
 => Counts and lists the Projects 
 => Create a new Project with the following structure:''')
-myTestLink = tl_helper.connect(TestLinkAPIClient) 
+myTestLink = tl_helper.connect(TestlinkAPIClient) 
 
 
 NEWPROJECT="NEW_PROJECT_API"

src/testlink/__init__.py

@@ -8,6 +8,6 @@
 
 
 from .testlinkerrors import TestLinkError
-from .testlinkapi import TestLinkAPIClient
+from .testlinkapi import TestlinkAPIClient
 from .testlink import TestLink
 from .testlinkhelper import TestLinkHelper

src/testlink/testlink.py

@@ -6,12 +6,12 @@
 #  Licensed under ???
 #  see https://github.com/orenault/TestLink-API-Python-client/issues/4
 
-from testlinkapi import TestLinkAPIClient, TestLinkHelper
+from testlinkapi import TestlinkAPIClient, TestLinkHelper
 from testlinkerrors import TestLinkError
 from datetime import date
 
 
-class TestLink(TestLinkAPIClient):
+class TestLink(TestlinkAPIClient):
     """
     TestLink API library 
     provide a user friendly library, with more robustness and error management

src/testlink/testlinkapi.py

@@ -12,7 +12,7 @@
 import testlinkerrors
 
 
-class TestLinkAPIClient(object):    
+class TestlinkAPIClient(object):    
 
     __slots__ = ['server', 'devKey', 'stepsList', '_server_url']
 
@@ -554,7 +554,7 @@ def getProjectIDByName(self, projectName):
 
     def __str__(self):
         message = """
-TestLinkAPIClient - class %s - version %s
+TestlinkAPIClient - class %s - version %s
 @author: Olivier Renault, James Stock, TestLink-API-Python-client developers
 """
         return message % (self.__class__.__name__, self.__VERSION__)
@@ -563,7 +563,7 @@ def __str__(self):
 if __name__ == "__main__":
     tl_helper = TestLinkHelper()
     tl_helper.setParamsFromArgs()
-    myTestLink = tl_helper.connect(TestLinkAPIClient)
+    myTestLink = tl_helper.connect(TestlinkAPIClient)
     print myTestLink
     print myTestLink.about()
 

src/testlink/testlinkhelper.py

@@ -22,11 +22,11 @@ class TestLinkHelper(object):
        default value        - 42 
        command line arg     - devKey
        
-    Examples 1 - init TestLinkAPIClient with environment variables 
+    Examples 1 - init TestlinkAPIClient with environment variables 
     - define connection parameters in environment variables 
       TESTLINK_API_PYTHON_DEVKEY and TESTLINK_API_PYTHON_DEVKEY
-    - TestLinkHelper().connect(TestLinkAPIClient) 
-      -> returns a TestLinkAPIClient instance
+    - TestLinkHelper().connect(TestlinkAPIClient) 
+      -> returns a TestlinkAPIClient instance
       
     Examples 2 - init TestLink with command line arguments 
     - call python module with command line arguments --server_url and --devKey 

test/utest/testlinkapi_offline_test.py

@@ -10,7 +10,7 @@
 # no calls are send to a TestLink Server
 
 import unittest
-from testlink import TestLinkAPIClient, TestLinkHelper
+from testlink import TestlinkAPIClient, TestLinkHelper
 
 # scenario_a includes response from a testlink 1.9.3 server
 SCENARIO_A = {'getProjects' : [
@@ -73,7 +73,7 @@
               'getBuildsForTestPlan' : {'22' : ''}
               }
 
-class DummyAPIClient(TestLinkAPIClient):
+class DummyAPIClient(TestlinkAPIClient):
     """ Dummy for Simulation TestLinkAPICLient. 
     Overrides _callServer() Method to return test scenarios
     """
@@ -104,7 +104,7 @@ def _callServer(self, methodAPI, argsAPI=None):
 
 
 class TestLinkAPIOfflineTestCase(unittest.TestCase):
-    """ TestCases for TestLinkAPIClient - does not interacts with a TestLink Server.
+    """ TestCases for TestlinkAPIClient - does not interacts with a TestLink Server.
     works with DummyAPIClientm which returns special test data
     """
 

test/utest/testlinkapi_online_test.py

@@ -17,16 +17,16 @@
 #                   to cover all possible responses or argument combinations
 
 import unittest
-from testlink import TestLinkAPIClient, TestLinkHelper
+from testlink import TestlinkAPIClient, TestLinkHelper
 
 
 class TestLinkAPIOnlineTestCase(unittest.TestCase):
-    """ TestCases for TestLinkAPIClient - interacts with a TestLink Server.
+    """ TestCases for TestlinkAPIClient - interacts with a TestLink Server.
     works with the example project NEW_PROJECT_API (see TestLinkExample.py)
     """
 
     def setUp(self):
-        self.client = TestLinkHelper().connect(TestLinkAPIClient)
+        self.client = TestLinkHelper().connect(TestlinkAPIClient)
 
 
 #    def tearDown(self):
@@ -52,26 +52,32 @@ def test_echo(self):
     def test_doesUserExist_unknownID(self):
         response = self.client.doesUserExist('Big Bird')
         self.assertIn('Big Bird', response[0]['message'])
+        self.assertEqual(10000, response[0]['code'])
 
     def test_getBuildsForTestPlan_unknownID(self):
         response = self.client.getBuildsForTestPlan(4711)
         self.assertIn('4711', response[0]['message'])
+        self.assertEqual(3000, response[0]['code'])
 
     def test_getFirstLevelTestSuitesForTestProject_unknownID(self):
         response = self.client.getFirstLevelTestSuitesForTestProject(4711)
         self.assertIn('4711', response[0]['message'])
+        self.assertEqual(7000, response[0]['code'])
 
     def test_getFullPath_unknownID(self):
         response = self.client.getFullPath(4711)
         self.assertIn('getFullPath', response[0]['message'])
+        self.assertEqual(234, response[0]['code'])
 
     def test_getLastExecutionResult_unknownID(self):
         response = self.client.getLastExecutionResult(4711, 4712)
         self.assertIn('4711', response[0]['message'])
+        self.assertEqual(3000, response[0]['code'])
 
     def test_getLatestBuildForTestPlan_unknownID(self):
         response = self.client.getLatestBuildForTestPlan(4711)
         self.assertIn('4711', response[0]['message'])
+        self.assertEqual(3000, response[0]['code'])
 
     def test_getProjects(self):
         response = self.client.getProjects()
@@ -80,85 +86,111 @@ def test_getProjects(self):
     def test_getProjectTestPlans_unknownID(self):
         response = self.client.getProjectTestPlans(4711)
         self.assertIn('4711', response[0]['message'])
+        self.assertEqual(7000, response[0]['code'])
 
     def test_getTestCase_unknownID(self):
         response = self.client.getTestCase(4711)
-        self.assertIn('4711', response[0]['message'])
+        # FAILURE in 1.9.3 API message: replacement does not work
+        # The Test Case ID (testcaseid: %s) provided does not exist!
+        #self.assertIn('4711', response[0]['message'])
+        self.assertEqual(5000, response[0]['code'])
 
     def test_getTestCaseAttachments_unknownID(self):
         response = self.client.getTestCaseAttachments(4711)
-        self.assertIn('4711', response[0]['message'])
+        # FAILURE in 1.9.3 API message: replacement does not work
+        # The Test Case ID (testcaseid: %s) provided does not exist!
+        #self.assertIn('4711', response[0]['message'])
+        self.assertEqual(5000, response[0]['code'])
 
     def test_getTestCaseCustomFieldDesignValue_unknownID(self):
         response = self.client.getTestCaseCustomFieldDesignValue(
                    4712, 1, 4711, 'a_field', 'a_detail')
         self.assertIn('4711', response[0]['message'])
+        self.assertEqual(7000, response[0]['code'])
 
     def test_getTestCaseIDByName_unknownID(self):
         response = self.client.getTestCaseIDByName('Big Bird')
         self.assertIn('getTestCaseIDByName', response[0]['message'])
+        self.assertEqual(5030, response[0]['code'])
 
     def test_getTestCasesForTestPlan_unknownID(self):
         response = self.client.getTestCasesForTestPlan(4711)
         self.assertIn('4711', response[0]['message'])
+        self.assertEqual(3000, response[0]['code'])
 
     def test_getTestCasesForTestSuite_unknownID(self):
         response = self.client.getTestCasesForTestSuite(4711, 2, 'a_detail')
         self.assertIn('4711', response[0]['message'])
+        self.assertEqual(8000, response[0]['code'])
 
     def test_getTestPlanByName_unknownID(self):
         response = self.client.getTestPlanByName('project 4711', 'plan 4712')
         self.assertIn('4711', response[0]['message'])
+        self.assertEqual(7011, response[0]['code'])
 
     def test_getTestPlanPlatforms_unknownID(self):
         response = self.client.getTestPlanPlatforms(4711)
         self.assertIn('4711', response[0]['message'])
+        self.assertEqual(3000, response[0]['code'])
 
     def test_getTestProjectByName_unknownID(self):
         response = self.client.getTestProjectByName('project 4711')
         self.assertIn('4711', response[0]['message'])
+        self.assertEqual(7011, response[0]['code'])
 
     def test_getTestSuiteByID_unknownID(self):
         response = self.client.getTestSuiteByID(4711)
         self.assertIn('4711', response[0]['message'])
+        self.assertEqual(8000, response[0]['code'])
 
     def test_getTestSuitesForTestPlan_unknownID(self):
         response = self.client.getTestSuitesForTestPlan(4711)
         self.assertIn('4711', response[0]['message'])
+        self.assertEqual(3000, response[0]['code'])
 
     def test_getTestSuitesForTestSuite_unknownID(self):
         response = self.client.getTestSuitesForTestSuite(4711)
         self.assertIn('4711', response[0]['message'])
+        self.assertEqual(8000, response[0]['code'])
 
     def test_getTotalsForTestPlan_unknownID(self):
         response = self.client.getTotalsForTestPlan(4711)
         self.assertIn('4711', response[0]['message'])
+        self.assertEqual(3000, response[0]['code'])
 
     def test_createTestProject_unknownID(self):
         response = self.client.createTestProject('', 'P4711')
         self.assertIn('Empty name', response[0]['message'])
+        self.assertEqual(7001, response[0]['code'])
 
     def test_createBuild_unknownID(self):
         response = self.client.createBuild(4711, 'Build 4712', 'note 4713')
         self.assertIn('4711', response[0]['message'])
+        self.assertEqual(3000, response[0]['code'])
 
     def test_createTestPlan_unknownID(self):
         response = self.client.createTestPlan('plan 4711', 'project 4712')
         self.assertIn('4712', response[0]['message'])
+        self.assertEqual(7011, response[0]['code'])
 
     def test_createTestSuite_unknownID(self):
         response = self.client.createTestSuite( 4711, 'suite 4712', 'detail 4713')
         self.assertIn('4711', response[0]['message'])
+        self.assertEqual(7000, response[0]['code'])
 
     def test_createTestCase_unknownID(self):
         response = self.client.createTestCase('case 4711', 4712, 4713, 
                                                'Big Bird', 'summary 4714')
         self.assertIn('4713', response[0]['message'])
+        self.assertEqual(7000, response[0]['code'])
 
     def test_reportTCResult_unknownID(self):
         response = self.client.reportTCResult(4711, 4712, 'build 4713', 'p', 
                                               'note 4714')
-        self.assertIn('4711', response[0]['message'])
+        # FAILURE in 1.9.3 API message: replacement does not work
+        # The Test Case ID (testcaseid: %s) provided does not exist!
+        #self.assertIn('4711', response[0]['message'])
+        self.assertEqual(5000, response[0]['code'])
 
 #    def test_uploadExecutionAttachment_unknownID(self):
 #        response = self.client.uploadExecutionAttachment('file 4711', 4712, 

test/utest/testlinkapicallservertest.py

@@ -11,7 +11,7 @@
 #     TESTLINK_API_PYTHON_DEVKEY and TESTLINK_API_PYTHON_DEVKEY
 
 import unittest
-from testlink import TestLinkAPIClient, TestLinkHelper
+from testlink import TestlinkAPIClient, TestLinkHelper
 from testlink import testlinkerrors
 
 
@@ -22,14 +22,14 @@ class TestLinkAPIcallServerTestCase(unittest.TestCase):
     def test_callServer_noArgs(self):
         """ test _callServer() - calling method with no args """
 
-        client = TestLinkHelper().connect(TestLinkAPIClient)
+        client = TestLinkHelper().connect(TestlinkAPIClient)
         response = client._callServer('sayHello')
         self.assertEqual('Hello!', response)
 
     def test_callServer_withArgs(self):
         """ test _callServer() - calling method with args """
 
-        client = TestLinkHelper().connect(TestLinkAPIClient)
+        client = TestLinkHelper().connect(TestlinkAPIClient)
         response = client._callServer('repeat', {'str' : 'some arg'})
         self.assertEqual('You said: some arg', response)
 
@@ -38,22 +38,22 @@ def test_callServer_ProtocollError(self):
 
         server_url = TestLinkHelper()._server_url
         bad_server_url = server_url.split('xmlrpc.php')[0] 
-        client = TestLinkHelper(bad_server_url).connect(TestLinkAPIClient)
+        client = TestLinkHelper(bad_server_url).connect(TestlinkAPIClient)
         def a_func(api_client): api_client._callServer('sayHello')
         self.assertRaises(testlinkerrors.TLConnectionError, a_func, client)
 
     def test_callServer_socketError(self):
         """ test _callServer() - Server raises a socket Error (IOError) """
 
         bad_server_url = 'http://111.222.333.4/testlink/lib/api/xmlrpc.php' 
-        client = TestLinkHelper(bad_server_url).connect(TestLinkAPIClient)
+        client = TestLinkHelper(bad_server_url).connect(TestlinkAPIClient)
         def a_func(api_client): api_client._callServer('sayHello')
         self.assertRaises(testlinkerrors.TLConnectionError, a_func, client)
 
     def test_callServer_FaultError(self):
         """ test _callServer() - Server raises Fault Error """
 
-        client = TestLinkHelper().connect(TestLinkAPIClient)
+        client = TestLinkHelper().connect(TestlinkAPIClient)
         def a_func(api_client): api_client._callServer('sayGoodBye')
         self.assertRaises(testlinkerrors.TLAPIError, a_func, client)