autopkg.py 12.8 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.")
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")
Vangelis Koukis's avatar
Vangelis Koukis committed
148
149
150

    (options, args) = parser.parse_args()

Christos Stavrakakis's avatar
Christos Stavrakakis committed
151
152
153
154
155
    if options.help:
        print_help(parser.get_prog_name())
        parser.print_help()
        return

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

165
    # Load the repository
166
    original_repo = utils.get_repository()
Vangelis Koukis's avatar
Vangelis Koukis committed
167

168
    # Check that repository is clean
Christos Stavrakakis's avatar
Christos Stavrakakis committed
169
    toplevel = original_repo.working_dir
Vangelis Koukis's avatar
Vangelis Koukis committed
170
171
172
    if original_repo.is_dirty() and not options.force_dirty:
        raise RuntimeError(red("Repository %s is dirty." % toplevel))

173
    # Get packages from configuration file
174
    config = utils.get_config(options.config_file)
175
    packages = config['packages'].keys()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
176
    print_green("Will build the following packages:\n" + "\n".join(packages))
Vangelis Koukis's avatar
Vangelis Koukis committed
177

Christos Stavrakakis's avatar
Christos Stavrakakis committed
178
    # Get current branch name and type and check if it is a valid one
179
    branch = original_repo.head.reference.name
180
    branch = utils.undebianize(branch)
Christos Stavrakakis's avatar
Fix bug    
Christos Stavrakakis committed
181
    branch_type_str = utils.get_branch_type(branch)
Vangelis Koukis's avatar
Vangelis Koukis committed
182

Christos Stavrakakis's avatar
Christos Stavrakakis committed
183
    if branch_type_str not in BRANCH_TYPES.keys():
Christos Stavrakakis's avatar
Christos Stavrakakis committed
184
        allowed_branches = ", ".join(BRANCH_TYPES.keys())
185
186
187
        raise ValueError("Malformed branch name '%s', cannot classify as"
                         " one of %s" % (branch, allowed_branches))

188
    # Fix needed environment variables
189
    v = utils.get_vcs_info()
190
    os.environ["DEVFLOW_BUILD_MODE"] = mode
191
192
    os.environ["DEBFULLNAME"] = v.name
    os.environ["DEBEMAIL"] = v.email
193

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

197
    # Get the debian branch
198
199
200
201
    if options.debian_branch:
        debian_branch = options.debian_branch
    else:
        debian_branch = utils.get_debian_branch(branch)
202
    origin_debian = "origin/" + debian_branch
203
204
205

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

Christos Stavrakakis's avatar
Christos Stavrakakis committed
210
211
212
213
    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)

214
    # Create the debian branch
Christos Stavrakakis's avatar
Christos Stavrakakis committed
215
    repo.git.branch(debian_branch, origin_debian)
216
217
    print_green("Created branch '%s' to track '%s'" % (debian_branch,
                origin_debian))
Vangelis Koukis's avatar
Vangelis Koukis committed
218

219
    # Go to debian branch
Vangelis Koukis's avatar
Vangelis Koukis committed
220
221
222
    repo.git.checkout(debian_branch)
    print_green("Changed to branch '%s'" % debian_branch)

223
    # Merge with starting branch
Vangelis Koukis's avatar
Vangelis Koukis committed
224
    repo.git.merge(branch)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
225
    print_green("Merged branch '%s' into '%s'" % (branch, debian_branch))
Vangelis Koukis's avatar
Vangelis Koukis committed
226

227
    # Compute python and debian version
Vangelis Koukis's avatar
Vangelis Koukis committed
228
    cd(repo_dir)
229
    python_version = versioning.get_python_version()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
230
    debian_version = versioning.\
Christos Stavrakakis's avatar
Christos Stavrakakis committed
231
        debian_version_from_python_version(python_version)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
232
    print_green("The new debian version will be: '%s'" % debian_version)
Vangelis Koukis's avatar
Vangelis Koukis committed
233

234
    # Update the version files
Christos Stavrakakis's avatar
Christos Stavrakakis committed
235
    versioning.update_version()
236

Christos Stavrakakis's avatar
Christos Stavrakakis committed
237
238
239
240
241
242
243
244
245
246

    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
247
248
    # Tag branch with python version
    branch_tag = python_version
Christos Stavrakakis's avatar
Christos Stavrakakis committed
249
    tag_message = "%s version %s" % (mode.capitalize(), python_version)
250
    try:
Christos Stavrakakis's avatar
Christos Stavrakakis committed
251
        repo.git.tag(branch_tag, branch, sign_tag_opt, "-m=%s" % tag_message)
252
253
254
    except GitCommandError:
        # Tag may already exist, if only the debian branch has changed
        pass
255
256
    upstream_tag = "upstream/" + branch_tag
    repo.git.tag(upstream_tag, branch)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
257

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

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

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

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

Christos Stavrakakis's avatar
Christos Stavrakakis committed
298
    # Create debian packages
Christos Stavrakakis's avatar
Christos Stavrakakis committed
299
    cd(repo_dir)
300
301
302
303
    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
304
305
306
    build_cmd = "git-buildpackage --git-export-dir=%s"\
                " --git-upstream-branch=%s --git-debian-branch=%s"\
                " --git-export=INDEX --git-ignore-new -sa"\
307
308
309
310
                " --source-option='\"--extend-diff-ignore=%s\"'"\
                " --git-upstream-tag=%s"\
                % (build_dir, branch, debian_branch, ignore_regexp,
                   upstream_tag)
311
312
    if options.source_only:
        build_cmd += " -S"
Christos Stavrakakis's avatar
Christos Stavrakakis committed
313
314
    if not options.sign:
        build_cmd += " -uc -us"
315
316
    elif options.keyid:
        build_cmd += " -k\"'%s'\"" % options.keyid
Christos Stavrakakis's avatar
Christos Stavrakakis committed
317
    call(build_cmd)
Vangelis Koukis's avatar
Vangelis Koukis committed
318

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

Christos Stavrakakis's avatar
Christos Stavrakakis committed
324
325
326
327
328
329
330
331
332
    # 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
333

334
    # Print help message
Christos Stavrakakis's avatar
Christos Stavrakakis committed
335
    if mode == "release":
Christos Stavrakakis's avatar
Christos Stavrakakis committed
336
337
338
339
        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
340

Christos Stavrakakis's avatar
Christos Stavrakakis committed
341
342
343
        print_green("To update repositories '%s' and '%s' go to '%s' and run:"
                    % (toplevel, origin, repo_dir))
        for remote in ['origin', 'original_origin']:
344
345
            objects = [debian_branch, branch_tag, debian_branch_tag]
            print_green("git push %s %s" % (remote, " ".join(objects)))
Christos Stavrakakis's avatar
Christos Stavrakakis committed
346
347


348
349
350
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
351
352


353
354
355
def call(cmd):
    rc = os.system(cmd)
    if rc:
Christos Stavrakakis's avatar
Christos Stavrakakis committed
356
        raise RuntimeError("Command '%s' failed!" % cmd)
357
358


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