autopkg.py 11.6 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
34
35
36
37
#
# 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.

import git
import os
import sys
from optparse import OptionParser
38
39
from collections import namedtuple
from sh import mktemp, cd, rm, git_dch, python
40
from configobj import ConfigObj
Vangelis Koukis's avatar
Vangelis Koukis committed
41

42
from devflow import versioning
Christos Stavrakakis's avatar
Christos Stavrakakis committed
43

Vangelis Koukis's avatar
Vangelis Koukis committed
44
45
46
47
48
49
50
51
52
53
54
try:
    from colors import red, green
except ImportError:
    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"]

55
56
57
58
59
60
61
62
branch_type = namedtuple("branch_type", ["default_debian_branch"])
BRANCH_TYPES = {
    "feature": branch_type("debian-develop"),
    "develop": branch_type("debian-develop"),
    "release": branch_type("debian-develop"),
    "master": branch_type("debian"),
    "hotfix": branch_type("debian")}

Christos Stavrakakis's avatar
Christos Stavrakakis committed
63

Christos Stavrakakis's avatar
Christos Stavrakakis committed
64
65
66
67
68
69
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/>.

70
71
This script must run from inside a clean git repository and will perform the
following steps:
Christos Stavrakakis's avatar
Christos Stavrakakis committed
72
73
74
75
76
77
78
79
    * 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

