robotframework-robotlog2rqm 1.2.4__tar.gz → 1.4.1__tar.gz

{robotframework-robotlog2rqm-1.2.4 → robotframework-robotlog2rqm-1.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: robotframework-robotlog2rqm
-Version: 1.2.4
+Version: 1.4.1
 Summary: Imports robot result(s) to IBM Rational Quality Manager (RQM)
 Home-page: https://github.com/test-fullautomation/robotframework-robotlog2rqm
 Author: Tran Duy Ngoan
@@ -128,33 +128,40 @@ Use below command to get tools\'s usage:
 
 The usage should be showed as below:
 
-    usage: RobotLog2RQM (RobotXMLResult to RQM importer) [-h] [-v] [--recursive]
-                        [--createmissing] [--updatetestcase] [--dryrun]
-                        resultxmlfile host project user password testplan
+    usage: RobotLog2RQM (RobotXMLResult to RQM importer) [-h] [-v] [--testsuite TESTSUITE] [--recursive] 
+                [--createmissing] [--updatetestcase] [--dryrun] [--stream STREAM] [--baseline BASELINE] 
+                resultxmlfile host project user password testplan
 
-    RobotLog2RQM imports XML result files (default: output.xml) generated by the
+    RobotLog2RQM imports XML result files (default: output.xml) generated by the 
     Robot Framework into an IBM Rational Quality Manager.
 
     positional arguments:
-    resultxmlfile     absolute or relative path to the xml result file
-                      or directory of result files to be imported.
-    host              RQM host url.
-    project           project on RQM.
-    user              user for RQM login.
-    password          password for RQM login.
-    testplan          testplan ID for this execution.
+    resultxmlfile         absolute or relative path to the xml result file 
+                          or directory of result files to be imported.
+    host                  RQM host url.
+    project               project on RQM.
+    user                  user for RQM login.
+    password              password for RQM login.
+    testplan              testplan ID for this execution.
 
     optional arguments:
-    -h, --help        show this help message and exit
-    -v, --version     Version of the RobotLog2RQM importer.
-    --recursive       if set, then the path is searched recursively for
-                      log files to be imported.
-    --createmissing   if set, then all testcases without tcid are created
-                      when importing.
-    --updatetestcase  if set, then testcase information on RQM will be updated
-                      bases on robot testfile.
-    --dryrun          if set, then verify all input arguments
-                      (includes RQM authentication) and show what would be done.
+    -h, --help            show this help message and exit
+    -v, --version         Version of the RobotLog2RQM importer.
+    --testsuite TESTSUITE
+                            testsuite ID for this execution. If 'new', then create a new 
+                            testsuite for this execution.
+    --recursive           if set, then the path is searched recursively for 
+                          log files to be imported.
+    --createmissing       if set, then all testcases without tcid are created 
+                          when importing.
+    --updatetestcase      if set, then testcase information on RQM will be updated 
+                          bases on robot testfile.
+    --dryrun              if set, then verify all input arguments 
+                          (includes RQM authentication) and show what would be done.
+    --stream STREAM       project stream. Note, requires Configuration Management (CM) 
+                          to be enabled for the project area.
+    --baseline BASELINE   project baseline. Note, requires Configuration Management (CM), 
+                          or Baselines Only to be enabled for the project area.
 
 The below command is simple usage witth all required arguments to import
 Robot Framework results into RQM:

{robotframework-robotlog2rqm-1.2.4 → robotframework-robotlog2rqm-1.4.1}/README.rst

@@ -112,33 +112,40 @@ The usage should be showed as below:
 
 ::
 
-   usage: RobotLog2RQM (RobotXMLResult to RQM importer) [-h] [-v] [--recursive]
-                       [--createmissing] [--updatetestcase] [--dryrun]
-                       resultxmlfile host project user password testplan
+   usage: RobotLog2RQM (RobotXMLResult to RQM importer) [-h] [-v] [--testsuite TESTSUITE] [--recursive] 
+               [--createmissing] [--updatetestcase] [--dryrun] [--stream STREAM] [--baseline BASELINE] 
+               resultxmlfile host project user password testplan
 
-   RobotLog2RQM imports XML result files (default: output.xml) generated by the
+   RobotLog2RQM imports XML result files (default: output.xml) generated by the 
    Robot Framework into an IBM Rational Quality Manager.
 
    positional arguments:
-   resultxmlfile     absolute or relative path to the xml result file
-                     or directory of result files to be imported.
-   host              RQM host url.
-   project           project on RQM.
-   user              user for RQM login.
-   password          password for RQM login.
-   testplan          testplan ID for this execution.
+   resultxmlfile         absolute or relative path to the xml result file 
+                         or directory of result files to be imported.
+   host                  RQM host url.
+   project               project on RQM.
+   user                  user for RQM login.
+   password              password for RQM login.
+   testplan              testplan ID for this execution.
 
    optional arguments:
-   -h, --help        show this help message and exit
-   -v, --version     Version of the RobotLog2RQM importer.
-   --recursive       if set, then the path is searched recursively for
-                     log files to be imported.
-   --createmissing   if set, then all testcases without tcid are created
-                     when importing.
-   --updatetestcase  if set, then testcase information on RQM will be updated
-                     bases on robot testfile.
-   --dryrun          if set, then verify all input arguments
-                     (includes RQM authentication) and show what would be done.
+   -h, --help            show this help message and exit
+   -v, --version         Version of the RobotLog2RQM importer.
+   --testsuite TESTSUITE
+                           testsuite ID for this execution. If 'new', then create a new 
+                           testsuite for this execution.
+   --recursive           if set, then the path is searched recursively for 
+                         log files to be imported.
+   --createmissing       if set, then all testcases without tcid are created 
+                         when importing.
+   --updatetestcase      if set, then testcase information on RQM will be updated 
+                         bases on robot testfile.
+   --dryrun              if set, then verify all input arguments 
+                         (includes RQM authentication) and show what would be done.
+   --stream STREAM       project stream. Note, requires Configuration Management (CM) 
+                         to be enabled for the project area.
+   --baseline BASELINE   project baseline. Note, requires Configuration Management (CM), 
+                         or Baselines Only to be enabled for the project area.
 
 
 The below command is simple usage witth all required arguments to import

{robotframework-robotlog2rqm-1.2.4 → robotframework-robotlog2rqm-1.4.1}/RobotLog2RQM/CRQM.py

@@ -15,7 +15,7 @@
 #
 # File: CRQM.py
 #
-# Initialy created by Tran Duy Ngoan(RBVH/ECM11) / January 2021
+# Initially created by Tran Duy Ngoan(RBVH/ECM11) / January 2021
 #
 # This is CRQMClient class which is used to interact with RQM via RQM REST APIs
 #
@@ -78,6 +78,14 @@ Parse xml object from file.
       exit(1)
    return oTree
 
+class Identifier:
+   """
+Identifier class used to identify RQM resource with name and id
+   """
+   def __init__(self, name='', id=None):
+      self.name = name
+      self.id = id
+
 #
 #  IBM Rational Quality Manager
 #
@@ -87,7 +95,7 @@ class CRQMClient():
 CRQMClient class uses RQM REST APIs to get, create and update resources
 (testplan, testcase, test result, ...) on RQM - Rational Quality Manager
 
-Resoure type mapping:
+Resource type mapping:
 
 * buildrecord:          Build Record
 * configuration:        Test Environment
@@ -131,6 +139,17 @@ Resoure type mapping:
       'ns21' : "http://www.w3.org/1999/XSL/Transform"
    }
 
