Package: testgear-adapter-robotframework
Test Gear TMS adapter for Robot FrameworkGetting StartedInstallationpip install testgear-adapter-robotframeworkUsageConfigurationDescriptionPropertyEnvironment variableCLI argumentLocation of the TMS instanceurlTMS_URLtmsUrlAPI secret keyHow to getting API secret key?privateTokenTMS_PRIVATE_TOKENtmsPrivateTokenID of project in TMS instanceHow to getting project ID?projectIdTMS_PROJECT_IDtmsProjectIdID of configuration in TMS instanceHow to getting configuration ID?configurationIdTMS_CONFIGURATION_IDtmsConfigurationIdID of the created test run in TMS instance.It's necessary foradapterMode0 or 1testRunIdTMS_TEST_RUN_IDtmsTestRunIdParameter for specifying the name of test run in TMS instance (It's optional). If it is not provided, it is created automaticallytestRunNameTMS_TEST_RUN_NAMEtmsTestRunNameAdapter mode. Default value - 0. The adapter supports following modes:0 - in this mode, the adapter filters tests by test run ID and configuration ID, and sends the results to the test run1 - in this mode, the adapter sends all results to the test run without filtering2 - in this mode, the adapter creates a new test run and sends results to the new test runadapterModeTMS_ADAPTER_MODEtmsAdapterModeIt enables/disables certificate validation (It's optional). Default value - truecertValidationTMS_CERT_VALIDATIONtmsCertValidationMode of automatic creation test cases (It's optional). Default value - false. The adapter supports following modes:true - in this mode, the adapter will create a test case linked to the created autotest (not to the updated autotest)false - in this mode, the adapter will not create a test caseautomaticCreationTestCasesTMS_AUTOMATIC_CREATION_TEST_CASEStmsAutomaticCreationTestCasesUrl of proxy server (It's optional)tmsProxyTMS_PROXYtmsProxyName of the configuration file If it is not provided, it is used default file name (It's optional)-TMS_CONFIG_FILEtmsConfigFileFileCreateconnection_config.inifile in the root directory of the project:[testgear]
URL = URL
privateToken = USER_PRIVATE_TOKEN
projectId = PROJECT_ID
configurationId = CONFIGURATION_ID
testRunId = TEST_RUN_ID
testRunName = TEST_RUN_NAME
adapterMode = ADAPTER_MODE
certValidation = CERT_VALIDATION
automaticCreationTestCases = AUTOMATIC_CREATION_TEST_CASES

# This section are optional. It enables debug mode.
[debug]
tmsProxy = TMS_PROXYExamplesLaunch with a connection_config.ini file in the root directory of the project:$ robot -v testgear TEST_DIRECTORYLaunch with command-line parameters (parameters are case-insensitive):$ robot -v testgear -v tmsUrl:URL -v tmsPrivateToken:USER_PRIVATE_TOKEN -v tmsProjectId:PROJECT_ID -v tmsConfigurationId:CONFIGURATION_ID -v tmsTestRunId:TEST_RUN_ID -v tmsTestRunName:TEST_RUN_NAME -v tmsAdapterMode:ADAPTER_MODE -v tmsProxy:'{"http":"http://localhost:8888","https":"http://localhost:8888"}' -v tmsConfigFile:<optional file> -v tmsCertValidation:CERT_VALIDATION -v tmsAutomaticCreationTestCases:AUTOMATIC_CREATION_TEST_CASES TEST_DIRECTORYIf you want to enable debug mode then seeHow to enable debug logging?TagsTags can be used to specify information about autotest. Tags are space sensitive, use only one space between words.Description of tags:testgear.workItemsId- a method that links autotests with manual tests. Receives the array of manual tests' IDstestgear.displayName- internal autotest name (used in Test Gear)testgear.externalId- unique internal autotest ID (used in Test Gear)testgear.title- autotest name specified in the autotest card. If not specified, the name from the displayName method is usedtestgear.description- autotest description specified in the autotest cardtestgear.links- links listed in the autotest cardtestgear.labels- tags listed in the autotest cardtestgear.nameSpace- directory in the TMS system (default - file's name of test)testgear.className- subdirectory in the TMS system (default - class's name of test)Description of methods:Add Links- links in the autotest resultAdd Link- add one link in the autotest resultAdd Attachments- uploading files in the autotest resultAdd Attachment- upload given content with given filename in the autotest resultAdd Message- information about autotest in the autotest resultParallel executionYou can also run your test in parallel withPabot.$ pabot --pabotlib -v testgear <test directory>All other settings are the same as for standard execution.Examples*** Settings ***DocumentationMain Suite with examplesLibrarytestgear_adapter_robotframework.TMSLibrary*** Variables ***&{SIMPLE_LINK}url=http://google.com&{FULL_LINK}url=http://google.co.uktitle=Googletype=Relateddescription=just a link@{LINKS}               ${SIMPLE_LINK}   ${FULL_LINK}*** Test Cases ***Simple Test[Setup]SetupDo SomethingDo Another ThingLogI'am a step[Teardown]TeardownSimple Test with link as variable[Tags]testgear.links:${SIMPLE_LINK}[Setup]SetupDo SomethingDo Another ThingLogI'am a step[Teardown]TeardownSimple Test with link as dict[Tags]testgear.links:${{{'url': 'http://google.com', 'type':'Issue'}}}[Setup]SetupDo SomethingDo Another ThingLogI'am a step[Teardown]TeardownSimple Test with WorkitemId as string[Tags]testgear.workitemsID:123[Setup]SetupDo SomethingDo Another ThingLogI'am a step[Teardown]TeardownSimple Test with WorkitemId as list[Tags]testgear.workitemsID:${{[123, '456']}}[Setup]SetupDo SomethingDo Another ThingLogI'am a step[Teardown]TeardownSimple Test with Title or Description or DisplayName with simple formatting[Documentation]Tags are space sensitive, use only one space between words[Tags]testgear.displayName:This workstestgear.title:'This also works'...testgear.description:"This works too"[Setup]SetupDo SomethingDo Another ThingLogI'am a step[Teardown]TeardownTest With All Params[Documentation]It's better to use this kind of formatting for different data types in tags[Tags]testgear.externalID:123testgear.title:${{'Different title'}}testgear.displayName:${{'Different name'}}...testgear.description:${{'Different description'}}testgear.workitemsID:${{[123, '456']}}...testgear.links:${{{'url': 'http://google.com', 'type':'Issue'}}}testgear.labels:${{['smoke', 'lol']}}[Setup]SetupLogSomethingLogAnother[Teardown]TeardownTest With Add Link[Setup]SetupDo SomethingDo Another ThingAdd Links@{LINKS}#    You can also add one link (default type is Defect)Add Linkhttp://ya.ruAdd Linkhttp://ya.rutype=IssueAdd Link${SIMPLE_LINK}[url][Teardown]TeardownTest With Add Attachment[Setup]SetupDo SomethingDo Another Thing${V}Get VariablesAdd Attachment'${V}'file.txtAdd Attachmentsimages/banner.pngimages/icon.png[Teardown]TeardownTest With Add Message[Setup]SetupDo SomethingDo Another ThingAdd MessageWow, it's my error message!Fail[Teardown]TeardownContributingYou can help to develop the project. Any contributions aregreatly appreciated.If you have suggestions for adding or removing projects, feel free toopen an issueto discuss it, or directly create a pull request after you edit theREADME.mdfile with necessary changes.Please make sure you check your spelling and grammar.Create individual PR for each suggestion.Please also read through theCode Of Conductbefore posting your first idea as well.LicenseDistributed under the Apache-2.0 License. SeeLICENSEfor more information.