autopkg.py 10.9 KB
Newer Older
Vangelis Koukis's avatar
Vangelis Koukis committed
1
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
# Copyright 2012 GRNET S.A. All rights reserved.
#
# 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")
Vangelis Koukis's avatar
Vangelis Koukis committed
119
120
121

    (options, args) = parser.parse_args()

Christos Stavrakakis's avatar
Christos Stavrakakis committed
122
123
124
125
126
    if options.help:
        print_help(parser.get_prog_name())
        parser.print_help()
        return

127
    # Get build mode
Christos Stavrakakis's avatar
Christos Stavrakakis committed
128
129
130
131
132
    try:
        mode = args[0]
    except IndexError:
        raise ValueError("Mode argument is mandatory. Usage: %s"
                         % parser.usage)
Vangelis Koukis's avatar
Vangelis Koukis committed
133
134
135
136
137
138
    if mode not in AVAILABLE_MODES:
        raise ValueError(red("Invalid argument! Mode must be one: %s"
                         % ", ".join(AVAILABLE_MODES)))

    os.environ["GITFLOW_BUILD_MODE"] = mode

139
    # Load the repository
Vangelis Koukis's avatar
Vangelis Koukis committed
140
141
142
143
144
    try:
        original_repo = git.Repo(".")
    except git.git.InvalidGitRepositoryError:
        raise RuntimeError(red("Current directory is not git repository."))

145
    # Check that repository is clean
Christos Stavrakakis's avatar
Christos Stavrakakis committed
146
    toplevel = original_repo.working_dir
Vangelis Koukis's avatar
Vangelis Koukis committed
147
148
149
    if original_repo.is_dirty() and not options.force_dirty:
        raise RuntimeError(red("Repository %s is dirty." % toplevel))

150
151
152
    # 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
153
154
155
156
157
158
159
    if packages:
        print_green("Will build the following packages:\n" + \
                    "\n".join(packages))
    else:
        raise RuntimeError("Configuration file is empty."
                           " No packages to build.")

160
    # Clone the repo
Christos Stavrakakis's avatar
Reorder    
Christos Stavrakakis committed
161
162
163
164
165
166
    repo_dir = options.repo_dir
    if not repo_dir:
        repo_dir = mktemp("-d", "/tmp/devflow-build-repo-XXX").stdout.strip()
        print_green("Created temporary directory '%s' for the cloned repo."
                    % repo_dir)

Vangelis Koukis's avatar
Vangelis Koukis committed
167
168
169
170
171
172
173
    repo = original_repo.clone(repo_dir)
    print_green("Cloned current repository to '%s'." % repo_dir)

    reflog_hexsha = repo.head.log()[-1].newhexsha
    print "Latest Reflog entry is %s" % reflog_hexsha

    branch = repo.head.reference.name
174
175
176
    brnorm = versioning.normalize_branch_name(branch)
    btypestr = versioning.get_branch_type(brnorm)

177
    # Find the debian branch, and create it if does not exist
178
179
180
181
182
183
184
185
    debian_branch = "debian-" + brnorm
    origin_debian = "origin/" + debian_branch
    if not origin_debian in repo.references:
        # Get default debian branch
        try:
            debian_branch = BRANCH_TYPES[btypestr].default_debian_branch
        except KeyError:
            allowed_branches = ", ".join(x for x in BRANCH_TYPES.keys())
Christos Stavrakakis's avatar
Christos Stavrakakis committed
186
187
            raise ValueError("Malformed branch name '%s', cannot classify as"
                             " one of %s" % (btypestr, allowed_branches))
188
189
190
191
192
        origin_debian = "origin/" + debian_branch

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

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

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

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

209
    # Update changelog
Vangelis Koukis's avatar
Vangelis Koukis committed
210
211
212
213
214
    dch = git_dch("--debian-branch=%s" % debian_branch,
            "--git-author",
            "--ignore-regex=\".*\"",
            "--multimaint-merge",
            "--since=HEAD",
Christos Stavrakakis's avatar
Christos Stavrakakis committed
215
            "--new-version=%s" % debian_version)
Vangelis Koukis's avatar
Vangelis Koukis committed
216
217
    print_green("Successfully ran '%s'" % " ".join(dch.cmd))

218
    os.system("vim debian/changelog")
