series.py 9.32 KB
Newer Older
1 2
# Copyright (c) 2011 The Chromium OS Authors.
#
3
# SPDX-License-Identifier:	GPL-2.0+
4 5
#

6
import itertools
7 8
import os

9
import get_maintainer
10 11 12 13
import gitutil
import terminal

# Series-xxx tags that we understand
14
valid_series = ['to', 'cc', 'version', 'changes', 'prefix', 'notes', 'name',
15
                'cover_cc', 'process_log']
16 17 18 19 20 21 22 23 24 25 26

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
27
        allow_overwrite: Allow tags to overwrite an existing tag
28 29 30 31
    """
    def __init__(self):
        self.cc = []
        self.to = []
32
        self.cover_cc = []
33 34 35 36
        self.commits = []
        self.cover = None
        self.notes = []
        self.changes = {}
37
        self.allow_overwrite = False
38

39 40 41 42 43
        # Written in MakeCcFile()
        #  key: name of patch file
        #  value: list of email addresses
        self._generated_cc = {}

44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
    # 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
60
        name = name.replace('-', '_')
61
        if name in self and not self.allow_overwrite:
62 63 64 65 66 67 68 69 70 71 72 73 74
            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 "
75
                        "options are %s" % (commit.hash, line, name,
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
                            ', '.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
        """
97 98 99
        to_set = set(gitutil.BuildEmailList(self.to));
        cc_set = set(gitutil.BuildEmailList(self.cc));

100 101 102 103 104 105 106 107 108 109 110
        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])
111
            cc_list = list(self._generated_cc[commit.patch])
112
            for email in set(cc_list) - to_set - cc_set:
113 114 115 116 117 118
                if email == None:
                    email = col.Color(col.YELLOW, "<alias '%s' not found>"
                            % tag)
                if email:
                    print '      Cc: ',email
        print
119
        for item in to_set:
120
            print 'To:\t ', item
121
        for item in cc_set - to_set:
122 123 124 125 126
            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)
127 128
            cover_cc = gitutil.BuildEmailList(self.get('cover_cc', ''))
            all_ccs = itertools.chain(cover_cc, *self._generated_cc.values())
129
            for email in set(all_ccs) - to_set - cc_set:
130
                    print '      Cc: ',email
131 132 133 134 135 136 137 138 139
        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

140
            Changes in v4:
141 142
            - Jog the dial back closer to the widget

143 144
            Changes in v3: None
            Changes in v2:
145 146 147 148 149 150
            - Fix the widget
            - Jog the dial

            etc.
        """
        final = []
151 152
        process_it = self.get('process_log', '').split(',')
        process_it = [item.strip() for item in process_it]
153
        need_blank = False
154
        for change in sorted(self.changes, reverse=True):
155 156 157 158
            out = []
            for this_commit, text in self.changes[change]:
                if commit and this_commit != commit:
                    continue
159 160
                if 'uniq' not in process_it or text not in out:
                    out.append(text)
161 162
            line = 'Changes in v%d:' % change
            have_changes = len(out) > 0
163 164
            if 'sort' in process_it:
                out = sorted(out)
165 166 167 168 169 170 171 172
            if have_changes:
                out.insert(0, line)
            else:
                out = [line + ' None']
            if need_blank:
                out.insert(0, '')
            final += out
            need_blank = have_changes
173 174 175 176 177 178 179 180 181 182 183 184
        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)
185
            for version in range(1, int(self.version) + 1):
186 187 188
                if self.changes.get(version):
                    del changes_copy[version]
                else:
189 190 191
                    if version > 1:
                        str = 'Change log missing for v%d' % version
                        print col.Color(col.RED, str)
192 193 194 195 196 197 198
            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)

199 200
    def MakeCcFile(self, process_tags, cover_fname, raise_on_error,
                   add_maintainers):
201 202
        """Make a cc file for us to use for per-commit Cc automation

203 204
        Also stores in self._generated_cc to make ShowActions() faster.

205 206
        Args:
            process_tags: Process tags as if they were aliases
207
            cover_fname: If non-None the name of the cover letter.
208 209
            raise_on_error: True to raise an error when an alias fails to match,
                False to just print a message.
210
            add_maintainers: Call the get_maintainers to CC maintainers
211 212 213 214 215 216
        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')
217
        all_ccs = []
218 219 220
        for commit in self.commits:
            list = []
            if process_tags:
221 222 223 224
                list += gitutil.BuildEmailList(commit.tags,
                                               raise_on_error=raise_on_error)
            list += gitutil.BuildEmailList(commit.cc_list,
                                           raise_on_error=raise_on_error)
225 226
	    if add_maintainers:
                list += get_maintainer.GetMaintainer(commit.patch)
227
            all_ccs += list
228
            print >>fd, commit.patch, ', '.join(set(list))
229
            self._generated_cc[commit.patch] = list
230

231
        if cover_fname:
232 233
            cover_cc = gitutil.BuildEmailList(self.get('cover_cc', ''))
            print >>fd, cover_fname, ', '.join(set(cover_cc + all_ccs))
234

235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
        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'
        """
257 258 259 260 261 262
        git_prefix = gitutil.GetDefaultSubjectPrefix()
        if git_prefix:
	    git_prefix = '%s][' % git_prefix
        else:
            git_prefix = ''

263 264 265 266 267 268 269 270
        version = ''
        if self.get('version'):
            version = ' v%s' % self['version']

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