Merge pull request #5096 from jestabro/extend-activation-system

T8445: T8335: Extend config activation system

8 files changed, 352 insertions, 28 deletions

diff --git a/src/activation-scripts/00-first-installed-boot.py b/src/activation-scripts/00-first-installed-boot.py
new file mode 100644
index 000000000..ca02c2642
--- /dev/null
+++ b/src/activation-scripts/00-first-installed-boot.py
@@ -0,0 +1,35 @@
+# Copyright (C) VyOS Inc.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library.  If not, see <http://www.gnu.org/licenses/>.
+
+
+from vyos.configtree import ConfigTree
+from vyos.system.image import is_live_boot
+from vyos.utils.activate import set_activation
+from vyos.utils.activate import set_first_installed_boot
+from vyos.utils.activate import is_first_installed_boot
+
+
+def pre_condition() -> bool:
+    return not is_live_boot()
+
+
+def activate(_config: ConfigTree) -> None:
+    pass
+
+
+def post_condition() -> None:
+    set_first_installed_boot()
+    if is_first_installed_boot():
+        set_activation(__file__, 'never')
diff --git a/src/activation-scripts/01-set-config-path-hint.py b/src/activation-scripts/01-set-config-path-hint.py
new file mode 100644
index 000000000..3146a7905
--- /dev/null
+++ b/src/activation-scripts/01-set-config-path-hint.py
@@ -0,0 +1,35 @@
+# Copyright (C) VyOS Inc.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library.  If not, see <http://www.gnu.org/licenses/>.
+
+
+from vyos.configtree import ConfigTree
+from vyos.system.image import is_live_boot
+from vyos.utils.activate import set_activation
+from vyos.utils.activate import set_config_path_hint
+from vyos.utils.activate import is_first_installed_boot
+
+
+def pre_condition() -> bool:
+    return not is_live_boot()
+
+
+def activate(_config: ConfigTree) -> None:
+    pass
+
+
+def post_condition() -> None:
+    if is_first_installed_boot():
+        set_config_path_hint()
+        set_activation(__file__, 'never')
diff --git a/src/activation-scripts/20-ethernet_offload.py b/src/activation-scripts/20-ethernet-offload.py
index bc1e9f202..9f61f6d8f 100755..100644
--- a/src/activation-scripts/20-ethernet_offload.py
+++ b/src/activation-scripts/20-ethernet-offload.py
@@ -22,9 +22,12 @@
 
 from vyos.ethtool import Ethtool
 from vyos.configtree import ConfigTree
-from vyos.system.image import is_live_boot
+from vyos.utils.activate import set_activation
+from vyos.utils.activate import is_first_installed_boot
+
 
 def activate(config: ConfigTree):
+    # pylint: disable=too-many-branches
     base = ['interfaces', 'ethernet']
 
     if not config.exists(base):
@@ -39,7 +42,7 @@ def activate(config: ConfigTree):
         enabled, fixed = eth.get_generic_receive_offload()
         if configured and fixed:
             config.delete(base + [ifname, 'offload', 'gro'])
-        elif is_live_boot() and enabled and not fixed:
+        elif enabled and not fixed:
             config.set(base + [ifname, 'offload', 'gro'])
 
         # If GSO is enabled by the Kernel - we reflect this on the CLI. If GSO is
@@ -48,7 +51,7 @@ def activate(config: ConfigTree):
         enabled, fixed = eth.get_generic_segmentation_offload()
         if configured and fixed:
             config.delete(base + [ifname, 'offload', 'gso'])
-        elif is_live_boot() and enabled and not fixed:
+        elif enabled and not fixed:
             config.set(base + [ifname, 'offload', 'gso'])
 
         # If LRO is enabled by the Kernel - we reflect this on the CLI. If LRO is
@@ -57,7 +60,7 @@ def activate(config: ConfigTree):
         enabled, fixed = eth.get_large_receive_offload()
         if configured and fixed:
             config.delete(base + [ifname, 'offload', 'lro'])
-        elif is_live_boot() and enabled and not fixed:
+        elif enabled and not fixed:
             config.set(base + [ifname, 'offload', 'lro'])
 
         # If SG is enabled by the Kernel - we reflect this on the CLI. If SG is
