Merge pull request #26 from niklasstoffers/lint-workflow

Add linting, lint workflow and fix linter errors

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+exclude = __pycache__,.pytest_cache,.venv,venv
+max-complexity = 10
+max_line_length = 250

.github/workflows/lint.yml

@@ -0,0 +1,20 @@
+name: LINT
+
+on: [push]
+
+jobs:
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Wait for build
+      uses: lewagon/[email protected]
+      with:
+        ref: ${{ github.ref }}
+        check-name: 'build'
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        wait-interval: 5
+    - name: Run lint
+      run: |
+        ./ci_lint.sh

.github/workflows/publish.yml

@@ -21,6 +21,13 @@ jobs:
         check-name: 'test'
         repo-token: ${{ secrets.GITHUB_TOKEN }}
         wait-interval: 5
+    - name: Wait for lint
+      uses: lewagon/[email protected]
+      with:
+        ref: ${{ github.ref }}
+        check-name: 'lint'
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        wait-interval: 5
     - name: Download build artifacts
       uses: dawidd6/action-download-artifact@v3
       with:

.pre-commit-config.yaml

@@ -4,4 +4,10 @@ repos:
     hooks:
       - id: ggshield
         language_version: python3
-        stages: [commit]
+        stages: [commit]
+  - repo: https://github.com/PyCQA/flake8
+    rev: 6.1.0
+    hooks:
+      - id: flake8
+        files: .
+        args: [--config, .flake8]

autoapprove/app.py

@@ -9,4 +9,4 @@
 app.include_router(comment_router)
 
 logger: Logger = getLogger(__name__)
-logger.info("Application startup complete")
+logger.info("Application startup complete")

autoapprove/app_info.py

@@ -1,3 +1,3 @@
-VERSION="0.1.0"
-NAME="Gitlab Auto Approve"
-SUMMARY="Gitlab webhook for automatically approving merge requests."
+VERSION = "0.1.0"
+NAME = "Gitlab Auto Approve"
+SUMMARY = "Gitlab webhook for automatically approving merge requests."

autoapprove/bootstrapping/app_builder.py

@@ -9,25 +9,26 @@
 from middleware.exception_logger_middleware import ExceptionLoggerMiddleware
 from app_info import VERSION, NAME, SUMMARY
 
+
 class AppBuilder():
     config: Config
     logger: Logger
 
     def with_config(self, config: Config) -> 'AppBuilder':
         self.config = config
         return self
-    
+
     def __configure_logging(self):
         rootLogger: Logger = getLogger(None)
         config = self.config.logging
         if config.enable and config.handlers is not None:
             handlers = config.handlers
-            rootLogger = create_logger(rootLogger, 
-                                    config.getLogLevel(),
-                                    handlers.console is not None and handlers.console.enable,
-                                    handlers.file is not None and handlers.file.enable,
-                                    handlers.file.logfile if handlers.file is not None else "")
-    
+            rootLogger = create_logger(rootLogger,
+                                       config.getLogLevel(),
+                                       handlers.console is not None and handlers.console.enable,
+                                       handlers.file is not None and handlers.file.enable,
+                                       handlers.file.logfile if handlers.file is not None else "")
+
     def __configure_app(self, app: FastAPI):
         app.add_middleware(ExceptionLoggerMiddleware)
 
@@ -38,7 +39,7 @@ def __configure_app(self, app: FastAPI):
         if self.config.ssl.enable:
             self.logger.info("Enabling HTTPS redirection")
             enable_https_redirection(app)
-        
+
         origin = str(self.config.gitlab.host)
         self.logger.info('Enabling CORS with allowed origin set to "%s"', origin)
         enable_cors(app, origins=[origin])
@@ -56,4 +57,4 @@ def build(self) -> FastAPI:
         self.logger.info("Configuring app")
         self.__configure_app(app)
 
-        return app
+        return app

autoapprove/config/commands/approval.py

@@ -1,4 +1,5 @@
 from config.commands.respondable_command import RespondableCommand
 
+
 class Approval(RespondableCommand):
-    pass
+    pass

autoapprove/config/commands/command.py

@@ -4,11 +4,12 @@
 from config.validators.string_list_not_empty import string_list_not_empty
 from config.gitlab.gitlab_role import GitlabRole
 
+
 class Command(ABC, BaseModel):
     keyword: Annotated[str, StringConstraints(strip_whitespace=True, min_length=1)]
     ignore_case: bool
     strict_match: bool
     only_for_members: list[str] | None = None
     requires_role: GitlabRole | None = None
 
