feat(registry): move registry information to its own top level Config resource

ref #639

Author: helgi

rootfs/api/migrations/0008_config_registry.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.9.5 on 2016-04-21 19:06
+from __future__ import unicode_literals
+
+from django.db import migrations
+import jsonfield.fields
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0007_auto_20160226_2335'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='config',
+            name='registry',
+            field=jsonfield.fields.JSONField(blank=True, default={}),
+        ),
+    ]

rootfs/api/models/config.py

@@ -17,6 +17,7 @@ class Config(UuidAuditedModel):
     memory = JSONField(default={}, blank=True)
     cpu = JSONField(default={}, blank=True)
     tags = JSONField(default={}, blank=True)
+    registry = JSONField(default={}, blank=True)
 
     class Meta:
         get_latest_by = 'created'
@@ -80,11 +81,15 @@ def set_healthchecks(self):
         # having succeeded.
         self.values['HEALTHCHECK_FAILURE_THRESHOLD'] = health['failure_threshold']
 
+    def set_registry(self):
+        # lower case all registry options for consistency
+        self.registry = {key.lower(): value for key, value in self.registry.copy().items()}
+
     def save(self, **kwargs):
         """merge the old config with the new"""
         try:
             previous_config = self.app.config_set.latest()
-            for attr in ['cpu', 'memory', 'tags', 'values']:
+            for attr in ['cpu', 'memory', 'tags', 'registry', 'values']:
                 # Guard against migrations from older apps without fixes to
                 # JSONField encoding.
                 try:
@@ -104,8 +109,8 @@ def save(self, **kwargs):
         except Config.DoesNotExist:
             pass
 
-        # set any missing HEALTHCHECK_* elements
         self.set_healthchecks()
+        self.set_registry()
 
         # verify the tags exist on any nodes as labels
         if self.tags:

rootfs/api/models/release.py

@@ -107,10 +107,10 @@ def publish(self, source_version='latest'):
         if not self.build.dockerfile and not self.build.sha:
             # gather custom login information for registry if needed
             auth = None
-            if self.config.values.get('IMAGE_AUTH_USER', None):
+            if self.config.registry.get('username', None):
                 auth = {
-                    'username': self.config.values.get('IMAGE_AUTH_USER', None),
-                    'password': self.config.values.get('IMAGE_AUTH_PASSWORD', None),
+                    'username': self.config.registry.get('username', None),
+                    'password': self.config.registry.get('password', None),
                     'email': self.owner.email
                 }
 
@@ -248,8 +248,10 @@ def save(self, *args, **kwargs):  # noqa
                     self.summary += "{} deployed {}".format(self.build.owner, self.build.sha[:7])
                 else:
                     self.summary += "{} deployed {}".format(self.build.owner, self.build.image)
+
             # if the config data changed, log the dict diff
             if self.config != old_config:
+                # if env vars change, log the dict diff
                 dict1 = self.config.values
                 dict2 = old_config.values if old_config else {}
                 diff = dict_diff(dict1, dict2)
@@ -265,6 +267,7 @@ def save(self, *args, **kwargs):  # noqa
                     if self.summary:
                         self.summary += ' and '
                     self.summary += "{} {}".format(self.config.owner, changes)
+
                 # if the limits changed (memory or cpu), log the dict diff
                 changes = []
                 old_mem = old_config.memory if old_config else {}
@@ -278,6 +281,7 @@ def save(self, *args, **kwargs):  # noqa
                 if changes:
                     changes = 'changed limits for '+', '.join(changes)
                     self.summary += "{} {}".format(self.config.owner, changes)
+
                 # if the tags changed, log the dict diff
                 changes = []
                 old_tags = old_config.tags if old_config else {}
@@ -294,6 +298,24 @@ def save(self, *args, **kwargs):  # noqa
                     if self.summary:
                         self.summary += ' and '
                     self.summary += "{} {}".format(self.config.owner, changes)
+
+                # if the registry information changed, log the dict diff
+                changes = []
+                old_registry = old_config.registry if old_config else {}
+                diff = dict_diff(self.config.registry, old_registry)
+                # try to be as succinct as possible
+                added = ', '.join(k for k in diff.get('added', {}))
+                added = 'added registry info ' + added if added else ''
+                changed = ', '.join(k for k in diff.get('changed', {}))
+                changed = 'changed registry info ' + changed if changed else ''
+                deleted = ', '.join(k for k in diff.get('deleted', {}))
+                deleted = 'deleted registry info ' + deleted if deleted else ''
+                changes = ', '.join(i for i in (added, changed, deleted) if i)
+                if changes:
+                    if self.summary:
+                        self.summary += ' and '
+                    self.summary += "{} {}".format(self.config.owner, changes)
+
             if not self.summary:
                 if self.version == 1:
                     self.summary = "{} created the initial release".format(self.owner)

rootfs/api/serializers.py

