zuul-stream: automatically remove streaming files

When using protocol version 1, send a finalise message when streaming
is complete so that the zuul_console daemon can delete the temporary
file.

We test this by inspecting the Ansible console output, which logs a
message with the UUID of the streaming job.  We dump the temporary
files on the remote side and make sure a console file for that job
isn't present.

Change-Id: I823156dc2bcae91bd6d9770bd1520aa55ad875b4

1 files changed, 10 insertions, 0 deletions

diff --git a/zuul/ansible/base/callback/zuul_stream.py b/zuul/ansible/base/callback/zuul_stream.py
index d33b4dda0..f31983ed6 100644
--- a/zuul/ansible/base/callback/zuul_stream.py
+++ b/zuul/ansible/base/callback/zuul_stream.py
@@ -211,6 +211,16 @@ class CallbackModule(default.CallbackModule):
                 done = self._log_streamline(
                     host, line.decode("utf-8", "backslashreplace"))
                 if done:
+                    if self._zuul_console_version > 0:
+                        try:
+                            # reestablish connection and tell console to
+                            # clean up
+                            s = self._read_log_connect(host, ip, port)
+                            s.send(f'f:{log_id}\n'.encode('utf-8'))
+                            s.close()
+                        except Exception:
+                            # Don't worry if this fails
+                            pass
                     return
             else:
                 more = s.recv(4096)