Merge pull request #340 from dotcloud/config

Config

Author: dmp42

docker_registry/app.py

@@ -13,6 +13,8 @@
 from . import toolkit
 from .lib import config
 
+from .lib.core.exceptions import ConfigError
+
 
 VERSION = '0.6.8'
 app = flask.Flask('docker-registry')
@@ -46,7 +48,7 @@ def after_request(response):
 def init():
     # Configure the secret key
     if not cfg.secret_key:
-        raise RuntimeError('Config error: `secret_key\' is not set')
+        raise ConfigError('`secret_key\' is not set')
     app.secret_key = cfg.secret_key
     # Configure the email exceptions
     info = cfg.email_exceptions

docker_registry/lib/config.py

@@ -3,6 +3,9 @@
 import rsa
 import yaml
 
+from .core.exceptions import ConfigError
+from .core.exceptions import FileNotFoundError
+
 
 class Config(object):
 
@@ -56,15 +59,35 @@ def load():
     if not os.path.isabs(config_path):
         config_path = os.path.join(os.path.dirname(__file__), '../../',
                                    'config', config_path)
-    with open(config_path) as f:
+    try:
+        f = open(config_path)
+    except Exception:
+        raise FileNotFoundError(
+            'Heads-up! File is missing: %s' % config_path)
+
+    try:
         data = yaml.load(f)
+    except Exception:
+        raise ConfigError(
+            'Config file (%s) is not valid yaml' % config_path)
+
     config = data.get('common', {})
     flavor = os.environ.get('SETTINGS_FLAVOR', 'dev')
     config.update(data.get(flavor, {}))
     config['flavor'] = flavor
     config = convert_env_vars(config)
     if 'privileged_key' in config:
-        with open(config['privileged_key']) as f:
+        try:
+            f = open(config['privileged_key'])
+        except Exception:
+            raise FileNotFoundError(
+                'Heads-up! File is missing: %s' % config['privileged_key'])
+
+        try:
             config['privileged_key'] = rsa.PublicKey.load_pkcs1(f.read())
+        except Exception:
+            raise ConfigError(
+                'Key at %s is not a valid RSA key' % config['privileged_key'])
+
     _config = Config(config)
     return _config

docker_registry/lib/core/__init__.py

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+"""
+docker-registry.core
+~~~~~~~~~~~~~~~
+
+"""
+
+from __future__ import absolute_import
+
+__all__ = []

docker_registry/lib/core/compat.py

@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+"""
+docker-registry.compat
+~~~~~~~~~~~~~~~~~~~~~~
+
+This file defines a collection of properties to quickly identify what python
+runtime/version we are working with, and handles the import of modules
+that changed, hence hiding import gymnastics from other components.
+
+Use imports from here to ensure portability.
+
+Largely stolen from requests (http://docs.python-requests.org/en/latest/)
+under Apache2 license
+"""
+
+__all__ = []
+
+import logging
+logger = logging.getLogger(__name__)
+
+import sys
+
+# -------
+# Pythons
+# -------
+
+_ver = sys.version_info
+
+is_py2 = (_ver[0] == 2)
+is_py3 = (_ver[0] == 3)
+
+is_py25 = (is_py2 and _ver[1] == 5)
+is_py26 = (is_py2 and _ver[1] == 6)
+# is_py27 = (is_py2 and _ver[1] == 7)
+# is_py30 = (is_py3 and _ver[1] == 0)
+# is_py31 = (is_py3 and _ver[1] == 1)
+# is_py32 = (is_py3 and _ver[1] == 2)
+# is_py33 = (is_py3 and _ver[1] == 3)
+# is_py34 = (is_py3 and _ver[1] == 4)
+
+# ---------
+# Platforms
+# ---------
+
+# _ver = sys.version.lower()
+
+# is_pypy = ('pypy' in _ver)
+# is_jython = ('jython' in _ver)
+# is_ironpython = ('iron' in _ver)
+# is_cpython = not any((is_pypy, is_jython, is_ironpython))
+
+# is_windows = 'win32' in str(sys.platform).lower()
+# is_linux = ('linux' in str(sys.platform).lower())
+# is_osx = ('darwin' in str(sys.platform).lower())
+# is_hpux = ('hpux' in str(sys.platform).lower())   # Complete guess.
+# is_solaris = ('solar' in str(sys.platform).lower())   # Complete guess.
+
+if is_py25 or is_py26:
+    logger.debug("Old python! Using simplejson.")
+    try:
+        import simplejson as json  # noqa
+    except ImportError:
+        json = {}
+else:
+    import json  # noqa
+
+# ---------
+# Specifics
+# ---------
+
+if is_py2:
+    logger.debug("This is python2")
+    from urllib import quote_plus  # noqa
+
+    builtin_str = str
+    bytes = str
+    str = unicode
+    basestring = basestring
+    # numeric_types = (int, long, float)
+
+elif is_py3:
+    logger.debug("This is python3")
+    from urllib.parse import quote_plus  # noqa
+
+    builtin_str = str
+    str = str
+    bytes = bytes
+    basestring = (str, bytes)
+    # numeric_types = (int, float)

docker_registry/lib/core/exceptions.py

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+"""
+docker-registry.exceptions
+~~~~~~~~~~~~~~~~~~~~~
+
+"""
+
+__all__ = [
+    "UnspecifiedError",
+    "UsageError", "NotImplementedError", "FileNotFoundError", "ConfigError"
+    # "WrongArgumentsError",
+    # "ConnectionError", "UnreachableError", "MissingError", "BrokenError"
+]
+
+
+class UnspecifiedError(Exception):
+
+    """Base class for all exceptions in docker-registry.
+    """
+
+    def __init__(self, *args, **kwargs):
+        self.message = kwargs.pop('message', 'No details')
+        super(UnspecifiedError, self).__init__(*args, **kwargs)
+
+
+class UsageError(UnspecifiedError):
+
+    """Exceptions related to use of the library."""
+
+
+class NotImplementedError(UsageError):
+
+    """Requested feature is not supported / not implemented."""
+
+
+class FileNotFoundError(UsageError):
+
+    """Requested (config) file not found."""
+
+
+class ConfigError(UsageError):
+
+    """Something in the configuration file is not ok."""
+
+
+# class WrongArgumentsError(UsageError):
+
+#     """Expected arguments not satisfied."""
+
+
+# class ConnectionError(UnspecifiedError):
+
+#     """Exceptions related to server/client operation."""
+
+
+# class UnreachableError(ConnectionError):
+
+#     """The requested server is not reachable."""
+
+
+# class MissingError(ConnectionError):
+
+#     """The requested ressource is not to be found on the server."""
+
+
+# class BrokenError(ConnectionError):
+
+#     """Something died on our hands, that the server couldn't digest..."""