Skip to content

Commit

Permalink
confd: refactor yang modules setup script for better modularity and m…
Browse files Browse the repository at this point in the history
…aintainability

- Moved setup.sh and yang_modules files from infix/src/confd/scripts/ to infix/utils/ to streamline the repository structure
- Updated confd.mk to correctly reference the new location of the setup script
- Introduced yang_modules_<type>.inc file to list all YANG modules for improved clarity and maintainability
- Modified the new setup script to dynamically source module lists from yang_modules_<type>.inc
  • Loading branch information
axkar authored and mattiaswal committed Jun 18, 2024
1 parent 8baca7d commit 7d9257f
Show file tree
Hide file tree
Showing 4 changed files with 214 additions and 10 deletions.
35 changes: 25 additions & 10 deletions package/confd/confd.mk
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
#
################################################################################


CONFD_VERSION = 1.0
CONFD_SITE_METHOD = local
CONFD_SITE = $(BR2_EXTERNAL_INFIX_PATH)/src/confd
Expand All @@ -17,13 +16,13 @@ CONFD_AUTORECONF = YES
CONFD_SYSREPO_SHM_PREFIX = sr_buildroot$(subst /,_,$(CONFIG_DIR))_confd

define CONFD_CONF_ENV
CFLAGS="$(INFIX_CFLAGS)"
CFLAGS="$(INFIX_CFLAGS)"
endef

ifeq ($(BR2_PACKAGE_PODMAN),y)
CONFD_CONF_OPTS += --enable-containers
CONFD_CONF_OPTS += --enable-containers
else
CONFD_CONF_OPTS += --disable-containers
CONFD_CONF_OPTS += --disable-containers
endif

define CONFD_INSTALL_EXTRA
Expand All @@ -33,24 +32,40 @@ define CONFD_INSTALL_EXTRA
mkdir -p $(TARGET_DIR)/etc/avahi/services
cp $(CONFD_PKGDIR)/avahi.service $(TARGET_DIR)/etc/avahi/services/netconf.service
endef
define CONFD_INSTALL_YANG_MODULES
USE_CONTAINERS=$(BR2_PACKAGE_PODMAN) \

COMMON_SYSREPO_ENV = \
SYSREPO_SHM_PREFIX=$(CONFD_SYSREPO_SHM_PREFIX) \
SYSREPOCTL_EXECUTABLE="$(HOST_DIR)/bin/sysrepoctl" \
SYSREPOCFG_EXECUTABLE="$(HOST_DIR)/bin/sysrepocfg" \
SEARCH_PATH="$(TARGET_DIR)/usr/share/yang/modules/confd/" \
$(@D)/scripts/setup.sh
SEARCH_PATH="$(TARGET_DIR)/usr/share/yang/modules/confd/"

define CONFD_INSTALL_YANG_MODULES
$(COMMON_SYSREPO_ENV) \
$(BR2_EXTERNAL_INFIX_PATH)/utils/yang_modules_setup.sh $(CONFD_PKGDIR)/yang_modules_confd.inc
endef

ifeq ($(BR2_PACKAGE_PODMAN),y)
define CONFD_INSTALL_YANG_MODULES_CONTAINERS
$(COMMON_SYSREPO_ENV) \
$(BR2_EXTERNAL_INFIX_PATH)/utils/yang_modules_setup.sh $(CONFD_PKGDIR)/yang_modules_containers.inc
endef
endif

define CONFD_PERMISSIONS
/etc/sysrepo/data/ r 660 root wheel - - - - -
/etc/sysrepo/data d 770 root wheel - - - - -
/etc/sysrepo/data/ r 660 root wheel - - - - -
/etc/sysrepo/data d 770 root wheel - - - - -
endef

define CONFD_CLEANUP
rm -f /dev/shm/$(CONFD_SYSREPO_SHM_PREFIX)*
endef

