=========================
.. image:: https://travis-ci.org/linkdd/unittest2canopsis.svg?branch=master
This package provides a connector which will executes Python unittest to generate
events for Canopsis.
Usage
-----
In this example, we will use the following test (as ``mytest.py``):
.. code-block:: python
# -*- coding: utf-8 -*-
import unittest
class MyTestCase(unittest.TestCase):
def test_success(self):
self.assertTrue(True)
def test_fail(self):
self.assertFalse(True)
if __name__ == '__main__':
unittest.main()
Run the unittest on :
.. code-block::
$ unittest2canopsis -t mytest.py -n mytest0 -a "amqp://guest:guest@localhost:5672/"
unittest.mytest0.check.resource.MyTestCase.test_fail... FAIL
unittest.mytest0.check.resource.MyTestCase.test_success... OK
You can also use a JSON configuration file :
.. code-block:: javascript
{"tcp2canopsis": {
"test": "mytest.py",
"testname": "mytest0",
"amqp": "amqp://guest:guest@localhost:5672/"
}}
And load the file using :
.. code-block::
$ unittest2canopsis -c path/to/config.json
Example of generated events :
.. code-block:: javascript
{
"timestamp": 1418206046,
"connector": "unittest",
"connector_name": "mytest0",
"event_type": "check",
"source_type": "resource",
"component": "MyTestCase",
"resource": "test_fail",
"state": 2,
"state_type": 1,
"output": "Traceback (most recent call last):\n File \"mytest.py\", line 11, in test_fail\n self.assertFalse(True)\nAssertionError: True is not false\n"
}
{
"timestamp": 1418206046,
"connector": "unittest",
"connector_name": "mytest0",
"event_type": "check",
"source_type": "resource",
"component": "MyTestCase",
"resource": "test_success",
"state": 0,
"state_type": 1,
"output": "OK"
}
Installation
------------
Just type :
.. code-block::
$ pip install unittest2canopsis
Or, to install it in a locally :
.. code-block::
$ ./makefile
This will create a virtual Python environment in the current folder, and install the dependencies listed by ``requirements.txt``.
Finally, it will perform a ``python setup.py install``.
After executing this script, the connector will be available in the current folder (which is now a virtual Python environment).
Metadata
Release files for unittest2canopsis 0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| unittest2canopsis-0.2.tar.gz | 3.7 kB | Without provenance | Details for unittest2canopsis-0.2.tar.gz |
Release files / unittest2canopsis-0.2.tar.gz
| Download URL | unittest2canopsis-0.2.tar.gz |
|---|---|
| Size | 3.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
66b08721f0270be230026d10807a392d47dbb7f527775386713d7cc904d9986b
|
|
BLAKE2b-256 checksum How to use checksums |
2092cf5f5e72e09ac901dd17ea97b0bc5dc203e3e99a1452f8945277bb834f83
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for unittest2canopsis 0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.