autopkg.py 12.2 KB
Newer Older
1
# Copyright 2012, 2013 GRNET S.A. All rights reserved.
Vangelis Koukis's avatar
Vangelis Koukis committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
#   1. Redistributions of source code must retain the above
#      copyright notice, this list of conditions and the following
#      disclaimer.
#
#   2. Redistributions in binary form must reproduce the above
#      copyright notice, this list of conditions and the following
#      disclaimer in the documentation and/or other materials
#      provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# The views and conclusions contained in the software and
# documentation are those of the authors and should not be
# interpreted as representing official policies, either expressed
# or implied, of GRNET S.A.

Christos Stavrakakis's avatar
Christos Stavrakakis committed
34
35
"""Helper script for automatic build of debian packages."""

Vangelis Koukis's avatar
Vangelis Koukis committed
36
37
import os
import sys
38
39

from git import GitCommandError
Vangelis Koukis's avatar
Vangelis Koukis committed
40
from optparse import OptionParser
Christos Stavrakakis's avatar
Christos Stavrakakis committed
41
from sh import mktemp, cd, rm, git_dch  # pylint: disable=E0611
Vangelis Koukis's avatar
Vangelis Koukis committed
42

43
from devflow import versioning
44
from devflow import utils
45
from devflow import BRANCH_TYPES
Christos Stavrakakis's avatar
Christos Stavrakakis committed
46

47
48
49
50
51
52
if sys.stdout.isatty():
    try:
        import colors
        use_colors = True
    except AttributeError:
        use_colors = False
Christos Stavrakakis's avatar
Christos Stavrakakis committed
53
54
else:
    use_colors = False
55
56
57
58
59
60


if use_colors:
    red = colors.red
    green = colors.green
else:
Vangelis Koukis's avatar
Vangelis Koukis committed
61
62
63
64
65
66
67
68
    red = lambda x: x
    green = lambda x: x

print_red = lambda x: sys.stdout.write(red(x) + "\n")
print_green = lambda x: sys.stdout.write(green(x) + "\n")

AVAILABLE_MODES = ["release", "snapshot"]

Christos Stavrakakis's avatar
Christos Stavrakakis committed
69
70
71
72
73
74
DESCRIPTION = """Tool for automatical build of debian packages.

%(prog)s is a helper script for automatic build of debian packages from
repositories that follow the `git flow` development model
<http://nvie.com/posts/a-successful-git-branching-model/>.

75
76
This script must run from inside a clean git repository and will perform the
following steps:
Christos Stavrakakis's avatar
Christos Stavrakakis committed
77
78
79
80
81
82
83
84
    * Clone your repository to a temporary directory
    * Merge the current branch with the corresponding debian branch
    * Compute the version of the new package and update the python
      version files
    * Create a new entry in debian/changelog, using `git-dch`
    * Create the debian packages, using `git-buildpackage`
    * Tag the appropriate branches if in `release` mode

85
86
87
%(prog)s will work with the packages that are declared in `autopkg.conf`
file, which must exist in the toplevel directory of the git repository.

Christos Stavrakakis's avatar
Christos Stavrakakis committed
88
89
90
91
92
93
"""


def print_help(prog):
    print DESCRIPTION % {"prog": prog}

Vangelis Koukis's avatar
Vangelis Koukis committed
94
95

def main():
96
    from devflow.version import __version__  # pylint: disable=E0611,F0401
Vangelis Koukis's avatar
Vangelis Koukis committed
97
    parser = OptionParser(usage="usage: %prog [options] mode",
Christos Stavrakakis's avatar
Christos Stavrakakis committed
98
99
100
101
102
103
                          version="devflow %s" % __version__,
                          add_help_option=False)
    parser.add_option("-h", "--help",
                      action="store_true",
                      default=False,
                      help="show this help message")