-    _string_list_not_empty = validator('ONLY_FOR_MEMBERS', allow_reuse=True, check_fields=False)(string_list_not_empty)
+    _string_list_not_empty = validator('ONLY_FOR_MEMBERS', allow_reuse=True, check_fields=False)(string_list_not_empty)

autoapprove/config/commands/commands.py

@@ -3,7 +3,8 @@
 from config.commands.disapproval import Disapproval
 from config.commands.merge import Merge
 
+
 class Commands(BaseModel):
     approval: Approval
     disapproval: Disapproval
-    merge: Merge
+    merge: Merge

autoapprove/config/commands/disapproval.py

@@ -1,4 +1,5 @@
 from config.commands.respondable_command import RespondableCommand
 
+
 class Disapproval(RespondableCommand):
-    pass
+    pass

autoapprove/config/commands/merge.py

@@ -1,4 +1,5 @@
 from config.commands.respondable_command import RespondableCommand
 
+
 class Merge(RespondableCommand):
-    pass
+    pass

autoapprove/config/commands/respondable_command.py

@@ -3,5 +3,6 @@
 from typing import Annotated
 from config.commands.command import Command
 
+
 class RespondableCommand(Command, ABC):
-    message: Annotated[str | None, StringConstraints(strip_whitespace=True, min_length=1)] = None
+    message: Annotated[str | None, StringConstraints(strip_whitespace=True, min_length=1)] = None

autoapprove/config/config.py

@@ -6,11 +6,12 @@
 from config.uvicorn import Uvicorn
 from config.logging.logging import Logging
 
+
 class Config(BaseModel):
     gitlab: Gitlab
     trusted_hosts_only: bool
     environment: Environment
     ssl: SSL
     commands: Commands
     uvicorn: Uvicorn
-    logging: Logging
+    logging: Logging

autoapprove/config/config_manager.py

@@ -7,6 +7,7 @@
 
 _config: Config | None = None
 
+
 def _load_config(filename: str, logger: Logger) -> Config:
     try:
         logger.info('Loading configuration from file "%s"', filename)
@@ -19,11 +20,13 @@ def _load_config(filename: str, logger: Logger) -> Config:
         logger.error('Failed to load configuration', exc_info=e)
         raise Exception("Failed to load configuration file. Please check your settings")
 
+
 def init(filename: str, logger: Logger):
     global _config
     _config = _load_config(filename, logger)
 
+
 def get_config() -> Config:
     if _config is None:
         raise Exception("Configuration has not been loaded")
-    return _config
+    return _config

autoapprove/config/environment.py

@@ -1,5 +1,6 @@
 from enum import Enum
 
+
 class Environment(str, Enum):
     DEVELOPMENT = 'DEVELOPMENT'
-    PRODUCTION = 'PRODUCTION'
+    PRODUCTION = 'PRODUCTION'

autoapprove/config/environment_loader.py

@@ -4,15 +4,17 @@
 from config.config import Config
 from helpers.type import is_of_type_or_generic_of_type, is_optional, unpack_optional
 
+
 def _parse_as_list(value: str) -> list[str]:
     value = value.strip("[]")
     return [x.strip() for x in value.split(',') if len(x.strip()) > 0]
 
+
 def _load_environment_variable(section: dict[str, Any], env_var_name: str, attribute: str, type: type) -> bool:
     value: str = environ.get(env_var_name, None)
     if value is None or len(value.strip()) == 0:
         return False
-    
+
     value = value.strip()
     if is_optional(type):
         type = unpack_optional(type)
