stress-tool 1.0.0__tar.gz

stress_tool-1.0.0/.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

stress_tool-1.0.0/.gitignore

@@ -0,0 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

stress_tool-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Nick Tsai
+
+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.

stress_tool-1.0.0/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.3
+Name: stress_tool
+Version: 1.0.0
+Summary: Stress test tool with statistical TPS reports based on Worker Dispatcher in Python
+Project-URL: Homepage, https://github.com/yidas/python-stress-tool
+Project-URL: Issues, https://github.com/yidas/python-stress-tool/issues
+Author-email: Nick Tsai <myintaer@gmail.com>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.0
+Requires-Dist: openpyxl>=3.0.0
+Requires-Dist: worker-dispatcher>=1.0.6
+Description-Content-Type: text/markdown
+
+# python-stress-test
+Developing

stress_tool-1.0.0/README.md

@@ -0,0 +1,2 @@
+# python-stress-test
+Developing

stress_tool-1.0.0/pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "stress_tool"
+version = "1.0.0"
+authors = [
+  { name="Nick Tsai", email="myintaer@gmail.com" },
+]
+description = "Stress test tool with statistical TPS reports based on Worker Dispatcher in Python"
+readme = "README.md"
+requires-python = ">=3.0"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "worker-dispatcher>=1.0.6",
+    "openpyxl>=3.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/yidas/python-stress-tool"
+Issues = "https://github.com/yidas/python-stress-tool/issues"

stress_tool-1.0.0/src/stress_tool/__init__.py

@@ -0,0 +1 @@
+from .stress_tool import *

stress_tool-1.0.0/src/stress_tool/stress_tool.py

