Merge pull request #4526 from jestabro/config-mgmt-context

T7365: add commit hooks and cli integration

3 files changed, 37 insertions, 1 deletions

diff --git a/python/vyos/defaults.py b/python/vyos/defaults.py
index b57dcac89..f84b14040 100644
--- a/python/vyos/defaults.py
+++ b/python/vyos/defaults.py
@@ -84,3 +84,7 @@ rt_global_table = rt_symbolic_names['main']
 vyconfd_conf = '/etc/vyos/vyconfd.conf'
 
 DEFAULT_COMMIT_CONFIRM_MINUTES = 10
+
+commit_hooks = {'pre': '/etc/commit/pre-hooks.d',
+                'post': '/etc/commit/post-hooks.d'
+               }
diff --git a/python/vyos/utils/commit.py b/python/vyos/utils/commit.py
index 9167c78d2..fc259dadb 100644
--- a/python/vyos/utils/commit.py
+++ b/python/vyos/utils/commit.py
@@ -101,3 +101,30 @@ def release_commit_lock_file(file_descr):
         return
     fcntl.lockf(file_descr, fcntl.LOCK_UN)
     file_descr.close()
+
+
+def call_commit_hooks(which: str):
+    import re
+    import os
+    from pathlib import Path
+    from vyos.defaults import commit_hooks
+    from vyos.utils.process import rc_cmd
+
+    if which not in list(commit_hooks):
+        raise ValueError(f'no entry {which} in commit_hooks')
+
+    hook_dir = commit_hooks[which]
+    file_list = list(Path(hook_dir).glob('*'))
+    regex = re.compile('^[a-zA-Z0-9._-]+$')
+    hook_list = sorted([str(f) for f in file_list if regex.match(f.name)])
+    err = False
+    out = ''
+    for runf in hook_list:
+        try:
+            e, o = rc_cmd(runf)
+        except FileNotFoundError:
+            continue
+        err = err | bool(e)
+        out = out + o
+
+    return out, int(err)
diff --git a/python/vyos/vyconf_session.py b/python/vyos/vyconf_session.py
index 4250f0cfb..3cf847b6c 100644
--- a/python/vyos/vyconf_session.py
+++ b/python/vyos/vyconf_session.py
@@ -29,6 +29,7 @@ from vyos.utils.session import in_config_session
 from vyos.proto.vyconf_proto import Errnum
 from vyos.utils.commit import acquire_commit_lock_file
 from vyos.utils.commit import release_commit_lock_file
+from vyos.utils.commit import call_commit_hooks
 
 
 class VyconfSessionError(Exception):
@@ -145,10 +146,14 @@ class VyconfSession:
         if lock_fd is None:
             return out, Errnum.COMMIT_IN_PROGRESS
 
+        pre_out, _ = call_commit_hooks('pre')
         out = vyconf_client.send_request('commit', token=self.__token)
+        os.environ['COMMIT_STATUS'] = 'FAILURE' if out.status else 'SUCCESS'
+        post_out, _ = call_commit_hooks('post')
+
         release_commit_lock_file(lock_fd)
 
-        return self.output(out), out.status
+        return pre_out + self.output(out) + post_out, out.status
 
     @raise_exception
     @config_mode