Pytest adapter for Test IT
Project description
Test IT TMS adapter for Pytest
Getting Started
Installation
pip install testit-adapter-pytest
Usage
Configuration
File
-
Create connection_config.ini file in the root directory of the project:
[testit] URL = <url> privateToken = <token> projectId = <id> configurationId = <id> testRunId = <optional id> testRunName = <optional name> adapterMode = <optional> certValidation = <optional boolean> automaticCreationTestCases = <optional boolean> # This section are optional. It enables debug mode. [debug] tmsProxy = {"http": "http://localhost:8888", "https": "http://localhost:8888"}
-
Fill parameters with your configuration, where:
-
URL
- location of the TMS instance -
privateToken
- API secret key- go to the https://{DOMAIN}/user-profile profile
- copy the API secret key
-
projectId
- ID of project in TMS instance.- create a project
- open DevTools -> network
- go to the project https://{DOMAIN}/projects/{PROJECT_GLOBAL_ID}/tests
- GET-request project, Preview tab, copy id field
-
configurationId
- ID of configuration in TMS instance.- create a project
- open DevTools -> network
- go to the project https://{DOMAIN}/projects/{PROJECT_GLOBAL_ID}/tests
- GET-request configurations, Preview tab, copy id field
-
testRunId
- id of the created test run in TMS instance.testRunId
is optional. If it is not provided, it is created automatically. -
testRunName
- parameter for specifying the name of test run in TMS instance.testRunName
is optional. If it is not provided, it is created automatically. -
adapterMode
- adapter 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 run.
- 1 - in this mode, the adapter sends all results to the test run without filtering.
- 2 - in this mode, the adapter creates a new test run and sends results to the new test run.
-
certValidation
- it enables/disables certificate validation. Default value - true. -
automaticCreationTestCases
- mode of automatic creation test cases. 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 case.
-
tmsProxy
- it enables debug mode.tmsProxy
is optional.
-
ENV
You can use environment variables (environment variables take precedence over file variables):
-
TMS_URL
- location of the TMS instance. -
TMS_PRIVATE_TOKEN
- API secret key. -
TMS_PROJECT_ID
- ID of a project in TMS instance. -
TMS_CONFIGURATION_ID
- ID of a configuration in TMS instance. -
TMS_ADAPTER_MODE
- adapter mode. Default value - 0. -
TMS_TEST_RUN_ID
- ID of the created test-run in TMS instance.TMS_TEST_RUN_ID
is optional. If it is not provided, it is created automatically. -
TMS_TEST_RUN_NAME
- name of the new test-run.TMS_TEST_RUN_NAME
is optional. If it is not provided, it is created automatically. -
TMS_CONFIG_FILE
- name of the configuration file.TMS_CONFIG_FILE
is optional. If it is not provided, it is used default file name. -
TMS_PROXY
- it enables debug mode.TMS_PROXY
is optional. -
TMS_CERT_VALIDATION
- it enables/disables certificate validation. Default value - true. -
TMS_AUTOMATIC_CREATION_TEST_CASES
- mode of automatic creation test cases. Default value - false.
Command line
You also can CLI variables (CLI variables take precedence over environment variables):
-
tmsUrl
- location of the TMS instance. -
tmsPrivateToken
- API secret key. -
tmsProjectId
- ID of a project in TMS instance. -
tmsConfigurationId
- ID of a configuration in TMS instance. -
tmsAdapterMode
- adapter mode. Default value - 0. -
tmsTestRunId
- ID of the created test-run in TMS instance.tmsTestRunId
is optional. If it is not provided, it is created automatically. -
tmsTestRunName
- name of the new test-run.tmsTestRunName
is optional. If it is not provided, it is created automatically. -
tmsConfigFile
- name of the configuration file.tmsConfigFile
is optional. If it is not provided, it is used default file name. -
tmsProxy
- it enables debug mode.tmsProxy
is optional. -
tmsCertValidation
- it enables/disables certificate validation. Default value - true. -
tmsAutomaticCreationTestCases
- mode of automatic creation test cases. Default value - false.
Examples
Launch with a connection_config.ini file in the root directory of the project:
$ pytest --testit
Launch with command-line parameters:
$ pytest --testit --tmsUrl=<url> --tmsPrivateToken=<token> --tmsProjectId=<id> --tmsConfigurationId=<id> --tmsTestRunId=<optional id> --tmsTestRunName=<optional name> --tmsProxy='{"http":"http://localhost:8888","https":"http://localhost:8888"}' --tmsCertValidation=<optional boolean> --tmsAutomaticCreationTestCases=<optional boolean>
If you want to enable debug mode then see How to enable debug logging?
Decorators
Decorators can be used to specify information about autotest.
Description of decorators:
testit.workItemIds
- linking an autotest to a test casetestit.displayName
- name of the autotest in the TMS system (can be replaced with documentation strings)testit.externalId
- ID of the autotest within the project in the TMS systemtestit.title
- title in the autotest cardtestit.description
- description in the autotest cardtestit.labels
- tags in the work itemtestit.link
- links in the autotest cardtestit.step
- the designation of the step called in the body of the test or other steptestit.nameSpace
- directory in the TMS system (default - file's name of test)testit.className
- subdirectory in the TMS system (default - class's name of test)
All decorators support the use of parameterization attributes
Description of methods:
testit.addLinks
- links in the autotest resulttestit.addAttachments
- uploading files in the autotest resulttestit.addMessage
- information about autotest in the autotest resulttestit.step
- usage in the "with" construct to designation a step in the body of the test
Examples
Simple test
import pytest
import testit
# Test with a minimal set of decorators
@testit.externalId('Simple_autotest2')
def test_2():
"""Simple autotest 2"""
assert oneStep()
assert twoStep()
@testit.step
def oneStep():
assert oneOneStep()
assert oneTwoStep()
return True
@testit.step
def twoStep():
return True
@testit.step('step 1.1', 'description')
def oneOneStep():
return True
@testit.step('step 2')
def oneTwoStep():
return True
@testit.externalId('Simple_test_skip')
@testit.displayName('Simple test skip')
@testit.links(url='https://dumps.example.com/module/JCP-777')
@testit.links(url='https://dumps.example.com/module/JCP-777',
title='JCP-777',
type=testit.LinkType.RELATED,
description='Description of JCP-777')
@pytest.mark.skipif(True, reason='Because i can')
def test_skip():
assert True
Parameterized test
# Parameterized test with a full set of decorators
from os.path import join, dirname
import pytest
import testit
@testit.workItemIds(627)
@testit.displayName('Simple autotest 1 - {name}')
@testit.externalId('Simple_autotest1_{name}')
@testit.title('Authorization')
@testit.description('E2E_autotest')
@testit.labels('{labels}')
@testit.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', testit.LinkType.DEFECT, 'JCP-777',
'Desc of JCP-777'),
('param 2', (), 'https://dumps.example.com/module/docs', testit.LinkType.RELATED, 'Documentation',
'Desc of JCP-777'),
('param 3', ('E2E', 'test'), 'https://dumps.example.com/module/projects', testit.LinkType.REQUIREMENT, 'Projects',
'Desc of Projects'),
('param 4', {'E2E', 'test'}, 'https://dumps.example.com/module/', testit.LinkType.BLOCKED_BY, '', ''),
('param 5', 'test', 'https://dumps.example.com/module/repository', testit.LinkType.REPOSITORY, 'Repository',
'Desc of Repository')
])
def test_1(name, labels, url, link_type, link_title, link_desc):
testit.addLinks(url='https://dumps.example.com/module/some_module_dump', title='component_dump.dmp',
type=testit.LinkType.RELATED, description='Description')
testit.addLinks(url='https://dumps.example.com/module/some_module_dump')
testit.addLinks(links=[
{'url': 'https://dumps.example.com/module/some_module_dump', 'type': testit.LinkType.BLOCKED_BY,
'title': 'component_dump.dmp', 'description': 'Description'},
{'url': 'https://dumps.example.com/module/some_module_dump', 'type': testit.LinkType.DEFECT},
{'url': 'https://dumps.example.com/module/some_module_dump', 'type': testit.LinkType.ISSUE,
'title': 'component_dump.dmp'},
{'url': 'https://dumps.example.com/module/some_module_dump', 'type': testit.LinkType.REQUIREMENT,
'title': 'component_dump.dmp', 'description': 'Description'},
{'url': 'https://dumps.example.com/module/some_module_dump', 'type': testit.LinkType.REPOSITORY,
'description': 'Description'},
{'url': 'https://dumps.example.com/module/some_module_dump'}
])
with testit.step('Log in the system', 'system authentication'):
with testit.step('Enter the login', 'login was entered'):
with testit.step('Enter the password', 'password was entered'):
assert True
with testit.step('Create a project', 'the project was created'):
with testit.step('Enter the project', 'the contents of the project are displayed'):
assert True
with testit.step('Create a test case', 'test case was created'):
assert True
with testit.step('Attachments'):
testit.addAttachments(
join(dirname(__file__), 'docs/text_file.txt'),
join(dirname(__file__), 'pictures/picture.jpg'),
join(dirname(__file__), 'docs/document.docx')
)
testit.addAttachments(
join(dirname(__file__), 'docs/document.doc'),
join(dirname(__file__), 'docs/logs.log')
)
assert True
Contributing
You can help to develop the project. Any contributions are greatly appreciated.
- If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
- Please make sure you check your spelling and grammar.
- Create individual PR for each suggestion.
- Please also read through the Code Of Conduct before posting your first idea as well.
License
Distributed under the Apache-2.0 License. See LICENSE for more information.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for testit-adapter-pytest-2.1.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ffe576440c12def3ee501cf85fd4434d5255d82e640ada2f70706303c0e5c82 |
|
MD5 | 677f5589d72fe374851ac2ce9abe9236 |
|
BLAKE2b-256 | dad91fff14c2b29266dd9100ff098f36325d322d0e0a1213e08b7a005ec4d95e |