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