feat(bsd): add OpenBSD support to Meson build (#6789)

Author: hcartiaux

meson.build

@@ -221,6 +221,27 @@ elif init_system == 'sysvinit_freebsd'
   endforeach
   # Enable cloud-init on reboot
   meson.add_install_script('sh', '-c', '/usr/sbin/sysrc cloudinit_enable=YES')
+elif init_system == 'sysvinit_openbsd'
+  rcd_templates = run_command(find, 'sysvinit/openbsd', '-type', 'f', check: true)
+  foreach template : rcd_templates.stdout().strip().split('\n')
+    custom_target(
+      input: template,
+      output: '@BASENAME@',
+      command: [
+        render_tmpl,
+        '@INPUT@',
+        meson.current_build_dir() / '@OUTPUT@',
+      ],
+      install: true,
+      install_dir: sysconfdir / 'rc.d',
+      install_mode: 'r-xr-xr-x',
+      install_tag: 'sysvinit',
+    )
+  endforeach
+  meson.add_install_script('/usr/sbin/rcctl', 'enable', 'cloudinitlocal')
+  meson.add_install_script('/usr/sbin/rcctl', 'enable', 'cloudinit')
+  meson.add_install_script('/usr/sbin/rcctl', 'enable', 'cloudconfig')
+  meson.add_install_script('/usr/sbin/rcctl', 'enable', 'cloudfinal')
 endif
 
 custom_target(

meson_options.txt

@@ -1,4 +1,4 @@
-option('init_system', type: 'combo', value: 'systemd', choices: ['systemd', 'sysvinit_openrc', 'sysvinit_freebsd'], description: 'Set target init system.')
+option('init_system', type: 'combo', value: 'systemd', choices: ['systemd', 'sysvinit_openrc', 'sysvinit_freebsd', 'sysvinit_openbsd'], description: 'Set target init system.')
 option('distro_templates', type: 'array', value: [], description: 'Distro template files to install. WARNING: Templates may change in the future. If using this option, be sure to check new releases for template file changes.')
 option('disable_sshd_keygen', type: 'boolean', value: false, description: 'Provide systemd service to disable sshd-keygen if present to avoid races with cloud-init.')
 option('bash_completion', type: 'boolean', value: true, description: 'Bash completion for cloud-init.')

packages/pkg-deps.json

@@ -99,6 +99,25 @@
          "sudo"
       ]
    },
