pytest-test-radar 0.0.1a1__py3-none-any.whl

pytest_test_radar/__init__.py

@@ -0,0 +1,21 @@
+# The MIT License (MIT).
+#
+# Copyright (c) 2024 Almaz Ilaletdinov <a.ilaletdinov@yandex.ru>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+# OR OTHER DEALINGS IN THE SOFTWARE.

pytest_test_radar/plugin.py

@@ -0,0 +1,75 @@
+# The MIT License (MIT).
+#
+# Copyright (c) 2024 Almaz Ilaletdinov <a.ilaletdinov@yandex.ru>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+# OR OTHER DEALINGS IN THE SOFTWARE.
+
+import base64
+import datetime
+import zlib
+
+import httpx
+import pytest
+
+http_session = httpx.Client()
+session_start_date = datetime.datetime.now(tz=datetime.UTC).isoformat()
+
+
+def pytest_addoption(parser: pytest.Parser) -> None:
+    help_text = 'Test radar endpoint'
+    parser.addini('radar_endpoint', type='string', help=help_text)
+    parser.addoption('--radar-endpoint', help=help_text)
+
+
+def pytest_configure(config: pytest.Config) -> None:
+    if config.option.help:
+        return
+    if not config.getini('radar_endpoint') and not config.getoption('--radar-endpoint'):
+        msg = 'Provide `--radar-endpoint` in cli option or `radar_endpoint` in config file`'
+        raise pytest.UsageError(msg)
+
+
+def pytest_sessionstart(session: pytest.Session) -> None:
+    http_session.base_url = session.config.getoption('--radar-endpoint') or session.config.getini('radar_endpoint')
+
+
+def pytest_runtest_logreport(report: pytest.TestReport) -> None:
+    logs = ''
+    if report.when == 'call' and report.failed:
+        compressed = zlib.compress(report.longreprtext.encode('utf-8'))
+        encoded = base64.b64encode(compressed)
+        logs = encoded.decode('utf-8')
+    if report.when == 'call':
+        try:
+            response = http_session.post(
+                '/api/v1/test_record/create/',
+                json={
+                    'label': report.nodeid,
+                    'timestamp': session_start_date,
+                    'logs': logs,
+                    'success': not report.failed,
+                },
+            )
+            response.raise_for_status()
+        except httpx.HTTPError as exc:
+            print(f'Some error occured on sending test record to radar. Exc: {exc}')
+
+
+def pytest_sessionfinish(session: pytest.Session, exitstatus: int) -> None:
+    http_session.close()

pytest_test_radar-0.0.1a1.dist-info/METADATA

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: pytest-test-radar
+Version: 0.0.1a1
+Summary: A pytest plugin to send test statistics to Test Radar.
+Project-URL: Homepage, https://github.com/yourusername/pytest-test-radar
+License: MIT
+License-File: LICENSE
+Keywords: flaky,plugin,pytest,test
+Classifier: Framework :: Pytest
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.28.1
+Description-Content-Type: text/markdown
+
+<!--
+The MIT License (MIT).
+
+Copyright (c) 2024 Almaz Ilaletdinov <a.ilaletdinov@yandex.ru>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+OR OTHER DEALINGS IN THE SOFTWARE.
+-->
+
+# pytest-test-radar
+
+pytest-test-radar is a pytest plugin designed to send test execution statistics
+to a centralized server. This allows teams to monitor flaky tests,
+track performance, and identify redundant or overly stable tests that might
+not be adding value to the test suite.
+
+## Features
+
+- Collects test execution statistics, including:
+  - Test name
+  - Outcome (passed, failed, skipped)
+  - Execution duration
+- Sends data to a configured HTTP endpoint.
+- Easy integration with any centralized monitoring system.
+
+## Installation
+
+You can install it to your project dependencies:
+
+```bash
+pip install pytest-test-radar
+```
+
+## Usage
+
+Run pytest with the --test-radar-endpoint option to specify the server where statistics will be sent:
+
+```bash
+pytest --test-radar-endpoint="http://your-server.com/api/test-results"
+```
+
+## Example
+
+Create a sample test file:
+
+```python
+# test_sample.py
+def test_pass():
+    assert 1 == 1
+
+def test_fail():
+    assert 1 == 2
+```
+
+Run the tests with the plugin:
+
+```bash
+pytest test_sample.py --test-radar-endpoint="http://localhost:8000/api/test-results"
+```
+
+This will send the following payload to the specified endpoint:
+
+```json
+{
+  "total_tests": 2,
+  "results": [
+    {
+      "test_name": "test_sample.py::test_pass",
+      "outcome": "passed",
+      "duration": 0.001
+    },
+    {
+      "test_name": "test_sample.py::test_fail",
+      "outcome": "failed",
+      "duration": 0.002
+    }
+  ]
+}
+```

pytest_test_radar-0.0.1a1.dist-info/RECORD

@@ -0,0 +1,7 @@
+pytest_test_radar/__init__.py,sha256=mOJVtg77FU7cAoy7ir2HJi-j9iZGIoFLkNq09Mio6EM,1149
+pytest_test_radar/plugin.py,sha256=1NnFAvcZxAefiMf5GWnl-MCIqfdfkYbtZoXuniu8VuM,2955
+pytest_test_radar-0.0.1a1.dist-info/METADATA,sha256=cXIitz4IV7rXJxiExoZ63mL_fVdVtBSTpq6Zx5541vQ,3110
+pytest_test_radar-0.0.1a1.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+pytest_test_radar-0.0.1a1.dist-info/entry_points.txt,sha256=9F-A6rwGFGdDz_P--tAO29NlKMmdhkuLUqaGRUprfjQ,49
+pytest_test_radar-0.0.1a1.dist-info/licenses/LICENSE,sha256=Gc1FKRVA4g5qs0MnMY6K-zVZr-SQey28xj98ARzxr6E,1111
+pytest_test_radar-0.0.1a1.dist-info/RECORD,,

pytest_test_radar-0.0.1a1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pytest_test_radar-0.0.1a1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+test_radar = pytest_test_radar.plugin

pytest_test_radar-0.0.1a1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT).
+
+Copyright (c) 2024 Almaz Ilaletdinov <a.ilaletdinov@yandex.ru>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+OR OTHER DEALINGS IN THE SOFTWARE.