CONFD_PRE_INSTALL_TARGET_HOOKS += CONFD_CLEANUP
CONFD_POST_INSTALL_TARGET_HOOKS += CONFD_INSTALL_EXTRA
CONFD_POST_INSTALL_TARGET_HOOKS += CONFD_INSTALL_YANG_MODULES
ifeq ($(BR2_PACKAGE_PODMAN),y)
CONFD_POST_INSTALL_TARGET_HOOKS += CONFD_INSTALL_YANG_MODULES_CONTAINERS
endif
CONFD_POST_INSTALL_TARGET_HOOKS += CONFD_CLEANUP

$(eval $(autotools-package))
47 changes: 47 additions & 0 deletions package/confd/yang_modules_confd.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
MODULES=(
"[email protected] -e authentication -e local-users -e ntp -e ntp-udp-port -e timezone-name"
"[email protected]"
"[email protected]"
"[email protected] -e keepalives-supported"
"[email protected] -e if-mib"
"[email protected] -e ipv6-privacy-autoconf"
"[email protected]"
"[email protected]"
"[email protected] -e origin -e with-defaults"
"[email protected] -e encode-xml -e replay -e subtree -e xpath"
"[email protected] -e on-change"
"[email protected]"
"[email protected]"
"[email protected]"
"[email protected] -e bfd -e explicit-router-id"
"[email protected]"
"[email protected]"
"[email protected] -e hardware-state"
"[email protected]"
"[email protected]"
"[email protected]"
"[email protected]"
"[email protected]"
"[email protected]"
"[email protected]"
"[email protected]"
"[email protected]"
"[email protected]"
"[email protected]"
"[email protected]"
"[email protected]"
"[email protected]"
# from sysrepo
"[email protected]"
# from netopeer
"[email protected]"
"[email protected] -e encrypted-private-keys"
"[email protected] -e ssh-listen -e tls-listen -e ssh-call-home -e tls-call-home"
"[email protected]"
"[email protected] -e writable-running -e candidate -e rollback-on-error -e validate -e startup -e url -e xpath -e confirmed-commit"
"[email protected] -e central-truststore-supported -e certificates"
"[email protected] -e central-keystore-supported -e inline-definitions-supported -e asymmetric-keys -e symmetric-keys"
"[email protected] -e local-user-auth-password -e local-user-auth-publickey"
"[email protected] -e server-ident-raw-public-key -e server-ident-x509-cert"
"[email protected]"
)
4 changes: 4 additions & 0 deletions package/confd/yang_modules_containers.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
MODULES=(
"[email protected] -e vlan-filtering -e containers"
"[email protected]"
)
138 changes: 138 additions & 0 deletions utils/yang_modules_setup.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
#!/usr/bin/env bash
set -x
# This is based on scripts/setup.sh from Netopeer2/libnetconf2
# env variables NP2_MODULE_DIR, NP2_MODULE_PERMS must be defined and NP2_MODULE_OWNER, NP2_MODULE_GROUP will be used if
# defined when executing this script!
#if [ -z "$NP2_MODULE_DIR" -o -z "$NP2_MODULE_PERMS" ]; then
# echo "Required environment variables not defined!"
# exit 1
#fi


# Source the provided file, which is expected to contain the list of YANG modules and their features.
# This file, specified by the first argument to the script ($1), is sourced to populate the MODULES
# array with the modules and their respective features to be processed by this script.
# The file typically includes definitions in the form of module@revision with optional features to enable,
# e.g., module@revision -e feature1 -e feature2.
source $1

# optional env variable override
if [ -n "$SYSREPOCTL_EXECUTABLE" ]; then
SYSREPOCTL="$SYSREPOCTL_EXECUTABLE"
# avoid problems with sudo PATH
elif [ `id -u` -eq 0 ] && [ -n "$USER" ] && [ `command -v su` ]; then
SYSREPOCTL=`command -v sysrepoctl -l $USER`
else
SYSREPOCTL=`command -v sysrepoctl`
fi

MODDIR=${SEARCH_PATH}
PERMS="660"
#OWNER=root
#GROUP=wheel

CMD_INSTALL=