+   # define the convention for naming new RQM resource
+   SUPPORTED_PLACEHOLDER = ["testplan", "build", "environment", "testsuite", "testcase"]
+   NAMING_CONVENTION = {
+      "testcase"    : "{testcase}",
+      "tcer"        : "TCER: {testcase}",
+      "testresult"  : "Execution result: {testcase}",
+      "testsuite"   : "{testsuite}",
+      "tser"        : "TSER: {testsuite}",
+      "suiteresult" : "Testsuite result: {testsuite}"  
+   }
+
    def __init__(self, user, password, project, host):
       """
 Constructor of class ``CRQMClient``.
@@ -175,7 +194,7 @@ Constructor of class ``CRQMClient``.
                         'OSLC-Core-Version'  : '2.0'
                      }
 
-      # Templates location which is uesd for importing
+      # Templates location which is used for importing
       self.templatesDir = os.path.join(os.path.dirname(__file__),'RQM_templates')
 
       # Data for mapping and linking
@@ -190,12 +209,17 @@ Constructor of class ``CRQMClient``.
       self.lEndTimes     = list()
 
       # RQM configuration info
-      self.testplan      = None
-      self.build         = None
-      self.configuration = None
       self.createmissing = None
       self.updatetestcase= None
-      self.testsuite     = None
+      self.testplan      = Identifier()
+      self.build         = Identifier()
+      self.configuration = Identifier()
+      self.testsuite     = Identifier()
+      self.stream        = Identifier()
+      self.baseline      = Identifier()
+
+      # Naming convention
+      self.naming_convention = None
 
    def login(self):
       """
