Merge pull request #64 from getsentry/taskconfig

Split TaskConfig off of App

Author: mattrobenolt

Procfile

@@ -1,2 +1,3 @@
-web: bin/upgrade && PYTHONUNBUFFERED=1 bin/web --no-debug --addr=:${PORT}
+web: bin/upgrade && PYTHONUNBUFFERED=1 bin/web --addr=:${PORT} --debug
 worker: bin/upgrade && PYTHONUNBUFFERED=1 bin/worker --no-debug -n 4 -l ${LOG_LEVEL}
+static: node_modules/.bin/webpack -d --watch

freight/api/app_details.py

@@ -9,7 +9,7 @@
 from freight.checks.utils import parse_checks_config
 from freight.config import db, queue
 from freight.environments.utils import parse_environments_config
-from freight.models import App, Repository
+from freight.models import App, Repository, TaskConfig, TaskConfigType
 from freight.notifiers.utils import parse_notifiers_config
 from freight.providers.utils import parse_provider_config
 
@@ -20,12 +20,19 @@ def get(self, app):
         if app is None:
             return self.error('Invalid app', name='invalid_resource', status_code=404)
 
+        deploy_config = TaskConfig.query.filter(
+            TaskConfig.app_id == app.id,
+            TaskConfig.type == TaskConfigType.deploy,
+        ).first()
+        if deploy_config is None:
+            return self.error('Missing deploy config', name='missing_conf', status_code=404)
+
         context = serialize(app)
         context.update({
-            'provider': app.provider,
-            'provider_config': app.provider_config,
-            'notifiers': app.notifiers,
-            'checks': app.checks,
+            'provider': deploy_config.provider,
+            'provider_config': deploy_config.provider_config,
+            'notifiers': deploy_config.notifiers,
+            'checks': deploy_config.checks,
         })
 
         return self.respond(context)
@@ -49,27 +56,38 @@ def put(self, app):
         if app is None:
             return self.error('Invalid app', name='invalid_resource', status_code=404)
 
+        # For backwards compatibility, we assume that we need a deploy TaskConfig
+        # on the app at all times.
+        deploy_config = TaskConfig.query.filter(
+            TaskConfig.app_id == app.id,
+            TaskConfig.type == TaskConfigType.deploy,
+        ).first()
+        if deploy_config is None:
+            deploy_config = TaskConfig(app_id=app.id, type=TaskConfigType.deploy)
+            db.session.add(deploy_config)
+            db.session.flush()
+
         if args.provider or args.provider_config:
             if args.provider is not None:
                 provider = args.provider
             else:
-                provider = app.provider
+                provider = deploy_config.provider
 
             if args.provider_config is not None:
                 provider_config = args.provider_config
             else:
-                provider_config = app.provider_config
+                provider_config = deploy_config.provider_config
 