Vangelis Koukis's avatar
Vangelis Koukis committed
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
    parser.add_option("-k", "--keep-repo",
                      action="store_true",
                      dest="keep_repo",
                      default=False,
                      help="Do not delete the cloned repository")
    parser.add_option("-b", "--build-dir",
                      dest="build_dir",
                      default=None,
                      help="Directory to store created pacakges")
    parser.add_option("-r", "--repo-dir",
                      dest="repo_dir",
                      default=None,
                      help="Directory to clone repository")
    parser.add_option("-d", "--dirty",
                      dest="force_dirty",
                      default=False,
                      action="store_true",
                      help="Do not check if working directory is dirty")
122
123
124
    parser.add_option("-c", "--config-file",
                      dest="config_file",
                      help="Override default configuration file")
Christos Stavrakakis's avatar
Christos Stavrakakis committed
125
126
127
128
129
    parser.add_option("--no-sign",
                      dest="sign",
                      action="store_false",
                      default=True,
                      help="Do not sign the packages")
130
131
132
    parser.add_option("--key-id",
                      dest="keyid",
                      help="Use this keyid for gpg signing")
133
134
    parser.add_option("--dist",
                      dest="dist",
135
136
                      default=None,
                      help="Force distribution in Debian changelog"),
137
138
139
140
141
142
    parser.add_option("-S", "--source-only",
                      dest="source_only",
                      default=False,
                      action="store_true",
                      help="Specifies a source-only build, no binary packages"
                           " need to be made.")
Vangelis Koukis's avatar
Vangelis Koukis committed
143
144
145

    (options, args) = parser.parse_args()

Christos Stavrakakis's avatar
Christos Stavrakakis committed
146
147
148
149
150
    if options.help:
        print_help(parser.get_prog_name())
        parser.print_help()
        return

151
    # Get build mode
Christos Stavrakakis's avatar
Christos Stavrakakis committed
152
153
154
    try:
        mode = args[0]
    except IndexError:
155
        mode = utils.get_build_mode()
Vangelis Koukis's avatar
Vangelis Koukis committed
156
157
158
159
    if mode not in AVAILABLE_MODES:
        raise ValueError(red("Invalid argument! Mode must be one: %s"
                         % ", ".join(AVAILABLE_MODES)))

160
    # Load the repository
161
    original_repo = utils.get_repository()
Vangelis Koukis's avatar
Vangelis Koukis committed
162

163
    # Check that repository is clean
Christos Stavrakakis's avatar
Christos Stavrakakis committed
164
    toplevel = original_repo.working_dir
Vangelis Koukis's avatar
Vangelis Koukis committed
165
166
167
    if original_repo.is_dirty() and not options.force_dirty:
        raise RuntimeError(red("Repository %s is dirty." % toplevel))

168
    # Get packages from configuration file
169
    config = utils.get_config(options.config_file)
170
    packages = config['packages'].keys()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
171
    print_green("Will build the following packages:\n" + "\n".join(packages))
Vangelis Koukis's avatar
Vangelis Koukis committed
172

Christos Stavrakakis's avatar
Christos Stavrakakis committed
173
    # Get current branch name and type and check if it is a valid one
174
    branch = original_repo.head.reference.name
175
    branch = utils.undebianize(branch)
Christos Stavrakakis's avatar
Fix bug    
Christos Stavrakakis committed
176
    branch_type_str = utils.get_branch_type(branch)
Vangelis Koukis's avatar
Vangelis Koukis committed
177

Christos Stavrakakis's avatar
Christos Stavrakakis committed
178
    if branch_type_str not in BRANCH_TYPES.keys():
Christos Stavrakakis's avatar
Christos Stavrakakis committed
179
        allowed_branches = ", ".join(BRANCH_TYPES.keys())
180
181
182
        raise ValueError("Malformed branch name '%s', cannot classify as"
                         " one of %s" % (branch, allowed_branches))

183
184
185
    # Fix needed environment variables
    os.environ["DEVFLOW_BUILD_MODE"] = mode
    git_config = original_repo.config_reader()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
186
187
188
189
190
    try:
        os.environ["DEBFULLNAME"] = git_config.get_value("user", "name")
        os.environ["DEBEMAIL"] = git_config.get_value("user", "email")
    except:
        print "Could not load user/email from config"
191

192
193
194
    # Check that base version file and branch are correct
    versioning.get_python_version()

195
196
    # Get the debian branch
    debian_branch = utils.get_debian_branch(branch)
