feat(release): re-use image source if Build is called with an image that is already in the deis registry

Closes #614

Author: helgi

rootfs/api/models/release.py

@@ -1,3 +1,5 @@
+import logging
+
 from django.conf import settings
 from django.db import models
 
@@ -6,6 +8,8 @@
 
 from api.models import UuidAuditedModel, log_event
 
+logger = logging.getLogger(__name__)
+
 
 class Release(UuidAuditedModel):
     """
@@ -32,13 +36,22 @@ def __str__(self):
 
     @property
     def image(self):
+        # return image if it is already in the registry, test host and then host + port
+        if (
+            self.build.image.startswith(settings.REGISTRY_HOST) or
+            self.build.image.startswith(settings.REGISTRY_URL)
+        ):
+            # strip registry information off first
+            image = self.build.image.replace('{}/'.format(settings.REGISTRY_URL), '')
+            return image.replace('{}/'.format(settings.REGISTRY_HOST), '')
+
         if not self.build.dockerfile:
             # Deis Pull
             if not self.build.sha:
                 return '{}:v{}'.format(self.app.id, str(self.version))
-            else:
-                # Build Pack
-                return self.build.image
+
+            # Build Pack
+            return self.build.image
 
         # DockerFile
         return '{}:git-{}'.format(self.app.id, str(self.build.sha))
@@ -72,6 +85,15 @@ def publish(self, source_version='latest'):
             raise EnvironmentError('No build associated with this release to publish')
 
         source_image = self.build.image
+        # return image if it is already in the registry, test host and then host + port
+        if (
+            source_image.startswith(settings.REGISTRY_HOST) or
+            source_image.startswith(settings.REGISTRY_URL)
+        ):
+            logger.debug('{} already exists in the target registry. Using this image for release {} of app {}'.format(source_image, self.version, self.app))  # noqa
+            return
+
+        # add tag if it was not provided
         if ':' not in source_image:
             source_tag = 'git-{}'.format(self.build.sha) if self.build.sha else source_version
             source_image = "{}:{}".format(source_image, source_tag)
@@ -90,6 +112,7 @@ def previous(self):
         releases = self.app.release_set
         if self.pk:
             releases = releases.exclude(pk=self.pk)
+
         try:
             # Get the Release previous to this one
             prev_release = releases.latest()

rootfs/api/tests/test_build.py

@@ -9,6 +9,7 @@
 
 from django.contrib.auth.models import User
 from django.core.cache import cache
+from django.conf import settings
 from rest_framework.test import APITransactionTestCase
 from unittest import mock
 from rest_framework.authtoken.models import Token
@@ -130,9 +131,11 @@ def test_build_default_containers(self, mock_requests):
         app_id = response.data['id']
         # post a new build with procfile
         url = "/v2/apps/{app_id}/builds".format(**locals())
-        body = {'image': 'autotest/example',
-                'sha': 'a'*40,
-                'dockerfile': "FROM scratch"}
+        body = {
+            'image': 'autotest/example',
+            'sha': 'a'*40,
+            'dockerfile': "FROM scratch"
+        }
         response = self.client.post(url, body)
         self.assertEqual(response.status_code, 201)
 
@@ -154,10 +157,14 @@ def test_build_default_containers(self, mock_requests):
 
         # post a new build with procfile
         url = "/v2/apps/{app_id}/builds".format(**locals())
-        body = {'image': 'autotest/example',
-                'sha': 'a'*40,
-                'dockerfile': "FROM scratch",
-                'procfile': {'worker': 'node worker.js'}}
+        body = {
+            'image': 'autotest/example',
+            'sha': 'a'*40,
+            'dockerfile': "FROM scratch",
+            'procfile': {
+                'worker': 'node worker.js'
+            }
+        }
         response = self.client.post(url, body)
         self.assertEqual(response.status_code, 201)
 
@@ -179,10 +186,14 @@ def test_build_default_containers(self, mock_requests):
         # post a new build with procfile
 
         url = "/v2/apps/{app_id}/builds".format(**locals())
-        body = {'image': 'autotest/example',
-                'sha': 'a'*40,
-                'procfile': json.dumps({'web': 'node server.js',
-                                        'worker': 'node worker.js'})}
+        body = {
+            'image': 'autotest/example',
+            'sha': 'a'*40,
+            'procfile': json.dumps({
+                'web': 'node server.js',
+                'worker': 'node worker.js'
+            })
+        }
         response = self.client.post(url, body)
         self.assertEqual(response.status_code, 201)
 
@@ -306,3 +317,33 @@ def test_new_build_does_not_scale_up_automatically(self, mock_requests):
         response = self.client.get(url)
         self.assertEqual(response.status_code, 200)
         self.assertEqual(len(response.data['results']), 0)
+
+    def test_build_image_in_registry(self, mock_requests):
+        """When the image is already in the deis registry no pull/tag/push happens"""
+        body = {'id': 'test'}
+        url = '/v2/apps'
+        response = self.client.post(url, body)
+
+        # post an image as a build using registry hostname
+        url = "/v2/apps/test/builds".format(**locals())
+        image = '{}/autotest/example'.format(settings.REGISTRY_HOST)
+        body = {'image': image}
+        response = self.client.post(url, body)
+        self.assertEqual(response.status_code, 201)
+
+        build = Build.objects.get(uuid=response.data['uuid'])
+        release = build.app.release_set.latest()
+        # Registry host is internally stripped off
+        self.assertEqual(release.image, 'autotest/example')
+
+        # post an image as a build using registry hostname + port
+        url = "/v2/apps/test/builds".format(**locals())
+        image = '{}/autotest/example'.format(settings.REGISTRY_URL)
+        body = {'image': image}
+        response = self.client.post(url, body)
+        self.assertEqual(response.status_code, 201)
+
+        build = Build.objects.get(uuid=response.data['uuid'])
+        release = build.app.release_set.latest()
+        # Registry host + port is internally stripped off
+        self.assertEqual(release.image, 'autotest/example')

rootfs/api/tests/test_release.py

@@ -144,7 +144,7 @@ def test_release_rollback(self, mock_requests):
         body = {'values': json.dumps({'NEW_URL1': 'http://localhost:8080/'})}
         response = self.client.post(url, body)
         self.assertEqual(response.status_code, 201)
-        #  todo : edge case that fails becasue version 1 has no build object.
+        #  TODO: edge case that fails becasue version 1 has no build object.
         # update the build to roll a new release
         # url = '/v2/apps/{app_id}/builds'.format(**locals())
         # body = {'image': 'autotest/example'}