@@ -285,7 +309,8 @@ Disconnect from RQM.
       self.session.close()
 
    def config(self, plan_id, build_name=None, config_name=None,
-              createmissing=False, updatetestcase=False,suite_id=None):
+              createmissing=False, updatetestcase=False, suite_id=None, 
+              stream=None, baseline=None, naming_convention=None):
       """
 Configure RQMClient with testplan ID, build, configuration, createmissing, ...
 
@@ -338,15 +363,61 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
 (*no returns*)
       """
       try:
+         self.naming_convention = self.NAMING_CONVENTION
+         if naming_convention:
+            self.naming_convention.update(naming_convention)
+
          self.createmissing = createmissing
          self.updatetestcase = updatetestcase
-         self.testsuite = suite_id
-         self.testplan  = plan_id
+         self.testplan.id  = plan_id
+         self.testsuite.id = suite_id
+         
+         # Add Configuration-Context header information due to given stream or baseline
+         if stream:
+            res = self.getAllByResource('stream')
+            if res['success']:
+               dStreams = res['data']
+               bFoundStream = False
+               for stream_id, stream_name in dStreams.items():
+                  if stream_name == stream:
+                     self.stream.id = stream_id
+                     self.stream.name = stream_name
+                     bFoundStream = True
+                     self.headers['Configuration-Context'] = stream_id
+                     self.session.headers = self.headers
+                     break
+               
+               if not bFoundStream:
+                  raise Exception(f"Cannot found given stream '{stream}'")
+            else:
+               raise Exception("Get all streams failed. Reason: %s"%res['message'])
+         elif baseline:
+            res = self.getAllByResource('baseline')
+            if res['success']:
+               dBaselines = res['data']
+               bFoundBaseline = False
+               for baseline_id, baseline_name in dBaselines.items():
+                  if baseline_name == baseline:
+                     self.baseline.id = baseline_id
+                     self.baseline.name = baseline_name
+                     bFoundBaseline = True
+                     self.headers['Configuration-Context'] = baseline_id
+                     self.session.headers = self.headers
+                     break
+               
+               if not bFoundBaseline:
+                  raise Exception(f"Cannot found given baseline '{baseline}'")
+            else:
+               raise Exception("Get all baselines failed. Reason: %s"%res['message'])
+
          # Verify testplan ID
          res_plan = self.getResourceByID('testplan', plan_id)
          if res_plan.status_code != 200:
             raise Exception('Testplan with ID %s is not existing!'%str(plan_id))
 
+         oTestplan = get_xml_tree(BytesIO(str(res_plan.text).encode()), bdtd_validation=False)
+         self.testplan.name  = oTestplan.find('ns4:title', oTestplan.getroot().nsmap).text
+
          # Verify and create build version if required
          if build_name != None:
             if build_name == '':
@@ -354,7 +425,8 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
             self.getAllBuildRecords()
             res_build = self.createBuildRecord(build_name)
             if res_build['success'] or res_build['status_code'] == "303":
-               self.build = res_build['id']
+               self.build.id = res_build['id']
+               self.build.name = build_name
             else:
                raise Exception("Cannot create build '%s': %s"%
                                (build_name, res_build['message']))
@@ -366,13 +438,23 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
             self.getAllConfigurations()
             res_conf = self.createConfiguration(config_name)
             if res_conf['success'] or res_conf['status_code'] == "303":
-               self.configuration = res_conf['id']
+               self.configuration.id = res_conf['id']
+               self.configuration.name = config_name
             else:
                raise Exception("Cannot create configuration '%s': %s"%
                                (config_name, res_conf['message']))
 
+         # Verify testsuite if given
+         if (suite_id != None) and (suite_id != "new"):
+            res_suite = self.getResourceByID('testsuite', suite_id)
+            if res_suite.status_code != 200:
+               raise Exception('Testsuite with ID %s is not existing!'%str(suite_id))
+            oTestsuite = get_xml_tree(BytesIO(str(res_suite.text).encode()), bdtd_validation=False)
+            self.testsuite.name  = oTestsuite.find('ns4:title', oTestsuite.getroot().nsmap).text
+
          # get all team-areas for testcase template
          self.getAllTeamAreas()
