feature #24: simplify docker deploy steps

Author: CodingCrush

.gitignore

@@ -1,4 +1,3 @@
-config.py
 .idea/
 mongo_data/
 pg96_data/

Dockerfile

@@ -1,4 +1,4 @@
-# image: weeklyreport:<yymmdd>
+# image: weeklyreport:0.2
 FROM centos:7
 MAINTAINER CodingCrush
 ENV LANG en_US.UTF-8
@@ -16,11 +16,12 @@ WORKDIR /opt/weeklyreport
 
 
 # Start wp-server container
-# docker run \
-#            -d --restart=always \
+
+# docker run -d
+#            --restart=unless-stopped \
 #            --name weeklyreport-server \
-#            --net='host' \
+#            --net=host \
 #            -v /etc/localtime:/etc/localtime:ro \
 #            -v $PWD:/opt/weeklyreport \
-#            weeklyreport:<yymmdd> \
-#            gunicorn wsgi:app --bind <host>:<port> -w <N> --log-file logs/awsgi.log --log-level=DEBUG
+#            weeklyreport:0.2 \
+#            gunicorn wsgi:app --bind 0.0.0.0:8000 -w 2 --log-file logs/awsgi.log --log-level=DEBUG

app/__init__.py

@@ -6,7 +6,6 @@
 from flask_mail import Mail
 from flask_login import LoginManager
 from flask_sqlalchemy import SQLAlchemy
-from config import config
 from .json_encoder import JSONEncoder
 
 
@@ -30,10 +29,9 @@ def get_locale():
     return 'zh_Hans_CN'
 
 
-def create_app(config_name):
+def create_app(config_file):
 
-    app.config.from_object(config[config_name])
-    config[config_name].init_app(app)
+    app.config.from_pyfile(config_file)
 
     mail.init_app(app)
     bootstrap.init_app(app)

app/auth/views.py

@@ -40,15 +40,18 @@ def register():
         (str(dept.id), dept.name) for dept in Department.query.all()]
 
     if form.validate_on_submit():
+        exist_users = bool(User.query.all())
+
         user = User(
             email=form.email.data,
             username=form.username.data,
             password=form.password.data,
             role=Role.query.filter_by(name='EMPLOYEE').first(),
             department=Department.query.get(form.department.data))
 
-        if user.email == current_app.config['FLASK_ADMIN_EMAIL']:
+        if not exist_users:
             user.role = Role.query.filter_by(name='ADMINISTRATOR').first()
+            user.is_super_admin = True
             user.is_ignored = True
 
         db.session.add(user)

app/main/views.py

@@ -10,10 +10,19 @@
 from .. import admin, db
 from ..models import Permission, User, Role, Report, Department
 from ..utils import permission_required, is_allowed_file
+from sqlalchemy.exc import OperationalError
 
 
 @main.route('/', methods=['GET', 'POST'])
 def index():
+    # check if the database is initialized.
+    try:
+        User.query.all()
+    except OperationalError:
+        db.create_all()
+        Role.insert_roles()
+        Department.insert_departments()
+
     if not current_user.is_authenticated:
         return redirect(url_for('auth.login'))
     return redirect(url_for('report.read'))

app/models.py

@@ -1,9 +1,9 @@
 from datetime import datetime
 from werkzeug.security import generate_password_hash, check_password_hash
-from . import db, login_manager
 from flask import current_app
 from flask_login import UserMixin, AnonymousUserMixin
 from itsdangerous import TimedJSONWebSignatureSerializer as Serializer
+from . import db, login_manager
 from .utils import get_week_count, get_last_week
 
 
@@ -74,6 +74,7 @@ class User(db.Model, UserMixin):
     is_ignored = db.Column(db.Boolean, default=False)
     role_id = db.Column(db.Integer, db.ForeignKey('roles.id'))
     department_id = db.Column(db.Integer, db.ForeignKey('departments.id'))
+    is_super_admin = db.Column(db.Boolean, default=False)
 
     @property
     def password(self):
@@ -108,8 +109,7 @@ def reset_password(self, token, new_password):
 
     @property
     def is_admin(self):
