series.py 9.86 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
# Copyright (c) 2011 The Chromium OS Authors.
#
# See file CREDITS for list of people who contributed to this
# project.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; either version 2 of
# the License, or (at your option) any later version.
#
# This program 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 this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
# MA 02111-1307 USA
#

22
import itertools
23 24
import os

25
import get_maintainer
26 27 28 29
import gitutil
import terminal

# Series-xxx tags that we understand
30
valid_series = ['to', 'cc', 'version', 'changes', 'prefix', 'notes', 'name',
31
                'cover-cc', 'process_log']
32 33 34 35 36 37 38 39 40 41 42

class Series(dict):
    """Holds information about a patch series, including all tags.

    Vars:
        cc: List of aliases/emails to Cc all patches to
        commits: List of Commit objects, one for each patch
        cover: List of lines in the cover letter
        notes: List of lines in the notes
        changes: (dict) List of changes for each version, The key is
            the integer version number
43
        allow_overwrite: Allow tags to overwrite an existing tag
44 45 46 47
    """
    def __init__(self):
        self.cc = []
        self.to = []
48
        self.cover_cc = []
49 50 51 52
        self.commits = []
        self.cover = None
        self.notes = []
        self.changes = {}
53
        self.allow_overwrite = False
54

55 56 57 58 59
        # Written in MakeCcFile()
        #  key: name of patch file
        #  value: list of email addresses
        self._generated_cc = {}

60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
    # These make us more like a dictionary
    def __setattr__(self, name, value):
        self[name] = value

    def __getattr__(self, name):
        return self[name]

    def AddTag(self, commit, line, name, value):
        """Add a new Series-xxx tag along with its value.

        Args:
            line: Source line containing tag (useful for debug/error messages)
            name: Tag name (part after 'Series-')
            value: Tag value (part after 'Series-xxx: ')
        """
        # If we already have it, then add to our list
76
        name = name.replace('-', '_')
77
        if name in self and not self.allow_overwrite:
78 79 80 81 82 83 84 85 86 87 88 89 90
            values = value.split(',')
            values = [str.strip() for str in values]
            if type(self[name]) != type([]):
                raise ValueError("In %s: line '%s': Cannot add another value "
                        "'%s' to series '%s'" %
                            (commit.hash, line, values, self[name]))
            self[name] += values

        # Otherwise just set the value
        elif name in valid_series:
            self[name] = value
        else:
            raise ValueError("In %s: line '%s': Unknown 'Series-%s': valid "
91
                        "options are %s" % (commit.hash, line, name,
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
                            ', '.join(valid_series)))

    def AddCommit(self, commit):
        """Add a commit into our list of commits

        We create a list of tags in the commit subject also.

        Args:
            commit: Commit object to add
        """
        commit.CheckTags()
        self.commits.append(commit)

    def ShowActions(self, args, cmd, process_tags):
        """Show what actions we will/would perform

        Args:
            args: List of patch files we created
            cmd: The git command we would have run
            process_tags: Process tags as if they were aliases
        """
        col = terminal.Color()
        print 'Dry run, so not doing much. But I would do this:'
        print
        print 'Send a total of %d patch%s with %scover letter.' % (
                len(args), '' if len(args) == 1 else 'es',
                self.get('cover') and 'a ' or 'no ')

        # TODO: Colour the patches according to whether they passed checks
        for upto in range(len(args)):
            commit = self.commits[upto]
            print col.Color(col.GREEN, '   %s' % args[upto])
124
            cc_list = list(self._generated_cc[commit.patch])
125

126 127 128 129 130 131 132
            # Skip items in To list
            if 'to' in self:
                try:
                    map(cc_list.remove, gitutil.BuildEmailList(self.to))
                except ValueError:
                    pass

133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
            for email in cc_list:
                if email == None:
                    email = col.Color(col.YELLOW, "<alias '%s' not found>"
                            % tag)
                if email:
                    print '      Cc: ',email
        print
        for item in gitutil.BuildEmailList(self.get('to', '<none>')):
            print 'To:\t ', item
        for item in gitutil.BuildEmailList(self.cc):
            print 'Cc:\t ', item
        print 'Version: ', self.get('version')
        print 'Prefix:\t ', self.get('prefix')
        if self.cover:
            print 'Cover: %d lines' % len(self.cover)
148 149
            cover_cc = gitutil.BuildEmailList(self.get('cover_cc', ''))
            all_ccs = itertools.chain(cover_cc, *self._generated_cc.values())
