autopkg.py 14.3 KB
Newer Older
1
# Copyright 2012-2014 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.

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

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

from git import GitCommandError
Vangelis Koukis's avatar
Vangelis Koukis committed
41
from optparse import OptionParser
42
43
44
45
46
47
48
49
50
51
52
53
from sh import mktemp, cd, rm  # pylint: disable=E0611
from functools import partial
try:
    from sh import git_dch as gbp_dch  # pylint: disable=E0611
    gbp_buildpackage = ['git-buildpackage']
except ImportError:
    # In newer versions of git-buildpackage the executables have changed.
    # Instead of having various git-* executables, there is only a gbp one,
    # which expects the command (dch, buildpackage, etc) as the first argument.
    from sh import gbp  # pylint: disable=E0611
    gbp_dch = partial(gbp, 'dch')
    gbp_buildpackage = ['gbp', 'buildpackage']
Vangelis Koukis's avatar
Vangelis Koukis committed
54

55
from devflow import versioning
56
from devflow import utils
57
from devflow import BRANCH_TYPES
Christos Stavrakakis's avatar
Christos Stavrakakis committed
58

Vangelis Koukis's avatar
Vangelis Koukis committed
59
60
61

AVAILABLE_MODES = ["release", "snapshot"]

Nikos Skalkotos's avatar
Nikos Skalkotos committed
62
DESCRIPTION = """Tool for automatic build of Debian packages.
Christos Stavrakakis's avatar
Christos Stavrakakis committed
63

Nikos Skalkotos's avatar
Nikos Skalkotos committed
64
%(prog)s is a helper script for automatic build of Debian packages from
Christos Stavrakakis's avatar
Christos Stavrakakis committed
65
66
67
repositories that follow the `git flow` development model
<http://nvie.com/posts/a-successful-git-branching-model/>.

68
69
This script must run from inside a clean git repository and will perform the
following steps:
Christos Stavrakakis's avatar
Christos Stavrakakis committed
70
71
72
73
74
    * 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`
Nikos Skalkotos's avatar
Nikos Skalkotos committed
75
    * Create the Debian packages, using `git-buildpackage`
Christos Stavrakakis's avatar
Christos Stavrakakis committed
76
77
    * Tag the appropriate branches if in `release` mode

Nikos Skalkotos's avatar
Nikos Skalkotos committed
78
79
%(prog)s will work with the packages that are declared in `devflow.conf'
file, which must exist in the top-level directory of the git repository.
80

Christos Stavrakakis's avatar
Christos Stavrakakis committed
81
82
83
84
85
86
"""


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

Vangelis Koukis's avatar
Vangelis Koukis committed
87
88

def main():
89
    from devflow.version import __version__  # pylint: disable=E0611,F0401
Vangelis Koukis's avatar
Vangelis Koukis committed
90
    parser = OptionParser(usage="usage: %prog [options] mode",
Christos Stavrakakis's avatar
Christos Stavrakakis committed
91
92
93
94
95
96
                          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
97
98
99
100
101
102
103
104
    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,
Nikos Skalkotos's avatar
Nikos Skalkotos committed
105
                      help="Directory to store created packages")
Vangelis Koukis's avatar
Vangelis Koukis committed
106
107
108
109
110
111
112
113
114
    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")
115
116
117
    parser.add_option("-c", "--config-file",
                      dest="config_file",
                      help="Override default configuration file")
Christos Stavrakakis's avatar
Christos Stavrakakis committed
118
119
120
121
122
    parser.add_option("--no-sign",
                      dest="sign",
                      action="store_false",
                      default=True,
                      help="Do not sign the packages")
123
124
125
    parser.add_option("--key-id",
                      dest="keyid",
                      help="Use this keyid for gpg signing")
126
127
    parser.add_option("--dist",
                      dest="dist",
128
                      default=None,
Christos Stavrakakis's avatar
Christos Stavrakakis committed
129
                      help="Force distribution in Debian changelog")
130
131
132
133
134
135
    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.")
136
137
138
139
140
    parser.add_option("--debian-branch",
                      dest="debian_branch",
                      default=None,
                      help="Use this debian branch, instead of"
                           "auto-discovering the debian branch to use")
141
142
143
144
145
    parser.add_option("--push-back",
                      dest="push_back",
                      default=False,
                      action="store_true",
                      help="Automatically push branches and tags to repo.")
146
147
148
149
150
    parser.add_option("--color",
                      dest="color_output",
                      default="auto",
                      help="Enable/disable colored output. Default mode is" +
                           " auto, available options are yes/no")
Vangelis Koukis's avatar
Vangelis Koukis committed
151
152
153

    (options, args) = parser.parse_args()

