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
#
# 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
53
54
55
56
57
58
if sys.stdout.isatty():
    try:
        import colors
        use_colors = True
    except AttributeError:
        use_colors = False


if use_colors:
    red = colors.red
    green = colors.green
else:
Vangelis Koukis's avatar
Vangelis Koukis committed
59
60
61
62
63
64
65
66
    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
67
68
69
70
71
72
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/>.

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

83
84
85
%(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
86
87
88
89
90
91
"""


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

Vangelis Koukis's avatar
Vangelis Koukis committed
92
93

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

    (options, args) = parser.parse_args()

Christos Stavrakakis's avatar
Christos Stavrakakis committed
140
141
142
143
144
    if options.help:
        print_help(parser.get_prog_name())
        parser.print_help()
        return

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

154
    # Load the repository
155
    original_repo = utils.get_repository()
Vangelis Koukis's avatar
Vangelis Koukis committed
156

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

162
    # Get packages from configuration file
163
    config = utils.get_config(options.config_file)
164
    packages = config['packages'].keys()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
165
    print_green("Will build the following packages:\n" + "\n".join(packages))
Vangelis Koukis's avatar
Vangelis Koukis committed
166

Christos Stavrakakis's avatar
Christos Stavrakakis committed
167
    # Get current branch name and type and check if it is a valid one
168
    branch = original_repo.head.reference.name
Christos Stavrakakis's avatar
Fix bug    
Christos Stavrakakis committed
169
    branch_type_str = utils.get_branch_type(branch)
Vangelis Koukis's avatar
Vangelis Koukis committed
170

Christos Stavrakakis's avatar
Christos Stavrakakis committed
171
    if branch_type_str not in BRANCH_TYPES.keys():
Christos Stavrakakis's avatar
Christos Stavrakakis committed
172
        allowed_branches = ", ".join(BRANCH_TYPES.keys())
173
174
175
        raise ValueError("Malformed branch name '%s', cannot classify as"
                         " one of %s" % (branch, allowed_branches))

176
177
178
    # Fix needed environment variables
    os.environ["DEVFLOW_BUILD_MODE"] = mode
    git_config = original_repo.config_reader()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
179
180
181
182
183
    try:
        os.environ["DEBFULLNAME"] = git_config.get_value("user", "name")
        os.environ["DEBEMAIL"] = git_config.get_value("user", "email")
    except:
        print "Could not load user/email from config"
184

185
186
187
    # Check that base version file and branch are correct
    versioning.get_python_version()

188
189
    # Get the debian branch
    debian_branch = utils.get_debian_branch(branch)
190
    origin_debian = "origin/" + debian_branch
191
192
193

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

Christos Stavrakakis's avatar
Christos Stavrakakis committed
198
199
200
201
    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)

202
    # Create the debian branch
Christos Stavrakakis's avatar
Christos Stavrakakis committed
203
    repo.git.branch(debian_branch, origin_debian)
204
205
    print_green("Created branch '%s' to track '%s'" % (debian_branch,
                origin_debian))
Vangelis Koukis's avatar
Vangelis Koukis committed
206

207
    # Go to debian branch
Vangelis Koukis's avatar
Vangelis Koukis committed
208
209
210
    repo.git.checkout(debian_branch)
    print_green("Changed to branch '%s'" % debian_branch)

211
    # Merge with starting branch
Vangelis Koukis's avatar
Vangelis Koukis committed
212
    repo.git.merge(branch)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
213
    print_green("Merged branch '%s' into '%s'" % (branch, debian_branch))
Vangelis Koukis's avatar
Vangelis Koukis committed
214

215
    # Compute python and debian version
Vangelis Koukis's avatar
Vangelis Koukis committed
216
    cd(repo_dir)
217
    python_version = versioning.get_python_version()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
218
    debian_version = versioning.\
Christos Stavrakakis's avatar
Christos Stavrakakis committed
219
        debian_version_from_python_version(python_version)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
220
    print_green("The new debian version will be: '%s'" % debian_version)
Vangelis Koukis's avatar
Vangelis Koukis committed
221

222
    # Update the version files
Christos Stavrakakis's avatar
Christos Stavrakakis committed
223
    versioning.update_version()
224

Christos Stavrakakis's avatar
Christos Stavrakakis committed
225
226
    # Tag branch with python version
    branch_tag = python_version
227
228
229
230
231
    try:
        repo.git.tag(branch_tag, branch)
    except GitCommandError:
        # Tag may already exist, if only the debian branch has changed
        pass
232
233
    upstream_tag = "upstream/" + branch_tag
    repo.git.tag(upstream_tag, branch)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
234

235
    # Update changelog
Vangelis Koukis's avatar
Vangelis Koukis committed
236
    dch = git_dch("--debian-branch=%s" % debian_branch,
Christos Stavrakakis's avatar
Christos Stavrakakis committed
237
238
239
240
241
                  "--git-author",
                  "--ignore-regex=\".*\"",
                  "--multimaint-merge",
                  "--since=HEAD",
                  "--new-version=%s" % debian_version)
Vangelis Koukis's avatar
Vangelis Koukis committed
242
243
244
    print_green("Successfully ran '%s'" % " ".join(dch.cmd))

    if mode == "release":
245
        call("vim debian/changelog")
246
247
248
    else:
        f = open("debian/changelog", 'r+')
        lines = f.readlines()
249
        lines[0] = lines[0].replace("UNRELEASED", options.dist)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
250
        lines[2] = lines[2].replace("UNRELEASED", "Snapshot build")
251
252
253
        f.seek(0)
        f.writelines(lines)
        f.close()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
254
255
256
257
258
259

    # 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
260
    debian_branch_tag = "debian/" + debian_version
261
262
    if mode == "release":
        repo.git.tag(debian_branch_tag)
Vangelis Koukis's avatar
Vangelis Koukis committed
263
264

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

Christos Stavrakakis's avatar
Christos Stavrakakis committed
267
    # Create debian packages
Christos Stavrakakis's avatar
Christos Stavrakakis committed
268
    cd(repo_dir)
269
270
271
272
    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
273
274
275
    build_cmd = "git-buildpackage --git-export-dir=%s"\
                " --git-upstream-branch=%s --git-debian-branch=%s"\
                " --git-export=INDEX --git-ignore-new -sa"\
276
277
278
279
                " --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
280
281
    if not options.sign:
        build_cmd += " -uc -us"
282
283
    elif options.keyid:
        build_cmd += " -k\"'%s'\"" % options.keyid
Christos Stavrakakis's avatar
Christos Stavrakakis committed
284
    call(build_cmd)
Vangelis Koukis's avatar
Vangelis Koukis committed
285

286
    # Remove cloned repo
287
    if mode != 'release' and not options.keep_repo:
Vangelis Koukis's avatar
Vangelis Koukis committed
288
289
290
        print_green("Removing cloned repo '%s'." % repo_dir)
        rm("-r", repo_dir)

Christos Stavrakakis's avatar
Christos Stavrakakis committed
291
292
293
294
295
296
297
298
299
    # 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
300

301
    # Print help message
Christos Stavrakakis's avatar
Christos Stavrakakis committed
302
    if mode == "release":
Christos Stavrakakis's avatar
Christos Stavrakakis committed
303
304
305
306
        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
307

Christos Stavrakakis's avatar
Christos Stavrakakis committed
308
309
310
        print_green("To update repositories '%s' and '%s' go to '%s' and run:"
                    % (toplevel, origin, repo_dir))
        for remote in ['origin', 'original_origin']:
311
312
            objects = [debian_branch, branch_tag, debian_branch_tag]
            print_green("git push %s %s" % (remote, " ".join(objects)))
Christos Stavrakakis's avatar
Christos Stavrakakis committed
313
314


315
316
317
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
318
319


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


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