s3: smbd: Add utility function smbd_smb2_is_last_in_compound().
[Samba.git] / bootstrap / config.py
blob621912a7d94d5123a81f2b986dc5838feb0426da
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 Update the lists in this file to require new packages in the
24 container images used in GitLab CI
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')
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 'lcov',
53 'make',
54 'patch',
55 'perl',
56 'psmisc', # for pstree in test
57 'rng-tools',
58 'rsync',
59 'sed',
60 'sudo', # docker images has no sudo by default
61 'tar',
62 'tree',
63 'wget',
67 # define pkgs for all packaging systems in parallel
68 # make it easier to find missing ones
69 # use latest ubuntu and fedora as defaults
70 # deb, rpm, ...
71 PKGS = [
72 # NAME1-dev, NAME2-devel
73 ('lmdb-utils', 'lmdb'),
74 ('mingw-w64', 'mingw64-gcc'),
75 ('zlib1g-dev', 'zlib-devel'),
76 ('libbsd-dev', 'libbsd-devel'),
77 ('liburing-dev', 'liburing-devel'),
78 ('libarchive-dev', 'libarchive-devel'),
79 ('libblkid-dev', 'libblkid-devel'),
80 ('libcap-dev', 'libcap-devel'),
81 ('libacl1-dev', 'libacl-devel'),
82 ('libattr1-dev', 'libattr-devel'),
84 # libNAME1-dev, NAME2-devel
85 ('libpopt-dev', 'popt-devel'),
86 ('libreadline-dev', 'readline-devel'),
87 ('libjansson-dev', 'jansson-devel'),
88 ('liblmdb-dev', 'lmdb-devel'),
89 ('libncurses5-dev', 'ncurses-devel'),
90 # NOTE: Debian 7+ or Ubuntu 16.04+
91 ('libsystemd-dev', 'systemd-devel'),
92 ('libkrb5-dev', 'krb5-devel'),
93 ('libldap2-dev', 'openldap-devel'),
94 ('libcups2-dev', 'cups-devel'),
95 ('libpam0g-dev', 'pam-devel'),
96 ('libgpgme11-dev', 'gpgme-devel'),
97 # NOTE: Debian 8+ and Ubuntu 14.04+
98 ('libgnutls28-dev', 'gnutls-devel'),
99 ('libtasn1-bin', 'libtasn1-tools'),
100 ('libtasn1-dev', 'libtasn1-devel'),
101 ('', 'quota-devel'),
102 ('uuid-dev', 'libuuid-devel'),
103 ('libjs-jquery', ''),
104 ('libavahi-common-dev', 'avahi-devel'),
105 ('libdbus-1-dev', 'dbus-devel'),
106 ('libpcap-dev', 'libpcap-devel'),
107 ('libunwind-dev', 'libunwind-devel'), # for back trace
108 ('libglib2.0-dev', 'glib2-devel'),
109 ('libicu-dev', 'libicu-devel'),
110 ('heimdal-multidev', ''),
112 # NAME1, NAME2
113 # for debian, locales provide locale support with language packs
114 # ubuntu split language packs to language-pack-xx
115 # for centos, glibc-common provide locale support with language packs
116 # fedora split language packs to glibc-langpack-xx
117 ('locales', 'glibc-common'), # required for locale
118 ('language-pack-en', 'glibc-langpack-en'), # we need en_US.UTF-8
119 ('bind9utils', 'bind-utils'),
120 ('dnsutils', ''),
121 ('xsltproc', 'libxslt'),
122 ('krb5-user', 'krb5-workstation'),
123 ('krb5-config', ''),
124 ('krb5-kdc', 'krb5-server'),
125 ('apt-utils', 'yum-utils'),
126 ('pkg-config', 'pkgconfig'),
127 ('procps', 'procps-ng'), # required for the free cmd in tests
128 ('lsb-release', 'lsb-release'), # we need lsb_relase to show info
129 ('', 'rpcgen'), # required for test
130 # refer: https://fedoraproject.org/wiki/Changes/SunRPCRemoval
131 ('', 'libtirpc-devel'), # for <rpc/rpc.h> header on fedora
132 ('', 'rpcsvc-proto-devel'), # for <rpcsvc/rquota.h> header
133 ('mawk', 'gawk'),
135 ('python3', 'python3'),
136 ('python3-cryptography', 'python3-cryptography'), # for krb5 tests
137 ('python3-dev', 'python3-devel'),
138 ('python3-dbg', ''),
139 ('python3-iso8601', 'python3-iso8601'),
140 ('python3-gpg', 'python3-gpg'), # defaults to ubuntu/fedora latest
141 ('python3-markdown', 'python3-markdown'),
142 ('python3-matplotlib', ''),
143 ('python3-dnspython', 'python3-dns'),
144 ('python3-pexpect', ''), # for wintest only
145 ('python3-pyasn1', 'python3-pyasn1'), # for krb5 tests
146 ('python3-setproctitle', 'python3-setproctitle'),
148 ('', 'python3-libsemanage'),
149 ('', 'python3-policycoreutils'),
151 # perl
152 ('libparse-yapp-perl', 'perl-Parse-Yapp'),
153 ('libjson-perl', 'perl-JSON'),
154 ('', 'perl-JSON-Parse'),
155 ('perl-modules', ''),
156 ('', 'perl-FindBin'),
157 ('', 'perl-Archive-Tar'),
158 ('', 'perl-ExtUtils-MakeMaker'),
159 ('', 'perl-Test-Base'),
160 ('', 'perl-generators'),
161 ('', 'perl-interpreter'),
163 # fs
164 ('xfslibs-dev', 'xfsprogs-devel'), # for xfs quota support
165 ('', 'glusterfs-api-devel'),
166 ('glusterfs-common', 'glusterfs-devel'),
167 ('libcephfs-dev', 'libcephfs-devel'),
169 # spotlight
170 ('libtracker-sparql-2.0-dev', 'tracker-devel'),
172 # misc
173 # @ means group for rpm, use fedora as rpm default
174 ('build-essential', '@development-tools'),
175 ('debhelper', ''),
176 # rpm has no pkg for docbook-xml
177 ('docbook-xml', 'docbook-dtds'),
178 ('docbook-xsl', 'docbook-style-xsl'),
179 ('', 'keyutils-libs-devel'),
180 ('', 'which'),
184 DEB_PKGS = COMMON + [pkg for pkg, _ in PKGS if pkg]
185 RPM_PKGS = COMMON + [pkg for _, pkg in PKGS if pkg]
187 GENERATED_MARKER = r"""
189 # This file is generated by 'bootstrap/template.py --render'
190 # See also bootstrap/config.py
195 APT_BOOTSTRAP = r"""
196 #!/bin/bash
197 {GENERATED_MARKER}
198 set -xueo pipefail
200 export DEBIAN_FRONTEND=noninteractive
201 apt-get -y update
203 apt-get -y install \
204 {pkgs}
206 apt-get -y autoremove
207 apt-get -y autoclean
208 apt-get -y clean
212 YUM_BOOTSTRAP = r"""
213 #!/bin/bash
214 {GENERATED_MARKER}
215 set -xueo pipefail
217 yum update -y
218 yum install -y epel-release
219 yum install -y yum-plugin-copr
220 yum copr enable -y sergiomb/SambaAD
221 yum update -y
223 yum install -y \
224 {pkgs}
226 yum clean all
228 if [ ! -f /usr/bin/python3 ]; then
229 ln -sf /usr/bin/python3.6 /usr/bin/python3
233 CENTOS8_YUM_BOOTSTRAP = r"""
234 #!/bin/bash
235 {GENERATED_MARKER}
236 set -xueo pipefail
238 yum update -y
239 yum install -y dnf-plugins-core
240 yum install -y epel-release
242 yum -v repolist all
243 yum config-manager --set-enabled PowerTools -y || \
244 yum config-manager --set-enabled powertools -y
245 yum config-manager --set-enabled Devel -y || \
246 yum config-manager --set-enabled devel -y
247 yum update -y
249 yum install -y \
250 --setopt=install_weak_deps=False \
251 {pkgs}
253 yum clean all
256 DNF_BOOTSTRAP = r"""
257 #!/bin/bash
258 {GENERATED_MARKER}
259 set -xueo pipefail
261 dnf update -y
263 dnf install -y \
264 --setopt=install_weak_deps=False \
265 {pkgs}
267 dnf clean all
270 ZYPPER_BOOTSTRAP = r"""
271 #!/bin/bash
272 {GENERATED_MARKER}
273 set -xueo pipefail
275 zypper --non-interactive refresh
276 zypper --non-interactive update
277 zypper --non-interactive install \
278 --no-recommends \
279 system-user-nobody \
280 {pkgs}
282 zypper --non-interactive clean
284 if [ -f /usr/lib/mit/bin/krb5-config ]; then
285 ln -sf /usr/lib/mit/bin/krb5-config /usr/bin/krb5-config
289 # A generic shell script to setup locale
290 LOCALE_SETUP = r"""
291 #!/bin/bash
292 {GENERATED_MARKER}
293 set -xueo pipefail
295 # refer to /usr/share/i18n/locales
296 INPUTFILE=en_US
297 # refer to /usr/share/i18n/charmaps
298 CHARMAP=UTF-8
299 # locale to generate in /usr/lib/locale
300 # glibc/localedef will normalize UTF-8 to utf8, follow the naming style
301 LOCALE=$INPUTFILE.utf8
303 # if locale is already correct, exit
304 ( locale | grep LC_ALL | grep -i $LOCALE ) && exit 0
306 # if locale not available, generate locale into /usr/lib/locale
307 if ! ( locale --all-locales | grep -i $LOCALE )
308 then
309 # no-archive means create its own dir
310 localedef --inputfile $INPUTFILE --charmap $CHARMAP --no-archive $LOCALE
313 # update locale conf and global env file
314 # set both LC_ALL and LANG for safe
316 # update conf for Debian family
317 FILE=/etc/default/locale
318 if [ -f $FILE ]
319 then
320 echo LC_ALL="$LOCALE" > $FILE
321 echo LANG="$LOCALE" >> $FILE
324 # update conf for RedHat family
325 FILE=/etc/locale.conf
326 if [ -f $FILE ]
327 then
328 # LC_ALL is not valid in this file, set LANG only
329 echo LANG="$LOCALE" > $FILE
332 # update global env file
333 FILE=/etc/environment
334 if [ -f $FILE ]
335 then
336 # append LC_ALL if not exist
337 grep LC_ALL $FILE || echo LC_ALL="$LOCALE" >> $FILE
338 # append LANG if not exist
339 grep LANG $FILE || echo LANG="$LOCALE" >> $FILE
344 DOCKERFILE = r"""
345 {GENERATED_MARKER}
346 FROM {docker_image}
348 # pass in with --build-arg while build
349 ARG SHA1SUM
350 RUN [ -n $SHA1SUM ] && echo $SHA1SUM > /sha1sum.txt
352 ADD *.sh /tmp/
353 # need root permission, do it before USER samba
354 RUN /tmp/bootstrap.sh && /tmp/locale.sh
356 # if ld.gold exists, force link it to ld
357 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"
359 # make test can not work with root, so we have to create a new user
360 RUN useradd -m -U -s /bin/bash samba && \
361 mkdir -p /etc/sudoers.d && \
362 echo "samba ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/samba
364 USER samba
365 WORKDIR /home/samba
366 # samba tests rely on this
367 ENV USER=samba LC_ALL=en_US.utf8 LANG=en_US.utf8
370 # Vagrantfile snippet for each dist
371 VAGRANTFILE_SNIPPET = r"""
372 config.vm.define "{name}" do |v|
373 v.vm.box = "{vagrant_box}"
374 v.vm.hostname = "{name}"
375 v.vm.provision :shell, path: "{name}/bootstrap.sh"
376 v.vm.provision :shell, path: "{name}/locale.sh"
380 # global Vagrantfile with snippets for all dists
381 VAGRANTFILE_GLOBAL = r"""
382 {GENERATED_MARKER}
384 Vagrant.configure("2") do |config|
385 config.ssh.insert_key = false
387 {vagrantfile_snippets}
393 DEB_DISTS = {
394 'debian10': {
395 'docker_image': 'debian:10',
396 'vagrant_box': 'debian/buster64',
397 'replace': {
398 'language-pack-en': '', # included in locales
399 'liburing-dev': '', # not available
402 'debian11': {
403 'docker_image': 'debian:11',
404 'vagrant_box': 'debian/bullseye64',
405 'replace': {
406 'language-pack-en': '', # included in locales
409 'ubuntu1804': {
410 'docker_image': 'ubuntu:18.04',
411 'vagrant_box': 'ubuntu/bionic64',
412 'replace': {
413 'liburing-dev': '', # not available
416 'ubuntu2004': {
417 'docker_image': 'ubuntu:20.04',
418 'vagrant_box': 'ubuntu/focal64',
419 'replace': {
420 'liburing-dev': '', # not available
426 RPM_DISTS = {
427 'centos7': {
428 'docker_image': 'centos:7',
429 'vagrant_box': 'centos/7',
430 'bootstrap': YUM_BOOTSTRAP,
431 'replace': {
432 'lsb-release': 'redhat-lsb',
433 'python3': 'python36',
434 'python3-cryptography': 'python36-cryptography',
435 'python3-devel': 'python36-devel',
436 'python3-dns': 'python36-dns',
437 'python3-pyasn1': 'python36-pyasn1',
438 'python3-gpg': 'python36-gpg',
439 'python3-iso8601' : 'python36-iso8601',
440 'python3-markdown': 'python36-markdown',
441 # although python36-devel is available
442 # after epel-release installed
443 # however, all other python3 pkgs are still python36-ish
444 'python2-gpg': 'pygpgme',
445 'python3-gpg': '', # no python3-gpg yet
446 '@development-tools': '"@Development Tools"', # add quotes
447 'glibc-langpack-en': '', # included in glibc-common
448 'glibc-locale-source': '', # included in glibc-common
449 # update perl core modules on centos
450 # fix: Can't locate Archive/Tar.pm in @INC
451 'perl': 'perl-core',
452 'perl-FindBin': '',
453 'rpcsvc-proto-devel': '',
454 'glusterfs-api-devel': '',
455 'glusterfs-devel': '',
456 'libcephfs-devel': '',
457 'gnutls-devel': 'compat-gnutls37-devel',
458 'liburing-devel': '', # not available
459 'python3-setproctitle': 'python36-setproctitle',
460 'tracker-devel': '', # do not install
463 'centos8': {
464 'docker_image': 'centos:8',
465 'vagrant_box': 'centos/8',
466 'bootstrap': CENTOS8_YUM_BOOTSTRAP,
467 'replace': {
468 'lsb-release': 'redhat-lsb',
469 '@development-tools': '"@Development Tools"', # add quotes
470 'lcov': '', # does not exist
471 'perl-JSON-Parse': '', # does not exist?
472 'perl-Test-Base': 'perl-Test-Simple',
473 'perl-FindBin': '',
474 'liburing-devel': '', # not available yet, Add me back, once available!
477 'fedora34': {
478 'docker_image': 'fedora:34',
479 'vagrant_box': 'fedora/34-cloud-base',
480 'bootstrap': DNF_BOOTSTRAP,
481 'replace': {
482 'lsb-release': 'redhat-lsb',
483 'perl-FindBin': '',
484 'python3-iso8601': 'python3-dateutil',
485 'libtracker-sparql-2.0-dev': '', # only tracker 3.x is available
488 'fedora35': {
489 'docker_image': 'fedora:35',
490 'vagrant_box': 'fedora/35-cloud-base',
491 'bootstrap': DNF_BOOTSTRAP,
492 'replace': {
493 'lsb-release': 'redhat-lsb',
494 'perl-FindBin': '',
495 'python3-iso8601': 'python3-dateutil',
496 'libtracker-sparql-2.0-dev': '', # only tracker 3.x is available
499 'opensuse151': {
500 'docker_image': 'opensuse/leap:15.1',
501 'vagrant_box': 'opensuse/openSUSE-15.1-x86_64',
502 'bootstrap': ZYPPER_BOOTSTRAP,
503 'replace': {
504 '@development-tools': '',
505 'dbus-devel': 'dbus-1-devel',
506 'docbook-style-xsl': 'docbook-xsl-stylesheets',
507 'glibc-common': 'glibc-locale',
508 'glibc-locale-source': 'glibc-i18ndata',
509 'glibc-langpack-en': '',
510 'jansson-devel': 'libjansson-devel',
511 'keyutils-libs-devel': 'keyutils-devel',
512 'krb5-workstation': 'krb5-client',
513 'python3-libsemanage': 'python2-semanage',
514 'openldap-devel': 'openldap2-devel',
515 'perl-Archive-Tar': 'perl-Archive-Tar-Wrapper',
516 'perl-JSON-Parse': 'perl-JSON-XS',
517 'perl-generators': '',
518 'perl-interpreter': '',
519 'perl-FindBin': '',
520 'procps-ng': 'procps',
521 'python3-dns': 'python3-dnspython',
522 'python3-markdown': 'python3-Markdown',
523 'quota-devel': '',
524 'glusterfs-api-devel': '',
525 'libtasn1-tools': '', # asn1Parser is part of libtasn1
526 'mingw64-gcc': '', # doesn't exist
527 'liburing-devel': '', # not available
530 'opensuse152': {
531 'docker_image': 'opensuse/leap:15.2',
532 'vagrant_box': 'opensuse/openSUSE-15.2-x86_64',
533 'bootstrap': ZYPPER_BOOTSTRAP,
534 'replace': {
535 '@development-tools': '',
536 'dbus-devel': 'dbus-1-devel',
537 'docbook-style-xsl': 'docbook-xsl-stylesheets',
538 'glibc-common': 'glibc-locale',
539 'glibc-locale-source': 'glibc-i18ndata',
540 'glibc-langpack-en': '',
541 'jansson-devel': 'libjansson-devel',
542 'keyutils-libs-devel': 'keyutils-devel',
543 'krb5-workstation': 'krb5-client',
544 'python3-libsemanage': '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-iso8601': 'python3-python-dateutil',
553 'python3-dns': 'python3-dnspython',
554 'python3-markdown': 'python3-Markdown',
555 'quota-devel': '',
556 'glusterfs-api-devel': '',
557 'libtasn1-tools': '', # asn1Parser is part of libtasn1
563 DEB_FAMILY = {
564 'name': 'deb',
565 'pkgs': DEB_PKGS,
566 'bootstrap': APT_BOOTSTRAP, # family default
567 'dists': DEB_DISTS,
571 RPM_FAMILY = {
572 'name': 'rpm',
573 'pkgs': RPM_PKGS,
574 'bootstrap': YUM_BOOTSTRAP, # family default
575 'dists': RPM_DISTS,
579 YML_HEADER = r"""
581 packages:
585 def expand_family_dists(family):
586 dists = {}
587 for name, config in family['dists'].items():
588 config = config.copy()
589 config['name'] = name
590 config['home'] = join(OUT, name)
591 config['family'] = family['name']
592 config['GENERATED_MARKER'] = GENERATED_MARKER
594 # replace dist specific pkgs
595 replace = config.get('replace', {})
596 pkgs = []
597 for pkg in family['pkgs']:
598 pkg = replace.get(pkg, pkg) # replace if exists or get self
599 if pkg:
600 pkgs.append(pkg)
601 pkgs.sort()
603 lines = [' - {}'.format(pkg) for pkg in pkgs]
604 config['packages.yml'] = YML_HEADER.lstrip() + os.linesep.join(lines)
606 sep = ' \\' + os.linesep + ' '
607 config['pkgs'] = sep.join(pkgs)
609 # get dist bootstrap template or fall back to family default
610 bootstrap_template = config.get('bootstrap', family['bootstrap'])
611 config['bootstrap.sh'] = bootstrap_template.format(**config).strip()
612 config['locale.sh'] = LOCALE_SETUP.format(**config).strip()
614 config['Dockerfile'] = DOCKERFILE.format(**config).strip()
615 # keep the indent, no strip
616 config['vagrantfile_snippet'] = VAGRANTFILE_SNIPPET.format(**config)
618 dists[name] = config
619 return dists
622 # expanded config for dists
623 DEB_DISTS_EXP = expand_family_dists(DEB_FAMILY)
624 RPM_DISTS_EXP = expand_family_dists(RPM_FAMILY)
626 # assemble all together
627 DISTS = {}
628 DISTS.update(DEB_DISTS_EXP)
629 DISTS.update(RPM_DISTS_EXP)
632 def render_vagrantfile(dists):
634 Render all snippets for each dist into global Vagrantfile.
636 Vagrant supports multiple vms in one Vagrantfile.
637 This make it easier to manage the fleet, e.g:
639 start all: vagrant up
640 start one: vagrant up ubuntu1804
642 All other commands apply to above syntax, e.g.: status, destroy, provision
644 # sort dists by name and put all vagrantfile snippets together
645 snippets = [
646 dists[dist]['vagrantfile_snippet']
647 for dist in sorted(dists.keys())]
649 return VAGRANTFILE_GLOBAL.format(
650 vagrantfile_snippets=''.join(snippets),
651 GENERATED_MARKER=GENERATED_MARKER
655 VAGRANTFILE = render_vagrantfile(DISTS)
658 # data we need to expose
659 __all__ = ['DISTS', 'VAGRANTFILE', 'OUT']