From aa1b757c3d537eca4b2a3c2906b7d1e7d0d2e390 Mon Sep 17 00:00:00 2001
From: mayabi <mayabi@um.ac.ir>
Date: Sun, 30 Mar 2025 13:47:31 +0330
Subject: [PATCH] add vm_id in result output

---
 plugins/modules/proxmox_backup_schedule.py    | 19 ++++---
 .../modules/test_proxmox_backup_schedule.py   | 55 +++++++++----------
 2 files changed, 37 insertions(+), 37 deletions(-)

diff --git a/plugins/modules/proxmox_backup_schedule.py b/plugins/modules/proxmox_backup_schedule.py
index 83975fe078..48a2d70d60 100644
--- a/plugins/modules/proxmox_backup_schedule.py
+++ b/plugins/modules/proxmox_backup_schedule.py
@@ -13,7 +13,7 @@ DOCUMENTATION = """
 ---
 module: proxmox_backup_schedule
 
-short_description: Schedule VM backups and remove them
+short_description: Schedule VM backups and removing them
 
 version_added: 10.5.0
 
@@ -108,12 +108,12 @@ EXAMPLES = """
 
 RETURN = """
 ---
-changed:
+backup_schedule:
   description:
-    - If V(present), the changed will return True after adding the VM ID to the backup job.
-    - If V(absent), the changed will return True after removing it from the backup job.
+    - If V(present), the backup_schedule will return True after adding the VM ID to the backup job.
+    - If V(absent), the backup_schedule will return True after removing it from the backup job.
   returned: always, but can be empty
-  type: bool
+  type: raw
 """
 
 from ansible.module_utils.basic import AnsibleModule, missing_required_lib
@@ -246,13 +246,14 @@ def main():
         vm_id = proxmox.vmname_2_vmid(vm_name)
 
     if state == 'present':
-        backup_schedule = proxmox.backup_present(vm_id, backup_id)
+        backup_schedule_result = proxmox.backup_present(vm_id, backup_id)
 
     if state == 'absent':
-        backup_schedule = proxmox.backup_absent(vm_id, backup_id)
+        backup_schedule_result = proxmox.backup_absent(vm_id, backup_id)
 
-    if backup_schedule:
-        result['changed'] = True
+    if backup_schedule_result:
+        result['changed'] = backup_schedule_result
+        result['vm_id'] = vm_id
         result['message'] = 'The backup schedule has been changed successfully.'
     else:
         result['message'] = 'The backup schedule did not change anything.'
diff --git a/tests/unit/plugins/modules/test_proxmox_backup_schedule.py b/tests/unit/plugins/modules/test_proxmox_backup_schedule.py
index c541facecc..fad35b25b4 100644
--- a/tests/unit/plugins/modules/test_proxmox_backup_schedule.py
+++ b/tests/unit/plugins/modules/test_proxmox_backup_schedule.py
@@ -171,9 +171,7 @@ class TestProxmoxBackupScheduleModule(ModuleTestCase):
             RESOURCE_LIST
         )
         self.connect_mock.return_value.cluster.backup.get.side_effect = (
-            lambda backup_id=None: BACKUP_JOBS if backup_id is None else [
-                job for job in BACKUP_JOBS if job['id'] == backup_id
-            ]
+            lambda backup_id=None: BACKUP_JOBS if backup_id is None else [job for job in BACKUP_JOBS if job['id'] == backup_id]
         )
 
     def tearDown(self):
@@ -189,35 +187,36 @@ class TestProxmoxBackupScheduleModule(ModuleTestCase):
         assert result["msg"] == "missing required arguments: api_host, api_user, state"
 
     def test_update_vmid_in_backup(self):
-        with patch('builtins.input', return_value='mocked input'):
-            with pytest.raises(AnsibleExitJson) as exc_info:
-                set_module_args({
-                    'api_host': 'proxmoxhost',
-                    'api_user': 'root@pam',
-                    'api_password': 'supersecret',
-                    'vm_name': 'test05',
-                    'backup_id': 'backup-001',
-                    'state': 'present'
-                })
-                self.module.main()
+        with pytest.raises(AnsibleExitJson) as exc_info:
+            set_module_args({
+                'api_host': 'proxmoxhost',
+                'api_user': 'root@pam',
+                'api_password': 'supersecret',
+                'vm_name': 'test05',
+                'backup_id': 'backup-001',
+                'state': 'present'
+            })
+            self.module.main()
 
-            result = exc_info.value.args[0]
-            assert result['changed'] is True
+        result = exc_info.value.args[0]
+
+        assert result['changed'] is True
+        assert result['vm_id'] == 105
 
     def test_delete_vmid_from_backup(self):
-        with patch('builtins.input', return_value='mocked input'):
-            with pytest.raises(AnsibleExitJson) as exc_info:
-                set_module_args({
-                    'api_host': 'proxmoxhost',
-                    'api_user': 'root@pam',
-                    'api_password': 'supersecret',
-                    'vm_id': '101',
-                    'state': 'absent'
-                })
-                self.module.main()
+        with pytest.raises(AnsibleExitJson) as exc_info:
+            set_module_args({
+                'api_host': 'proxmoxhost',
+                'api_user': 'root@pam',
+                'api_password': 'supersecret',
+                'vm_id': 101,
+                'state': 'absent'
+            })
+            self.module.main()
 
-            result = exc_info.value.args[0]
-            assert result['changed'] is True
+        result = exc_info.value.args[0]
+        assert result['changed'] is True
+        assert result['vm_id'] == 101
 
 
 if __name__ == '__main__':