jool: T160: Added scripts to build jool package

Added dependencies and build scripts for
https://github.com/NICMx/Jool/

3 files changed, 107 insertions, 0 deletions

diff --git a/docker/Dockerfile b/docker/Dockerfile
index 23efa7d2..a47a1d19 100644
--- a/docker/Dockerfile
+++ b/docker/Dockerfile
@@ -339,6 +339,16 @@ RUN apt-get update && apt-get install -y \
       libssl-dev \
       libpcre3-dev
 
+# debmake: a native Debian tool for preparing sources for packaging
+RUN apt-get update && apt-get install -y \
+      debmake \
+      python3-debian
+
+# Packages for jool
+RUN apt-get update && apt-get install -y \
+      libnl-genl-3-dev \
+      libxtables-dev
+
 # Allow password-less 'sudo' for all users in group 'sudo'
 RUN sed "s/^%sudo.*/%sudo\tALL=(ALL) NOPASSWD:ALL/g" -i /etc/sudoers && \
     echo "vyos_bld\tALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers && \
diff --git a/packages/linux-kernel/Jenkinsfile b/packages/linux-kernel/Jenkinsfile
index b0715e19..e7a156b8 100644
--- a/packages/linux-kernel/Jenkinsfile
+++ b/packages/linux-kernel/Jenkinsfile
@@ -55,6 +55,9 @@ def pkgList = [
 
     // Intel-QAT
     ['name': 'qat', 'buildCmd': 'cd ..; ./build-intel-qat.sh'],
+
+    // Jool
+    ['name': 'jool', 'buildCmd': 'cd ..; ./build-jool.py'],
 ]
 
 // Start package build using library function from https://github.com/vyos/vyos-build
diff --git a/packages/linux-kernel/build-jool.py b/packages/linux-kernel/build-jool.py
new file mode 100755
index 00000000..10802108
--- /dev/null
+++ b/packages/linux-kernel/build-jool.py
@@ -0,0 +1,94 @@
+#!/usr/bin/env python3
+
+from tomllib import loads as toml_loads
+from requests import get
+from pathlib import Path
+from subprocess import run
+
+
+# dependency modifier
+def add_depends(package_dir: str, package_name: str,
+                depends: list[str]) -> None:
+    """Add dependencies to a package
+
+    Args:
+        package_dir (str): a directory where package sources are located
+        package_name (str): a name of package
+        depends (list[str]): a list of dependencies to add
+    """
+    depends_list: str = ', '.join(depends)
+    depends_line: str = f'misc:Depends={depends_list}\n'
+
+    substvars_file = Path(f'{package_dir}/debian/{package_name}.substvars')
+    substvars_file.write_text(depends_line)
+
+
+# find kernel version and source path
+defaults_file: str = Path('../../data/defaults.toml').read_text()
+architecture_file: str = Path('../../data/architectures/amd64.toml').read_text()
+KERNEL_VER: str = toml_loads(defaults_file).get('kernel_version')
+KERNEL_FLAVOR: str = toml_loads(architecture_file).get('kernel_flavor')
+KERNEL_SRC: str = Path.cwd().as_posix() + '/linux'
+
+# define variables
+PACKAGE_NAME: str = 'jool'
+PACKAGE_VERSION: str = '4.1.9+bf4c7e3669'
+PACKAGE_DIR: str = f'{PACKAGE_NAME}-{PACKAGE_VERSION}'
+SOURCES_ARCHIVE: str = 'jool-4.1.9+bf4c7e3669.tar.gz'
+SOURCES_URL: str = f'https://github.com/NICMx/Jool/archive/bf4c7e3669672367934dc50c8b257b7790f0e27e.tar.gz'
+
+# download sources
+sources_archive = Path(SOURCES_ARCHIVE)
+sources_archive.write_bytes(get(SOURCES_URL).content)
+
+# prepare sources
+debmake_cmd: list[str] = [
+    'debmake', '-e', 'support@vyos.io', '-f', 'VyOS Support', '-p',
+    PACKAGE_NAME, '-u', PACKAGE_VERSION, '-a', SOURCES_ARCHIVE
+]
+run(debmake_cmd)
+
+# add kernel to dependencies
+add_depends(PACKAGE_DIR, PACKAGE_NAME,
+            [f'linux-image-{KERNEL_VER}-{KERNEL_FLAVOR}'])
+
+# configure build rules
+build_rules_text: str = f'''#!/usr/bin/make -f
+# config
+export KERNEL_DIR := {KERNEL_SRC}
+PACKAGE_BUILD_DIR := debian/{PACKAGE_NAME}
+KVER := {KERNEL_VER}-{KERNEL_FLAVOR}
+MODULES_DIR := extra
+
+# main packaging script based on dh7 syntax
+%:
+	dh $@  
+
+override_dh_clean:
+	dh_clean --exclude=debian/{PACKAGE_NAME}.substvars
+
+override_dh_prep:
+	dh_prep --exclude=debian/{PACKAGE_NAME}.substvars
+
+# override_dh_auto_clean:
+# 	make -C src/mod clean
+
+override_dh_auto_build:
+	dh_auto_build $@
+	make -C ${{KERNEL_DIR}} M=$$PWD/src/mod/common modules
+	make -C ${{KERNEL_DIR}} M=$$PWD/src/mod/nat64 modules
+	make -C ${{KERNEL_DIR}} M=$$PWD/src/mod/siit modules
+
+override_dh_auto_install:
+	dh_auto_install $@
+	install -D -m 644 src/mod/common/jool_common.ko ${{PACKAGE_BUILD_DIR}}/lib/modules/${{KVER}}/${{MODULES_DIR}}/jool_common.ko
+	install -D -m 644 src/mod/nat64/jool.ko ${{PACKAGE_BUILD_DIR}}/lib/modules/${{KVER}}/${{MODULES_DIR}}/jool.ko
+	install -D -m 644 src/mod/siit/jool_siit.ko ${{PACKAGE_BUILD_DIR}}/lib/modules/${{KVER}}/${{MODULES_DIR}}/jool_siit.ko
+
+'''
+bild_rules = Path(f'{PACKAGE_DIR}/debian/rules')
+bild_rules.write_text(build_rules_text)
+
+# build a package
+debuild_cmd: list[str] = ['debuild']
+run(debuild_cmd, cwd=PACKAGE_DIR)