-        return self.email == current_app.config['FLASK_ADMIN_EMAIL'] or \
-               self.role.name == 'ADMINISTRATOR'
+        return self.role.name == 'ADMINISTRATOR' or self.is_super_admin
 
     @property
     def is_hr(self):

app/utils.py

@@ -1,6 +1,6 @@
 import datetime
 from functools import wraps
-from flask import abort, current_app
+from flask import abort
 from flask_login import current_user
 
 
@@ -16,23 +16,6 @@ def decorated_function(*args, **kwargs):
     return decorator
 
 
-def email_check(email_address):
-    def decorator(f):
-        @wraps(f)
-        def decorated_function(*args, **kwargs):
-            if not current_user.email == email_address:
-                abort(403)
-            return f(*args, **kwargs)
-        return decorated_function
-    return decorator
-
-
-def admin_required(f):
-    from .models import Permission
-    return email_check(current_app.config['FLASK_ADMIN_EMAIL'])(f) or \
-           permission_required(Permission.ADMINISTER)(f)
-
-
 def get_week_count(at=datetime.datetime.now()):
     return at.isocalendar()[1]
 

config.py

@@ -0,0 +1,40 @@
+import os
+
+
+base_dir = os.path.dirname(os.path.realpath(__file__))
+
+DEBUG = True
+
+SECRET_KEY = os.environ.get('SECRET_KEY') or 'nobody knows the password'
+PER_PAGE = 10
+
+SQLALCHEMY_COMMIT_ON_TEARDOWN = True
+SQLALCHEMY_TRACK_MODIFICATIONS = False
+SQLALCHEMY_RECORD_QUERIES = True
+
+IMAGE_UPLOAD_DIR = 'static/upload/'
+UPLOAD_FOLDER = os.path.join(base_dir, 'app/static/upload/')
+
+MAIL_SERVER = 'smtp.163.com'
+MAIL_PORT = 465
+MAIL_USE_SSL = True
+MAIL_USERNAME = '<EMAIL@ADDRESS>'
+MAIL_PASSWORD = '<EMAIL_PASSWORD>'
+
+WR_MAIL_SUBJECT_PREFIX = '[WeeklyReport]'
+WR_MAIL_SENDER = 'WeeklyReport <[email protected]>'
+
+
+DEPARTMENTS = (
+    '人事行政部',
+    '软件测试部',
+    '产品开发部',
+    '新技术研发部'
+)
+
+DEFAULT_CONTENT = "<p><strong>本周工作内容:</strong></p><ol><li></li></ol>" \
+                  "<p>&nbsp;<strong>下周计划:</strong></p><ol><li></li></ol>"
+
+
+# SQLALCHEMY_DATABASE_URI = 'postgresql://postgres:postgres@localhost/wr_prd'
+SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(base_dir, 'wr_prd.sqlite')

config.py.sample

@@ -1,8 +1,43 @@
-from app import create_app
+from app import create_app, db
+from app.models import Role, Department, Report
+from flask_migrate import Migrate, MigrateCommand
+from flask_script import Manager, Shell
 import os
 
 
-app = create_app(os.getenv('FLASK_CONFIG') or 'default')
+config_file = os.path.join(
+    os.path.dirname(os.path.realpath(__file__)), 'config.py')
+
+app = create_app(config_file)
+
 
 if __name__ == '__main__':
-    app.run()
+    manager = Manager(app)
+    migrate = Migrate(app, db)
+
+
+    def make_shell_context():
+        return dict(app=app, db=db, Role=Role,
+                    Department=Department, Report=Report)
+
+
+    manager.add_command("shell", Shell(make_context=make_shell_context))
+    manager.add_command('db', MigrateCommand)
+
+
+    @manager.command
+    def profile(length=25, profile_dir=None):
+        """Start the application under the code profiler."""
+        from werkzeug.contrib.profiler import ProfilerMiddleware
+        app.wsgi_app = ProfilerMiddleware(
+            app.wsgi_app, restrictions=[length], profile_dir=profile_dir)
+        app.run()
+
+
+    @manager.command
+    def deploy():
+        db.create_all()
+        Role.insert_roles()
+        Department.insert_departments()
+
+    manager.run()