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', ''),
 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-Parse'),
 151     ('perl-modules', ''),
 152     ('', 'perl-Archive-Tar'),
 153     ('', 'perl-ExtUtils-MakeMaker'),
 154     ('', 'perl-Test-Base'),
 155     ('', 'perl-generators'),
 156     ('', 'perl-interpreter'),
 157
 158     # fs
 159     ('xfslibs-dev', 'xfsprogs-devel'), # for xfs quota support
 160     ('', 'glusterfs-api-devel'),
 161     ('glusterfs-common', 'glusterfs-devel'),
 162     ('libcephfs-dev', 'libcephfs-devel'),
 163
 164     # misc
 165     # @ means group for rpm, use fedora as rpm default
 166     ('build-essential', '@development-tools'),
 167     ('debhelper', ''),
 168     # rpm has no pkg for docbook-xml
 169     ('docbook-xml', 'docbook-dtds'),
 170     ('docbook-xsl', 'docbook-style-xsl'),
 171     ('', 'keyutils-libs-devel'),
 172     ('', 'which'),
 173 ]
 174
 175
 176 DEB_PKGS = COMMON + [pkg for pkg, _ in PKGS if pkg]
 177 RPM_PKGS = COMMON + [pkg for _, pkg in PKGS if pkg]
 178
 179 GENERATED_MARKER = r"""
 180 #
 181 # This file is generated by 'bootstrap/template.py --render'
 182 # See also bootstrap/config.py
 183 #
 184 """
 185
 186
 187 APT_BOOTSTRAP = r"""
 188 #!/bin/bash
 189 {GENERATED_MARKER}
 190 set -xueo pipefail
 191
 192 export DEBIAN_FRONTEND=noninteractive
 193 apt-get -y update
 194
 195 apt-get -y install \
 196     {pkgs}
 197
 198 apt-get -y autoremove
 199 apt-get -y autoclean
 200 apt-get -y clean
 201 """
 202
 203
 204 YUM_BOOTSTRAP = r"""
 205 #!/bin/bash
 206 {GENERATED_MARKER}
 207 set -xueo pipefail
 208
 209 yum update -y
 210 yum install -y epel-release
 211 yum install -y yum-plugin-copr
 212 yum copr enable -y sergiomb/SambaAD
 213 yum update -y
 214
 215 yum install -y \
 216     {pkgs}
 217
 218 yum clean all
 219
 220 if [ ! -f /usr/bin/python3 ]; then
 221     ln -sf /usr/bin/python3.6 /usr/bin/python3
 222 fi
 223 """
 224
 225 CENTOS8_YUM_BOOTSTRAP = r"""
 226 #!/bin/bash
 227 {GENERATED_MARKER}
 228 set -xueo pipefail
 229
 230 yum update -y
 231 yum install -y dnf-plugins-core
 232 yum install -y epel-release
 233 yum config-manager --set-enabled PowerTools -y
 234 yum update -y
 235
 236 yum install -y \
 237     --setopt=install_weak_deps=False \
 238     {pkgs}
 239
 240 yum clean all
 241 """
 242
 243 DNF_BOOTSTRAP = r"""
 244 #!/bin/bash
 245 {GENERATED_MARKER}
 246 set -xueo pipefail
 247
 248 dnf update -y
 249
 250 dnf install -y \
 251     --setopt=install_weak_deps=False \
 252     {pkgs}
 253
 254 dnf clean all
 255 """
 256
 257 ZYPPER_BOOTSTRAP = r"""
 258 #!/bin/bash
 259 {GENERATED_MARKER}
 260 set -xueo pipefail
 261
 262 zypper --non-interactive refresh
 263 zypper --non-interactive update
 264 zypper --non-interactive install \
 265     --no-recommends \
 266     system-user-nobody \
 267     {pkgs}
 268
 269 zypper --non-interactive clean
 270
 271 if [ -f /usr/lib/mit/bin/krb5-config ]; then
 272     ln -sf /usr/lib/mit/bin/krb5-config /usr/bin/krb5-config
 273 fi
 274 """
 275
 276 # A generic shell script to setup locale
 277 LOCALE_SETUP = r"""
 278 #!/bin/bash
 279 {GENERATED_MARKER}
 280 set -xueo pipefail
 281
 282 # refer to /usr/share/i18n/locales
 283 INPUTFILE=en_US
 284 # refer to /usr/share/i18n/charmaps
 285 CHARMAP=UTF-8
 286 # locale to generate in /usr/lib/locale
 287 # glibc/localedef will normalize UTF-8 to utf8, follow the naming style
 288 LOCALE=$INPUTFILE.utf8
 289
 290 # if locale is already correct, exit
 291 ( locale | grep LC_ALL | grep -i $LOCALE ) && exit 0
 292
 293 # if locale not available, generate locale into /usr/lib/locale
 294 if ! ( locale --all-locales | grep -i $LOCALE )
 295 then
 296     # no-archive means create its own dir
 297     localedef --inputfile $INPUTFILE --charmap $CHARMAP --no-archive $LOCALE
 298 fi
 299
 300 # update locale conf and global env file
 301 # set both LC_ALL and LANG for safe
 302
 303 # update conf for Debian family
 304 FILE=/etc/default/locale
 305 if [ -f $FILE ]
 306 then
 307     echo LC_ALL="$LOCALE" > $FILE
 308     echo LANG="$LOCALE" >> $FILE
 309 fi
 310
 311 # update conf for RedHat family
 312 FILE=/etc/locale.conf
 313 if [ -f $FILE ]
 314 then
 315     # LC_ALL is not valid in this file, set LANG only
 316     echo LANG="$LOCALE" > $FILE
 317 fi
 318
 319 # update global env file
 320 FILE=/etc/environment
 321 if [ -f $FILE ]
 322 then
 323     # append LC_ALL if not exist
 324     grep LC_ALL $FILE || echo LC_ALL="$LOCALE" >> $FILE
 325     # append LANG if not exist
 326     grep LANG $FILE || echo LANG="$LOCALE" >> $FILE
 327 fi
 328 """
 329
 330
 331 DOCKERFILE = r"""
 332 {GENERATED_MARKER}
 333 FROM {docker_image}
 334
 335 # pass in with --build-arg while build
 336 ARG SHA1SUM
 337 RUN [ -n $SHA1SUM ] && echo $SHA1SUM > /sha1sum.txt
 338
 339 ADD *.sh /tmp/
 340 # need root permission, do it before USER samba
 341 RUN /tmp/bootstrap.sh && /tmp/locale.sh
 342
 343 # if ld.gold exists, force link it to ld
 344 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"
 345
 346 # make test can not work with root, so we have to create a new user
 347 RUN useradd -m -U -s /bin/bash samba && \
 348     mkdir -p /etc/sudoers.d && \
 349     echo "samba ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/samba
 350
 351 USER samba
 352 WORKDIR /home/samba
 353 # samba tests rely on this
 354 ENV USER=samba LC_ALL=en_US.utf8 LANG=en_US.utf8
 355 """
 356
 357 # Vagrantfile snippet for each dist
 358 VAGRANTFILE_SNIPPET = r"""
 359     config.vm.define "{name}" do |v|
 360         v.vm.box = "{vagrant_box}"
 361         v.vm.hostname = "{name}"
 362         v.vm.provision :shell, path: "{name}/bootstrap.sh"
 363         v.vm.provision :shell, path: "{name}/locale.sh"
 364     end
 365 """
 366
 367 # global Vagrantfile with snippets for all dists
 368 VAGRANTFILE_GLOBAL = r"""
 369 {GENERATED_MARKER}
 370
 371 Vagrant.configure("2") do |config|
 372     config.ssh.insert_key = false
 373
 374 {vagrantfile_snippets}
 375
 376 end
 377 """
 378
 379
 380 DEB_DISTS = {
 381     'debian10': {
 382         'docker_image': 'debian:10',
 383         'vagrant_box': 'debian/buster64',
 384         'replace': {
 385             'language-pack-en': '',   # included in locales
 386             'liburing-dev': '',   # not available
 387         }
 388     },
 389     'ubuntu1604': {
 390         'docker_image': 'ubuntu:16.04',
 391         'vagrant_box': 'ubuntu/xenial64',
 392         'replace': {
 393             'python-gpg': 'python-gpgme',
 394             'python3-gpg': 'python3-gpgme',
 395             'glusterfs-common': '',
 396             'libcephfs-dev': '',
 397             'liburing-dev': '',   # not available
 398         }
 399     },
 400     'ubuntu1804': {
 401         'docker_image': 'ubuntu:18.04',
 402         'vagrant_box': 'ubuntu/bionic64',
 403         'replace': {
 404             'liburing-dev': '',   # not available
 405         }
 406     },
 407     'ubuntu2004': {
 408         'docker_image': 'ubuntu:20.04',
 409         'vagrant_box': 'ubuntu/focal64',
 410         'replace': {
 411             'liburing-dev': '',   # not available
 412         }
 413     },
 414 }
 415
 416
 417 RPM_DISTS = {
 418     'centos7': {
 419         'docker_image': 'centos:7',
 420         'vagrant_box': 'centos/7',
 421         'bootstrap': YUM_BOOTSTRAP,
 422         'replace': {
 423             'lsb-release': 'redhat-lsb',
 424             'python3': 'python36',
 425             'python3-cryptography': 'python36-cryptography',
 426             'python3-devel': 'python36-devel',
 427             'python3-dns': 'python36-dns',
 428             'python3-pyasn1': 'python36-pyasn1',
 429             'python3-gpg': 'python36-gpg',
 430             'python3-iso8601' : 'python36-iso8601',
 431             'python3-markdown': 'python36-markdown',
 432             # although python36-devel is available
 433             # after epel-release installed
 434             # however, all other python3 pkgs are still python36-ish
 435             'python2-gpg': 'pygpgme',
 436             'python3-gpg': '',  # no python3-gpg yet
 437             '@development-tools': '"@Development Tools"',  # add quotes
 438             'glibc-langpack-en': '',  # included in glibc-common
 439             'glibc-locale-source': '',  # included in glibc-common
 440             # update perl core modules on centos
 441             # fix: Can't locate Archive/Tar.pm in @INC
 442             'perl': 'perl-core',
 443             'rpcsvc-proto-devel': '',
 444             'glusterfs-api-devel': '',
 445             'glusterfs-devel': '',
 446             'libcephfs-devel': '',
 447             'gnutls-devel': 'compat-gnutls34-devel',
 448             'liburing-devel': '',   # not available
 449         }
 450     },
 451     'centos8': {
 452         'docker_image': 'centos:8',
 453         'vagrant_box': 'centos/8',
 454         'bootstrap': CENTOS8_YUM_BOOTSTRAP,
 455         'replace': {
 456             'lsb-release': 'redhat-lsb',
 457             '@development-tools': '"@Development Tools"',  # add quotes
 458             'libsemanage-python': 'python3-libsemanage',
 459             'lcov': '', # does not exist
 460             'perl-JSON-Parse': '', # does not exist?
 461             'perl-Test-Base': 'perl-Test-Simple',
 462             'policycoreutils-python': 'python3-policycoreutils',
 463             'quota-devel': '', # FIXME: Add me back, once available!
 464             'liburing-devel': '', # not available yet, Add me back, once available!
 465         }
 466     },
 467     'fedora31': {
 468         'docker_image': 'fedora:31',
 469         'vagrant_box': 'fedora/31-cloud-base',
 470         'bootstrap': DNF_BOOTSTRAP,
 471         'replace': {
 472             'lsb-release': 'redhat-lsb',
 473             'libsemanage-python': 'python3-libsemanage',
 474             'policycoreutils-python': 'python3-policycoreutils',
 475         }
 476     },
 477     'fedora32': {
 478         'docker_image': 'fedora:32',
 479         'vagrant_box': 'fedora/32-cloud-base',
 480         'bootstrap': DNF_BOOTSTRAP,
 481         'replace': {
 482             'lsb-release': 'redhat-lsb',
 483             'libsemanage-python': 'python3-libsemanage',
 484             'policycoreutils-python': 'python3-policycoreutils',
 485         }
 486     },
 487     'opensuse150': {
 488         'docker_image': 'opensuse/leap:15.0',
 489         'vagrant_box': 'opensuse/openSUSE-15.0-x86_64',
 490         'bootstrap': ZYPPER_BOOTSTRAP,
 491         'replace': {
 492             '@development-tools': '',
 493             'dbus-devel': 'dbus-1-devel',
 494             'docbook-style-xsl': 'docbook-xsl-stylesheets',
 495             'glibc-common': 'glibc-locale',
 496             'glibc-locale-source': 'glibc-i18ndata',
 497             'glibc-langpack-en': '',
 498             'jansson-devel': 'libjansson-devel',
 499             'keyutils-libs-devel': 'keyutils-devel',
 500             'krb5-workstation': 'krb5-client',
 501             'libnsl2-devel': 'libnsl-devel',
 502             'libsemanage-python': 'python2-semanage',
 503             'openldap-devel': 'openldap2-devel',
 504             'perl-Archive-Tar': 'perl-Archive-Tar-Wrapper',
 505             'perl-JSON-Parse': 'perl-JSON-XS',
 506             'perl-generators': '',
 507             'perl-interpreter': '',
 508             'procps-ng': 'procps',
 509             'python-dns': 'python2-dnspython',
 510             'python3-dns': 'python3-dnspython',
 511             'python3-markdown': 'python3-Markdown',
 512             'quota-devel': '',
 513             'glusterfs-api-devel': '',
 514             'libtasn1-tools': '', # asn1Parser is part of libtasn1
 515             'mingw64-gcc': '', # doesn't exist
 516             'liburing-devel': '',   # not available
 517         }
 518     },
 519     'opensuse151': {
 520         'docker_image': 'opensuse/leap:15.1',
 521         'vagrant_box': 'opensuse/openSUSE-15.1-x86_64',
 522         'bootstrap': ZYPPER_BOOTSTRAP,
 523         'replace': {
 524             '@development-tools': '',
 525             'dbus-devel': 'dbus-1-devel',
 526             'docbook-style-xsl': 'docbook-xsl-stylesheets',
 527             'glibc-common': 'glibc-locale',
 528             'glibc-locale-source': 'glibc-i18ndata',
 529             'glibc-langpack-en': '',
 530             'jansson-devel': 'libjansson-devel',
 531             'keyutils-libs-devel': 'keyutils-devel',
 532             'krb5-workstation': 'krb5-client',
 533             'libnsl2-devel': 'libnsl-devel',
 534             'libsemanage-python': 'python2-semanage',
 535             'openldap-devel': 'openldap2-devel',
 536             'perl-Archive-Tar': 'perl-Archive-Tar-Wrapper',
 537             'perl-JSON-Parse': 'perl-JSON-XS',
 538             'perl-generators': '',
 539             'perl-interpreter': '',
 540             'procps-ng': 'procps',
 541             'python-dns': 'python2-dnspython',
 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']