add commit-confirm options to vyos_config (#229)

* added vyos_config confirm options

* fix: update commit comment to match main

* fix: documentation example for automatic confirm

* fix: add tests for commit confirm and confirm_timeout options

* fix: add config_confirm changelog fragment

* fix: lint missing diff parameter for edit_config

* fix: add commit confirm integration test

---------

Co-authored-by: omnom62 <75066712+omnom62@users.noreply.github.com>

3 files changed, 52 insertions, 10 deletions

diff --git a/plugins/cliconf/vyos.py b/plugins/cliconf/vyos.py
index c35ff1ec..17fcdf24 100644
--- a/plugins/cliconf/vyos.py
+++ b/plugins/cliconf/vyos.py
@@ -122,7 +122,9 @@ class Cliconf(CliconfBase):
         out = self.send_command(command)
         return out
 
-    def edit_config(self, candidate=None, commit=True, replace=None, comment=None):
+    def edit_config(
+        self, candidate=None, commit=True, replace=None, diff=False, comment=None, confirm=None
+    ):
         resp = {}
         operations = self.get_device_operations()
         self.check_edit_config_capability(operations, candidate, commit, replace, comment)
@@ -143,7 +145,7 @@ class Cliconf(CliconfBase):
         if diff_config:
             if commit:
                 try:
-                    self.commit(comment)
+                    self.commit(comment, confirm)
                 except AnsibleConnectionFailure as e:
                     msg = "commit failed: %s" % e.message
                     self.discard_changes()
@@ -191,12 +193,19 @@ class Cliconf(CliconfBase):
             check_all=check_all,
         )
 
-    def commit(self, comment=None):
-        if comment:
-            command = 'commit comment "{0}"'.format(comment)
+    def commit(self, comment=None, confirm=None):
+        if confirm:
+            if comment:
+                command = 'commit-confirm {0} comment "{1}"'.format(confirm, comment)
+            else:
+                command = 'commit-confirm {0}'.format(confirm)
+            self.send_command(command, "Proceed?", "\n")
         else:
-            command = "commit"
-        self.send_command(command)
+            if comment:
+                command = 'commit comment "{0}"'.format(comment)
+            else:
+                command = "commit"
+            self.send_command(command)
 
     def discard_changes(self):
         self.send_command("exit discard")
diff --git a/plugins/module_utils/network/vyos/vyos.py b/plugins/module_utils/network/vyos/vyos.py
index 6bd8daee..4987d6b0 100644
--- a/plugins/module_utils/network/vyos/vyos.py
+++ b/plugins/module_utils/network/vyos/vyos.py
@@ -96,11 +96,13 @@ def run_commands(module, commands, check_rc=True):
     return response
 
 
-def load_config(module, commands, commit=False, comment=None):
+def load_config(module, commands, commit=False, comment=None, confirm=None):
     connection = get_connection(module)
 
     try:
-        response = connection.edit_config(candidate=commands, commit=commit, comment=comment)
+        response = connection.edit_config(
+            candidate=commands, commit=commit, comment=comment, confirm=confirm
+        )
     except ConnectionError as exc:
         module.fail_json(msg=to_text(exc, errors="surrogate_then_replace"))
 
diff --git a/plugins/modules/vyos_config.py b/plugins/modules/vyos_config.py
index eeb6bc44..a9774638 100644
--- a/plugins/modules/vyos_config.py
+++ b/plugins/modules/vyos_config.py
@@ -84,6 +84,25 @@ options:
       is ignored.
     default: configured by vyos_config
     type: str
+  confirm:
+    description:
+    - The C(confirm) argument will tell vyos to revert to the previous configuration
+      if not explicitly confirmed after applying the new config. When set to C(automatic)
+      this module will automatically confirm the configuration, if the current session
+      remains working with the new config. When set to C(manual), this module does
+      not issue the confirmation itself.
+    type: str
+    default: none
+    choices:
+    - automatic
+    - manual
+    - none
+  confirm_timeout:
+    description:
+    - Minutes to wait for confirmation before reverting the configuration. Does
+      not apply when C(confirm) is set to C(none) .
+    type: int
+    default: 10
   config:
     description:
     - The C(config) argument specifies the base configuration to use to compare against
@@ -142,6 +161,11 @@ EXAMPLES = """
   vyos.vyos.vyos_config:
     src: vyos_template.j2
 
+- name: revert after ten minutes, if connection is lost
+  vyos.vyos.vyos_config:
+    src: vyos_template.j2
+    confirm: automatic
+
 - name: for idempotency, use full-form commands
   vyos.vyos.vyos_config:
     lines:
@@ -310,10 +334,15 @@ def run(module, result):
 
     commit = not module.check_mode
     comment = module.params["comment"]
+    confirm = None
+    if module.params["confirm"] == "automatic" or module.params["confirm"] == "manual":
+        confirm = module.params["confirm_timeout"]
 
     diff = None
     if commands:
-        diff = load_config(module, commands, commit=commit, comment=comment)
+        diff = load_config(module, commands, commit=commit, comment=comment, confirm=confirm)
+        if module.params["confirm"] == "automatic":
+            run_commands(module, ["configure", "confirm", "exit"])
 
         if result.get("filtered"):
             result["warnings"].append(
@@ -333,6 +362,8 @@ def main():
         lines=dict(type="list", elements="str"),
         match=dict(default="line", choices=["line", "none"]),
         comment=dict(default=DEFAULT_COMMENT),
+        confirm=dict(choices=["automatic", "manual", "none"], default='none'),
+        confirm_timeout=dict(type="int", default=10),
         config=dict(),
         backup=dict(type="bool", default=False),
         backup_options=dict(type="dict", options=backup_spec),