Add black to pre-commit (#68)

Author: nicolasbarra

.pre-commit-config.yaml

@@ -3,7 +3,7 @@ default_language_version:
     python: python3.8
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.4.0
     hooks:
     -   id: check-docstring-first
     -   id: check-executables-have-shebangs
@@ -13,6 +13,10 @@ repos:
     -   id: debug-statements
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
+-   repo: https://github.com/psf/black
+    rev: 23.1.0
+    hooks:
+    -   id: black
 -   repo: https://github.com/pycqa/flake8
     rev: 5.0.4
     hooks:
@@ -22,4 +26,3 @@ repos:
         -   flake8-builtins==2.0.1
         -   flake8-comprehensions==3.10.1
         -   flake8-tidy-imports==4.8.0
-        

data/mock/interactive/view_submission_synchronous_test.json

@@ -1,3 +1,3 @@
 {
   "payload": "{\"type\":\"view_submission\",\"token\":\"ABCDEFGHIJKLMNOPQRSTUVWX\",\"team\":{\"id\":\"TEST_TEAM_ID\",\"domain\":\"test-team-name\"},\"user\":{\"id\":\"TEST_USER_ID\",\"name\":\"testusername\"},\"view\":{\"id\":\"VNHU13V36\",\"type\":\"modal\",\"title\":{ \"a\":\"b\" },\"submit\":{ \"a\":\"b\" },\"blocks\":[],\"private_metadata\":\"shhh-its-secret\",\"callback_id\":\"modal-with-inputs\",\"state\":{\"values\":{\"multiline\":{\"mlvalue\":{\"type\":\"plain_text_input\",\"value\":\"This is my example inputted value\"}},\"target_channel\":{\"target_select\":{\"type\":\"conversations_select\",\"selected_conversation\":\"C123B12DE\"}}}},\"hash\":\"156663117.cd33ad1f\",\"response_urls\":[{\"block_id\":\"target_channel\",\"action_id\":\"target_select\",\"channel_id\":\"C123B12DE\",\"response_url\":\"https:\\/\\/hooks.slack.com\\/app\\/ABC12312\\/1234567890\\/A100B100C100d100\"}]}}"
-}
+}

omnibot/__init__.py

@@ -1,4 +1,4 @@
 from os import getenv
 import importlib
 
-logging = importlib.import_module(getenv('LOG_MODULE', 'logging'))
+logging = importlib.import_module(getenv("LOG_MODULE", "logging"))

omnibot/authnz/__init__.py

@@ -14,10 +14,7 @@
 import re
 from functools import wraps
 
-from flask import (
-    abort,
-    request
-)
+from flask import abort, request
 
 from omnibot import logging
 from omnibot import settings
@@ -42,24 +39,26 @@ def enforce_checks(f):
     Checks will be executed in the order defined by the list. All checks must
     pass for a request to be accepted.
     """
+
     @wraps(f)
     def decorated(*args, **kwargs):
-        checks = settings.AUTHORIZATION.get('checks', [])
+        checks = settings.AUTHORIZATION.get("checks", [])
         if not checks:
             logger.warning(
-                'No checks set in the authorization section of the configuration;'
-                ' denying access to API calls for sanity sake'
+                "No checks set in the authorization section of the configuration;"
+                " denying access to API calls for sanity sake"
             )
             return abort(403)
         for check in checks:
-            module_name, function_name = check['module'].split(':')
+            module_name, function_name = check["module"].split(":")
             module = importlib.import_module(module_name)
             function = getattr(module, function_name)
-            func_kwargs = check.get('kwargs', {})
+            func_kwargs = check.get("kwargs", {})
             response = function(**func_kwargs)
             if not response:
                 return abort(403)
         return f(*args, **kwargs)
+
     return decorated
 
 

omnibot/authnz/envoy_checks.py

@@ -23,7 +23,7 @@ def _match_subject(subject_to_match, subject):
     return False
 
 
-def envoy_internal_check(header='x-envoy-internal'):
+def envoy_internal_check(header="x-envoy-internal"):
     """
     Perform a check to ensure that the ``x-envoy-internal`` is set to 'true'.
     By default this check will apply to all routes, if enabled. It's possible