154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
    if options.color_output == "yes":
        use_colors = True
    elif options.color_output == "no":
        use_colors = False
    else:
        if sys.stdout.isatty():
            use_colors = True
        else:
            use_colors = False

    red = lambda x: x
    green = lambda x: x

    if use_colors:
        try:
            import colors
            red = colors.red
            green = colors.green
        except AttributeError:
            pass

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

Christos Stavrakakis's avatar
Christos Stavrakakis committed
178
179
180
181
182
    if options.help:
        print_help(parser.get_prog_name())
        parser.print_help()
        return

183
    # Get build mode
Christos Stavrakakis's avatar
Christos Stavrakakis committed
184
185
186
    try:
        mode = args[0]
    except IndexError:
187
        mode = utils.get_build_mode()
Vangelis Koukis's avatar
Vangelis Koukis committed
188
189
190
191
    if mode not in AVAILABLE_MODES:
        raise ValueError(red("Invalid argument! Mode must be one: %s"
                         % ", ".join(AVAILABLE_MODES)))

192
    # Load the repository
193
    original_repo = utils.get_repository()
Vangelis Koukis's avatar
Vangelis Koukis committed
194

195
    # Check that repository is clean
Christos Stavrakakis's avatar
Christos Stavrakakis committed
196
    toplevel = original_repo.working_dir
Vangelis Koukis's avatar
Vangelis Koukis committed
197
198
199
    if original_repo.is_dirty() and not options.force_dirty:
        raise RuntimeError(red("Repository %s is dirty." % toplevel))

200
    # Get packages from configuration file
201
    config = utils.get_config(options.config_file)
202
    packages = config['packages'].keys()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
203
    print_green("Will build the following packages:\n" + "\n".join(packages))
Vangelis Koukis's avatar
Vangelis Koukis committed
204

Christos Stavrakakis's avatar
Christos Stavrakakis committed
205
    # Get current branch name and type and check if it is a valid one
206
    branch = original_repo.head.reference.name
207
    branch = utils.undebianize(branch)
Christos Stavrakakis's avatar
Fix bug    
Christos Stavrakakis committed
208
    branch_type_str = utils.get_branch_type(branch)
Vangelis Koukis's avatar
Vangelis Koukis committed
209

Christos Stavrakakis's avatar
Christos Stavrakakis committed
210
    if branch_type_str not in BRANCH_TYPES.keys():
Christos Stavrakakis's avatar
Christos Stavrakakis committed
211
        allowed_branches = ", ".join(BRANCH_TYPES.keys())
212
213
214
        raise ValueError("Malformed branch name '%s', cannot classify as"
                         " one of %s" % (branch, allowed_branches))

215
    # Fix needed environment variables
216
    v = utils.get_vcs_info()
217
    os.environ["DEVFLOW_BUILD_MODE"] = mode
218
219
    os.environ["DEBFULLNAME"] = v.name
    os.environ["DEBEMAIL"] = v.email
220

221
222
223
    # Check that base version file and branch are correct
    versioning.get_python_version()

224
    # Get the debian branch
225
226
227
228
    if options.debian_branch:
        debian_branch = options.debian_branch
    else:
        debian_branch = utils.get_debian_branch(branch)
229
    origin_debian = "origin/" + debian_branch
230
231
232

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

Christos Stavrakakis's avatar
Christos Stavrakakis committed
237
238
239
240
    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)

241
    # Create the debian branch
Christos Stavrakakis's avatar
Christos Stavrakakis committed
242
    repo.git.branch(debian_branch, origin_debian)
243
244
    print_green("Created branch '%s' to track '%s'" % (debian_branch,
                origin_debian))
Vangelis Koukis's avatar
Vangelis Koukis committed
245

246
    # Go to debian branch
Vangelis Koukis's avatar
Vangelis Koukis committed
247
248
249
    repo.git.checkout(debian_branch)
    print_green("Changed to branch '%s'" % debian_branch)

250
    # Merge with starting branch
Vangelis Koukis's avatar
Vangelis Koukis committed
251
    repo.git.merge(branch)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
252
    print_green("Merged branch '%s' into '%s'" % (branch, debian_branch))
Vangelis Koukis's avatar
Vangelis Koukis committed
253

254
    # Compute python and debian version
Vangelis Koukis's avatar
Vangelis Koukis committed
255
    cd(repo_dir)
256
    python_version = versioning.get_python_version()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
257
    debian_version = versioning.\
Christos Stavrakakis's avatar
Christos Stavrakakis committed
258
        debian_version_from_python_version(python_version)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
259
    print_green("The new debian version will be: '%s'" % debian_version)
Vangelis Koukis's avatar
Vangelis Koukis committed
260

261
    # Update the version files
Christos Stavrakakis's avatar
Christos Stavrakakis committed
262
    versioning.update_version()
263

Christos Stavrakakis's avatar
Christos Stavrakakis committed
264
265
266
267
268
269
270
271
272
    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
