testit-adapter-pytest

Test IT TMS adapter for Pytest

Getting Started

Installation

pip install testit-adapter-pytest

Usage

Configuration

Description	File property	Environment variable	CLI argument
Location of the TMS instance	url	TMS_URL	tmsUrl
API secret key How to getting API secret key?	privateToken	TMS_PRIVATE_TOKEN	tmsPrivateToken
ID of project in TMS instance How to getting project ID?	projectId	TMS_PROJECT_ID	tmsProjectId
ID of configuration in TMS instance How to getting configuration ID?	configurationId	TMS_CONFIGURATION_ID	tmsConfigurationId
ID of the created test run in TMS instance. It's necessary for adapterMode 0 or 1	testRunId	TMS_TEST_RUN_ID	tmsTestRunId
Parameter for specifying the name of test run in TMS instance (It's optional). If it is not provided, it is created automatically	testRunName	TMS_TEST_RUN_NAME	tmsTestRunName
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 or with filtering CLI 2 - in this mode, the adapter creates a new test run and sends results to the new test run	adapterMode	TMS_ADAPTER_MODE	tmsAdapterMode
It enables/disables certificate validation (It's optional). Default value - true	certValidation	TMS_CERT_VALIDATION	tmsCertValidation
Mode 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 case	automaticCreationTestCases	TMS_AUTOMATIC_CREATION_TEST_CASES	tmsAutomaticCreationTestCases
Mode of automatic updation links to test cases (It's optional). Default value - false. The adapter supports following modes: true - in this mode, the adapter will update links to test cases false - in this mode, the adapter will not update link to test cases	automaticUpdationLinksToTestCases	TMS_AUTOMATIC_UPDATION_LINKS_TO_TEST_CASES	tmsAutomaticUpdationLinksToTestCases
Mode of import type selection when launching autotests (It's optional). Default value - true. The adapter supports following modes: true - in this mode, the adapter will create/update each autotest in real time false - in this mode, the adapter will create/update multiple autotests	importRealtime	TMS_IMPORT_REALTIME	tmsImportRealtime
Url of proxy server (It's optional)	tmsProxy	TMS_PROXY	tmsProxy
Name (including extension) of the configuration file If it is not provided, it is used default file name (It's optional)	-	TMS_CONFIG_FILE	tmsConfigFile

File

Add [testit] block to your pyproject.toml or create connection_config.ini file in the root directory of the project:

[testit]
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
automaticUpdationLinksToTestCases = AUTOMATIC_UPDATION_LINKS_TO_TEST_CASES
importRealtime = IMPORT_REALTIME

# This section are optional. It enables debug mode.
[debug]
tmsProxy = TMS_PROXY

Examples

Launch with a pyproject.toml or connection_config.ini file in the root directory of the project:

$ pytest --testit

Enable debug logs:

$ pytest --testit --log-cli-level=DEBUG

Launch with command-line parameters:

$ pytest --testit --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_CASES --tmsAutomaticUpdationLinksToTestCases=AUTOMATIC_UPDATION_LINKS_TO_TEST_CASES --tmsImportRealtime=IMPORT_REALTIME

If you want to enable debug mode then see How to enable debug logging?

Run with filter

To create filter by autotests you can use the Test IT CLI (use adapterMode 1 for run with filter):

$ export TMS_TOKEN=<YOUR_TOKEN>
$ testit autotests_filter 
  --url https://tms.testit.software \
  --configuration-id 5236eb3f-7c05-46f9-a609-dc0278896464 \
  --testrun-id 6d4ac4b7-dd67-4805-b879-18da0b89d4a8 \
  --framework pytest \
  --output tmp/filter.txt
  
$ pytest "$(cat tmp/filter.txt)" --tmsTestRunId=6d4ac4b7-dd67-4805-b879-18da0b89d4a8 --tmsAdapterMode=1 --testit

Decorators

Decorators can be used to specify information about autotest.

Description of decorators:

• testit.workItemIds - a method that links autotests with manual tests. Receives the array of manual tests' IDs
• testit.displayName - internal autotest name (used in Test IT)
• testit.externalId - unique internal autotest ID (used in Test IT)
• testit.title - autotest name specified in the autotest card. If not specified, the name from the displayName method is used
• testit.description - autotest description specified in the autotest card
• testit.labels - tags listed in the autotest card
• testit.link - links listed in the autotest card
• testit.step - the designation of the step called in the body of the test or other step
• testit.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.addWorkItemIds - a dynamic method that links autotests with manual tests. Receives the array of manual tests' IDs
• testit.addDisplayName - a dynamic method for adding internal autotest name (used in Test IT)
• testit.addExternalId - a dynamic method for adding unique internal autotest ID (used in Test IT)
• testit.addTitle - a dynamic method for adding autotest name specified in the autotest card. If not specified, the name from the displayName method is used
• testit.addDescription - a dynamic method for adding autotest description specified in the autotest card
• testit.addLabels - a dynamic method for adding tags listed in the autotest card
• testit.addLinks - links in the autotest result
• testit.addAttachments - uploading files in the autotest result
• testit.addMessage - information about autotest in the autotest result
• testit.addNameSpace - a dynamic method for adding directory in the TMS system (default - file's name of test)
• testit.addClassName - a dynamic method for adding subdirectory in the TMS system (default - class's name of test)
• testit.addParameter - a dynamic method for adding parameter in the autotest result
• testit.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.