Fixed #383 -- Added summaries to deis releases:list

Author: mboersma

api/migrations/0006_auto__add_field_release_summary.py

@@ -23,6 +23,8 @@
 
 from api import fields, tasks
 from provider import import_provider_module
+from utils import dict_diff
+
 
 # import user-defined configuration management module
 CM = importlib.import_module(settings.CM_MODULE)
@@ -789,6 +791,7 @@ class Release(UuidAuditedModel):
     owner = models.ForeignKey(settings.AUTH_USER_MODEL)
     app = models.ForeignKey('App')
     version = models.PositiveIntegerField()
+    summary = models.TextField(blank=True, null=True)
 
     config = models.ForeignKey('Config')
     build = models.ForeignKey('Build', blank=True, null=True)
@@ -801,6 +804,57 @@ class Meta:
     def __str__(self):
         return "{0}-v{1}".format(self.app.id, self.version)
 
+    def previous(self):
+        """
+        Return the previous Release to this one.
+
+        :return: the previous :class:`Release`, or None
+        """
+        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()
+        except Release.DoesNotExist:
+            prev_release = None
+        return prev_release
+
+    def save(self, *args, **kwargs):
+        if not self.summary:
+            self.summary = ''
+            prev_release = self.previous()
+            # compare this build to the previous build
+            old_build = prev_release.build if prev_release else None
+            # if the build changed, log it and who pushed it
+            if self.build != old_build and self.build.sha:
+                self.summary += "{} deployed {}".format(self.build.owner, self.build.sha[:7])
+            # compare this config to the previous config
+            old_config = prev_release.config if prev_release else None
+            # if the config data changed, log the dict diff
+            if self.config != old_config:
+                dict1 = self.config.values
+                dict2 = old_config.values if old_config else {}
+                diff = dict_diff(dict1, dict2)
+                # try to be as succinct as possible
+                added = ', '.join(k for k in diff.get('added', {}))
+                added = 'added ' + added if added else ''
+                changed = ', '.join(k for k in diff.get('changed', {}))
+                changed = 'changed ' + changed if changed else ''
+                deleted = ', '.join(k for k in diff.get('deleted', {}))
+                deleted = 'deleted ' + 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)
+                    else:
+                        self.summary = "{} changed nothing".format(self.owner)
+        super(Release, self).save(*args, **kwargs)
+
 
 @receiver(release_signal)
 def new_release(sender, **kwargs):

api/models.py

@@ -63,7 +63,7 @@ def test_release(self):
         response = self.client.get(url)
         self.assertEqual(response.status_code, 200)
         self.assertEqual(response.data['count'], 1)
-        url = '/api/apps/{app_id}/releases/1'.format(**locals())
+        url = '/api/apps/{app_id}/releases/v1'.format(**locals())
         response = self.client.get(url)
         self.assertEqual(response.status_code, 200)
         release1 = response.data
@@ -78,7 +78,7 @@ def test_release(self):
         self.assertEqual(response.status_code, 201)
         self.assertIn('NEW_URL1', json.loads(response.data['values']))
         # check to see that a new release was created
-        url = '/api/apps/{app_id}/releases/2'.format(**locals())
+        url = '/api/apps/{app_id}/releases/v2'.format(**locals())
         response = self.client.get(url)
         self.assertEqual(response.status_code, 200)
         release2 = response.data
@@ -102,7 +102,7 @@ def test_release(self):
         self.assertEqual(response.status_code, 201)
         self.assertEqual(response.data['url'], body['url'])
         # check to see that a new release was created
-        url = '/api/apps/{app_id}/releases/3'.format(**locals())
+        url = '/api/apps/{app_id}/releases/v3'.format(**locals())
         response = self.client.get(url)
         self.assertEqual(response.status_code, 200)
         release3 = response.data
@@ -120,7 +120,7 @@ def test_release(self):
         self.assertEqual(
             config3_values['PATH'], 'bin:/usr/local/bin:/usr/bin:/bin')
         # check that we can fetch a previous release
-        url = '/api/apps/{app_id}/releases/2'.format(**locals())
+        url = '/api/apps/{app_id}/releases/v2'.format(**locals())
         response = self.client.get(url)
         self.assertEqual(response.status_code, 200)
         release2 = response.data
@@ -174,12 +174,12 @@ def test_release_rollback(self):
         response = self.client.get(url, content_type='application/json')
         self.assertEqual(response.status_code, 200)
         self.assertEqual(response.data['count'], 4)
-        url = '/api/apps/{app_id}/releases/2'.format(**locals())
+        url = '/api/apps/{app_id}/releases/v2'.format(**locals())
         response = self.client.get(url, content_type='application/json')
         self.assertEqual(response.status_code, 200)
         release2 = response.data
         self.assertEquals(release2['version'], 2)