-            app.provider = provider
-            app.data['provider_config'] = parse_provider_config(
+            deploy_config.provider = provider
+            deploy_config.data['provider_config'] = parse_provider_config(
                 provider, provider_config
             )
 
         if args.notifiers is not None:
-            app.data['notifiers'] = parse_notifiers_config(args.notifiers)
+            deploy_config.data['notifiers'] = parse_notifiers_config(args.notifiers)
 
         if args.checks is not None:
-            app.data['checks'] = parse_checks_config(args.checks)
+            deploy_config.data['checks'] = parse_checks_config(args.checks)
 
         if args.environments is not None:
             app.data['environments'] = parse_environments_config(args.environments)
@@ -89,14 +107,15 @@ def put(self, app):
             app.repository_id = repo.id
 
         db.session.add(app)
+        db.session.add(deploy_config)
         db.session.commit()
 
         context = serialize(app)
         context.update({
-            'provider': app.provider,
-            'provider_config': app.provider_config,
-            'notifiers': app.notifiers,
-            'checks': app.checks,
+            'provider': deploy_config.provider,
+            'provider_config': deploy_config.provider_config,
+            'notifiers': deploy_config.notifiers,
+            'checks': deploy_config.checks,
         })
 
         return self.respond(context)

freight/api/app_index.py

@@ -9,7 +9,7 @@
 from freight.checks.utils import parse_checks_config
 from freight.config import db
 from freight.environments.utils import parse_environments_config
-from freight.models import App, Repository
+from freight.models import App, Repository, TaskConfig, TaskConfigType
 from freight.notifiers.utils import parse_notifiers_config
 from freight.providers.utils import parse_provider_config
 
@@ -68,15 +68,26 @@ def post(self):
         app = App(
             name=args.name,
             repository_id=repo.id,
+            data={
+                'environments': environments_config,
+            },
+        )
+        db.session.add(app)
+        db.session.flush()
+
+        # For backwards compatibility, we assume that we need a deploy TaskConfig
+        # on the app at all times.
+        deploy_config = TaskConfig(
+            app_id=app.id,
+            type=TaskConfigType.deploy,
             provider=args.provider,
             data={
                 'provider_config': provider_config,
                 'notifiers': notifiers_config,
                 'checks': checks_config,
-                'environments': environments_config,
             },
         )
-        db.session.add(app)
+        db.session.add(deploy_config)
         db.session.commit()
 
         return self.respond(serialize(app), status_code=201)

freight/api/deploy_index.py

@@ -10,7 +10,8 @@
 from freight.config import db, redis
 from freight.exceptions import CheckError, CheckPending
 from freight.models import (
-    App, Repository, Task, Deploy, DeploySequence, TaskStatus, User
+    App, Repository, Task, Deploy, DeploySequence, TaskStatus, User,
+    TaskConfig, TaskConfigType,
 )
 from freight.notifiers import NotifierEvent
 from freight.notifiers.utils import send_task_notifications
@@ -114,6 +115,13 @@ def post(self):
         if not app:
             return self.error('Invalid app', name='invalid_resource', status_code=404)
 
+        deploy_config = TaskConfig.query.filter(
+            TaskConfig.app_id == app.id,
+            TaskConfig.type == TaskConfigType.deploy,
+        ).first()
+        if not deploy_config:
+            return self.error('Missing deploy config', name='missing_conf', status_code=404)
+
         params = None
 
         repo = Repository.query.get(app.repository_id)
@@ -149,7 +157,7 @@ def post(self):
             params = args.params
 
         if not args.force:
-            for check_config in app.checks:
+            for check_config in deploy_config.checks:
                 check = checks.get(check_config['type'])
                 try:
                     check.check(app, sha, check_config['config'])
@@ -170,12 +178,12 @@ def post(self):
                 params=params,
                 status=TaskStatus.pending,
                 user_id=user.id,
-                provider=app.provider,
+                provider=deploy_config.provider,
                 data={
                     'force': args.force,
-                    'provider_config': app.provider_config,
-                    'notifiers': app.notifiers,
-                    'checks': app.checks,
+                    'provider_config': deploy_config.provider_config,
+                    'notifiers': deploy_config.notifiers,
+                    'checks': deploy_config.checks,
                 },
             )
             db.session.add(task)

freight/models/app.py

@@ -61,22 +61,18 @@ class App(db.Model):
     data = Column(JSONEncodedDict)
     date_created = Column(DateTime, default=datetime.utcnow, nullable=False)
 
-    @property
-    def checks(self):
-        return self.data.get('checks', [])
-
-    @property
-    def notifiers(self):
-        return self.data.get('notifiers', [])
-
-    @property
-    def provider_config(self):
-        return self.data.get('provider_config', {})
-
     @property
     def environments(self):
         return self.data.get('environments', {})
 
+    @property
+    def deploy_config(self):
+        from freight.models import TaskConfig, TaskConfigType
+        return TaskConfig.query.filter(
+            TaskConfig.app_id == self.id,
+            TaskConfig.type == TaskConfigType.deploy,
+        ).first()
+
     def get_default_ref(self, env):
         data = self.environments.get(env)
         if not data:

freight/models/taskconfig.py

@@ -0,0 +1,63 @@
+from __future__ import absolute_import
+
+from sqlalchemy import Column, ForeignKey, Integer, String
+from sqlalchemy.schema import Index, UniqueConstraint
+
+from freight.config import db
+from freight.db.types.json import JSONEncodedDict
+
+
+class TaskConfigType(object):
+    deploy = 0
+
+    @classmethod
+    def get_label(cls, status):
+        return TYPE_LABELS[status]
+
+    @classmethod
+    def label_to_id(cls, label):
+        return TYPE_LABELS_REV[label]
+
+
+TYPE_LABELS = {
+    TaskConfigType.deploy: 'deploy',
+}
+TYPE_LABELS_REV = {
+    v: k for k, v in TYPE_LABELS.items()
+}
+
+
+class TaskConfig(db.Model):
+    __tablename__ = 'taskconfig'
+    __table_args__ = (
+        Index('idx_taskconfig_app_id', 'app_id'),
+        Index('idx_taskconfig_type', 'type'),
+        UniqueConstraint('app_id', 'type', name='unq_app_id_type'),
+    )
+
+    id = Column(Integer, primary_key=True)
+    app_id = Column(Integer, ForeignKey('app.id', ondelete="CASCADE"),
+                    nullable=False)
+    provider = Column(String(64), nullable=False)
+    type = Column(Integer)
+    data = Column(JSONEncodedDict)
+
+    @property
+    def checks(self):
+        return self.data.get('checks', [])
+
+    @property
+    def notifiers(self):
+        return self.data.get('notifiers', [])
+
+    @property
+    def provider_config(self):
+        return self.data.get('provider_config', {})
+
+    @property
+    def environments(self):
+        return self.data.get('environments', {})
+
+    @property
+    def type_label(self):
+        return TYPE_LABELS[self.type]

