airflow-pytest-plugin 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. airflow_pytest_plugin-0.1.0/.gitignore +222 -0
  2. airflow_pytest_plugin-0.1.0/LICENSE +201 -0
  3. airflow_pytest_plugin-0.1.0/PKG-INFO +222 -0
  4. airflow_pytest_plugin-0.1.0/README.md +178 -0
  5. airflow_pytest_plugin-0.1.0/examples/example_dag.py +47 -0
  6. airflow_pytest_plugin-0.1.0/pyproject.toml +127 -0
  7. airflow_pytest_plugin-0.1.0/src/airflow_pytest_plugin/__init__.py +66 -0
  8. airflow_pytest_plugin-0.1.0/src/airflow_pytest_plugin/compat/__init__.py +29 -0
  9. airflow_pytest_plugin-0.1.0/src/airflow_pytest_plugin/compat/airflow.py +70 -0
  10. airflow_pytest_plugin-0.1.0/src/airflow_pytest_plugin/config.py +46 -0
  11. airflow_pytest_plugin-0.1.0/src/airflow_pytest_plugin/layout.py +78 -0
  12. airflow_pytest_plugin-0.1.0/src/airflow_pytest_plugin/models.py +157 -0
  13. airflow_pytest_plugin-0.1.0/src/airflow_pytest_plugin/plugin.py +98 -0
  14. airflow_pytest_plugin-0.1.0/src/airflow_pytest_plugin/producer/__init__.py +21 -0
  15. airflow_pytest_plugin-0.1.0/src/airflow_pytest_plugin/producer/archiving_parser.py +214 -0
  16. airflow_pytest_plugin-0.1.0/src/airflow_pytest_plugin/sources/__init__.py +22 -0
  17. airflow_pytest_plugin-0.1.0/src/airflow_pytest_plugin/sources/base.py +49 -0
  18. airflow_pytest_plugin-0.1.0/src/airflow_pytest_plugin/sources/filesystem.py +231 -0
  19. airflow_pytest_plugin-0.1.0/src/airflow_pytest_plugin/version.py +31 -0
  20. airflow_pytest_plugin-0.1.0/src/airflow_pytest_plugin/web/__init__.py +21 -0
  21. airflow_pytest_plugin-0.1.0/src/airflow_pytest_plugin/web/__main__.py +53 -0
  22. airflow_pytest_plugin-0.1.0/src/airflow_pytest_plugin/web/app.py +103 -0
  23. airflow_pytest_plugin-0.1.0/src/airflow_pytest_plugin/web/templates.py +564 -0
  24. airflow_pytest_plugin-0.1.0/tests/conftest.py +122 -0
  25. airflow_pytest_plugin-0.1.0/tests/test_archiving_parser.py +81 -0
  26. airflow_pytest_plugin-0.1.0/tests/test_filesystem_source.py +104 -0
  27. airflow_pytest_plugin-0.1.0/tests/test_layout.py +44 -0
  28. airflow_pytest_plugin-0.1.0/tests/test_models.py +41 -0
  29. airflow_pytest_plugin-0.1.0/tests/test_plugin.py +63 -0
  30. airflow_pytest_plugin-0.1.0/tests/test_web_app.py +79 -0
