refactor(domains): cleanup domain publishing logic and URLs

Author: Gabriel Monroy

controller/api/models.py

@@ -567,13 +567,6 @@ def __str__(self):
 # define update/delete callbacks for synchronizing
 # models with the configuration management backend
 
-def _publish_domains(**kwargs):
-    app = kwargs['app']
-    domains = kwargs['domains']
-    _etcd_client.write(
-        '/deis/domains/{}'.format(app),
-        ' '.join(str(i) for i in domains))
-
 def _log_build_created(**kwargs):
     if kwargs.get('created'):
         build = kwargs['instance']
@@ -608,6 +601,16 @@ def _etcd_purge_user(**kwargs):
     _etcd_client.delete('/deis/builder/users/{}'.format(username), dir=True, recursive=True)
 
 
+def _etcd_publish_domains(**kwargs):
+    app = kwargs['instance'].app
+    app_domains = app.domain_set.all()
+    if app_domains:
+        _etcd_client.write('/deis/domains/{}'.format(app),
+                           ' '.join(str(d.domain) for d in app_domains))
+    else:
+        _etcd_client.delete('/deis/domains/{}'.format(app))
+
+
 # Log significant app-related events
 post_save.connect(_log_build_created, sender=Build, dispatch_uid='api.models')
 post_save.connect(_log_release_created, sender=Release, dispatch_uid='api.models')
@@ -632,3 +635,5 @@ def _save_transition(**kwargs):
     post_save.connect(_etcd_publish_key, sender=Key, dispatch_uid='api.models')
     post_delete.connect(_etcd_purge_key, sender=Key, dispatch_uid='api.models')
     post_delete.connect(_etcd_purge_user, sender=User, dispatch_uid='api.models')
+    post_save.connect(_etcd_publish_domains, sender=Domain, dispatch_uid='api.models')
+    post_delete.connect(_etcd_publish_domains, sender=Domain, dispatch_uid='api.models')

controller/api/tests/test_domain.py

@@ -44,16 +44,14 @@ def test_manage_domain(self):
         body = {'domain': 'test-domain.example.com'}
         response = self.client.post(url, json.dumps(body), content_type='application/json')
         self.assertEqual(response.status_code, 201)
-
         url = '/api/apps/{app_id}/domains'.format(app_id=self.app_id)
         response = self.client.get(url, content_type='application/json')
         result = response.data['results'][0]
         self.assertEqual('test-domain.example.com', result['domain'])
-
-        url = '/api/domains/{hostname}'.format(hostname='test-domain.example.com')
+        url = '/api/apps/{app_id}/domains/{hostname}'.format(hostname='test-domain.example.com',
+                                                             app_id=self.app_id)
         response = self.client.delete(url, content_type='application/json')
         self.assertEqual(response.status_code, 204)
-
         url = '/api/apps/{app_id}/domains'.format(app_id=self.app_id)
         response = self.client.get(url, content_type='application/json')
         self.assertEqual(0, response.data['count'])
@@ -63,7 +61,6 @@ def test_manage_domain_invalid_app(self):
         body = {'domain': 'test-domain.example.com'}
         response = self.client.post(url, json.dumps(body), content_type='application/json')
         self.assertEqual(response.status_code, 404)
-
         url = '/api/apps/{app_id}/domains'.format(app_id='this-app-does-not-exist')
         response = self.client.get(url, content_type='application/json')
         self.assertEqual(response.status_code, 404)
@@ -82,12 +79,10 @@ def test_manage_domain_invalid_domain(self):
         body = {'domain': 'this_is_an.invalid.domain'}
         response = self.client.post(url, json.dumps(body), content_type='application/json')
         self.assertEqual(response.status_code, 400)
-
         url = '/api/apps/{app_id}/domains'.format(app_id=self.app_id)
         body = {'domain': 'this-is-an.invalid.a'}
         response = self.client.post(url, json.dumps(body), content_type='application/json')
         self.assertEqual(response.status_code, 400)
-
         url = '/api/apps/{app_id}/domains'.format(app_id=self.app_id)
         body = {'domain': 'domain'}
         response = self.client.post(url, json.dumps(body), content_type='application/json')

controller/api/urls.py

@@ -94,6 +94,23 @@
   List all :class:`~api.models.Container`\s.
 
 
+Application Domains
+-------------------
+
+
+.. http:delete:: /api/apps/(string:id)/domains/(string:hostname)
+
+  Destroy a :class:`~api.models.Domain` by its `hostname`
+
+.. http:get:: /api/apps/(string:id)/domains/
+
+  List all :class:`~api.models.Domain`\s.
+
+.. http:post:: /api/apps/(string:id)/domains/
+
+  Create a new :class:`~api.models.Domain`\s.
+
+
 Application Actions
 -------------------
 
@@ -233,12 +250,6 @@
             'get': 'retrieve', 'patch': 'partial_update', 'delete': 'destroy'})),
     url(r'^clusters/?',
         views.ClusterViewSet.as_view({'get': 'list', 'post': 'create'})),
-    # application domains
-    url(r'^domains/(?P<id>[-\._\w]+)/?',
-        views.DomainViewSet.as_view({'delete': 'destroy'})),
-    url(r'^apps/(?P<id>[-_\w]+)/domains/?',
-        views.DomainViewSet.as_view({'post': 'create',
-                                     'get': 'list'})),
     # application release components
     url(r'^apps/(?P<id>[-_\w]+)/config/?',
         views.AppConfigViewSet.as_view({'get': 'retrieve', 'post': 'create'})),
@@ -259,6 +270,11 @@
         views.AppContainerViewSet.as_view({'get': 'list'})),
     url(r'^apps/(?P<id>[-_\w]+)/containers/?',
         views.AppContainerViewSet.as_view({'get': 'list'})),
+    # application domains
+    url(r'^apps/(?P<id>[-_\w]+)/domains/(?P<domain>[-\._\w]+)/?',
+        views.DomainViewSet.as_view({'delete': 'destroy'})),
+    url(r'^apps/(?P<id>[-_\w]+)/domains/?',
+        views.DomainViewSet.as_view({'post': 'create', 'get': 'list'})),
     # application actions
     url(r'^apps/(?P<id>[-_\w]+)/scale/?',
         views.AppViewSet.as_view({'post': 'scale'})),

controller/api/views.py

@@ -466,16 +466,13 @@ class DomainViewSet(OwnerViewSet):
 
     def create(self, request, *args, **kwargs):
         app = get_object_or_404(models.App, id=self.kwargs['id'])
+        # TODO: allow non-owners to manage domains
         if request.user != app.owner:
             return Response(status=status.HTTP_403_FORBIDDEN)
         request._data = request.DATA.copy()
         request.DATA['app'] = app
         return super(DomainViewSet, self).create(request, *args, **kwargs)
 
-    def post_save(self, domain, created=False):
-        if created:
-            domain.create()
-
     def get_queryset(self, **kwargs):
         app = get_object_or_404(models.App, id=self.kwargs['id'])
         qs = self.model.objects.filter(app=app)