Continue tackling issues with distributed configuration.

Antoine Goutenoir
1 parent c2a01bd2
Showing 4 changed files with 30 additions and 43 deletions Show diff stats
.env.dist
flaskr/__init__.py
flaskr/settings.py
tests/test_config.py
 # Create a sibling `.env` file from this file, and customize it.
 # `export ` prefixes are ignored and allow bash sourcing of this file.
+# Do not use True and False in here, but 1 and 0, respectively.
+
  
 # Secret for Flask
 export FLASK_SECRET="IAMN0TSECRETCHANGEM3"
+export SECRET_KEY="IAMN0TSECRETCH4NGEM3"
+
  
 # Credentials for the restricted sections
 export ADMIN_USERNAME="admin"
 export ADMIN_PASSWORD="admin"
  
+
+# Database
+#export SQLALCHEMY_DATABASE_URI="sqlite:///../database_prod.db"
+#export SQLALCHEMY_TRACK_MODIFICATIONS=0
+
+
 # Mail sending configuration
 export MAIL_SERVER="localhost"
 export MAIL_PORT=25
@@ -3,8 +3,10 @@ import os
 from markdown import markdown
 from dotenv import load_dotenv, find_dotenv, dotenv_values
 # Load config from .env ; do this before local libs (and flask)
-load_dotenv(find_dotenv(), override=True)  # write into OS environment
-local_env = dotenv_values(find_dotenv())   # load it as well to inject it later
+# 1. Write into OS environment -- if this fails you forgot to create .env file
+load_dotenv(find_dotenv(raise_error_if_not_found=True), override=True)
+# 2. Load it as well to inject it later into app.config
+local_env = dotenv_values(find_dotenv())
  
  
 from flask import Flask, url_for
@@ -44,12 +46,10 @@ def create_app(object_name):
     if type(object_name) == ScriptInfo:
         object_name = 'flaskr.settings.DevelopmentConfig'
  
-    # Load configuration
+    # Load the configuration
     app.config.from_object(object_name)
-    if local_env:
-        app.config.update(**local_env)
-    else:
-        pass  # FIXME
+    app.config.update(**local_env)
+
     app.config['BASIC_AUTH_USERNAME'] = os.getenv('ADMIN_USERNAME')
     app.config['BASIC_AUTH_PASSWORD'] = os.getenv('ADMIN_PASSWORD')
  
 import tempfile
-db_file = tempfile.NamedTemporaryFile()
+
+
+# Configuration should be done in .env file
+# Create it first:
+#     cp .env.dist .env
+# And then edit it with your own sauce.
+# The contents of .env will override values in here.
  
  
 class Config(object):
-    SECRET_KEY = 'TWOOXYGENONECARBON'
-    # FLASK_RUN_EXTRA_FILES="content.yml"
+    FLASK_RUN_EXTRA_FILES="content.yml"
  
  
 class ProductionConfig(Config):
     ENV = 'production'
+
     SQLALCHEMY_DATABASE_URI = 'sqlite:///../database_prod.db'
     SQLALCHEMY_TRACK_MODIFICATIONS = False
  
     CACHE_TYPE = 'simple'
-    SECRET_KEY = 'REPLACE M3'  # todo: use a .env file
  
  
 class DevelopmentConfig(Config):
@@ -28,12 +33,15 @@ class DevelopmentConfig(Config):
     ASSETS_DEBUG = True
  
  
+db_file = tempfile.NamedTemporaryFile()
+
+
 class TestConfig(Config):
     ENV = 'test'
     DEBUG = True
     DEBUG_TB_INTERCEPT_REDIRECTS = False
  
-    SQLALCHEMY_DATABASE_URI = 'sqlite:///' + db_file.name
+    SQLALCHEMY_DATABASE_URI = 'sqlite:///../%s' % db_file.name
     SQLALCHEMY_ECHO = True
     SQLALCHEMY_TRACK_MODIFICATIONS = False
  
@@ -1,31 +0,0 @@
-#! ../env/bin/python
-# -*- coding: utf-8 -*-
-from flaskr import create_app
-
-
-class TestConfig:
-    def test_dev_config(self):
-        """ Tests if the development config loads correctly """
-
-        app = create_app('flaskr.settings.DevConfig')
-
-        assert app.config['DEBUG'] is True
-        assert app.config['SQLALCHEMY_DATABASE_URI'] == 'sqlite:///../database.db'
-        assert app.config['CACHE_TYPE'] == 'null'
-
-    def test_test_config(self):
-        """ Tests if the test config loads correctly """
-
-        app = create_app('flaskr.settings.TestConfig')
-
-        assert app.config['DEBUG'] is True
-        assert app.config['SQLALCHEMY_ECHO'] is True
-        assert app.config['CACHE_TYPE'] == 'null'
-
-    def test_prod_config(self):
-        """ Tests if the production config loads correctly """
-
-        app = create_app('flaskr.settings.ProdConfig')
-
-        assert app.config['SQLALCHEMY_DATABASE_URI'] == 'sqlite:///../database.db'
-        assert app.config['CACHE_TYPE'] == 'simple'