From ea8c1076254cb7f3d6d1ebbd6bafca6caa4a1423 Mon Sep 17 00:00:00 2001
From: Raghu Siddarth Udiyar <raghusiddarth@gmail.com>
Date: Sun, 15 Nov 2020 21:21:02 +0530
Subject: [PATCH] Add docker build output to task result (#805)

The build output is only added during failures, but its useful to
have this available during normal task execution as well.
---
 ....general-805-docker_image-build-output.yml |  2 ++
 plugins/modules/docker_image.py               | 22 ++++++++++++++-----
 .../docker_image/tasks/tests/docker_image.yml |  5 +++++
 3 files changed, 24 insertions(+), 5 deletions(-)
 create mode 100644 changelogs/fragments/community.general-805-docker_image-build-output.yml

diff --git a/changelogs/fragments/community.general-805-docker_image-build-output.yml b/changelogs/fragments/community.general-805-docker_image-build-output.yml
new file mode 100644
index 00000000..ed762094
--- /dev/null
+++ b/changelogs/fragments/community.general-805-docker_image-build-output.yml
@@ -0,0 +1,2 @@
+minor_changes:
+  - "docker_image - return docker build output (https://github.com/ansible-collections/community.general/pull/805)."
diff --git a/plugins/modules/docker_image.py b/plugins/modules/docker_image.py
index d0cce7ce..922547d2 100644
--- a/plugins/modules/docker_image.py
+++ b/plugins/modules/docker_image.py
@@ -291,6 +291,12 @@ image:
     returned: success
     type: dict
     sample: {}
+stdout:
+    description: Docker build output when building an image.
+    returned: success
+    type: str
+    sample: ""
+    version_added: 1.3.0
 '''
 
 import errno
@@ -397,7 +403,8 @@ class ImageManager(DockerBaseClass):
                 self.results['actions'].append("Built image %s from %s" % (image_name, self.build_path))
                 self.results['changed'] = True
                 if not self.check_mode:
-                    self.results['image'] = self.build_image()
+                    self.results.update(self.build_image())
+
             elif self.source == 'load':
                 # Load the image from an archive
                 if not os.path.isfile(self.load_path):
@@ -604,7 +611,7 @@ class ImageManager(DockerBaseClass):
         )
         if self.client.docker_py_version < LooseVersion('3.0.0'):
             params['stream'] = True
-        build_output = []
+
         if self.tag:
             params['tag'] = "%s:%s" % (self.name, self.tag)
         if self.container_limits:
@@ -628,11 +635,14 @@ class ImageManager(DockerBaseClass):
         if self.target:
             params['target'] = self.target
 
+        build_output = []
         for line in self.client.build(**params):
             # line = json.loads(line)
             self.log(line, pretty_print=True)
-            if "stream" in line:
-                build_output.append(line["stream"])
+            if "stream" in line or "status" in line:
+                build_line = line.get("stream") or line.get("status")
+                build_output.append(build_line)
+
             if line.get('error'):
                 if line.get('errorDetail'):
                     errorDetail = line.get('errorDetail')
@@ -645,7 +655,9 @@ class ImageManager(DockerBaseClass):
                 else:
                     self.fail("Error building %s - message: %s, logs: %s" % (
                         self.name, line.get('error'), build_output))
-        return self.client.find_image(name=self.name, tag=self.tag)
+
+        return {"stdout": "\n".join(build_output),
+                "image": self.client.find_image(name=self.name, tag=self.tag)}
 
     def load_image(self):
         '''
diff --git a/tests/integration/targets/docker_image/tasks/tests/docker_image.yml b/tests/integration/targets/docker_image/tasks/tests/docker_image.yml
index 1959446a..3cb45d01 100644
--- a/tests/integration/targets/docker_image/tasks/tests/docker_image.yml
+++ b/tests/integration/targets/docker_image/tasks/tests/docker_image.yml
@@ -136,6 +136,11 @@
     - repository_1 is changed
     - repository_2 is not changed
 
+# Uncomment in community.docker
+# - assert:
+#     that:
+#       - 'FROM busybox' in repository_1.stdout
+
 - name: Get facts of image
   docker_image_info:
     name: "{{ test_image_base }}:latest"