flakytest 2023.0b0__tar.gz

flakytest-2023.0b0/.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    environment: release
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+        cache: 'pip'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install hatch
+    - name: Build package
+      run: hatch build
+    # - name: Test package
+    #   run: hatch run test
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

flakytest-2023.0b0/.gitignore

@@ -0,0 +1 @@
+dist

flakytest-2023.0b0/.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v3.2.0
+  hooks:
+   - id: trailing-whitespace
+   - id: end-of-file-fixer
+   - id: check-yaml
+   - id: check-added-large-files
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.0.290
+  hooks:
+   - id: ruff
+   - id: ruff-format

flakytest-2023.0b0/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Calendar Versioning](https://calver.org).
+
+## [2023.0b0] - 2023-09-24
+
+Initial release

flakytest-2023.0b0/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023-present Anže Pečar <anze@pecar.me>
+
+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.

flakytest-2023.0b0/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.1
+Name: flakytest
+Version: 2023.0b0
+Summary: Pytest plugin for flakytest.dev
+Project-URL: Documentation, https://github.com/anze3db/flakytest-python#readme
+Project-URL: Changelog, https://github.com/anze3db/flakytest-python/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/anze3db/flakytest-python/issues
+Project-URL: Source, https://github.com/anze3db/flakytest-python
+Project-URL: Mastodon, https://fosstodon.org/@anze3db
+Project-URL: Twitter, https://twitter.com/anze3db
+Author-email: Anže Pečar <anze@pecar.me>
+License-Expression: MIT
+License-File: LICENSE.txt
+Keywords: flaky,pytest,test
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# flakytest-python
+
+[![PyPI - Version](https://img.shields.io/pypi/v/flakytest.svg)](https://pypi.org/project/flakytest)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/flakytest.svg)](https://pypi.org/project/flakytest)
+
+-----
+
+**Table of Contents**
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+> [!WARNING]
+> flakytest is currently in beta. It is not recommended to use it in production.
+
+```console
+pip install flakytest --pre
+```
+
+Obtain the `FLAKYTEST_SECRET_TOKEN` from [flakytest.dev](https://flakytest.dev/) and set it as an environment variable (e.g. your secrets store in your CI/CD pipeline)
+
+```console
+export FLAKYTEST_SECRET_TOKEN=****************************
+```
+
+Run your tests with `pytest` normally
+
+```console
+pytest
+```
+
+## License
+
+`flakytest` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

flakytest-2023.0b0/README.md

@@ -0,0 +1,36 @@
+# flakytest-python
+
+[![PyPI - Version](https://img.shields.io/pypi/v/flakytest.svg)](https://pypi.org/project/flakytest)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/flakytest.svg)](https://pypi.org/project/flakytest)
+
+-----
+
+**Table of Contents**
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+> [!WARNING]
+> flakytest is currently in beta. It is not recommended to use it in production.
+
+```console
+pip install flakytest --pre
+```
+
+Obtain the `FLAKYTEST_SECRET_TOKEN` from [flakytest.dev](https://flakytest.dev/) and set it as an environment variable (e.g. your secrets store in your CI/CD pipeline)
+
+```console
+export FLAKYTEST_SECRET_TOKEN=****************************
+```
+
+Run your tests with `pytest` normally
+
+```console
+pytest
+```
+
+## License
+
+`flakytest` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

flakytest-2023.0b0/pyproject.toml

@@ -0,0 +1,168 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "flakytest"
+dynamic = ["version"]
+description = 'Pytest plugin for flakytest.dev'
+readme = "README.md"
+requires-python = ">=3.8"
+license = "MIT"
+keywords = [
+  "test",
+  "flaky",
+  "pytest"
+]
+authors = [
+  { name = "Anže Pečar", email = "anze@pecar.me" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Natural Language :: English",
+  "Framework :: Pytest",
+]
+dependencies = []
+
+[project.urls]
+Documentation = "https://github.com/anze3db/flakytest-python#readme"
+Changelog = "https://github.com/anze3db/flakytest-python/blob/main/CHANGELOG.md"
+Issues = "https://github.com/anze3db/flakytest-python/issues"
+Source = "https://github.com/anze3db/flakytest-python"
+Mastodon = "https://fosstodon.org/@anze3db"
+Twitter = "https://twitter.com/anze3db"
+
+[project.entry-points.pytest11]
+flakytest = "flakytest.hook"
+
+
+[tool.hatch.version]
+path = "src/flakytest/__about__.py"
+
+[tool.hatch.envs.default]
+dependencies = [
+  "coverage[toml]>=6.5",
+  "pytest",
+]
+[tool.hatch.envs.default.scripts]
+test = "pytest {args:tests}"
+test-cov = "coverage run -m pytest {args:tests}"
+cov-report = [
+  "- coverage combine",
+  "coverage report",
+]
+cov = [
+  "test-cov",
+  "cov-report",
+]
+
+[[tool.hatch.envs.all.matrix]]
+python = ["3.8", "3.9", "3.10", "3.11"]
+
+[tool.hatch.envs.lint]
+detached = true
+dependencies = [
+  "mypy>=1.0.0",
+  "ruff>=0.0.290",
+]
+[tool.hatch.envs.lint.scripts]
+typing = "mypy --install-types --non-interactive {args:src/flakytest tests}"
+style = [
+  "ruff {args:.}",
+  "ruff format --check --diff {args:.}",
+]
+fmt = [
+  "ruff format {args:.}",
+  "ruff --fix {args:.}",
+  "style",
+]
+all = [
+  "style",
+  "typing",
+]
+
+[tool.ruff]
+target-version = "py37"
+line-length = 120
+select = [
+  "A",
+  "ARG",
+  "B",
+  "C",
+  "DTZ",
+  "E",
+  "EM",
+  "F",
+  "FBT",
+  "I",
+  "ICN",
+  "ISC",
+  "N",
+  "PLC",
+  "PLE",
+  "PLR",
+  "PLW",
+  "Q",
+  "RUF",
+  "S",
+  "T",
+  "TID",
+  "UP",
+  "W",
+  "YTT",
+]
+ignore = [
+  # Allow non-abstract empty methods in abstract base classes
+  "B027",
+  # Allow boolean positional values in function calls, like `dict.get(... True)`
+  "FBT003",
+  # Ignore checks for possible passwords
+  "S105", "S106", "S107",
+  # Ignore complexity
+  "C901", "PLR0911", "PLR0912", "PLR0913", "PLR0915",
+  # Ignore assert False
+  "B011",
+  "S311",
+]
+unfixable = [
+  # Don't touch unused imports
+  "F401",
+]
+
+[tool.ruff.isort]
+known-first-party = ["flakytest"]
+
+[tool.ruff.flake8-tidy-imports]
+ban-relative-imports = "all"
+
+[tool.ruff.per-file-ignores]
+# Tests can use magic values, assertions, and relative imports
+"tests/**/*" = ["PLR2004", "S101", "TID252"]
+
+[tool.coverage.run]
+source_pkgs = ["flakytest", "tests"]
+branch = true
+parallel = true
+omit = [
+  "src/flakytest/__about__.py",
+]
+
+[tool.coverage.paths]
+flakytest = ["src/flakytest", "*/flakytest/src/flakytest"]
+tests = ["tests", "*/flakytest/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]

flakytest-2023.0b0/src/flakytest/__about__.py

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: 2023-present Anže Pečar <anze@pecar.me>
+#
+# SPDX-License-Identifier: MIT
+__version__ = "2023.0b0"

flakytest-2023.0b0/src/flakytest/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2023-present Anže Pečar <anze@pecar.me>
+#
+# SPDX-License-Identifier: MIT

flakytest-2023.0b0/src/flakytest/hook.py

@@ -0,0 +1,109 @@
+# SPDX-FileCopyrightText: 2023-present Anže Pečar <anze@pecar.me>
+#
+# SPDX-License-Identifier: MIT
+
+# root
+# └── pytest_cmdline_main
+#  ├── pytest_plugin_registered
+#  ├── pytest_configure
+#  │ └── pytest_plugin_registered
+#  ├── pytest_sessionstart
+#  │ ├── pytest_plugin_registered
+#  │ └── pytest_report_header
+#  ├── pytest_collection
+#  │ ├── pytest_collectstart
+#  │ ├── pytest_make_collect_report
+#  │ │ ├── pytest_collect_file
+#  │ │ │ └── pytest_pycollect_makemodule
+#  │ │ └── pytest_pycollect_makeitem
+#  │ │ └── pytest_generate_tests
+#  │ │ └── pytest_make_parametrize_id
+#  │ ├── pytest_collectreport
+#  │ ├── pytest_itemcollected
+#  │ ├── pytest_collection_modifyitems
+#  │ └── pytest_collection_finish
+#  │ └── pytest_report_collectionfinish
+#  ├── pytest_runtestloop
+#  │ └── pytest_runtest_protocol
+#  │ ├── pytest_runtest_logstart
+#  │ ├── pytest_runtest_setup
+#  │ │ └── pytest_fixture_setup
+#  │ ├── pytest_runtest_makereport
+#  │ ├── pytest_runtest_logreport
+#  │ │ └── pytest_report_teststatus
+#  │ ├── pytest_runtest_call
+#  │ │ └── pytest_pyfunc_call
+#  │ ├── pytest_runtest_teardown
+#  │ │ └── pytest_fixture_post_finalizer
+#  │ └── pytest_runtest_logfinish
+#  ├── pytest_sessionfinish
+#  │ └── pytest_terminal_summary
+#  └── pytest_unconfigure
+
+# def pytest_terminal_summary(terminalreporter, exitstatus, config):
+#     # Add a section?
+#     ...
+import http.client
+import json
+import os
+import traceback
+
+token = os.environ.get("FLAKYTEST_SECRET_TOKEN")
+host = os.environ.get("FLAKYTEST_HOST", "flakytest.dev")
+
+muted_tests = []
+tests = []
+
+
+def pytest_collection_modifyitems(items):
+    if not token:
+        return
+
+    headers = {"Content-type": "application/json", "Accept": "text/plain", "Authorization": token}
+    conn = http.client.HTTPConnection("localhost", 8001)
+    conn.request("GET", "/muted_tests/", headers=headers)
+    muted_tests[:] = json.loads(conn.getresponse().read().decode())["result"]
+    muted_test_set = {test["name"] for test in muted_tests}
+    items[:] = [item for item in items if item.nodeid not in muted_test_set]
+
+
+def pytest_collection_finish(session):
+    if not token:
+        return
+
+    headers = {"Content-type": "application/json", "Accept": "text/plain", "Authorization": token}
+    conn = http.client.HTTPConnection(host)
+    conn.request("POST", "/sessions/", headers=headers)
+    session.stash["session_id"] = conn.getresponse().read().decode()
+
+
+def pytest_sessionfinish(session, exitstatus):
+    # Send report end here?
+    if not token:
+        return
+    json_data = json.dumps(
+        {"tests": tests + muted_tests, "exit_status": exitstatus.name if exitstatus != 0 else "OK"}
+    ).encode()
+    headers = {"Content-type": "application/json", "Accept": "text/plain", "Authorization": token}
+    conn = http.client.HTTPConnection(host)
+    conn.request("POST", f"/sessions/{session.stash['session_id']}/finish", json_data, headers)
+
+
+def pytest_runtest_makereport(item, call):
+    if call.when == "call":
+        # Get the test status
+        if call.excinfo is None:
+            status = "PASS"
+        elif call.excinfo.type == AssertionError:
+            status = "FAIL"
+        else:
+            status = "ERROR"
+
+        tests.append(
+            {
+                "name": item.nodeid,
+                "status": status,
+                "duration": call.duration,
+                "output": "\n".join(traceback.format_tb(call.excinfo.tb)) if call.excinfo else "",
+            }
+        )

flakytest-2023.0b0/tests/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2023-present Anže Pečar <anze@pecar.me>
+#
+# SPDX-License-Identifier: MIT

flakytest-2023.0b0/tests/test_flake.py

@@ -0,0 +1,13 @@
+import random
+
+
+def test_always_pass():
+    assert True
+
+
+def test_always_fail():
+    assert False
+
+
+def test_flaky():
+    assert random.randint(0, 1) < 0.5