refactor(controller): move app regex to settings

Author: Matthew Fisher

controller/api/serializers.py

@@ -6,6 +6,7 @@
 
 import re
 
+from django.conf import settings
 from django.contrib.auth.models import User
 from rest_framework import serializers
 
@@ -184,7 +185,9 @@ def validate_domain(self, attrs, source):
         Check that the hostname is valid
         """
         value = attrs[source]
-        match = re.match(r'^(\*\.)?([a-z0-9-]+\.)*([a-z0-9-]+)\.([a-z0-9]{2,})$', value)
+        match = re.match(
+            r'^(\*\.)?(' + settings.APP_URL_REGEX + r'\.)*([a-z0-9-]+)\.([a-z0-9]{2,})$',
+            value)
         if not match:
             raise serializers.ValidationError(
                 "Hostname does not look like a valid hostname. "

controller/api/urls.py

@@ -230,6 +230,7 @@
 
 from __future__ import unicode_literals
 
+from django.conf import settings
 from django.conf.urls import include
 from django.conf.urls import patterns
 from django.conf.urls import url
@@ -251,46 +252,47 @@
     url(r'^clusters/?',
         views.ClusterViewSet.as_view({'get': 'list', 'post': 'create'})),
     # application release components
-    url(r'^apps/(?P<id>[-a-z0-9]+)/config/?',
+    url(r'^apps/(?P<id>{})/config/?'.format(settings.APP_URL_REGEX),
         views.AppConfigViewSet.as_view({'get': 'retrieve', 'post': 'create'})),
-    url(r'^apps/(?P<id>[-a-z0-9]+)/builds/(?P<uuid>[-_\w]+)/?',
+    url(r'^apps/(?P<id>{})/builds/(?P<uuid>[-_\w]+)/?'.format(settings.APP_URL_REGEX),
         views.AppBuildViewSet.as_view({'get': 'retrieve'})),
-    url(r'^apps/(?P<id>[-a-z0-9]+)/builds/?',
+    url(r'^apps/(?P<id>{})/builds/?'.format(settings.APP_URL_REGEX),
         views.AppBuildViewSet.as_view({'get': 'list', 'post': 'create'})),
-    url(r'^apps/(?P<id>[-a-z0-9]+)/releases/v(?P<version>[0-9]+)/?',
+    url(r'^apps/(?P<id>{})/releases/v(?P<version>[0-9]+)/?'.format(settings.APP_URL_REGEX),
         views.AppReleaseViewSet.as_view({'get': 'retrieve'})),
-    url(r'^apps/(?P<id>[-a-z0-9]+)/releases/rollback/?',
+    url(r'^apps/(?P<id>{})/releases/rollback/?'.format(settings.APP_URL_REGEX),
         views.AppReleaseViewSet.as_view({'post': 'rollback'})),
-    url(r'^apps/(?P<id>[-a-z0-9]+)/releases/?',
+    url(r'^apps/(?P<id>{})/releases/?'.format(settings.APP_URL_REGEX),
         views.AppReleaseViewSet.as_view({'get': 'list'})),
     # application infrastructure
-    url(r'^apps/(?P<id>[-a-z0-9]+)/containers/(?P<type>[-_\w]+)/(?P<num>[-_\w]+)/?',
+    url(r'^apps/(?P<id>{})/containers/(?P<type>[-_\w]+)/(?P<num>[-_\w]+)/?'.format(
+        settings.APP_URL_REGEX),
         views.AppContainerViewSet.as_view({'get': 'retrieve'})),
-    url(r'^apps/(?P<id>[-a-z0-9]+)/containers/(?P<type>[-_\w.]+)/?',
+    url(r'^apps/(?P<id>{})/containers/(?P<type>[-_\w.]+)/?'.format(settings.APP_URL_REGEX),
         views.AppContainerViewSet.as_view({'get': 'list'})),
-    url(r'^apps/(?P<id>[-a-z0-9]+)/containers/?',
+    url(r'^apps/(?P<id>{})/containers/?'.format(settings.APP_URL_REGEX),
         views.AppContainerViewSet.as_view({'get': 'list'})),
     # application domains
-    url(r'^apps/(?P<id>[-a-z0-9]+)/domains/(?P<domain>[-\._\w]+)/?',
+    url(r'^apps/(?P<id>{})/domains/(?P<domain>[-\._\w]+)/?'.format(settings.APP_URL_REGEX),
         views.DomainViewSet.as_view({'delete': 'destroy'})),
-    url(r'^apps/(?P<id>[-a-z0-9]+)/domains/?',
+    url(r'^apps/(?P<id>{})/domains/?'.format(settings.APP_URL_REGEX),
         views.DomainViewSet.as_view({'post': 'create', 'get': 'list'})),
     # application actions
-    url(r'^apps/(?P<id>[-a-z0-9]+)/scale/?',
+    url(r'^apps/(?P<id>{})/scale/?'.format(settings.APP_URL_REGEX),
         views.AppViewSet.as_view({'post': 'scale'})),
-    url(r'^apps/(?P<id>[-a-z0-9]+)/logs/?',
+    url(r'^apps/(?P<id>{})/logs/?'.format(settings.APP_URL_REGEX),
         views.AppViewSet.as_view({'post': 'logs'})),
-    url(r'^apps/(?P<id>[-a-z0-9]+)/run/?',
+    url(r'^apps/(?P<id>{})/run/?'.format(settings.APP_URL_REGEX),
         views.AppViewSet.as_view({'post': 'run'})),
-    url(r'^apps/(?P<id>[-a-z0-9]+)/calculate/?',
+    url(r'^apps/(?P<id>{})/calculate/?'.format(settings.APP_URL_REGEX),
         views.AppViewSet.as_view({'post': 'calculate'})),
     # apps sharing
-    url(r'^apps/(?P<id>[-a-z0-9]+)/perms/(?P<username>[-_\w]+)/?',
+    url(r'^apps/(?P<id>{})/perms/(?P<username>[-_\w]+)/?'.format(settings.APP_URL_REGEX),
         views.AppPermsViewSet.as_view({'delete': 'destroy'})),
-    url(r'^apps/(?P<id>[-a-z0-9]+)/perms/?',
+    url(r'^apps/(?P<id>{})/perms/?'.format(settings.APP_URL_REGEX),
         views.AppPermsViewSet.as_view({'get': 'list', 'post': 'create'})),
     # apps base endpoint
-    url(r'^apps/(?P<id>[-a-z0-9]+)/?',
+    url(r'^apps/(?P<id>{})/?'.format(settings.APP_URL_REGEX),
         views.AppViewSet.as_view({'get': 'retrieve', 'delete': 'destroy'})),
     url(r'^apps/?',
         views.AppViewSet.as_view({'get': 'list', 'post': 'create'})),

controller/deis/settings.py

@@ -297,6 +297,8 @@
     }
 }
 
+APP_URL_REGEX = '[a-z0-9-]+'
+
 # SECURITY: change this to allowed fqdn's to prevent host poisioning attacks
 # see https://docs.djangoproject.com/en/1.5/ref/settings/#std:setting-ALLOWED_HOSTS
 ALLOWED_HOSTS = ['*']