Skip to main content

lockable resource plugin for pytest

Project description

pytest-lockable

CircleCI PyPI version Coverage Status

pytest plugin for lockable resources.

Replacement for Jenkins lockable -plugin. Locking is implemented using <resource-id>.pid files and is released automatically.

Resources are automatically released when pytest ends.

Resources are described in json file as array of objects. Each object has some mandatory fields but can contains any other as well. Required fields are: id, online, hostname.

Example resources.json

[
  {
    "id": "1234",
    "online": true,
    "hostname": "localhost",
    "os": "Android"
  }
]

id should be unique for each resources. online describes if resource are available for allocator. Set this false if you don't want to allocate resource. hostname is used to select suitable resource by running host.

Usage:

pytest --allocation_hostname localhost -s --allocation_requirements os=Android my_test

installation

Requires: python 3.7<

pip install pytest-lockable

integrations

pytest-lockable integrates pytest-metadata - when resource is reserved and pytest-metadata plugin are in use metadata will be generated from resource json with resource_ -prefixes. e.g. resource_id=<id>. Same dictionary are also recorded to testsuite property using record_testsuite_property -method.

Usage

Custom options:

--allocation_hostname=<hostname>, default=<os-hostname>  Allocation host
--allocation_requirements=<requirements>                 Resource requirements to be allocate
--allocation_timeout=<timeout>, default=10               Allocation timeout in seconds
--allocation_resource_list_file=<filename>, default=resources.json 
                                                         Available resorces list
--allocation_lock_folder=<folder>, default=<os-tmp-path> allocation lockfiles folder

<requirements> can be json-string or key-value pairs. requirements have to match available resources to make allocation possible. Key-value pairs example: key=value&key2=value2

Example:

Use shared lockable resource

def test_example(lockable_resource):
    """ Simple test """
    print(f'Testing with resource: {lockable_resource}')

Allocate lockable resource during test with given requirements

def test_example(lockable):
    """ Simple test """
    with lockable.auto_lock({"my": "requirements"}) as allocation:
        print(f'Testing with resource#: {allocation.resource_id}')

See example test. Usage:

cd example
pytest --allocation_hostname localhost -s --allocation_lock_folder . .

Project details


Download files

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

Source Distribution

pytest-lockable-0.9.1.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

pytest_lockable-0.9.1-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file pytest-lockable-0.9.1.tar.gz.

File metadata

  • Download URL: pytest-lockable-0.9.1.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.12

File hashes

Hashes for pytest-lockable-0.9.1.tar.gz
Algorithm Hash digest
SHA256 7a7bdcd16b1a854adabdf7ef51c4324c32bfe00d6b2228764250bafc497c28fd
MD5 b71a1c9b744cc0651485032c90e62642
BLAKE2b-256 4505a011fc5c0d65c52ced973bfc8d4246b4cdbcbf9c6217466923ad06f838bd

See more details on using hashes here.

File details

Details for the file pytest_lockable-0.9.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_lockable-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4a02c239fb70f99dfd6b12d0aea42cedfb481d2facd377d03d399bee45b7f673
MD5 b20166ae3475cd9807a5b5889279e0d2
BLAKE2b-256 79b0e3001c793ed6502bf67905ac63bb84a077dc2f55f56eca8bf125990c4e7f

See more details on using hashes here.

Supported by

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