patman: Add Series-process-log tag to sort/uniq change logs
[karo-tx-uboot.git] / tools / patman / series.py
1 # Copyright (c) 2011 The Chromium OS Authors.
2 #
3 # See file CREDITS for list of people who contributed to this
4 # project.
5 #
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU General Public License as
8 # published by the Free Software Foundation; either version 2 of
9 # the License, or (at your option) any later version.
10 #
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 # GNU General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston,
19 # MA 02111-1307 USA
20 #
21
22 import itertools
23 import os
24
25 import get_maintainer
26 import gitutil
27 import terminal
28
29 # Series-xxx tags that we understand
30 valid_series = ['to', 'cc', 'version', 'changes', 'prefix', 'notes', 'name',
31                 'cover-cc', 'process_log']
32
33 class Series(dict):
34     """Holds information about a patch series, including all tags.
35
36     Vars:
37         cc: List of aliases/emails to Cc all patches to
38         commits: List of Commit objects, one for each patch
39         cover: List of lines in the cover letter
40         notes: List of lines in the notes
41         changes: (dict) List of changes for each version, The key is
42             the integer version number
43     """
44     def __init__(self):
45         self.cc = []
46         self.to = []
47         self.cover_cc = []
48         self.commits = []
49         self.cover = None
50         self.notes = []
51         self.changes = {}
52
53         # Written in MakeCcFile()
54         #  key: name of patch file
55         #  value: list of email addresses
56         self._generated_cc = {}
57
58     # These make us more like a dictionary
59     def __setattr__(self, name, value):
60         self[name] = value
61
62     def __getattr__(self, name):
63         return self[name]
64
65     def AddTag(self, commit, line, name, value):
66         """Add a new Series-xxx tag along with its value.
67
68         Args:
69             line: Source line containing tag (useful for debug/error messages)
70             name: Tag name (part after 'Series-')
71             value: Tag value (part after 'Series-xxx: ')
72         """
73         # If we already have it, then add to our list
74         name = name.replace('-', '_')
75         if name in self:
76             values = value.split(',')
77             values = [str.strip() for str in values]
78             if type(self[name]) != type([]):
79                 raise ValueError("In %s: line '%s': Cannot add another value "
80                         "'%s' to series '%s'" %
81                             (commit.hash, line, values, self[name]))
82             self[name] += values
83
84         # Otherwise just set the value
85         elif name in valid_series:
86             self[name] = value
87         else:
88             raise ValueError("In %s: line '%s': Unknown 'Series-%s': valid "
89                         "options are %s" % (commit.hash, line, name,
90                             ', '.join(valid_series)))
91
92     def AddCommit(self, commit):
93         """Add a commit into our list of commits
94
95         We create a list of tags in the commit subject also.
96
97         Args:
98             commit: Commit object to add
99         """
100         commit.CheckTags()
101         self.commits.append(commit)
102
103     def ShowActions(self, args, cmd, process_tags):
104         """Show what actions we will/would perform
105
106         Args:
107             args: List of patch files we created
108             cmd: The git command we would have run
109             process_tags: Process tags as if they were aliases
110         """
111         col = terminal.Color()
112         print 'Dry run, so not doing much. But I would do this:'
113         print
114         print 'Send a total of %d patch%s with %scover letter.' % (
115                 len(args), '' if len(args) == 1 else 'es',
116                 self.get('cover') and 'a ' or 'no ')
117
118         # TODO: Colour the patches according to whether they passed checks
119         for upto in range(len(args)):
120             commit = self.commits[upto]
121             print col.Color(col.GREEN, '   %s' % args[upto])
122             cc_list = list(self._generated_cc[commit.patch])
123
124             # Skip items in To list
125             if 'to' in self:
126                 try:
127                     map(cc_list.remove, gitutil.BuildEmailList(self.to))
128                 except ValueError:
129                     pass
130
131             for email in cc_list:
132                 if email == None:
133                     email = col.Color(col.YELLOW, "<alias '%s' not found>"
134                             % tag)
135                 if email:
136                     print '      Cc: ',email
137         print
138         for item in gitutil.BuildEmailList(self.get('to', '<none>')):
139             print 'To:\t ', item
140         for item in gitutil.BuildEmailList(self.cc):
141             print 'Cc:\t ', item
142         print 'Version: ', self.get('version')
143         print 'Prefix:\t ', self.get('prefix')
144         if self.cover:
145             print 'Cover: %d lines' % len(self.cover)
146             cover_cc = gitutil.BuildEmailList(self.get('cover_cc', ''))
147             all_ccs = itertools.chain(cover_cc, *self._generated_cc.values())
148             for email in set(all_ccs):
149                     print '      Cc: ',email
150         if cmd:
151             print 'Git command: %s' % cmd
152
153     def MakeChangeLog(self, commit):
154         """Create a list of changes for each version.
155
156         Return:
157             The change log as a list of strings, one per line
158
159             Changes in v4:
160             - Jog the dial back closer to the widget
161
162             Changes in v3: None
163             Changes in v2:
164             - Fix the widget
165             - Jog the dial
166
167             etc.
168         """
169         final = []
170         process_it = self.get('process_log', '').split(',')
171         process_it = [item.strip() for item in process_it]
172         need_blank = False
173         for change in sorted(self.changes, reverse=True):
174             out = []
175             for this_commit, text in self.changes[change]:
176                 if commit and this_commit != commit:
177                     continue
178                 if 'uniq' not in process_it or text not in out:
179                     out.append(text)
180             line = 'Changes in v%d:' % change
181             have_changes = len(out) > 0
182             if 'sort' in process_it:
183                 out = sorted(out)
184             if have_changes:
185                 out.insert(0, line)
186             else:
187                 out = [line + ' None']
188             if need_blank:
189                 out.insert(0, '')
190             final += out
191             need_blank = have_changes
192         if self.changes:
193             final.append('')
194         return final
195
196     def DoChecks(self):
197         """Check that each version has a change log
198
199         Print an error if something is wrong.
200         """
201         col = terminal.Color()
202         if self.get('version'):
203             changes_copy = dict(self.changes)
204             for version in range(1, int(self.version) + 1):
205                 if self.changes.get(version):
206                     del changes_copy[version]
207                 else:
208                     if version > 1:
209                         str = 'Change log missing for v%d' % version
210                         print col.Color(col.RED, str)
211             for version in changes_copy:
212                 str = 'Change log for unknown version v%d' % version
213                 print col.Color(col.RED, str)
214         elif self.changes:
215             str = 'Change log exists, but no version is set'
216             print col.Color(col.RED, str)
217
218     def MakeCcFile(self, process_tags, cover_fname, raise_on_error):
219         """Make a cc file for us to use for per-commit Cc automation
220
221         Also stores in self._generated_cc to make ShowActions() faster.
222
223         Args:
224             process_tags: Process tags as if they were aliases
225             cover_fname: If non-None the name of the cover letter.
226             raise_on_error: True to raise an error when an alias fails to match,
227                 False to just print a message.
228         Return:
229             Filename of temp file created
230         """
231         # Look for commit tags (of the form 'xxx:' at the start of the subject)
232         fname = '/tmp/patman.%d' % os.getpid()
233         fd = open(fname, 'w')
234         all_ccs = []
235         for commit in self.commits:
236             list = []
237             if process_tags:
238                 list += gitutil.BuildEmailList(commit.tags,
239                                                raise_on_error=raise_on_error)
240             list += gitutil.BuildEmailList(commit.cc_list,
241                                            raise_on_error=raise_on_error)
242             list += get_maintainer.GetMaintainer(commit.patch)
243             all_ccs += list
244             print >>fd, commit.patch, ', '.join(list)
245             self._generated_cc[commit.patch] = list
246
247         if cover_fname:
248             cover_cc = gitutil.BuildEmailList(self.get('cover_cc', ''))
249             print >>fd, cover_fname, ', '.join(set(cover_cc + all_ccs))
250
251         fd.close()
252         return fname
253
254     def AddChange(self, version, commit, info):
255         """Add a new change line to a version.
256
257         This will later appear in the change log.
258
259         Args:
260             version: version number to add change list to
261             info: change line for this version
262         """
263         if not self.changes.get(version):
264             self.changes[version] = []
265         self.changes[version].append([commit, info])
266
267     def GetPatchPrefix(self):
268         """Get the patch version string
269
270         Return:
271             Patch string, like 'RFC PATCH v5' or just 'PATCH'
272         """
273         version = ''
274         if self.get('version'):
275             version = ' v%s' % self['version']
276
277         # Get patch name prefix
278         prefix = ''
279         if self.get('prefix'):
280             prefix = '%s ' % self['prefix']
281         return '%sPATCH%s' % (prefix, version)