@@ -0,0 +1,222 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[codz]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py.cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ # Pipfile.lock
96
+
97
+ # UV
98
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ # uv.lock
102
+
103
+ # poetry
104
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
106
+ # commonly ignored for libraries.
107
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108
+ # poetry.lock
109
+ # poetry.toml
110
+
111
+ # pdm
112
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
113
+ # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
114
+ # https://pdm-project.org/en/latest/usage/project/#working-with-version-control
115
+ # pdm.lock
116
+ # pdm.toml
117
+ .pdm-python
118
+ .pdm-build/
119
+
120
+ # pixi
121
+ # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
122
+ # pixi.lock
123
+ # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
124
+ # in the .venv directory. It is recommended not to include this directory in version control.
125
+ .pixi
126
+
127
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
128
+ __pypackages__/
129
+
130
+ # Celery stuff
131
+ celerybeat-schedule
132
+ celerybeat.pid
133
+
134
+ # Redis
135
+ *.rdb
136
+ *.aof
137
+ *.pid
138
+
139
+ # RabbitMQ
140
+ mnesia/
141
+ rabbitmq/
142
+ rabbitmq-data/
143
+
144
+ # ActiveMQ
145
+ activemq-data/
146
+
147
+ # SageMath parsed files
148
+ *.sage.py
149
+
150
+ # Environments
151
+ .env
152
+ .envrc
153
+ .venv
154
+ env/
155
+ venv/
156
+ ENV/
157
+ env.bak/
158
+ venv.bak/
159
+
160
+ # Spyder project settings
161
+ .spyderproject
162
+ .spyproject
163
+
164
+ # Rope project settings
165
+ .ropeproject
166
+
167
+ # mkdocs documentation
168
+ /site
169
+
170
+ # mypy
171
+ .mypy_cache/
172
+ .dmypy.json
173
+ dmypy.json
174
+
175
+ # Pyre type checker
176
+ .pyre/
177
+
178
+ # pytype static type analyzer
179
+ .pytype/
180
+
181
+ # Cython debug symbols
182
+ cython_debug/
183
+
184
+ # PyCharm
185
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
186
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
187
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
188
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
189
+ # .idea/
190
+
191
+ # Abstra
192
+ # Abstra is an AI-powered process automation framework.
193
+ # Ignore directories containing user credentials, local state, and settings.
194
+ # Learn more at https://abstra.io/docs
195
+ .abstra/
196
+
197
+ # Visual Studio Code
198
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
199
+ # that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
200
+ # and can be added to the global gitignore or merged into this file. However, if you prefer,
201
+ # you could uncomment the following to ignore the entire vscode folder
202
+ # .vscode/
203
+ # Temporary file for partial code execution
204
+ tempCodeRunnerFile.py
205
+
206
+ # Ruff stuff:
207
+ .ruff_cache/
208
+
209
+ # PyPI configuration file
210
+ .pypirc
211
+
212
+ # Marimo
213
+ marimo/_static/
214
+ marimo/_lsp/
215
+ __marimo__/
216
+
217
+ # Streamlit
218
+ .streamlit/secrets.toml
219
+
220
+ # Local preview config (machine-specific absolute paths)
221
+ .claude/
222
+ .claude/launch.json
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 Ilya Krysanov
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,222 @@
1
+ Metadata-Version: 2.4
2
+ Name: airflow-pytest-plugin
3
+ Version: 0.1.0
4
+ Summary: View airflow-pytest-operator results in the Airflow 3 web UI.
5
+ Project-URL: Homepage, https://github.com/IKrysanov/airflow-pytest-plugin
6
+ Project-URL: Repository, https://github.com/IKrysanov/airflow-pytest-plugin
7
+ Project-URL: Issues, https://github.com/IKrysanov/airflow-pytest-plugin/issues
8
+ Author: Ilya Krysanov
9
+ License-Expression: Apache-2.0
10
+ License-File: LICENSE
11
+ Keywords: airflow,plugin,pytest,reports,testing,ui
12
+ Classifier: Development Status :: 4 - Beta
13
+ Classifier: Framework :: Apache Airflow
14
+ Classifier: Framework :: Apache Airflow :: Provider
15
+ Classifier: Framework :: Pytest
16
+ Classifier: Intended Audience :: Developers
17
+ Classifier: License :: OSI Approved :: Apache Software License
18
+ Classifier: Operating System :: MacOS
19
+ Classifier: Operating System :: POSIX :: Linux
20
+ Classifier: Programming Language :: Python :: 3
21
+ Classifier: Programming Language :: Python :: 3.10
22
+ Classifier: Programming Language :: Python :: 3.11
23
+ Classifier: Programming Language :: Python :: 3.12
24
+ Classifier: Programming Language :: Python :: 3.13
25
+ Classifier: Topic :: Software Development :: Testing
26
+ Requires-Python: >=3.10
27
+ Requires-Dist: airflow-pytest-operator>=0.5
28
+ Provides-Extra: airflow3
29
+ Requires-Dist: apache-airflow<4.0,>=3.0; extra == 'airflow3'
30
+ Provides-Extra: dev
31
+ Requires-Dist: defusedxml>=0.7; extra == 'dev'
32
+ Requires-Dist: fastapi>=0.110; extra == 'dev'
33
+ Requires-Dist: httpx>=0.27; extra == 'dev'
34
+ Requires-Dist: mypy>=1.8; extra == 'dev'
35
+ Requires-Dist: pytest-cov>=4.0; extra == 'dev'
36
+ Requires-Dist: pytest>=7.0; extra == 'dev'
37
+ Requires-Dist: ruff>=0.4; extra == 'dev'
38
+ Provides-Extra: secure-xml
39
+ Requires-Dist: defusedxml>=0.7; extra == 'secure-xml'
40
+ Provides-Extra: web
41
+ Requires-Dist: fastapi>=0.110; extra == 'web'
42
+ Requires-Dist: uvicorn>=0.23; extra == 'web'
43
+ Description-Content-Type: text/markdown
44
+
45
+ # airflow-pytest-plugin
46
+
47
+ View [`airflow-pytest-operator`](https://github.com/IKrysanov/airflow-pytest-operator)
48
+ results in the **Airflow 3** web UI.
49
+
50
+ **Package**
51
+
52
+ | Badge | What it tells you |
53
+ |:------|:------------------|
54
+ | [![PyPI version](https://img.shields.io/pypi/v/airflow-pytest-plugin.svg)](https://pypi.org/project/airflow-pytest-plugin/) | Latest release on PyPI — `pip install airflow-pytest-plugin` |
55
+ | [![Python versions](https://img.shields.io/pypi/pyversions/airflow-pytest-plugin.svg)](https://pypi.org/project/airflow-pytest-plugin/) | Supported Python versions (3.10+) |
56
+ | [![Airflow](https://img.shields.io/badge/Airflow-3.x-017CEE.svg?logo=apacheairflow)](https://airflow.apache.org/) | Targets Airflow 3.x (FastAPI plugin UI) |
57
+ | [![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) | Distributed under the Apache-2.0 licence |
58
+
59
+ **Quality &amp; build**
60
+
61
+ | Badge | What it tells you |
62
+ |:------|:------------------|
63
+ | [![CI](https://github.com/IKrysanov/airflow-pytest-plugin/actions/workflows/ci.yml/badge.svg)](https://github.com/IKrysanov/airflow-pytest-plugin/actions/workflows/ci.yml) | Build & test suite (lint, types, unit, integration) on `main` |
64
+ | [![codecov](https://codecov.io/gh/IKrysanov/airflow-pytest-plugin/branch/main/graph/badge.svg)](https://codecov.io/gh/IKrysanov/airflow-pytest-plugin) | Test coverage of the package |
65
+ | [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/) | Fully type-checked with mypy `--strict` |
66
+ | [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) | Linted & formatted with Ruff |
67
+ | [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/IKrysanov/airflow-pytest-plugin/badge)](https://scorecard.dev/viewer/?uri=github.com/IKrysanov/airflow-pytest-plugin) | OpenSSF supply-chain security score |
68
+
69
+ The operator runs a `pytest` suite as an Airflow task and parses the JUnit
70
+ report into a structured result. This plugin archives each of those reports —
71
+ keyed by `dag_id / run_id / task_id / try` — and serves a small web UI to browse
72
+ them: pass/fail counts per run, durations, and the per-test breakdown (with
73
+ failure messages) for any run.
74
+
75
+ It has two halves that share one on-disk layout:
76
+
77
+ | Side | Where it runs | What it is |
78
+ | --- | --- | --- |
79
+ | **Producer** | the worker | `ArchivingJUnitResultParser`, a drop-in `parser=` for `PytestOperator` |
80
+ | **Reader** | the API server | a FastAPI app + single-page viewer, registered as an Airflow plugin |
81
+
82
+ ---
83
+
84
+ ## Install
85
+
86
+ ```bash
87
+ pip install airflow-pytest-plugin # producer side (workers)
88
+ pip install 'airflow-pytest-plugin[web]' # reader side (API server)
89
+ ```
90
+
91
+ On Airflow 3 the API server already provides FastAPI, so the bare install is
92
+ enough there too; the `[web]` extra only adds the standalone dev server.
93
+
94
+ ## Quickstart
95
+
96
+ **1. Point your operator at the archiving parser** — the only DAG change:
97
+
98
+ ```python
99
+ from airflow_pytest_operator import PytestOperator
100
+ from airflow_pytest_plugin import ArchivingJUnitResultParser
101
+
102
+ PytestOperator(
103
+ task_id="run_tests",
104
+ test_path="tests/",
105
+ parser=ArchivingJUnitResultParser(), # was JUnitResultParser()
106
+ )
107
+ ```
108
+
109
+ **2. Tell both sides where reports live** (one place, read by producer and
110
+ reader alike):
111
+
112
+ ```bash
113
+ export AIRFLOW_PYTEST_REPORTS_ROOT=/opt/airflow/pytest-reports
114
+ ```
115
+
116
+ or in `airflow.cfg`:
117
+
118
+ ```ini
119
+ [pytest_reports]
120
+ reports_root = /opt/airflow/pytest-reports
121
+ ```
122
+
123
+ In a distributed deployment this should be a **shared volume** that both the
124
+ workers (writing) and the API server (reading) can see.
125
+
126
+ **3. Open the UI.** The plugin registers itself via the `airflow.plugins` entry
127
+ point — no config. The app mounts on the API server at `/pytest-reports`, with a
128
+ **Pytest Reports** entry under *Browse* in the nav.
129
+
130
+ ### Preview locally, without Airflow
131
+
132
+ ```bash
133
+ python -m airflow_pytest_plugin.web --root ./pytest-reports --port 8000
134
+ # open http://127.0.0.1:8000/
135
+ ```
136
+
137
+ ---
138
+
139
+ ## Do I need `cleanup="never"`?
140
+
141
+ **No.** In the operator, the *parser* owns the report location, and a
142
+ **parser-supplied directory is never deleted by the runner under any cleanup
143
+ policy**. `ArchivingJUnitResultParser` supplies its own directory, so reports
144
+ always survive regardless of the runner's `cleanup` setting. `cleanup="never"`
145
+ only matters when you let the runner use throwaway temp dirs — which is exactly
146
+ the fragile path (random names, no `dag/run/task` association, not visible to
147
+ other workers) this plugin replaces.
148
+
149
+ ## How it works
150
+
151
+ ```
152
+ worker shared volume API server
153
+ ────── ───────────── ──────────
154
+ PytestOperator {root}/{dag}/{run}/ FastAPI app
155
+ └─ ArchivingJUnitResultParser ──▶ {task}/t{try}/ ◀──── FileSystemReportSource
156
+ report_request() → path ├─ junit.xml └─ lists meta.json,
157
+ parse() → meta.json └─ meta.json parses junit.xml
158
+ ```
159
+
160
+ * `report_request()` reads the live Airflow context (`get_current_context()`,
161
+ available because the parser runs inside the task's `execute()`), computes the
162
+ archive directory, and hands it to the operator's JUnit parser.
163
+ * `parse()` reuses the operator's JUnit parsing, then drops a `meta.json`
164
+ sidecar carrying the Airflow coordinates + the summary. That sidecar makes
165
+ each report **self-describing**, so the reader needs no database access.
166
+ * The reader lists by scanning `meta.json` files (fast) and parses `junit.xml`
167
+ on demand for the per-case detail.
168
+
169
+ The directory is a human-friendly container; the authoritative identity always
170
+ lives in `meta.json` (and the API's opaque, reversible report token), so awkward
171
+ `run_id` characters like `:` are sanitised in the path without losing anything.
172
+
173
+ ## HTTP API
174
+
175
+ The app is mountable under any prefix; the viewer derives its API base at
176
+ runtime. Endpoints (relative to the mount):
177
+
178
+ | Method & path | Returns |
179
+ | --- | --- |
180
+ | `GET /` | the single-page viewer (HTML) |
181
+ | `GET /api/reports?dag_id=&run_id=` | summaries, newest first |
182
+ | `GET /api/reports/{report_id}` | one report with per-case rows |
183
+ | `GET /api/health` | `{"status": "ok"}` |
184
+ | `GET /api/docs` | OpenAPI docs |
185
+
186
+ ## Configuration
187
+
188
+ | Setting | Default | Purpose |
189
+ | --- | --- | --- |
190
+ | `AIRFLOW_PYTEST_REPORTS_ROOT` (env) | — | report root (highest precedence) |
191
+ | `[pytest_reports] reports_root` (cfg) | — | report root |
192
+ | built-in default | `/opt/airflow/pytest-reports` | fallback |
193
+
194
+ ## Architecture (SOLID)
195
+
196
+ Mirrors the operator's layering — each piece has one reason to change:
197
+
198
+ | Module | Responsibility |
199
+ | --- | --- |
200
+ | `layout.ReportLayout` | the single `ReportRef → directory` mapping, shared by both sides |
201
+ | `producer.ArchivingJUnitResultParser` | write JUnit XML + `meta.json` (extends the operator's parser) |
202
+ | `sources.ReportSource` / `FileSystemReportSource` | read/index reports behind an interface (Dependency Inversion) |
203
+ | `web.create_app` | map HTTP onto a `ReportSource` — knows nothing about the filesystem |
204
+ | `plugin.PytestReportsPlugin` | register the app with Airflow |
205
+ | `compat` | the only module that imports Airflow; version differences resolved once |
206
+ | `models` | JSON-serializable view types; the web layer never sees operator types |
207
+
208
+ Adding a different backing store (e.g. an `XComReportSource` reading the
209
+ metadata DB) is a new `ReportSource`, not an edit of the web app (Open/Closed).
210
+
211
+ ## Development
212
+
213
+ ```bash
214
+ pip install -e '.[dev,web]'
215
+ pytest -q
216
+ ruff check src tests && ruff format --check src tests
217
+ mypy src
218
+ ```
219
+
220
+ ## License
221
+
222
+ Apache-2.0. See [LICENSE](LICENSE).