150 151
            for email in set(all_ccs):
                    print '      Cc: ',email
152 153 154 155 156 157 158 159 160
        if cmd:
            print 'Git command: %s' % cmd

    def MakeChangeLog(self, commit):
        """Create a list of changes for each version.

        Return:
            The change log as a list of strings, one per line

161
            Changes in v4:
162 163
            - Jog the dial back closer to the widget

164 165
            Changes in v3: None
            Changes in v2:
166 167 168 169 170 171
            - Fix the widget
            - Jog the dial

            etc.
        """
        final = []
172 173
        process_it = self.get('process_log', '').split(',')
        process_it = [item.strip() for item in process_it]
174
        need_blank = False
175
        for change in sorted(self.changes, reverse=True):
176 177 178 179
            out = []
            for this_commit, text in self.changes[change]:
                if commit and this_commit != commit:
                    continue
180 181
                if 'uniq' not in process_it or text not in out:
                    out.append(text)
182 183
            line = 'Changes in v%d:' % change
            have_changes = len(out) > 0
184 185
            if 'sort' in process_it:
                out = sorted(out)
186 187 188 189 190 191 192 193
            if have_changes:
                out.insert(0, line)
            else:
                out = [line + ' None']
            if need_blank:
                out.insert(0, '')
            final += out
            need_blank = have_changes
194 195 196 197 198 199 200 201 202 203 204 205
        if self.changes:
            final.append('')
        return final

    def DoChecks(self):
        """Check that each version has a change log

        Print an error if something is wrong.
        """
        col = terminal.Color()
        if self.get('version'):
            changes_copy = dict(self.changes)
206
            for version in range(1, int(self.version) + 1):
207 208 209
                if self.changes.get(version):
                    del changes_copy[version]
                else:
210 211 212
                    if version > 1:
                        str = 'Change log missing for v%d' % version
                        print col.Color(col.RED, str)
213 214 215 216 217 218 219
            for version in changes_copy:
                str = 'Change log for unknown version v%d' % version
                print col.Color(col.RED, str)
        elif self.changes:
            str = 'Change log exists, but no version is set'
            print col.Color(col.RED, str)

220
    def MakeCcFile(self, process_tags, cover_fname, raise_on_error):
221 222
        """Make a cc file for us to use for per-commit Cc automation

223 224
        Also stores in self._generated_cc to make ShowActions() faster.

225 226
        Args:
            process_tags: Process tags as if they were aliases
227
            cover_fname: If non-None the name of the cover letter.
228 229
            raise_on_error: True to raise an error when an alias fails to match,
                False to just print a message.
230 231 232 233 234 235
        Return:
            Filename of temp file created
        """
        # Look for commit tags (of the form 'xxx:' at the start of the subject)
        fname = '/tmp/patman.%d' % os.getpid()
        fd = open(fname, 'w')
236
        all_ccs = []
237 238 239
        for commit in self.commits:
            list = []
            if process_tags:
240 241 242 243
                list += gitutil.BuildEmailList(commit.tags,
                                               raise_on_error=raise_on_error)
            list += gitutil.BuildEmailList(commit.cc_list,
                                           raise_on_error=raise_on_error)
244
            list += get_maintainer.GetMaintainer(commit.patch)
245
            all_ccs += list
246
            print >>fd, commit.patch, ', '.join(list)
247
            self._generated_cc[commit.patch] = list
248

249
        if cover_fname:
250 251
            cover_cc = gitutil.BuildEmailList(self.get('cover_cc', ''))
            print >>fd, cover_fname, ', '.join(set(cover_cc + all_ccs))
252

253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
        fd.close()
        return fname

    def AddChange(self, version, commit, info):
        """Add a new change line to a version.

        This will later appear in the change log.

        Args:
            version: version number to add change list to
            info: change line for this version
        """
        if not self.changes.get(version):
            self.changes[version] = []
        self.changes[version].append([commit, info])

    def GetPatchPrefix(self):
        """Get the patch version string

        Return:
            Patch string, like 'RFC PATCH v5' or just 'PATCH'
        """
        version = ''
        if self.get('version'):
            version = ' v%s' % self['version']

        # Get patch name prefix
        prefix = ''
        if self.get('prefix'):
            prefix = '%s ' % self['prefix']
        return '%sPATCH%s' % (prefix, version)