@@ -66,7 +69,7 @@ def activate(config: ConfigTree):
         enabled, fixed = eth.get_scatter_gather()
         if configured and fixed:
             config.delete(base + [ifname, 'offload', 'sg'])
-        elif is_live_boot() and enabled and not fixed:
+        elif enabled and not fixed:
             config.set(base + [ifname, 'offload', 'sg'])
 
         # If TSO is enabled by the Kernel - we reflect this on the CLI. If TSO is
@@ -75,7 +78,7 @@ def activate(config: ConfigTree):
         enabled, fixed = eth.get_tcp_segmentation_offload()
         if configured and fixed:
             config.delete(base + [ifname, 'offload', 'tso'])
-        elif is_live_boot() and enabled and not fixed:
+        elif enabled and not fixed:
             config.set(base + [ifname, 'offload', 'tso'])
 
         # Remove deprecated UDP fragmentation offloading option
@@ -104,3 +107,8 @@ def activate(config: ConfigTree):
         if config.exists(flow_control_path):
             if not eth.check_flow_control():
                 config.delete(flow_control_path)
+
+
+def post_condition() -> None:
+    if is_first_installed_boot():
+        set_activation(__file__, 'off')
diff --git a/src/activation-scripts/example.py b/src/activation-scripts/example.py
new file mode 100644
index 000000000..74beedf80
--- /dev/null
+++ b/src/activation-scripts/example.py
@@ -0,0 +1,42 @@
+# Copyright VyOS maintainers and contributors <maintainers@vyos.io>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library.  If not, see <http://www.gnu.org/licenses/>.
+
+
+from vyos.configtree import ConfigTree
+
+
+# pylint: disable=anomalous-backslash-in-string,pointless-string-statement
+"""Activation scripts must be named '^\\d+\\-.+.py$' to be included by the
+activation script runner. They are run in ascending order of prefix."""
+
+
+def pre_condition() -> bool:
+    """This function is not required.
+    If not present, or pre_condition returns True, the function activate
+    will be called on the config."""
+
+
+def activate(_config: ConfigTree) -> None:
+    """This function is expected.
+    If not present, the script is ignored. The function itself can be a
+    no-op."""
+
+
+def post_condition() -> None:
+    """This function is not required.
+    If present, and application of 'activate' succeeds, post_condition will
+    be called.
+    Commonly used to set activation 'off' for the script, after first run on
+    an installed system."""
diff --git a/src/helpers/run-config-activation.py b/src/helpers/run-config-activation.py
index f20adff1e..7e7a6571e 100755
--- a/src/helpers/run-config-activation.py
+++ b/src/helpers/run-config-activation.py
@@ -14,20 +14,33 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-import re
+
+import sys
 import logging
+
 from pathlib import Path
 from argparse import ArgumentParser
 
 from vyos.compose_config import ComposeConfig
 from vyos.compose_config import ComposeConfigError
+from vyos.utils.activate import refresh_activation_list
+from vyos.utils.activate import get_activation_scripts
+from vyos.utils.activate import get_activation
+from vyos.utils.activate import set_activation
+from vyos.utils.activate import is_active
+from vyos.utils.system import load_as_module
+from vyos.utils.func import FalseCallable
 from vyos.defaults import directories
+from vyos.defaults import activation_list
+
 
 parser = ArgumentParser()
-parser.add_argument('config_file', type=str,
-                    help="configuration file to modify with system-specific settings")
-parser.add_argument('--test-script', type=str,
-                    help="test effect of named script")
+parser.add_argument(
+    'config_file',
+    type=str,
+    help='configuration file to modify with system-specific settings',
+)
+parser.add_argument('--test-script', type=str, help='test effect of named script')
 
 args = parser.parse_args()
 
@@ -40,6 +53,7 @@ formatter = logging.Formatter('%(message)s')
 fh.setFormatter(formatter)
 logger.addHandler(fh)
 
+
 if 'vyos-activate-debug' in Path('/proc/cmdline').read_text():
     print(f'\nactivate-debug enabled: file {checkpoint_file}_* on error')
     debug = checkpoint_file
@@ -48,36 +62,67 @@ else:
     debug = None
     logger.setLevel(logging.INFO)
 
-def sort_key(s: Path):
-    s = s.stem
-    pre, rem = re.match(r'(\d*)(?:-)?(.+)', s).groups()
-    return int(pre or 0), rem
 
 def file_ext(file_name: str) -> str:
