new helper method - ensureUserExist #141

Author: Luiko Czub

CHANGES.rst

@@ -7,6 +7,18 @@ support for TL 1.9.20_fixed changes and py39
 
 main topic is to support TL 1.9.20_fixed api changes
 
+implement 1.9.20_fixed new api interfaces - #141
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+new TestlinkAPIGeneric and TestlinkAPIClient api method
+
+- createUser(<login>, <firstname>, <lastname>, <email>, [password=<password>])
+
+new TestlinkAPIClient helper method
+
+- ensureUserExist(<login>, [firstname=<firstname>], [lastname=<lastname>], 
+  [email=<email>, [password=<password>])
+
 implement 1.9.20_fixed changed api interfaces - #139
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

example/TestLinkExample.py

@@ -121,9 +121,16 @@
 print(myTestLink.connectionInfo())
 print("")
 
-# CHANGE this name into a valid account, known in your TL application
-myTestUserName="pyTLapi"
-myTestUserName2="admin"
+# ensure tester and expert users exists
+myTestUserName="myTester"
+myTestUser1_ID=myTestLink.ensureUserExist(myTestUserName, 
+    firstname="myFirstName", lastname="myLastName", mail="myTester@example.com")
+print("ensureUserExist", myTestUserName, myTestUser1_ID)
+
+myTestUserName2="myExpert"
+myTestUser2_ID=myTestLink.ensureUserExist(myTestUserName2)
+print("checkUser", myTestUserName2, myTestUser2_ID)
+
 # get user information
 response = myTestLink.getUserByLogin(myTestUserName)
 print("getUserByLogin", response)

src/testlink/testlinkapi.py

@@ -21,7 +21,7 @@
 
 from __future__ import print_function
 from .testlinkapigeneric import TestlinkAPIGeneric, TestLinkHelper
-from .testlinkerrors import TLArgError
+from .testlinkerrors import TLArgError, TLResponseError
 import sys
 
 
@@ -512,6 +512,36 @@ def getProjectIDByName(self, projectName):
                 result = project['id']
                 break
         return result
+    
+    def ensureUserExist(self, login, **userArgs):
+        """ combines getUserByLogin() + createUser()
+            creates new user only, when login not exist
+            
+            returns userID 
+            
+            userArgs defines optional key value pairs used to create new user
+            - firstname Default 'unknown'
+            - lastname  Default 'via pyTLapi'
+            - email      Default 'unknown@example.com'
+            - password  Default None
+        """
+        
+        try:
+            response = self.getUserByLogin(login)
+            userID = response[0]['dbID']
+        except TLResponseError as tl_err:
+            if tl_err.code == 10000:
+                # Cannot Find User Login create new user
+                name1 = userArgs.get('firstname', 'unknown')
+                name2 = userArgs.get('lastname', 'via pyTLapi')
+                mail  = userArgs.get('email', 'unknown@example.com')
+                pw    = userArgs.get('password')
+                userID = self.createUser(login, name1, name2, mail, password=pw)
+            else:
+                # seems to be another response failure -  we forward it
+                raise   
+    
+        return userID
 
 
 if __name__ == "__main__":