Package: testgear-adapter-pytest
Test Gear TMS adapter for PytestGetting StartedInstallationpip install testgear-adapter-pytestUsageConfigurationDescriptionPropertyEnvironment 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:$ pytest --testgearLaunch with command-line parameters:$ pytest --testgear --tmsUrl=URL --tmsPrivateToken=USER_PRIVATE_TOKEN --tmsProjectId=PROJECT_ID --tmsConfigurationId=CONFIGURATION_ID --tmsTestRunId=TEST_RUN_ID --tmsTestRunName=TEST_RUN_NAME --tmsAdapterMode=ADAPTER_MODE --tmsProxy='{"http":"http://localhost:8888","https":"http://localhost:8888"}' --tmsCertValidation=CERT_VALIDATION --tmsAutomaticCreationTestCases=AUTOMATIC_CREATION_TEST_CASESIf you want to enable debug mode then
seeHow to enable debug logging?DecoratorsDecorators can be used to specify information about autotest.Description of decorators:testgear.workItemIds- 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.labels- tags listed in the autotest cardtestgear.link- links listed in the autotest cardtestgear.step- the designation of the step called in the body of the test or other steptestgear.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)All decorators support the use of parameterization attributesDescription of methods:testgear.addLinks- links in the autotest resulttestgear.addAttachments- uploading files in the autotest resulttestgear.addMessage- information about autotest in the autotest resulttestgear.step- usage in the "with" construct to designation a step in the body of the testExamplesSimple testimportpytestimporttestgear# Test with a minimal set of decorators@testgear.externalId('Simple_autotest2')deftest_2():"""Simple autotest 2"""assertoneStep()asserttwoStep()@testgear.stepdefoneStep():assertoneOneStep()assertoneTwoStep()returnTrue@testgear.stepdeftwoStep():returnTrue@testgear.step('step 1.1','description')defoneOneStep():returnTrue@testgear.step('step 2')defoneTwoStep():returnTrue@testgear.externalId('Simple_test_skip')@testgear.displayName('Simple test skip')@testgear.links(url='https://dumps.example.com/module/JCP-777')@testgear.links(url='https://dumps.example.com/module/JCP-777',title='JCP-777',type=testgear.LinkType.RELATED,description='Description of JCP-777')@pytest.mark.skipif(True,reason='Because i can')deftest_skip():assertTrueParameterized test# Parameterized test with a full set of decoratorsfromos.pathimportjoin,dirnameimportpytestimporttestgear@testgear.workItemIds(627)@testgear.displayName('Simple autotest 1 -{name}')@testgear.externalId('Simple_autotest1_{name}')@testgear.title('Authorization')@testgear.description('E2E_autotest')@testgear.labels('{labels}')@testgear.links(links=[{'url':'{url}','type':'{link_type}','title':'{link_title}','description':'{link_desc}'},{'url':'{url}','type':'{link_type}','title':'{link_title}','description':'{link_desc}'}])@pytest.mark.parametrize('name, labels, url, link_type, link_title, link_desc',[('param 1',['E2E','test'],'https://dumps.example.com/module/JCP-777',testgear.LinkType.DEFECT,'JCP-777','Desc of JCP-777'),('param 2',(),'https://dumps.example.com/module/docs',testgear.LinkType.RELATED,'Documentation','Desc of JCP-777'),('param 3',('E2E','test'),'https://dumps.example.com/module/projects',testgear.LinkType.REQUIREMENT,'Projects','Desc of Projects'),('param 4',{'E2E','test'},'https://dumps.example.com/module/',testgear.LinkType.BLOCKED_BY,'',''),('param 5','test','https://dumps.example.com/module/repository',testgear.LinkType.REPOSITORY,'Repository','Desc of Repository')])deftest_1(name,labels,url,link_type,link_title,link_desc):testgear.addLinks(url='https://dumps.example.com/module/some_module_dump',title='component_dump.dmp',type=testgear.LinkType.RELATED,description='Description')testgear.addLinks(url='https://dumps.example.com/module/some_module_dump')testgear.addLinks(links=[{'url':'https://dumps.example.com/module/some_module_dump','type':testgear.LinkType.BLOCKED_BY,'title':'component_dump.dmp','description':'Description'},{'url':'https://dumps.example.com/module/some_module_dump','type':testgear.LinkType.DEFECT},{'url':'https://dumps.example.com/module/some_module_dump','type':testgear.LinkType.ISSUE,'title':'component_dump.dmp'},{'url':'https://dumps.example.com/module/some_module_dump','type':testgear.LinkType.REQUIREMENT,'title':'component_dump.dmp','description':'Description'},{'url':'https://dumps.example.com/module/some_module_dump','type':testgear.LinkType.REPOSITORY,'description':'Description'},{'url':'https://dumps.example.com/module/some_module_dump'}])withtestgear.step('Log in the system','system authentication'):withtestgear.step('Enter the login','login was entered'):withtestgear.step('Enter the password','password was entered'):assertTruewithtestgear.step('Create a project','the project was created'):withtestgear.step('Enter the project','the contents of the project are displayed'):assertTruewithtestgear.step('Create a test case','test case was created'):assertTruewithtestgear.step('Attachments'):testgear.addAttachments(join(dirname(__file__),'docs/text_file.txt'),join(dirname(__file__),'pictures/picture.jpg'),join(dirname(__file__),'docs/document.docx'))testgear.addAttachments(join(dirname(__file__),'docs/document.doc'),join(dirname(__file__),'docs/logs.log'))assertTrueContributingYou 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.