bootstrap/config.py

   1 #!/usr/bin/env python3
   2
   3 # Copyright (C) Catalyst.Net Ltd 2019
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 """
  19 Manage dependencies and bootstrap environments for Samba.
  20
  21 Config file for packages and templates.
  22
  23 Author: Joe Guo <joeg@catalyst.net.nz>
  24 """
  25 import os
  26 from os.path import abspath, dirname, join
  27 HERE = abspath(dirname(__file__))
  28 # output dir for rendered files
  29 OUT = join(HERE, 'generated-dists')
  30
  31
  32 # pkgs with same name in all packaging systems
  33 COMMON = [
  34     'acl',
  35     'attr',
  36     'autoconf',
  37     'binutils',
  38     'bison',
  39     'ccache',
  40     'curl',
  41     'chrpath',
  42     'flex',
  43     'gcc',
  44     'gdb',
  45     'git',
  46     'gzip',
  47     'hostname',
  48     'htop',
  49     'lcov',
  50     'make',
  51     'patch',
  52     'perl',
  53     'psmisc',  # for pstree in test
  54     'rng-tools',
  55     'rsync',
  56     'sed',
  57     'sudo',  # docker images has no sudo by default
  58     'tar',
  59     'tree',
  60     'wget',
  61 ]
  62
  63
  64 # define pkgs for all packaging systems in parallel
  65 # make it easier to find missing ones
  66 # use latest ubuntu and fedora as defaults
  67 # deb, rpm, ...
  68 PKGS = [
  69     # NAME1-dev, NAME2-devel
  70     ('lmdb-utils', 'lmdb'),
  71     ('mingw-w64', 'mingw64-gcc'),
  72     ('zlib1g-dev', 'zlib-devel'),
  73     ('libbsd-dev', 'libbsd-devel'),
  74     ('liburing-dev', 'liburing-devel'),
  75     ('libarchive-dev', 'libarchive-devel'),
  76     ('libblkid-dev', 'libblkid-devel'),
  77     ('libcap-dev', 'libcap-devel'),
  78     ('libacl1-dev', 'libacl-devel'),
  79     ('libattr1-dev', 'libattr-devel'),
  80
  81     # libNAME1-dev, NAME2-devel
  82     ('libpopt-dev', 'popt-devel'),
  83     ('libreadline-dev', 'readline-devel'),
  84     ('libjansson-dev', 'jansson-devel'),
  85     ('liblmdb-dev', 'lmdb-devel'),
  86     ('libncurses5-dev', 'ncurses-devel'),
  87     # NOTE: Debian 7+ or Ubuntu 16.04+
  88     ('libsystemd-dev', 'systemd-devel'),
  89     ('libkrb5-dev', 'krb5-devel'),
  90     ('libldap2-dev', 'openldap-devel'),
  91     ('libcups2-dev', 'cups-devel'),
  92     ('libpam0g-dev', 'pam-devel'),
  93     ('libgpgme11-dev', 'gpgme-devel'),
  94     # NOTE: Debian 8+ and Ubuntu 14.04+
  95     ('libgnutls28-dev', 'gnutls-devel'),
  96     ('libtasn1-bin', 'libtasn1-tools'),
  97     ('libtasn1-dev', 'libtasn1-devel'),
  98     ('', 'quota-devel'),
  99     ('uuid-dev', 'libuuid-devel'),
 100     ('libjs-jquery', ''),
 101     ('libavahi-common-dev', 'avahi-devel'),
 102     ('libdbus-1-dev', 'dbus-devel'),
 103     ('libpcap-dev', 'libpcap-devel'),
 104     ('libunwind-dev', 'libunwind-devel'),  # for back trace
 105     ('libglib2.0-dev', 'glib2-devel'),
 106     ('libicu-dev', 'libicu-devel'),
 107     ('heimdal-multidev', ''),
 108
 109     # NAME1, NAME2
 110     # for debian, locales provide locale support with language packs
 111     # ubuntu split language packs to language-pack-xx
 112     # for centos, glibc-common provide locale support with language packs
 113     # fedora split language packs  to glibc-langpack-xx
 114     ('locales', 'glibc-common'),  # required for locale
 115     ('language-pack-en', 'glibc-langpack-en'),  # we need en_US.UTF-8
 116     ('bind9utils', 'bind-utils'),
 117     ('dnsutils', ''),
 118     ('xsltproc', 'libxslt'),
 119     ('krb5-user', ''),
 120     ('krb5-config', ''),
 121     ('krb5-kdc', 'krb5-server'),
 122     ('apt-utils', 'yum-utils'),
 123     ('pkg-config', 'pkgconfig'),
 124     ('procps', 'procps-ng'),  # required for the free cmd in tests
 125     ('lsb-release', 'lsb-release'),  # we need lsb_relase to show info
 126     ('', 'rpcgen'),  # required for test
 127     # refer: https://fedoraproject.org/wiki/Changes/SunRPCRemoval
 128     ('', 'libtirpc-devel'),  # for <rpc/rpc.h> header on fedora
 129     ('', 'libnsl2-devel'),  # for <rpcsvc/yp_prot.h> header on fedora
 130     ('', 'rpcsvc-proto-devel'), # for <rpcsvc/rquota.h> header
 131     ('mawk', 'gawk'),
 132
 133     ('python3', 'python3'),
 134     ('python3-cryptography', 'python3-cryptography'), # for krb5 tests
 135     ('python3-dev', 'python3-devel'),
 136     ('python3-dbg', ''),
 137     ('python3-iso8601', 'python3-iso8601'),
 138     ('python3-gpg', 'python3-gpg'),  # defaults to ubuntu/fedora latest
 139     ('python3-markdown', 'python3-markdown'),
 140     ('python3-matplotlib', ''),
 141     ('python3-dnspython', 'python3-dns'),
 142     ('python3-pexpect', ''),  # for wintest only
 143     ('python3-pyasn1', 'python3-pyasn1'), # for krb5 tests
 144
 145     ('', 'libsemanage-python'),
 146     ('', 'policycoreutils-python'),
 147
 148     # perl
 149     ('libparse-yapp-perl', 'perl-Parse-Yapp'),
 150     ('libjson-perl', 'perl-JSON'),
 151     ('', 'perl-JSON-Parse'),
 152     ('perl-modules', ''),
 153     ('', 'perl-Archive-Tar'),
 154     ('', 'perl-ExtUtils-MakeMaker'),
 155     ('', 'perl-Test-Base'),
 156     ('', 'perl-generators'),
 157     ('', 'perl-interpreter'),
 158
 159     # fs
 160     ('xfslibs-dev', 'xfsprogs-devel'), # for xfs quota support
 161     ('', 'glusterfs-api-devel'),
 162     ('glusterfs-common', 'glusterfs-devel'),
 163     ('libcephfs-dev', 'libcephfs-devel'),
 164
 165     # misc
 166     # @ means group for rpm, use fedora as rpm default
 167     ('build-essential', '@development-tools'),
 168     ('debhelper', ''),
 169     # rpm has no pkg for docbook-xml
 170     ('docbook-xml', 'docbook-dtds'),
 171     ('docbook-xsl', 'docbook-style-xsl'),
 172     ('', 'keyutils-libs-devel'),
 173     ('', 'which'),
 174 ]
 175
 176
 177 DEB_PKGS = COMMON + [pkg for pkg, _ in PKGS if pkg]
 178 RPM_PKGS = COMMON + [pkg for _, pkg in PKGS if pkg]
 179
 180 GENERATED_MARKER = r"""
 181 #
 182 # This file is generated by 'bootstrap/template.py --render'
 183 # See also bootstrap/config.py
 184 #
 185 """
 186
 187
 188 APT_BOOTSTRAP = r"""
 189 #!/bin/bash
 190 {GENERATED_MARKER}
 191 set -xueo pipefail
 192
 193 export DEBIAN_FRONTEND=noninteractive
 194 apt-get -y update
 195
 196 apt-get -y install \
 197     {pkgs}
 198
 199 apt-get -y autoremove
 200 apt-get -y autoclean
 201 apt-get -y clean
 202 """
 203
 204
 205 YUM_BOOTSTRAP = r"""
 206 #!/bin/bash
 207 {GENERATED_MARKER}
 208 set -xueo pipefail
 209
 210 yum update -y
 211 yum install -y epel-release
 212 yum install -y yum-plugin-copr
 213 yum copr enable -y sergiomb/SambaAD
 214 yum update -y
 215
 216 yum install -y \
 217     {pkgs}
 218
 219 yum clean all
 220
 221 if [ ! -f /usr/bin/python3 ]; then
 222     ln -sf /usr/bin/python3.6 /usr/bin/python3
 223 fi
 224 """
 225
 226 CENTOS8_YUM_BOOTSTRAP = r"""
 227 #!/bin/bash
 228 {GENERATED_MARKER}
 229 set -xueo pipefail
 230
 231 yum update -y
 232 yum install -y dnf-plugins-core
 233 yum install -y epel-release
 234
 235 yum -v repolist all
 236 yum config-manager --set-enabled PowerTools -y
 237 yum config-manager --set-enabled Devel -y
 238 yum update -y
 239
 240 yum install -y \
 241     --setopt=install_weak_deps=False \
 242     {pkgs}
 243
 244 yum clean all
 245 """
 246
 247 DNF_BOOTSTRAP = r"""
 248 #!/bin/bash
 249 {GENERATED_MARKER}
 250 set -xueo pipefail
 251
 252 dnf update -y
 253
 254 dnf install -y \
 255     --setopt=install_weak_deps=False \
 256     {pkgs}
 257
 258 dnf clean all
 259 """
 260
 261 ZYPPER_BOOTSTRAP = r"""
 262 #!/bin/bash
 263 {GENERATED_MARKER}
 264 set -xueo pipefail
 265
 266 zypper --non-interactive refresh
 267 zypper --non-interactive update
 268 zypper --non-interactive install \
 269     --no-recommends \
 270     system-user-nobody \
 271     {pkgs}
 272
 273 zypper --non-interactive clean
 274
 275 if [ -f /usr/lib/mit/bin/krb5-config ]; then
 276     ln -sf /usr/lib/mit/bin/krb5-config /usr/bin/krb5-config
 277 fi
 278 """
 279
 280 # A generic shell script to setup locale
 281 LOCALE_SETUP = r"""
 282 #!/bin/bash
 283 {GENERATED_MARKER}
 284 set -xueo pipefail
 285
 286 # refer to /usr/share/i18n/locales
 287 INPUTFILE=en_US
 288 # refer to /usr/share/i18n/charmaps
 289 CHARMAP=UTF-8
 290 # locale to generate in /usr/lib/locale
 291 # glibc/localedef will normalize UTF-8 to utf8, follow the naming style
 292 LOCALE=$INPUTFILE.utf8
 293
 294 # if locale is already correct, exit
 295 ( locale | grep LC_ALL | grep -i $LOCALE ) && exit 0
 296
 297 # if locale not available, generate locale into /usr/lib/locale
 298 if ! ( locale --all-locales | grep -i $LOCALE )
 299 then
 300     # no-archive means create its own dir
 301     localedef --inputfile $INPUTFILE --charmap $CHARMAP --no-archive $LOCALE
 302 fi
 303
 304 # update locale conf and global env file
 305 # set both LC_ALL and LANG for safe
 306
 307 # update conf for Debian family
 308 FILE=/etc/default/locale
 309 if [ -f $FILE ]
 310 then
 311     echo LC_ALL="$LOCALE" > $FILE
 312     echo LANG="$LOCALE" >> $FILE
 313 fi
 314
 315 # update conf for RedHat family
 316 FILE=/etc/locale.conf
 317 if [ -f $FILE ]
 318 then
 319     # LC_ALL is not valid in this file, set LANG only
 320     echo LANG="$LOCALE" > $FILE
 321 fi
 322
 323 # update global env file
 324 FILE=/etc/environment
 325 if [ -f $FILE ]
 326 then
 327     # append LC_ALL if not exist
 328     grep LC_ALL $FILE || echo LC_ALL="$LOCALE" >> $FILE
 329     # append LANG if not exist
 330     grep LANG $FILE || echo LANG="$LOCALE" >> $FILE
 331 fi
 332 """
 333
 334
 335 DOCKERFILE = r"""
 336 {GENERATED_MARKER}
 337 FROM {docker_image}
 338
 339 # pass in with --build-arg while build
 340 ARG SHA1SUM
 341 RUN [ -n $SHA1SUM ] && echo $SHA1SUM > /sha1sum.txt
 342
 343 ADD *.sh /tmp/
 344 # need root permission, do it before USER samba
 345 RUN /tmp/bootstrap.sh && /tmp/locale.sh
 346
 347 # if ld.gold exists, force link it to ld
 348 RUN set -x; LD=$(which ld); LD_GOLD=$(which ld.gold); test -x $LD_GOLD && ln -sf $LD_GOLD $LD && test -x $LD && echo "$LD is now $LD_GOLD"
 349
 350 # make test can not work with root, so we have to create a new user
 351 RUN useradd -m -U -s /bin/bash samba && \
 352     mkdir -p /etc/sudoers.d && \
 353     echo "samba ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/samba
 354
 355 USER samba
 356 WORKDIR /home/samba
 357 # samba tests rely on this
 358 ENV USER=samba LC_ALL=en_US.utf8 LANG=en_US.utf8
 359 """
 360
 361 # Vagrantfile snippet for each dist
 362 VAGRANTFILE_SNIPPET = r"""
 363     config.vm.define "{name}" do |v|
 364         v.vm.box = "{vagrant_box}"
 365         v.vm.hostname = "{name}"
 366         v.vm.provision :shell, path: "{name}/bootstrap.sh"
 367         v.vm.provision :shell, path: "{name}/locale.sh"
 368     end
 369 """
 370
 371 # global Vagrantfile with snippets for all dists
 372 VAGRANTFILE_GLOBAL = r"""
 373 {GENERATED_MARKER}
 374
 375 Vagrant.configure("2") do |config|
 376     config.ssh.insert_key = false
 377
 378 {vagrantfile_snippets}
 379
 380 end
 381 """
 382
 383
 384 DEB_DISTS = {
 385     'debian10': {
 386         'docker_image': 'debian:10',
 387         'vagrant_box': 'debian/buster64',
 388         'replace': {
 389             'language-pack-en': '',   # included in locales
 390             'liburing-dev': '',   # not available
 391         }
 392     },
 393     'ubuntu1604': {
 394         'docker_image': 'ubuntu:16.04',
 395         'vagrant_box': 'ubuntu/xenial64',
 396         'replace': {
 397             'python3-gpg': 'python3-gpgme',
 398             'glusterfs-common': '',
 399             'libcephfs-dev': '',
 400             'liburing-dev': '',   # not available
 401         }
 402     },
 403     'ubuntu1804': {
 404         'docker_image': 'ubuntu:18.04',
 405         'vagrant_box': 'ubuntu/bionic64',
 406         'replace': {
 407             'liburing-dev': '',   # not available
 408         }
 409     },
 410     'ubuntu2004': {
 411         'docker_image': 'ubuntu:20.04',
 412         'vagrant_box': 'ubuntu/focal64',
 413         'replace': {
 414             'liburing-dev': '',   # not available
 415         }
 416     },
 417 }
 418
 419
 420 RPM_DISTS = {
 421     'centos7': {
 422         'docker_image': 'centos:7',
 423         'vagrant_box': 'centos/7',
 424         'bootstrap': YUM_BOOTSTRAP,
 425         'replace': {
 426             'lsb-release': 'redhat-lsb',
 427             'python3': 'python36',
 428             'python3-cryptography': 'python36-cryptography',
 429             'python3-devel': 'python36-devel',
 430             'python3-dns': 'python36-dns',
 431             'python3-pyasn1': 'python36-pyasn1',
 432             'python3-gpg': 'python36-gpg',
 433             'python3-iso8601' : 'python36-iso8601',
 434             'python3-markdown': 'python36-markdown',
 435             # although python36-devel is available
 436             # after epel-release installed
 437             # however, all other python3 pkgs are still python36-ish
 438             'python2-gpg': 'pygpgme',
 439             'python3-gpg': '',  # no python3-gpg yet
 440             '@development-tools': '"@Development Tools"',  # add quotes
 441             'glibc-langpack-en': '',  # included in glibc-common
 442             'glibc-locale-source': '',  # included in glibc-common
 443             # update perl core modules on centos
 444             # fix: Can't locate Archive/Tar.pm in @INC
 445             'perl': 'perl-core',
 446             'rpcsvc-proto-devel': '',
 447             'glusterfs-api-devel': '',
 448             'glusterfs-devel': '',
 449             'libcephfs-devel': '',
 450             'gnutls-devel': 'compat-gnutls34-devel',
 451             'liburing-devel': '',   # not available
 452         }
 453     },
 454     'centos8': {
 455         'docker_image': 'centos:8',
 456         'vagrant_box': 'centos/8',
 457         'bootstrap': CENTOS8_YUM_BOOTSTRAP,
 458         'replace': {
 459             'lsb-release': 'redhat-lsb',
 460             '@development-tools': '"@Development Tools"',  # add quotes
 461             'libsemanage-python': 'python3-libsemanage',
 462             'lcov': '', # does not exist
 463             'perl-JSON-Parse': '', # does not exist?
 464             'perl-Test-Base': 'perl-Test-Simple',
 465             'policycoreutils-python': 'python3-policycoreutils',
 466             'liburing-devel': '', # not available yet, Add me back, once available!
 467         }
 468     },
 469     'fedora31': {
 470         'docker_image': 'fedora:31',
 471         'vagrant_box': 'fedora/31-cloud-base',
 472         'bootstrap': DNF_BOOTSTRAP,
 473         'replace': {
 474             'lsb-release': 'redhat-lsb',
 475             'libsemanage-python': 'python3-libsemanage',
 476             'policycoreutils-python': 'python3-policycoreutils',
 477         }
 478     },
 479     'fedora32': {
 480         'docker_image': 'fedora:32',
 481         'vagrant_box': 'fedora/32-cloud-base',
 482         'bootstrap': DNF_BOOTSTRAP,
 483         'replace': {
 484             'lsb-release': 'redhat-lsb',
 485             'libsemanage-python': 'python3-libsemanage',
 486             'policycoreutils-python': 'python3-policycoreutils',
 487         }
 488     },
 489     'opensuse150': {
 490         'docker_image': 'opensuse/leap:15.0',
 491         'vagrant_box': 'opensuse/openSUSE-15.0-x86_64',
 492         'bootstrap': ZYPPER_BOOTSTRAP,
 493         'replace': {
 494             '@development-tools': '',
 495             'dbus-devel': 'dbus-1-devel',
 496             'docbook-style-xsl': 'docbook-xsl-stylesheets',
 497             'glibc-common': 'glibc-locale',
 498             'glibc-locale-source': 'glibc-i18ndata',
 499             'glibc-langpack-en': '',
 500             'jansson-devel': 'libjansson-devel',
 501             'keyutils-libs-devel': 'keyutils-devel',
 502             'krb5-workstation': 'krb5-client',
 503             'libnsl2-devel': 'libnsl-devel',
 504             'libsemanage-python': 'python2-semanage',
 505             'openldap-devel': 'openldap2-devel',
 506             'perl-Archive-Tar': 'perl-Archive-Tar-Wrapper',
 507             'perl-JSON-Parse': 'perl-JSON-XS',
 508             'perl-generators': '',
 509             'perl-interpreter': '',
 510             'procps-ng': 'procps',
 511             'python3-dns': 'python3-dnspython',
 512             'python3-markdown': 'python3-Markdown',
 513             'quota-devel': '',
 514             'glusterfs-api-devel': '',
 515             'libtasn1-tools': '', # asn1Parser is part of libtasn1
 516             'mingw64-gcc': '', # doesn't exist
 517             'liburing-devel': '',   # not available
 518         }
 519     },
 520     'opensuse151': {
 521         'docker_image': 'opensuse/leap:15.1',
 522         'vagrant_box': 'opensuse/openSUSE-15.1-x86_64',
 523         'bootstrap': ZYPPER_BOOTSTRAP,
 524         'replace': {
 525             '@development-tools': '',
 526             'dbus-devel': 'dbus-1-devel',
 527             'docbook-style-xsl': 'docbook-xsl-stylesheets',
 528             'glibc-common': 'glibc-locale',
 529             'glibc-locale-source': 'glibc-i18ndata',
 530             'glibc-langpack-en': '',
 531             'jansson-devel': 'libjansson-devel',
 532             'keyutils-libs-devel': 'keyutils-devel',
 533             'krb5-workstation': 'krb5-client',
 534             'libnsl2-devel': 'libnsl-devel',
 535             'libsemanage-python': 'python2-semanage',
 536             'openldap-devel': 'openldap2-devel',
 537             'perl-Archive-Tar': 'perl-Archive-Tar-Wrapper',
 538             'perl-JSON-Parse': 'perl-JSON-XS',
 539             'perl-generators': '',
 540             'perl-interpreter': '',
 541             'procps-ng': 'procps',
 542             'python3-dns': 'python3-dnspython',
 543             'python3-markdown': 'python3-Markdown',
 544             'quota-devel': '',
 545             'glusterfs-api-devel': '',
 546             'libtasn1-tools': '', # asn1Parser is part of libtasn1
 547             'mingw64-gcc': '', # doesn't exist
 548             'liburing-devel': '',   # not available, will be added in 15.2
 549         }
 550     }
 551 }
 552
 553
 554 DEB_FAMILY = {
 555     'name': 'deb',
 556     'pkgs': DEB_PKGS,
 557     'bootstrap': APT_BOOTSTRAP,  # family default
 558     'dists': DEB_DISTS,
 559 }
 560
 561
 562 RPM_FAMILY = {
 563     'name': 'rpm',
 564     'pkgs': RPM_PKGS,
 565     'bootstrap': YUM_BOOTSTRAP,  # family default
 566     'dists': RPM_DISTS,
 567 }
 568
 569
 570 YML_HEADER = r"""
 571 ---
 572 packages:
 573 """
 574
 575
 576 def expand_family_dists(family):
 577     dists = {}
 578     for name, config in family['dists'].items():
 579         config = config.copy()
 580         config['name'] = name
 581         config['home'] = join(OUT, name)
 582         config['family'] = family['name']
 583         config['GENERATED_MARKER'] = GENERATED_MARKER
 584
 585         # replace dist specific pkgs
 586         replace = config.get('replace', {})
 587         pkgs = []
 588         for pkg in family['pkgs']:
 589             pkg = replace.get(pkg, pkg)  # replace if exists or get self
 590             if pkg:
 591                 pkgs.append(pkg)
 592         pkgs.sort()
 593
 594         lines = ['  - {}'.format(pkg) for pkg in pkgs]
 595         config['packages.yml'] = YML_HEADER.lstrip() + os.linesep.join(lines)
 596
 597         sep = ' \\' + os.linesep + '    '
 598         config['pkgs'] = sep.join(pkgs)
 599
 600         # get dist bootstrap template or fall back to family default
 601         bootstrap_template = config.get('bootstrap', family['bootstrap'])
 602         config['bootstrap.sh'] = bootstrap_template.format(**config).strip()
 603         config['locale.sh'] = LOCALE_SETUP.format(**config).strip()
 604
 605         config['Dockerfile'] = DOCKERFILE.format(**config).strip()
 606         # keep the indent, no strip
 607         config['vagrantfile_snippet'] = VAGRANTFILE_SNIPPET.format(**config)
 608
 609         dists[name] = config
 610     return dists
 611
 612
 613 # expanded config for dists
 614 DEB_DISTS_EXP = expand_family_dists(DEB_FAMILY)
 615 RPM_DISTS_EXP = expand_family_dists(RPM_FAMILY)
 616
 617 # assemble all together
 618 DISTS = {}
 619 DISTS.update(DEB_DISTS_EXP)
 620 DISTS.update(RPM_DISTS_EXP)
 621
 622
 623 def render_vagrantfile(dists):
 624     """
 625     Render all snippets for each dist into global Vagrantfile.
 626
 627     Vagrant supports multiple vms in one Vagrantfile.
 628     This make it easier to manage the fleet, e.g:
 629
 630     start all: vagrant up
 631     start one: vagrant up ubuntu1804
 632
 633     All other commands apply to above syntax, e.g.: status, destroy, provision
 634     """
 635     # sort dists by name and put all vagrantfile snippets together
 636     snippets = [
 637         dists[dist]['vagrantfile_snippet']
 638         for dist in sorted(dists.keys())]
 639
 640     return VAGRANTFILE_GLOBAL.format(
 641             vagrantfile_snippets=''.join(snippets),
 642             GENERATED_MARKER=GENERATED_MARKER
 643             )
 644
 645
 646 VAGRANTFILE = render_vagrantfile(DISTS)
 647
 648
 649 # data we need to expose
 650 __all__ = ['DISTS', 'VAGRANTFILE', 'OUT']