path: root/packages/bddeb

#!/usr/bin/env python3

import argparse
import json
import os
import shutil
import sys


def find_root():
    # expected path is in <top_dir>/packages/
    top_dir = os.environ.get("CLOUD_INIT_TOP_D", None)
    if top_dir is None:
        top_dir = os.path.dirname(
            os.path.dirname(os.path.abspath(sys.argv[0])))
    if os.path.isfile(os.path.join(top_dir, 'setup.py')):
        return os.path.abspath(top_dir)
    raise OSError(("Unable to determine where your cloud-init topdir is."
                   " set CLOUD_INIT_TOP_D?"))

if "avoid-pep8-E402-import-not-top-of-file":
    # Use the util functions from cloudinit
    sys.path.insert(0, find_root())
    from cloudinit import templater
    from cloudinit import util

# Package names that will showup in requires to what we can actually
# use in our debian 'control' file, this is a translation of the 'requires'
# file pypi package name to a debian/ubuntu package name.
STD_NAMED_PACKAGES = [
    'configobj',
    'coverage',
    'jinja2',
    'jsonpatch',
    'oauthlib',
    'prettytable',
    'requests',
    'six',
    'httpretty',
    'mock',
    'nose',
    'setuptools',
    'flake8',
    'hacking',
    'unittest2',
]
NONSTD_NAMED_PACKAGES = {
    'argparse': ('python-argparse', None),
    'contextlib2': ('python-contextlib2', None),
    'cheetah': ('python-cheetah', None),
    'pyserial': ('python-serial', 'python3-serial'),
    'pyyaml': ('python-yaml', 'python3-yaml'),
    'six': ('python-six', 'python3-six'),
    'pep8': ('pep8', 'python3-pep8'),
    'pyflakes': ('pyflakes', 'pyflakes'),
}

DEBUILD_ARGS = ["-S", "-d"]


def run_helper(helper, args=None, strip=True):
    if args is None:
        args = []
    cmd = [util.abs_join(find_root(), 'tools', helper)] + args
    (stdout, _stderr) = util.subp(cmd)
    if strip:
        stdout = stdout.strip()
    return stdout


def write_debian_folder(root, templ_data, pkgmap, pyver="3",
                        append_requires=[]):
    deb_dir = util.abs_join(root, 'debian')

    # Just copy debian/ dir and then update files
    pdeb_d = util.abs_join(find_root(), 'packages', 'debian')
    util.subp(['cp', '-a', pdeb_d, deb_dir])

    # Fill in the change log template
    templater.render_to_file(util.abs_join(find_root(),
                             'packages', 'debian', 'changelog.in'),
                             util.abs_join(deb_dir, 'changelog'),
                             params=templ_data)

    # Write out the control file template
    reqs = run_helper('read-dependencies').splitlines()
    test_reqs = run_helper(
        'read-dependencies', ['test-requirements.txt']).splitlines()

    pypi_pkgs = [p.lower().strip() for p in reqs]
    pypi_test_pkgs = [p.lower().strip() for p in test_reqs]

    # Map to known packages
    requires = append_requires
    test_requires = []
    lists = ((pypi_pkgs, requires), (pypi_test_pkgs, test_requires))
    for pypilist, target in lists:
        for p in pypilist:
            if p not in pkgmap:
                raise RuntimeError(("Do not know how to translate pypi "
                                    "dependency %r to a known package") % (p))
            elif pkgmap[p]:
                target.append(pkgmap[p])

    if pyver == "3":
        python = "python3"
    else:
        python = "python"

    templater.render_to_file(util.abs_join(find_root(),
                                           'packages', 'debian', 'control.in'),
                             util.abs_join(deb_dir, 'control'),
                             params={'requires': ','.join(requires),
                                     'test_requires': ','.join(test_requires),
                                     'python': python})

    templater.render_to_file(util.abs_join(find_root(),
                                           'packages', 'debian', 'rules.in'),
                             util.abs_join(deb_dir, 'rules'),
                             params={'python': python, 'pyver': pyver})


def read_version():
    return json.loads(run_helper('read-version', ['--json']))


