pytest-exasol-benchmark 0.1.0__tar.gz

pytest_exasol_benchmark-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Exasol
+
+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_exasol_benchmark-0.1.0/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: pytest-exasol-benchmark
+Version: 0.1.0
+Summary: 
+License-Expression: MIT
+License-File: LICENSE
+Author: Exasol AG
+Author-email: opensource@exasol.com
+Requires-Python: >=3.10,<3.14
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: pytest (>=9.1.1,<10.0.0)
+Requires-Dist: pytest-benchmark (>=5.2.3,<6.0.0)
+Requires-Dist: sqlglot (>=30.13.0,<31.0.0)
+Project-URL: Homepage, https://github.com/exasol/pytest-exasol-benchmark
+Project-URL: Repository, https://github.com/exasol/pytest-exasol-benchmark
+Description-Content-Type: text/x-rst
+
+pytest-exasol-benchmark Plugin
+==============================
+
+
+
+.. image:: https://img.shields.io/pypi/l/pytest_exasol_benchmark
+    :target: https://opensource.org/licenses/MIT
+    :alt: License
+
+.. image:: https://img.shields.io/pypi/dm/pytest_exasol_benchmark
+    :target: https://pypi.org/project/pytest_exasol_benchmark/
+    :alt: Downloads
+
+.. image:: https://img.shields.io/pypi/pyversions/pytest_exasol_benchmark
+    :target: https://pypi.org/project/pytest_exasol_benchmark/
+    :alt: Supported Python Versions
+
+.. image:: https://img.shields.io/pypi/v/pytest_exasol_benchmark
+    :target: https://pypi.org/project/pytest_exasol_benchmark/
+    :alt: PyPi Package
+
+🚀 Features
+-----------
+
+🔌️ Prerequisites
+-----------------
+
+- `Python <https://www.python.org/>`__ >= 3.10
+
+💾 Installation
+---------------
+
+.. code-block:: shell
+
+    pip install pytest_exasol_benchmark
+
+.. 📚 Documentation
+   ----------------
+
+   For further details, check out the latest `documentation <https://exasol.github.io/pytest-exasol-benchmark/>`_.
+

pytest_exasol_benchmark-0.1.0/README.rst

@@ -0,0 +1,40 @@
+pytest-exasol-benchmark Plugin
+==============================
+
+
+
+.. image:: https://img.shields.io/pypi/l/pytest_exasol_benchmark
+    :target: https://opensource.org/licenses/MIT
+    :alt: License
+
+.. image:: https://img.shields.io/pypi/dm/pytest_exasol_benchmark
+    :target: https://pypi.org/project/pytest_exasol_benchmark/
+    :alt: Downloads
+
+.. image:: https://img.shields.io/pypi/pyversions/pytest_exasol_benchmark
+    :target: https://pypi.org/project/pytest_exasol_benchmark/
+    :alt: Supported Python Versions
+
+.. image:: https://img.shields.io/pypi/v/pytest_exasol_benchmark
+    :target: https://pypi.org/project/pytest_exasol_benchmark/
+    :alt: PyPi Package
+
+🚀 Features
+-----------
+
+🔌️ Prerequisites
+-----------------
+
+- `Python <https://www.python.org/>`__ >= 3.10
+
+💾 Installation
+---------------
+
+.. code-block:: shell
+
+    pip install pytest_exasol_benchmark
+
+.. 📚 Documentation
+   ----------------
+
+   For further details, check out the latest `documentation <https://exasol.github.io/pytest-exasol-benchmark/>`_.

pytest_exasol_benchmark-0.1.0/doc/changes/changelog.md

@@ -0,0 +1,12 @@
+# Changes
+
+* [unreleased](unreleased.md)
+* [0.1.0](changes_0.1.0.md)
+
+```{toctree}
+---
+hidden:
+---
+unreleased
+changes_0.1.0
+```