-    """Return an identifier from file name for checkpoint file extension.
-    """
+    """Return an identifier from file name for checkpoint file extension."""
     return Path(file_name).stem
 
+
+refresh_activation_list()
+
+if not Path(activation_list).exists():
+    logger.error('Missing config activation list!')
+    sys.exit(1)
+
 script_dir = Path(directories['activate'])
 
 if args.test_script:
-    script_list = [script_dir.joinpath(args.test_script)]
+    script_list = [script_dir.joinpath(args.test_script).stem]
 else:
-    script_list = sorted(script_dir.glob('*.py'), key=sort_key)
+    script_list = list(get_activation_scripts())
 
 config_file = args.config_file
 config_str = Path(config_file).read_text()
 
 compose = ComposeConfig(config_str, checkpoint_file=debug)
 
+false_call = FalseCallable()
+
+update_config = False
 for file in script_list:
-    file = file.as_posix()
+    if not is_active(file):
+        continue
+
     logger.info(f'calling {file}')
-    try:
-        compose.apply_file(file, func_name='activate')
-    except ComposeConfigError as e:
-        if debug:
-            compose.write(f'{compose.checkpoint_file}_{file_ext(file)}')
-        logger.error(f'config-activation error in {file}: {e}')
-
-compose.write(config_file, with_version=True)
+
+    mod_name = Path(file).stem.replace('-', '_')
+    mod = load_as_module(mod_name, script_dir.joinpath(f'{file}.py').as_posix())
+
+    pre_condition = getattr(mod, 'pre_condition', false_call)
+    post_condition = getattr(mod, 'post_condition', false_call)
+    activate = getattr(mod, 'activate', false_call)
+
+    if not activate:
+        logger.error(f'missing activate function in {file}')
+        continue
+
+    if not pre_condition or pre_condition():
+        try:
+            compose.apply_func(activate)
+        except ComposeConfigError as e:
+            if debug:
+                compose.write(f'{compose.checkpoint_file}_{file_ext(file)}')
+            logger.error(f'config-activation error in {file}: {e}')
+            update_config = False
+            break
+
+        if post_condition:
+            post_condition()
+
+        if get_activation(file) == 'once':
+            set_activation(file, 'off')
+
+        update_config = True
+
+if update_config:
+    compose.write(config_file, with_version=True)
diff --git a/src/init/vyos-router b/src/init/vyos-router
index 600892c93..982126637 100755
--- a/src/init/vyos-router
+++ b/src/init/vyos-router
@@ -199,7 +199,12 @@ system_activate ()
     if [ -x $vyos_libexec_dir/run-config-activation.py ]; then
         log_progress_msg activate
         sg ${GROUP} -c "$vyos_libexec_dir/run-config-activation.py $BOOTFILE"
+        STATUS=$?
+        if [[ "$STATUS" != "0" ]]; then
+            return 1
+        fi
     fi
+    return 0
 }
 
 # load the initial config
