Merge branch 'develop'

Dockerfile.prod

@@ -8,8 +8,9 @@ RUN apk add --no-cache mysql-client \
 # Set the working directory in the container to /app
 WORKDIR /app
 
-# Copy the contents of the local app/ directory to the /app directory in the container
+# Copy files
 COPY app/ ./app
+COPY core/ ./core
 
 # Copy requirements.txt into the working directory /app
 COPY requirements.txt .

app/__init__.py

@@ -1,14 +1,15 @@
 import os
-import logging
 
-from flask import Flask, render_template
+from flask import Flask
 from flask_login import current_user
 from flask_sqlalchemy import SQLAlchemy
 from dotenv import load_dotenv
 from flask_migrate import Migrate
 
-from app.managers.blueprint_manager import BlueprintManager
-from app.managers.config_manager import ConfigManager
+from core.managers.blueprint_manager import BlueprintManager
+from core.managers.config_manager import ConfigManager
+from core.managers.error_handler_manager import ErrorHandlerManager
+from core.managers.logging_manager import LoggingManager
 
 # Load environment variables
 load_dotenv()
@@ -43,12 +44,13 @@ def load_user(user_id):
         from app.blueprints.auth.models import User
         return User.query.get(int(user_id))
 
-    # Logging
-    logging.basicConfig(filename='app.log', level=logging.ERROR,
-                        format='%(asctime)s:%(levelname)s:%(message)s')
+    # Set up logging
+    logging_manager = LoggingManager(app)
+    logging_manager.setup_logging()
 
-    # Custom error handlers
-    register_error_handlers(app)
+    # Initialize error handler manager
+    error_handler_manager = ErrorHandlerManager(app)
+    error_handler_manager.register_error_handlers()
 
     # Injecting environment variables into jinja context
     @app.context_processor
@@ -62,28 +64,6 @@ def inject_vars_into_jinja():
     return app
 
 