def main():

    parser = argparse.ArgumentParser()
    parser.add_argument("-v", "--verbose", dest="verbose",
                        help=("run verbosely"
                              " (default: %(default)s)"),
                        default=False,
                        action='store_true')
    parser.add_argument("--cloud-utils", dest="cloud_utils",
                        help=("depend on cloud-utils package"
                              " (default: %(default)s)"),
                        default=False,
                        action='store_true')

    parser.add_argument("--python2", dest="python2",
                        help=("build debs for python2 rather than python3"),
                        default=False, action='store_true')

    parser.add_argument("--init-system", dest="init_system",
                        help=("build deb with INIT_SYSTEM=xxx"
                              " (default: %(default)s"),
                        default=os.environ.get("INIT_SYSTEM",
                                               "upstart,systemd"))

    parser.add_argument("--release", dest="release",
                        help=("build with changelog referencing RELEASE"),
                        default="UNRELEASED")

    for ent in DEBUILD_ARGS:
        parser.add_argument(ent, dest="debuild_args", action='append_const',
                            const=ent, default=[],
                            help=("pass through '%s' to debuild" % ent))

    parser.add_argument("--sign", default=False, action='store_true',
                        help="sign result. do not pass -us -uc to debuild")

    parser.add_argument("--signuser", default=False, action='store',
                        help="user to sign, see man dpkg-genchanges")

    args = parser.parse_args()

    if not args.sign:
        args.debuild_args.extend(['-us', '-uc'])

    if args.signuser:
        args.debuild_args.extend(['-e%s' % args.signuser])

    os.environ['INIT_SYSTEM'] = args.init_system

    capture = True
    if args.verbose:
        capture = False

    pkgmap = {}
    for p in NONSTD_NAMED_PACKAGES:
        pkgmap[p] = NONSTD_NAMED_PACKAGES[p][int(not args.python2)]

    for p in STD_NAMED_PACKAGES:
        if args.python2:
            pkgmap[p] = "python-" + p
            pyver = "2"
        else:
            pkgmap[p] = "python3-" + p
            pyver = "3"

    templ_data = {'debian_release': args.release}
    with util.tempdir() as tdir:

        # output like 0.7.6-1022-g36e92d3
        ver_data = read_version()

        # This is really only a temporary archive
        # since we will extract it then add in the debian
        # folder, then re-archive it for debian happiness
        print("Creating a temporary tarball using the 'make-tarball' helper")
        tarball = "cloud-init_%s.orig.tar.gz" % ver_data['version_long']
        tarball_fp = util.abs_join(tdir, tarball)
        run_helper('make-tarball', ['--long', '--output=' + tarball_fp])

        print("Extracting temporary tarball %r" % (tarball))
        cmd = ['tar', '-xvzf', tarball_fp, '-C', tdir]
        util.subp(cmd, capture=capture)

        xdir = util.abs_join(tdir, "cloud-init-%s" % ver_data['version_long'])

        print("Creating a debian/ folder in %r" % (xdir))
        if args.cloud_utils:
            append_requires = ['cloud-utils | cloud-guest-utils']
        else:
            append_requires = []

        templ_data.update(ver_data)
        write_debian_folder(xdir, templ_data, pkgmap,
                            pyver=pyver, append_requires=append_requires)

        print("Running 'debuild %s' in %r" % (' '.join(args.debuild_args),
                                              xdir))
        with util.chdir(xdir):
            cmd = ['debuild', '--preserve-envvar', 'INIT_SYSTEM']
            if args.debuild_args:
                cmd.extend(args.debuild_args)
            util.subp(cmd, capture=capture)

        link_fn = os.path.join(os.getcwd(), 'cloud-init_all.deb')
        link_dsc = os.path.join(os.getcwd(), 'cloud-init.dsc')
        for base_fn in os.listdir(os.path.join(tdir)):
            full_fn = os.path.join(tdir, base_fn)
            if not os.path.isfile(full_fn):
                continue
            shutil.move(full_fn, base_fn)
            print("Wrote %r" % (base_fn))
            if base_fn.endswith('_all.deb'):
                # Add in the local link
                util.del_file(link_fn)
                os.symlink(base_fn, link_fn)
                print("Linked %r to %r" % (base_fn,
                                           os.path.basename(link_fn)))
            if base_fn.endswith('.dsc'):
                util.del_file(link_dsc)
                os.symlink(base_fn, link_dsc)
                print("Linked %r to %r" % (base_fn,
                                           os.path.basename(link_dsc)))

    return 0


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