[PR #6602/59db302d backport][stable-7] VarDict module utils: add as_dict() method (#6610)

VarDict module utils: add `as_dict()` method (#6602)

* VarDict module utils: add `as_dict()` method

* add changelog frag

(cherry picked from commit 59db302deb)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

changelogs/fragments/6602-vardict-as-dict.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - VarDict module utils - add method ``VarDict.as_dict()`` to convert to a plain ``dict`` object (https://github.com/ansible-collections/community.general/pull/6602).

plugins/module_utils/vardict.py

@@ -173,3 +173,6 @@ class VarDict(object):
     @property
     def has_changed(self):
         return any(True for var in self.__vars__.values() if var.has_changed)
+
+    def as_dict(self):
+        return dict((name, var.value) for name, var in self.__vars__.items())

tests/unit/plugins/module_utils/test_vardict.py

@@ -122,3 +122,12 @@ def test_vardict_change():
     assert vd.has_changed is False
     vd.xx = 12345
     assert vd.has_changed is True
+
+
+def test_vardict_dict():
+    vd = VarDict()
+    vd.set("xx", 123)
+    vd.set("yy", 456)
+    vd.set("zz", 789)
+
+    assert vd.as_dict() == {"xx": 123, "yy": 456, "zz": 789}