Added Bug.comments(), BugDir.has_bug() & cleaned up diff.diff().
[be.git] / libbe / diff.py
1 # Copyright (C) 2005 Aaron Bentley and Panometrics, Inc.
2 # <abentley@panoramicfeedback.com>
3 #
4 #    This program is free software; you can redistribute it and/or modify
5 #    it under the terms of the GNU General Public License as published by
6 #    the Free Software Foundation; either version 2 of the License, or
7 #    (at your option) any later version.
8 #
9 #    This program is distributed in the hope that it will be useful,
10 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
11 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 #    GNU General Public License for more details.
13 #
14 #    You should have received a copy of the GNU General Public License
15 #    along with this program; if not, write to the Free Software
16 #    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17 """Compare two bug trees"""
18 from libbe import cmdutil, bugdir
19 from libbe.utility import time_to_str
20 from libbe.bug import cmp_severity
21 import doctest
22
23 def diff(old_bugdir, new_bugdir):
24     added = []
25     removed = []
26     modified = []
27     for uuid in old_bugdir.list_uuids():
28         old_bug = old_bugdir.bug_from_uuid(uuid)
29         try:
30             new_bug = new_bugdir.bug_from_uuid(uuid)
31             if old_bug != new_bug:
32                 modified.append((old_bug, new_bug))
33         except KeyError:
34             removed.append(old_bug)
35     for uuid in new_bugdir.list_uuids():
36         if not old_bugdir.has_bug(uuid):
37             new_bug = new_bugdir.bug_from_uuid(uuid)
38             added.append(new_bug)
39     return (removed, modified, added)
40
41 def diff_report(diff_data, bug_dir):
42     (removed, modified, added) = diff_data
43     def modified_cmp(left, right):
44         return cmp_severity(left[1], right[1])
45
46     added.sort(cmp_severity)
47     removed.sort(cmp_severity)
48     modified.sort(modified_cmp)
49
50     if len(added) > 0:
51         print "New bug reports:"
52         for bug in added:
53             print bug.string(shortlist=True)
54         print ""
55
56     if len(modified) > 0:
57         printed = False
58         for old_bug, new_bug in modified:
59             change_str = bug_changes(old_bug, new_bug, bug_dir)
60             if change_str is None:
61                 continue
62             if not printed:
63                 printed = True
64                 print "Modified bug reports:"
65             print change_str
66         print ""
67
68     if len(removed) > 0: 
69         print "Removed bug reports:"
70         for bug in removed:
71             print bug.string(shortlist=True)
72         print ""
73
74 def change_lines(old, new, attributes):
75     change_list = []    
76     for attr in attributes:
77         old_attr = getattr(old, attr)
78         new_attr = getattr(new, attr)
79         if old_attr != new_attr:
80             change_list.append((attr, old_attr, new_attr))
81     if len(change_list) >= 0:
82         return change_list
83     else:
84         return None
85
86 def bug_changes(old, new, bugs):
87     change_list = change_lines(old, new, ("time", "creator", "severity",
88     "target", "summary", "status", "assigned"))
89
90     old_comment_ids = [c.uuid for c in old.comments()]
91     new_comment_ids = [c.uuid for c in new.comments()]
92     change_strings = ["%s: %s -> %s" % f for f in change_list]
93     for comment_id in new_comment_ids:
94         if comment_id not in old_comment_ids:
95             summary = comment_summary(new.comment_from_uuid(comment_id), "new")
96             change_strings.append(summary)
97     for comment_id in old_comment_ids:
98         if comment_id not in new_comment_ids:
99             summary = comment_summary(new.comment_from_uuid(comment_id),
100                                       "removed")
101             change_strings.append(summary)
102
103     if len(change_strings) == 0:
104         return None
105     return "%s\n  %s" % (new.string(shortlist=True),
106                          "  \n".join(change_strings))
107
108
109 def comment_summary(comment, status):
110     return "%8s comment from %s on %s" % (status, comment.From, 
111                                           time_to_str(comment.time))
112
113 suite = doctest.DocTestSuite()