#!/usr/bin/env python3 # Copyright (C) 2018-2021 Internet Systems Consortium, Inc. ("ISC") # # This Source Code Form is subject to the terms of the Mozilla Public # License, v. 2.0. If a copy of the MPL was not distributed with this # file, You can obtain one at http://mozilla.org/MPL/2.0/. """Hammer - Kea development environment management tool.""" from __future__ import print_function import os import re import sys import glob import time import json import logging import datetime import platform import binascii import argparse import textwrap import functools import subprocess import multiprocessing import grp import pwd import getpass try: import urllib.request except: pass try: from urllib.parse import urljoin except: from urlparse import urljoin import xml.etree.ElementTree as ET SYSTEMS = { 'fedora': [ #'27', # EOLed #'28', # EOLed #'29', # EOLed #'30', # EOLed #'31', # EOLed '32', # EOLed '33', '34', ], 'centos': [ '7', '8', ], 'rhel': ['8'], 'ubuntu': [ #'16.04', '18.04', #'18.10', # EOLed #'19.04', # EOLed #'19.10', # EOLed '20.04', '20.10', '21.04', ], 'debian': [ #'8', '9', '10', ], 'freebsd': [ '11.2', '11.4', '12.0', '12.1', '13.0', ], 'alpine': [ #'3.10', # EOLed '3.11', '3.12', '3.13', ] } # pylint: disable=C0326 IMAGE_TEMPLATES = { # fedora 'fedora-27-lxc': {'bare': 'lxc-fedora-27', 'kea': 'godfryd/kea-fedora-27'}, 'fedora-27-virtualbox': {'bare': 'generic/fedora27', 'kea': 'godfryd/kea-fedora-27'}, 'fedora-28-lxc': {'bare': 'godfryd/lxc-fedora-28', 'kea': 'godfryd/kea-fedora-28'}, 'fedora-28-virtualbox': {'bare': 'generic/fedora28', 'kea': 'godfryd/kea-fedora-28'}, 'fedora-29-lxc': {'bare': 'godfryd/lxc-fedora-29', 'kea': 'godfryd/kea-fedora-29'}, 'fedora-29-virtualbox': {'bare': 'generic/fedora29', 'kea': 'godfryd/kea-fedora-29'}, 'fedora-30-lxc': {'bare': 'godfryd/lxc-fedora-30', 'kea': 'godfryd/kea-fedora-30'}, 'fedora-30-virtualbox': {'bare': 'generic/fedora30', 'kea': 'godfryd/kea-fedora-30'}, 'fedora-31-lxc': {'bare': 'isc/lxc-fedora-31', 'kea': 'isc/kea-fedora-31'}, 'fedora-31-virtualbox': {'bare': 'isc/vbox-fedora-31', 'kea': 'isc/kea-fedora-31'}, 'fedora-32-lxc': {'bare': 'isc/lxc-fedora-32', 'kea': 'isc/kea-fedora-32'}, 'fedora-33-lxc': {'bare': 'isc/lxc-fedora-33', 'kea': 'isc/kea-fedora-33'}, 'fedora-34-lxc': {'bare': 'isc/lxc-fedora-34', 'kea': 'isc/kea-fedora-34'}, # centos 'centos-7-lxc': {'bare': 'isc/lxc-centos-7', 'kea': 'isc/kea-centos-7'}, 'centos-7-virtualbox': {'bare': 'generic/centos7', 'kea': 'godfryd/kea-centos-7'}, 'centos-8-lxc': {'bare': 'isc/lxc-centos-8', 'kea': 'isc/kea-centos-8'}, 'centos-8-virtualbox': {'bare': 'generic/centos8', 'kea': 'isc/kea-centos-8'}, # rhel 'rhel-8-virtualbox': {'bare': 'generic/rhel8', 'kea': 'generic/rhel8'}, # ubuntu 'ubuntu-16.04-lxc': {'bare': 'godfryd/lxc-ubuntu-16.04', 'kea': 'godfryd/kea-ubuntu-16.04'}, 'ubuntu-16.04-virtualbox': {'bare': 'ubuntu/xenial64', 'kea': 'godfryd/kea-ubuntu-16.04'}, 'ubuntu-18.04-lxc': {'bare': 'isc/lxc-ubuntu-18.04', 'kea': 'isc/kea-ubuntu-18.04'}, 'ubuntu-18.04-virtualbox': {'bare': 'ubuntu/bionic64', 'kea': 'godfryd/kea-ubuntu-18.04'}, 'ubuntu-18.10-lxc': {'bare': 'godfryd/lxc-ubuntu-18.10', 'kea': 'godfryd/kea-ubuntu-18.10'}, 'ubuntu-18.10-virtualbox': {'bare': 'ubuntu/cosmic64', 'kea': 'godfryd/kea-ubuntu-18.10'}, 'ubuntu-19.04-lxc': {'bare': 'godfryd/lxc-ubuntu-19.04', 'kea': 'godfryd/kea-ubuntu-19.04'}, 'ubuntu-19.04-virtualbox': {'bare': 'ubuntu/disco64', 'kea': 'godfryd/kea-ubuntu-19.04'}, 'ubuntu-19.10-lxc': {'bare': 'isc/lxc-ubuntu-19.10', 'kea': 'isc/kea-ubuntu-19.10'}, 'ubuntu-19.10-virtualbox': {'bare': 'generic/ubuntu1910', 'kea': 'isc/kea-ubuntu-19.10'}, 'ubuntu-20.04-lxc': {'bare': 'isc/lxc-ubuntu-20.04', 'kea': 'isc/kea-ubuntu-20.04'}, 'ubuntu-20.10-lxc': {'bare': 'isc/lxc-ubuntu-20.10', 'kea': 'isc/kea-ubuntu-20.10'}, 'ubuntu-21.04-lxc': {'bare': 'isc/lxc-ubuntu-21.04', 'kea': 'isc/kea-ubuntu-21.04'}, # debian 'debian-8-lxc': {'bare': 'godfryd/lxc-debian-8', 'kea': 'godfryd/kea-debian-8'}, 'debian-8-virtualbox': {'bare': 'debian/jessie64', 'kea': 'godfryd/kea-debian-8'}, 'debian-9-lxc': {'bare': 'isc/lxc-debian-9', 'kea': 'isc/kea-debian-9'}, 'debian-9-virtualbox': {'bare': 'debian/stretch64', 'kea': 'godfryd/kea-debian-9'}, 'debian-10-lxc': {'bare': 'isc/lxc-debian-10', 'kea': 'isc/kea-debian-10'}, 'debian-10-virtualbox': {'bare': 'debian/buster64', 'kea': 'godfryd/kea-debian-10'}, # freebsd 'freebsd-11.2-virtualbox': {'bare': 'generic/freebsd11', 'kea': 'godfryd/kea-freebsd-11.2'}, 'freebsd-12.0-virtualbox': {'bare': 'generic/freebsd12', 'kea': 'godfryd/kea-freebsd-12.0'}, 'freebsd-13.0-virtualbox': {'bare': 'isc/vbox-freebsd-13.0', 'kea': 'isc/kea-freebsd-13.0'}, # alpine 'alpine-3.10-lxc': {'bare': 'godfryd/lxc-alpine-3.10', 'kea': 'godfryd/kea-alpine-3.10'}, 'alpine-3.11-lxc': {'bare': 'isc/lxc-alpine-3.11', 'kea': 'isc/kea-alpine-3.11'}, 'alpine-3.12-lxc': {'bare': 'isc/lxc-alpine-3.12', 'kea': 'isc/kea-alpine-3.12'}, 'alpine-3.13-lxc': {'bare': 'isc/lxc-alpine-3.13', 'kea': 'isc/kea-alpine-3.13'}, } # NOTES # ** Alpine ** # 1. Extracting rootfs is failing: # It requires commenting out checking if rootfs has been extracted as it checks for file /bin/true which is a link. # Comment out in ~/.vagrant.d/gems/2.X.Y/gems/vagrant-lxc-1.4.3/scripts/lxc-template near 'Failed to extract rootfs' LXC_VAGRANTFILE_TPL = """# -*- mode: ruby -*- # vi: set ft=ruby : ENV["LC_ALL"] = "C" Vagrant.configure("2") do |config| {hostname} config.vm.box = "{image_tpl}" {box_version} config.vm.provider "lxc" do |lxc| lxc.container_name = "{name}" lxc.customize 'rootfs.path', "/var/lib/lxc/{name}/rootfs" end config.vm.synced_folder '.', '/vagrant', disabled: true config.vm.synced_folder '{ccache_dir}', '/ccache' end """ VBOX_VAGRANTFILE_TPL = """# -*- mode: ruby -*- # vi: set ft=ruby : ENV["LC_ALL"] = "C" Vagrant.configure("2") do |config| config.vm.hostname = "{name}" config.vm.box = "{image_tpl}" {box_version} config.vm.provider "virtualbox" do |v| v.name = "{name}" v.memory = 8192 nproc = Etc.nprocessors if nproc > 8 nproc -= 2 elsif nproc > 1 nproc -= 1 end v.cpus = nproc end config.vm.synced_folder '.', '/vagrant', disabled: true end """ log = logging.getLogger() def red(txt): """Return colorized (if the terminal supports it) or plain text.""" if sys.stdout.isatty(): return '\033[1;31m%s\033[0;0m' % txt return txt def green(txt): """Return colorized (if the terminal supports it) or plain text.""" if sys.stdout.isatty(): return '\033[0;32m%s\033[0;0m' % txt return txt def blue(txt): """Return colorized (if the terminal supports it) or plain text.""" if sys.stdout.isatty(): return '\033[0;34m%s\033[0;0m' % txt return txt def get_system_revision(): """Return tuple containing system name and its revision.""" system = platform.system() if system == 'Linux': system, revision = None, None try: system, revision, _ = platform.dist() # pylint: disable=deprecated-method if system == 'debian': revision = revision.split('.')[0] elif system == 'redhat': system = 'rhel' revision = revision[0] elif system == 'centos': revision = revision[0] if not system or not revision: raise Exception('fallback to /etc/os-release') except: if os.path.exists('/etc/os-release'): vals = {} with open('/etc/os-release') as f: for l in f.readlines(): if '=' in l: key, val = l.split('=', 1) vals[key.strip()] = val.strip() system = vals['ID'] revision = vals['VERSION_ID'] if system == 'alpine': revision = revision.rsplit('.', 1)[0] else: raise Exception('cannot determine system or its revision') elif system == 'FreeBSD': system = system.lower() revision = platform.release() if '"' in revision: revision = revision.replace('"', '') if '"' in system: system = system.replace('"', '') return system.lower(), revision class ExecutionError(Exception): """Exception thrown when execution encountered an error.""" pass def execute(cmd, timeout=60, cwd=None, env=None, raise_error=True, dry_run=False, log_file_path=None, quiet=False, check_times=False, capture=False, interactive=False, attempts=1, sleep_time_after_attempt=None, super_quiet=False): """Execute a command in shell. :param str cmd: a command to be executed :param int timeout: timeout in number of seconds, after that time the command is terminated but only if check_times is True :param str cwd: current working directory for the command :param dict env: dictionary with environment variables :param bool raise_error: if False then in case of error exception is not raised, default: True ie exception is raise :param bool dry_run: if True then the command is not executed :param str log_file_path: if provided then all traces from the command are stored in indicated file :param bool quiet: if True then the command's traces are not printed to stdout :param bool check_times: if True then timeout is taken into account :param bool capture: if True then the command's traces are captured and returned by the function :param bool interactive: if True then stdin and stdout are not redirected, traces handling is disabled, used for e.g. SSH :param int attempts: number of attempts to run the command if it fails :param int sleep_time_after_attempt: number of seconds to sleep before taking next attempt """ if super_quiet: quiet = True if not super_quiet: log.info('>>>>> Executing %s in %s', cmd, cwd if cwd else os.getcwd()) if not check_times: timeout = None if dry_run: return 0 if 'sudo' in cmd and env: # if sudo is used and env is overridden then to preserve env add -E to sudo cmd = cmd.replace('sudo', 'sudo -E') if log_file_path: log_file = open(log_file_path, "wb") for attempt in range(attempts): if interactive: p = subprocess.Popen(cmd, cwd=cwd, env=env, shell=True) exitcode = p.wait() else: p = subprocess.Popen(cmd, cwd=cwd, env=env, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT) if capture: output = '' t0 = time.time() t1 = time.time() # repeat until process is running or timeout not occurred while p.poll() is None and (timeout is None or t1 - t0 < timeout): line = p.stdout.readline() if line: line_decoded = line.decode(encoding='ascii', errors='ignore').rstrip() + '\r' if not quiet: print(line_decoded) if capture: output += line_decoded if log_file_path: log_file.write(line) t1 = time.time() # If no exitcode yet, ie. process is still running then it means that timeout occurred. # In such case terminate the process and raise an exception. if p.poll() is None: # kill using sudo to be able to kill other sudo commands execute('sudo kill -s TERM %s' % p.pid) time.sleep(5) # if still running, kill harder if p.poll() is None: execute('sudo kill -s KILL %s' % p.pid) msg = "Execution timeout, %d > %d seconds elapsed (start: %d, stop %d), cmd: '%s'" msg = msg % (t1 - t0, timeout, t0, t1, cmd) raise ExecutionError(msg) exitcode = p.returncode if exitcode == 0: break elif attempt < attempts - 1: txt = 'command failed, retry, attempt %d/%d' % (attempt, attempts) if log_file_path: txt_to_file = '\n\n[HAMMER] %s\n\n\n' % txt log_file.write(txt_to_file.encode('ascii')) log.info(txt) if sleep_time_after_attempt: time.sleep(sleep_time_after_attempt) if log_file_path: log_file.close() if exitcode != 0 and raise_error: if capture and quiet: log.error(output) raise ExecutionError("The command return non-zero exitcode %s, cmd: '%s'" % (exitcode, cmd)) if capture: return exitcode, output return exitcode def _prepare_installed_packages_cache_for_debs(): pkg_cache = {} _, out = execute("dpkg -l", timeout=15, capture=True, quiet=True) for line in out.splitlines(): line = line.strip() m = re.search('^([^\s]+)\s+([^\s]+)\s+([^\s]+)\s+([^\s]+)\s+(.+)', line) if not m: continue status, name, version, arch, descr = m.groups() name = name.split(':')[0] pkg_cache[name] = dict(status=status, version=version, arch=arch, descr=descr) return pkg_cache def _prepare_installed_packages_cache_for_rpms(): pkg_cache = {} _, out = execute("rpm -qa --qf '%{NAME}\\n'", timeout=15, capture=True, quiet=True) for line in out.splitlines(): name = line.strip() pkg_cache[name] = dict(status='ii') return pkg_cache def _prepare_installed_packages_cache_for_alpine(): pkg_cache = {} _, out = execute("apk list -I\\n'", timeout=15, capture=True, quiet=True) for line in out.splitlines(): name = line.strip() pkg_cache[name] = dict(status='ii') return pkg_cache def install_pkgs(pkgs, timeout=60, env=None, check_times=False, pkg_cache={}): """Install native packages in a system. :param dict pkgs: specifies a list of packages to be installed :param int timeout: timeout in number of seconds, after that time the command is terminated but only if check_times is True :param dict env: dictionary with environment variables (optional) :param bool check_times: specifies if timeouts should be enabled (optional) """ system, revision = get_system_revision() if not isinstance(pkgs, list): pkgs = pkgs.split() # prepare cache if needed if not pkg_cache and system in ['centos', 'rhel', 'fedora', 'debian', 'ubuntu']:#, 'alpine']: # TODO: complete caching support for alpine if system in ['centos', 'rhel', 'fedora']: pkg_cache.update(_prepare_installed_packages_cache_for_rpms()) elif system in ['debian', 'ubuntu']: pkg_cache.update(_prepare_installed_packages_cache_for_debs()) elif system in ['alpine']: pkg_cache.update(_prepare_installed_packages_cache_for_alpine()) # check if packages actually need to be installed if pkg_cache: pkgs_to_install = [] pkgs_installed = [] for pkg in pkgs: if pkg not in pkg_cache or pkg_cache[pkg]['status'] != 'ii': pkgs_to_install.append(pkg) else: pkgs_installed.append(pkg) if pkgs_installed: log.info('packages already installed: %s', ', '.join(pkgs_installed)) pkgs = pkgs_to_install if not pkgs: log.info('all packages already installed') return if system in ['centos', 'rhel'] and revision == '7': # skip_missing_names_on_install used to detect case when one packet is not found and no error is returned # but we want an error cmd = 'sudo yum install -y --setopt=skip_missing_names_on_install=False' elif system == 'fedora' or (system in ['centos', 'rhel'] and revision == '8'): cmd = 'sudo dnf -y install' elif system in ['debian', 'ubuntu']: # prepare the command for ubuntu/debian if not env: env = os.environ.copy() env['DEBIAN_FRONTEND'] = 'noninteractive' cmd = 'sudo apt install --no-install-recommends -y' elif system == 'freebsd': cmd = 'sudo pkg install -y' elif system == 'alpine': cmd = 'sudo apk add' else: raise NotImplementedError('no implementation for %s' % system) pkgs = ' '.join(pkgs) cmd += ' ' + pkgs execute(cmd, timeout=timeout, env=env, check_times=check_times, attempts=3, sleep_time_after_attempt=10) def _get_full_repo_url(repository_url, system, revision, pkg_version): if not repository_url: return None repo_name = 'kea-%s-%s-%s' % (pkg_version.rsplit('.', 1)[0], system, revision) repo_url = urljoin(repository_url, 'repository') repo_url += '/%s-ci/' % repo_name return repo_url class VagrantEnv(object): """Helper class that makes interacting with Vagrant easier. It creates Vagrantfile according to specified system. It exposes basic Vagrant functions like up, upload, destroy, ssh. It also provides more complex function for preparing system for Kea build and building Kea. """ def __init__(self, provider, system, revision, features, image_template_variant, dry_run, quiet=False, check_times=False, ccache_dir=None): """VagrantEnv initializer. :param str provider: indicate backend type: virtualbox or lxc :param str system: name of the system eg. ubuntu :param str revision: revision of the system e.g. 18.04 :param list features: list of requested features :param str image_template_variant: variant of images' templates: bare or kea :param bool dry_run: if False then system commands are not really executed :param bool quiet: if True then commands will not trace to stdout :param bool check_times: if True then commands will be terminated after given timeout """ self.provider = provider self.system = system self.revision = revision self.features = features self.dry_run = dry_run self.quiet = quiet self.check_times = check_times # set properly later self.features_arg = None self.nofeatures_arg = None self.python = None self.key = key = "%s-%s-%s" % (system, revision, provider) self.image_tpl = image_tpl = IMAGE_TEMPLATES[key][image_template_variant] self.repo_dir = os.getcwd() sys_dir = "%s-%s" % (system, revision) if provider == "virtualbox": self.vagrant_dir = os.path.join(self.repo_dir, 'hammer', sys_dir, 'vbox') elif provider == "lxc": self.vagrant_dir = os.path.join(self.repo_dir, 'hammer', sys_dir, 'lxc') if ccache_dir is None: self.ccache_dir = '/' self.ccache_enabled = False else: self.ccache_dir = ccache_dir self.ccache_enabled = True self.init_files() def init_files(self): if not os.path.exists(self.vagrant_dir): os.makedirs(self.vagrant_dir) vagrantfile_path = os.path.join(self.vagrant_dir, "Vagrantfile") crc = binascii.crc32(self.vagrant_dir.encode()) self.name = "hmr-%s-%s-kea-srv-%08d" % (self.system, self.revision.replace('.', '-'), crc) if '/' in self.image_tpl: self.latest_version = self._get_latest_cloud_version() box_version = 'config.vm.box_version = "%s"' % self.latest_version else: self.latest_version = None box_version = "" # alpine has a problem with setting hostname so skip it if self.system == 'alpine': hostname = '' else: hostname = 'config.vm.hostname = "%s"' % self.name if self.provider == "virtualbox": vagrantfile_tpl = VBOX_VAGRANTFILE_TPL elif self.provider == "lxc": vagrantfile_tpl = LXC_VAGRANTFILE_TPL vagrantfile = vagrantfile_tpl.format(image_tpl=self.image_tpl, name=self.name, ccache_dir=self.ccache_dir, box_version=box_version, hostname=hostname) with open(vagrantfile_path, "w") as f: f.write(vagrantfile) log.info('Prepared vagrant system %s in %s', self.name, self.vagrant_dir) def up(self): """Do Vagrant up.""" exitcode, out = execute("vagrant up --no-provision --provider %s" % self.provider, cwd=self.vagrant_dir, timeout=15 * 60, dry_run=self.dry_run, capture=True, raise_error=False) if exitcode != 0: if 'There is container on your system' in out and 'lxc-destroy' in out: m = re.search('`lxc-destroy.*?`', out) if m: # destroy some old container cmd = m.group(0)[1:-1] cmd = 'sudo ' + cmd + ' -f' execute(cmd, timeout=60) # try again spinning up new execute("vagrant up --no-provision --provider %s" % self.provider, cwd=self.vagrant_dir, timeout=15 * 60, dry_run=self.dry_run) return raise ExecutionError('There is a problem with putting up a system') def _get_cloud_meta(self, image_tpl=None): if '/' not in self.image_tpl: return {} url = 'https://app.vagrantup.com/api/v1/box/' + (image_tpl if image_tpl else self.image_tpl) try: with urllib.request.urlopen(url) as response: data = response.read() except: log.exception('ignored exception') return {} data = json.loads(data) return data def _get_local_meta(self): meta_file = os.path.join(self.vagrant_dir, '.vagrant/machines/default', self.provider, 'box_meta') if not os.path.exists(meta_file): return {} with open(meta_file) as f: data = f.read() data = json.loads(data) return data def _get_latest_cloud_version(self, image_tpl=None): cloud_meta = self._get_cloud_meta(image_tpl) if not cloud_meta and 'versions' not in cloud_meta: return 0 latest_version = 0 for ver in cloud_meta['versions']: provider_found = False for p in ver['providers']: if p['name'] == self.provider: provider_found = True break if provider_found: try: v = int(ver['number']) except: return ver['number'] if v > latest_version: latest_version = v return latest_version def get_status(self): """Return system status. Status can be: 'not created', 'running', 'stopped', etc. """ if not os.path.exists(self.vagrant_dir): return "not created" _, out = execute("vagrant status", cwd=self.vagrant_dir, timeout=15, capture=True, quiet=True) m = re.search('default\s+(.+)\(', out) if not m: raise Exception('cannot get status in:\n%s' % out) return m.group(1).strip() def bring_up_latest_box(self): if self.get_status() == 'running': self.reload() else: self.up() def reload(self): """Do Vagrant reload.""" execute("vagrant reload --no-provision --force", cwd=self.vagrant_dir, timeout=15 * 60, dry_run=self.dry_run) def package(self): """Package Vagrant system into Vagrant box.""" execute('vagrant halt', cwd=self.vagrant_dir, dry_run=self.dry_run, raise_error=False, attempts=3) box_path = os.path.join(self.vagrant_dir, 'kea-%s-%s.box' % (self.system, self.revision)) if os.path.exists(box_path): os.unlink(box_path) if self.provider == 'virtualbox': cmd = "vagrant package --output %s" % box_path execute(cmd, cwd=self.vagrant_dir, timeout=4 * 60, dry_run=self.dry_run) elif self.provider == 'lxc': lxc_box_dir = os.path.join(self.vagrant_dir, 'lxc-box') if os.path.exists(lxc_box_dir): execute('sudo rm -rf %s' % lxc_box_dir) os.mkdir(lxc_box_dir) lxc_container_path = os.path.join('/var/lib/lxc', self.name) # add vagrant universal key to accepted keys execute('sudo bash -c \'echo "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA6NF8ia' 'llvQVp22WDkTkyrtvp9eWW6A8YVr+kz4TjGYe7gHzIw+niNltGEFHzD8+v1I2YJ' '6oXevct1YeS0o9HZyN1Q9qgCgzUFtdOKLv6IedplqoPkcmF0aYet2PkEDo3MlTB' 'ckFXPITAMzF8dJSIFo9D8HfdOV0IAdx4O7PtixWKn5y2hMNG0zQPyUecp4pzC6k' 'ivAIhyfHilFR61RGL+GPXQ2MWZWFYbAGjyiYJnAmCP3NOTd0jMZEnDkbUvxhMmB' 'YSdETk1rRgm+R4LOzFUGaHqHDLKLX+FIPKcF96hrucXzcWyLbIbEgE98OHlnVYC' 'zRdK8jlqm8tehUc9c9WhQ== vagrant insecure public key"' '> %s/rootfs/home/vagrant/.ssh/authorized_keys\'' % lxc_container_path) # reset machine-id execute('sudo rm -f %s/rootfs/var/lib/dbus/machine-id' % lxc_container_path) #execute('sudo truncate -s 0 %s/rootfs/etc/machine-id' % lxc_container_path) execute('sudo rm -f %s/rootfs/etc/machine-id' % lxc_container_path) # pack rootfs cmd = 'sudo bash -c "' cmd += 'cd %s ' cmd += '&& tar --numeric-owner --anchored --exclude=./rootfs/dev/log -czf %s/rootfs.tar.gz ./rootfs/*' cmd += '"' execute(cmd % (lxc_container_path, lxc_box_dir)) # copy lxc config from runtime container execute('sudo cp %s/config %s/lxc-config' % (lxc_container_path, lxc_box_dir)) # remove mac address from eth0 - it should be dynamically assigned execute("sudo sed -i '/lxc.net.0.hwaddr/d' %s/lxc-config" % lxc_box_dir) # correct files ownership execute('sudo chown `id -un`:`id -gn` *', cwd=lxc_box_dir) # and other metadata with open(os.path.join(lxc_box_dir, 'metadata.json'), 'w') as f: now = datetime.datetime.now() f.write('{\n') f.write(' "provider": "lxc",\n') f.write(' "version": "1.0.0",\n') f.write(' "built-on": "%s"\n' % now.strftime('%c')) f.write('}\n') # pack vagrant box with metadata and config execute('tar -czf %s ./*' % box_path, cwd=lxc_box_dir) execute('sudo rm -rf %s' % lxc_box_dir) return box_path def upload_to_cloud(self, box_path): image_tpl = IMAGE_TEMPLATES[self.key]['kea'] if '/' not in image_tpl: return latest_version = self._get_latest_cloud_version(image_tpl) new_version = latest_version + 1 cmd = "vagrant cloud publish --no-private -f -r %s %s %s %s" cmd = cmd % (image_tpl, new_version, self.provider, box_path) execute(cmd, cwd=self.vagrant_dir, timeout=60 * 60) def upload(self, src): """Upload src to Vagrant system, home folder.""" attempt = 4 while attempt > 0: exitcode = execute('vagrant upload %s' % src, cwd=self.vagrant_dir, dry_run=self.dry_run, raise_error=False) if exitcode == 0: break attempt -= 1 if exitcode != 0: msg = 'cannot upload %s' % src log.error(msg) raise ExecutionError(msg) def run_build_and_test(self, tarball_path, jobs, pkg_version, pkg_isc_version, upload, repository_url): """Run build and unit tests inside Vagrant system.""" if self.dry_run: return 0, 0 # prepare tarball if needed and upload it to vagrant system if not tarball_path: name_ver = 'kea-%s' % pkg_version cmd = 'tar --transform "flags=r;s|^|%s/|" --exclude hammer ' % name_ver cmd += ' --exclude "*~" --exclude .git --exclude .libs ' cmd += ' --exclude .deps --exclude \'*.o\' --exclude \'*.lo\' ' cmd += ' -zcf /tmp/%s.tar.gz .' % name_ver execute(cmd) tarball_path = '/tmp/%s.tar.gz' % name_ver self.upload(tarball_path) log_file_path = os.path.join(self.vagrant_dir, 'build.log') log.info('Build log file stored to %s', log_file_path) t0 = time.time() # run build command bld_cmd = "{python} hammer.py build -p local {features} {nofeatures} {check_times} {ccache}" bld_cmd += " {tarball} {jobs} {pkg_version} {pkg_isc_version} {repository_url}" bld_cmd = bld_cmd.format(python=self.python, features=self.features_arg, nofeatures=self.nofeatures_arg, check_times='-i' if self.check_times else '', ccache='--ccache-dir /ccache' if self.ccache_enabled else '', tarball='-t ~/%s.tar.gz' % name_ver, jobs='-j %d' % jobs, pkg_version='--pkg-version %s' % pkg_version, pkg_isc_version='--pkg-isc-version %s' % pkg_isc_version, repository_url=('--repository-url %s' % repository_url) if repository_url else '') timeout = _calculate_build_timeout(self.features) + 5 * 60 # executes hammer.py inside LXC container self.execute(bld_cmd, timeout=timeout, log_file_path=log_file_path, quiet=self.quiet) # timeout: 40 minutes ssh_cfg_path = self.dump_ssh_config() if 'native-pkg' in self.features: pkgs_dir = os.path.join(self.vagrant_dir, 'pkgs') if os.path.exists(pkgs_dir): execute('rm -rf %s' % pkgs_dir) os.makedirs(pkgs_dir) # copy results of _build_native_pkg execute('scp -F %s -r default:~/kea-pkg/* .' % ssh_cfg_path, cwd=pkgs_dir) if upload: repo_url = _get_full_repo_url(repository_url, self.system, self.revision, pkg_version) assert repo_url is not None upload_cmd = 'curl -v --netrc -f' if self.system in ['ubuntu', 'debian']: upload_cmd += ' -X POST -H "Content-Type: multipart/form-data" --data-binary "@%s" ' file_ext = '.deb' elif self.system in ['fedora', 'centos', 'rhel']: upload_cmd += ' --upload-file %s ' file_ext = '.rpm' elif self.system == 'alpine': upload_cmd += ' --upload-file %s ' file_ext = '' repo_url = urljoin(repo_url, '%s/v%s/x86_64/' % (pkg_isc_version, self.revision)) upload_cmd += ' ' + repo_url for fn in os.listdir(pkgs_dir): if file_ext and not fn.endswith(file_ext): continue fp = os.path.join(pkgs_dir, fn) cmd = upload_cmd % fp execute(cmd) t1 = time.time() dt = int(t1 - t0) log.info('Build log file stored to %s', log_file_path) log.info("") log.info(">>>>>> Build time %s:%s", dt // 60, dt % 60) log.info("") # run unit tests if requested total = 0 passed = 0 try: if 'unittest' in self.features: cmd = 'scp -F %s -r default:/home/vagrant/unit-test-results.json .' % ssh_cfg_path execute(cmd, cwd=self.vagrant_dir) results_file = os.path.join(self.vagrant_dir, 'unit-test-results.json') if os.path.exists(results_file): with open(results_file) as f: txt = f.read() results = json.loads(txt) total = results['grand_total'] passed = results['grand_passed'] cmd = 'scp -F %s -r default:/home/vagrant/aggregated_tests.xml .' % ssh_cfg_path execute(cmd, cwd=self.vagrant_dir) except: # pylint: disable=bare-except log.exception('ignored issue with parsing unit test results') return total, passed def destroy(self): """Remove the VM completely.""" if os.path.exists(self.vagrant_dir): cmd = 'vagrant destroy --force' execute(cmd, cwd=self.vagrant_dir, timeout=3 * 60, dry_run=self.dry_run) # timeout: 3 minutes execute('rm -rf %s' % self.vagrant_dir) def ssh(self): """Open interactive session to the VM.""" execute('vagrant ssh', cwd=self.vagrant_dir, timeout=None, dry_run=self.dry_run, interactive=True) def dump_ssh_config(self): """Dump ssh config that allows getting into Vagrant system via SSH.""" ssh_cfg_path = os.path.join(self.vagrant_dir, 'ssh.cfg') execute('vagrant ssh-config > %s' % ssh_cfg_path, cwd=self.vagrant_dir) return ssh_cfg_path def execute(self, cmd, timeout=None, raise_error=True, log_file_path=None, quiet=False, env=None, attempts=1, sleep_time_after_attempt=None): """Execute provided command inside Vagrant system.""" if not env: env = os.environ.copy() env['LANGUAGE'] = env['LANG'] = env['LC_ALL'] = 'C' return execute('vagrant ssh -c "%s"' % cmd, env=env, cwd=self.vagrant_dir, timeout=timeout, raise_error=raise_error, dry_run=self.dry_run, log_file_path=log_file_path, quiet=quiet, check_times=self.check_times, attempts=attempts, sleep_time_after_attempt=sleep_time_after_attempt) def prepare_system(self): """Prepare Vagrant system for building Kea.""" if self.features: self.features_arg = '--with ' + ' '.join(self.features) else: self.features_arg = '' nofeatures = set(DEFAULT_FEATURES) - self.features if nofeatures: self.nofeatures_arg = '--without ' + ' '.join(nofeatures) else: self.nofeatures_arg = '' # install python3 on some systems if self.system == 'centos': if self.revision == '7': self.execute("sudo yum remove -y python-devel") self.execute("sudo yum install -y python36 rpm-build python3-virtualenv", attempts=3) else: self.execute("sudo dnf install -y python36 rpm-build python3-virtualenv", attempts=3) elif self.system == 'freebsd': if self.revision.startswith('13'): self.execute("sudo pkg install -y python3", attempts=3) # select proper python version for running Hammer inside Vagrant system if self.system == 'freebsd': if self.revision.startswith(('11', '12')): self.python = 'python3.6' else: self.python = 'python3' else: self.python = 'python3' # to get python in RHEL 8 beta it is required first register machine in RHEL account if self.system == 'rhel' and self.revision == '8': cmd = "sudo subscription-manager repos --list-enabled | grep rhel-8-for-x86_64-baseos-beta-rpms" exitcode = self.execute(cmd, raise_error=False) if exitcode != 0: env = os.environ.copy() with open(os.path.expanduser('~/rhel-creds.txt')) as f: env['RHEL_USER'] = f.readline().strip() env['RHEL_PASSWD'] = f.readline().strip() self.execute('sudo subscription-manager register --user $RHEL_USER --password "$RHEL_PASSWD"', env=env) self.execute("sudo subscription-manager refresh") self.execute("sudo subscription-manager attach --pool 8a85f99a67cdc3e70167e45c85f47429") self.execute("sudo subscription-manager repos --enable rhel-8-for-x86_64-baseos-beta-rpms") self.execute("sudo dnf install -y python36") # upload Hammer to Vagrant system hmr_py_path = os.path.join(self.repo_dir, 'hammer.py') self.upload(hmr_py_path) log_file_path = os.path.join(self.vagrant_dir, 'prepare.log') log.info('Prepare log file stored to %s', log_file_path) t0 = time.time() # run prepare-system inside Vagrant system cmd = "{python} hammer.py prepare-system -p local {features} {nofeatures} {check_times} {ccache}" cmd = cmd.format(python=self.python, features=self.features_arg, nofeatures=self.nofeatures_arg, check_times='-i' if self.check_times else '', ccache='--ccache-dir /ccache' if self.ccache_enabled else '') self.execute(cmd, timeout=40 * 60, log_file_path=log_file_path, quiet=self.quiet) t1 = time.time() dt = int(t1 - t0) log.info('') log.info(">>> Preparing %s, %s, %s completed in %s:%s", self.provider, self.system, self.revision, dt // 60, dt % 60) log.info('') def prepare_for_boxing(self): if self.system in ['debian', 'ubuntu', 'fedora', 'centos', 'rhel']: # setup a script that on first boot will set machine-id cmd = 'bash -c \'cat </dev/null | grep '#define LY_VERSION ' | cut -d ' ' -f 3 | sed 's/"//g' ''' % prefix, capture=True, ) if len(libyang_version) > 0: libyang_version = libyang_version.rstrip() break if libyang_version in versions: sysrepo_version = versions[libyang_version] else: # Let's try the latest v1.x version. If it complains, please add the # right version pair to the dictionary above. sysrepo_version = '1.4.140' execute('rm -rf /tmp/sysrepo') try: execute('git clone https://github.com/sysrepo/sysrepo.git /tmp/sysrepo') execute('git checkout v%s' % sysrepo_version, cwd='/tmp/sysrepo') execute('mkdir /tmp/sysrepo/build') execute('cmake .. -DGEN_CPP_BINDINGS=ON -DGEN_LANGUAGE_BINDINGS=ON -DGEN_PYTHON_BINDINGS=OFF', cwd='/tmp/sysrepo/build') execute('make -j $(nproc || gnproc)', cwd='/tmp/sysrepo/build') execute('sudo make install', cwd='/tmp/sysrepo/build') finally: execute('rm -rf /tmp/sysrepo') def _get_local_timezone(): _, output = execute(''' # timedatectl if command -v timedatectl > /dev/null 2>&1; then timedatectl | grep 'Time zone' | cut -d ':' -f 2 | cut -d '(' -f 1 | xargs exit ${?} fi # brute force: for Alpine, FreeBSD for i in $(find /usr/share/zoneinfo | cut -d '/' -f 5- | grep -E '^[A-Z][a-z]+/[A-Z][a-z]+.*$' | sort -ruV); do unset TZ if test "$(date)" = "$(TZ="${i}" date)"; then printf '%s\n' "${i}" break fi done ''', capture=True, quiet=True) return output.rstrip() def _configure_mysql(system, revision, features): """Configure MySQL database.""" if system in ['fedora', 'centos']: execute('sudo systemctl enable mariadb.service') execute('sudo systemctl start mariadb.service') time.sleep(5) elif system == 'freebsd': cmd = "echo 'SET PASSWORD = \"\";' " cmd += "| sudo mysql -u root --password=\"$(sudo cat /root/.mysql_secret | grep -v '^#')\" --connect-expired-password" execute(cmd, raise_error=False) elif system == 'alpine': execute('sudo rc-update add mariadb') execute('sudo /etc/init.d/mariadb setup', raise_error=False) execute('sudo /etc/init.d/mariadb start') cmd = "echo 'DROP DATABASE IF EXISTS keatest;' | sudo mysql -u root" execute(cmd) cmd = "echo 'DROP USER 'keatest'@'localhost';' | sudo mysql -u root" execute(cmd, raise_error=False) cmd = "echo 'DROP USER 'keatest_readonly'@'localhost';' | sudo mysql -u root" execute(cmd, raise_error=False) cmd = "bash -c \"cat < /dev/null') elif system == 'alpine': execute('sudo /etc/init.d/postgresql restart') else: execute('sudo systemctl restart postgresql.service') def _configure_pgsql(system, features): """ Configure PostgreSQL DB """ if system in ['fedora', 'centos']: # https://fedoraproject.org/wiki/PostgreSQL exitcode = execute('sudo ls /var/lib/pgsql/data/postgresql.conf', raise_error=False) if exitcode != 0: if system == 'centos': execute('sudo postgresql-setup initdb') else: execute('sudo postgresql-setup --initdb --unit postgresql') elif system == 'freebsd': execute('[ ! -d /var/db/postgres/data11 ] && sudo /usr/local/etc/rc.d/postgresql oneinitdb || true') # if the file '/var/db/postgres/data11/postmaster.opts' does not exist the 'restart' of postgresql will fail with error: # pg_ctl: could not read file "/var/db/postgres/data11/postmaster.opts" # the initial start of the postgresql will create the 'postmaster.opts' file execute('sudo [ ! -f /var/db/postgres/data11/postmaster.opts ] && sudo service postgresql onestart > /dev/null') _enable_postgresql(system) _restart_postgresql(system) # Change auth-method to 'trust' on local connections. cmd = "printf 'SHOW hba_file' | sudo -u postgres psql -t postgres | xargs" _, output = execute(cmd, capture=True, cwd='/tmp') # CWD to avoid: could not change as postgres user directory to "/home/jenkins": Permission denied hba_file = output.rstrip() cmd = "sudo sed -i.bak 's/^local\(.*\) [a-z0-9]*$/local\\1 trust/g' '{}'".format(hba_file) execute(cmd, cwd='/tmp') # CWD to avoid: could not change as postgres user directory to "/home/jenkins": Permission denied _restart_postgresql(system) cmd = """bash -c \"cat <= 10: cmd += ' --allow-releaseinfo-change' return execute(cmd, env=env, check_times=check_times, attempts=attempts, sleep_time_after_attempt=sleep_time_after_attempt, capture=capture) def _install_cassandra_deb(system, revision, env, check_times): """Install Cassandra and cpp-driver using DEB package.""" if system == 'ubuntu' and revision == '20.10': # no support for ubuntu 20.10 return 0 if not os.path.exists('/usr/sbin/cassandra'): cmd = 'echo "deb https://downloads.apache.org/cassandra/debian 311x main" ' cmd += '| sudo tee /etc/apt/sources.list.d/cassandra.sources.list' execute(cmd, env=env, check_times=check_times) execute('wget -qO- https://downloads.apache.org/cassandra/KEYS | sudo apt-key add -', env=env, check_times=check_times) _apt_update(system, revision, env=env, check_times=check_times) # ca-certificates-java needs to be installed first because it fails if installed together with cassandra install_pkgs('ca-certificates-java', env=env, check_times=check_times) install_pkgs('cassandra libuv1 pkgconf', env=env, check_times=check_times) if not os.path.exists('/usr/include/cassandra.h'): if system == 'ubuntu' and revision == '16.04': execute('wget http://downloads.datastax.com/cpp-driver/ubuntu/16.04/cassandra/v2.11.0/cassandra-cpp-driver-dev_2.11.0-1_amd64.deb', env=env, check_times=check_times) execute('wget http://downloads.datastax.com/cpp-driver/ubuntu/16.04/cassandra/v2.11.0/cassandra-cpp-driver_2.11.0-1_amd64.deb', env=env, check_times=check_times) else: execute('wget http://downloads.datastax.com/cpp-driver/ubuntu/18.04/cassandra/v2.11.0/cassandra-cpp-driver-dev_2.11.0-1_amd64.deb', env=env, check_times=check_times) execute('wget http://downloads.datastax.com/cpp-driver/ubuntu/18.04/cassandra/v2.11.0/cassandra-cpp-driver_2.11.0-1_amd64.deb', env=env, check_times=check_times) if system == 'debian' and revision == '10': install_pkgs('multiarch-support', env=env, check_times=check_times) execute('sudo dpkg -i cassandra-cpp-driver-dev_2.11.0-1_amd64.deb cassandra-cpp-driver_2.11.0-1_amd64.deb', env=env, check_times=check_times) execute('rm -rf cassandra-cpp-driver-dev_2.11.0-1_amd64.deb cassandra-cpp-driver_2.11.0-1_amd64.deb', env=env, check_times=check_times) def _install_cassandra_rpm(system, revision, env, check_times): """Install Cassandra and cpp-driver using RPM package.""" if not os.path.exists('/usr/bin/cassandra'): install_pkgs('yum-utils', env=env, check_times=check_times) execute('sudo yum-config-manager --add-repo https://www.apache.org/dist/cassandra/redhat/311x/', raise_error=False) execute('sudo rpm --import https://www.apache.org/dist/cassandra/KEYS') pkgs = 'cassandra cassandra-tools libuv libuv-devel openssl' install_pkgs(pkgs, env=env, check_times=check_times) execute('sudo systemctl daemon-reload') if system == 'fedora' and int(revision) >= 30: execute("echo '-Xms1G -Xmx1G' | sudo tee -a /etc/cassandra/jvm.options") execute('sudo systemctl start cassandra') if not os.path.exists('/usr/include/cassandra.h'): execute('wget http://downloads.datastax.com/cpp-driver/centos/7/cassandra/v2.11.0/cassandra-cpp-driver-2.11.0-1.el7.x86_64.rpm') execute('wget http://downloads.datastax.com/cpp-driver/centos/7/cassandra/v2.11.0/cassandra-cpp-driver-devel-2.11.0-1.el7.x86_64.rpm') if system == 'centos': execute('sudo rpm -i cassandra-cpp-driver-2.11.0-1.el7.x86_64.rpm cassandra-cpp-driver-devel-2.11.0-1.el7.x86_64.rpm') else: execute('sudo dnf install -y cassandra-cpp-driver-2.11.0-1.el7.x86_64.rpm cassandra-cpp-driver-devel-2.11.0-1.el7.x86_64.rpm') execute('rm -rf cassandra-cpp-driver-2.11.0-1.el7.x86_64.rpm cassandra-cpp-driver-devel-2.11.0-1.el7.x86_64.rpm') def _install_freeradius_client(system, revision, features, env, check_times): """Install FreeRADIUS-client with necessary patches from Francis Dupont.""" # check if it is already installed if (os.path.exists('/usr/local/lib/libfreeradius-client.so.2.0.0') and os.path.exists('/usr/local/include/freeradius-client.h')): log.info('freeradius is already installed') return # install freeradius dependencies if system in ['centos', 'rhel', 'fedora']: install_pkgs('nettle-devel', env=env, check_times=check_times) elif system in ['alpine', 'debian', 'ubuntu']: install_pkgs('nettle-dev', env=env, check_times=check_times) elif system in ['freebsd']: install_pkgs('nettle', env=env, check_times=check_times) else: raise NotImplementedError('no implementation for %s' % system) # checkout sources, build them and install execute('rm -rf freeradius-client') execute('git clone https://github.com/fxdupont/freeradius-client.git', env=env, check_times=check_times) execute('git checkout iscdev', cwd='freeradius-client', env=env, check_times=check_times) execute('./configure --with-nettle', cwd='freeradius-client', env=env, check_times=check_times) execute('make', cwd='freeradius-client', env=env, check_times=check_times) execute('sudo make install', cwd='freeradius-client', env=env, check_times=check_times) if system != 'alpine': execute('sudo ldconfig', env=env) # TODO: this shouldn't be needed execute('rm -rf freeradius-client') log.info('freeradius just installed') def prepare_system_local(features, check_times): """Prepare local system for Kea development based on requested features.""" env = os.environ.copy() env['LANGUAGE'] = env['LANG'] = env['LC_ALL'] = 'C' # Actions decided before installing packages, but run afterwards deferred_functions = [] system, revision = get_system_revision() log.info('Preparing deps for %s %s', system, revision) # prepare fedora if system == 'fedora': packages = ['make', 'autoconf', 'automake', 'libtool', 'gcc-c++', 'openssl-devel', 'log4cplus-devel', 'boost-devel', 'libpcap-devel', 'python3-virtualenv'] if 'native-pkg' in features: packages.extend(['rpm-build', 'python3-devel']) if 'docs' in features: packages.extend(['python3-sphinx', 'texlive', 'texlive-collection-latexextra']) if int(revision) >= 31: packages.extend(['python3-sphinx_rtd_theme']) if 'mysql' in features: execute('sudo dnf remove -y community-mysql-devel || true') packages.extend(['mariadb', 'mariadb-server', 'mariadb-connector-c-devel']) if 'pgsql' in features: packages.extend(['postgresql-devel', 'postgresql-server']) if int(revision) >= 30: packages.extend(['postgresql-server-devel']) if 'radius' in features: packages.extend(['git']) if 'gssapi' in features: packages.extend(['krb5-devel']) if 'ccache' in features: packages.extend(['ccache']) if 'netconf' in features: packages.extend(['cmake', 'libyang', 'libyang-devel', 'libyang-cpp', 'libyang-cpp-devel']) deferred_functions.append(_install_sysrepo_from_sources) install_pkgs(packages, timeout=300, env=env, check_times=check_times) if 'unittest' in features: _install_gtest_sources() execute('sudo dnf clean packages', env=env, check_times=check_times) if 'cql' in features: _install_cassandra_rpm(system, revision, env, check_times) # prepare centos elif system == 'centos': install_pkgs('epel-release', env=env, check_times=check_times) packages = ['make', 'autoconf', 'automake', 'libtool', 'gcc-c++', 'openssl-devel', 'log4cplus-devel', 'boost-devel', 'mariadb-devel', 'postgresql-devel'] if 'native-pkg' in features: packages.extend(['rpm-build', 'python3-devel']) if 'docs' in features: packages.extend(['python3-virtualenv']) if 'mysql' in features: packages.extend(['mariadb', 'mariadb-server', 'mariadb-devel']) if 'pgsql' in features: packages.extend(['postgresql-server']) if revision == '7': packages.extend(['postgresql-devel']) else: packages.extend(['postgresql-server-devel']) if 'radius' in features: packages.extend(['git']) if 'gssapi' in features: packages.extend(['krb5-devel']) if 'ccache' in features: packages.extend(['ccache']) if 'netconf' in features: # CentOS 8+ systems have the libyang package, but they are missing # libyang-cpp which results in this error when building sysrepo: # "Required libyang C++ bindings not found!" # So until it is added, install libyang from sources. packages.extend(['cmake', 'pcre-devel']) deferred_functions.extend([ _install_libyang_from_sources, _install_sysrepo_from_sources, ]) if 'unittest' in features: packages.append('wget') deferred_functions.append(_install_gtest_sources) install_pkgs(packages, env=env, check_times=check_times) if 'docs' in features: execute('virtualenv-3 ~/venv', env=env, timeout=60, check_times=check_times) execute('~/venv/bin/pip install sphinx==3.5.4 sphinx-rtd-theme==0.5.2', env=env, timeout=120, check_times=check_times) if 'cql' in features: _install_cassandra_rpm(system, revision, env, check_times) # prepare rhel elif system == 'rhel': packages = ['make', 'autoconf', 'automake', 'libtool', 'gcc-c++', 'openssl-devel', 'boost-devel', 'mariadb-devel', 'postgresql-devel'] packages.extend(['rpm-build']) if 'docs' in features and not revision == '8': packages.extend(['libxslt', 'elinks', 'docbook-style-xsl']) # TODO: # if 'mysql' in features: # packages.extend(['default-mysql-client-core', 'default-libmysqlclient-dev', 'mysql-server']) # if 'pgsql' in features: # packages.extend(['postgresql-client', 'libpq-dev', 'postgresql-all']) if 'radius' in features: packages.extend(['git']) if 'forge' in features: packages.extend(['freeradius']) if 'ccache' in features: packages.extend(['ccache']) if 'netconf' in features: # RHEL 8+ systems have the libyang package, but they are missing # libyang-cpp which results in this error when building sysrepo: # "Required libyang C++ bindings not found!" # So until it is added, install libyang from sources. packages.extend(['cmake', 'pcre-devel']) deferred_functions.extend([ _install_libyang_from_sources, _install_sysrepo_from_sources, ]) if 'unittest' in features: packages.append('wget') deferred_functions.append(_install_gtest_sources) install_pkgs(packages, env=env, timeout=120, check_times=check_times) if 'cql' in features: _install_cassandra_rpm(system, revision, env, check_times) # prepare ubuntu elif system == 'ubuntu': _apt_update(system, revision, env=env, check_times=check_times, attempts=3, sleep_time_after_attempt=10) packages = ['gcc', 'g++', 'make', 'autoconf', 'automake', 'libtool', 'libssl-dev', 'liblog4cplus-dev', 'libboost-system-dev', 'gnupg', 'libpcap-dev', 'python3-venv'] if 'unittest' in features: if revision.startswith('16.'): _install_gtest_sources() else: packages.append('googletest') if 'docs' in features: packages.extend(['python3-sphinx', 'python3-sphinx-rtd-theme', 'texlive', 'texlive-latex-extra']) if 'native-pkg' in features: packages.extend(['build-essential', 'fakeroot', 'devscripts']) packages.extend(['bison', 'debhelper', 'docbook', 'flex', 'libboost-dev', 'python3-dev']) if 20.04 <= float(revision): packages.extend(['dh-python']) if 'mysql' in features: if revision == '16.04': packages.extend(['mysql-client', 'libmysqlclient-dev', 'mysql-server']) else: packages.extend(['default-mysql-client-core', 'default-libmysqlclient-dev', 'mysql-server']) if 'pgsql' in features: if revision == '16.04': packages.extend(['postgresql-client', 'libpq-dev', 'postgresql', 'postgresql-server-dev-all']) else: packages.extend(['postgresql-client', 'libpq-dev', 'postgresql-all']) if 'radius' in features: packages.extend(['git']) if 'gssapi' in features: packages.extend(['libkrb5-dev']) if 'ccache' in features: packages.extend(['ccache']) if 'netconf' in features: if float(revision) <= 20.04: packages.extend(['cmake', 'libpcre3-dev']) deferred_functions.append(_install_libyang_from_sources) else: packages.extend(['libyang-dev', 'libyang-cpp-dev']) if float(revision) <= 20.10: packages.extend(['cmake', 'libpcre3-dev']) deferred_functions.append(_install_sysrepo_from_sources) else: packages.extend(['libsysrepo-dev', 'libsysrepo-cpp-dev']) install_pkgs(packages, env=env, timeout=240, check_times=check_times) if 'cql' in features: _install_cassandra_deb(system, revision, env, check_times) # prepare debian elif system == 'debian': _apt_update(system, revision, env=env, check_times=check_times, attempts=3, sleep_time_after_attempt=10) packages = ['gcc', 'g++', 'make', 'autoconf', 'automake', 'libtool', 'libssl-dev', 'liblog4cplus-dev', 'libboost-system-dev', 'gnupg'] if 'unittest' in features: if revision == '8': # libgtest-dev does not work and googletest is not available _install_gtest_sources() else: packages.append('googletest') if 'netconf' in features: if int(revision) <= 10: packages.extend(['cmake', 'libpcre3-dev']) deferred_functions.extend([ _install_libyang_from_sources, _install_sysrepo_from_sources, ]) else: packages.extend(['libyang-dev', 'libyang-cpp-dev', 'libsysrepo-dev', 'libsysrepo-cpp-dev']) if 'docs' in features: if revision == '8': packages.extend(['virtualenv']) else: packages.extend(['python3-sphinx', 'python3-sphinx-rtd-theme', 'texlive', 'texlive-latex-extra']) if revision == '9': packages.extend(['texlive-generic-extra']) if 'native-pkg' in features: packages.extend(['build-essential', 'fakeroot', 'devscripts']) packages.extend(['bison', 'debhelper', 'docbook', 'flex', 'libboost-dev', 'python3-dev']) if 'mysql' in features: if revision == '8': packages.extend(['mysql-client', 'libmysqlclient-dev']) else: packages.extend(['default-mysql-client-core', 'default-libmysqlclient-dev']) if revision in ['8', '9']: packages.append('mysql-server') else: packages.append('mariadb-server') if 'pgsql' in features: packages.extend(['postgresql-client', 'libpq-dev']) if revision == '8': packages.extend(['postgresql', 'postgresql-client']) else: packages.append('postgresql-all') if 'radius' in features: packages.extend(['git']) if 'gssapi' in features: packages.extend(['libkrb5-dev']) if 'ccache' in features: packages.extend(['ccache']) install_pkgs(packages, env=env, timeout=240, check_times=check_times) if 'docs' in features and revision == '8': execute('virtualenv -p /usr/bin/python3 ~/venv', env=env, timeout=60, check_times=check_times) execute('~/venv/bin/pip install sphinx typing sphinx-rtd-theme', env=env, timeout=120, check_times=check_times) if 'cql' in features and revision != '8': # there is no libuv1 package in case of debian 8 _install_cassandra_deb(system, revision, env, check_times) # prepare freebsd elif system == 'freebsd': packages = ['autoconf', 'automake', 'libtool', 'openssl', 'log4cplus', 'boost-libs', 'wget'] if 'docs' in features: if float(revision.split('.')[0]) < 12.0: packages.extend(['py37-sphinx', 'py37-sphinx_rtd_theme']) else: packages.extend(['py38-sphinx', 'py38-sphinx_rtd_theme']) if 'mysql' in features: if revision.startswith(('11', '12')): packages.extend(['mysql57-server', 'mysql57-client']) else: packages.extend(['mysql80-server', 'mysql80-client']) if 'pgsql' in features: if revision.startswith(('11', '12')): packages.extend(['postgresql11-server', 'postgresql11-client']) else: packages.extend(['postgresql13-server', 'postgresql13-client']) if 'radius' in features: packages.extend(['git']) if 'gssapi' in features: packages.extend(['krb5']) if 'ccache' in features: packages.extend(['ccache']) if 'netconf' in features: # FreeBSD systems have the libyang package, but they are missing # libyang-cpp which results in this error when building sysrepo: # "Required libyang C++ bindings not found!" # So until it is added, install libyang from sources. packages.append('cmake') deferred_functions.extend([ _install_libyang_from_sources, _install_sysrepo_from_sources, ]) install_pkgs(packages, env=env, timeout=6 * 60, check_times=check_times) if 'unittest' in features: _install_gtest_sources() if 'mysql' in features: execute('sudo sysrc mysql_enable="yes"', env=env, check_times=check_times) execute('sudo service mysql-server start', env=env, check_times=check_times, raise_error=False) execute('sudo pkg clean -a -y') execute('sudo rm -rf /usr/lib/debug') # prepare alpine elif system == 'alpine': packages = ['gcc', 'g++', 'make', 'autoconf', 'automake', 'libtool', 'openssl-dev', 'boost-libs', 'boost-dev', 'procps', 'tar'] if 'docs' in features: if revision == '3.10': packages.extend(['py-sphinx', 'py-sphinx_rtd_theme']) elif revision == '3.11': packages.extend(['py3-sphinx']) else: packages.extend(['py3-sphinx', 'py3-sphinx_rtd_theme']) if 'unittest' in features: _install_gtest_sources() if 'netconf' in features: # Alpine systems have the libyang-dev package, but they are missing # libyang-cpp-dev which results in this error when building sysrepo: # "Required libyang C++ bindings not found!" # So until it is added, install libyang from sources. packages.extend(['cmake', 'pcre-dev']) deferred_functions.extend([ _install_libyang_from_sources, _install_sysrepo_from_sources, ]) if 'mysql' in features: packages.extend(['mariadb-dev', 'mariadb', 'mariadb-client']) if 'pgsql' in features: packages.extend(['postgresql-dev', 'postgresql']) packages.extend(['bison', 'flex', 'boost-dev', 'docbook-xsl', 'python3-dev']) if 'gssapi' in features: packages.extend(['krb5-dev']) if 'native-pkg' in features: packages.extend(['alpine-sdk']) if 'ccache' in features: packages.extend(['ccache']) install_pkgs(packages, env=env, timeout=6 * 60, check_times=check_times) # log4cplus needs to be taken from extra repository, edge testing execute('sudo apk add log4cplus log4cplus-dev --update-cache --repository http://dl-3.alpinelinux.org/alpine/edge/testing/ --allow-untrusted', env=env, timeout=60, check_times=check_times) # check for existence of 'vagrant' user and 'abuild' group before adding him to the group try: pwd.getpwnam('vagrant') grp.getgrnam('abuild') except KeyError: log.info("Can't add 'vagrant' user to 'abuild' group. Vagrant or abuild does not exist.") else: execute('sudo adduser vagrant abuild') try: current_user = getpass.getuser() pwd.getpwnam(current_user) grp.getgrnam('abuild') except KeyError: log.info("Can't add %s user to 'abuild' group. %s or abuild does not exist.", current_user, current_user) else: execute('sudo adduser %s abuild' % current_user) else: raise NotImplementedError('no implementation for %s' % system) # Packages required by these functions have been installed. Now call them. for f in deferred_functions: f() if 'mysql' in features: _configure_mysql(system, revision, features) if 'pgsql' in features: _configure_pgsql(system, features) if 'radius' in features and 'native-pkg' not in features: _install_freeradius_client(system, revision, features, env, check_times) #execute('sudo rm -rf /usr/share/doc') log.info('Preparing deps completed successfully.') def prepare_system_in_vagrant(provider, system, revision, features, dry_run, check_times, clean_start, ccache_dir=None): """Prepare specified system in Vagrant according to specified features.""" ve = VagrantEnv(provider, system, revision, features, 'kea', dry_run, check_times=check_times, ccache_dir=ccache_dir) if clean_start: ve.destroy() ve.init_files() ve.bring_up_latest_box() ve.prepare_system() def _calculate_build_timeout(features): """Return maximum allowed time for build (in seconds).""" timeout = 60 if 'mysql' in features: timeout += 60 timeout *= 60 return timeout def _prepare_ccache_if_needed(system, ccache_dir, env): if ccache_dir is not None: if system in ['debian', 'ubuntu']: ccache_bin_path = '/usr/lib/ccache/' elif system in ['centos', 'rhel', 'fedora']: ccache_bin_path = '/usr/lib64/ccache' env['CC'] = 'ccache gcc' env['CXX'] = 'ccache g++' elif system == 'alpine': # TODO: it doesn't work yet, new abuild is needed and add 'USE_CCACHE=1' to /etc/abuild.conf ccache_bin_path = '/usr/lib/ccache/bin' env['PATH'] = ccache_bin_path + ':' + env['PATH'] env['CCACHE_DIR'] = ccache_dir return env def _build_binaries_and_run_ut(system, revision, features, tarball_path, env, check_times, jobs, dry_run, ccache_dir): if tarball_path: # unpack tarball with sources execute('sudo rm -rf kea-src') os.mkdir('kea-src') execute('tar -zxf %s' % tarball_path, cwd='kea-src', check_times=check_times) src_path = glob.glob('kea-src/*')[0] else: src_path = '.' execute('autoreconf -f -i', cwd=src_path, env=env, dry_run=dry_run) # prepare switches for ./configure cmd = './configure' log.info('OS: %s Revision: %s', system, revision) if 'mysql' in features: cmd += ' --with-mysql' if 'pgsql' in features: cmd += ' --with-pgsql' if 'cql' in features and not (system in ['debian', 'fedora', 'ubuntu'] and revision in ['8', '33', '34', '20.10']): # debian 8, fedora 33/34, ubuntu 20.10 does not have all deps required # combinations in (system in ['debian', 'fedora', 'ubuntu'] and revision in ['8', '33', '20.10']) # will not generate errors cmd += ' --with-cql=/usr/bin/pkg-config' if 'unittest' in features: # prepare gtest switch - use downloaded gtest sources only if it is not present as native package if system in ['centos', 'fedora', 'rhel', 'freebsd', 'alpine']: cmd += ' --with-gtest-source=/usr/src/googletest-release-1.10.0/googletest/' elif system == 'debian' and revision == '8': cmd += ' --with-gtest-source=/usr/src/googletest-release-1.10.0/googletest/' elif system == 'debian': cmd += ' --with-gtest-source=/usr/src/googletest/googletest' elif system == 'ubuntu': if revision.startswith('16.'): cmd += ' --with-gtest-source=/usr/src/googletest-release-1.10.0/googletest/' else: cmd += ' --with-gtest-source=/usr/src/googletest/googletest' else: raise NotImplementedError('no implementation for %s' % system) if 'docs' in features and not (system == 'rhel' and revision == '8'): cmd += ' --enable-generate-docs' if system == 'debian' and revision == '8': cmd += ' --with-sphinx=~/venv/bin/sphinx-build' elif system == 'centos' and revision in ['7', '8']: cmd += ' --with-sphinx=~/venv/bin/sphinx-build' if 'radius' in features: cmd += ' --with-freeradius=/usr/local' if 'gssapi' in features: if system == 'freebsd': cmd += ' --with-gssapi=/usr/local/bin/krb5-config' else: cmd += ' --with-gssapi' if 'shell' in features: cmd += ' --enable-shell' if 'perfdhcp' in features: cmd += ' --enable-perfdhcp' if 'netconf' in features: cmd += ' --with-libyang --with-sysrepo' # do ./configure execute(cmd, cwd=src_path, env=env, timeout=120, check_times=check_times, dry_run=dry_run) if 'netconf' in features: # Make sure sysrepoctl can find its libraries. Some systems don't look # in /usr/local. if 'LD_LIBRARY_PATH' not in env: env['LD_LIBRARY_PATH'] = '' if len(env['LD_LIBRARY_PATH']): env['LD_LIBRARY_PATH'] += ':' env['LD_LIBRARY_PATH'] += '/usr/local/lib:/usr/local/lib64' # ./configure has created reinstall.sh from reinstall.sh.in. Call it. execute('./src/share/yang/modules/utils/reinstall.sh', cwd=src_path, env=env) # estimate number of processes (jobs) to use in compilation if jobs are not provided if jobs == 0: cpus = multiprocessing.cpu_count() - 1 if system == 'centos': cpus = cpus // 2 if cpus == 0: cpus = 1 else: cpus = jobs # enable ccache if requested env = _prepare_ccache_if_needed(system, ccache_dir, env) # do build timeout = _calculate_build_timeout(features) if 'distcheck' in features: cmd = 'make distcheck' else: cmd = 'make -j%s' % cpus execute(cmd, cwd=src_path, env=env, timeout=timeout, check_times=check_times, dry_run=dry_run) if 'unittest' in features: results_dir = os.path.abspath(os.path.join(src_path, 'tests_result')) execute('rm -rf %s' % results_dir, dry_run=dry_run) if not os.path.exists(results_dir): os.mkdir(results_dir) env['GTEST_OUTPUT'] = 'xml:%s/' % results_dir env['KEA_SOCKET_TEST_DIR'] = '/tmp/' # run unit tests execute('make check -k', cwd=src_path, env=env, timeout=90 * 60, raise_error=False, check_times=check_times, dry_run=dry_run) # parse unit tests results results = {} grand_total = 0 grand_not_passed = 0 aggregated_root = ET.Element('testsuites') for fn in os.listdir(results_dir): if not fn.endswith('.xml'): continue fp = os.path.join(results_dir, fn) tree = ET.parse(fp) root = tree.getroot() # prepare stats for json total = int(root.get('tests')) failures = int(root.get('failures')) disabled = int(root.get('disabled')) errors = int(root.get('errors')) results[fn] = dict(total=total, failures=failures, disabled=disabled, errors=errors) grand_total += total grand_not_passed += failures + errors # append test suites to aggregated root for ts in root.findall('testsuite'): if not ts: continue aggregated_root.append(ts) # prepare and stats in json grand_passed = grand_total - grand_not_passed results['grand_passed'] = grand_total - grand_not_passed results['grand_total'] = grand_total result = '%s/%s passed' % (grand_passed, grand_total) if grand_not_passed > 0 or grand_total == 0: result = red(result) else: result = green(result) log.info('Unit test results: %s', result) with open('unit-test-results.json', 'w') as f: f.write(json.dumps(results)) # store aggregated results in XML if os.path.exists('aggregated_tests.xml'): os.unlink('aggregated_tests.xml') aggr = ET.ElementTree(aggregated_root) aggr.write('aggregated_tests.xml') if 'install' in features: execute('sudo make install', timeout=2 * 60, cwd=src_path, env=env, check_times=check_times, dry_run=dry_run) if system != 'alpine': execute('sudo ldconfig', dry_run=dry_run) # TODO: this shouldn't be needed if 'forge' in features: if 'mysql' in features: execute('kea-admin db-init mysql -u keauser -p keapass -n keadb', dry_run=dry_run) if 'pgsql' in features: execute('kea-admin db-init pgsql -u keauser -p keapass -n keadb', dry_run=dry_run) def _check_installed_rpm_or_debs(services_list): for svc in services_list: execute('sudo systemctl stop %s' % svc) now = datetime.datetime.now() timestamp = now.strftime('%Y-%m-%d%H:%M:%S') execute('sudo systemctl start %s' % svc) time.sleep(3) cmd = "sudo journalctl --since %s -u %s | grep '_STARTED Kea'" % (timestamp, svc) execute(cmd, attempts=10, sleep_time_after_attempt=1) def _build_rpm(system, revision, features, tarball_path, env, check_times, dry_run, pkg_version, pkg_isc_version, repo_url): # install our freeradius-client but now from rpm cmd = 'bash -c "cat <>> Building %s, %s, %s", provider, system, revision) log.info('') t0 = time.time() ve = None error = None total = 0 passed = 0 try: ve = VagrantEnv(provider, system, revision, features, 'kea', dry_run, quiet, check_times, ccache_dir) if clean_start: ve.destroy() ve.init_files() ve.bring_up_latest_box() ve.prepare_system() total, passed = ve.run_build_and_test(tarball_path, jobs, pkg_version, pkg_isc_version, upload, repository_url) msg = ' - ' + green('all ok') except KeyboardInterrupt as e: error = e msg = ' - keyboard interrupt' except ExecutionError as e: error = e msg = ' - ' + red(str(e)) except Exception as e: # pylint: disable=broad-except log.exception('Building erred') error = e msg = ' - ' + red(str(e)) finally: if not leave_system and ve: ve.destroy() t1 = time.time() dt = int(t1 - t0) log.info('') log.info(">>> Building %s, %s, %s completed in %s:%s%s", provider, system, revision, dt // 60, dt % 60, msg) log.info('') return dt, error, total, passed def package_box(provider, system, revision, features, dry_run, check_times, reuse, skip_upload): """Prepare Vagrant box of specified system.""" ve = VagrantEnv(provider, system, revision, features, 'bare', dry_run, check_times=check_times) if not reuse: ve.destroy() ve.init_files() ve.bring_up_latest_box() ve.prepare_system() ve.prepare_for_boxing() box_path = ve.package() if not skip_upload: ve.upload_to_cloud(box_path) def ssh(provider, system, revision): """Invoke Vagrant ssh for given system.""" ve = VagrantEnv(provider, system, revision, [], 'kea', False) ve.up() ve.ssh() def _install_vagrant(ver='2.2.16', upgrade=False): system, _ = get_system_revision() if system in ['fedora', 'centos', 'rhel']: if upgrade: execute('sudo rpm -e vagrant') rpm = 'vagrant_%s_x86_64.rpm' % ver cmd = 'wget --no-verbose -O /tmp/%s ' % rpm cmd += 'https://releases.hashicorp.com/vagrant/%s/%s' % (ver, rpm) execute(cmd) execute('sudo rpm -i /tmp/%s' % rpm) os.unlink('/tmp/%s' % rpm) elif system in ['debian', 'ubuntu']: if upgrade: execute('sudo dpkg --purge vagrant') deb = 'vagrant_%s_x86_64.deb' % ver cmd = 'wget --no-verbose -O /tmp/%s ' % deb cmd += 'https://releases.hashicorp.com/vagrant/%s/%s' % (ver, deb) execute(cmd) execute('sudo dpkg -i /tmp/%s' % deb) os.unlink('/tmp/%s' % deb) else: # TODO: check for packages here: https://www.vagrantup.com/downloads.html raise NotImplementedError('no implementation for %s' % system) def ensure_hammer_deps(): """Install Hammer dependencies onto current, host system.""" exitcode, out = execute('vagrant version', raise_error=False, capture=True) if exitcode != 0: _install_vagrant() else: m = re.search('Installed Version: ([\d\.]+)', out, re.I) ver = m.group(1) major, minor, patch = [int(v) for v in ver.split('.')] # if ver < 2.2.16 if major < 2 or (major == 2 and (minor < 2 or (minor == 2 and patch < 16))): m = re.search('Latest Version: ([\d\.]+)', out, re.I) ver = m.group(1) _install_vagrant(ver, upgrade=True) exitcode = execute('vagrant plugin list | grep vagrant-lxc', raise_error=False) if exitcode != 0: execute('vagrant plugin install vagrant-lxc') # install lxc-create on Ubuntu (part of lxc-utils) system, _ = get_system_revision() if system in ['ubuntu']: execute('sudo apt-get -y install lxc-utils') class CollectCommaSeparatedArgsAction(argparse.Action): """Helper argparse action class that can split multi-argument options by space and by comma.""" def __call__(self, parser, namespace, values, option_string=None): values2 = [] for v1 in values: for v2 in v1.split(): values2.extend(v2.split(',')) for v in values2: if v not in ALL_FEATURES: msg = "feature '%s' is not supported. List of supported features: %s." msg = msg % (v, ", ".join(ALL_FEATURES)) raise argparse.ArgumentError(self, msg) setattr(namespace, self.dest, values2) DEFAULT_FEATURES = ['install', 'unittest', 'docs', 'perfdhcp'] ALL_FEATURES = ['install', 'distcheck', 'unittest', 'docs', 'mysql', 'pgsql', 'cql', 'native-pkg', 'radius', 'gssapi', 'netconf', 'shell', 'forge', 'perfdhcp', 'ccache', 'all'] def parse_args(): """Parse arguments.""" # used lambda to change args order and able to substitute width fl = functools.partial(lambda w, t: textwrap.fill(t, w), 80) description = [ "Hammer - Kea development environment management tool.\n", fl("At first it is required to install Hammer dependencies which is Vagrant and either " "VirtualBox or LXC. To make life easier Hammer can install Vagrant and required " "Vagrant plugins using the command:"), "\n ./hammer.py ensure-hammer-deps\n", "Still VirtualBox and LXC need to be installed manually.", fl("Basic functionality provided by Hammer is preparing building environment and " "performing actual build and running unit tests locally, in current system. " "This can be achieved by running the command:"), "\n ./hammer.py build -p local\n", fl("The scope of the process can be defined using --with (-w) and --without (-x) options. " "By default the build command will build Kea with documentation, install it locally " "and run unit tests."), "To exclude installation and generating docs do:", "\n ./hammer.py build -p local -x install docs\n", fl("The whole list of available features is: %s." % ", ".join(ALL_FEATURES)), fl("Hammer can be told to set up a new virtual machine with specified operating system " "and not running the build:"), "\n ./hammer.py prepare-system -p virtualbox -s freebsd -r 12.0\n", fl("This way we can prepare a system for our own use. To get to such system using SSH invoke:"), "\n ./hammer.py ssh -p virtualbox -s freebsd -r 12.0\n", "To list all created system on a host invoke:", "\n ./hammer.py created-systems\n", "And then to destroy a given system run:", "\n ./hammer.py destroy -d /path/to/dir/with/Vagrantfile\n", ] description = "\n".join(description) main_parser = argparse.ArgumentParser(description=description, formatter_class=argparse.RawDescriptionHelpFormatter) main_parser.add_argument('-v', '--verbose', action='store_true', help='Enable verbose mode.') main_parser.add_argument('-q', '--quiet', action='store_true', help='Enable quiet mode.') subparsers = main_parser.add_subparsers(dest='command', title="Hammer commands", description=fl("The following commands are provided by Hammer. " "To get more information about particular command invoke: " "./hammer.py -h.")) parent_parser1 = argparse.ArgumentParser(add_help=False) parent_parser1.add_argument('-p', '--provider', default='virtualbox', choices=['lxc', 'virtualbox', 'local', 'all'], help="Backend build executor. If 'all' then build is executed several times " "on all providers. If 'local' then build is executed on current system. " "Default is 'virtualbox'.") parent_parser1.add_argument('-s', '--system', default='all', choices=list(SYSTEMS.keys()) + ['all'], help="Build is executed on selected system. If 'all' then build is executed " "several times on all systems. If provider is 'local' then this option is ignored. " "Default is 'all'.") parent_parser1.add_argument('-r', '--revision', default='all', help="Revision of selected system. If 'all' then build is executed several times " "on all revisions of selected system. To list supported systems and their revisions " "invoke 'supported-systems'. Default is 'all'.") parent_parser2 = argparse.ArgumentParser(add_help=False) hlp = "Enable features. Separate them by space or comma. List of available features: %s. Default is '%s'." hlp = hlp % (", ".join(ALL_FEATURES), ' '.join(DEFAULT_FEATURES)) parent_parser2.add_argument('-w', '--with', metavar='FEATURE', nargs='+', default=set(), action=CollectCommaSeparatedArgsAction, help=hlp) hlp = "Disable features. Separate them by space or comma. List of available features: %s. Default is ''." hlp = hlp % ", ".join(ALL_FEATURES) parent_parser2.add_argument('-x', '--without', metavar='FEATURE', nargs='+', default=set(), action=CollectCommaSeparatedArgsAction, help=hlp) parent_parser2.add_argument('-l', '--leave-system', action='store_true', help='At the end of the command do not destroy vagrant system. Default behavior is ' 'destroying the system.') parent_parser2.add_argument('-c', '--clean-start', action='store_true', help='If there is pre-existing system then it is destroyed first.') parent_parser2.add_argument('-i', '--check-times', action='store_true', help='Do not allow executing commands infinitely.') parent_parser2.add_argument('-n', '--dry-run', action='store_true', help='Print only what would be done.') parser = subparsers.add_parser('ensure-hammer-deps', help="Install Hammer dependencies on current, host system.") parser = subparsers.add_parser('supported-systems', help="List system supported by Hammer for doing Kea development.") parser = subparsers.add_parser('build', help="Prepare system and run Kea build in indicated system.", parents=[parent_parser1, parent_parser2]) parser.add_argument('-j', '--jobs', default=0, help='Number of processes used in compilation. Override make -j default value.') parser.add_argument('-t', '--from-tarball', metavar='TARBALL_PATH', help='Instead of building sources in current folder use provided tarball ' 'package (e.g. tar.gz).') parser.add_argument('--ccache-dir', default=None, help='Path to CCache directory on host system.') parser.add_argument('--pkg-version', default='0.0.1', help='Kea version.') parser.add_argument('--pkg-isc-version', default='isc0', help='ISC build version of Kea.') parser.add_argument('--upload', action='store_true', help='Request uploading native packages to repository indicated by --repository-url.') parser.add_argument('--repository-url', default=None, help='Repository for 3rd party dependencies and for uploading built packages.') parser = subparsers.add_parser('prepare-system', help="Prepare system for doing Kea development i.e. install all required " "dependencies and pre-configure the system. build command always first calls " "prepare-system internally.", parents=[parent_parser1, parent_parser2]) parser.add_argument('--ccache-dir', default=None, help='Path to CCache directory on host system.') parser.add_argument('--repository-url', default=None, help='Repository for 3rd party dependencies and for uploading built packages.') parser = subparsers.add_parser('ssh', help="SSH to indicated system.", formatter_class=argparse.RawDescriptionHelpFormatter, description="Allows getting into the system using SSH. If the system is " "not present then it will be created first but not prepared. The command " "can be run in 2 way: \n" "1) ./hammer.py ssh -p -s -r \n" "2) ./hammer.py ssh -d ", parents=[parent_parser1]) parser.add_argument('-d', '--directory', help='Path to directory with Vagrantfile.') parser = subparsers.add_parser('created-systems', help="List ALL systems created by Hammer.") parser = subparsers.add_parser('destroy', help="Destroy indicated system.", description="Destroys system indicated by a path to directory with Vagrantfile. " "To get the list of created systems run: ./hammer.py created-systems.") parser.add_argument('-d', '--directory', help='Path to directory with Vagrantfile.') parser = subparsers.add_parser('package-box', help="Prepare system from scratch and package it into Vagrant Box. Prepared box can be " "later deployed to Vagrant Cloud.", parents=[parent_parser1, parent_parser2]) parser.add_argument('--repository-url', default=None, help='Repository for 3rd party dependencies and for uploading built packages.') parser.add_argument('-u', '--reuse', action='store_true', help='Reuse existing system image, otherwise (default case) if there is any existing then destroy it first.') parser.add_argument('-k', '--skip-upload', action='store_true', help='Skip uploading prepared box to cloud, otherwise (default case) upload it.') args = main_parser.parse_args() return args, main_parser def list_supported_systems(): """List systems hammer can support (with supported providers).""" for system, revisions in SYSTEMS.items(): print('%s:' % system) for r in revisions: providers = [] for p in ['lxc', 'virtualbox']: k = '%s-%s-%s' % (system, r, p) if k in IMAGE_TEMPLATES: providers.append(p) providers = ', '.join(providers) print(' - %s: %s' % (r, providers)) def list_created_systems(): """List VMs that are created on this host by Hammer.""" _, output = execute('vagrant global-status --prune', quiet=True, capture=True) systems = [] for line in output.splitlines(): if 'hammer' not in line: continue elems = line.split() state = elems[3] path = elems[4] systems.append([path, state]) print('') print('%-10s %s' % ('State', 'Path')) print('-' * 80) for path, state, in sorted(systems): print('%-10s %s' % (state, path)) print('-' * 80) print('To destroy a system run: ./hammer.py destroy -d ') print('') def destroy_system(path): """Destroy Vagrant system under given path.""" vf = os.path.join(path, 'Vagrantfile') if not os.path.exists(vf): print('Wrong directory. It does not have Vagrantfile.') sys.exit(1) execute('vagrant destroy', cwd=path, interactive=True) def _get_features(args): features = set(vars(args)['with']) # establish initial set of features if 'all' in features: # special case 'all' but some of features needs to be removed # as they are not compatible with others features = set(ALL_FEATURES) features.discard('all') features.discard('distcheck') features.discard('native-pkg') features.discard('ccache') elif 'distcheck' not in features: # distcheck is not compatible with defaults so do not add defaults features = features.union(DEFAULT_FEATURES) nofeatures = set(args.without) features = features.difference(nofeatures) if hasattr(args, 'ccache_dir') and args.ccache_dir: features.add('ccache') # if we build native packages then some features are required and some not if 'native-pkg' in features: features.add('docs') features.add('perfdhcp') features.add('shell') features.add('mysql') features.add('pgsql') features.add('radius') features.add('gssapi') # in case of build command of native packages, unittest should not # be run as they are not built if args.command == 'build': features.discard('unittest') return features def _print_summary(results, features): """Print summary of build times and unit-test results.""" print("") print("+===== Hammer Summary ====================================================+") print("| provider | system | revision | duration | status | unit tests |") print("+------------+------------+----------+-----------+---------+--------------+") total_dt = 0 for key, result in results.items(): provider, system, revision = key dt, error, ut_total, ut_passed = result total_dt += dt if error is None: status = ' %s' % green('ok') elif error == 'not run': status = blue('not run') else: status = ' %s' % red('error') if 'unittest' in features: ut_results = '%s/%s' % (ut_passed, ut_total) padding = ' ' * (12 - len(ut_results)) if ut_passed < ut_total or ut_total == 0: ut_results = padding + red(ut_results) else: ut_results = padding + green(ut_results) else: ut_results = ' not planned' txt = '| %10s | %10s | %8s | %6d:%02d | %s | %s |' % (provider, system, revision, dt // 60, dt % 60, status, ut_results) print(txt) print("+------------+------------+----------+-----------+---------+--------------+") txt = "| Total: %6d:%02d | |" % (total_dt // 60, total_dt % 60) print(txt) print("+=========================================================================+") def _check_system_revision(system, revision): if revision == 'all': return revs = SYSTEMS[system] if revision not in revs: msg = "hammer.py error: argument -r/--revision: invalid choice: '%s' (choose from '%s')" msg = msg % (revision, "', '".join(revs)) print(msg) sys.exit(1) def _prepare_ccache_dir(ccache_dir, system, revision): if not ccache_dir: return None ccache_dir = os.path.join(ccache_dir, "%s-%s" % (system, revision)) ccache_dir = os.path.abspath(ccache_dir) if not os.path.exists(ccache_dir): os.makedirs(ccache_dir) return ccache_dir def prepare_system_cmd(args): """Check command args and run the prepare-system command.""" if args.provider != 'local' and (args.system == 'all' or args.revision == 'all'): print('Please provide required system and its version.') print('Example: ./hammer.py prepare-system -s fedora -r 28.') print('To get list of supported systems run: ./hammer.py supported-systems.') sys.exit(1) _check_system_revision(args.system, args.revision) features = _get_features(args) log.info('Enabled features: %s', ' '.join(features)) if args.provider == 'local': prepare_system_local(features, args.check_times) return ccache_dir = _prepare_ccache_dir(args.ccache_dir, args.system, args.revision) _check_deps_presence() prepare_system_in_vagrant(args.provider, args.system, args.revision, features, args.dry_run, args.check_times, args.clean_start, ccache_dir) def upload_to_repo(args, pkgs_dir): # NOTE: note the differences (if any) in system/revision vs args.system/revision system, revision = get_system_revision() repo_url = _get_full_repo_url(args.repository_url, system, revision, args.pkg_version) assert repo_url is not None upload_cmd = 'curl -v --netrc -f' log.info('args.system %s, system = %s', args.system, system) file_ext = '' if system in ['ubuntu', 'debian']: upload_cmd += ' -X POST -H "Content-Type: multipart/form-data" --data-binary "@%s" ' file_ext = '.deb' elif system in ['fedora', 'centos', 'rhel']: upload_cmd += ' --upload-file %s ' file_ext = '.rpm' elif system == 'alpine': upload_cmd += ' --upload-file %s ' file_ext = '' repo_url = urljoin(repo_url, '%s/v%s/x86_64/' % (args.pkg_isc_version, revision)) upload_cmd += ' ' + repo_url for fn in os.listdir(pkgs_dir): log.info("debug: fn = %s", fn) if file_ext and not fn.endswith(file_ext): log.info('File extension "%s" is not supported by upload_to_repo function', file_ext) continue fp = os.path.join(pkgs_dir, fn) log.info("upload cmd: %s", upload_cmd) log.info("fp: %s", fp) cmd = upload_cmd % fp execute(cmd) def build_cmd(args): """Check command args and run the build command.""" features = _get_features(args) log.info('Enabled features: %s', ' '.join(features)) if args.provider == 'local': # NOTE: working dir is /tmp/workspace/kea-dev/pkg pkgs_dir = "kea-pkg" if os.path.exists(pkgs_dir): execute('rm -rf %s' % pkgs_dir) os.makedirs(pkgs_dir) build_local(features, args.from_tarball, args.check_times, int(args.jobs), args.dry_run, args.ccache_dir, args.pkg_version, args.pkg_isc_version, args.repository_url, pkgs_dir) # NOTE: upload the locally build packages and leave; the rest of the code is vagrant specific if args.upload: upload_to_repo(args,pkgs_dir) return _check_system_revision(args.system, args.revision) if 'native-pkg' in features and not args.repository_url: msg = "Enabling 'native-pkg' requires passing --repository-url." print(msg) sys.exit(1) _check_deps_presence() if args.provider == 'all': providers = ['lxc', 'virtualbox'] else: providers = [args.provider] if args.system == 'all': systems = SYSTEMS.keys() else: systems = [args.system] plan = [] results = {} log.info('Build plan:') for provider in providers: for system in systems: if args.revision == 'all': revisions = SYSTEMS[system] else: revisions = [args.revision] for revision in revisions: if args.revision == 'all': key = '%s-%s-%s' % (system, revision, provider) if key not in IMAGE_TEMPLATES: continue plan.append((provider, system, revision)) log.info(' - %s, %s, %s', provider, system, revision) results[(provider, system, revision)] = (0, 'not run') fail = False for provider, system, revision in plan: ccache_dir = _prepare_ccache_dir(args.ccache_dir, args.system, args.revision) result = build_in_vagrant(provider, system, revision, features, args.leave_system, args.from_tarball, args.dry_run, args.quiet, args.clean_start, args.check_times, int(args.jobs), ccache_dir, args.pkg_version, args.pkg_isc_version, args.upload, args.repository_url) results[(provider, system, revision)] = result error = result[1] if error: fail = True if isinstance(error, KeyboardInterrupt): break _print_summary(results, features) if fail: sys.exit(1) def _check_deps_presence(): ret = execute('vagrant -v', super_quiet=True, raise_error=False) if ret != 0: print('Missing vagrant. Please install it from https://www.vagrantup.com/') sys.exit(1) def main(): """Main function - parse args and invoke proper command.""" args, parser = parse_args() # prepare logging if args.verbose: level = logging.DEBUG fmt = '[HAMMER] %(asctime)-15s L%(lineno)04d %(message)s' else: level = logging.INFO fmt = '[HAMMER] %(asctime)-15s %(message)s' logging.basicConfig(format=fmt, level=level) # dispatch command if args.command == 'supported-systems': list_supported_systems() elif args.command == 'created-systems': _check_deps_presence() list_created_systems() elif args.command == "package-box": _check_deps_presence() _check_system_revision(args.system, args.revision) features = set(['docs', 'perfdhcp', 'shell', 'mysql', 'pgsql', 'radius', 'gssapi', 'native-pkg']) log.info('Enabled features: %s', ' '.join(features)) package_box(args.provider, args.system, args.revision, features, args.dry_run, args.check_times, args.reuse, args.skip_upload) elif args.command == "prepare-system": prepare_system_cmd(args) elif args.command == "build": build_cmd(args) elif args.command == "ssh": _check_system_revision(args.system, args.revision) if not args.system or not args.revision or args.system == 'all' or args.revision == 'all': print('System (-s) and revision (-r) parameters are required') sys.exit(1) _check_deps_presence() ssh(args.provider, args.system, args.revision) elif args.command == "ensure-hammer-deps": ensure_hammer_deps() elif args.command == "destroy": if not args.directory: print('Missing directory (-d) parameter') sys.exit(1) _check_deps_presence() destroy_system(args.directory) else: parser.print_help() if __name__ == '__main__': main()