Merge lp:~dobey/tarmac/bug-closure into lp:tarmac

[dobey]

Get the list of bugs fixed in the to-be-merged branch
Set the status of fixed bugs to 'Fix committed'
Bring back test_branch.py and make it work in local isolation

[lp:~dobey/tarmac/bug-closure]

337. By dobey on 2010-08-10

Remove debugging pdb usage

338. By dobey on 2010-08-11

Move the actual bug resolving code to a plug-in
Change the fixed_bugs method to a property
Fix up the MockLPBranch class to take a MockLPBranch as the source_branch arg
Set up revision_count property on MockLPBranch objects for testing

[Paul Hummer (rockstar)]

review: Approve

=== modified file 'tarmac/branch.py'
--- tarmac/branch.py	2010-07-25 23:53:05 +0000
+++ tarmac/branch.py	2010-08-11 19:57:43 +0000
@@ -26,6 +26,8 @@
 import tempfile
 
 from bzrlib import branch as bzr_branch
+from bzrlib import missing
+from bzrlib.errors import NoSuchRevision
 from bzrlib.workingtree import WorkingTree
 
 from tarmac.config import BranchConfig
@@ -47,7 +49,6 @@
     @classmethod
     def create(cls, lp_branch, config, create_tree=False):
         if create_tree:
-            assert config.has_section(lp_branch.bzr_identity)
             clazz = cls(lp_branch, config)
             clazz.create_tree()
         else:
@@ -107,8 +108,6 @@
 
     def commit(self, commit_message, revprops=None, **kwargs):
         '''Commit changes.'''
-        assert self.tree
-
         if not revprops:
             revprops = {}
 
@@ -148,6 +147,27 @@
 
     @property
     def has_changes(self):
-        if not self.has_tree:
+        if not self.tree:
             return False
         return self.tree.changes_from(self.tree.basis_tree())
+
+    @property
+    def fixed_bugs(self):
+        """Return the list of bugs fixed by the branch."""
+        bugs_list = []
+
+        self.bzr_branch.lock_read()
+        oldrevid = self.bzr_branch.get_rev_id(self.lp_branch.revision_count)
+        for rev_info in self.bzr_branch.iter_merge_sorted_revisions(
+            stop_revision_id=oldrevid):
+            try:
+                rev = self.bzr_branch.repository.get_revision(rev_info[0])
+                for bug in rev.iter_bugs():
+                    if bug[0].startswith('https://launchpad.net/bugs/'):
+                        bugs_list.append(bug[0].replace(
+                                'https://launchpad.net/bugs/', ''))
+            except NoSuchRevision:
+                continue
+
+        self.bzr_branch.unlock()
+        return bugs_list