freight/testutils/fixtures.py

@@ -6,14 +6,15 @@
 
 from freight.config import db
 from freight.constants import PROJECT_ROOT
-from freight.models import App, Repository, Task, DeploySequence, Deploy, TaskStatus, User
+from freight.models import (
+    App, Repository, Task, DeploySequence, Deploy, TaskStatus, User,
+    TaskConfig, TaskConfigType,
+)
 
 
 class Fixtures(object):
-    def create_app(self, repository, **kwargs):
-        if not kwargs.get('name'):
-            kwargs['name'] = uuid4().hex
-
+    def create_taskconfig(self, app, **kwargs):
+        kwargs.setdefault('type', TaskConfigType.deploy)
         kwargs.setdefault('provider', 'shell')
         kwargs.setdefault('data', {
             'provider_config': {
@@ -25,6 +26,19 @@ def create_app(self, repository, **kwargs):
                     'config': {'webhook_url': 'https://example.com'},
                 },
             ],
+        })
+
+        task_config = TaskConfig(app_id=app.id, **kwargs)
+        db.session.add(task_config)
+        db.session.commit()
+
+        return task_config
+
+    def create_app(self, repository, **kwargs):
+        if not kwargs.get('name'):
+            kwargs['name'] = uuid4().hex
+
+        kwargs.setdefault('data', {
             'environments': {
                 'production': {
                     'default_ref': 'master',
@@ -46,7 +60,7 @@ def create_task(self, app, user, **kwargs):
         kwargs.setdefault('ref', 'master')
         kwargs.setdefault('sha', 'HEAD')
         kwargs.setdefault('status', TaskStatus.in_progress)
-        kwargs.setdefault('data', {'provider_config': app.provider_config})
+        kwargs.setdefault('data', {'provider_config': app.deploy_config.provider_config})
         kwargs.setdefault('params', {'task': 'deploy'})
 
         task = Task(

migrations/versions/205fd513c96_added_taskconfig.py

@@ -0,0 +1,58 @@
+"""
+Added TaskConfig
+
+Revision ID: 205fd513c96
+Revises: 106230ad9e69
+Create Date: 2016-03-07 13:27:04.392376
+"""
+
+# revision identifiers, used by Alembic.
+revision = '205fd513c96'
+down_revision = '106230ad9e69'
+
+from alembic import op
+from sqlalchemy.sql import table
+import sqlalchemy as sa
+import freight
+
+
+def upgrade():
+    taskconfig_table = op.create_table(
+        'taskconfig',
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('app_id', sa.Integer(), nullable=False),
+        sa.Column('provider', sa.String(length=64), nullable=False),
+        sa.Column('type', sa.Integer(), nullable=True),
+        sa.Column('data', freight.db.types.json.JSONEncodedDict(), nullable=True),
+        sa.ForeignKeyConstraint(['app_id'], ['app.id'], ondelete='CASCADE'),
+        sa.PrimaryKeyConstraint('id'),
+        sa.UniqueConstraint('app_id', 'type', name='unq_app_id_type')
+    )
+    op.create_index('idx_taskconfig_app_id', 'taskconfig', ['app_id'], unique=False)
+    op.create_index('idx_taskconfig_type', 'taskconfig', ['type'], unique=False)
+
+    connection = op.get_bind()
+
+    app_table = table(
+        'app',
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('provider', sa.String(length=54), nullable=False),
+        sa.Column('data', freight.db.types.json.JSONEncodedDict(), nullable=True)
+    )
+
+    # Copy over the existing configs out of the App table and into TaskConfigs
+    for app in connection.execute(app_table.select()):
+        print("Migrating App id=%s" % app.id)
+
+        op.bulk_insert(
+            taskconfig_table,
+            [
+                {'app_id': app.id, 'type': 0, 'provider': app.provider, 'data': app.data},
+            ],
+        )
+
+
+def downgrade():
+    op.drop_index('idx_taskconfig_type', table_name='taskconfig')
+    op.drop_index('idx_taskconfig_app_id', table_name='taskconfig')
+    op.drop_table('taskconfig')