Vangelis Koukis's avatar
Vangelis Koukis committed
219
220
221
    repo.git.add("debian/changelog")

    if mode == "release":
222
        # Commit changelog and update tag branches
Christos Stavrakakis's avatar
Christos Stavrakakis committed
223
224
        os.system("vim debian/changelog")
        repo.git.add("debian/changelog")
Vangelis Koukis's avatar
Vangelis Koukis committed
225
        repo.git.commit("-s", "-a", "-m", "Bump new upstream version")
Christos Stavrakakis's avatar
Christos Stavrakakis committed
226
227
228
        python_tag = python_version
        debian_tag = "debian/" + python_tag
        repo.git.tag(debian_tag)
229
        repo.git.tag(python_tag, brnorm)
Vangelis Koukis's avatar
Vangelis Koukis committed
230

231
232
    # Update the python version files
    # TODO: remove this
Christos Stavrakakis's avatar
Christos Stavrakakis committed
233
    for package in packages:
Vangelis Koukis's avatar
Vangelis Koukis committed
234
235
236
237
238
        # python setup.py should run in its directory
        cd(package)
        package_dir = repo_dir + "/" + package
        res = python(package_dir + "/setup.py", "sdist", _out=sys.stdout)
        print res.stdout
Christos Stavrakakis's avatar
Christos Stavrakakis committed
239
240
        if package != ".":
            cd("../")
Vangelis Koukis's avatar
Vangelis Koukis committed
241
242
243
244

    # Add version.py files to repo
    os.system("grep \"__version_vcs\" -r . -l -I | xargs git add -f")

245
    # Create debian branches
Vangelis Koukis's avatar
Vangelis Koukis committed
246
247
248
249
250
251
    build_dir = options.build_dir
    if not options.build_dir:
        build_dir = mktemp("-d", "/tmp/devflow-build-XXX").stdout.strip()
        print_green("Created directory '%s' to store the .deb files." %
                     build_dir)

Christos Stavrakakis's avatar
Christos Stavrakakis committed
252
    cd(repo_dir)
Vangelis Koukis's avatar
Vangelis Koukis committed
253
254
    os.system("git-buildpackage --git-export-dir=%s --git-upstream-branch=%s"
              " --git-debian-branch=%s --git-export=INDEX --git-ignore-new -sa"
255
              % (build_dir, brnorm, debian_branch))
Vangelis Koukis's avatar
Vangelis Koukis committed
256

257
    # Remove cloned repo
Vangelis Koukis's avatar
Vangelis Koukis committed
258
259
260
261
262
263
264
    if not options.keep_repo:
        print_green("Removing cloned repo '%s'." % repo_dir)
        rm("-r", repo_dir)
    else:
        print_green("Repository dir '%s'" % repo_dir)

    print_green("Completed. Version '%s', build area: '%s'"
Christos Stavrakakis's avatar
Christos Stavrakakis committed
265
266
                % (debian_version, build_dir))

267
    # Print help message
Christos Stavrakakis's avatar
Christos Stavrakakis committed
268
269
    if mode == "release":
        TAG_MSG = "Tagged branch %s with tag %s\n"
270
        print_green(TAG_MSG % (brnorm, python_tag))
Christos Stavrakakis's avatar
Christos Stavrakakis committed
271
272
273
274
275
276
277
278
279
280
281
282
        print_green(TAG_MSG % (debian_branch, debian_tag))

        UPDATE_MSG = "To update repository %s, go to %s, and run the"\
                     " following commands:\n" + "git_push origin %s\n" * 3

        origin_url = repo.remotes['origin'].url
        remote_url = original_repo.remotes['origin'].url

        print_green(UPDATE_MSG % (origin_url, repo_dir, debian_branch,
                    debian_tag, python_tag))
        print_green(UPDATE_MSG % (remote_url, original_repo.working_dir,
                    debian_branch, debian_tag, python_tag))
Vangelis Koukis's avatar
Vangelis Koukis committed
283
284


285
286
287
288
289
290
291
292
293
294
295
296
297
298
def get_packages_to_build(config_file):
    config_file = os.path.abspath(config_file)
    try:
        f = open(config_file)
    except IOError:
        raise RuntimeError("Configuration file %s does not exist!"
                           % config_file)

    lines = [l.strip() for l in f.readlines()]
    l = [l for l in lines if not l.startswith("#")]
    f.close()
    return l


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