Package: robotframework-robotlog2rqm
RobotLog2RQM DescriptionThe Python packageRobotLog2RQMprovides ability to importRobot
Framework test
resultas*.xmlformat file(s) toIBM® Rational® Quality
Manager(RQM) for test management.RobotLog2RQMtool helps to:Create all required resources (Test Case Excution Record,Test
Case Execution Result, ...) for new testcase on RQM.Link all testcases to provided testplan.Add new test result for existing testcase on RQM.Update existing testcase on RQM.RobotLog2RQMtool is operating system independent and only works
with Python 3.How to installRobotLog2RQMcan be installed in two different ways.Installation via PyPi (recommended for users)pip install RobotLog2RQMRobotLog2RQM in
PyPiInstallation via GitHub (recommended for developers)Clone therobotframework-robotlog2rqmrepository to your
machine.git clone https://github.com/test-fullautomation/robotframework-robotlog2rqm.gitRobotLog2RQM in
GitHubInstall dependenciesRobotLog2RQMrequires some additional Python libraries.
Before you install the cloned repository sources you have to
install the dependencies manually. The names of all related
packages you can find in the filerequirements.txtin the
repository root folder. Use pip to install them:pip install -r ./requirements.txtAdditionally installLaTeX(recommended: TeX Live). This is
used to render the documentation.Configure dependenciesThe installation ofRobotLog2RQMincludes to generate the
documentation in PDF format. This is done by an application
calledGenPackageDoc, that is part of the installation
dependencies (seerequirements.txt).GenPackageDocusesLaTeXto generate the documentation
in PDF format. ThereforeGenPackageDocneeds to know where
to findLaTeX. This is defined in theGenPackageDocconfiguration filepackagedoc\packagedoc_config.jsonBefore you start the installation you have to introduce the
following environment variable, that is used inpackagedoc_config.json:GENDOC_LATEXPATH: path topdflatexexecutableUse the following command to installRobotLog2RQM:python setup.py installAfter succesful installation, the executable fileRobotLog2RQMwill
be available (underScriptsfolder of Python on Windows and~/.local/bin/folder on Linux).In case above location is added toPATHenvironment variable then
you can run it directly as operation system's command.How to useRobotLog2RQMtool requires the Robot Frameworkoutput.xmlresult
file(s) which will be imported, RQM information(e.g. host url, project,
...) and user credential(user name and password) to interact with RQM
resources.Use below command to get tools's usage:RobotLog2RQM -hThe usage should be showed as below:usage: RobotLog2RQM (RobotXMLResult to RQM importer) [-h] [-v] [--recursive] 
                    [--createmissing] [--updatetestcase] [--dryrun] 
                    resultxmlfile host project user password testplan

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.

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.The below command is simple usage witth all required arguments to import
Robot Framework results into RQM:RobotLog2RQM <outputfile> <host> <project> <user> <password> <testplan>Besides the executable file, you can also run tool as a Python modulepython -m RobotLog2RQM <outputfile> <host> <project> <user> <password> <testplan>ExampleIn order the import the Robot result(s) to RQM, we need theoutput.xmlresult file.So, firstly execute the Robot testcase(s) to get theoutput.xmlresult
file.Sample Robot testcase which contains neccessary information for
importing into RQM:*** Settings ***
Metadata   project      ROBFW             # Test Environment
Metadata   version_sw   SW_VERSION_0.1    # Build Record
Metadata   component    Import_Tools      # Component - is used for test case
Metadata   machine      %{COMPUTERNAME}   # Hostname
Metadata   team-area    Internet Team RQM  # team-area (case-sensitive)

*** Test Cases ***
Testcase 01
   [Documentation]   This test is traceable with provided tcid  
   [Tags]   TCID-1001   FID-112   FID-111    robotfile-https://github.com/test-fullautomation
   Log      This is Testcase 01

Testcase 02
   [Documentation]  This new testcase will be created if --createmissing argument 
               ...  is provided when importing
   [Tags]   FID-113  robotfile-https://github.com/test-fullautomation
   Log      This is Testcase 02After gettingoutput.xmlresult file, use below command to import that
result file into testplan ID720ofROBFW-AIOproject which is
hosted athttps://sample-rqm-host.comRobotLog2RQM output.xml https://sample-rqm-host.com ROBFW-AIO test_user test_pw 720Then, open RQM with your favourite browser and you will see that the
test case execution records and their results are imported in the given
testplan ID.Sourcecode DocumentationTo understand more detail about the tool's features and how Robot test
cases and their results are reflected on RQM, please refer toRobotLog2RQM tool's
Documentation.FeedbackTo give us a feedback, you can send an email toThomas
Pollerspöck.In case you want to report a bug or request any interesting feature,
please don't hesitate to raise a ticket.MaintainersThomas PollerspöckTran Duy NgoanContributorsNguyen Huynh Tri CuongMai Dinh Nam SonTran Hoang NguyenHolger QueckenstedtLicenseCopyright 2020-2022 Robert Bosch GmbHLicensed 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 atUnless 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.