-        url = '/api/apps/{app_id}/releases/4'.format(**locals())
+        url = '/api/apps/{app_id}/releases/v4'.format(**locals())
         response = self.client.get(url, content_type='application/json')
         self.assertEqual(response.status_code, 200)
         release4 = response.data
@@ -198,11 +198,11 @@ def test_release_rollback(self):
         response = self.client.get(url, content_type='application/json')
         self.assertEqual(response.status_code, 200)
         self.assertEqual(response.data['count'], 5)
-        url = '/api/apps/{app_id}/releases/1'.format(**locals())
+        url = '/api/apps/{app_id}/releases/v1'.format(**locals())
         response = self.client.get(url)
         self.assertEqual(response.status_code, 200)
         release1 = response.data
-        url = '/api/apps/{app_id}/releases/5'.format(**locals())
+        url = '/api/apps/{app_id}/releases/v5'.format(**locals())
         response = self.client.get(url)
         self.assertEqual(response.status_code, 200)
         release5 = response.data
@@ -216,3 +216,11 @@ def test_release_str(self):
         release3 = self.test_release()
         release = Release.objects.get(uuid=release3['uuid'])
         self.assertEqual(str(release), "{}-v3".format(release3['app']))
+
+    def test_release_summary(self):
+        """Test the text summary of a release."""
+        release3 = self.test_release()
+        release = Release.objects.get(uuid=release3['uuid'])
+        # check that the release has push and env change messages
+        self.assertIn('autotest deployed ', release.summary)
+        self.assertIn('autotest added PATH', release.summary)

api/tests/test_release.py

@@ -417,7 +417,7 @@
         views.AppBuildViewSet.as_view({'get': 'retrieve'})),
     url(r'^apps/(?P<id>[-_\w]+)/builds/?',
         views.AppBuildViewSet.as_view({'get': 'list', 'post': 'create'})),
-    url(r'^apps/(?P<id>[-_\w]+)/releases/(?P<version>[0-9]+)/?',
+    url(r'^apps/(?P<id>[-_\w]+)/releases/v(?P<version>[0-9]+)/?',
         views.AppReleaseViewSet.as_view({'get': 'retrieve'})),
     url(r'^apps/(?P<id>[-_\w]+)/releases/rollback/?',
         views.AppReleaseViewSet.as_view({'post': 'rollback'})),

api/urls.py

@@ -63,3 +63,41 @@ def generate_app_name():
     ]
     return "{}-{}".format(
         random.choice(adjectives), random.choice(nouns))
+
+
+def dict_diff(dict1, dict2):
+    """
+    Returns the added, changed, and deleted items in dict1 compared with dict2.
+
+    :param dict1: a python dict
+    :param dict2: an earlier version of the same python dict
+    :return: a new dict, with 'added', 'changed', and 'removed' items if
+             any were found.
+
+    >>> d1 = {1: 'a'}
+    >>> dict_diff(d1, d1)
+    {}
+    >>> d2 = {1: 'a', 2: 'b'}
+    >>> dict_diff(d2, d1)
+    {'added': {2: 'b'}}
+    >>> d3 = {2: 'B', 3: 'c'}
+    >>> expected = {'added': {3: 'c'}, 'changed': {2: 'B'}, 'deleted': {1: 'a'}}
+    >>> dict_diff(d3, d2) == expected
+    True
+    """
+    diff = {}
+    set1, set2 = set(dict1), set(dict2)
+    # Find items that were added to dict2
+    diff['added'] = {k: dict1[k] for k in (set1 - set2)}
+    # Find common items whose values differ between dict1 and dict2
+    diff['changed'] = {
+        k: dict1[k] for k in (set1 & set2) if dict1[k] != dict2[k]
+    }
+    # Find items that were deleted from dict2
+    diff['deleted'] = {k: dict2[k] for k in (set2 - set1)}
+    return {k: diff[k] for k in diff if diff[k]}
+
+
+if __name__ == "__main__":
+    import doctest
+    doctest.testmod()

api/utils.py

@@ -640,15 +640,17 @@ def rollback(self, request, *args, **kwargs):
         """
         app = get_object_or_404(models.App, id=self.kwargs['id'])
         last_version = app.release_set.latest().version
-        version = request.DATA.get('version', last_version - 1)
+        version = int(request.DATA.get('version', last_version - 1))
         if version < 1:
             return Response(status=status.HTTP_404_NOT_FOUND)
         prev = app.release_set.get(version=version)
         with transaction.atomic():
+            summary = "{} rolled back to v{}".format(request.user, version)
             app.release_set.create(owner=request.user, version=last_version + 1,
-                                   build=prev.build, config=prev.config)
+                                   build=prev.build, config=prev.config,
+                                   summary=summary)
             app.converge()
-        msg = "Rolled back to {}".format(version)
+        msg = "Rolled back to v{}".format(version)
         return Response(msg, status=status.HTTP_201_CREATED)
 
 

api/views.py

@@ -45,12 +45,14 @@
 from __future__ import print_function
 from collections import namedtuple
 from cookielib import MozillaCookieJar
+from datetime import datetime
 from getpass import getpass
 from itertools import cycle
 from threading import Event
 from threading import Thread
 import glob
 import json
+import locale
 import os.path
 import random
 import re
@@ -60,15 +62,21 @@
 import time
 import urlparse
 import webbrowser
-import yaml
 
+from dateutil import parser
+from dateutil import relativedelta
+from dateutil import tz
 from docopt import docopt
 from docopt import DocoptExit
 import requests
+import yaml
 
 __version__ = '0.4.0'
 
 
+locale.setlocale(locale.LC_ALL, '')
+
+
 class Session(requests.Session):
     """
     Session for making API requests and interacting with the filesystem