+   "openbsd": {
+      "renames" : {
+         "pyserial"    : "py3-serial",
+         "pyyaml"      : "py3-yaml",
+         "pytest"      : "py3-test",
+         "pytest-cov"  : "py3-test-cov",
+         "pytest-mock" : "py3-test-mock",
+         "pytest-xdist": "py3-test-xdist"
+      },
+      "build-requires" : [
+         "bash",
+         "bash-completion",
+         "meson"
+      ],
+      "requires" : [
+         "e2fsprogs",
+         "sudo--"
+      ]
+   },
    "suse" : {
       "renames" : {
          "jinja2" : "python3-Jinja2",

tools/build-on-openbsd

@@ -1,4 +1,8 @@
 #!/bin/sh
+# This script provides a quick and dirty way of building and installing
+# cloud-init on OpenBSD.
+
+set -eux
 
 fail() {
     echo "FAILED:" "$@" 1>&2
@@ -13,42 +17,11 @@ fi
 
 # Check dependencies:
 depschecked=/tmp/c-i.dependencieschecked
-pkgs="
-   bash
-   dmidecode
-   py3-configobj
-   py3-jinja2
-   py3-jsonschema
-   py3-jsonpatch
-   py3-jsonpointer
-   py3-oauthlib
-   py3-requests
-   py3-setuptools
-   py3-serial
-   py3-yaml
-   sudo--
-   wget
-"
-
-[ -f $depschecked ] || echo "Installing the following packages: $pkgs"
-output=$(pkg_add -zI $pkgs 2>&1)
-
-if echo "$output" | grep -q -e "Can't find" -e "Ambiguous"; then
-    echo "Failed to find or install one or more packages"
-    echo "Failed Package(s):"
-    echo "$output"
-    exit 1
-else
-    echo Successfully installed packages
-    touch $depschecked
-
-    python3 setup.py build
-    python3 setup.py install -O1 --distro openbsd --skip-build --init-system sysvinit_openbsd
+[ -f "$depschecked" ] || ./tools/read-dependencies --distro openbsd -t || fail "install packages"
+touch "$depschecked"
 
-    echo "Installation completed."
+# Build the code and install in /usr/local/:
+meson setup builddir -Dinit_system=sysvinit_openbsd -Dsysconfdir=/etc
+meson install -C builddir
 
-    rcctl enable cloudinitlocal
-    rcctl enable cloudinit
-    rcctl enable cloudconfig
-    rcctl enable cloudfinal
-fi
+echo "Installation completed."

tools/read-dependencies

@@ -23,13 +23,15 @@ DEFAULT_REQUIREMENTS = "requirements.txt"
 
 DEFAULT_PKG_PREFIX = "python3-"
 FREEBSD_PKG_PREFIX = f"py{sys.version_info.major}{sys.version_info.minor}-"
+OPENBSD_PKG_PREFIX = "py3-"
 
 # Map the appropriate package dir needed for each distro choice
 DISTRO_PKG_TYPE_MAP = {
     "centos": "redhat",
     "eurolinux": "redhat",
     "miraclelinux": "redhat",
     "freebsd": "freebsd",
+    "openbsd": "openbsd",
     "fedora": "fedora",
     "rocky": "redhat",
     "redhat": "redhat",
@@ -113,19 +115,22 @@ DRYRUN_DISTRO_INSTALL_PKG_CMD = {
     "redhat": ["yum", "install", "--assumeyes"],
     "fedora": ["yum", "install", "--assumeyes"],
     "freebsd": ["pkg", "install", "--yes"],
+    "openbsd": ["pkg_add", "-n"],
 }
 
 DISTRO_INSTALL_PKG_CMD = {
     "redhat": MAYBE_RELIABLE_YUM_INSTALL,
     "fedora": MAYBE_RELIABLE_YUM_INSTALL,
     "freebsd": ["pkg", "install", "--yes"],
+    "openbsd": ["pkg_add", "-I"],
     "debian": ["apt", "install", "-y"],
     "suse": ZYPPER_INSTALL,
 }
 
 DISTRO_UPDATE_PKG_CMD = {
     "redhat": ["yum", "update"],
     "freebsd": ["pkg", "update"],
+    "openbsd": ["pkg_add", "-I", "-u"],
     "debian": ["apt", "update", "-q"],
     "suse": ["zypper", "update"],
 }
@@ -138,6 +143,7 @@ CI_SYSTEM_BASE_PKGS = {
     "miraclelinux": ["python3-tox"],
     "fedora": ["python3-tox"],
     "freebsd": [f"{FREEBSD_PKG_PREFIX}tox"],
+    "openbsd": [f"{OPENBSD_PKG_PREFIX}tox"],
     "redhat": ["python3-tox"],
     "centos": ["python3-tox"],
     "ubuntu": [
@@ -284,6 +290,8 @@ def translate_pip_to_system_pkg(distro, pip_requires, renames):
     """
     if distro in ("freebsd",):
         prefix = FREEBSD_PKG_PREFIX
+    elif distro in ("openbsd",):
+        prefix = OPENBSD_PKG_PREFIX
     else:
         prefix = DEFAULT_PKG_PREFIX
     standard_pkg_name = "{0}{1}"
@@ -376,7 +384,7 @@ def pkg_install(pkg_list, distro, test_distro=False, dry_run=False):
     """Install a list of packages using the DISTRO_INSTALL_PKG_CMD."""
     if test_distro:
         pkg_list = list(pkg_list) + CI_SYSTEM_BASE_PKGS["common"]
-        if distro not in ("freebsd",):
+        if distro not in ("freebsd", "openbsd"):
             pkg_list += CI_SYSTEM_BASE_PKGS["linux_common"]
         distro_base_pkgs = CI_SYSTEM_BASE_PKGS.get(distro, [])
         pkg_list += distro_base_pkgs