-def register_error_handlers(app):
-    @app.errorhandler(500)
-    def base_error_handler(e):
-        app.logger.error('Internal Server Error: %s', str(e))  # Error logging
-        return render_template('500.html'), 500
-
-    @app.errorhandler(404)
-    def error_404_handler(e):
-        app.logger.warning('Page Not Found: %s', str(e))  # Warning logging
-        return render_template('404.html'), 404
-
-    @app.errorhandler(401)
-    def error_401_handler(e):
-        app.logger.warning('Unauthorized Access: %s', str(e))  # Warning logging
-        return render_template('401.html'), 401
-
-    @app.errorhandler(400)
-    def error_400_handler(e):
-        app.logger.warning('Bad Request: %s', str(e))  # Warning logging
-        return render_template('400.html'), 400
-
-
 def get_test_client():
     """
     Function to get the test client of the application.

app/blueprints/auth/seeders.py

@@ -1,6 +1,6 @@
 from app.blueprints.auth.models import User
 from app.blueprints.profile.models import UserProfile
-from app.seeders.BaseSeeder import BaseSeeder
+from core.seeders.BaseSeeder import BaseSeeder
 
 
 class AuthSeeder(BaseSeeder):

app/blueprints/profile/repositories.py

@@ -1,5 +1,5 @@
 from app.blueprints.profile.models import UserProfile
-from app.repositories.BaseRepository import BaseRepository
+from core.repositories.BaseRepository import BaseRepository
 
 
 class UserProfileRepository(BaseRepository):

app/blueprints/profile/services.py

@@ -1,5 +1,5 @@
 from app.blueprints.profile.repositories import UserProfileRepository
-from app.services.BaseService import BaseService
+from core.services.BaseService import BaseService
 
 
 class UserProfileService(BaseService):

app/blueprints/zenodo/repositories.py

@@ -1,5 +1,5 @@
 from app.blueprints.zenodo.models import Zenodo
-from app.repositories.BaseRepository import BaseRepository
+from core.repositories.BaseRepository import BaseRepository
 
 
 class ZenodoRepository(BaseRepository):

app/blueprints/zenodo/services.py

@@ -1,5 +1,5 @@
 from app.blueprints.zenodo.repositories import ZenodoRepository
-from app.services.BaseService import BaseService
+from core.services.BaseService import BaseService
 
 import os
 

core/managers/error_handler_manager.py

@@ -0,0 +1,27 @@
+from flask import render_template
+
+
+class ErrorHandlerManager:
+    def __init__(self, app):
+        self.app = app
+
+    def register_error_handlers(self):
+        @self.app.errorhandler(500)
+        def internal_error(e):
+            self.app.logger.error('Internal Server Error: %s', str(e))
+            return render_template('500.html'), 500
+
+        @self.app.errorhandler(404)
+        def not_found_error(e):
+            self.app.logger.warning('Page Not Found: %s', str(e))
+            return render_template('404.html'), 404
+
+        @self.app.errorhandler(401)
+        def unauthorized_error(e):
+            self.app.logger.warning('Unauthorized Access: %s', str(e))
+            return render_template('401.html'), 401
+
+        @self.app.errorhandler(400)
+        def bad_request_error(e):
+            self.app.logger.warning('Bad Request: %s', str(e))
+            return render_template('400.html'), 400

core/managers/logging_manager.py

@@ -0,0 +1,29 @@
+import logging
+from logging.handlers import RotatingFileHandler
+
+
+class LoggingManager:
+    def __init__(self, app):
+        self.app = app
+
+    def setup_logging(self):
+        # Configure log format
+        formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+
+        # Configure the log file with file rotation
+        file_handler = RotatingFileHandler('app.log', maxBytes=10240, backupCount=10)
+        file_handler.setLevel(logging.ERROR)
+        file_handler.setFormatter(formatter)
+
+        # Add handler to app logger
+        self.app.logger.addHandler(file_handler)
+
+        # Configure console log if necessary
+        if self.app.debug:
+            stream_handler = logging.StreamHandler()
+            stream_handler.setLevel(logging.INFO)
+            stream_handler.setFormatter(formatter)
+            self.app.logger.addHandler(stream_handler)
+
+        # Set the overall log level
+        self.app.logger.setLevel(logging.INFO)

rosemary/commands/db_seed.py

@@ -4,7 +4,7 @@
 import click
 from flask.cli import with_appcontext
 
-from app.seeders.BaseSeeder import BaseSeeder
+from core.seeders.BaseSeeder import BaseSeeder
 from rosemary.commands.db_reset import db_reset
 
 

rosemary/commands/linter.py

@@ -6,7 +6,7 @@
 def linter():
 
     # Define the directories to be checked with flake8
-    directories = ["/app/app", "/app/rosemary"]
+    directories = ["/app/app", "/app/rosemary", "/app/core"]
 
     # Run flake8 in each directory
     for directory in directories:

rosemary/templates/blueprint_repositories.py.j2

@@ -1,5 +1,5 @@
 from app.blueprints.{{ blueprint_name }}.models import {{ blueprint_name | pascalcase }}
-from app.repositories.BaseRepository import BaseRepository
+from core.repositories.BaseRepository import BaseRepository
 
 
 class {{ blueprint_name | pascalcase }}Repository(BaseRepository):

rosemary/templates/blueprint_seeders.py.j2

@@ -1,4 +1,4 @@
-from app.seeders.BaseSeeder import BaseSeeder
+from core.seeders.BaseSeeder import BaseSeeder
 
 
 class {{ blueprint_name | pascalcase }}Seeder(BaseSeeder):

rosemary/templates/blueprint_services.py.j2

@@ -1,5 +1,5 @@
 from app.blueprints.{{ blueprint_name }}.repositories import {{ blueprint_name | pascalcase }}Repository
-from app.services.BaseService import BaseService
+from core.services.BaseService import BaseService
 
 
 class {{ blueprint_name | pascalcase }}(BaseService):