=== modified file 'tarmac/config.py'
--- tarmac/config.py	2010-07-21 20:33:26 +0000
+++ tarmac/config.py	2010-08-11 19:57:43 +0000
@@ -106,5 +106,6 @@
     '''
 
     def __init__(self, branch_name, config):
-        for key, val in config.items(branch_name):
-            setattr(self, key, val)
+        if config.has_section(branch_name):
+            for key, val in config.items(branch_name):
+                setattr(self, key, val)

=== added file 'tarmac/plugins/bugresolver.py'
--- tarmac/plugins/bugresolver.py	1970-01-01 00:00:00 +0000
+++ tarmac/plugins/bugresolver.py	2010-08-11 19:57:43 +0000
@@ -0,0 +1,32 @@
+# Copyright 2010 Canonical, Ltd.
+# This file is part of Tarmac.
+#
+# Tarmac is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# Tarmac is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Tarmac.  If not, see <http://www.gnu.org/licenses/>.
+"""Tarmac plug-in for setting a bug status post-commit."""
+
+from tarmac.hooks import tarmac_hooks
+from tarmac.plugins import TarmacPlugin
+
+
+class BugResolver(TarmacPlugin):
+    """Tarmac plug-in for resolving a bug."""
+
+    def run(self, command, target, source, proposal):
+        """Mark bugs fixed in the bug tracker."""
+        for bug_id in target.fixed_bugs:
+            bug = command.launchpad.bugs[bug_id]
+            bug.setStatus(u'Fix committed')
+            bug.lp_save()
+            
+
+tarmac_hooks['tarmac_post_commit'].hook(BugResolver(), 'Bug resolver')

=== modified file 'tarmac/tests/__init__.py'
--- tarmac/tests/__init__.py	2010-07-24 13:23:55 +0000
+++ tarmac/tests/__init__.py	2010-08-11 19:57:43 +0000
@@ -58,7 +58,11 @@
             self.tempdir, 'credentials')
 
         # Create self.tempdir; it is removed in tearDown().
-        os.makedirs(self.tempdir)
+        try:
+            os.makedirs(self.tempdir)
+        except OSError, e:
+            if e.errno != 17:
+                raise e
 
         if self.NEEDS_SAMPLE_DATA:
             config = TarmacConfig()

=== modified file 'tarmac/tests/mock.py'
--- tarmac/tests/mock.py	2010-04-24 03:55:28 +0000
+++ tarmac/tests/mock.py	2010-08-11 19:57:43 +0000
@@ -18,6 +18,7 @@
 from base64 import b64encode
 import math
 import os
+import shutil
 import tempfile
 
 from bzrlib.bzrdir import BzrDir
@@ -36,18 +37,24 @@
     '''A mock LP Branch.'''
 
     def __init__(self, source_branch=None):
-        self.temp_dir = tempfile.mkdtemp()
+        tempfile.tempdir = os.getcwd()
+        self.temp_dir = tempfile.mkdtemp(dir=os.getcwd())
         if source_branch:
-            bzrdir = source_branch.bzrdir.sprout(
+            bzrdir = source_branch._internal_bzr_branch.bzrdir.sprout(
                 self.temp_dir)
             self._internal_tree, self._internal_bzr_branch = \
                     bzrdir.open_tree_or_branch(self.temp_dir)
+            self.revision_count = source_branch.revision_count
         else:
             self._internal_bzr_branch = BzrDir.create_branch_convenience(
                 self.temp_dir)
+            self.revision_count = 0
         self.bzr_identity = self._internal_bzr_branch.base
         self.project = MockLPProject()
 
+    def cleanup(self):
+        shutil.rmtree(self.temp_dir)
+
 
 class cmd_mock(TarmacCommand):
     '''A mock command.'''

=== added file 'tarmac/tests/test_branch.py'
--- tarmac/tests/test_branch.py	1970-01-01 00:00:00 +0000
+++ tarmac/tests/test_branch.py	2010-08-11 19:57:43 +0000
@@ -0,0 +1,188 @@
+# Copyright 2009 Paul Hummer
+# Copyright 2009 Canonical Ltd.
+#
+# This file is part of Tarmac.
+#
+# Tarmac is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by
+# the Free Software Foundation.
+#
+# Tarmac is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Tarmac.  If not, see <http://www.gnu.org/licenses/>.
+
+'''Tests for tarmac.branch'''
+import os
+
+from bzrlib.errors import NoCommits
+
+from tarmac import branch
+from tarmac.config import TarmacConfig
+from tarmac.tests import TarmacTestCase
+from tarmac.tests.mock import MockLPBranch
+
+CONFIG_TEMPLATE = '''
+[%(url)s]
+tree_dir = %(temp_tree)s
+log_file = %(temp_log)s
+'''
+
+
+class TestBranch(TarmacTestCase):
+    '''Test for Tarmac.branch.Branch.'''
+
+    def setUp(self):
+        '''Set up the test environment.'''
+        TarmacTestCase.setUp(self)
+
+        self.bzrdir = os.path.join(os.getcwd(), "bzr")
+        os.environ['BZR_HOME'] = self.bzrdir
+
+        self.config = TarmacConfig()
+        self.write_config_file()
+
+    def make_two_branches_to_merge(self):
+        '''Make two branches, one with revisions to merge.'''
+        mock1 = MockLPBranch()
+        self.CONFIG_TEMPLATE = CONFIG_TEMPLATE % {
+            'url' : 'file://%s' % mock1.temp_dir,
+            'temp_log' : mock1.temp_dir + '.log',
+            'temp_tree' : mock1.temp_dir
+            }
+        self.write_config_file()
+
+        a_branch = branch.Branch.create(mock1, self.config, create_tree=True)
+        a_branch.commit("Reading, 'riting, 'rithmetic")
+        a_branch.lp_branch.revision_count += 1
+        another_branch = branch.Branch.create(MockLPBranch(
+            source_branch=a_branch.lp_branch), self.config, create_tree=True)
+        another_branch.commit('ABC...')
+        another_branch.commit('...as easy as 123')
+        another_branch.lp_branch.revision_count += 2
+
+        return a_branch, another_branch
+
+    def test_create(self):
+        '''Test the creation of a TarmacBranch instance.'''
+        mock1 = MockLPBranch()
+        self.CONFIG_TEMPLATE = CONFIG_TEMPLATE % {
+            'url' : 'file://%s' % mock1.temp_dir,
+            'temp_log' : mock1.temp_dir + '.log',
+            'temp_tree' : mock1.temp_dir
+            }
+        self.write_config_file()
+
+        self.assertTrue(self.config.has_section('file://%s' % mock1.temp_dir))
+        self.assertEqual(self.config.get('file://%s' % mock1.temp_dir,
+                                         'tree_dir', None),
+                         mock1.temp_dir)
+        a_branch = branch.Branch.create(mock1, self.config)
+
+        self.assertTrue(isinstance(a_branch, branch.Branch))
+        self.assertTrue(a_branch.lp_branch.bzr_identity)
+        self.assertFalse(hasattr(a_branch, 'tree'))
+
+    def test_create_with_tree(self):
+        '''Test the creation of a TarmacBranch with a created tree.'''
+        mock1 = MockLPBranch()
+        self.CONFIG_TEMPLATE = CONFIG_TEMPLATE % {
+            'url' : 'file://%s' % mock1.temp_dir,
+            'temp_log' : mock1.temp_dir + '.log',
+            'temp_tree' : mock1.temp_dir
+            }
+        self.write_config_file()
+
+        a_branch = branch.Branch.create(mock1, self.config,
+                                        create_tree=True)
+
+        self.assertTrue(isinstance(a_branch, branch.Branch))
+        self.assertTrue(a_branch.lp_branch.bzr_identity)
+        self.assertTrue(hasattr(a_branch, 'tree'))
+
+    def test_merge_raises_exception_with_no_tree(self):
+        '''A merge on a branch with no tree will raise an exception.'''
+        a_branch = branch.Branch(MockLPBranch())
+        another_branch = branch.Branch(MockLPBranch())
+
+        self.assertRaises(
+            AttributeError, a_branch.merge, another_branch)
+
+    def test_merge_no_changes(self):
+        '''A merge on a branch with a tree will raise an exception if no
+        changes are present.'''
+        a_branch = branch.Branch.create(MockLPBranch(), self.config,
+                                        create_tree=True)
+        another_branch = branch.Branch(MockLPBranch())
+
+        # XXX: Find a way to generate dummy revisions for the second branch.
+        self.assertRaises(NoCommits, a_branch.merge, another_branch)
+
+    def test_merge(self):
+        '''A merge on a branch with a tree of a branch with changes will merge.
+        '''
+        a_branch, another_branch = self.make_two_branches_to_merge()
+        a_branch.merge(another_branch)
+        self.assertTrue(a_branch.has_changes)
+        a_branch.lp_branch.cleanup()
+        another_branch.lp_branch.cleanup()
+
+    def test_merge_with_authors(self):
+        '''A merge from a branch with authors'''
+        branch1, branch2 = self.make_two_branches_to_merge()
+        authors = [ 'author1', 'author2' ]
+        branch1.commit('Authors test', authors=authors)
+        branch2.merge(branch1)
+        branch2.commit('Authors Merge test', authors=branch1.authors)
+        self.assertEqual(branch2.authors.sort(), authors.sort())
+
+    def test_merge_with_bugs(self):
+        '''A merge from a branch with authors'''
+        branch1, branch2 = self.make_two_branches_to_merge()
+        bugs = ['https://launchpad.net/bugs/1 fixed',
+                'https://bugzilla.gnome.org/show_bug.cgi?id=1 fixed',
+                'https://launchpad.net/bugs/2 fixed'
+                ]
+        revprops = {}
+        revprops['bugs'] = '\n'.join(bugs)
+        branch1.commit('Bugs test', revprops)
+        branch1.commit('Testing')
+        branch2.commit('Foo',
+                       revprops={'bugs':'https://launchpad.net/bugs/3 fixed'})
+        branch2.lp_branch.revision_count += 1
+        branch2.merge(branch1)
+        branch2.commit('Landed bugs')
+        self.assertEqual(branch2.fixed_bugs, branch1.fixed_bugs)
+        branch2.cleanup()
+
+    def test_merge_with_reviewers(self):
+        '''A merge with reviewers.'''
+        reviewers = [ 'reviewer1', 'reviewer2' ]
+
+        a_branch, another_branch = self.make_two_branches_to_merge()
+        a_branch.merge(another_branch)
+        a_branch.commit('Reviewers test', reviewers=reviewers)
+
+        last_rev = a_branch.lp_branch._internal_bzr_branch.last_revision()
+        self.assertNotEquals(last_rev, 'null:')
+        rev = a_branch.lp_branch._internal_bzr_branch.repository.get_revision(
+            last_rev)
+        self.assertEquals('\n'.join(reviewers), rev.properties['reviewers'])
+        a_branch.lp_branch.cleanup()
+        another_branch.lp_branch.cleanup()
+
+    def test_cleanup(self):
+        '''The branch object should clean up after itself.'''
+        a_branch, another_branch = self.make_two_branches_to_merge()
+        a_branch.merge(another_branch)
+        self.assertTrue(a_branch.has_changes)
+
+        a_branch.cleanup()
+        self.assertTrue(a_branch.has_changes)
+
+        a_branch.lp_branch.cleanup()
+        another_branch.lp_branch.cleanup()