From de12161deac0c3a813ac6c2c9a9830e71abb93f7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ren=C3=A9=20Moser?= <mail@renemoser.net>
Date: Thu, 15 Nov 2018 14:38:42 +0100
Subject: [PATCH] cs_template: fix KeyError on state=extracted (#48675)

* cs_template: fix KeyError on state=extracted

* add changelog

(cherry picked from commit c7c3ca1c41db7983377dc6d58e79f91465c74919)
---
 ..._template-fix-keyerror-state-extracted.yml |  2 +
 .../modules/cloud/cloudstack/cs_template.py   | 53 ++++++++++---------
 2 files changed, 30 insertions(+), 25 deletions(-)
 create mode 100644 changelogs/fragments/48675-cs_template-fix-keyerror-state-extracted.yml

diff --git a/changelogs/fragments/48675-cs_template-fix-keyerror-state-extracted.yml b/changelogs/fragments/48675-cs_template-fix-keyerror-state-extracted.yml
new file mode 100644
index 00000000000..fbb3d37fd59
--- /dev/null
+++ b/changelogs/fragments/48675-cs_template-fix-keyerror-state-extracted.yml
@@ -0,0 +1,2 @@
+bugfixes:
+  - cs_template - Fixed a KeyError on state=extracted.
diff --git a/lib/ansible/modules/cloud/cloudstack/cs_template.py b/lib/ansible/modules/cloud/cloudstack/cs_template.py
index f29870436db..efbbed0e1f0 100644
--- a/lib/ansible/modules/cloud/cloudstack/cs_template.py
+++ b/lib/ansible/modules/cloud/cloudstack/cs_template.py
@@ -243,78 +243,78 @@ EXAMPLES = '''
 RETURN = '''
 ---
 id:
-  description: UUID of the template.
+  description: UUID of the template or extracted object.
   returned: success
   type: string
   sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
 name:
-  description: Name of the template.
+  description: Name of the template or extracted object.
   returned: success
   type: string
   sample: Debian 7 64-bit
 display_text:
   description: Display text of the template.
-  returned: success
+  returned: if available
   type: string
   sample: Debian 7.7 64-bit minimal 2015-03-19
 checksum:
   description: MD5 checksum of the template.
-  returned: success
+  returned: if available
   type: string
   sample: 0b31bccccb048d20b551f70830bb7ad0
 status:
-  description: Status of the template.
+  description: Status of the template or extracted object.
   returned: success
   type: string
   sample: Download Complete
 is_ready:
   description: True if the template is ready to be deployed from.
-  returned: success
+  returned: if available
   type: boolean
   sample: true
 is_public:
   description: True if the template is public.
-  returned: success
+  returned: if available
   type: boolean
   sample: true
 is_featured:
   description: True if the template is featured.
-  returned: success
+  returned: if available
   type: boolean
   sample: true
 is_extractable:
   description: True if the template is extractable.
-  returned: success
+  returned: if available
   type: boolean
   sample: true
 format:
   description: Format of the template.
-  returned: success
+  returned: if available
   type: string
   sample: OVA
 os_type:
-  description: Typo of the OS.
-  returned: success
+  description: Type of the OS.
+  returned: if available
   type: string
   sample: CentOS 6.5 (64-bit)
 password_enabled:
   description: True if the reset password feature is enabled, false otherwise.
-  returned: success
+  returned: if available
   type: boolean
   sample: false
 sshkey_enabled:
   description: true if template is sshkey enabled, false otherwise.
-  returned: success
+  returned: if available
   type: boolean
   sample: false
 cross_zones:
   description: true if the template is managed across all zones, false otherwise.
-  returned: success
+  returned: if available
   type: boolean
   sample: false
 template_type:
   description: Type of the template.
-  returned: success
+  returned: if available
   type: string
   sample: USER
 created:
@@ -324,32 +324,32 @@ created:
   sample: 2015-03-29T14:57:06+0200
 template_tag:
   description: Template tag related to this template.
-  returned: success
+  returned: if available
   type: string
   sample: special
 hypervisor:
   description: Hypervisor related to this template.
-  returned: success
+  returned: if available
   type: string
   sample: VMware
 mode:
   description: Mode of extraction
-  returned: success
+  returned: on state=extracted
   type: string
   sample: http_download
 state:
   description: State of the extracted template
-  returned: success
+  returned: on state=extracted
   type: string
   sample: DOWNLOAD_URL_CREATED
 url:
   description: Url to which the template is extracted to
-  returned: success
+  returned: on state=extracted
   type: string
   sample: "http://1.2.3.4/userdata/eb307f13-4aca-45e8-b157-a414a14e6b04.ova"
 tags:
   description: List of resource tags associated with the template.
-  returned: success
+  returned: if available
   type: dict
   sample: '[ { "key": "foo", "value": "bar" } ]'
 zone:
@@ -664,9 +664,12 @@ class AnsibleCloudStackTemplate(AnsibleCloudStack):
     def get_result(self, template):
         super(AnsibleCloudStackTemplate, self).get_result(template)
         if template:
-            self.result['is_extractable'] = True if template['isextractable'] else False
-            self.result['is_featured'] = True if template['isfeatured'] else False
-            self.result['is_public'] = True if template['ispublic'] else False
+            if 'isextractable' in template:
+                self.result['is_extractable'] = True if template['isextractable'] else False
+            if 'isfeatured' in template:
+                self.result['is_featured'] = True if template['isfeatured'] else False
+            if 'ispublic' in template:
+                self.result['is_public'] = True if template['ispublic'] else False
         return self.result