273
274
    # Tag branch with python version
    branch_tag = python_version
Christos Stavrakakis's avatar
Christos Stavrakakis committed
275
    tag_message = "%s version %s" % (mode.capitalize(), python_version)
276
    try:
Christos Stavrakakis's avatar
Christos Stavrakakis committed
277
        repo.git.tag(branch_tag, branch, sign_tag_opt, "-m %s" % tag_message)
278
279
280
    except GitCommandError:
        # Tag may already exist, if only the debian branch has changed
        pass
281
282
    upstream_tag = "upstream/" + branch_tag
    repo.git.tag(upstream_tag, branch)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
283

284
    # Update changelog
285
    dch = gbp_dch("--debian-branch=%s" % debian_branch,
Christos Stavrakakis's avatar
Christos Stavrakakis committed
286
287
288
289
290
                  "--git-author",
                  "--ignore-regex=\".*\"",
                  "--multimaint-merge",
                  "--since=HEAD",
                  "--new-version=%s" % debian_version)
Vangelis Koukis's avatar
Vangelis Koukis committed
291
292
    print_green("Successfully ran '%s'" % " ".join(dch.cmd))

293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
    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
308
    if mode == "release":
309
        subprocess.check_call(['editor', "debian/changelog"])
Christos Stavrakakis's avatar
Christos Stavrakakis committed
310
311
312
313

    # Add changelog to INDEX
    repo.git.add("debian/changelog")
    # Commit Changes
314
315
    repo.git.commit("-s", "debian/changelog",
                    m="Bump version to %s" % debian_version)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
316
    # Tag debian branch
317
    debian_branch_tag = "debian/" + utils.version_to_tag(debian_version)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
318
    tag_message = "%s version %s" % (mode.capitalize(), debian_version)
319
    if mode == "release":
Christos Stavrakakis's avatar
Christos Stavrakakis committed
320
        repo.git.tag(debian_branch_tag, sign_tag_opt, "-m %s" % tag_message)
Vangelis Koukis's avatar
Vangelis Koukis committed
321

Christos Stavrakakis's avatar
Christos Stavrakakis committed
322
    # Create debian packages
Christos Stavrakakis's avatar
Christos Stavrakakis committed
323
    cd(repo_dir)
324
325
    version_files = []
    for _, pkg_info in config['packages'].items():
326
327
        if pkg_info.get("version_file"):
            version_files.extend(pkg_info.as_list('version_file'))
328
329

    # Add version.py files to repo
Christos Stavrakakis's avatar
Christos Stavrakakis committed
330
    repo.git.add("-f", *version_files)
331

332
333
    # Export version info to debuilg environment
    os.environ["DEB_DEVFLOW_DEBIAN_VERSION"] = debian_version
334
    os.environ["DEB_DEVFLOW_VERSION"] = python_version
335
336
337
338
339
340
341
342
343
344
345

    args = list(gbp_buildpackage)
    args.extend(["--git-export-dir=%s" % build_dir,
                 "--git-upstream-branch=%s" % branch,
                 "--git-debian-branch=%s" % debian_branch,
                 "--git-export=INDEX",
                 "--git-ignore-new",
                 "-sa",
                 " --source-option=--auto-commit",
                 " --git-upstream-tag=%s" % upstream_tag])

346
    if options.source_only:
347
        args.append("-S")
Christos Stavrakakis's avatar
Christos Stavrakakis committed
348
    if not options.sign:
349
        args.extend(["-uc", "-us"])
350
    elif options.keyid:
351
352
353
        args.append("-k\"'%s'\"" % options.keyid)

    subprocess.check_call(args)
Vangelis Koukis's avatar
Vangelis Koukis committed
354

355
    # Remove cloned repo
356
    if mode != 'release' and not options.keep_repo:
Vangelis Koukis's avatar
Vangelis Koukis committed
357
358
359
        print_green("Removing cloned repo '%s'." % repo_dir)
        rm("-r", repo_dir)

Christos Stavrakakis's avatar
Christos Stavrakakis committed
360
361
362
363
364
365
366
367
368
    # 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
369

370
    # Print help message
Christos Stavrakakis's avatar
Christos Stavrakakis committed
371
    if mode == "release":
Christos Stavrakakis's avatar
Christos Stavrakakis committed
372
373
374
375
        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
376

Christos Stavrakakis's avatar
Christos Stavrakakis committed
377
378
379
        print_green("To update repositories '%s' and '%s' go to '%s' and run:"
                    % (toplevel, origin, repo_dir))
        for remote in ['origin', 'original_origin']:
380
381
            objects = [debian_branch, branch_tag, debian_branch_tag]
            print_green("git push %s %s" % (remote, " ".join(objects)))
382
383
384
385
        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
386
387


388
389
390
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
391
392
393
394


if __name__ == "__main__":
    sys.exit(main())