+         
 
       except Exception as error:
          raise Exception('Configure RQMClient failed: %s'%error)
@@ -402,7 +484,7 @@ Return interaction URL of provided userID
 
    def integrationURL(self, resourceType, id=None, forceinternalID=False):
       """
-Return interaction URL of provided reource and ID.
+Return interaction URL of provided resource and ID.
 The provided ID can be internalID (contains only digits) or externalID.
 
 **Arguments:**
@@ -434,7 +516,7 @@ The provided ID can be internalID (contains only digits) or externalID.
 
    / *Type*: str /
 
-   The interaction URL of provided reource and ID.
+   The interaction URL of provided resource and ID.
       """
       integrationURL = self.host + "/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/" + \
                        self.projectID + '/' + resourceType
@@ -486,7 +568,7 @@ Note:
          raise Exception("Cannot get ID from response. Reason: %s"%str(error))
       return resultId
 
-   def webIDfromGeneratedID(self, resourrceType, generateID):
+   def webIDfromGeneratedID(self, resourceType, generateID):
       """
 Return web ID (ns2:webId) from generate ID by get resource data from RQM.
 
@@ -497,7 +579,7 @@ Note:
 
 **Arguments:**
 
-*  ``resourrceType``
+*  ``resourceType``
 
    / *Condition*: required / *Type*: str /
 
@@ -531,8 +613,8 @@ Note:
                               'testscript',
                               'testsuite',
                               'testsuitelog']
-      if resourrceType in lSupportedResources:
-         resResource = self.getResourceByID(resourrceType, generateID)
+      if resourceType in lSupportedResources:
+         resResource = self.getResourceByID(resourceType, generateID)
          if resResource.status_code == 200:
             oResource = get_xml_tree(BytesIO(str(resResource.text).encode()),
                                      bdtd_validation=False)
@@ -543,6 +625,61 @@ Note:
             raise Exception("Cannot get web ID of generated testcase!")
       return webID
 
+   def __genResourceName(self, resource, name):
+      """
+Return the name for given resource bases on the naming convention
+
+**Arguments:**
+
+*  ``resource``
+
+   / *Condition*: required / *Type*: str /
+
+   The RQM resource type.
+
+*  ``name``
+
+   / *Condition*: required / *Type*: str /
+
+   Relevant resource name.
+
+**Returns:**
+
+*  ``resourceName``
+
+   / *Type*: str /
+
+   Resource name after replacing bases on naming convention.
+      """
+      dPlaceHolders = {
+         "{testplan}": self.testplan.name
+      }
+      testcaseRelevant = ["testcase", "tcer", "testresult"]
+      testsuiteRelevant = ["testsuite", "tser", "suiteresult"]
+
+      # Define scope of place holders
+      if resource in testcaseRelevant:
+         dPlaceHolders.update({
+            "{build}": self.build.name,
+            "{environment}": self.configuration.name,
+            "{testsuite}": self.testsuite.name,
+            "{testcase}": name
+         })
+      elif resource in testsuiteRelevant:
+         dPlaceHolders.update({
+            "{build}": self.build.name,
+            "{environment}": self.configuration.name,
+            "{testsuite}": name,
+         })
+
+      try:
+         resourceName = self.naming_convention[resource]
+         for placeHolder, val in dPlaceHolders.items():
+            resourceName = resourceName.replace(placeHolder, val)
+         return resourceName
+      except:
+         raise Exception(f"Failed to generate name for {resource} '{name}'")
+
    #
    #  Methods to get resources
    #
@@ -553,7 +690,7 @@ Return data of provided resource and ID by GET method
 
 **Arguments:**
 
-*  ``resourrceType``
+*  ``resourceType``
 
    / *Condition*: required / *Type*: str /
 
@@ -583,7 +720,7 @@ Return all entries (in all pages) of provided resource by GET method.
 
 **Arguments:**
 
-*  ``resourrceType``
+*  ``resourceType``
 
    / *Condition*: required / *Type*: str /
 
@@ -845,7 +982,7 @@ Return testcase template from provided information.
       root         = oTree.getroot()
       nsmap        = root.nsmap
       # prepare required data for template
-      testcaseTittle  = testcaseName
+      testcaseTittle  = self.__genResourceName('testcase', testcaseName)
 
       # find nodes to change data
       oTittle      = oTree.find(f'{{{self.NAMESPACES["ns3"]}}}title')
@@ -958,7 +1095,8 @@ Return testcase execution record template from provided information.
       root = oTree.getroot()
       nsmap = root.nsmap
       # prepare required data for template
-      TCERTittle  = 'TCER: '+testcaseName
+      TCERTittle  = self.__genResourceName('tcer', testcaseName)
+      
 
       # Check tcid is internalid or externalid
       testcaseURL = self.integrationURL('testcase', testcaseID)
@@ -1104,7 +1242,7 @@ Return testcase execution result template from provided information.
       nsmap = root.nsmap
       # prepare required data for template
       prefixState  = 'com.ibm.rqm.execution.common.state.'
-      resultTittle = 'Execution result: '+testcaseName
+      resultTittle = self.__genResourceName('testresult', testcaseName)
       testcaseURL  = self.integrationURL('testcase', testcaseID)
       testplanURL  = self.integrationURL('testplan', testplanID)
       TCERURL      = self.integrationURL('executionworkitem', TCERID)
@@ -1287,7 +1425,7 @@ Return testsuite execution record (TSER) template from provided configuration na
       oTree         = get_xml_tree(sTemplatePath, bdtd_validation=False)
       root = oTree.getroot()
       # prepare required data for template
-      TSERTittle   = 'TSER: ' + testsuiteName
+      TSERTittle   = self.__genResourceName('tser', testsuiteName)
       testsuiteURL = self.integrationURL('testsuite', testsuiteID)
       testplanURL  = self.integrationURL('testplan', testplanID)
       testerURL    = self.userURL(self.userID)
@@ -1323,7 +1461,7 @@ Return testsuite execution record (TSER) template from provided configuration na
       return sTSxml
 
    def createTestsuiteResultTemplate(self, testsuiteID, testsuiteName, TSERID,
-                                     lTCER, lTCResults, startTime='',
+                                     lTCER, lTCResults, resultState, startTime='',
                                      endTime='', duration='', sOwnerID=''):
       """
 Return testsuite execution result template from provided configuration name.