@@ -23,6 +25,7 @@ def _load_environment_variable(section: dict[str, Any], env_var_name: str, attri
         section[attribute] = value
     return True
 
+
 def _is_model(t: type) -> (bool, type):
     model_type: type = t
     if is_optional(t):
@@ -31,13 +34,14 @@ def _is_model(t: type) -> (bool, type):
         return True, model_type
     return False, None
 
+
 def _load_environment_helper(section: dict[str, Any], section_type: BaseModel, separator: str, prefix: str = "") -> bool:
     loaded_field = False
     for field_name, field_info in section_type.model_fields.items():
         field_type = field_info.annotation
         is_model, model_type = _is_model(field_type)
         if is_model:
-            field_was_none = not field_name in section
+            field_was_none = field_name not in section
             if field_was_none:
                 section[field_name] = dict()
             loaded_sub_field = _load_environment_helper(section[field_name], cast(BaseModel, model_type), separator, f"{prefix}{field_name}{separator}")
@@ -49,4 +53,4 @@ def _load_environment_helper(section: dict[str, Any], section_type: BaseModel, s
 
 
 def load_environment(config: dict[str, Any], separator: str = "__"):
-    _load_environment_helper(config, Config, separator)
+    _load_environment_helper(config, Config, separator)

autoapprove/config/gitlab/gitlab.py

@@ -1,7 +1,8 @@
 from pydantic import BaseModel, StringConstraints, HttpUrl
 from typing import Annotated
 
+
 class Gitlab(BaseModel):
     host: HttpUrl
     access_token: Annotated[str, StringConstraints(strip_whitespace=True, min_length=1)]
-    webhook_token: Annotated[str, StringConstraints(strip_whitespace=True, min_length=1)]
+    webhook_token: Annotated[str, StringConstraints(strip_whitespace=True, min_length=1)]

autoapprove/config/gitlab/gitlab_role.py

@@ -3,6 +3,7 @@
 
 ROLE_MAPPINGS = dict()
 
+
 class GitlabRole(str, Enum):
     NO_ACCESS = 'NO_ACCESS'
     MINIMAL_ACCESS = 'MINIMAL_ACCESS'
@@ -15,10 +16,11 @@ class GitlabRole(str, Enum):
     def get_role(self):
         return ROLE_MAPPINGS[self]
 
+
 ROLE_MAPPINGS[GitlabRole.NO_ACCESS] = Role.NO_ACCESS
 ROLE_MAPPINGS[GitlabRole.MINIMAL_ACCESS] = Role.MINIMAL_ACCESS
 ROLE_MAPPINGS[GitlabRole.GUEST] = Role.GUEST
 ROLE_MAPPINGS[GitlabRole.REPORTER] = Role.REPORTER
 ROLE_MAPPINGS[GitlabRole.DEVELOPER] = Role.DEVELOPER
 ROLE_MAPPINGS[GitlabRole.MAINTAINER] = Role.MAINTAINER
-ROLE_MAPPINGS[GitlabRole.OWNER] = Role.OWNER
+ROLE_MAPPINGS[GitlabRole.OWNER] = Role.OWNER

autoapprove/config/logging/console_handler.py

@@ -1,4 +1,5 @@
 from config.logging.handler import Handler
 
+
 class ConsoleHandler(Handler):
-    pass
+    pass

autoapprove/config/logging/file_handler.py

@@ -2,11 +2,12 @@
 from pathlib import Path
 from config.logging.handler import Handler
 
+
 class FileHandler(Handler):
     logfile: Path | None = None
 
     @model_validator(mode='after')
     def _validate(self) -> 'FileHandler':
         if self.enable and self.logfile is None:
             raise ValidationError("Log file must be specified when enabling file handler")
-        return self
+        return self

autoapprove/config/logging/handler.py

@@ -1,4 +1,5 @@
 from pydantic import BaseModel
 
+
 class Handler(BaseModel):
-    enable: bool
+    enable: bool

autoapprove/config/logging/handlers.py

@@ -2,6 +2,7 @@
 from config.logging.file_handler import FileHandler
 from config.logging.console_handler import ConsoleHandler
 
+
 class Handlers(BaseModel):
     console: ConsoleHandler | None = None
-    file: FileHandler | None = None
+    file: FileHandler | None = None

autoapprove/config/logging/logging.py

@@ -1,14 +1,13 @@
 from pydantic import BaseModel, model_validator, ValidationError
 from config.logging.handlers import Handlers
-from logging import getLevelNamesMapping
 from helpers.logging.level import get_level_from_name
 
+
 class Logging(BaseModel):
     enable: bool
     level: str | None = None
     handlers: Handlers | None = None
     _level: int | None = None
-
 
     @model_validator(mode='after')
     def _validate(self) -> 'Logging':
@@ -20,9 +19,8 @@ def _validate(self) -> 'Logging':
                 if level is None:
                     raise ValidationError("Invalid log level")
                 self._level = level
-        
+
         return self
 
-
     def getLogLevel(self) -> int:
-        return self._level
+        return self._level

autoapprove/config/ssl.py

@@ -1,5 +1,6 @@
 from pydantic import BaseModel, model_validator, FilePath, ValidationError
 
+
 class SSL(BaseModel):
     enable: bool
     key_file: FilePath | None = None
@@ -9,4 +10,4 @@ class SSL(BaseModel):
     def _validate_certs(self) -> 'SSL':
         if self.enable and (self.key_file is None or self.cert_file is None):
             raise ValidationError("Certificate and key file are required with SSL enabled")
-        return self
+        return self