fixing version numbers in modules

mikemorency · Aug 15, 2024 · 37c49a6 · 37c49a6
1 parent 8e5dabc
commit 37c49a6
Show file tree

Hide file tree

Showing 135 changed files with 270 additions and 245 deletions.
diff --git a/config/copy_old_return_blocks.py b/config/copy_old_return_blocks.py
@@ -1,10 +1,12 @@
 #!/usr/bin/env python
 import os
+import yaml
 
 
 SCRIPT_DIR = os.path.dirname(os.path.realpath(__file__))
-OLD_MODULE_PATH = f"{SCRIPT_DIR}/../plugins/modules"
+OLD_MODULE_PATH = f"{SCRIPT_DIR}/../../temp/vmware.vmware_rest/plugins/modules"
 NEW_MODULE_PATH = f"{SCRIPT_DIR}/output/plugins/modules"
+GALAXY_PATH = f"{SCRIPT_DIR}/../galaxy.yml"
 
 
 def read_examples_and_return_blocks(module_file_path):
@@ -26,38 +28,63 @@ def read_examples_and_return_blocks(module_file_path):
     return content
 
 
-def inject_examples_and_return_blocks(module_file_path, inject_lines):
+def read_version_added(old_module_file_path):
+    with open(old_module_file_path, "r") as f:
+        lines = f.readlines()
+
+    for line in lines:
+        if line.startswith('version_added:'):
+            return line
+
+    return None
+
+
+def format_new_content(module_file_path, example_and_return_blocks, version_added):
     with open(module_file_path, "r") as f:
         lines = f.readlines()
 
+    with open(GALAXY_PATH, "r") as f:
+        _galaxy_contents = yaml.safe_load(f)
+        default_version = _galaxy_contents['version']
+
     new_content = []
     added_content = False
     open_block = False
     for line in lines:
-        if line.startswith('EXAMPLES = r"""') or line.startswith('RETURN = r"""'):
+        if example_and_return_blocks and (line.startswith('EXAMPLES = r"""') or line.startswith('RETURN = r"""')):
             open_block = True
             if not added_content:
-                new_content += inject_lines
+                new_content += example_and_return_blocks
                 added_content = True
             continue
 
         if open_block and line.startswith('"""'):
             open_block = False
             continue
 
+        if line.startswith('version_added'):
+            if version_added:
+                new_content += [version_added]
+            else:
+                new_content += [f'version_added: {default_version}\n']
+            continue
+
         new_content += [line]
 
     return new_content
 
 
 if __name__ == "__main__":
-    for module in os.listdir(OLD_MODULE_PATH):
+    for module in os.listdir(NEW_MODULE_PATH):
         old_module = os.path.join(OLD_MODULE_PATH, module)
-        new_module = old_module.replace(OLD_MODULE_PATH, NEW_MODULE_PATH)
+        new_module = os.path.join(NEW_MODULE_PATH, module)
+        blocks = []
+        version_added = None
         if os.path.isfile(old_module):
             blocks = read_examples_and_return_blocks(old_module)
-            new_content = inject_examples_and_return_blocks(new_module, blocks)
+            version_added = read_version_added(old_module)
 
