Add 'idempotent' attribute (#337)

* Add 'idempotent' attribute. * Mention check mode in attribute description. Co-authored-by: Alexei Znamensky <[email protected]> --------- Co-authored-by: Alexei Znamensky <[email protected]>
ansible-collections · Dec 30, 2024 · 44e6bb6 · 44e6bb6
1 parent 2a34608
commit 44e6bb6
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 0 deletions.
diff --git a/plugins/doc_fragments/attributes.py b/plugins/doc_fragments/attributes.py
@@ -21,6 +21,20 @@ class ModuleDocFragment(object):
   platform:
     description: Target OS/families that can be operated against.
     support: N/A
+  idempotent:
+    description:
+      - When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.
+      - This assumes that the system controlled/queried by the module has not changed in a relevant way.
+"""
+
+    # Should be used together with the standard fragment
+    IDEMPOTENT_NOT_MODIFY_STATE = r"""
+options: {}
+attributes:
+  idempotent:
+    support: full
+    details:
+      - This action does not modify state.
 """
 
     # Should be used together with the standard fragment

diff --git a/plugins/modules/api.py b/plugins/modules/api.py
@@ -33,6 +33,10 @@
     platforms: RouterOS
   action_group:
     version_added: 2.1.0
+  idempotent:
+    support: N/A
+    details:
+      - Whether the executed command is idempotent depends on the operation performed.
 options:
   path:
     description:

diff --git a/plugins/modules/api_facts.py b/plugins/modules/api_facts.py
@@ -29,6 +29,7 @@
   - community.routeros.attributes.actiongroup_api
   - community.routeros.attributes.facts
   - community.routeros.attributes.facts_module
+  - community.routeros.attributes.idempotent_not_modify_state
 attributes:
   platform:
     support: full

diff --git a/plugins/modules/api_find_and_modify.py b/plugins/modules/api_find_and_modify.py
@@ -35,6 +35,8 @@
   platform:
     support: full
     platforms: RouterOS
+  idempotent:
+    support: full
 options:
   path:
     description:

diff --git a/plugins/modules/api_info.py b/plugins/modules/api_info.py
@@ -28,6 +28,7 @@
   - community.routeros.api.restrict
   - community.routeros.attributes
   - community.routeros.attributes.actiongroup_api
+  - community.routeros.attributes.idempotent_not_modify_state
   - community.routeros.attributes.info_module
 attributes:
   platform:

diff --git a/plugins/modules/api_modify.py b/plugins/modules/api_modify.py
@@ -42,6 +42,8 @@
   platform:
     support: full
     platforms: RouterOS
+  idempotent:
+    support: full
 options:
   path:
     description:

diff --git a/plugins/modules/command.py b/plugins/modules/command.py
@@ -29,6 +29,10 @@
   platform:
     support: full
     platforms: RouterOS
+  idempotent:
+    support: N/A
+    details:
+      - Whether the executed command is idempotent depends on the command.
 options:
   commands:
     description:

diff --git a/plugins/modules/facts.py b/plugins/modules/facts.py
@@ -19,6 +19,7 @@
   - community.routeros.attributes
   - community.routeros.attributes.facts
   - community.routeros.attributes.facts_module
+  - community.routeros.attributes.idempotent_not_modify_state
 attributes:
   platform:
     support: full