pytest_exasol_benchmark-0.1.0/exasol/pytest_benchmark/__init__.py

@@ -0,0 +1,154 @@
+from contextlib import contextmanager
+from importlib.metadata import version
+
+from sqlglot import (
+    Dialects,
+    exp,
+)
+
+__version__ = version("pytest_exasol_benchmark")
+import logging
+from collections.abc import Callable
+from typing import (
+    Any,
+    TypeAlias,
+)
+
+import pytest
+from sqlglot.expressions import (
+    Query,
+    Select,
+)
+
+logger = logging.getLogger(__name__)
+
+QueryResult: TypeAlias = Any
+QueryFunc: TypeAlias = Callable[[str], QueryResult]
+
+MAX_UNIONS: int = 100
+
+
+def linear_row_sql_data_generator(
+    schema_name: str,
+    output_table_name: str,
+    input_table_name: str,
+    factor: int,
+    max_unions: int = MAX_UNIONS,
+) -> list[str]:
+    """
+    Generate SQL statements that copy rows from `schema.input_table_name` to `schema.output_table_name`
+    `factor` times using UNION ALL. For each `max_unions` a new SQL statement is added to the list.
+
+    Returns a list of SQL statements.
+    Example:
+        factor=3,   max_unions=100 -> 1 SQL statement
+        factor=150, max_unions=100 -> 2 SQL statements: 150 + 50
+    """
+    if factor < 1:
+        raise ValueError("factor must be greater than 0")
+    if max_unions < 1 or max_unions > MAX_UNIONS:
+        raise ValueError(f"max_unions must be between 1 and {MAX_UNIONS}")
+
+    sql_statements: list[str] = []
+    remaining = factor
+
+    input_table = exp.table_(table=input_table_name, db=schema_name)
+    output_table = exp.table_(table=output_table_name, db=schema_name)
+
+    while remaining > 0:
+        batch_size: int = min(remaining, max_unions)
+
+        selects: list[Select] = [
+            exp.select("*").from_(input_table.copy()) for _ in range(batch_size)
+        ]
+
+        query: Query = selects[0]
+        for next_select in selects[1:]:
+            query = query.union(next_select, distinct=False)
+
+        insert = exp.Insert(
+            expression=query,
+            into=output_table.copy(),
+        )
+
+        sql_statements.append(insert.sql(dialect=Dialects.EXASOL, pretty=True))
+        remaining -= batch_size
+
+    return sql_statements
+
+
+def exponential_row_sql_data_generator(
+    schema_name: str,
+    output_table_name: str,
+    input_table_name: str,
+    exponent: int = 1,
+) -> list[str]:
+    """Generate SQL statements that grow ``output_table_name`` exponentially.
+
+    The first SQL statement copies the input table to the output table.
+    Each subsequent SQL statement inserts the output table into itself, doubling its
+    row count. Consequently, executing all returned SQL statements produces
+    ``2 ** exponent`` copies of the input table's rows.
+    """
+    if exponent < 1:
+        raise ValueError("exponent must be greater than or equal to 1")
+
+    input_table = exp.table_(table=input_table_name, db=schema_name)
+    output_table = exp.table_(table=output_table_name, db=schema_name)
+
+    source_tables = [input_table, *([output_table] * exponent)]
+    return [
+        exp.Insert(
+            this=output_table.copy(),
+            expression=exp.select("*").from_(source_table.copy()),
+        ).sql(dialect=Dialects.EXASOL, pretty=True)
+        for source_table in source_tables
+    ]
+
+
+@pytest.fixture
+def query_func() -> QueryFunc:
+    """
+    The fixture shall return a function which can be used to execute SQL queries.
+    The user has to override this fixture.
+    """
+    raise NotImplementedError("Override of fixture 'query_func' not implemented")
+
+
+def get_enable_query_cache_sql() -> str:
+    return "alter session set query_cache='on'"
+
+
+def get_disable_query_cache_sql() -> str:
+    return "alter session set query_cache='off'"
+
+
+@contextmanager
+def disable_query_cache_session(query_func: QueryFunc, disable_query_cache: bool):
+    if disable_query_cache:
+        query_func(get_disable_query_cache_sql())
+    yield
+    if disable_query_cache:
+        query_func(get_enable_query_cache_sql())
+
+
+@pytest.fixture
+def exasol_benchmark(benchmark, query_func: QueryFunc):
+    def run_benchmark(
+        target: Callable,
+        args: tuple = (),
+        rounds=1,
+        warmup_rounds=0,
+        iterations=1,
+        disable_query_cache: bool = True,
+    ):
+        with disable_query_cache_session(query_func, disable_query_cache):
+            return benchmark.pedantic(
+                target=target,
+                args=args,
+                rounds=rounds,
+                warmup_rounds=warmup_rounds,
+                iterations=iterations,
+            )
+
+    return run_benchmark

