Metadata-Version: 2.1
Name: locust-plugin-result
Version: 0.0.2
Summary: Locust plugin for providing FAIL/PASS result of test run.
Home-page: https://github.com/lhupfeldt/locust-plugin-result
Author: Lars Hupfeldt Nielsen
Author-email: lhn@hupfeldtit.dk
License: BSD
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.6.0
Description-Content-Type: text/x-rst
Requires-Dist: locust (>=1.2.3)
Requires-Dist: multiconf (>=9.1.1)

# Locust Plugin to provide FAIL/PASS status for entire test run

## Links

* Locust Website: <a href="https://locust.io">locust.io</a>

## Description

This locust plugin extends Locust with the concept of test run PASS/FAIL

## Features

**Utility function to set result**

In your locustfile.py::

  from locust_plugin_result import RESULT_PASS, RESULT_FAIL, set_result

  ...
    # Inside event callback
    set_result(environment.runner, RESULT_FAIL, "Failed check of ...")

See examples/result.py for details.

**Endpoint to get status**::

  http://<locust-master>/status

Returns json::

  {
    'result': None,  # Result will be None until your locustfile sets it.
    'state': 'ready',
    'worker_count': None,  # None for LocalWorker - current number of workers if running distributed 
    'user_count': 0
  }

## Authors

Lars Hupfeldt Nielsen

## License

Open source licensed under the BSD license (see _LICENSE_ file for details).