@@ -1395,9 +1533,10 @@ Return testsuite execution result template from provided configuration name.
       sTSResultxml = ''
       sTemplatePath = os.path.join(self.templatesDir, 'testsuitelog.xml')
       oTree         = get_xml_tree(sTemplatePath, bdtd_validation=False)
+      prefixState  = 'com.ibm.rqm.execution.common.state.'
 
       # prepare required data for template
-      resultTittle  = 'Testsuite result: ' + testsuiteName
+      resultTittle  = self.__genResourceName('suiteresult', testsuiteName)
       testsuiteURL  = self.integrationURL('testsuite', testsuiteID)
       TSERURL       = self.integrationURL('suiteexecutionrecord', TSERID)
       testerURL    = self.userURL(self.userID)
@@ -1438,6 +1577,11 @@ Return testsuite execution result template from provided configuration name.
       oStarttime.text          = str(startTime).replace(' ', 'T')
       oEndtime.text            = str(endTime).replace(' ', 'T')
       oTotalRunTime.text       = str(duration)
+      # set default RQM state as inconclusive
+      oState.text              = prefixState + 'inconclusive'
+      if resultState.lower() in self.RESULT_STATES:
+         oState.text = prefixState +resultState.lower()
+         
       for idx, sTCER in enumerate(lTCER):
          sTCERURL = self.integrationURL('executionworkitem', sTCER)
          oSuiteElem = etree.Element('{http://jazz.net/xmlns/alm/qm/v0.1/tsl/v0.1/}suiteelement', nsmap=nsmap)
@@ -1459,6 +1603,79 @@ Return testsuite execution result template from provided configuration name.
       sTSResultxml = etree.tostring(oTree)
       return sTSResultxml
 
