testgear-adapter-nose 2.1.3

Nose adapter for Test Gear

Test Gear TMS adapter for Nose

Getting Started

Installation

pip install testgear-adapter-nose

Usage

Configuration

Description	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 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
It enables debug mode (It's optional)	tmsProxy	TMS_PROXY	tmsProxy
Name of the configuration file If it is not provided, it is used default file name (It's optional)	-	TMS_CONFIG_FILE	tmsConfigFile

File

Create connection_config.ini file 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 = {"http": "http://localhost:8888", "https": "http://localhost:8888"}

Examples

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

$ nose2 --testgear

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:

• testgear.workItemIds - linking an autotest to a test case
• testgear.displayName - name of the autotest in the TMS system (can be replaced with documentation strings)
• testgear.externalId - ID of the autotest within the project in the TMS System
• testgear.title - title in the autotest card
• testgear.description - description in the autotest card
• testgear.labels - tags in the work item
• testgear.link - links in the autotest card
• testgear.step - the designation of the step called in the body of the test or other step
• testgear.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 attributes

Description of methods:

• testgear.addLinks - links in the autotest result
• testgear.addAttachments - uploading files in the autotest result
• testgear.addMessage - information about autotest in the autotest result
• testgear.step - usage in the "with" construct to designation a step in the body of the test

Examples

Simple test

import pytest
import testgear


# Test with a minimal set of decorators
@testgear.externalId('Simple_autotest2')
def test_2():
    """Simple autotest 2"""
    assert oneStep()
    assert twoStep()


@testgear.step
def oneStep():
    assert oneOneStep()
    assert oneTwoStep()
    return True


@testgear.step
def twoStep():
    return True


@testgear.step('step 1.1', 'description')
def oneOneStep():
    return True


@testgear.step('step 2')
def oneTwoStep():
    return True

Parameterized test

# Parameterized test with a full set of decorators
from os.path import join, dirname

import testgear
from nose2.tools import params

@params(1, 2, 3)
@testgear.workItemIds(627)
@testgear.externalId('param {num}')
@testgear.displayName('param {num}')
@testgear.title('Test with params')
@testgear.description('E2E_autotest')
@testgear.labels('parameters', 'test')
@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')
def test_nums(num):
    assert num < 4

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.