@@ -45,44 +45,44 @@ def envoy_internal_check(header='x-envoy-internal'):
     """
     # Flask provides all headers as strings. The only acceptable string here
     # is 'true'
-    envoy_internal = request.headers.get(header) == 'true'
+    envoy_internal = request.headers.get(header) == "true"
     # Easy case. The header says the request is internal.
     if envoy_internal:
         return True
     # If the request isn't internal, let's see if we have a permission that
     # matches, which has internal_only set to False
-    permissions = settings.AUTHORIZATION.get('permissions', {})
+    permissions = settings.AUTHORIZATION.get("permissions", {})
     for policy_name, policy in permissions.items():
-        method_match = request.method in policy['methods']
-        path_match = _match_path(request.path, policy['paths'])
-        internal_only = policy.get('internal_only', True)
+        method_match = request.method in policy["methods"]
+        path_match = _match_path(request.path, policy["paths"])
+        internal_only = policy.get("internal_only", True)
         if (method_match and path_match) and not internal_only:
             return True
     logger.warning(
-        'Received an external request to internal endpoint',
+        "Received an external request to internal endpoint",
         extra={
-            'endpoint': request.path,
-            'method': request.method,
-            'header_value': envoy_internal,
+            "endpoint": request.path,
+            "method": request.method,
+            "header_value": envoy_internal,
         },
     )
     return False
 
 
 def _check_permission(permission):
-    permissions = settings.AUTHORIZATION.get('permissions', {})
+    permissions = settings.AUTHORIZATION.get("permissions", {})
     policy = permissions.get(permission, {})
     # TODO: envoy RBAC spec allows for matching methods and paths as
     # individual checks. So for instance, a permission may allow for all GETs
     # without a particular path, or may allow all methods on particular paths.
-    method_match = request.method in policy.get('methods', [])
-    path_match = _match_path(request.path, policy.get('paths', []))
+    method_match = request.method in policy.get("methods", [])
+    path_match = _match_path(request.path, policy.get("paths", []))
     if method_match and path_match:
         return True
     return False
 
 
-def envoy_permissions_check(header='x-envoy-downstream-service-cluster'):
+def envoy_permissions_check(header="x-envoy-downstream-service-cluster"):
     """
     Perform a check against the defined permissions and bindings in the
     authorization configuration to ensure the service defined in the
@@ -122,17 +122,17 @@ def envoy_permissions_check(header='x-envoy-downstream-service-cluster'):
     envoy_identity = request.headers.get(header)
     if envoy_identity is None:
         return False
-    bindings = settings.AUTHORIZATION.get('bindings', {})
+    bindings = settings.AUTHORIZATION.get("bindings", {})
     for subject, permissions in bindings.items():
         if _match_subject(envoy_identity, subject):
             for permission in permissions:
                 if _check_permission(permission):
                     return True
     logger.warning(
-        'Received an unauthorized request',
+        "Received an unauthorized request",
         extra={
-            'from': envoy_identity,
-            'endpoint': request.path,
+            "from": envoy_identity,
+            "endpoint": request.path,
         },
     )
     return False

omnibot/callbacks/interactive_component_callbacks.py

@@ -14,17 +14,13 @@ def echo_dialog_submission_callback(container):
     Just repond back with whatever is sent in.
     """
     payload = container.payload
-    logger.debug('echo callback payload: {}'.format(
-        json.dumps(payload, indent=2))
-    )
+    logger.debug("echo callback payload: {}".format(json.dumps(payload, indent=2)))
     return {
         # Respond back to the slash command with the same text
-        'responses': [
+        "responses": [
             {
-                'text': payload['submission']['echo_element'],
-                'omnibot_parse': {
-                    'text': ['users', 'specials', 'channels']
-                }
+                "text": payload["submission"]["echo_element"],
+                "omnibot_parse": {"text": ["users", "specials", "channels"]},
             }
         ]
     }