pytest-sort 0.0.1__tar.gz → 0.0.3__tar.gz

pytest-sort-0.0.3/PKG-INFO

@@ -0,0 +1,191 @@
+Metadata-Version: 2.1
+Name: pytest-sort
+Version: 0.0.3
+Summary: Tools for sorting test cases
+Author-email: Peter Busch <pbuschmail-pytestsort@yahoo.com>
+Maintainer-email: Peter Busch <pbuschmail-pytestsort@yahoo.com>
+License: MIT License
+        
+        Copyright (c) 2023 Peter Busch
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/WiredNerd/pytest-sort
+Project-URL: Bug Tracker, https://github.com/WiredNerd/pytest-sort/issues
+Keywords: test,pytest,order,sort,random,randomly
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Framework :: Pytest
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+![python>=3.8](https://img.shields.io/badge/python->=3.8-blue)
+
+# Project description
+
+pytest-sort is a pytest plugin to automatically change the execution order of test cases.  Changing the order of execution can help find test cases that only succeed because of a favorable state.
+
+This plugin provides several options for controlling how the test cases are reordered.
+
+# Quick Start
+
+Installation:
+
+```
+pip install pytest-sort --upgrade
+```
+
+Running with pytest-sort:
+
+```
+pytest --sort_mode=random
+```
+
+By default, all tests from the same module will run together.  This command will run the tests within the module in a random order.
+
+```
+pytest --help
+```
+
+In the pytest-sort section, all currently avaialable options will be listed.
+
+You may also set options in any [pytest configruation file](https://docs.pytest.org/en/stable/reference/customize.html).
+
+# Usage
+
+Ideally, all test cases should be small and independant.  This package provides several options for validating if test cases can really be run independantly, or if running them in a specific order is required.
+
+## Deterministic but Unpredictable
+
+The Junit package automatically runs test cases in a deterministic, but unpredictable order.  This package can provide similar functionality in pytest several ways.
+
+1. Using sort mode "md5" will produce the same order of tests every time as long as the test case names don't change.
+   ```toml
+   sort_mode="md5"
+   ```
+2. Using sort mode "random" with a fixed sort seed value will produce the same order of tests every time unles the list of test cases is changed (new test case, or name changes)
+   ```toml
+   sort_mode="random"
+   sort_seed=100
+   ```
+
+## Random
+
+By running in random mode, the test case order will change every time. If a test case fails unexpectedly, you can use the seed from the failed run to determine what order is causing the tests to fail.
+
+```toml
+sort_mode="random"
+```
+
+## Fail Fast
+
+When you have a test suite that includes long running test cases, it can be helpful to delay the longer running test cases till later.  The 'fastest' mode allows you to track how long different test cases take to run.  Then always run the fastest test cases first, and the slow test cases last.
+```cmd
+pytest --exitfirst --sort-mode=fastest
+```
+
+
+# Options
+
+## Sort Mode
+
+This option controlls how the order is modified within each bucket.
+
+This option must be set to something other than "none" to enable pytest_sort plugin.
+
+***Command Line:*** `--sort-mode`
+
+***Pytest Config:*** `sort_mode`
+
+***Default:*** `none`
+
+| Option | Definition | 
+| --- | --- |
+| none | pytest_sort will not modify the sort order.  This option disables pytest_sort. |
+| md5 | This mode creates an md5 of each test case id, then sorts on those values.  <br> This runs test cases in a deterministicly shuffled order. |
+| random | Test cases are shuffled randomly |
+| fastest | In each run in "fasttest" mode, the plugin will track the longest execution time for each test case in a file ".pytest-sort".  <br> At the beginning of a test run, any previously recorded values will be used to sort the tests so that the fastest test runs first.
+
+## Sort Bucket
+
+Sort test order within specified test buckets.
+
+For example, if the sort bucket is "module", then all tests from the same module will be completed before running tests for the next module.
+
+***Command Line:*** `--sort-bucket`
+
+***Pytest Config:*** `sort_bucket`
+
+***Default:*** `module`
+
+| Option | Definition | 
+| --- | --- |
+| global | Apply sort to all items together. |
+| package | Group together test cases that are in the same package (folder). |
+| module | Group together test cases that are in the same module (py file). |
+| class | Group together test cases that are members of a class.  <br>All other (non-class) test cases are grouped by module. |
+| parent | Group together test cases by their immediate parent. |
+| grandparent | Group together test cases by their parent's parent. |
+
+## Sort Seed
+
+Only used in "random" sort mode.  This field allows you to manually set the seed used by random package when sorting tests.
+
+> Tip: Seed is printed in the pytest header
+
+***Command Line:*** `--sort-seed`
+
+***Pytest Config:*** `sort_seed`
+
+***Default:*** A random integer between 0 and 1,000,000 generated at runtime.
+
+## Record Test Runtimes
+
+This option enables or disables pytest_sort to record test case runtimes.  These runtimes are used when sort mode is "fastest".  When sort mode is "fastest" recording is enabled by default, otherwise this is disabled by default.
+
+***Command Line:*** `--sort-record-times/--sort-no-record-times`
+
+***Pytest Config:*** `sort_record_times`
+
+***Default:*** false 
+
+| Option | Definition |
+| --- | --- |
+| `--sort-record-times`<br>`sort_record_times=true` | Record test case runtime statistics |
+| `--sort-no-record-times`<br>`sort_record_times=false` | Disable recording runtime statistics in "fastest" mode |
+
+## Reset Recorded Test Runtimes
+
+Clear all recorded runtimes before sorting the next test.
+
+When recording runtimes, only the highest runtime values for each test case are retained.  After significant changes to test cases that can change how fast they run, it is advisable to reset the runtimes.  This can help maintain more accurate sorting in "fastest" mode.
+
+***Command Line:*** `--sort-reset-times`
+
+***Pytest Config:*** N/A
+
+## Report Recorded Test Runtimes
+
+At the end of the test run, print out the currently saved test runtimes.
+
+***Command Line:*** `--sort-reset-times`
+
+***Pytest Config:*** N/A

pytest-sort-0.0.3/README.md

@@ -0,0 +1,152 @@
+![python>=3.8](https://img.shields.io/badge/python->=3.8-blue)
+
+# Project description
+
+pytest-sort is a pytest plugin to automatically change the execution order of test cases.  Changing the order of execution can help find test cases that only succeed because of a favorable state.
+
+This plugin provides several options for controlling how the test cases are reordered.
+
+# Quick Start
+
+Installation:
+
+```
+pip install pytest-sort --upgrade
+```
+
+Running with pytest-sort:
+
+```
+pytest --sort_mode=random
+```
+
+By default, all tests from the same module will run together.  This command will run the tests within the module in a random order.
+
+```
+pytest --help
+```
+
+In the pytest-sort section, all currently avaialable options will be listed.
+
+You may also set options in any [pytest configruation file](https://docs.pytest.org/en/stable/reference/customize.html).
+
+# Usage
+
+Ideally, all test cases should be small and independant.  This package provides several options for validating if test cases can really be run independantly, or if running them in a specific order is required.
+
+## Deterministic but Unpredictable
+
+The Junit package automatically runs test cases in a deterministic, but unpredictable order.  This package can provide similar functionality in pytest several ways.
+
+1. Using sort mode "md5" will produce the same order of tests every time as long as the test case names don't change.
+   ```toml
+   sort_mode="md5"
+   ```
+2. Using sort mode "random" with a fixed sort seed value will produce the same order of tests every time unles the list of test cases is changed (new test case, or name changes)
+   ```toml
+   sort_mode="random"
+   sort_seed=100
+   ```
+
+## Random
+
+By running in random mode, the test case order will change every time. If a test case fails unexpectedly, you can use the seed from the failed run to determine what order is causing the tests to fail.
+
+```toml
+sort_mode="random"
+```
+
+## Fail Fast
+
+When you have a test suite that includes long running test cases, it can be helpful to delay the longer running test cases till later.  The 'fastest' mode allows you to track how long different test cases take to run.  Then always run the fastest test cases first, and the slow test cases last.
+```cmd
+pytest --exitfirst --sort-mode=fastest
+```
+
+
+# Options
+
+## Sort Mode
+
+This option controlls how the order is modified within each bucket.
+
+This option must be set to something other than "none" to enable pytest_sort plugin.
+
+***Command Line:*** `--sort-mode`
+
+***Pytest Config:*** `sort_mode`
+
+***Default:*** `none`
+
+| Option | Definition | 
+| --- | --- |
+| none | pytest_sort will not modify the sort order.  This option disables pytest_sort. |
+| md5 | This mode creates an md5 of each test case id, then sorts on those values.  <br> This runs test cases in a deterministicly shuffled order. |
+| random | Test cases are shuffled randomly |
+| fastest | In each run in "fasttest" mode, the plugin will track the longest execution time for each test case in a file ".pytest-sort".  <br> At the beginning of a test run, any previously recorded values will be used to sort the tests so that the fastest test runs first.
+
+## Sort Bucket
+
+Sort test order within specified test buckets.
+
+For example, if the sort bucket is "module", then all tests from the same module will be completed before running tests for the next module.
+
+***Command Line:*** `--sort-bucket`
+
+***Pytest Config:*** `sort_bucket`
+
+***Default:*** `module`
+
+| Option | Definition | 
+| --- | --- |
+| global | Apply sort to all items together. |
+| package | Group together test cases that are in the same package (folder). |
+| module | Group together test cases that are in the same module (py file). |
+| class | Group together test cases that are members of a class.  <br>All other (non-class) test cases are grouped by module. |
+| parent | Group together test cases by their immediate parent. |
+| grandparent | Group together test cases by their parent's parent. |
+
+## Sort Seed
+
+Only used in "random" sort mode.  This field allows you to manually set the seed used by random package when sorting tests.
+
+> Tip: Seed is printed in the pytest header
+
+***Command Line:*** `--sort-seed`
+
+***Pytest Config:*** `sort_seed`
+
+***Default:*** A random integer between 0 and 1,000,000 generated at runtime.
+
+## Record Test Runtimes
+
+This option enables or disables pytest_sort to record test case runtimes.  These runtimes are used when sort mode is "fastest".  When sort mode is "fastest" recording is enabled by default, otherwise this is disabled by default.
+
+***Command Line:*** `--sort-record-times/--sort-no-record-times`
+
+***Pytest Config:*** `sort_record_times`
+
+***Default:*** false 
+
+| Option | Definition |
+| --- | --- |
+| `--sort-record-times`<br>`sort_record_times=true` | Record test case runtime statistics |
+| `--sort-no-record-times`<br>`sort_record_times=false` | Disable recording runtime statistics in "fastest" mode |
+
+## Reset Recorded Test Runtimes
+
+Clear all recorded runtimes before sorting the next test.
+
+When recording runtimes, only the highest runtime values for each test case are retained.  After significant changes to test cases that can change how fast they run, it is advisable to reset the runtimes.  This can help maintain more accurate sorting in "fastest" mode.
+
+***Command Line:*** `--sort-reset-times`
+
+***Pytest Config:*** N/A
+
+## Report Recorded Test Runtimes
+
+At the end of the test run, print out the currently saved test runtimes.
+
+***Command Line:*** `--sort-reset-times`
+
+***Pytest Config:*** N/A

{pytest-sort-0.0.1 → pytest-sort-0.0.3}/pyproject.toml

@@ -5,11 +5,13 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "pytest-sort"
 description = "Tools for sorting test cases"
-version = "0.0.1"
+version = "0.0.3"
 license = { file = "LICENSE" }
 keywords = ["test", "pytest", "order", "sort", "random", "randomly"]
 authors = [{ name = "Peter Busch", email = "pbuschmail-pytestsort@yahoo.com" }]
-maintainers = [{ name = "Peter Busch", email = "pbuschmail-pytestsort@yahoo.com" }]
+maintainers = [
+    { name = "Peter Busch", email = "pbuschmail-pytestsort@yahoo.com" },
+]
 readme = "README.md"
 requires-python = ">=3.8"
 classifiers = [
@@ -24,9 +26,6 @@ dependencies = ["pytest>=7.0.0", "pony>=0.7.16"]
 "Homepage" = "https://github.com/WiredNerd/pytest-sort"
 "Bug Tracker" = "https://github.com/WiredNerd/pytest-sort/issues"
 
-#[tool.setuptools]
-#py-modules = ["pytest_sort"]
-
 [project.entry-points."pytest11"]
 sort = "pytest_sort.plugin"
 
@@ -34,6 +33,9 @@ sort = "pytest_sort.plugin"
 pythonpath = ["src"]
 testpaths = ["test"]
 addopts = "-vv -p pytester --cov-reset --cov-report=html --cov-report=term"
+sort_mode = "random"
+sort_bucket = "global"
+sort_record_times = true
 
 # https://pytest-cov.readthedocs.io/en/latest/config.html
 # https://coverage.readthedocs.io/en/latest/config.html
@@ -49,58 +51,25 @@ skip_covered = true
 
 [tool.black]
 line-length = 120
-target-version = ['py38', 'py39', 'py310', 'py311', 'py312']
+target-version = ['py38', 'py39', 'py310', 'py311']
 skip-string-normalization = true
-diff = true
 color = true
 
 [tool.isort]
 profile = 'black'
 
 [tool.mypy]
+files = "src"
 
 [tool.ruff]
-select = [
-    "E",
-    "F",
-    "W",
-    "C90",
-    "I",
-    "N",
-    "D",
-    "UP",
-    "YTT",
-    "ANN",
-    "S",
-    "BLE",
-    "FBT",
-    "B",
-    "A",
-    "COM",
-    "C4",
-    "EM",
-    "FA",
-    "ISC",
-    "ICN",
-    "G",
-    "PIE",
-    "T20",
-    "PYI",
-    "PT",
-    "RSE",
-    "RET",
-    "SLF",
-    "SIM",
-    "TID",
-    "TCH",
-    "INT",
-    "PTH",
-    "TD",
-    "FIX",
-    "ERA",
-    "PL",
-    "PERF",
-    "RUF",
+target-version = "py38"
+select = ["ALL"]
+ignore = [
+    "D203",   # 1 blank line required before class docstring
+    "D213",   # multi-line-summary-second-line
+    "EM101",  # Exception must not use a string literal, assign to variable first
+    "S311",   # Standard pseudo-random generators are not suitable for cryptographic purposes
+    "TRY003", # Avoid specifying long messages outside the exception class
 ]
 line-length = 120
 exclude = [

pytest-sort-0.0.3/src/pytest_sort/__init__.py

@@ -0,0 +1 @@
+"""pytest-sort is a pytest plugin to automatically change the execution order of test cases."""

pytest-sort-0.0.3/src/pytest_sort/config.py

@@ -0,0 +1,72 @@
+"""Container for configuration of pytest_sort."""
+
+from __future__ import annotations
+
+import random
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    import pytest
+
+
+class SortConfig:
+    """Statoc class for storing configuration of pytest_sort."""
+
+    mode: str = "none"
+    bucket: str = "module"
+    record: bool | None = False
+    reset: bool = False
+    report: bool = False
+
+    seed = random.randint(0, 1_000_000)
+
+    @staticmethod
+    def from_pytest(config: pytest.Config) -> None:
+        """Extract pytest_sort settings from pytest's Config options and ini data."""
+        SortConfig.mode = config.getoption("sort_mode") or config.getini("sort_mode") or "none"
+        SortConfig.bucket = config.getoption("sort_bucket") or config.getini("sort_bucket") or "module"
+
+        if config.getoption("sort_no_record") and config.getoption("sort_record"):
+            raise ValueError("Do not use both --sort-record-times and --sort-no-record-times")
+
+        if config.getoption("sort_no_record"):
+            SortConfig.record = False
+        else:
+            SortConfig.record = config.getoption("sort_record") or config.getini("sort_record_times")
+        # getini returns [] when option not specified
+        if not isinstance(SortConfig.record, bool):
+            SortConfig.record = None
+        if SortConfig.mode == "fastest" and SortConfig.record is None:
+            SortConfig.record = True
+
+        SortConfig.reset = config.getoption("sort_reset_times", default=False)
+        SortConfig.report = config.getoption("sort_report_times", default=False)
+
+        SortConfig.seed = config.getoption("sort_seed") or config.getini("sort_seed") or SortConfig.seed
+
+    @staticmethod
+    def header_dict() -> dict:
+        """Construct dict of pytest_sort configuration data for use in displaying header.
+
+        Skips settings that are not currently in use.
+        """
+        config: dict[str, Any] = {
+            "sort-mode": SortConfig.mode,
+        }
+
+        if SortConfig.mode == "random":
+            config["sort-seed"] = SortConfig.seed
+
+        if SortConfig.mode != "none":
+            config["sort-bucket"] = SortConfig.bucket
+
+        if SortConfig.reset:
+            config["sort-reset-times"] = True
+
+        if SortConfig.record is not None:
+            config["sort-record-times"] = SortConfig.record
+
+        if SortConfig.report:
+            config["sort-report-times"] = True
+
+        return config

pytest-sort-0.0.3/src/pytest_sort/database.py

@@ -0,0 +1,97 @@
+"""Manages pony database for pytest_sort plugin."""
+
+from __future__ import annotations
+
+from functools import wraps
+from pathlib import Path
+from typing import Any, Callable
+
+from pony.orm import Database, OperationalError, PrimaryKey, Required, db_session
+
+database_file = Path.cwd() / ".pytest_sort"
+db = Database()
+
+
+class TestTab(db.Entity):  # type: ignore[name-defined]
+    """Records data for each Test Case by nodeid."""
+
+    nodeid = PrimaryKey(str)
+    setup = Required(int, size=64)
+    call = Required(int, size=64)
+    teardown = Required(int, size=64)
+    total = Required(int, size=64)
+
+
+def _init_db(f: Callable) -> Callable:
+    """Initialize database before running function."""
+
+    @wraps(f)
+    def wrapper(*args: tuple, **kwargs: dict[str, Any]):  # noqa: ANN202
+        if not db.provider:
+            db.bind(provider="sqlite", filename=str(database_file), create_db=True)
+            try:
+                db.generate_mapping(create_tables=True)
+            except OperationalError:
+                db.drop_all_tables(with_all_data=True)
+                db.schema = None  # Pony will only rebuild build tables if this is None
+                db.generate_mapping(create_tables=True)
+        return f(*args, **kwargs)
+
+    return wrapper
+
+
+@_init_db
+def clear_db() -> None:
+    """Manually drop and recreate tables."""
+    db.drop_all_tables(with_all_data=True)
+    db.schema = None  # Pony will only rebuild build tables if this is None
+    db.generate_mapping(create_tables=True)
+
+
+@_init_db
+@db_session
+def update_test_case(nodeid: str, setup: int = 0, call: int = 0, teardown: int = 0) -> None:
+    """Update Test Case Data with specfiied duration(s) and recalculate total."""
+    test: TestTab = TestTab.get(nodeid=nodeid)
+    if not test:
+        TestTab(nodeid=nodeid, setup=setup, call=call, teardown=teardown, total=setup + call + teardown)
+    else:
+        if test.setup < setup:
+            test.setup = setup
+        if test.call < call:
+            test.call = call
+        if test.teardown < teardown:
+            test.teardown = teardown
+        total = test.setup + test.call + test.teardown
+        if test.total < total:
+            test.total = total
+
+
+@_init_db
+@db_session
+def get_total(nodeid: str) -> int:
+    """Retrieve the total duration for specified nodeid. (0 if not found)."""
+    test: TestTab = TestTab.get(nodeid=nodeid)
+    if not test:
+        return 0
+    return test.total
+
+
+@_init_db
+@db_session
+def get_stats(nodeid: str) -> dict:
+    """Retrieve all stats for specified nodeid. (all zeroes if not found)."""
+    test = TestTab.get(nodeid=nodeid)
+    if not test:
+        return {
+            "setup": 0,
+            "call": 0,
+            "teardown": 0,
+            "total": 0,
+        }
+    return {
+        "setup": test.setup,
+        "call": test.call,
+        "teardown": test.teardown,
+        "total": test.total,
+    }