autopkg.py 11.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
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
Vangelis Koukis's avatar
Vangelis Koukis committed
40

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

Vangelis Koukis's avatar
Vangelis Koukis committed
43
44
45
46
47
48
49
50
51
52
53
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"]

54
55
56
57
58
59
60
61
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
62

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

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

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


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

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

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

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

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

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

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

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

164
165
166
    # Get packages from configuration file
    config_file = options.config_file or os.path.join(toplevel, "autopkg.conf")
    packages = get_packages_to_build(config_file)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
167
    print_green("Will build the following packages:\n" + "\n".join(packages))
Christos Stavrakakis's avatar
Christos Stavrakakis committed
168

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

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

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

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

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

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

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

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

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

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

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

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

    # 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
246
247

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

Christos Stavrakakis's avatar
Christos Stavrakakis committed
250
251
252
    # 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
253

Christos Stavrakakis's avatar
Christos Stavrakakis committed
254
    cd(repo_dir)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
255
256
257
258
259
260
261
    build_cmd = "git-buildpackage --git-export-dir=%s"\
                " --git-upstream-branch=%s --git-debian-branch=%s"\
                " --git-export=INDEX --git-ignore-new -sa"\
                " -i\/version\.py --git-upstream-tag=%s"\
                % (build_dir, branch, debian_branch, upstream_tag)
    if not options.sign:
        build_cmd += " -uc -us"
262
263
    elif options.keyid:
        build_cmd += " -k\"'%s'\"" % options.keyid
Christos Stavrakakis's avatar
Christos Stavrakakis committed
264
    call(build_cmd)
Vangelis Koukis's avatar
Vangelis Koukis committed
265

266
    # Remove cloned repo
267
    if mode != 'release' and not options.keep_repo:
Vangelis Koukis's avatar
Vangelis Koukis committed
268
269
270
        print_green("Removing cloned repo '%s'." % repo_dir)
        rm("-r", repo_dir)

Christos Stavrakakis's avatar
Christos Stavrakakis committed
271
272
273
274
275
276
277
278
279
    # 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
280

281
    # Print help message
Christos Stavrakakis's avatar
Christos Stavrakakis committed
282
    if mode == "release":
Christos Stavrakakis's avatar
Christos Stavrakakis committed
283
284
285
286
        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
287

Christos Stavrakakis's avatar
Christos Stavrakakis committed
288
289
290
291
292
293
        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
294
295


296
297
298
299
def get_packages_to_build(config_file):
    config_file = os.path.abspath(config_file)
    try:
        f = open(config_file)
300
    except IOError as e:
Christos Stavrakakis's avatar
Christos Stavrakakis committed
301
        raise IOError("Can not access configuration file '%s': %s"
302
                      % (config_file, e.strerror))
303
304
305
306

    lines = [l.strip() for l in f.readlines()]
    l = [l for l in lines if not l.startswith("#")]
    f.close()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
307
308
309
    if not l:
        raise RuntimeError("Configuration file '%s' is empty."
                           " No packages to build." % config_fule)
310
311
312
    return l


313
314
315
316
317
def create_temp_directory(suffix):
    create_dir_cmd = mktemp("-d", "/tmp/" + suffix + "-XXXXX")
    return create_dir_cmd.stdout.strip()


318
319
320
def call(cmd):
    rc = os.system(cmd)
    if rc:
Christos Stavrakakis's avatar
Christos Stavrakakis committed
321
        raise RuntimeError("Command '%s' failed!" % cmd)
322

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