autopkg.py 13.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
                      default=None,
Christos Stavrakakis's avatar
Christos Stavrakakis committed
136
                      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.")
143
144
145
146
147
    parser.add_option("--debian-branch",
                      dest="debian_branch",
                      default=None,
                      help="Use this debian branch, instead of"
                           "auto-discovering the debian branch to use")
148
149
150
151
152
    parser.add_option("--push-back",
                      dest="push_back",
                      default=False,
                      action="store_true",
                      help="Automatically push branches and tags to repo.")
Vangelis Koukis's avatar
Vangelis Koukis committed
153
154
155

    (options, args) = parser.parse_args()

Christos Stavrakakis's avatar
Christos Stavrakakis committed
156
157
158
159
160
    if options.help:
        print_help(parser.get_prog_name())
        parser.print_help()
        return

161
    # Get build mode
Christos Stavrakakis's avatar
Christos Stavrakakis committed
162
163
164
    try:
        mode = args[0]
    except IndexError:
165
        mode = utils.get_build_mode()
Vangelis Koukis's avatar
Vangelis Koukis committed
166
167
168
169
    if mode not in AVAILABLE_MODES:
        raise ValueError(red("Invalid argument! Mode must be one: %s"
                         % ", ".join(AVAILABLE_MODES)))

170
    # Load the repository
171
    original_repo = utils.get_repository()
Vangelis Koukis's avatar
Vangelis Koukis committed
172

173
    # Check that repository is clean
Christos Stavrakakis's avatar
Christos Stavrakakis committed
174
    toplevel = original_repo.working_dir
Vangelis Koukis's avatar
Vangelis Koukis committed
175
176
177
    if original_repo.is_dirty() and not options.force_dirty:
        raise RuntimeError(red("Repository %s is dirty." % toplevel))

178
    # Get packages from configuration file
179
    config = utils.get_config(options.config_file)
180
    packages = config['packages'].keys()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
181
    print_green("Will build the following packages:\n" + "\n".join(packages))
Vangelis Koukis's avatar
Vangelis Koukis committed
182

Christos Stavrakakis's avatar
Christos Stavrakakis committed
183
    # Get current branch name and type and check if it is a valid one
184
    branch = original_repo.head.reference.name
185
    branch = utils.undebianize(branch)
Christos Stavrakakis's avatar
Fix bug    
Christos Stavrakakis committed
186
    branch_type_str = utils.get_branch_type(branch)
Vangelis Koukis's avatar
Vangelis Koukis committed
187

Christos Stavrakakis's avatar
Christos Stavrakakis committed
188
    if branch_type_str not in BRANCH_TYPES.keys():
Christos Stavrakakis's avatar
Christos Stavrakakis committed
189
        allowed_branches = ", ".join(BRANCH_TYPES.keys())
190
191
192
        raise ValueError("Malformed branch name '%s', cannot classify as"
                         " one of %s" % (branch, allowed_branches))

193
    # Fix needed environment variables
194
    v = utils.get_vcs_info()
195
    os.environ["DEVFLOW_BUILD_MODE"] = mode
196
197
    os.environ["DEBFULLNAME"] = v.name
    os.environ["DEBEMAIL"] = v.email
198

199
200
201
    # Check that base version file and branch are correct
    versioning.get_python_version()

202
    # Get the debian branch
203
204
205
206
    if options.debian_branch:
        debian_branch = options.debian_branch
    else:
        debian_branch = utils.get_debian_branch(branch)
207
    origin_debian = "origin/" + debian_branch
208
209
210

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

Christos Stavrakakis's avatar
Christos Stavrakakis committed
215
216
217
218
    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)

219
    # Create the debian branch
Christos Stavrakakis's avatar
Christos Stavrakakis committed
220
    repo.git.branch(debian_branch, origin_debian)
221
222
    print_green("Created branch '%s' to track '%s'" % (debian_branch,
                origin_debian))
Vangelis Koukis's avatar
Vangelis Koukis committed
223

224
    # Go to debian branch
Vangelis Koukis's avatar
Vangelis Koukis committed
225
226
227
    repo.git.checkout(debian_branch)
    print_green("Changed to branch '%s'" % debian_branch)

228
    # Merge with starting branch
Vangelis Koukis's avatar
Vangelis Koukis committed
229
    repo.git.merge(branch)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
230
    print_green("Merged branch '%s' into '%s'" % (branch, debian_branch))
Vangelis Koukis's avatar
Vangelis Koukis committed
231

232
    # Compute python and debian version
Vangelis Koukis's avatar
Vangelis Koukis committed
233
    cd(repo_dir)
234
    python_version = versioning.get_python_version()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
235
    debian_version = versioning.\
Christos Stavrakakis's avatar
Christos Stavrakakis committed
236
        debian_version_from_python_version(python_version)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
237
    print_green("The new debian version will be: '%s'" % debian_version)
Vangelis Koukis's avatar
Vangelis Koukis committed
238

239
    # Update the version files
Christos Stavrakakis's avatar
Christos Stavrakakis committed
240
    versioning.update_version()
241

