add pre-commit with basic hooks

leo-schick · leo-schick · commit d55e84880ee6 · 2023-03-03T16:39:31.000+01:00
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -30,4 +30,4 @@ jobs:
           echo Finished successful build with Python $pythonversion
 #      - name: Test with pytest
 #        run: |
-#          pytest -v tests 
+#          pytest -v tests
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,11 @@
+# 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-toml
+    -   id: check-yaml
+    -   id: check-added-large-files
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,7 +19,7 @@
 
 - Change MARA_XXX variables to functions to delay importing of imports
 
-**required changes** 
+**required changes**
 
 - Update `mara-app` to `>=2.0.0`
 
@@ -32,7 +32,7 @@
 - Remove functions `user_has_permission` and `current_user_has_permission` (they are now implemented in `mara_page.acl`)
 - Remove deprecated dependency_links
 - Bump minimum `mara-page` version to 1.4.0
-- In `current_user_has_permissions`: When requested for a parent resource, return `True` when permissions for one of the child resources exist 
+- In `current_user_has_permissions`: When requested for a parent resource, return `True` when permissions for one of the child resources exist
 
 **required changes**
 
@@ -57,7 +57,7 @@ monkey_patch.patch(mara_page.acl.user_has_permissions)(mara_acl.permissions.user
 
 - If not already the case, add these two dependencies to your project requirements.txt:
 
-```        
+```
 -e git+git@github.com:mara/mara-db.git@3.2.1#egg=mara-db
 -e git+git@github.com:mara/mara-page.git@1.4.0#egg=mara-page
 ```
@@ -71,7 +71,7 @@ monkey_patch.patch(mara_page.acl.user_has_permissions)(mara_acl.permissions.user
 ## 1.3.0 (2018-03-19)
 
 - Replace sqlalchemy orm query logic with plain sql queries in order to avoid idling zombie connections
- 
+
 
 ## 1.2.0 (2017-12-30)
 
@@ -85,12 +85,11 @@ monkey_patch.patch(mara_page.acl.user_has_permissions)(mara_acl.permissions.user
 
 
 
-## 1.0.0 - 1.0.4 (2017-03-10) 
+## 1.0.0 - 1.0.4 (2017-03-10)
 
 - Initial version
-- Refactored login 
+- Refactored login
 - Added function `user_has_permission`
 - Login bug fix
 - Emails are always converted to lowercase before processing
 - Adapted to mara ui changes
-
diff --git a/Makefile b/Makefile
@@ -30,4 +30,4 @@ clean:
 	mkdir -p .venv
 	cd .venv && $(.PYTHON3) -m venv --copies --prompt='[$(shell basename `pwd`)/.venv]' .
 
-	.venv/bin/python -m pip install --upgrade pip 
+	.venv/bin/python -m pip install --upgrade pip
diff --git a/README.md b/README.md
@@ -7,19 +7,19 @@
 
 Default ACL implementation for mara with the following design choices:
 
-- Authentication of users is handled externally, e.g. through a [OAuth2 Proxy](https://github.com/oauth2-proxy/oauth2-proxy). 
+- Authentication of users is handled externally, e.g. through a [OAuth2 Proxy](https://github.com/oauth2-proxy/oauth2-proxy).
   An upstream authentication app manages authentication and then adds a http header identifying the user to each authenticated request.
 - Each user is assigned a single role.
-- Permissions are not based on urls, but on application-defined "resources". 
+- Permissions are not based on urls, but on application-defined "resources".
   Thus, checking of permissions needs to be done in the application.
 
-The ACL provides a single UI for both user and permission management. 
+The ACL provides a single UI for both user and permission management.
 Users can be added / removed and their roles can be changed like this:
 ![User management](https://github.com/mara/mara-acl/raw/main/docs/_static/users-and-roles.gif)
 
 New roles are created by moving a user to a new role.
 
-Permissions can be set for 
+Permissions can be set for
 
 - an individual user or a whole role,
 - an individual resource, a group of resources or "All" resources.
@@ -28,11 +28,11 @@ Individual users inherit permissions from their role, and permissions on higher
 ![User management](https://github.com/mara/mara-acl/raw/main/docs/_static/permissions.gif)
 
 
-Each new user that is authenticated is automatically created 
+Each new user that is authenticated is automatically created
 with a default role in the acl:
 ![User management](https://github.com/mara/mara-acl/raw/main/docs/_static/automatic-user-creation.png)
 
-This behavior can be switched off (so that only invited users can join). See [config.py](https://github.com/mara/mara-acl/blob/main/mara_acl/config.py) for details. 
+This behavior can be switched off (so that only invited users can join). See [config.py](https://github.com/mara/mara-acl/blob/main/mara_acl/config.py) for details.
 
 
 Please have a look at the mara example application for how to integrate this ACL implementation.
diff --git a/docs/changes.md b/docs/changes.md
@@ -1,2 +1,2 @@
 ```{include} ../CHANGELOG.md
-```
+```
diff --git a/docs/conf.py b/docs/conf.py
@@ -60,4 +60,4 @@
 html_static_path = ['_static']
 html_favicon = "_static/favicon.ico"
 html_logo = "_static/mara-animal.jpg"
-html_title = f"Mara ACL Documentation ({version})" 
+html_title = f"Mara ACL Documentation ({version})"
diff --git a/docs/index.rst b/docs/index.rst
@@ -36,4 +36,4 @@ Legal information and changelog are here for the interested.
    :maxdepth: 2
 
    license
-   changes
+   changes
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,2 @@
 sphinx==4.5.0
-myst-parser==0.18.0
+myst-parser==0.18.0
diff --git a/docs/user-and-permission-management.md b/docs/user-and-permission-management.md
@@ -1,15 +1,15 @@
 User and permission management
 ==============================
 
-The module provides a single UI for both user and permission management. 
+The module provides a single UI for both user and permission management.
 Users can be added / removed and their roles can be changed like this:
 ![User management](https://github.com/mara/mara-acl/raw/main/docs/_static/users-and-roles.gif)
 
 
 Automatic user creation
 -----------------------
 
-Each new user that is authenticated is automatically created 
+Each new user that is authenticated is automatically created
 with a default role in the acl:
 ![User management](https://github.com/mara/mara-acl/raw/main/docs/_static/automatic-user-creation.png)
 
@@ -21,7 +21,7 @@ Managing permissions for users and roles
 
 New roles are created by moving a user to a new role.
 
-Permissions can be set for 
+Permissions can be set for
 
 - an individual user or a whole role,
 - an individual resource, a group of resources or "All" resources.
diff --git a/mara_acl/config.py b/mara_acl/config.py
@@ -42,4 +42,3 @@ def require_email_http_header() -> str:
 def whitelisted_uris() -> [str]:
     """Which uris to exclude from the acl"""
     return []
-
diff --git a/mara_acl/keys.py b/mara_acl/keys.py
@@ -19,4 +19,3 @@ def resource_key(resource: acl.AclResource) -> str:
     """Computes a unique key for a permission"""
     return (resource_key(resource.parent) if resource.parent else 'resource__All') \
            + '__' + escape_key(resource.name)
-
diff --git a/mara_acl/permissions.py b/mara_acl/permissions.py
@@ -34,8 +34,8 @@ def current_user_has_permissions(resources: [acl.AclResource]) -> [[acl.AclResou
         # create a select statement for each resource and combine them with ' UNION ALL '
         cursor.execute(' UNION ALL '.join([
             cursor.mogrify(f"""
-SELECT EXISTS (SELECT 1 FROM acl_permission 
-               WHERE ({'%s'} LIKE CONCAT(resource_key, '%%') OR resource_key LIKE CONCAT({'%s'}, '%%')) 
+SELECT EXISTS (SELECT 1 FROM acl_permission
+               WHERE ({'%s'} LIKE CONCAT(resource_key, '%%') OR resource_key LIKE CONCAT({'%s'}, '%%'))
                    AND {'%s'} LIKE CONCAT(user_key,'%%'))
 """,
                            (keys.resource_key(resource), keys.resource_key(resource), user_key)).decode("utf-8")
diff --git a/mara_acl/static/acl.css b/mara_acl/static/acl.css
@@ -63,4 +63,3 @@
     cursor: pointer;
     color: #ccc;
 }
-
diff --git a/mara_acl/static/acl.js b/mara_acl/static/acl.js
@@ -250,4 +250,4 @@ function toggleResource(resource) {
         });
     }
     updatePermissionTable();
-}
+}
diff --git a/mara_acl/users.py b/mara_acl/users.py
@@ -37,7 +37,7 @@ def login(email: str) -> typing.Union[response.Response, bool]:
     email = email.lower()  # make sure always same case is used
 
     with mara_db.postgresql.postgres_cursor_context('mara') as cursor:
-        
+
         # get user from db
         cursor.execute(f"SELECT email, role FROM acl_user WHERE email = {'%s'}", (email,))
         result = cursor.fetchone()
diff --git a/mara_acl/views.py b/mara_acl/views.py
@@ -118,7 +118,7 @@ def login():
 def _handle_login() -> str:
     """
     Handles the login process
-    
+
     Returns:
         Null when the page is whiltelisted
         flask.redirect when the page shall be forwareded to a authentication page
@@ -133,4 +133,4 @@ def _handle_login() -> str:
         else:
             email = 'guest@localhost'
 
-    return email
+    return email
diff --git a/setup.py b/setup.py
@@ -1,3 +1,3 @@
 from setuptools import setup
 
-setup()
+setup()

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	```{include} ../CHANGELOG.md
`2`		-```
	`2`	+```
-Original file line number
+Diff line change
    :maxdepth: 2
    license
 -   changes
 +   changes
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`sphinx==4.5.0`
`2`		`-myst-parser==0.18.0`
	`2`	`+myst-parser==0.18.0`