import inspect import itertools import os import sys import threading import time from contextlib import contextmanager from enum import Enum from pathlib import Path from tempfile import NamedTemporaryFile from typing import Optional, List from invoke import task, Context DAEMON_DIR: str = "daemon" DEFAULT_PREFIX: str = "/usr/local" EMANE_CHECKOUT: str = "v1.2.5" OSPFMDR_CHECKOUT: str = "f4295dbdc37c6834485aa894fc5e49d04315b107" REDHAT_LIKE = { "redhat", "fedora", } DEBIAN_LIKE = { "ubuntu", "debian", } class Progress: cycles = itertools.cycle(["-", "/", "|", "\\"]) def __init__(self, verbose: bool) -> None: self.verbose: bool = verbose self.thread: Optional[threading.Thread] = None self.running: bool = False @contextmanager def start(self, message: str) -> None: if not self.verbose: print(f"{message} ... ", end="") self.running = True self.thread = threading.Thread(target=self.run, daemon=True) self.thread.start() yield self.stop() def run(self) -> None: while self.running: sys.stdout.write(next(self.cycles)) sys.stdout.flush() sys.stdout.write("\b") time.sleep(0.1) def stop(self) -> None: if not self.verbose: print("done") if self.thread: self.running = False self.thread.join() self.thread = None class OsName(Enum): UBUNTU = "ubuntu" CENTOS = "centos" UNKNOWN = "unknown" @classmethod def get(cls, name: str) -> "OsName": try: return OsName(name) except ValueError: return OsName.UNKNOWN class OsLike(Enum): DEBIAN = "debian" REDHAT = "rhel" @classmethod def get(cls, values: List[str]) -> Optional["OsLike"]: for value in values: if value in DEBIAN_LIKE: return OsLike.DEBIAN elif value in REDHAT_LIKE: return OsLike.REDHAT return None class OsInfo: def __init__(self, name: OsName, like: OsLike, version: float) -> None: self.name: OsName = name self.like: OsLike = like self.version: float = version @classmethod def get(cls, name: str, like: List[str], version: Optional[str]) -> "OsInfo": os_name = OsName.get(name) os_like = OsLike.get(like) if not os_like: like = " ".join(like) print(f"unsupported os install type({like})") sys.exit(1) if version: try: version = float(version) except ValueError: print(f"os version is not a float: {version}") sys.exit(1) return OsInfo(os_name, os_like, version) def get_python(c: Context, warn: bool = False) -> str: with c.cd(DAEMON_DIR): r = c.run("poetry env info -p", warn=warn, hide=True) if r.ok: venv = r.stdout.strip() return os.path.join(venv, "bin", "python") else: return "" def get_pytest(c: Context) -> str: with c.cd(DAEMON_DIR): venv = c.run("poetry env info -p", hide=True).stdout.strip() return os.path.join(venv, "bin", "pytest") def get_os(install_type: Optional[str]) -> OsInfo: if install_type: name_value = OsName.UNKNOWN.value like_value = install_type version_value = None else: d = {} with open("/etc/os-release", "r") as f: for line in f.readlines(): line = line.strip() if not line: continue key, value = line.split("=") d[key] = value.strip("\"") name_value = d["ID"] like_value = d["ID_LIKE"] version_value = d["VERSION_ID"] return OsInfo.get(name_value, like_value.split(), version_value) def check_existing_core(c: Context, hide: bool) -> None: if c.run("python -c \"import core\"", warn=True, hide=hide): raise SystemError("existing python2 core installation detected, please remove") if c.run("python3 -c \"import core\"", warn=True, hide=hide): raise SystemError("existing python3 core installation detected, please remove") if c.run("which core-daemon", warn=True, hide=hide): raise SystemError("core scripts found, please remove old installation") def install_system(c: Context, os_info: OsInfo, hide: bool) -> None: if os_info.like == OsLike.DEBIAN: c.run( "sudo apt install -y automake pkg-config gcc libev-dev ebtables " "iproute2 ethtool tk python3-tk bash", hide=hide ) elif os_info.like == OsLike.REDHAT: c.run( "sudo yum install -y automake pkgconf-pkg-config gcc gcc-c++ " "libev-devel iptables-ebtables iproute python3-devel python3-tkinter " "tk ethtool make bash", hide=hide ) # centos 8+ does not support netem by default if os_info.name == OsName.CENTOS and os_info.version >= 8: c.run("sudo yum install -y kernel-modules-extra", hide=hide) if not c.run("sudo modprobe sch_netem", warn=True, hide=hide): print("\nERROR: you need to install the latest kernel") print("run the following, restart, and try again") print("sudo yum update") sys.exit(1) # attempt to setup legacy ebtables when an nftables based version is found r = c.run("ebtables -V", hide=hide) if "nf_tables" in r.stdout: if not c.run( "sudo update-alternatives --set ebtables /usr/sbin/ebtables-legacy", warn=True, hide=hide ): print( "\nWARNING: unable to setup ebtables-legacy, WLAN will not work" ) def install_grpcio(c: Context, hide: bool) -> None: c.run( "python3 -m pip install --user grpcio==1.27.2 grpcio-tools==1.27.2", hide=hide, ) def build_core(c: Context, hide: bool, prefix: str = DEFAULT_PREFIX) -> None: c.run("./bootstrap.sh", hide=hide) c.run(f"./configure --prefix={prefix}", hide=hide) c.run("make -j$(nproc)", hide=hide) def install_core(c: Context, hide: bool) -> None: c.run("sudo make install", hide=hide) def install_poetry(c: Context, dev: bool, local: bool, hide: bool) -> None: c.run("pipx install poetry", hide=hide) if local: with c.cd(DAEMON_DIR): c.run("poetry build -f wheel", hide=hide) c.run("sudo python3 -m pip install dist/*") else: args = "" if dev else "--no-dev" with c.cd(DAEMON_DIR): c.run(f"poetry install {args}", hide=hide) if dev: c.run("poetry run pre-commit install", hide=hide) def install_ospf_mdr(c: Context, os_info: OsInfo, hide: bool) -> None: if c.run("which zebra", warn=True, hide=hide): print("\nquagga already installed, skipping ospf mdr") return if os_info.like == OsLike.DEBIAN: c.run("sudo apt install -y libtool gawk libreadline-dev git", hide=hide) elif os_info.like == OsLike.REDHAT: c.run("sudo yum install -y libtool gawk readline-devel git", hide=hide) ospf_dir = "../ospf-mdr" ospf_url = "https://github.com/USNavalResearchLaboratory/ospf-mdr.git" c.run(f"git clone {ospf_url} {ospf_dir}", hide=hide) with c.cd(ospf_dir): c.run(f"git checkout {OSPFMDR_CHECKOUT}", hide=hide) c.run("./bootstrap.sh", hide=hide) c.run( "./configure --disable-doc --enable-user=root --enable-group=root " "--with-cflags=-ggdb --sysconfdir=/usr/local/etc/quagga --enable-vtysh " "--localstatedir=/var/run/quagga", hide=hide ) c.run("make -j$(nproc)", hide=hide) c.run("sudo make install", hide=hide) @task( help={ "verbose": "enable verbose", "prefix": f"prefix where scripts are installed, default is {DEFAULT_PREFIX}" }, ) def install_service(c, verbose=False, prefix=DEFAULT_PREFIX): """ install systemd core service """ hide = not verbose bin_dir = Path(prefix).joinpath("bin") systemd_dir = Path("/lib/systemd/system/") service_file = systemd_dir.joinpath("core-daemon.service") if systemd_dir.exists(): service_data = inspect.cleandoc(f""" [Unit] Description=Common Open Research Emulator Service After=network.target [Service] Type=simple ExecStart={bin_dir}/core-daemon TasksMax=infinity [Install] WantedBy=multi-user.target """) temp = NamedTemporaryFile("w", delete=False) temp.write(service_data) temp.close() c.run(f"sudo cp {temp.name} {service_file}", hide=hide) else: print(f"ERROR: systemd service path not found: {systemd_dir}") @task( help={ "verbose": "enable verbose", "prefix": f"prefix where scripts are installed, default is {DEFAULT_PREFIX}", "local": "determines if core will install to local system, default is False", }, ) def install_scripts(c, local=False, verbose=False, prefix=DEFAULT_PREFIX): """ install core script files, modified to leverage virtual environment """ hide = not verbose python = get_python(c) bin_dir = Path(prefix).joinpath("bin") for script in Path("daemon/scripts").iterdir(): dest = bin_dir.joinpath(script.name) with open(script, "r") as f: lines = f.readlines() first = lines[0].strip() # modify python scripts to point to virtual environment if not local and first == "#!/usr/bin/env python3": lines[0] = f"#!{python}\n" temp = NamedTemporaryFile("w", delete=False) for line in lines: temp.write(line) temp.close() c.run(f"sudo cp {temp.name} {dest}", hide=hide) c.run(f"sudo chmod 755 {dest}", hide=hide) os.unlink(temp.name) # copy normal links else: c.run(f"sudo cp {script} {dest}", hide=hide) # setup core python helper if not local: core_python = bin_dir.joinpath("core-python") temp = NamedTemporaryFile("w", delete=False) temp.writelines([ "#!/bin/bash\n", f'exec "{python}" "$@"\n', ]) temp.close() c.run(f"sudo cp {temp.name} {core_python}", hide=hide) c.run(f"sudo chmod 755 {core_python}", hide=hide) os.unlink(temp.name) # install core configuration file config_dir = "/etc/core" c.run(f"sudo mkdir -p {config_dir}", hide=hide) c.run(f"sudo cp -n daemon/data/core.conf {config_dir}", hide=hide) c.run(f"sudo cp -n daemon/data/logging.conf {config_dir}", hide=hide) @task( help={ "dev": "install development mode", "verbose": "enable verbose", "local": "determines if core will install to local system, default is False", "prefix": f"prefix where scripts are installed, default is {DEFAULT_PREFIX}", "install-type": "used to force an install type, " "can be one of the following (redhat, debian)", }, ) def install( c, dev=False, verbose=False, local=False, prefix=DEFAULT_PREFIX, install_type=None ): """ install core, poetry, scripts, service, and ospf mdr """ print(f"installing core locally: {local}") print(f"installing core with prefix: {prefix}") c.run("sudo -v", hide=True) p = Progress(verbose) hide = not verbose os_info = get_os(install_type) if not c["run"]["dry"]: with p.start("checking for old installations"): check_existing_core(c, hide) with p.start("installing system dependencies"): install_system(c, os_info, hide) with p.start("installing system grpcio-tools"): install_grpcio(c, hide) with p.start("building core"): build_core(c, hide, prefix) with p.start("installing vcmd/gui"): install_core(c, hide) install_type = "core" if local else "core virtual environment" with p.start(f"installing {install_type}"): install_poetry(c, dev, local, hide) with p.start("installing scripts and /etc/core"): install_scripts(c, local, hide, prefix) with p.start("installing systemd service"): install_service(c, hide, prefix) with p.start("installing ospf mdr"): install_ospf_mdr(c, os_info, hide) print("\ninstall complete!") @task( help={ "verbose": "enable verbose", "local": "used determine if core is installed locally, default is False", "install-type": "used to force an install type, " "can be one of the following (redhat, debian)", }, ) def install_emane(c, verbose=False, local=False, install_type=None): """ install emane and the python bindings """ c.run("sudo -v", hide=True) p = Progress(verbose) hide = not verbose os_info = get_os(install_type) with p.start("installing system dependencies"): if os_info.like == OsLike.DEBIAN: c.run( "sudo apt install -y gcc g++ automake libtool libxml2-dev " "libprotobuf-dev libpcap-dev libpcre3-dev uuid-dev pkg-config " "protobuf-compiler git python3-protobuf python3-setuptools", hide=hide, ) elif os_info.like == OsLike.REDHAT: if os_info.name == OsName.CENTOS and os_info.version >= 8: c.run("sudo yum config-manager --set-enabled PowerTools", hide=hide) c.run( "sudo yum install -y autoconf automake git libtool libxml2-devel " "libpcap-devel pcre-devel libuuid-devel make gcc-c++ protobuf-compiler " "protobuf-devel python3-setuptools", hide=hide, ) emane_dir = "../emane" emane_python_dir = Path(emane_dir).joinpath("src/python") emane_url = "https://github.com/adjacentlink/emane.git" with p.start("cloning emane"): c.run(f"git clone {emane_url} {emane_dir}", hide=hide) with p.start("building emane"): with c.cd(emane_dir): c.run(f"git checkout {EMANE_CHECKOUT}", hide=hide) c.run("./autogen.sh", hide=hide) c.run("PYTHON=python3 ./configure --prefix=/usr", hide=hide) c.run("make -j$(nproc)", hide=hide) with p.start("installing emane"): with c.cd(emane_dir): c.run("sudo make install", hide=hide) with p.start("installing python binding for core"): if local: with c.cd(str(emane_python_dir)): c.run("sudo python3 -m pip install .", hide=hide) else: with c.cd(DAEMON_DIR): c.run( f"poetry run pip install {emane_python_dir.absolute()}", hide=hide ) @task( help={ "dev": "uninstall development mode", "verbose": "enable verbose", "local": "determines if core was installed local to system, default is False", "prefix": f"prefix where scripts are installed, default is {DEFAULT_PREFIX}" }, ) def uninstall(c, dev=False, verbose=False, local=False, prefix=DEFAULT_PREFIX): """ uninstall core, scripts, service, virtual environment, and clean build directory """ print(f"uninstalling core with prefix: {prefix}") hide = not verbose p = Progress(verbose) c.run("sudo -v", hide=True) with p.start("uninstalling core"): c.run("sudo make uninstall", hide=hide) with p.start("cleaning build directory"): c.run("make clean", hide=hide) c.run("./bootstrap.sh clean", hide=hide) if local: with p.start("uninstalling core"): c.run("sudo python3 -m pip uninstall -y core", hide=hide) else: python = get_python(c, warn=True) if python: with c.cd(DAEMON_DIR): if dev: with p.start("uninstalling pre-commit"): c.run("poetry run pre-commit uninstall", hide=hide) with p.start("uninstalling poetry virtual environment"): c.run(f"poetry env remove {python}", hide=hide) # remove installed files bin_dir = Path(prefix).joinpath("bin") with p.start("uninstalling script files"): for script in Path("daemon/scripts").iterdir(): dest = bin_dir.joinpath(script.name) c.run(f"sudo rm -f {dest}", hide=hide) # remove core-python symlink if not local: core_python = bin_dir.joinpath("core-python") c.run(f"sudo rm -f {core_python}", hide=hide) # remove service systemd_dir = Path("/lib/systemd/system/") service_name = "core-daemon.service" service_file = systemd_dir.joinpath(service_name) if service_file.exists(): with p.start(f"uninstalling service {service_file}"): c.run(f"sudo systemctl disable {service_name}", hide=hide) c.run(f"sudo rm -f {service_file}", hide=hide) @task( help={ "dev": "reinstall development mode", "verbose": "enable verbose", "local": "determines if core will install to local system, default is False", "prefix": f"prefix where scripts are installed, default is {DEFAULT_PREFIX}", "branch": "branch to install latest code from, default is current branch", "install-type": "used to force an install type, " "can be one of the following (redhat, debian)", }, ) def reinstall( c, dev=False, verbose=False, local=False, prefix=DEFAULT_PREFIX, branch=None, install_type=None ): """ run the uninstall task, get latest from specified branch, and run install task """ uninstall(c, dev, verbose, local, prefix) hide = not verbose p = Progress(verbose) with p.start("pulling latest code"): current = c.run("git rev-parse --abbrev-ref HEAD", hide=hide).stdout.strip() if branch and branch != current: c.run(f"git checkout {branch}") else: branch = current c.run("git pull", hide=hide) if not Path("tasks.py").exists(): raise FileNotFoundError(f"missing tasks.py on branch: {branch}") install(c, dev, verbose, local, prefix, install_type) @task def daemon(c): """ start core-daemon """ python = get_python(c) with c.cd(DAEMON_DIR): c.run( f"sudo {python} scripts/core-daemon " "-f data/core.conf -l data/logging.conf", pty=True ) @task def test(c): """ run core tests """ pytest = get_pytest(c) with c.cd(DAEMON_DIR): c.run(f"sudo {pytest} -v --lf -x tests", pty=True) @task def test_mock(c): """ run core tests using mock to avoid running as sudo """ with c.cd(DAEMON_DIR): c.run("poetry run pytest -v --mock --lf -x tests", pty=True) @task def test_emane(c): """ run core emane tests """ pytest = get_pytest(c) with c.cd(DAEMON_DIR): c.run(f"sudo {pytest} -v --lf -x tests/emane", pty=True)