Christos Stavrakakis's avatar
Christos Stavrakakis committed
242
243
244
245
246
247
248
249
250
    if not options.sign:
        sign_tag_opt = None
    elif options.keyid:
        sign_tag_opt = "-u=%s" % options.keyid
    elif mode == "release":
        sign_tag_opt = "-s"
    else:
        sign_tag_opt = None

Christos Stavrakakis's avatar
Christos Stavrakakis committed
251
252
    # Tag branch with python version
    branch_tag = python_version
Christos Stavrakakis's avatar
Christos Stavrakakis committed
253
    tag_message = "%s version %s" % (mode.capitalize(), python_version)
254
    try:
Christos Stavrakakis's avatar
Christos Stavrakakis committed
255
        repo.git.tag(branch_tag, branch, sign_tag_opt, "-m=%s" % tag_message)
256
257
258
    except GitCommandError:
        # Tag may already exist, if only the debian branch has changed
        pass
259
260
    upstream_tag = "upstream/" + branch_tag
    repo.git.tag(upstream_tag, branch)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
261

262
    # Update changelog
Vangelis Koukis's avatar
Vangelis Koukis committed
263
    dch = git_dch("--debian-branch=%s" % debian_branch,
Christos Stavrakakis's avatar
Christos Stavrakakis committed
264
265
266
267
268
                  "--git-author",
                  "--ignore-regex=\".*\"",
                  "--multimaint-merge",
                  "--since=HEAD",
                  "--new-version=%s" % debian_version)
Vangelis Koukis's avatar
Vangelis Koukis committed
269
270
    print_green("Successfully ran '%s'" % " ".join(dch.cmd))

271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
    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
286
    if mode == "release":
287
        call("vim debian/changelog")
Christos Stavrakakis's avatar
Christos Stavrakakis committed
288
289
290
291
292
293

    # 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
294
    debian_branch_tag = "debian/" + utils.version_to_tag(debian_version)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
295
    tag_message = "%s version %s" % (mode.capitalize(), debian_version)
296
    if mode == "release":
Christos Stavrakakis's avatar
Christos Stavrakakis committed
297
        repo.git.tag(debian_branch_tag, sign_tag_opt, "-m=%s" % tag_message)
Vangelis Koukis's avatar
Vangelis Koukis committed
298
299

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

Christos Stavrakakis's avatar
Christos Stavrakakis committed
302
    # Create debian packages
Christos Stavrakakis's avatar
Christos Stavrakakis committed
303
    cd(repo_dir)
304
305
306
    version_files = []
    for _, pkg_info in config['packages'].items():
        version_files.append(pkg_info['version_file'])
307
308
    # Export version info to debuilg environment
    os.environ["DEB_DEVFLOW_DEBIAN_VERSION"] = debian_version
Christos Stavrakakis's avatar
Christos Stavrakakis committed
309
310
311
    build_cmd = "git-buildpackage --git-export-dir=%s"\
                " --git-upstream-branch=%s --git-debian-branch=%s"\
                " --git-export=INDEX --git-ignore-new -sa"\
312
                " --source-option=--auto-commit"\
313
                " --git-upstream-tag=%s"\
314
                % (build_dir, branch, debian_branch, upstream_tag)
315
316
    if options.source_only:
        build_cmd += " -S"
Christos Stavrakakis's avatar
Christos Stavrakakis committed
317
318
    if not options.sign:
        build_cmd += " -uc -us"
319
320
    elif options.keyid:
        build_cmd += " -k\"'%s'\"" % options.keyid
Christos Stavrakakis's avatar
Christos Stavrakakis committed
321
    call(build_cmd)
Vangelis Koukis's avatar
Vangelis Koukis committed
322

323
    # Remove cloned repo
324
    if mode != 'release' and not options.keep_repo:
Vangelis Koukis's avatar
Vangelis Koukis committed
325
326
327
        print_green("Removing cloned repo '%s'." % repo_dir)
        rm("-r", repo_dir)

Christos Stavrakakis's avatar
Christos Stavrakakis committed
328
329
330
331
332
333
334
335
336
    # 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
337

338
    # Print help message
Christos Stavrakakis's avatar
Christos Stavrakakis committed
339
    if mode == "release":
Christos Stavrakakis's avatar
Christos Stavrakakis committed
340
341
342
343
        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
344

Christos Stavrakakis's avatar
Christos Stavrakakis committed
345
346
347
        print_green("To update repositories '%s' and '%s' go to '%s' and run:"
                    % (toplevel, origin, repo_dir))
        for remote in ['origin', 'original_origin']:
348
349
            objects = [debian_branch, branch_tag, debian_branch_tag]
            print_green("git push %s %s" % (remote, " ".join(objects)))
350
351
352
353
        if options.push_back:
            objects = [debian_branch, branch_tag, debian_branch_tag]
            repo.git.push("origin", *objects)
            print_green("Automatically updated origin repo.")
Christos Stavrakakis's avatar
Christos Stavrakakis committed
354
355


356
357
358
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
359
360


361
362
363
def call(cmd):
    rc = os.system(cmd)
    if rc:
Christos Stavrakakis's avatar
Christos Stavrakakis committed
364
        raise RuntimeError("Command '%s' failed!" % cmd)
365
366


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