Linting and formatting with pre-commit (#17)

* locally + GH action against main
* run hooks on existing files

.aws/ecs-task-definition.json

@@ -63,4 +63,4 @@
     "cpu": "512",
     "volumes": [
     ]
-}
+}

.devcontainer.json

@@ -8,7 +8,7 @@
     "postStartCommand": ["/bin/bash", "bin/init.sh"],
 
     // Set *default* container specific settings.json values on container create.
-    "settings": { 
+    "settings": {
         "terminal.integrated.shell.linux": "/bin/bash",
         "python.pythonPath": "/usr/local/bin/python",
     },

.dockerignore

@@ -7,4 +7,4 @@ server/
 .*ignore
 *.db
 docker-compose.yml
-Dockerfile*
+Dockerfile*

.flake8

@@ -1,2 +1,2 @@
 [flake8]
-max-line-length = 127
+max-line-length = 127

.github/workflows/deploy-ecs.yml

@@ -11,7 +11,6 @@ defaults:
 
 jobs:
   deploy:
-    name: Deploy
     runs-on: ubuntu-latest
 
     steps:
@@ -57,4 +56,4 @@ jobs:
           task-definition: ${{ steps.task-def.outputs.task-definition }}
           service: cal-itp-benefits-client
           cluster: cal-itp-clientCluster
-          wait-for-service-stability: true
+          wait-for-service-stability: true

.github/workflows/lint.yml

@@ -0,0 +1,15 @@
+name: Lint and formatting
+
+on:
+  push:
+    branches: main
+  pull_request:
+    branches: main
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - uses: pre-commit/[email protected]

.gitignore

@@ -2,4 +2,4 @@
 .env
 *.mo
 static/
-!benefits/static
+!benefits/static

.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: mixed-line-ending
+      - id: end-of-file-fixer
+      - id: requirements-txt-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: https://github.com/psf/black
+    rev: 20.8b1
+    hooks:
+      - id: black
+        types:
+          - python
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.4
+    hooks:
+      - id: flake8
+        types:
+          - python

.vscode/launch.json

@@ -30,4 +30,4 @@
             ]
         }
     ]
-}
+}

.vscode/settings.json

@@ -3,4 +3,4 @@
     "python.linting.flake8Enabled": true,
     "python.linting.enabled": true,
     "python.pythonPath": "/usr/local/bin/python",
-}
+}

Dockerfile

@@ -47,4 +47,4 @@ RUN chown -R $USER /home/$USER/app/benefits/locale
 USER $USER
 
 # configure container executable
-ENTRYPOINT ["/bin/bash", "bin/start.sh"]
+ENTRYPOINT ["/bin/bash", "bin/start.sh"]

Dockerfile.dev

@@ -3,4 +3,5 @@ FROM benefits_client:latest
 USER root
 
 RUN apt-get install -qq --no-install-recommends curl git jq ssh && \
-    pip install --no-cache-dir flake8 debugpy
+    pip install --no-cache-dir flake8 debugpy pre-commit && \
+    pre-commit install

LICENSE

@@ -671,4 +671,4 @@ into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -8,26 +8,26 @@ Requires [Docker][docker] and [Docker Compose][docker-compose].
 
 Clone the repository:
 
-```bash
+```console
 git clone https://github.com/cal-itp/benefits
 cd benefits
 ```
 
 Create an environment file from the sample:
 
-```bash
+```console
 cp .env.sample .env
 ```
 
 Build the Docker image using Docker Compose:
 
-```bash
+```console
 docker-compose build [--no-cache] client
 ```
 
 ### Start the client
 
-```bash
+```console
 docker-compose up [-d] client
 ```
 
@@ -40,30 +40,46 @@ By default, sample data from [`data/client.json`](./data/client.json) is used to
 
 * Modify the sample data file; or
 * Point `DJANGO_INIT_PATH` at a different data file; or
-* Hardcode the JSON in `DJANGO_INIT_JSON` e.g.  
+* Hardcode the JSON in `DJANGO_INIT_JSON` e.g.
 `DJANGO_INIT_JSON='[{"model":"core.eligibilitytype",...}]'`; or
 
 * (If `DJANGO_ADMIN=true`) use the backend administrative interface CRUD
 
 Stop the running services with:
 
-```bash
+```console
 docker-compose down
 ```
 
 ### Test verification server
 
 A basic eligibility verification server is available for testing:
 
-```bash
+```console
 docker-compose up [-d] --build server
 ```
 
 The API endpoint is running at `http://localhost:5000/verify`.
 
 Sample users and eligibility can be found in [`data/server.json`](./data/server.json).
 
-## VS Code with Dev Containers
+## Development
+
+This repository uses [`pre-commit`][pre-commit] hooks to check and format code.
+
+Ensure you have `pre-commit` installed:
+
+```console
+pip install pre-commit
+```
+
+Then run (from the root of this repository):
+
+```console
+pre-commit install
+```
+
+### VS Code with Dev Containers
 
 **This is the recommended development setup**.
 
@@ -89,21 +105,24 @@ Once running inside a container, press **`F5`** to attach a debugger to the clie
 The test eligibility verification server endpoint is running at `http://localhost:5000/verify` on your host machine.
 Access the server endpoint from within the Dev Container at `http://server:5000/verify`.
 
+`pre-commit` hooks are also installed and activated within the Dev Container.
+
 To close out of the container and re-open the directory locally in Visual Studio Code:
 
 1. `Ctrl+Shift+P` to bring up the command palette in Visual Studio Code
 1. Type `Remote-Containers` to filter the commands
 1. Select `Reopen Locally`
 
-[config-file]: ./.devcontainer.json
-[docker]: https://docs.docker.com/
-[docker-compose]: https://docs.docker.com/compose/
-[vscode]: https://code.visualstudio.com/
-[vscode-containers]: https://code.visualstudio.com/docs/remote/containers
-
 ## Token signing and encryption
 
 The Eligiblity Verification API makes use of Signed and Encrypted JSON Web Tokens (JWS, JWE, JWT) as a means of data transfer.
 
 A public/private keypair must be generated by each party (Benefits Client and Eligibility Verification Server). [Example keys](./keys)
 are included for the test verification server and sample agencies.
+
+[config-file]: ./.devcontainer.json
+[docker]: https://docs.docker.com/
+[docker-compose]: https://docs.docker.com/compose/
+[vscode]: https://code.visualstudio.com/
+[pre-commit]: https://pre-commit.com/
+[vscode-containers]: https://code.visualstudio.com/docs/remote/containers

benefits/core/api.py

@@ -1,6 +1,4 @@
-
-
-class Response():
+class Response:
     """Base API response."""
 
     def __init__(self, status_code, error=None, message=None):

benefits/core/middleware.py

@@ -20,7 +20,7 @@ def process_view(self, request, view_func, view_args, view_kwargs):
             raise AttributeError("Agency not configured for session")
 
 
-class DebugSession():
+class DebugSession:
     """Middleware to configure debug context in the request session."""
 
     def __init__(self, get_response):