Merge pull request #19 from flavienbwk/develop

flavienbwk · web-flow · commit 40397a1bde62 · 2021-04-06T00:05:21.000+02:00
1.2.0 : Refactored Flask architecture for right Python import
diff --git a/.env.example b/.env.example
@@ -1,4 +1,4 @@
-FLASK_API_VERSION="1.1"
+FLASK_API_VERSION="1.2.0"
 FLASK_SERVER_NAME="My API Project"
 FLASK_SERVER_DESCRIPTION="Dockerized Flask API boilerplate using an LDAP and token-based authentication"
 FLASK_SECRET_KEY="Some secret key"
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Dockerized ReactJS, Flask, LDAP boilerplate
+# Dockerized ReactJS, Flask & LDAP boilerplate
 
 <p align="center">
     <a href="https://travis-ci.com/flavienbwk/reactjs-flask-ldap-boilerplate" target="_blank">
@@ -8,18 +8,16 @@
 </p>
 <p align="center">ReactJS + Flask + Docker (+ K8S)<br/>boilerplate using a token-based LDAP authentication</p>
 
-> :smiley: Suggestions and feedbacks are [highly appreciated](https://github.com/flavienbwk/reactjs-flask-ldap-boilerplate/issues/new)
-
 ## Features
 
 - Docker architecture
 - LDAP authentication
 - Token-based API authentication
-- Automatic [token renewal](./api/app/service/auth_service.py#L45) with [a Flask middleware](./api/app/service/auth_service.py#L32)
+- Automatic [token renewal](./api/app/src/service/auth_service.py#L43) with [a Flask middleware](./api/app/src/service/auth_service.py#L30)
 - Swagger documentation
 - Flask-Migrate
 - Flask-SQLAlchemy (PostgreSQL was chosen)
-- [Logging and logs rotation](./api/app/utils/Logger.py#L11)
+- [Logging and logs rotation](./api/app/src/utils/Logger.py#L12)
 - [Choose](./app/app/src/App.js#L65) between sidebar and navbar (or use both !)
 - Responsive design
 - [Production](./prod.docker-compose.yml) and [development](./docker-compose.yml) builds
@@ -77,7 +75,7 @@ This section will explain how to properly run this project and set-up the LDAP s
 
 4. Run the API
 
-    The database will be automatically set-up thanks to Flask Migrate and any future modification brought to [models](./api/app/model) will be automatically applied when the API is **restarted**.
+    The database will be automatically set-up thanks to Flask Migrate and any future modification brought to [models](./api/app/src/model) will be automatically applied when the API is **restarted**.
 
     You might wait some time before the database get updated after starting the API :
 
@@ -142,7 +140,7 @@ I've used [Scaleway Kapsule](https://www.scaleway.com/en/kubernetes-kapsule) to
 
 1. Building production images (optional)
 
-    Images are tagged `flavienb/reactjs-flask-ldap-boilerplate-{api,web,nginx}:latest` by default. Edit it in `prod.docker-compose.yml` before building.
+    Images are tagged `flavienb/reactjs-flask-ldap-boilerplate-{api,app,nginx}:latest` by default. Edit it in `prod.docker-compose.yml` before building.
 
     :information_source: You might be interested in pushing your images in a private registry (e.g: [Scaleway's Container Registry service](https://www.scaleway.com/en/container-registry/)).
 
@@ -177,3 +175,5 @@ I've used [Scaleway Kapsule](https://www.scaleway.com/en/kubernetes-kapsule) to
 4. Configure the first user
 
     **Create** your first user by accessing phpLDAPAdmin at [endpoint defined](./k8s/ingress.yaml#L35) and [following the LDAP user creation guide](./CREATE_LDAP_USER.md).
+
+> :smiley: Suggestions and feedbacks are [highly appreciated](https://github.com/flavienbwk/reactjs-flask-ldap-boilerplate/issues/new)
diff --git a/api/app/.gitignore b/api/app/.gitignore
@@ -1,7 +1 @@
 __pycache__/
-
-medias/*
-!medias/.gitkeep
-
-certs/*
-!certs/.gitkeep
diff --git a/api/app/main.py b/api/app/main.py
@@ -1,13 +1,9 @@
-import os
-import json
-
 from flask_migrate import Migrate, MigrateCommand
 from flask_script import Manager
 
-from routes import blueprint
-from app import create_app, database
-
-from utils.ApiResponse import ApiResponse
+from src.routes import blueprint
+from src.app import create_app, database
+from src.utils.ApiResponse import ApiResponse
 
 # Initialization
 
diff --git a/api/app/src/__init__.py b/api/app/src/__init__.py
diff --git a/api/app/src/app.py b/api/app/src/app.py
@@ -1,14 +1,17 @@
 import os
-
+from time import sleep
 from flask import Flask
 
-from utils.Database import Database
-from utils.ApiResponse import ApiResponse
+from .utils.Logger import Logger
+from .utils.Database import Database
+from .utils.ApiResponse import ApiResponse
+
+from .config import config_by_name
 
-from config import config_by_name
 
 FLASK_LEVEL = os.environ.get("FLASK_LEVEL", "dev")
 
+logger = Logger()
 database = Database()
 
 def page_not_found(e):
@@ -22,5 +25,11 @@ def create_app():
     app.register_error_handler(404, page_not_found)
     app.config.from_object(config_by_name[FLASK_LEVEL])
     os.environ["FLASK_ENV"] = config_by_name[FLASK_LEVEL].FLASK_ENV
+
+    # Waiting for database to be available
+    while database.isDatabaseAvailable(app) is False:
+        logger.warning("Database unreachable. Waiting for 3 seconds to be up...")
+        sleep(3.0)
+    logger.info("Database is up and running ✓")
     database.initDatabase(app)
     return app
diff --git a/api/app/src/config.py b/api/app/src/config.py
diff --git a/api/app/src/controller/__init__.py b/api/app/src/controller/__init__.py
diff --git a/api/app/src/controller/auth_controller.py b/api/app/src/controller/auth_controller.py
@@ -1,19 +1,9 @@
-import time
-import datetime
-
 from flask import request, escape
 from flask_restplus import Resource, Namespace, fields
 
-import sys
-sys.path.append("..")
-
-from utils.ApiResponse import ApiResponse
-from utils.Logger import Logger
-
-from model.User import User
-from model.Token import Token
+from ..utils.Logger import Logger
 
-from service.auth_service import AuthService, requires_authentication
+from ..service.auth_service import AuthService, requires_authentication
 
 logger = Logger()
 
diff --git a/api/app/src/controller/home_controller.py b/api/app/src/controller/home_controller.py
@@ -1,10 +1,6 @@
-from flask import request, escape
-from flask_restplus import Resource, Namespace, fields
+from flask_restplus import Resource, Namespace
 
-import sys
-sys.path.append("..")
-
-from utils.ApiResponse import ApiResponse
+from ..utils.ApiResponse import ApiResponse
 
 api = Namespace('Home', description='Basic health operations')
 
diff --git a/api/app/src/controller/user_controller.py b/api/app/src/controller/user_controller.py
@@ -1,14 +1,9 @@
 from flask import request, escape
 from flask_restplus import Resource, Namespace, fields
 
-import sys
-sys.path.append("..")
+from ..service.user_service import UserService
+from ..service.auth_service import requires_authentication
 
-from service.token_service import TokenService
-from service.user_service import UserService
-from service.auth_service import requires_authentication
-
-from utils.ApiResponse import ApiResponse
 
 api = Namespace('User', description='User-related operations')
 
diff --git a/api/app/src/model/Token.py b/api/app/src/model/Token.py
@@ -1,13 +1,7 @@
-import datetime
+from ..model.User import User
 
-from sqlalchemy import func
+from ..app import database
 
-import sys
-sys.path.append("..")
-
-from model.User import User
-
-from app import database
 
 db = database.getDatabase()
 
diff --git a/api/app/src/model/User.py b/api/app/src/model/User.py
@@ -1,11 +1,7 @@
-import datetime
-
 from sqlalchemy import func
 
-import sys
-sys.path.append("..")
+from ..app import database
 
-from app import database
 
 db = database.getDatabase()
 
diff --git a/api/app/src/model/__init__.py b/api/app/src/model/__init__.py
diff --git a/api/app/src/routes.py b/api/app/src/routes.py
@@ -3,16 +3,17 @@
 from flask_restplus import Api
 from flask import Blueprint
 
-from controller.home_controller import api as home_ns
-from controller.auth_controller import api as auth_ns
-from controller.user_controller import api as user_ns
+from .controller.home_controller import api as home_ns
+from .controller.auth_controller import api as auth_ns
+from .controller.user_controller import api as user_ns
+
 
 blueprint = Blueprint('api', __name__)
 api = Api(
     blueprint, 
     title=os.environ.get("FLASK_SERVER_NAME"), 
     description=os.environ.get("FLASK_SERVER_DESCRIPTION"),
-    version='1.0'
+    version=os.environ.get("FLASK_API_VERSION")
 )
 
 # Routes
diff --git a/api/app/src/service/__init__.py b/api/app/src/service/__init__.py
diff --git a/api/app/src/service/auth_service.py b/api/app/src/service/auth_service.py
@@ -6,18 +6,16 @@
 from flask import request, escape
 from functools import wraps
 
-import sys
-sys.path.append("..")
+from ..service.token_service import TokenService
+from ..service.user_service import UserService
 
-from service.token_service import TokenService
-from service.user_service import UserService
+from ..utils.Logger import Logger
+from ..utils.ApiResponse import ApiResponse
+from ..utils.hash import sha256, hash_id
 
-from utils.Logger import Logger
-from utils.ApiResponse import ApiResponse
-from utils.hash import sha256, hash_id
+from ..model.User import User
+from ..model.Token import Token
 
-from model.User import User
-from model.Token import Token
 
 LDAP_SCHEME = os.environ.get("LDAP_SCHEME")
 LDAP_HOST = os.environ.get("LDAP_HOST")
diff --git a/api/app/src/service/token_service.py b/api/app/src/service/token_service.py
@@ -1,21 +1,18 @@
-import os
 import time
 from uuid import uuid4
 from random import randint
 
 from flask import request
 
-import sys
-sys.path.append("..")
+from ..app import database
 
-from app import database
+from ..utils.ApiResponse import ApiResponse
+from ..utils.Logger import Logger
+from ..utils.hash import sha256, hash_id
 
-from utils.ApiResponse import ApiResponse
-from utils.Logger import Logger
-from utils.hash import sha256, hash_id
+from ..model.User import User
+from ..model.Token import Token
 
-from model.User import User
-from model.Token import Token
 
 TOKEN_EXPIRATION_TIME = 60 * 60 * 6
 
diff --git a/api/app/src/service/user_service.py b/api/app/src/service/user_service.py
@@ -4,16 +4,14 @@
 import datetime
 from validate_email import validate_email
 
-import sys
-sys.path.append("..")
+from ..app import database
 
-from app import database
+from ..utils.Logger import Logger
+from ..utils.ApiResponse import ApiResponse
 
-from utils.Logger import Logger
-from utils.ApiResponse import ApiResponse
+from ..model.User import User
+from ..model.Token import Token
 
-from model.User import User
-from model.Token import Token
 
 LDAP_SCHEME = os.environ.get("LDAP_SCHEME")
 LDAP_HOST = os.environ.get("LDAP_HOST")
diff --git a/api/app/src/utils/ApiResponse.py b/api/app/src/utils/ApiResponse.py
diff --git a/api/app/src/utils/Database.py b/api/app/src/utils/Database.py
@@ -1,10 +1,9 @@
 
+import psycopg2
 from flask_sqlalchemy import SQLAlchemy
 
-import sys
-sys.path.append("..")
+from ..utils.Logger import Logger
 
-from utils.Logger import Logger
 
 logger = Logger()
 
@@ -16,6 +15,20 @@ def __init__(self) -> None:
     def getDatabase(self):
         return self.database
 
+    def isDatabaseAvailable(self, app):
+        try:
+            conn = psycopg2.connect(
+                "host='{}' dbname='{}' user='{}' password='{}'".format(
+                app.config["POSTGRES_HOST"],
+                app.config["POSTGRES_DB"],
+                app.config["POSTGRES_USER"],
+                app.config["POSTGRES_PASSWORD"]
+            ))
+            conn.close()
+            return True
+        except psycopg2.OperationalError:
+            return False
+
     def initDatabase(self, app):
         self.database.init_app(app)
 
diff --git a/api/app/src/utils/Logger.py b/api/app/src/utils/Logger.py
@@ -8,6 +8,7 @@
 class Logger():
 
     def __init__(self) -> bool:
+        logging.getLogger().addHandler(logging.StreamHandler())
         handler = logging.handlers.WatchedFileHandler("/logs/api.{}.log".format(PROJECT_NAME))
         formatter = logging.Formatter(logging.BASIC_FORMAT)
         handler.setFormatter(formatter)
@@ -29,4 +30,4 @@ def error(self, message):
         self.root.error(message)
 
     def critical(self, message):
-        self.root.critical(message)
+        self.root.critical(message)
diff --git a/api/app/src/utils/__init__.py b/api/app/src/utils/__init__.py
diff --git a/api/app/src/utils/hash.py b/api/app/src/utils/hash.py
@@ -2,6 +2,7 @@
 import hashlib
 from hashids import Hashids
 
+
 FLASK_SECRET_KEY = os.environ.get("FLASK_SECRET_KEY")
 
 def hash_id(seed: int):
diff --git a/api/entrypoint.sh b/api/entrypoint.sh
@@ -1,9 +1,9 @@
 #!/bin/sh
 # These commands are here because they must be run at runtime
 
-python /app/manager.py db init
+cd /app
 
-python /app/manager.py db migrate --message 'initial database migration'
-python /app/manager.py db upgrade
-
-python /app/manager.py run
+python -m main db init
+python -m main db migrate --message 'Initial database migration'
+python -m main db upgrade
+python -m main run
diff --git a/api/prod.entrypoint.sh b/api/prod.entrypoint.sh
@@ -1,9 +1,10 @@
 #!/bin/sh
 # These commands are here because they must be run at runtime
 
-python /app/manager.py db init
+cd /app
 
-python /app/manager.py db migrate --message 'initial database migration'
-python /app/manager.py db upgrade
+python -m main db init
+python -m main db migrate --message 'Initial database migration'
+python -m main db upgrade
 
-gunicorn manager:app -b 0.0.0.0:5000
+gunicorn main:app -b 0.0.0.0:5000
diff --git a/api/requirements.txt b/api/requirements.txt
@@ -1,4 +1,4 @@
-psycopg2-binary==2.8.4
+psycopg2==2.8.4
 Werkzeug==0.16.1
 flask-restplus==0.13.0
 Flask-SQLAlchemy==2.4.1
diff --git a/app/app/package-lock.json b/app/app/package-lock.json
diff --git a/app/app/package.json b/app/app/package.json

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-FLASK_API_VERSION="1.1"`
	`1`	`+FLASK_API_VERSION="1.2.0"`
`2`	`2`	`FLASK_SERVER_NAME="My API Project"`
`3`	`3`	`FLASK_SERVER_DESCRIPTION="Dockerized Flask API boilerplate using an LDAP and token-based authentication"`
`4`	`4`	`FLASK_SECRET_KEY="Some secret key"`