Skip to main content

Test Gear TMS adapter for Nose

Test Gear

Release Status Downloads GitHub contributors

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
Url of proxy server (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 = TMS_PROXY

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 - a method that links autotests with manual tests. Receives the array of manual tests' IDs
  • testgear.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 used
  • testgear.description - autotest description specified in the autotest card
  • testgear.labels - tags listed in the autotest card
  • testgear.link - links listed 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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

testgear_adapter_nose-2.2.1.tar.gz (10.1 kB view details)

Uploaded Source

File details

Details for the file testgear_adapter_nose-2.2.1.tar.gz.

File metadata

  • Download URL: testgear_adapter_nose-2.2.1.tar.gz
  • Upload date:
  • Size: 10.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for testgear_adapter_nose-2.2.1.tar.gz
Algorithm Hash digest
SHA256 80ba3e9847cbbfb39638fb4d5e9857b2734634689d4f951e5f2409a1c6ffd907
MD5 6a041e793007fed17bd7dde676998ecf
BLAKE2b-256 2348eee25310cf8c166d24d56bf0951cb9b51e8a425154f9d1cec3e8d415a364

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

2.2.1 This release

1 file

2.2.0

1 file

2.1.3

1 file

2.1.2

1 file

2.1.1

1 file

2.1.0

1 file

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page