@@ -0,0 +1,152 @@
+import worker_dispatcher as lib_worker_dispatcher
+import time, datetime, copy
+import openpyxl
+
+default_config = {
+    'raw_logs': {
+        'fields': {}
+    },
+}
+
+def start(config: dict, worker_dispatcher: object=None):
+    worker_dispatcher = lib_worker_dispatcher if worker_dispatcher is None else worker_dispatcher
+    return worker_dispatcher.start(config)
+
+def generate_report(config: dict={}, worker_dispatcher: object=None, file_path: str='./tps-report.xlsx'):
+
+    config =_merge_dicts_recursive(default_config, config)
+
+    worker_dispatcher = lib_worker_dispatcher if worker_dispatcher is None else worker_dispatcher
+
+    # TPS calculation
+    tps_data = worker_dispatcher.get_tps(interval=1, display_intervals=True)
+    wd_config = worker_dispatcher.get_last_config()
+
+    # Create a new Workbook
+    workbook = openpyxl.Workbook()
+
+    # Sheet for TPS Report
+    sheet = workbook.active
+    sheet.title = "Report"
+    # Taipei timezone
+    datetime_gmt = datetime.timezone(datetime.timedelta(hours=time.localtime().tm_gmtoff / 3600))
+    # Each row data
+    rows_data = []
+    rows_data.append([])
+    rows_data.append(["TPS", tps_data['tps']])
+    rows_data.append(["Started at", datetime.datetime.fromtimestamp(tps_data['started_at'], datetime_gmt).isoformat()])
+    rows_data.append(["Ended at", datetime.datetime.fromtimestamp(tps_data['ended_at'], datetime_gmt).isoformat()])
+    rows_data.append(["Total Duration", "{:.6f} sec".format(tps_data['duration'])])
+    rows_data.append(["Number of Requests", tps_data['count']['total']])
+    if wd_config['worker'].get('per_second'):
+        rows_data.append(["Concurrency per second", int(wd_config['worker']['number'] / wd_config['worker']['per_second'])])
+    else:
+        rows_data.append(["Concurrency", wd_config['worker']['number']])
+    rows_data.append(["Number of Successes", tps_data['count']['success']])
+    rows_data.append(["Success Rate", "{:.2f}%".format(tps_data['count']['success'] / tps_data['count']['total'] * 100 if tps_data['count']['total'] > 0 else 0)])
+    rows_data.append(["Metrices:"])
+    rows_data.append(["Average Execution Time", "{:.6f} sec".format(tps_data['metrics']['execution_time']['avg'])])
+    rows_data.append(["Maximum Execution Time", "{:.6f} sec".format(tps_data['metrics']['execution_time']['max'])])
+    rows_data.append(["Minimum Execution Time", "{:.6f} sec".format(tps_data['metrics']['execution_time']['min'])])
+    rows_data.append(["Success Average Execution Time", "{:.6f} sec".format(tps_data['metrics']['success_execution_time']['avg'])])
+    rows_data.append(["Success Maximum Execution Time", "{:.6f} sec".format(tps_data['metrics']['success_execution_time']['max'])])
+    rows_data.append(["Success Minimum Execution Time", "{:.6f} sec".format(tps_data['metrics']['success_execution_time']['min'])])
+    # Peak TPS
+    if tps_data['peak']:
+        rows_data.append([])
+        rows_data.append(["Peak TPS", tps_data['peak']['tps']])
+        rows_data.append(["Peak Started at", datetime.datetime.fromtimestamp(round(tps_data['peak']['started_at'], 3), datetime_gmt).isoformat()])
+        rows_data.append(["Peak Ended at", datetime.datetime.fromtimestamp(round(tps_data['peak']['ended_at'], 3), datetime_gmt).isoformat()])
+        rows_data.append(["Peak Duration", "{:.6f} sec".format(tps_data['peak']['duration'])])
+        rows_data.append(["Peak Number of Requests", tps_data['peak']['count']['total']])
+        rows_data.append(["Peak Number of Successes", tps_data['peak']['count']['success']])
+        rows_data.append(["Peak Success Rate", "{:.2f}%".format(tps_data['peak']['count']['success'] / tps_data['peak']['count']['total'] * 100)])
+        rows_data.append(["Peak Metrices:"])
+        rows_data.append(["Average Execution Time", "{:.6f} sec".format(tps_data['peak']['metrics']['execution_time']['avg'])])
+        rows_data.append(["Maximum Execution Time", "{:.6f} sec".format(tps_data['peak']['metrics']['execution_time']['max'])])
+        rows_data.append(["Minimum Execution Time", "{:.6f} sec".format(tps_data['peak']['metrics']['execution_time']['min'])])
+        rows_data.append(["Success Average Execution Time", "{:.6f} sec".format(tps_data['peak']['metrics']['success_execution_time']['avg'])])
+        rows_data.append(["Success Maximum Execution Time", "{:.6f} sec".format(tps_data['peak']['metrics']['success_execution_time']['max'])])
+        rows_data.append(["Success Minimum Execution Time", "{:.6f} sec".format(tps_data['peak']['metrics']['success_execution_time']['min'])])
+    rows_data.append([])
+    rows_data.append(["Raw Report", str(tps_data)])
+    for row in rows_data:
+        sheet.append(row)
+    # writer.writerows(rows_data)
+    # csv_file.close() 
+
+    # Sheet for Raw Logs
+    sheet = workbook.create_sheet(title="Raw Logs")
+    # header
+    header_row = ["Task ID", "Started at", "Ended at", "Duration (sec)"]
+    # Customized Fields
+    customized_fields = config['raw_logs']['fields']
+    for key, value in customized_fields.items():
+        header_row.append(key)
+    sheet.append(header_row)
+
+    # Each row
+    for log in worker_dispatcher.get_logs():
+        row_data = [log['task_id'], str(log['started_at']), str(log['ended_at']), log['ended_at'] - log['started_at']]
+        # Customized Fields
+        user_log = log.get('log', {})
+        for key, value in customized_fields.items():
+            if callable(value):
+                try:
+                    row_data.append(value(user_log))
+                except Exception as e:
+                    # exit(e)
+                    pass
+            else:
+                row_data.append(str(user_log.get(value, '')))
+        sheet.append(row_data)
+
+    # Sheet for Interval
+    if tps_data['intervals']:
+        sheet = workbook.create_sheet(title="Intervals")
+        # header
+        sheet.append([
+            "TPS", 
+            "Started at", 
+            "Ended at", 
+            "Duration (sec)", 
+            "Success", 
+            "Total (Done)", 
+            "Request",
+            "Response",
+            "Average Execution Time", 
+            "Success Average Execution Time"
+        ])
+        for row in tps_data['intervals']:
+            row_data = [
+                row['tps'], 
+                str(row['started_at']), 
+                str(row['ended_at']), 
+                row['duration'], 
+                row['count']['success'], 
+                row['count']['total'], 
+                row['count']['start'], 
+                row['count']['end'], 
+                row['metrics']['execution_time']['avg'],
+                row['metrics']['success_execution_time']['avg']
+            ]
+            # exit(row_data)
+            sheet.append(row_data)
+
+    # Save workbook
+    workbook.save(file_path) 
+
+    return file_path
+
+def _merge_dicts_recursive(default_dict, user_dict):
+    merged_dict = copy.deepcopy(default_dict)
+    for key, user_value in user_dict.items():
+        if key in merged_dict:
+            if isinstance(merged_dict[key], dict) and isinstance(user_value, dict):
+                merged_dict[key] = _merge_dicts_recursive(merged_dict[key], user_value)
+            else:
+                merged_dict[key] = user_value
+        else:
+            merged_dict[key] = user_value
+    
+    return merged_dict