init pytest as action

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+ignore = E501,W503
+exclude = .git,__pycache__

.github/workflows/test.yml

@@ -6,7 +6,7 @@ on:
   pull_request:
 jobs:
   test-check:
-    name: runner / <linter-name> (github-check)
+    name: runner / pytest (github-check)
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -19,7 +19,7 @@ jobs:
 
   test-pr-check:
     if: github.event_name == 'pull_request'
-    name: runner / <linter-name> (github-pr-check)
+    name: runner / pytest (github-pr-check)
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -33,7 +33,7 @@ jobs:
 
   test-pr-review:
     if: github.event_name == 'pull_request'
-    name: runner / <linter-name> (github-pr-review)
+    name: runner / pytest (github-pr-review)
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2

.gitignore

@@ -1,2 +1,157 @@
+.report.json
+
 # Folders to ignore
-.vscode/
+.vscode/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintainted in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

Dockerfile

@@ -1,17 +1,24 @@
-FROM alpine:3.15
+FROM python:alpine
 
 ENV REVIEWDOG_VERSION=v0.13.0
 
+WORKDIR /src
+
 SHELL ["/bin/ash", "-eo", "pipefail", "-c"]
 
-# hadolint ignore=DL3006
-RUN apk --no-cache add git
+# hadolint ignore=DL3006,DL3018
+RUN apk --no-cache add build-base libffi-dev git graphviz
+
+COPY pyproject.toml pyproject.toml
+COPY poetry.lock poetry.lock
 
-RUN wget -O - -q https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh| sh -s -- -b /usr/local/bin/ ${REVIEWDOG_VERSION}
+RUN wget -O - -q https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh| sh -s -- -b /usr/local/bin ${REVIEWDOG_VERSION}
 
-# TODO: Install a linter and/or change docker image as you need.
-RUN wget -O - -q https://git.io/misspell | sh -s -- -b /usr/local/bin/
+# hadolint ignore=DL3013,SC2169,SC3001
+RUN python -m pip install --no-cache-dir --upgrade pip && \
+    python -m pip install --no-cache-dir --upgrade poetry && \
+    python -m pip install --no-cache-dir --requirement <(poetry export --format requirements.txt)
 
-COPY entrypoint.sh /entrypoint.sh
+COPY entrypoint.sh entrypoint.sh
 
-ENTRYPOINT ["/entrypoint.sh"]
+ENTRYPOINT ["./entrypoint.sh"]

README.md

@@ -62,6 +62,46 @@ jobs:
           level: warning
 ```
 
+## Inputs
+
+### `github_token`
+
+**Required**. The [GITHUB_TOKEN](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow). Must be in form of `github_token: ${{ secrets.github_token }}`. Defaults to `${{ github.token }}`.
+
+### `workdir`
+
+**Optional**. The directory to run pytest on. Defaults to `.`.
+
+#### `pytest_args`
+
+**Optional**. Command-line arguments to the pytest executable. Defaults to `""`.
+
+Please note that some command-line arguments can be defined with other fields in your configuration.  You may combine the `pytest_args` setting with the other settings below, or use `pytest_args` to configure pytest without the other Action settings.
+
+#### `level`
+
+**Optional**. The log level of the reviewdog reporter. Options: `[info, warning, error]`. Defaults to `error`.
+
+#### `reporter`
+
+**Optional**. Reporter of reviewdog command `[github-pr-check, github-pr-review, github-check]`. Defaults to `github-pr-check`.
+
+#### `filter_mode`
+
+**Optional**. Filtering mode for the reviewdog command `[added, diff_context, file, nofilter]`. Defaults to `added`.
+
+#### `fail_on_error`
+
+**Optional**. Exit code for reviewdog when errors are found `[true, false]`. Defaults to `false`.
+
+#### `reviewdog_flags`
+
+**Optional**. Additional reviewdog flags. Defaults to `""`.
+
+#### `tool_name`
+
+**Optional**. Tool name to use for reviewdog reporter. Defaults to `pytest`.
+
 ## Development
 
 ### Release

action.yml

@@ -1,43 +1,81 @@
-name: 'TODO: Run <linter-name> with reviewdog'
-description: 'TODO: 🐶 Run <linter-name> with reviewdog on pull requests to improve code review experience.'
-author: 'TODO: <your-name>'
+name: 'Run pytest with reviewdog'
+description: '🐶 Run pytest with reviewdog on pull requests to improve code review experience.'
+author: 'Ross Chadwick'
 inputs:
+  ### Generic flags ###
   github_token:
     description: 'GITHUB_TOKEN'
     default: '${{ github.token }}'
+    required: true
   workdir:
     description: 'Working directory relative to the root directory.'
+    required: false
     default: '.'
   ### Flags for reviewdog ###
   level:
     description: 'Report level for reviewdog [info,warning,error]'
+    required: false
     default: 'error'
   reporter:
     description: 'Reporter of reviewdog command [github-pr-check,github-pr-review].'
+    required: false
     default: 'github-pr-check'
   filter_mode:
     description: |
       Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
       Default is added.
+    required: false
     default: 'added'
   fail_on_error:
     description: |
       Exit code for reviewdog when errors are found [true,false]
       Default is `false`.
+    required: false
     default: 'false'
+  tool_name:
+    description: "Tool name to use for reviewdog reporter."
+    required: false
+    default: "pytest"
   reviewdog_flags:
     description: 'Additional reviewdog flags'
+    required: false
     default: ''
-  ### Flags for <linter-name> ###
-  locale:
-    description: '-locale flag of misspell. (US/UK)'
-    default: ''
+  ### Flags for pytest ###
+  pytest_coverage:
+    description: "Enables coverage reports output for pytest."
+    required: false
+    default: ""
+  pytest_profiling:
+    description: "Enables profiling reports output for pytest."
+    required: false
+    default: ""
+  pytest_profiling_visual:
+    description: "Enables visual profiling output for pytest. If both `pytest_profiling_visual` and `pytest_profiling` are true, visual mode takes precedence."
+    required: false
+    default: ""
+  pytest_args:
+    description: "Additional pytest arguments in standard command-line format, separated by spaces. If a custom argument conflicts with a pre-defined one, the custom argument will take precedence."
+    required: false
+    default: ""
+
 runs:
   using: 'docker'
   image: 'Dockerfile'
+  env:
+    INPUT_WORKDIR: ${{ inputs.workdir }}
+    INPUT_PYTEST_CUSTOM_ARGS: ${{ inputs.pytest_args }}
+    INPUT_PYTEST_PROFILING: ${{ inputs.pytest_profiling }}
+    INPUT_PYTEST_PROFILING_VISUAL: ${{ inputs.pytest_profiling_visual }}
+    INPUT_PYTEST_COVERAGE: ${{ inputs.pytest_coverage }}
+    INPUT_GITHUB_TOKEN: ${{ inputs.github_token }}
+    INPUT_TOOL_NAME: ${{ inputs.tool_name }}
+    INPUT_LEVEL: ${{ inputs.level }}
+    INPUT_REPORTER: ${{ inputs.reporter }}
+    INPUT_FILTER_MODE: ${{ inputs.filter_mode }}
+    INPUT_FAIL_ON_ERROR: ${{ inputs.fail_on_error }}
+    INPUT_REVIEWDOG_FLAGS: ${{ inputs.reviewdog_flags }}
 
 # Ref: https://haya14busa.github.io/github-action-brandings/
-# TODO: update branding if you want.
 branding:
   icon: 'check'
   color: 'blue'