diff --git a/src/op_mode/activation.py b/src/op_mode/activation.py
new file mode 100644
index 000000000..16192f3eb
--- /dev/null
+++ b/src/op_mode/activation.py
@@ -0,0 +1,144 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) VyOS Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+import sys
+import re
+import typing
+import tabulate
+
+import vyos.opmode
+from vyos.utils.activate import get_activation_scripts
+from vyos.utils.activate import set_activation as util_activate
+from vyos.utils.activate import get_activation
+from vyos.utils.activate import ActiveOpt
+from vyos.utils.io import ask_yes_no
+from vyos.base import Warning as Warn
+
+
+def _get_raw_data() -> dict:
+    return get_activation_scripts()
+
+
+def _split_name(name: str) -> tuple[str, str]:
+    # script names are guaranteed to have this format by construction:
+    # cf. scripts/generate-activation-scripts-json.py
+    match = re.match(r'(\d+)\-(.+)', name)
+    if match is None:
+        return '0', '_'
+    prio, base_name = match.groups()
+    return prio, base_name
+
+
+def _find_full_name(name: str) -> typing.Optional[str]:
+    script_names = list(_get_raw_data())
+    result = list(filter(lambda s: s.endswith(name), script_names))
+
+    return result[0] if result else None
+
+
+def show_list(raw: bool) -> typing.Optional[list]:
+    scripts = _get_raw_data()
+    data = []
+    for key in scripts.keys():
+        _, name = _split_name(key)
+        data.append(name)
+
+    if raw:
+        return data
+
+    print(*data)
+    return None
+
+
+def show_opts(raw: bool) -> typing.Optional[list]:
+    opts = list(typing.get_args(ActiveOpt))
+
+    if raw:
+        return opts
+
+    print(*opts)
+    return None
+
+
+def _format_scripts(scripts: dict):
+    headers = ['name', 'activate on reboot', 'priority']
+    data = []
+    for key in scripts.keys():
+        prio, name = _split_name(key)
+        value = scripts[key]
+        data.append([name, value, prio])
+
+    print('Activation units:')
+    print(tabulate.tabulate(data, headers))
+
+
+def show(raw: bool):
+    activation_dict = _get_raw_data()
+    if raw:
+        return activation_dict
+    return _format_scripts(activation_dict)
+
+
+def set_active(name: str, value: ActiveOpt, no_prompt: bool = False):
+    PROMPT_ENABLED = f'This will set {name} active on subsequent reboots. Proceed ?'
+    PROMPT_ONCE = f'This will set {name} active only for the next reboot. Proceed ?'
+    PROMPT_OFF = f'This will set {name} inactive. Proceed ?'
+    UNCHANGED = f'{name} is already set to {value}'
+    UNKNOWN = 'None such'
+
+    full_name = _find_full_name(name)
+    if not full_name:
+        Warn(f'No activation unit {name}')
+        return
+
+    state = get_activation(full_name)
+
+    if state == 'never':
+        Warn(f'{name} has been set to \'never\' and should not be reset')
+        return
+
+    if value == state:
+        print(UNCHANGED)
+        return
+
+    if value not in list(typing.get_args(ActiveOpt)):
+        Warn(f'No such value {value}')
+        return
+
+    match value:
+        case 'enabled':
+            message = PROMPT_ENABLED
+        case 'once':
+            message = PROMPT_ONCE
+        case 'off':
+            message = PROMPT_OFF
+        case _:
+            # not reached
+            message = UNKNOWN
+
+    if no_prompt or ask_yes_no(message, default=True):
+        util_activate(full_name, value)
+
+
+if __name__ == '__main__':
+    try:
+        res = vyos.opmode.run(sys.modules[__name__])
+        if res:
+            print(res)
+    except (ValueError, vyos.opmode.Error) as e:
+        print(e)
+        sys.exit(1)
diff --git a/src/op_mode/image_installer.py b/src/op_mode/image_installer.py
index 27d8214c3..07f69ccd5 100755
--- a/src/op_mode/image_installer.py
+++ b/src/op_mode/image_installer.py
@@ -46,6 +46,7 @@ from vyos.configtree import ConfigTree
 from vyos.config_mgmt import unsaved_commits
 from vyos.defaults import base_dir
 from vyos.defaults import directories
+from vyos.defaults import activation_hint
 from vyos.flavor import get_image_serial_console
 from vyos.remote import download
 from vyos.system import disk
@@ -133,6 +134,7 @@ CONST_RESERVED_SPACE: int = (2 + 1 + 256) * 1024**2
 
 # define directories and paths
 DIR_CONFIG: str = directories['config']
+DIR_DATA: str = directories['data']
 DIR_INSTALLATION: str = '/mnt/installation'
 DIR_ROOTFS_SRC: str = f'{DIR_INSTALLATION}/root_src'
 DIR_ROOTFS_DST: str = f'{DIR_INSTALLATION}/root_dst'
@@ -1041,6 +1043,14 @@ def install_image() -> None:
             write_dir: str = f'{DIR_DST_ROOT}/boot/{image_name}/rw'
             raid.update_default(write_dir)
 
+        # set activation hint
+        target_data_dir: str = f'{DIR_DST_ROOT}/boot/{image_name}/rw{DIR_DATA}/'
+        data_path = Path(target_data_dir)
+        data_path.mkdir(parents=True)
+        data_path.chmod(0o755)
+        init_hint = data_path.joinpath(Path(activation_hint).name)
+        init_hint.touch()
+
         setup_grub(DIR_DST_ROOT)
         # add information about version
         grub.create_structure()