+   def createTestsuiteTemplate(self, testsuiteName, sDescription='', sOwnerID='', sTStemplate=None):
+      """
+Return testcase template from provided information.
+
+**Arguments:**
+
+*  ``testsuiteName``
+
+   / *Condition*: required / *Type*: str /
+
+   Testsuite name.
+
+*  ``sDescription``
+
+   / *Condition*: optional / *Type*: str / *Default*: '' /
+
+   Testsuite description.
+
+*  ``sOwnerID``
+
+   / *Condition*: optional / *Type*: str / *Default*: '' /
+
+   User ID of testsuite owner.
+
+*  ``sTStemplate``
+
+   / *Condition*: optional / *Type*: str / *Default*: None /
+
+   Existing testsuite template as xml string.
+
+   If not provided, template file under `RQM_templates` is used as default.
+
+**Returns:**
+
+*  ``sTSxml``
+
+   / *Type*: str /
+
+   The xml testsuite template as string.
+      """
+      sTSxml = ''
+      if not sTStemplate:
+         sTemplatePath = os.path.join(self.templatesDir ,'testsuite.xml')
+         oTree         = get_xml_tree(sTemplatePath, bdtd_validation=False)
+      else:
+         oTree = get_xml_tree(BytesIO(sTStemplate.encode()),bdtd_validation=False)
+
+      root = oTree.getroot()
+      nsmap = root.nsmap
+
+      # prepare required data for template
+      testerURL    = self.userURL(self.userID)
+
+      # find nodes to change data
+      oTittle      = oTree.find('ns4:title', nsmap)
+      oDescription = oTree.find('ns4:description', nsmap)
+      oOwner       = oTree.find('ns6:owner', nsmap)
+
+      # change nodes's data
+      oTittle.text       = self.__genResourceName('testsuite', testsuiteName)
+      oDescription.text  = sDescription
+
+      # Incase not specify owner in template or input data, set it as provided user in cli
+      if sOwnerID:
+         oOwner.text = sOwnerID
+         oOwner.attrib['{%s}resource' % nsmap['ns1']] = self.userURL(sOwnerID)
+      elif not oOwner.text:
+         oOwner.text = self.userID
+         oOwner.attrib['{%s}resource' % nsmap['ns1']] = testerURL
+
+      # return xml template as string
+      sTSxml = etree.tostring(oTree)
+      return sTSxml
    #
    #  Methods to create RQM resources
    #
@@ -1643,7 +1860,6 @@ Create new configuration - test environment.
       """
       returnObj = {'success' : False, 'id': None, 'message': '', 'status_code': ''}
       # check existing build record in this executioon
-      sConfID = ''
       if (sConfigurationName not in self.dConfiguation.values()) or forceCreate:
          sConfTemplate = self.createConfigurationTemplate(sConfigurationName)
          returnObj  = self.createResource('configuration', sConfTemplate)
@@ -1827,3 +2043,66 @@ Link list of test cases to provided testsuite ID
       else:
          returnObj['message'] = "No testcase for linking."
       return returnObj
+
+   def addTestsuite2Testplan(self, testplanID, testsuiteID=None):
+      """
+Add testsuite ID to provided testplan ID
+
+**Arguments:**
+
+*  ``testplanID``
+
+   / *Condition*: required / *Type*: str /
+
+   Testplan ID to link given testsuite ID.
+
+*  ``testsuiteID``
+
+   / *Condition*: optional / *Type*: str / *Default*: None /
+
+   Testsuite to be linked with given testplan.
+
+   If not provide, `testsuite.id` value will be used as id of testsuite.
+
+**Returns:**
+
+*  ``returnObj``
+
+   / *Type*: dict /
+
+   Response dictionary which contains status and error message.
+
+   Example:
+
+   .. code:: python
+
+      {
+         'success' : False,
+         'message': ''
+      }
+
+      """
+      returnObj = {'success' : False, 'message': ''}
+      if testsuiteID == None:
+         testsuiteID = self.testsuite.id
+      if testsuiteID:
+         resTestplanData = self.getResourceByID('testplan', testplanID)
+         oTree = get_xml_tree(BytesIO(str(resTestplanData.text).encode()),bdtd_validation=False)
+         # RQM XML response using namespace for nodes
+         # use namespace mapping from root for access response XML
+         root = oTree.getroot()
+
+         sTestsuiteURL = self.integrationURL('testsuite', testsuiteID)
+         oTS = etree.Element('{http://jazz.net/xmlns/alm/qm/v0.1/}testsuite', nsmap=root.nsmap)
+         oTS.set('href', sTestsuiteURL)
+         root.append(oTS)
+
+         # Update test plan data with linked testsuite and PUT to RQM
+         resUpdateTestplan = self.updateResourceByID('testplan', testplanID, etree.tostring(oTree))
+         if resUpdateTestplan.status_code == 200:
+            returnObj['success'] = True
+         else:
+            returnObj['message'] = str(resUpdateTestplan.reason)
+      else:
+         returnObj['message'] = "No testsuite for adding."
+      return returnObj