├── .github ├── FUNDING.yml ├── dependabot.yml └── workflows │ └── push.yml ├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md └── entrypoint.sh /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: [cclauss] 2 | patreon: cclauss 3 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: github-actions 4 | directory: / 5 | groups: 6 | github-actions: 7 | patterns: 8 | - "*" # Group all Actions updates into a single larger pull request 9 | schedule: 10 | interval: weekly 11 | - package-ecosystem: docker 12 | directory: / 13 | groups: 14 | docker: 15 | patterns: 16 | - "*" # Group all Docker updates into a single larger pull request 17 | schedule: 18 | interval: weekly 19 | -------------------------------------------------------------------------------- /.github/workflows/push.yml: -------------------------------------------------------------------------------- 1 | on: push 2 | name: on push 3 | jobs: 4 | gitHubActionForPytest: 5 | name: GitHub Action for pytest 6 | runs-on: ubuntu-latest 7 | steps: 8 | - uses: actions/checkout@master 9 | - name: GitHub Action for pytest 10 | uses: cclauss/GitHub-Action-for-pytest@master 11 | with: 12 | args: pytest -h 13 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 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 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | MANIFEST 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | .pytest_cache/ 49 | 50 | # Translations 51 | *.mo 52 | *.pot 53 | 54 | # Django stuff: 55 | *.log 56 | local_settings.py 57 | db.sqlite3 58 | 59 | # Flask stuff: 60 | instance/ 61 | .webassets-cache 62 | 63 | # Scrapy stuff: 64 | .scrapy 65 | 66 | # Sphinx documentation 67 | docs/_build/ 68 | 69 | # PyBuilder 70 | target/ 71 | 72 | # Jupyter Notebook 73 | .ipynb_checkpoints 74 | 75 | # pyenv 76 | .python-version 77 | 78 | # celery beat schedule file 79 | celerybeat-schedule 80 | 81 | # SageMath parsed files 82 | *.sage.py 83 | 84 | # Environments 85 | .env 86 | .venv 87 | env/ 88 | venv/ 89 | ENV/ 90 | env.bak/ 91 | venv.bak/ 92 | 93 | # Spyder project settings 94 | .spyderproject 95 | .spyproject 96 | 97 | # Rope project settings 98 | .ropeproject 99 | 100 | # mkdocs documentation 101 | /site 102 | 103 | # mypy 104 | .mypy_cache/ 105 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.13-alpine 2 | 3 | LABEL "com.github.actions.name"="GitHub Action for pytest" 4 | LABEL "com.github.actions.description"="Run pytest commands" 5 | LABEL "com.github.actions.icon"="upload-cloud" 6 | LABEL "com.github.actions.color"="yellow" 7 | 8 | RUN apk add --no-cache bash 9 | RUN pip install --upgrade pip 10 | RUN pip install pytest 11 | RUN python --version ; pip --version ; pytest --version 12 | 13 | COPY entrypoint.sh / 14 | RUN chmod +x /entrypoint.sh 15 | ENTRYPOINT ["/entrypoint.sh"] 16 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 [yyyy] [name of copyright owner] 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. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # GitHub Action for running pytest commands 2 | 3 | Each time that new code is pushed into your repo, you can have a [pytest](https://docs.pytest.org) command automatically run. 4 | 5 | $ __pytest -h__ 6 | ``` 7 | usage: pytest [options] [file_or_dir] [file_or_dir] [...] 8 | 9 | positional arguments: 10 | file_or_dir 11 | 12 | general: 13 | -k EXPRESSION only run tests which match the given substring 14 | expression. An expression is a python evaluatable 15 | expression where all names are substring-matched 16 | against test names and their parent classes. Example: 17 | -k 'test_method or test_other' matches all test 18 | functions and classes whose name contains 19 | 'test_method' or 'test_other', while -k 'not 20 | test_method' matches those that don't contain 21 | 'test_method' in their names. Additionally keywords 22 | are matched to classes and functions containing extra 23 | names in their 'extra_keyword_matches' set, as well as 24 | functions which have names assigned directly to them. 25 | -m MARKEXPR only run tests matching given mark expression. 26 | example: -m 'mark1 and not mark2'. 27 | --markers show markers (builtin, plugin and per-project ones). 28 | -x, --exitfirst exit instantly on first error or failed test. 29 | --maxfail=num exit after first num failures or errors. 30 | --strict marks not registered in configuration file raise 31 | errors. 32 | -c file load configuration from `file` instead of trying to 33 | locate one of the implicit configuration files. 34 | --continue-on-collection-errors 35 | Force test execution even if collection errors occur. 36 | --rootdir=ROOTDIR Define root directory for tests. Can be relative path: 37 | 'root_dir', './root_dir', 'root_dir/another_dir/'; 38 | absolute path: '/home/user/root_dir'; path with 39 | variables: '$HOME/root_dir'. 40 | --fixtures, --funcargs 41 | show available fixtures, sorted by plugin appearance 42 | (fixtures with leading '_' are only shown with '-v') 43 | --fixtures-per-test show fixtures per test 44 | --import-mode={prepend,append} 45 | prepend/append to sys.path when importing test 46 | modules, default is to prepend. 47 | --pdb start the interactive Python debugger on errors or 48 | KeyboardInterrupt. 49 | --pdbcls=modulename:classname 50 | start a custom interactive Python debugger on errors. 51 | For example: 52 | --pdbcls=IPython.terminal.debugger:TerminalPdb 53 | --trace Immediately break when running each test. 54 | --capture=method per-test capturing method: one of fd|sys|no. 55 | -s shortcut for --capture=no. 56 | --runxfail run tests even if they are marked xfail 57 | --lf, --last-failed rerun only the tests that failed at the last run (or 58 | all if none failed) 59 | --ff, --failed-first run all tests but run the last failures first. This 60 | may re-order tests and thus lead to repeated fixture 61 | setup/teardown 62 | --nf, --new-first run tests from new files first, then the rest of the 63 | tests sorted by file mtime 64 | --cache-show show cache contents, don't perform collection or tests 65 | --cache-clear remove all cache contents at start of test run. 66 | --lfnf={all,none}, --last-failed-no-failures={all,none} 67 | change the behavior when no test failed in the last 68 | run or no information about the last failures was 69 | found in the cache 70 | --sw, --stepwise exit on test fail and continue from last failing test 71 | next time 72 | --stepwise-skip ignore the first failing test but stop on the next 73 | failing test 74 | 75 | reporting: 76 | -v, --verbose increase verbosity. 77 | -q, --quiet decrease verbosity. 78 | --verbosity=VERBOSE set verbosity 79 | -r chars show extra test summary info as specified by chars 80 | (f)ailed, (E)error, (s)skipped, (x)failed, (X)passed, 81 | (p)passed, (P)passed with output, (a)all except pP. 82 | Warnings are displayed at all times except when 83 | --disable-warnings is set 84 | --disable-warnings, --disable-pytest-warnings 85 | disable warnings summary 86 | -l, --showlocals show locals in tracebacks (disabled by default). 87 | --tb=style traceback print mode (auto/long/short/line/native/no). 88 | --show-capture={no,stdout,stderr,log,all} 89 | Controls how captured stdout/stderr/log is shown on 90 | failed tests. Default is 'all'. 91 | --full-trace don't cut any tracebacks (default is to cut). 92 | --color=color color terminal output (yes/no/auto). 93 | --durations=N show N slowest setup/test durations (N=0 for all). 94 | --pastebin=mode send failed|all info to bpaste.net pastebin service. 95 | --junit-xml=path create junit-xml style report file at given path. 96 | --junit-prefix=str prepend prefix to classnames in junit-xml output 97 | --result-log=path DEPRECATED path for machine-readable result log. 98 | 99 | collection: 100 | --collect-only only collect tests, don't execute them. 101 | --pyargs try to interpret all arguments as python packages. 102 | --ignore=path ignore path during collection (multi-allowed). 103 | --deselect=nodeid_prefix 104 | deselect item during collection (multi-allowed). 105 | --confcutdir=dir only load conftest.py's relative to specified dir. 106 | --noconftest Don't load any conftest.py files. 107 | --keep-duplicates Keep duplicate tests. 108 | --collect-in-virtualenv 109 | Don't ignore tests in a local virtualenv directory 110 | --doctest-modules run doctests in all .py modules 111 | --doctest-report={none,cdiff,ndiff,udiff,only_first_failure} 112 | choose another output format for diffs on doctest 113 | failure 114 | --doctest-glob=pat doctests file matching pattern, default: test*.txt 115 | --doctest-ignore-import-errors 116 | ignore doctest ImportErrors 117 | --doctest-continue-on-failure 118 | for a given doctest, continue to run after the first 119 | failure 120 | 121 | test session debugging and configuration: 122 | --basetemp=dir base temporary directory for this test run.(warning: 123 | this directory is removed if it exists) 124 | --version display pytest lib version and import information. 125 | -h, --help show help message and configuration info 126 | -p name early-load given plugin (multi-allowed). To avoid 127 | loading of plugins, use the `no:` prefix, e.g. 128 | `no:doctest`. 129 | --trace-config trace considerations of conftest.py files. 130 | --debug store internal tracing debug information in 131 | 'pytestdebug.log'. 132 | -o OVERRIDE_INI, --override-ini=OVERRIDE_INI 133 | override ini option with "option=value" style, e.g. 134 | `-o xfail_strict=True -o cache_dir=cache`. 135 | --assert=MODE Control assertion debugging tools. 'plain' performs no 136 | assertion debugging. 'rewrite' (the default) rewrites 137 | assert statements in test modules on import to provide 138 | assert expression information. 139 | --setup-only only setup fixtures, do not execute tests. 140 | --setup-show show setup of fixtures while executing tests. 141 | --setup-plan show what fixtures and tests would be executed but 142 | don't execute anything. 143 | 144 | pytest-warnings: 145 | -W PYTHONWARNINGS, --pythonwarnings=PYTHONWARNINGS 146 | set which warnings to report, see -W option of python 147 | itself. 148 | 149 | logging: 150 | --no-print-logs disable printing caught logs on failed tests. 151 | --log-level=LOG_LEVEL 152 | logging level used by the logging module 153 | --log-format=LOG_FORMAT 154 | log format as used by the logging module. 155 | --log-date-format=LOG_DATE_FORMAT 156 | log date format as used by the logging module. 157 | --log-cli-level=LOG_CLI_LEVEL 158 | cli logging level. 159 | --log-cli-format=LOG_CLI_FORMAT 160 | log format as used by the logging module. 161 | --log-cli-date-format=LOG_CLI_DATE_FORMAT 162 | log date format as used by the logging module. 163 | --log-file=LOG_FILE path to a file when logging will be written to. 164 | --log-file-level=LOG_FILE_LEVEL 165 | log file logging level. 166 | --log-file-format=LOG_FILE_FORMAT 167 | log format as used by the logging module. 168 | --log-file-date-format=LOG_FILE_DATE_FORMAT 169 | log date format as used by the logging module. 170 | ``` 171 | -------------------------------------------------------------------------------- /entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | set -e 3 | 4 | echo "#########################################" 5 | echo "Starting ${GITHUB_WORKFLOW}:${GITHUB_ACTION}" 6 | 7 | sh -c "$*" 8 | 9 | echo "#########################################" 10 | echo "Completed ${GITHUB_WORKFLOW}:${GITHUB_ACTION}" 11 | --------------------------------------------------------------------------------