docs:smbdotconf: fix a typo in oldpasswordallowedperiod.xml
[Samba.git] / bootstrap / config.py
blob8383aeb392da4b8ebd0ffeb39aeb903f60d0eae0
1 #!/usr/bin/env python3
3 # Copyright (C) Catalyst.Net Ltd 2019
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.
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.
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/>.
18 """
19 Manage dependencies and bootstrap environments for Samba.
21 Config file for packages and templates.
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')
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',
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'),
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', ''),
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'),
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 ('python3-setproctitle', 'python3-setproctitle'),
146 ('', 'libsemanage-python'),
147 ('', 'policycoreutils-python'),
149 # perl
150 ('libparse-yapp-perl', 'perl-Parse-Yapp'),
151 ('libjson-perl', 'perl-JSON'),
152 ('', 'perl-JSON-Parse'),
153 ('perl-modules', ''),
154 ('', 'perl-FindBin'),
155 ('', 'perl-Archive-Tar'),
156 ('', 'perl-ExtUtils-MakeMaker'),
157 ('', 'perl-Test-Base'),
158 ('', 'perl-generators'),
159 ('', 'perl-interpreter'),
161 # fs
162 ('xfslibs-dev', 'xfsprogs-devel'), # for xfs quota support
163 ('', 'glusterfs-api-devel'),
164 ('glusterfs-common', 'glusterfs-devel'),
165 ('libcephfs-dev', 'libcephfs-devel'),
167 # misc
168 # @ means group for rpm, use fedora as rpm default
169 ('build-essential', '@development-tools'),
170 ('debhelper', ''),
171 # rpm has no pkg for docbook-xml
172 ('docbook-xml', 'docbook-dtds'),
173 ('docbook-xsl', 'docbook-style-xsl'),
174 ('', 'keyutils-libs-devel'),
175 ('', 'which'),
179 DEB_PKGS = COMMON + [pkg for pkg, _ in PKGS if pkg]
180 RPM_PKGS = COMMON + [pkg for _, pkg in PKGS if pkg]
182 GENERATED_MARKER = r"""
184 # This file is generated by 'bootstrap/template.py --render'
185 # See also bootstrap/config.py
190 APT_BOOTSTRAP = r"""
191 #!/bin/bash
192 {GENERATED_MARKER}
193 set -xueo pipefail
195 export DEBIAN_FRONTEND=noninteractive
196 apt-get -y update
198 apt-get -y install \
199 {pkgs}
201 apt-get -y autoremove
202 apt-get -y autoclean
203 apt-get -y clean
207 YUM_BOOTSTRAP = r"""
208 #!/bin/bash
209 {GENERATED_MARKER}
210 set -xueo pipefail
212 yum update -y
213 yum install -y epel-release
214 yum install -y yum-plugin-copr
215 yum copr enable -y sergiomb/SambaAD
216 yum update -y
218 yum install -y \
219 {pkgs}
221 yum clean all
223 if [ ! -f /usr/bin/python3 ]; then
224 ln -sf /usr/bin/python3.6 /usr/bin/python3
228 CENTOS8_YUM_BOOTSTRAP = r"""
229 #!/bin/bash
230 {GENERATED_MARKER}
231 set -xueo pipefail
233 yum update -y
234 yum install -y dnf-plugins-core
235 yum install -y epel-release
237 yum -v repolist all
238 yum config-manager --set-enabled PowerTools -y || \
239 yum config-manager --set-enabled powertools -y
240 yum config-manager --set-enabled Devel -y || \
241 yum config-manager --set-enabled devel -y
242 yum update -y
244 yum install -y \
245 --setopt=install_weak_deps=False \
246 {pkgs}
248 yum clean all
251 DNF_BOOTSTRAP = r"""
252 #!/bin/bash
253 {GENERATED_MARKER}
254 set -xueo pipefail
256 dnf update -y
258 dnf install -y \
259 --setopt=install_weak_deps=False \
260 {pkgs}
262 dnf clean all
265 ZYPPER_BOOTSTRAP = r"""
266 #!/bin/bash
267 {GENERATED_MARKER}
268 set -xueo pipefail
270 zypper --non-interactive refresh
271 zypper --non-interactive update
272 zypper --non-interactive install \
273 --no-recommends \
274 system-user-nobody \
275 {pkgs}
277 zypper --non-interactive clean
279 if [ -f /usr/lib/mit/bin/krb5-config ]; then
280 ln -sf /usr/lib/mit/bin/krb5-config /usr/bin/krb5-config
284 # A generic shell script to setup locale
285 LOCALE_SETUP = r"""
286 #!/bin/bash
287 {GENERATED_MARKER}
288 set -xueo pipefail
290 # refer to /usr/share/i18n/locales
291 INPUTFILE=en_US
292 # refer to /usr/share/i18n/charmaps
293 CHARMAP=UTF-8
294 # locale to generate in /usr/lib/locale
295 # glibc/localedef will normalize UTF-8 to utf8, follow the naming style
296 LOCALE=$INPUTFILE.utf8
298 # if locale is already correct, exit
299 ( locale | grep LC_ALL | grep -i $LOCALE ) && exit 0
301 # if locale not available, generate locale into /usr/lib/locale
302 if ! ( locale --all-locales | grep -i $LOCALE )
303 then
304 # no-archive means create its own dir
305 localedef --inputfile $INPUTFILE --charmap $CHARMAP --no-archive $LOCALE
308 # update locale conf and global env file
309 # set both LC_ALL and LANG for safe
311 # update conf for Debian family
312 FILE=/etc/default/locale
313 if [ -f $FILE ]
314 then
315 echo LC_ALL="$LOCALE" > $FILE
316 echo LANG="$LOCALE" >> $FILE
319 # update conf for RedHat family
320 FILE=/etc/locale.conf
321 if [ -f $FILE ]
322 then
323 # LC_ALL is not valid in this file, set LANG only
324 echo LANG="$LOCALE" > $FILE
327 # update global env file
328 FILE=/etc/environment
329 if [ -f $FILE ]
330 then
331 # append LC_ALL if not exist
332 grep LC_ALL $FILE || echo LC_ALL="$LOCALE" >> $FILE
333 # append LANG if not exist
334 grep LANG $FILE || echo LANG="$LOCALE" >> $FILE
339 DOCKERFILE = r"""
340 {GENERATED_MARKER}
341 FROM {docker_image}
343 # pass in with --build-arg while build
344 ARG SHA1SUM
345 RUN [ -n $SHA1SUM ] && echo $SHA1SUM > /sha1sum.txt
347 ADD *.sh /tmp/
348 # need root permission, do it before USER samba
349 RUN /tmp/bootstrap.sh && /tmp/locale.sh
351 # if ld.gold exists, force link it to ld
352 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"
354 # make test can not work with root, so we have to create a new user
355 RUN useradd -m -U -s /bin/bash samba && \
356 mkdir -p /etc/sudoers.d && \
357 echo "samba ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/samba
359 USER samba
360 WORKDIR /home/samba
361 # samba tests rely on this
362 ENV USER=samba LC_ALL=en_US.utf8 LANG=en_US.utf8
365 # Vagrantfile snippet for each dist
366 VAGRANTFILE_SNIPPET = r"""
367 config.vm.define "{name}" do |v|
368 v.vm.box = "{vagrant_box}"
369 v.vm.hostname = "{name}"
370 v.vm.provision :shell, path: "{name}/bootstrap.sh"
371 v.vm.provision :shell, path: "{name}/locale.sh"
375 # global Vagrantfile with snippets for all dists
376 VAGRANTFILE_GLOBAL = r"""
377 {GENERATED_MARKER}
379 Vagrant.configure("2") do |config|
380 config.ssh.insert_key = false
382 {vagrantfile_snippets}
388 DEB_DISTS = {
389 'debian10': {
390 'docker_image': 'debian:10',
391 'vagrant_box': 'debian/buster64',
392 'replace': {
393 'language-pack-en': '', # included in locales
394 'liburing-dev': '', # not available
397 'ubuntu1604': {
398 'docker_image': 'ubuntu:16.04',
399 'vagrant_box': 'ubuntu/xenial64',
400 'replace': {
401 'python3-gpg': 'python3-gpgme',
402 'glusterfs-common': '',
403 'libcephfs-dev': '',
404 'liburing-dev': '', # not available
407 'ubuntu1804': {
408 'docker_image': 'ubuntu:18.04',
409 'vagrant_box': 'ubuntu/bionic64',
410 'replace': {
411 'liburing-dev': '', # not available
414 'ubuntu2004': {
415 'docker_image': 'ubuntu:20.04',
416 'vagrant_box': 'ubuntu/focal64',
417 'replace': {
418 'liburing-dev': '', # not available
424 RPM_DISTS = {
425 'centos7': {
426 'docker_image': 'centos:7',
427 'vagrant_box': 'centos/7',
428 'bootstrap': YUM_BOOTSTRAP,
429 'replace': {
430 'lsb-release': 'redhat-lsb',
431 'python3': 'python36',
432 'python3-cryptography': 'python36-cryptography',
433 'python3-devel': 'python36-devel',
434 'python3-dns': 'python36-dns',
435 'python3-pyasn1': 'python36-pyasn1',
436 'python3-gpg': 'python36-gpg',
437 'python3-iso8601' : 'python36-iso8601',
438 'python3-markdown': 'python36-markdown',
439 # although python36-devel is available
440 # after epel-release installed
441 # however, all other python3 pkgs are still python36-ish
442 'python2-gpg': 'pygpgme',
443 'python3-gpg': '', # no python3-gpg yet
444 '@development-tools': '"@Development Tools"', # add quotes
445 'glibc-langpack-en': '', # included in glibc-common
446 'glibc-locale-source': '', # included in glibc-common
447 # update perl core modules on centos
448 # fix: Can't locate Archive/Tar.pm in @INC
449 'perl': 'perl-core',
450 'perl-FindBin': '',
451 'rpcsvc-proto-devel': '',
452 'glusterfs-api-devel': '',
453 'glusterfs-devel': '',
454 'libcephfs-devel': '',
455 'gnutls-devel': 'compat-gnutls34-devel',
456 'liburing-devel': '', # not available
457 'python3-setproctitle': 'python36-setproctitle',
460 'centos8': {
461 'docker_image': 'centos:8',
462 'vagrant_box': 'centos/8',
463 'bootstrap': CENTOS8_YUM_BOOTSTRAP,
464 'replace': {
465 'lsb-release': 'redhat-lsb',
466 '@development-tools': '"@Development Tools"', # add quotes
467 'libsemanage-python': 'python3-libsemanage',
468 'lcov': '', # does not exist
469 'perl-JSON-Parse': '', # does not exist?
470 'perl-Test-Base': 'perl-Test-Simple',
471 'perl-FindBin': '',
472 'policycoreutils-python': 'python3-policycoreutils',
473 'liburing-devel': '', # not available yet, Add me back, once available!
476 'fedora32': {
477 'docker_image': 'fedora:32',
478 'vagrant_box': 'fedora/32-cloud-base',
479 'bootstrap': DNF_BOOTSTRAP,
480 'replace': {
481 'lsb-release': 'redhat-lsb',
482 'libsemanage-python': 'python3-libsemanage',
483 'policycoreutils-python': 'python3-policycoreutils',
484 'perl-FindBin': '',
487 'fedora33': {
488 'docker_image': 'fedora:33',
489 'vagrant_box': 'fedora/33-cloud-base',
490 'bootstrap': DNF_BOOTSTRAP,
491 'replace': {
492 'lsb-release': 'redhat-lsb',
493 'libsemanage-python': 'python3-libsemanage',
494 'policycoreutils-python': 'python3-policycoreutils',
497 'opensuse151': {
498 'docker_image': 'opensuse/leap:15.1',
499 'vagrant_box': 'opensuse/openSUSE-15.1-x86_64',
500 'bootstrap': ZYPPER_BOOTSTRAP,
501 'replace': {
502 '@development-tools': '',
503 'dbus-devel': 'dbus-1-devel',
504 'docbook-style-xsl': 'docbook-xsl-stylesheets',
505 'glibc-common': 'glibc-locale',
506 'glibc-locale-source': 'glibc-i18ndata',
507 'glibc-langpack-en': '',
508 'jansson-devel': 'libjansson-devel',
509 'keyutils-libs-devel': 'keyutils-devel',
510 'krb5-workstation': 'krb5-client',
511 'libnsl2-devel': 'libnsl-devel',
512 'libsemanage-python': 'python2-semanage',
513 'openldap-devel': 'openldap2-devel',
514 'perl-Archive-Tar': 'perl-Archive-Tar-Wrapper',
515 'perl-JSON-Parse': 'perl-JSON-XS',
516 'perl-generators': '',
517 'perl-interpreter': '',
518 'perl-FindBin': '',
519 'procps-ng': 'procps',
520 'python3-dns': 'python3-dnspython',
521 'python3-markdown': 'python3-Markdown',
522 'quota-devel': '',
523 'glusterfs-api-devel': '',
524 'libtasn1-tools': '', # asn1Parser is part of libtasn1
525 'mingw64-gcc': '', # doesn't exist
526 'liburing-devel': '', # not available
529 'opensuse152': {
530 'docker_image': 'opensuse/leap:15.2',
531 'vagrant_box': 'opensuse/openSUSE-15.2-x86_64',
532 'bootstrap': ZYPPER_BOOTSTRAP,
533 'replace': {
534 '@development-tools': '',
535 'dbus-devel': 'dbus-1-devel',
536 'docbook-style-xsl': 'docbook-xsl-stylesheets',
537 'glibc-common': 'glibc-locale',
538 'glibc-locale-source': 'glibc-i18ndata',
539 'glibc-langpack-en': '',
540 'jansson-devel': 'libjansson-devel',
541 'keyutils-libs-devel': 'keyutils-devel',
542 'krb5-workstation': 'krb5-client',
543 'libnsl2-devel': 'libnsl-devel',
544 'libsemanage-python': 'python2-semanage',
545 'openldap-devel': 'openldap2-devel',
546 'perl-Archive-Tar': 'perl-Archive-Tar-Wrapper',
547 'perl-JSON-Parse': 'perl-JSON-XS',
548 'perl-generators': '',
549 'perl-interpreter': '',
550 'perl-FindBin': '',
551 'procps-ng': 'procps',
552 'python3-dns': 'python3-dnspython',
553 'python3-markdown': 'python3-Markdown',
554 'quota-devel': '',
555 'glusterfs-api-devel': '',
556 'libtasn1-tools': '', # asn1Parser is part of libtasn1
562 DEB_FAMILY = {
563 'name': 'deb',
564 'pkgs': DEB_PKGS,
565 'bootstrap': APT_BOOTSTRAP, # family default
566 'dists': DEB_DISTS,
570 RPM_FAMILY = {
571 'name': 'rpm',
572 'pkgs': RPM_PKGS,
573 'bootstrap': YUM_BOOTSTRAP, # family default
574 'dists': RPM_DISTS,
578 YML_HEADER = r"""
580 packages:
584 def expand_family_dists(family):
585 dists = {}
586 for name, config in family['dists'].items():
587 config = config.copy()
588 config['name'] = name
589 config['home'] = join(OUT, name)
590 config['family'] = family['name']
591 config['GENERATED_MARKER'] = GENERATED_MARKER
593 # replace dist specific pkgs
594 replace = config.get('replace', {})
595 pkgs = []
596 for pkg in family['pkgs']:
597 pkg = replace.get(pkg, pkg) # replace if exists or get self
598 if pkg:
599 pkgs.append(pkg)
600 pkgs.sort()
602 lines = [' - {}'.format(pkg) for pkg in pkgs]
603 config['packages.yml'] = YML_HEADER.lstrip() + os.linesep.join(lines)
605 sep = ' \\' + os.linesep + ' '
606 config['pkgs'] = sep.join(pkgs)
608 # get dist bootstrap template or fall back to family default
609 bootstrap_template = config.get('bootstrap', family['bootstrap'])
610 config['bootstrap.sh'] = bootstrap_template.format(**config).strip()
611 config['locale.sh'] = LOCALE_SETUP.format(**config).strip()
613 config['Dockerfile'] = DOCKERFILE.format(**config).strip()
614 # keep the indent, no strip
615 config['vagrantfile_snippet'] = VAGRANTFILE_SNIPPET.format(**config)
617 dists[name] = config
618 return dists
621 # expanded config for dists
622 DEB_DISTS_EXP = expand_family_dists(DEB_FAMILY)
623 RPM_DISTS_EXP = expand_family_dists(RPM_FAMILY)
625 # assemble all together
626 DISTS = {}
627 DISTS.update(DEB_DISTS_EXP)
628 DISTS.update(RPM_DISTS_EXP)
631 def render_vagrantfile(dists):
633 Render all snippets for each dist into global Vagrantfile.
635 Vagrant supports multiple vms in one Vagrantfile.
636 This make it easier to manage the fleet, e.g:
638 start all: vagrant up
639 start one: vagrant up ubuntu1804
641 All other commands apply to above syntax, e.g.: status, destroy, provision
643 # sort dists by name and put all vagrantfile snippets together
644 snippets = [
645 dists[dist]['vagrantfile_snippet']
646 for dist in sorted(dists.keys())]
648 return VAGRANTFILE_GLOBAL.format(
649 vagrantfile_snippets=''.join(snippets),
650 GENERATED_MARKER=GENERATED_MARKER
654 VAGRANTFILE = render_vagrantfile(DISTS)
657 # data we need to expose
658 __all__ = ['DISTS', 'VAGRANTFILE', 'OUT']