197
    origin_debian = "origin/" + debian_branch
198
199
200

    # Clone the repo
    repo_dir = options.repo_dir or create_temp_directory("df-repo")
Christos Stavrakakis's avatar
Christos Stavrakakis committed
201
    repo_dir = os.path.abspath(repo_dir)
202
    repo = original_repo.clone(repo_dir, branch=branch)
203
    print_green("Cloned repository to '%s'." % repo_dir)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
204

Christos Stavrakakis's avatar
Christos Stavrakakis committed
205
206
207
208
    build_dir = options.build_dir or create_temp_directory("df-build")
    build_dir = os.path.abspath(build_dir)
    print_green("Build directory: '%s'" % build_dir)

209
    # Create the debian branch
Christos Stavrakakis's avatar
Christos Stavrakakis committed
210
    repo.git.branch(debian_branch, origin_debian)
211
212
    print_green("Created branch '%s' to track '%s'" % (debian_branch,
                origin_debian))
Vangelis Koukis's avatar
Vangelis Koukis committed
213

214
    # Go to debian branch
Vangelis Koukis's avatar
Vangelis Koukis committed
215
216
217
    repo.git.checkout(debian_branch)
    print_green("Changed to branch '%s'" % debian_branch)

218
    # Merge with starting branch
Vangelis Koukis's avatar
Vangelis Koukis committed
219
    repo.git.merge(branch)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
220
    print_green("Merged branch '%s' into '%s'" % (branch, debian_branch))
Vangelis Koukis's avatar
Vangelis Koukis committed
221

222
    # Compute python and debian version
Vangelis Koukis's avatar
Vangelis Koukis committed
223
    cd(repo_dir)
224
    python_version = versioning.get_python_version()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
225
    debian_version = versioning.\
Christos Stavrakakis's avatar
Christos Stavrakakis committed
226
        debian_version_from_python_version(python_version)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
227
    print_green("The new debian version will be: '%s'" % debian_version)
Vangelis Koukis's avatar
Vangelis Koukis committed
228

229
    # Update the version files
Christos Stavrakakis's avatar
Christos Stavrakakis committed
230
    versioning.update_version()
231

Christos Stavrakakis's avatar
Christos Stavrakakis committed
232
233
    # Tag branch with python version
    branch_tag = python_version
234
235
236
237
238
    try:
        repo.git.tag(branch_tag, branch)
    except GitCommandError:
        # Tag may already exist, if only the debian branch has changed
        pass
239
240
    upstream_tag = "upstream/" + branch_tag
    repo.git.tag(upstream_tag, branch)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
241

242
    # Update changelog
Vangelis Koukis's avatar
Vangelis Koukis committed
243
    dch = git_dch("--debian-branch=%s" % debian_branch,
Christos Stavrakakis's avatar
Christos Stavrakakis committed
244
245
246
247
248
                  "--git-author",
                  "--ignore-regex=\".*\"",
                  "--multimaint-merge",
                  "--since=HEAD",
                  "--new-version=%s" % debian_version)
Vangelis Koukis's avatar
Vangelis Koukis committed
249
250
    print_green("Successfully ran '%s'" % " ".join(dch.cmd))

251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
    if options.dist is not None:
        distribution = options.dist
    elif mode == "release":
        distribution = utils.get_distribution_codename()
    else:
        distribution = "unstable"

    f = open("debian/changelog", 'r+')
    lines = f.readlines()
    lines[0] = lines[0].replace("UNRELEASED", distribution)
    lines[2] = lines[2].replace("UNRELEASED", "%s build" % mode)
    f.seek(0)
    f.writelines(lines)
    f.close()

Vangelis Koukis's avatar
Vangelis Koukis committed
266
    if mode == "release":
267
        call("vim debian/changelog")
Christos Stavrakakis's avatar
Christos Stavrakakis committed
268
269
270
271
272
273

    # Add changelog to INDEX
    repo.git.add("debian/changelog")
    # Commit Changes
    repo.git.commit("-s", "-a", m="Bump version to %s" % debian_version)
    # Tag debian branch
274
    debian_branch_tag = "debian/" + utils.version_to_tag(debian_version)