-            with open(new_module, "w") as f:
-                for line in new_content:
-                    f.write(f"{line}")
+        new_content = format_new_content(new_module, blocks, version_added)
+        with open(new_module, "w") as f:
+            for line in new_content:
+                f.write(f"{line}")
diff --git a/plugins/modules/appliance_access_consolecli.py b/plugins/modules/appliance_access_consolecli.py
@@ -70,7 +70,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_access_consolecli_info.py b/plugins/modules/appliance_access_consolecli_info.py
@@ -59,7 +59,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_access_dcui.py b/plugins/modules/appliance_access_dcui.py
@@ -70,7 +70,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_access_dcui_info.py b/plugins/modules/appliance_access_dcui_info.py
@@ -59,7 +59,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_access_shell.py b/plugins/modules/appliance_access_shell.py
@@ -78,7 +78,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_access_shell_info.py b/plugins/modules/appliance_access_shell_info.py
@@ -61,7 +61,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_access_ssh.py b/plugins/modules/appliance_access_ssh.py
@@ -70,7 +70,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_access_ssh_info.py b/plugins/modules/appliance_access_ssh_info.py
@@ -59,7 +59,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_health_applmgmt_info.py b/plugins/modules/appliance_health_applmgmt_info.py
@@ -59,7 +59,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_health_database_info.py b/plugins/modules/appliance_health_database_info.py
@@ -59,7 +59,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_health_databasestorage_info.py b/plugins/modules/appliance_health_databasestorage_info.py
@@ -59,7 +59,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_health_load_info.py b/plugins/modules/appliance_health_load_info.py
@@ -59,7 +59,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_health_mem_info.py b/plugins/modules/appliance_health_mem_info.py
@@ -59,7 +59,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_health_softwarepackages_info.py b/plugins/modules/appliance_health_softwarepackages_info.py
@@ -64,7 +64,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_health_storage_info.py b/plugins/modules/appliance_health_storage_info.py
@@ -59,7 +59,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_health_swap_info.py b/plugins/modules/appliance_health_swap_info.py
@@ -59,7 +59,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_health_system_info.py b/plugins/modules/appliance_health_system_info.py
@@ -59,7 +59,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_infraprofile_configs.py b/plugins/modules/appliance_infraprofile_configs.py
@@ -83,7 +83,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_infraprofile_configs_info.py b/plugins/modules/appliance_infraprofile_configs_info.py
@@ -59,7 +59,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_localaccounts_globalpolicy.py b/plugins/modules/appliance_localaccounts_globalpolicy.py
@@ -83,7 +83,7 @@
         type: int
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_localaccounts_globalpolicy_info.py b/plugins/modules/appliance_localaccounts_globalpolicy_info.py
@@ -59,7 +59,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_localaccounts_info.py b/plugins/modules/appliance_localaccounts_info.py
@@ -63,7 +63,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_monitoring_info.py b/plugins/modules/appliance_monitoring_info.py
@@ -65,7 +65,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_monitoring_query.py b/plugins/modules/appliance_monitoring_query.py
@@ -100,7 +100,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_networking.py b/plugins/modules/appliance_networking.py
@@ -73,7 +73,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_networking_dns_domains.py b/plugins/modules/appliance_networking_dns_domains.py
@@ -75,7 +75,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6
@@ -111,8 +111,8 @@
 
 # This structure describes the format of the data expected by the end-points
 PAYLOAD_FORMAT = {
-    "add": {"query": {}, "body": {"domain": "domain"}, "path": {}},
     "set": {"query": {}, "body": {"domains": "domains"}, "path": {}},
+    "add": {"query": {}, "body": {"domain": "domain"}, "path": {}},
 }  # pylint: disable=line-too-long
 
 from ansible.module_utils.basic import env_fallback

diff --git a/plugins/modules/appliance_networking_dns_domains_info.py b/plugins/modules/appliance_networking_dns_domains_info.py
@@ -59,7 +59,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_networking_dns_hostname.py b/plugins/modules/appliance_networking_dns_hostname.py
@@ -71,7 +71,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6
@@ -103,8 +103,8 @@
 
 # This structure describes the format of the data expected by the end-points
 PAYLOAD_FORMAT = {
-    "test": {"query": {}, "body": {"name": "name"}, "path": {}},
     "set": {"query": {}, "body": {"name": "name"}, "path": {}},
+    "test": {"query": {}, "body": {"name": "name"}, "path": {}},
 }  # pylint: disable=line-too-long
 
 from ansible.module_utils.basic import env_fallback

diff --git a/plugins/modules/appliance_networking_dns_hostname_info.py b/plugins/modules/appliance_networking_dns_hostname_info.py
@@ -59,7 +59,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6

diff --git a/plugins/modules/appliance_networking_dns_servers.py b/plugins/modules/appliance_networking_dns_servers.py
@@ -85,7 +85,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6
@@ -142,9 +142,9 @@
 
 # This structure describes the format of the data expected by the end-points
 PAYLOAD_FORMAT = {
-    "test": {"query": {}, "body": {"servers": "servers"}, "path": {}},
-    "add": {"query": {}, "body": {"server": "server"}, "path": {}},
     "set": {"query": {}, "body": {"mode": "mode", "servers": "servers"}, "path": {}},
+    "add": {"query": {}, "body": {"server": "server"}, "path": {}},
+    "test": {"query": {}, "body": {"servers": "servers"}, "path": {}},
 }  # pylint: disable=line-too-long
 
 from ansible.module_utils.basic import env_fallback

diff --git a/plugins/modules/appliance_networking_dns_servers_info.py b/plugins/modules/appliance_networking_dns_servers_info.py
@@ -59,7 +59,7 @@
         type: bool
 author:
 - Ansible Cloud Team (@ansible-collections)
-version_added: 1.0.0
+version_added: 2.0.0
 requirements:
 - vSphere 7.0.3 or greater
 - python >= 3.6