Working on making app storage backends more pluggable

Author: robottaway

tests/unuo_tests.py

@@ -1,6 +1,8 @@
 import unittest
 import json
 import logging
+import tempfile
+import shutil
 
 from unuo.factories import default_factory
 
@@ -12,10 +14,25 @@
 class UnuoTests(unittest.TestCase):
 
     def setUp(self):
+        from unuo.config import config
+        self.buildfolder = tempfile.mkdtemp()
+        logger.info('Created temp build dir %s', self.buildfolder)
+        self.logfolder = tempfile.mkdtemp()
+        logger.info('Created temp log dir %s', self.logfolder)
+
+        config.builds_folder = self.buildfolder
+        config.logs_folder = self.logfolder
+
         app = default_factory()
         self.app = app.test_client()
 
+    def tearDown(self):
+        logger.info('Removing temp build dir %s', self.buildfolder)
+        shutil.rmtree(self.buildfolder)
+        logger.info('Removing temp log dir %s', self.logfolder)
+        shutil.rmtree(self.logfolder)
+
     def test_profiles(self):
         rv = self.app.get('/profile')
         j = json.loads(rv.data)
-        self.assertEquals({u'builds': [u'mynewbuild']}, j)
+        self.assertEquals({u'builds': []}, j)

unuo/blueprints/docker.py

@@ -3,20 +3,28 @@
 Contains API methods for kicking off a build profile, adding a build profile,
 getting a listing of build profiles.
 """
+import logging
+
 from flask import Blueprint
 from flask import jsonify, request
 from unuo.errors import ApiError
 
-from unuo.filebackend import post_build, run_build, get_build_profile, \
-    get_all_profiles
-
 docker_bp = Blueprint('docker', __name__)
 
+logger = logging.getLogger('test')
+
+backend = None
+
+
+def inject_backend(_backend):
+    global backend
+    logger.info('Injecting backend %s', _backend)
+    backend = _backend
+
+# @docker_bp.errorhandler(500)
+# def error_ise(error):
+#     return '{"status_code":500,"description":"oh noes!"}', 500
 
-#@docker_bp.errorhandler(500)
-#def error_ise(error):
-#    return '{"status_code":500,"description":"oh noes!"}', 500
-#
 
 @docker_bp.errorhandler(404)
 @docker_bp.errorhandler(400)
@@ -30,19 +38,19 @@ def error_json(error):
 @docker_bp.route('/build/<name>', methods=['POST'])
 def build(name):
     """Run given build."""
-    return run_build(name)
+    return backend.run_build(name)
 
 
 @docker_bp.route('/profile', methods=['GET'])
 def list_build_profiles():
     """Responsible for listing known builds."""
-    builds = get_all_profiles()
+    builds = backend.get_all_profiles()
     return jsonify({"builds": builds})
 
 
 @docker_bp.route('/profile/<name>', methods=['GET', 'POST'])
 def build_container(name):
     """Responsible for creating/updating builds and launching them."""
     if request.method == 'POST':
-        return post_build(name, request.json)
-    return jsonify(**get_build_profile(name))
+        return backend.post_build(name, request.json)
+    return jsonify(**backend.get_build_profile(name))

unuo/factories.py

@@ -1,13 +1,24 @@
 """Flask factories for running the app and testing it.
 """
+import logging
 
 from flask import Flask
 
 from unuo.blueprints.docker import docker_bp
+from unuo.filebackend import FileBackend
+from unuo.config import config
 
+logger = logging.getLogger(__name__)
 
-def default_factory(config=None):
+
+def default_factory(conf_env=None, conf_dict=None):
+    from unuo.blueprints.docker import inject_backend
     app = Flask(__name__)
     app.config.from_object('unuo.config.DefaultConfig')
+    if conf_dict:
+        app.config.update(**conf_dict)
+    if conf_env:
+        app.config.from_envvar(conf_env)
+    inject_backend(FileBackend(config.builds_folder))
     app.register_blueprint(docker_bp)
     return app

unuo/filebackend.py

@@ -12,52 +12,57 @@
 from unuo.models import build_schema, Build
 from unuo.errors import ApiError
 from unuo.docker import do_build
-from unuo.config import config
-
-
-def post_build(name, json):
-    """Create or update a build."""
-    try:
-        build_schema(json)
-    except MultipleInvalid as e:
-        raise ApiError('; '.join([str(i) for i in e.errors]))
-    build_file = os.path.join(config.builds_folder, name)
-    exists = os.path.exists(build_file)
-    with open(build_file, 'w') as fd:
-        json.dump(json, fd)
-    if exists:
-        return "build updated!"
-    return "build created!"
-
-
-def get_build_profile(name):
-    """Return build profile with given name."""
-    build_file = os.path.join(config.builds_folder, name)
-    if not os.path.exists(build_file):
-        raise ApiError("Build profile '%s' not found" % name, code=404)
-    with open(build_file, 'r') as fd:
-        build_json = json.load(fd)
-    return build_json
-
-
-def run_build(name):
-    """Kick off a build."""
-    build_json = get_build_profile(name)
-    build = Build(name, **build_json)
-
-    def generate():
-        for line in do_build(build):
-            yield line
-    return Response(generate(), mimetype='text/plain')
-
-
-def get_all_profiles():
-    builds = []
-    print config.builds_folder
-    for phile in listdir(config.builds_folder):
-        print phile
-        fp = os.path.join(config.builds_folder, phile)
-        if not os.path.isfile(fp):
-            continue
-        builds.append(phile)
-    return builds
+
+
+class FileBackend(object):
+    """A file based backend for Unuo objects"""
+
+    def __init__(self, builds_folder):
+        self.builds_folder = builds_folder
+
+    def post_build(self, name, json):
+        """Create or update a build."""
+        try:
+            build_schema(json)
+        except MultipleInvalid as e:
+            raise ApiError('; '.join([str(i) for i in e.errors]))
+        build_file = os.path.join(self.builds_folder, name)
+        exists = os.path.exists(build_file)
+        with open(build_file, 'w') as fd:
+            json.dump(json, fd)
+        if exists:
+            return "build updated!"
+        return "build created!"
+
+    def get_build_profile(self, name):
+        """Return build profile with given name."""
+        build_file = os.path.join(self.builds_folder, name)
+        if not os.path.exists(build_file):
+            raise ApiError("Build profile '%s' not found" % name, code=404)
+        with open(build_file, 'r') as fd:
+            build_json = json.load(fd)
+        return build_json
+
+    def run_build(self, name):
+        """Kick off a build.
+
+        Returns a Flask Response generator which allows for streaming console
+        output back to browser/agent.
+        """
+        build_json = self.get_build_profile(name)
+        build = Build(name, **build_json)
+
+        def generate():
+            for line in do_build(build):
+                yield line
+        return Response(generate(), mimetype='text/plain')
+
+    def get_all_profiles(self):
+        """Return back a list of the builds."""
+        builds = []
+        for phile in listdir(self.builds_folder):
+            fp = os.path.join(self.builds_folder, phile)
+            if not os.path.isfile(fp):
+                continue
+            builds.append(phile)
+        return builds