275
276
    if mode == "release":
        repo.git.tag(debian_branch_tag)
Vangelis Koukis's avatar
Vangelis Koukis committed
277
278

    # Add version.py files to repo
279
    call("grep \"__version_vcs\" -r . -l -I | xargs git add -f")
Vangelis Koukis's avatar
Vangelis Koukis committed
280

Christos Stavrakakis's avatar
Christos Stavrakakis committed
281
    # Create debian packages
Christos Stavrakakis's avatar
Christos Stavrakakis committed
282
    cd(repo_dir)
283
284
285
286
    version_files = []
    for _, pkg_info in config['packages'].items():
        version_files.append(pkg_info['version_file'])
    ignore_regexp = "|".join(["^(%s)$" % vf for vf in version_files])
Christos Stavrakakis's avatar
Christos Stavrakakis committed
287
288
289
    build_cmd = "git-buildpackage --git-export-dir=%s"\
                " --git-upstream-branch=%s --git-debian-branch=%s"\
                " --git-export=INDEX --git-ignore-new -sa"\
290
291
292
293
                " --source-option='\"--extend-diff-ignore=%s\"'"\
                " --git-upstream-tag=%s"\
                % (build_dir, branch, debian_branch, ignore_regexp,
                   upstream_tag)
294
295
    if options.source_only:
        build_cmd += " -S"
Christos Stavrakakis's avatar
Christos Stavrakakis committed
296
297
    if not options.sign:
        build_cmd += " -uc -us"
298
299
    elif options.keyid:
        build_cmd += " -k\"'%s'\"" % options.keyid
Christos Stavrakakis's avatar
Christos Stavrakakis committed
300
    call(build_cmd)
Vangelis Koukis's avatar
Vangelis Koukis committed
301

302
    # Remove cloned repo
303
    if mode != 'release' and not options.keep_repo:
Vangelis Koukis's avatar
Vangelis Koukis committed
304
305
306
        print_green("Removing cloned repo '%s'." % repo_dir)
        rm("-r", repo_dir)

Christos Stavrakakis's avatar
Christos Stavrakakis committed
307
308
309
310
311
312
313
314
315
    # Print final info
    info = (("Version", debian_version),
            ("Upstream branch", branch),
            ("Upstream tag", branch_tag),
            ("Debian branch", debian_branch),
            ("Debian tag", debian_branch_tag),
            ("Repository directory", repo_dir),
            ("Packages directory", build_dir))
    print_green("\n".join(["%s: %s" % (name, val) for name, val in info]))
Christos Stavrakakis's avatar
Christos Stavrakakis committed
316

317
    # Print help message
Christos Stavrakakis's avatar
Christos Stavrakakis committed
318
    if mode == "release":
Christos Stavrakakis's avatar
Christos Stavrakakis committed
319
320
321
322
        origin = original_repo.remote().url
        repo.create_remote("original_origin", origin)
        print_green("Created remote 'original_origin' for the repository '%s'"
                    % origin)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
323

Christos Stavrakakis's avatar
Christos Stavrakakis committed
324
325
326
        print_green("To update repositories '%s' and '%s' go to '%s' and run:"
                    % (toplevel, origin, repo_dir))
        for remote in ['origin', 'original_origin']:
327
328
            objects = [debian_branch, branch_tag, debian_branch_tag]
            print_green("git push %s %s" % (remote, " ".join(objects)))
Christos Stavrakakis's avatar
Christos Stavrakakis committed
329
330


331
332
333
def create_temp_directory(suffix):
    create_dir_cmd = mktemp("-d", "/tmp/" + suffix + "-XXXXX")
    return create_dir_cmd.stdout.strip()
Vangelis Koukis's avatar
Vangelis Koukis committed
334
335


336
337
338
def call(cmd):
    rc = os.system(cmd)
    if rc:
Christos Stavrakakis's avatar
Christos Stavrakakis committed
339
        raise RuntimeError("Command '%s' failed!" % cmd)
340
341


Vangelis Koukis's avatar
Vangelis Koukis committed
342
343
if __name__ == "__main__":
    sys.exit(main())