Commit: fc15e4fe6571d61a0f9bf29105ca9b1482bebd02 - allura (git)

allura

Commit MetaInfo

• Revision: fc15e4fe6571d61a0f9bf29105ca9b1482bebd02 (tree)
• Time: 2012-07-13 21:41:52
• Author: Igor Bondarenko <jetmind2@gmai...>
• Commiter: Igor Bondarenko

Log Message

[#4534] ticket:114 Add log_if_changed helper function

Change Summary

• modified: Allura/allura/controllers/project.py
• modified: Allura/allura/lib/helpers.py
• modified: Allura/allura/tests/test_helpers.py

Incremental Difference

--- a/Allura/allura/controllers/project.py
+++ b/Allura/allura/controllers/project.py
@@ -479,42 +479,32 @@ class NeighborhoodAdminController(object):
     def update(self, name=None, css=None, homepage=None, project_template=None, icon=None, **kw):
         nbhd = self.neighborhood
         c.project = nbhd.neighborhood_project
-        if nbhd.name != name:
-            M.AuditLog.log('change neighborhood name to %s', name)
-            nbhd.name = name
+        h.log_if_changed(nbhd, 'name', name, 
+                        'change neighborhood name to %s' % name)
         nbhd_redirect = kw.pop('redirect', '')
-        if nbhd.redirect != nbhd_redirect:
-            M.AuditLog.log('change neighborhood redirect to %s', nbhd_redirect)
-            nbhd.redirect = nbhd_redirect
-        if nbhd.homepage != homepage:
-            M.AuditLog.log('change neighborhood homepage to %s', homepage)
-            nbhd.homepage = homepage
-        if nbhd.css != css:
-            M.AuditLog.log('change neighborhood css to %s', css)
-            nbhd.css = css
-        if nbhd.project_template != project_template:
-            M.AuditLog.log('change neighborhood project template to %s',
-                            project_template)
-            nbhd.project_template = project_template
+        h.log_if_changed(nbhd, 'redirect', nbhd_redirect,
+                        'change neighborhood redirect to %s' % nbhd_redirect)
+        h.log_if_changed(nbhd, 'homepage', homepage,
+                        'change neighborhood homepage to %s' % homepage)
+        h.log_if_changed(nbhd, 'css', css,
+                        'change neighborhood css to %s' % css)
+        h.log_if_changed(nbhd, 'project_template', project_template,
+                        'change neighborhood project template to %s'
+                        % project_template)
         allow_browse = kw.get('allow_browse', False)
-        if nbhd.allow_browse != allow_browse:
-            M.AuditLog.log('change neighborhood allow browse to %s',
-                            allow_browse)
-            nbhd.allow_browse = allow_browse
+        h.log_if_changed(nbhd, 'allow_browse', allow_browse,
+                        'change neighborhood allow browse to %s'
+                        % allow_browse)
         show_title = kw.get('show_title', False)
-        if nbhd.show_title != show_title:
-            M.AuditLog.log('change neighborhood show title to %s',
-                            show_title)
-            nbhd.show_title = show_title
+        h.log_if_changed(nbhd, 'show_title', show_title,
+                        'change neighborhood show title to %s' % show_title)
         project_list_url = kw.get('project_list_url', '')
-        if nbhd.project_list_url != project_list_url:
-            M.AuditLog.log('change neighborhood project list url to %s',
-                            project_list_url)
-            nbhd.project_list_url = project_list_url
+        h.log_if_changed(nbhd, 'project_list_url', project_list_url,
+                        'change neighborhood project list url to %s'
+                        % project_list_url)
         tracking_id = kw.get('tracking_id', '')
-        if tracking_id != nbhd.tracking_id:
-            M.AuditLog.log('update neighborhood tracking_id')
-            nbhd.tracking_id = tracking_id
+        h.log_if_changed(nbhd, 'tracking_id', tracking_id,
+                        'update neighborhood tracking_id')
         if icon is not None and icon != '':
             if self.neighborhood.icon:
                 self.neighborhood.icon.delete()

--- a/Allura/allura/lib/helpers.py
+++ b/Allura/allura/lib/helpers.py
@@ -621,3 +621,13 @@ prefixes are used (Mebi, Gibi).
             if bytes < unit:
                 return '%.1f %s' % ((base * bytes / unit), prefix)
         return '%.1f %s' % ((base * bytes / unit), prefix)
+
+
+def log_if_changed(artifact, attr, new_val, message):
+    """Set `artifact.attr` to `new_val` if changed. Add AuditLog record."""
+    from allura import model as M
+    if not hasattr(artifact, attr):
+        return
+    if getattr(artifact, attr) != new_val:
+        M.AuditLog.log(message)
+        setattr(artifact, attr, new_val)

--- a/Allura/allura/tests/test_helpers.py
+++ b/Allura/allura/tests/test_helpers.py
@@ -1,4 +1,5 @@
 from os import path
+from mock import Mock, patch
 
 from pylons import c
 from nose.tools import eq_, assert_equals
@@ -125,3 +126,27 @@ def test_render_any_markup_formatting():
     assert_equals(h.render_any_markup('README.md', '### foo\n<script>alert(1)</script> bar'),
                   '<h3>foo</h3>\n<p>&lt;script&gt;alert(1)&lt;/script&gt; bar</p>')
 
+
+class AuditLogMock(Mock):
+    logs = list()
+
+    @classmethod
+    def log(cls, message):
+        cls.logs.append(message)
+
+
+@patch('allura.model.AuditLog', new=AuditLogMock)
+def test_log_if_changed():
+    artifact = Mock()
+    artifact.value = 'test'
+    # change
+    h.log_if_changed(artifact, 'value', 'changed', 'updated value')
+    assert artifact.value == 'changed'
+    assert len(AuditLogMock.logs) == 1
+    assert AuditLogMock.logs[0] == 'updated value'
+
+    # don't change
+    h.log_if_changed(artifact, 'value', 'changed', 'updated value')
+    assert artifact.value == 'changed'
+    assert len(AuditLogMock.logs) == 1
+    assert AuditLogMock.logs[0] == 'updated value'