80
81
82
%(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
83
84
85
86
87
88
"""


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

Vangelis Koukis's avatar
Vangelis Koukis committed
89
90
91
92

def main():
    from devflow.version import __version__
    parser = OptionParser(usage="usage: %prog [options] mode",
Christos Stavrakakis's avatar
Christos Stavrakakis committed
93
94
95
96
97
98
                          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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
    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")
117
118
119
    parser.add_option("-c", "--config-file",
                      dest="config_file",
                      help="Override default configuration file")
Christos Stavrakakis's avatar
Christos Stavrakakis committed
120
121
122
123
124
    parser.add_option("--no-sign",
                      dest="sign",
                      action="store_false",
                      default=True,
                      help="Do not sign the packages")
125
126
127
    parser.add_option("--key-id",
                      dest="keyid",
                      help="Use this keyid for gpg signing")
128
129
130
131
132
133
134
    parser.add_option("--dist",
                      dest="dist",
                      default="unstable",
                      help="If running in snapshot mode, automatically set"
                            " the changelog distribution to this value"
                            " (default=unstable).")

Vangelis Koukis's avatar
Vangelis Koukis committed
135
136
    (options, args) = parser.parse_args()

Christos Stavrakakis's avatar
Christos Stavrakakis committed
137
138
139
140
141
    if options.help:
        print_help(parser.get_prog_name())
        parser.print_help()
        return

142
    # Get build mode
Christos Stavrakakis's avatar
Christos Stavrakakis committed
143
144
145
146
147
    try:
        mode = args[0]
    except IndexError:
        raise ValueError("Mode argument is mandatory. Usage: %s"
                         % parser.usage)
Vangelis Koukis's avatar
Vangelis Koukis committed
148
149
150
151
    if mode not in AVAILABLE_MODES:
        raise ValueError(red("Invalid argument! Mode must be one: %s"
                         % ", ".join(AVAILABLE_MODES)))

152
    os.environ["DEVFLOW_BUILD_MODE"] = mode
Vangelis Koukis's avatar
Vangelis Koukis committed
153

154
    # Load the repository
Vangelis Koukis's avatar
Vangelis Koukis committed
155
156
157
158
159
    try:
        original_repo = git.Repo(".")
    except git.git.InvalidGitRepositoryError:
        raise RuntimeError(red("Current directory is not git repository."))

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

165
    # Get packages from configuration file
166
167
168
    config_file = options.config_file or os.path.join(toplevel, "devflow.conf")
    config = ConfigObj(config_file)
    packages = config['packages'].keys()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
169
    print_green("Will build the following packages:\n" + "\n".join(packages))
Christos Stavrakakis's avatar
Christos Stavrakakis committed
170

171
    # Clone the repo
Christos Stavrakakis's avatar
Christos Stavrakakis committed
172
    repo_dir = options.repo_dir or create_temp_directory("df-repo")
Vangelis Koukis's avatar
Vangelis Koukis committed
173
    repo = original_repo.clone(repo_dir)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
174
    print_green("Cloned repository to '%s'." % repo_dir)
Vangelis Koukis's avatar
Vangelis Koukis committed
175

Christos Stavrakakis's avatar
Christos Stavrakakis committed
176
    # Get current branch name and type and check if it is a valid one
Vangelis Koukis's avatar
Vangelis Koukis committed
177
    branch = repo.head.reference.name
Christos Stavrakakis's avatar
Christos Stavrakakis committed
178
179
180
181
    branch_type = versioning.get_branch_type(branch)

    if branch_type not in BRANCH_TYPES.keys():
        allowed_branches = ", ".join(BRANCH_TYPES.keys())
182
183
184
        raise ValueError("Malformed branch name '%s', cannot classify as"
                         " one of %s" % (branch, allowed_branches))

Christos Stavrakakis's avatar
Christos Stavrakakis committed
185
186
    # Find the debian branch
    debian_branch = "debian-" + branch
187
188
189
    origin_debian = "origin/" + debian_branch
    if not origin_debian in repo.references:
        # Get default debian branch
Christos Stavrakakis's avatar
Christos Stavrakakis committed
190
191
192
193
        default_debian = BRANCH_TYPES[branch_type].default_debian_branch
        origin_debian = "origin/" + default_debian

    repo.git.branch(debian_branch, origin_debian)
194
195
    print_green("Created branch '%s' to track '%s'" % (debian_branch,
                origin_debian))
Vangelis Koukis's avatar
Vangelis Koukis committed
196

197
    # Go to debian branch
Vangelis Koukis's avatar
Vangelis Koukis committed
198
199
200
    repo.git.checkout(debian_branch)
    print_green("Changed to branch '%s'" % debian_branch)

201
    # Merge with starting branch
Vangelis Koukis's avatar
Vangelis Koukis committed
202
    repo.git.merge(branch)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
203
    print_green("Merged branch '%s' into '%s'" % (branch, debian_branch))
Vangelis Koukis's avatar
Vangelis Koukis committed
204

205
    # Compute python and debian version
Vangelis Koukis's avatar
Vangelis Koukis committed
206
    cd(repo_dir)
207
    python_version = versioning.get_python_version()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
208
    debian_version = versioning.\
Christos Stavrakakis's avatar
Christos Stavrakakis committed
209
        debian_version_from_python_version(python_version)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
210
    print_green("The new debian version will be: '%s'" % debian_version)
Vangelis Koukis's avatar
Vangelis Koukis committed
211

212
213
214
    # Update the version files
    python("update_version.py", _out=sys.stdout)

Christos Stavrakakis's avatar
Christos Stavrakakis committed
215
216
217
    # Tag branch with python version
    branch_tag = python_version
    repo.git.tag(branch_tag, branch)
218
219
    upstream_tag = "upstream/" + branch_tag
    repo.git.tag(upstream_tag, branch)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
220

221
    # Update changelog
Vangelis Koukis's avatar
Vangelis Koukis committed
222
    dch = git_dch("--debian-branch=%s" % debian_branch,
Christos Stavrakakis's avatar
Christos Stavrakakis committed
223
224
225
226
227
                  "--git-author",
                  "--ignore-regex=\".*\"",
                  "--multimaint-merge",
                  "--since=HEAD",
                  "--new-version=%s" % debian_version)
Vangelis Koukis's avatar
Vangelis Koukis committed
228
229
230
    print_green("Successfully ran '%s'" % " ".join(dch.cmd))

    if mode == "release":
231
        call("vim debian/changelog")
232
233
234
    else:
        f = open("debian/changelog", 'r+')
        lines = f.readlines()
235
        lines[0] = lines[0].replace("UNRELEASED", options.dist)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
236
        lines[2] = lines[2].replace("UNRELEASED", "Snapshot build")
237
238
239
        f.seek(0)
        f.writelines(lines)
        f.close()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
240
241
242
243
244
245
246
247

    # 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
    debian_branch_tag = "debian/" + branch_tag
    repo.git.tag(debian_branch_tag)
Vangelis Koukis's avatar
Vangelis Koukis committed
248
249

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

Christos Stavrakakis's avatar
Christos Stavrakakis committed
252
253
254
    # Create debian packages
    build_dir = options.build_dir or create_temp_directory("df-build")
    print_green("Build directory: '%s'" % build_dir)
Vangelis Koukis's avatar
Vangelis Koukis committed
255

Christos Stavrakakis's avatar
Christos Stavrakakis committed
256
    cd(repo_dir)
257
258
259
260
    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
261
262
263
    build_cmd = "git-buildpackage --git-export-dir=%s"\
                " --git-upstream-branch=%s --git-debian-branch=%s"\
                " --git-export=INDEX --git-ignore-new -sa"\
264
265
266
267
                " --source-option='\"--extend-diff-ignore=%s\"'"\
                " --git-upstream-tag=%s"\
                % (build_dir, branch, debian_branch, ignore_regexp,
                   upstream_tag)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
268
269
    if not options.sign:
        build_cmd += " -uc -us"
270
271
    elif options.keyid:
        build_cmd += " -k\"'%s'\"" % options.keyid
Christos Stavrakakis's avatar
Christos Stavrakakis committed
272
    call(build_cmd)
Vangelis Koukis's avatar
Vangelis Koukis committed
273

274
    # Remove cloned repo
275
    if mode != 'release' and not options.keep_repo:
Vangelis Koukis's avatar
Vangelis Koukis committed
276
277
278
        print_green("Removing cloned repo '%s'." % repo_dir)
        rm("-r", repo_dir)

Christos Stavrakakis's avatar
Christos Stavrakakis committed
279
280
281
282
283
284
285
286
287
    # 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
288

289
    # Print help message
Christos Stavrakakis's avatar
Christos Stavrakakis committed
290
    if mode == "release":
Christos Stavrakakis's avatar
Christos Stavrakakis committed
291
292
293
294
        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
295

Christos Stavrakakis's avatar
Christos Stavrakakis committed
296
297
298
299
300
301
        print_green("To update repositories '%s' and '%s' go to '%s' and run:"
                    % (toplevel, origin, repo_dir))
        for remote in ['origin', 'original_origin']:
            print
            for obj in [debian_branch, branch_tag, debian_branch_tag]:
                print_green("git push %s %s" % (remote, obj))
Vangelis Koukis's avatar
Vangelis Koukis committed
302
303


304
305
306
307
308
def create_temp_directory(suffix):
    create_dir_cmd = mktemp("-d", "/tmp/" + suffix + "-XXXXX")
    return create_dir_cmd.stdout.strip()


309
310
311
def call(cmd):
    rc = os.system(cmd)
    if rc:
Christos Stavrakakis's avatar
Christos Stavrakakis committed
312
        raise RuntimeError("Command '%s' failed!" % cmd)
313

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