@@ -124,6 +124,7 @@ class ConfigSerializer(serializers.ModelSerializer):
     memory = JSONFieldSerializer(required=False, binary=True)
     cpu = JSONFieldSerializer(required=False, binary=True)
     tags = JSONFieldSerializer(required=False, binary=True)
+    registry = JSONFieldSerializer(required=False, binary=True)
 
     class Meta:
         """Metadata options for a :class:`ConfigSerializer`."""
@@ -208,6 +209,15 @@ def validate_tags(self, data):
 
         return data
 
+    def validate_registry(self, data):
+        for key, value in data.items():
+            if not re.match(CONFIGKEY_MATCH, key):
+                raise serializers.ValidationError(
+                    "Config keys must start with a letter or underscore and "
+                    "only contain [A-z0-9_]")
+
+        return data
+
 
 class ReleaseSerializer(serializers.ModelSerializer):
     """Serialize a :class:`~api.models.Release` model."""

rootfs/api/tests/test_config.py

@@ -126,14 +126,15 @@ def test_response_data(self, mock_requests):
         response = self.client.post(url, body)
         for key in response.data:
             self.assertIn(key, ['uuid', 'owner', 'created', 'updated', 'app', 'values', 'memory',
-                                'cpu', 'tags'])
+                                'cpu', 'tags', 'registry'])
         expected = {
             'owner': self.user.username,
             'app': 'test',
             'values': {'PORT': '5000'},
             'memory': {},
             'cpu': {},
-            'tags': {}
+            'tags': {},
+            'registry': {}
         }
         self.assertDictContainsSubset(expected, response.data)
 
@@ -148,14 +149,15 @@ def test_response_data_types_converted(self, mock_requests):
         self.assertEqual(response.status_code, 201)
         for key in response.data:
             self.assertIn(key, ['uuid', 'owner', 'created', 'updated', 'app', 'values', 'memory',
-                                'cpu', 'tags'])
+                                'cpu', 'tags', 'registry'])
         expected = {
             'owner': self.user.username,
             'app': 'test',
             'values': {'PORT': '5000'},
             'memory': {},
             'cpu': {'web': "1024"},
-            'tags': {}
+            'tags': {},
+            'registry': {}
         }
         self.assertDictContainsSubset(expected, response.data)
 
@@ -535,6 +537,76 @@ def test_tags(self, mock_requests):
         response = self.client.delete(url)
         self.assertEqual(response.status_code, 405)
 
+    def test_registry(self, mock_requests):
+        """
+        Test that registry information can be set on an application
+        """
+        url = '/v2/apps'
+        response = self.client.post(url)
+        self.assertEqual(response.status_code, 201)
+        app_id = response.data['id']
+
+        # check default
+        url = '/v2/apps/{app_id}/config'.format(**locals())
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, 200)
+        self.assertIn('registry', response.data)
+        self.assertEqual(response.data['registry'], {})
+
+        # set some registry information
+        body = {'registry': json.dumps({'username': 'bob'})}
+        response = self.client.post(url, body)
+        self.assertEqual(response.status_code, 201)
+        registry1 = response.data
+
+        # check registry information again
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, 200)
+        self.assertIn('registry', response.data)
+        registry = response.data['registry']
+        self.assertIn('username', registry)
+        self.assertEqual(registry['username'], 'bob')
+
+        # set an additional value
+        # set them upper case, internally it should translate to lower
+        body = {'registry': json.dumps({'PASSWORD': 's3cur3pw1'})}
+        response = self.client.post(url, body)
+        self.assertEqual(response.status_code, 201)
+        registry2 = response.data
+        self.assertNotEqual(registry1['uuid'], registry2['uuid'])
+        registry = response.data['registry']
+        self.assertIn('password', registry)
+        self.assertEqual(registry['password'], 's3cur3pw1')
+        self.assertIn('username', registry)
+        self.assertEqual(registry['username'], 'bob')
+
+        # read the registry information again
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, 200)
+        registry3 = response.data
+        self.assertEqual(registry2, registry3)
+        registry = response.data['registry']
+        self.assertIn('password', registry)
+        self.assertEqual(registry['password'], 's3cur3pw1')
+        self.assertIn('username', registry)
+        self.assertEqual(registry['username'], 'bob')
+
+        # unset a value
+        body = {'registry': json.dumps({'password': None})}
+        response = self.client.post(url, body)
+        self.assertEqual(response.status_code, 201)
+        registry4 = response.data
+        self.assertNotEqual(registry3['uuid'], registry4['uuid'])
+        self.assertNotIn('password', json.dumps(response.data['registry']))
+
+        # disallow put/patch/delete
+        response = self.client.put(url)
+        self.assertEqual(response.status_code, 405)
+        response = self.client.patch(url)
+        self.assertEqual(response.status_code, 405)
+        response = self.client.delete(url)
+        self.assertEqual(response.status_code, 405)
+
     def test_config_owner_is_requesting_user(self, mock_requests):
         """
         Ensure that setting the config value is owned by the requesting user