# functions
INSTALL_MODULE_CMD() {
if [ -z "${CMD_INSTALL}" ]; then
CMD_INSTALL="'$SYSREPOCTL' -s $MODDIR -v2"
fi
CMD_INSTALL="$CMD_INSTALL -i $MODDIR/$1 -p '$PERMS'"
if [ ! -z "${OWNER}" ]; then
CMD_INSTALL="$CMD_INSTALL -o '$OWNER'"
fi
if [ ! -z "${GROUP}" ]; then
CMD_INSTALL="$CMD_INSTALL -g '$GROUP'"
fi
}

UPDATE_MODULE() {
CMD="'$SYSREPOCTL' -U $MODDIR/$1 -s '$MODDIR -v2"
eval $CMD
local rc=$?
if [ $rc -ne 0 ]; then
exit $rc
fi
}

CHANGE_PERMS() {
CMD="'$SYSREPOCTL' -c $1 -p '$PERMS' -v2"
if [ ! -z "${OWNER}" ]; then
CMD="$CMD -o '$OWNER'"
fi
if [ ! -z "${GROUP}" ]; then
CMD="$CMD -g '$GROUP'"
fi
eval $CMD
local rc=$?
if [ $rc -ne 0 ]; then
exit $rc
fi
}

ENABLE_FEATURE() {
"$SYSREPOCTL" -c $1 -e $2 -v2
local rc=$?
if [ $rc -ne 0 ]; then
exit $rc
fi
}

# get current modules
SCTL_MODULES=`$SYSREPOCTL -l`
for i in "${MODULES[@]}"; do
name=`echo "$i" | sed 's/\([^@]*\).*/\1/'`

SCTL_MODULE=`echo "$SCTL_MODULES" | grep "^$name \+|[^|]*| I"`
if [ -z "$SCTL_MODULE" ]; then
# prepare command to install module with all its features
INSTALL_MODULE_CMD "$i"
continue
fi

sctl_revision=`echo "$SCTL_MODULE" | sed 's/[^|]*| \([^ ]*\).*/\1/'`
revision=`echo "$i" | sed 's/[^@]*@\([^\.]*\).*/\1/'`
if [ "$sctl_revision" \< "$revision" ]; then
# update module without any features
file=`echo "$i" | cut -d' ' -f 1`
UPDATE_MODULE "$file"
fi

sctl_owner=`echo "$SCTL_MODULE" | sed 's/\([^|]*|\)\{3\} \([^:]*\).*/\2/'`
sctl_group=`echo "$SCTL_MODULE" | sed 's/\([^|]*|\)\{3\}[^:]*:\([^ ]*\).*/\2/'`
sctl_perms=`echo "$SCTL_MODULE" | sed 's/\([^|]*|\)\{4\} \([^ ]*\).*/\2/'`
if [ "$sctl_perms" != "$PERMS" ]; then
# change permissions/owner
CHANGE_PERMS "$name"
fi

# parse sysrepoctl features and add extra space at the end for easier matching
sctl_features="`echo "$SCTL_MODULE" | sed 's/\([^|]*|\)\{6\}\(.*\)/\2/'` "
# parse features we want to enable
features=`echo "$i" | sed 's/[^ ]* \(.*\)/\1/'`
while [ "${features:0:3}" = "-e " ]; do
# skip "-e "
features=${features:3}
# parse feature
feature=`echo "$features" | sed 's/\([^[:space:]]*\).*/\1/'`

# enable feature if not already
sctl_feature=`echo "$sctl_features" | grep " ${feature} "`
if [ -z "$sctl_feature" ]; then
# enable feature
ENABLE_FEATURE $name $feature
fi

# next iteration, skip this feature
features=`echo "$features" | sed 's/[^[:space:]]* \(.*\)/\1/'`
done
done
# install all the new modules
if [ ! -z "${CMD_INSTALL}" ]; then
eval $CMD_INSTALL
rc=$?
if [ $rc -ne 0 ]; then
exit $rc
fi
fi

0 comments on commit 7d9257f

Please sign in to comment.