@@ -296,6 +304,42 @@ def get_provider_creds(provider, raise_error=False):
             "Missing environment variable: {}".format(missing))
 
 
+def readable_datetime(datetime_str):
+    """
+    Return a human-readable datetime string from an ECMA-262 (JavaScript)
+    datetime string.
+    """
+    timezone = tz.tzlocal()
+    dt = parser.parse(datetime_str).astimezone(timezone)
+    now = datetime.now(timezone)
+    delta = relativedelta.relativedelta(now, dt)
+    # if it happened today, say "2 hours and 1 minute ago"
+    if delta.days <= 1 and dt.day == now.day:
+        if delta.hours == 0:
+            hour_str = ''
+        elif delta.hours == 1:
+            hour_str = '1 hour '
+        else:
+            hour_str = "{} hours ".format(delta.hours)
+        if delta.minutes == 0:
+            min_str = ''
+        elif delta.minutes == 1:
+            min_str = '1 minute '
+        else:
+            min_str = "{} minutes ".format(delta.minutes)
+        if not any((hour_str, min_str)):
+            return 'Just now'
+        else:
+            return "{}{}ago".format(hour_str, min_str)
+    # if it happened yesterday, say "yesterday at 3:23 pm"
+    yesterday = now + relativedelta.relativedelta(days=-1)
+    if delta.days <= 2 and dt.day == yesterday.day:
+        return dt.strftime("Yesterday at %X")
+    # otherwise return locale-specific date/time format
+    else:
+        return dt.strftime('%c %Z')
+
+
 def trim(docstring):
     """
     Function to trim whitespace from docstring
@@ -1926,6 +1970,8 @@ def releases_info(self, args):
         Usage: deis releases:info <version> [--app=<app>]
         """
         version = args.get('<version>')
+        if not version.startswith('v'):
+            version = 'v' + version
         app = args.get('--app')
         if not app:
             app = self._session.app
@@ -1945,12 +1991,13 @@ def releases_list(self, args):
         app = args.get('--app')
         if not app:
             app = self._session.app
-        response = self._dispatch('get', '/api/apps/{app}/releases'.format(**locals()))
+        response = self._dispatch('get', "/api/apps/{app}/releases".format(**locals()))
         if response.status_code == requests.codes.ok:  # @UndefinedVariable
-            print('=== {0} Releases'.format(app))
+            print("=== {} Releases".format(app))
             data = response.json()
             for item in data['results']:
-                print('{version} {created}'.format(**item))
+                item['created'] = readable_datetime(item['created'])
+                print("v{version:<6} {created:<33} {summary}".format(**item))
         else:
             raise ResponseError(response)
 
@@ -1963,9 +2010,11 @@ def releases_rollback(self, args):
         app = args.get('--app')
         if not app:
             app = self._session.app
-        version = args.get('--version')
+        version = args.get('<version>')
         if version:
-            body = {'version': version}
+            if version.startswith('v'):
+                version = version[1:]
+            body = {'version': int(version)}
         else:
             body = {}
         url = "/api/apps/{app}/releases/rollback".format(**locals())

client/deis.py

@@ -23,7 +23,7 @@
 KWARGS = {}
 if USE_SETUPTOOLS:
     KWARGS = {
-        'install_requires': ['docopt', 'PyYAML', 'requests'],
+        'install_requires': ['docopt', 'python-dateutil', 'PyYAML', 'requests'],
         'entry_points': {'console_scripts': ['deis = deis:main']},
     }
 else:
@@ -59,6 +59,9 @@
           ('.', ['README.rst']),
       ],
       long_description=LONG_DESCRIPTION,
-      requires=['docopt(>=0.6.1)', 'PyYAML(>=3.10)', 'requests(>=2.1.0)'],
+      requires=[
+          'docopt(==0.6.1)', 'python-dateutil(==2.2)',
+          'PyYAML(==3.10)', 'requests(==2.1.0)',
+      ],
       zip_safe=True,
       **KWARGS)

client/setup.py

@@ -19,6 +19,7 @@ South==0.8.4
 
 # Deis client requirements
 docopt==0.6.1
+python-dateutil==2.2
 #PyYAML==3.10
 requests==2.1.0