pytest_exasol_benchmark-0.1.0/pyproject.toml

@@ -0,0 +1,109 @@
+[project]
+name = "pytest-exasol-benchmark"
+version = "0.1.0"
+description = ""
+authors = [
+    { name = "Exasol AG", email = "opensource@exasol.com" },
+]
+
+requires-python = ">=3.10,<3.14"
+readme = "README.rst"
+license = "MIT"
+license-files = ["LICENSE"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+
+dependencies = [
+    "pytest (>=9.1.1,<10.0.0)",
+    "pytest-benchmark (>=5.2.3,<6.0.0)",
+    "sqlglot (>=30.13.0,<31.0.0)"
+]
+
+[project.entry-points.pytest11]
+exasol_benchmark = "exasol.pytest_benchmark"
+
+[dependency-groups]
+dev = [
+    "exasol-toolbox>=10.3.0,<11",
+    "pyexasol (>=2.3.0,<3.0.0)",
+    "pytest-exasol-backend (>=1.5.1,<2.0.0)",
+    "pytest-exasol-extension (>=1.0.1,<2.0.0)"
+]
+
+[tool.poetry]
+requires-poetry = ">=2.3.0"
+packages = [
+    { include = "exasol" },
+]
+include = [
+    "README.rst",
+    "doc/changes/changelog.md",
+    "LICENSE",
+    "exasol/toolbox/templates/**/*"
+]
+
+[tool.poetry.requires-plugins]
+poetry-plugin-export = ">=1.8"
+
+[project.urls]
+repository = "https://github.com/exasol/pytest-exasol-benchmark"
+homepage = "https://github.com/exasol/pytest-exasol-benchmark"
+
+[build-system]
+requires = ["poetry-core>=2.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+# Tooling - marking what to show in the documentation
+[tool.coverage.run]
+relative_files = true
+source = [
+    "exasol",
+]
+
+[tool.coverage.report]
+# Switch to 15 after code has been added
+fail_under = 0
+
+[tool.black]
+line-length = 88
+verbose = false
+include = "\\.pyi?$"
+
+[tool.isort]
+profile = "black"
+force_grid_wrap = 2
+
+[tool.pylint.master]
+fail-under = 5.0
+ignore = []
+
+[tool.pylint.format]
+max-line-length = 88
+max-module-lines = 800
+
+[tool.ruff.lint]
+extend-ignore = [
+    "E", # Syntax errors
+    "F", # Pyflakes rules (excluding F401)
+    "UP", # pyupgrade rules
+    "D", # Docstring rules
+]
+extend-select = ["F401"]
+unfixable = []
+
+[[tool.mypy.overrides]]
+module = [
+    "test.*",
+]
+ignore_errors = true
+
+[tool.sonar]
+projectKey = "com.exasol:pytest-benchmark"
+host.url = "https://sonarcloud.io"
+organization = "exasol"
+sonar.tests = "test"