From 762ce3e1cfd9fbf5c518c21f0ad9289322d014b9 Mon Sep 17 00:00:00 2001
From: Felix Fontein <felix@fontein.de>
Date: Tue, 2 Jan 2024 21:10:59 +0100
Subject: [PATCH] Remove 'debug' parameter from new CLI modules. Move log
 writing to single function. (#740)

---
 plugins/doc_fragments/docker.py    | 10 +++++-----
 plugins/module_utils/common.py     |  8 ++------
 plugins/module_utils/common_api.py |  8 ++------
 plugins/module_utils/common_cli.py | 12 ++++--------
 plugins/module_utils/util.py       | 21 +++++++++++++++------
 5 files changed, 28 insertions(+), 31 deletions(-)

diff --git a/plugins/doc_fragments/docker.py b/plugins/doc_fragments/docker.py
index 3973c062..747b8191 100644
--- a/plugins/doc_fragments/docker.py
+++ b/plugins/doc_fragments/docker.py
@@ -368,11 +368,11 @@ options:
         type: bool
         default: false
         aliases: [ tls_verify ]
-    debug:
-        description:
-            - Debug mode
-        type: bool
-        default: false
+    # debug:
+    #     description:
+    #         - Debug mode
+    #     type: bool
+    #     default: false
     cli_context:
         description:
             - The Docker CLI context to use.
diff --git a/plugins/module_utils/common.py b/plugins/module_utils/common.py
index de36936a..7f6ed14f 100644
--- a/plugins/module_utils/common.py
+++ b/plugins/module_utils/common.py
@@ -260,12 +260,8 @@ class AnsibleDockerClientBase(Client):
     def log(self, msg, pretty_print=False):
         pass
         # if self.debug:
-        #     log_file = open('docker.log', 'a')
-        #     if pretty_print:
-        #         log_file.write(json.dumps(msg, sort_keys=True, indent=4, separators=(',', ': ')))
-        #         log_file.write(u'\n')
-        #     else:
-        #         log_file.write(msg + u'\n')
+        #     from .util import log_debug
+        #     log_debug(msg, pretty_print=pretty_print)
 
     @abc.abstractmethod
     def fail(self, msg, **kwargs):
diff --git a/plugins/module_utils/common_api.py b/plugins/module_utils/common_api.py
index c0ca08df..1d63b541 100644
--- a/plugins/module_utils/common_api.py
+++ b/plugins/module_utils/common_api.py
@@ -131,12 +131,8 @@ class AnsibleDockerClientBase(Client):
     def log(self, msg, pretty_print=False):
         pass
         # if self.debug:
-        #     log_file = open('docker.log', 'a')
-        #     if pretty_print:
-        #         log_file.write(json.dumps(msg, sort_keys=True, indent=4, separators=(',', ': ')))
-        #         log_file.write(u'\n')
-        #     else:
-        #         log_file.write(msg + u'\n')
+        #     from .util import log_debug
+        #     log_debug(msg, pretty_print=pretty_print)
 
     @abc.abstractmethod
     def fail(self, msg, **kwargs):
diff --git a/plugins/module_utils/common_cli.py b/plugins/module_utils/common_cli.py
index 877fcbb8..5d5da556 100644
--- a/plugins/module_utils/common_cli.py
+++ b/plugins/module_utils/common_cli.py
@@ -38,7 +38,7 @@ DOCKER_COMMON_ARGS = dict(
     client_key=dict(type='path', aliases=['tls_client_key', 'key_path']),
     tls=dict(type='bool', default=DEFAULT_TLS, fallback=(env_fallback, ['DOCKER_TLS'])),
     validate_certs=dict(type='bool', default=DEFAULT_TLS_VERIFY, fallback=(env_fallback, ['DOCKER_TLS_VERIFY']), aliases=['tls_verify']),
-    debug=dict(type='bool', default=False),
+    # debug=dict(type='bool', default=False),
     cli_context=dict(type='str'),
 )
 
@@ -89,12 +89,8 @@ class AnsibleDockerClientBase(object):
     def log(self, msg, pretty_print=False):
         pass
         # if self.debug:
-        #     log_file = open('docker.log', 'a')
-        #     if pretty_print:
-        #         log_file.write(json.dumps(msg, sort_keys=True, indent=4, separators=(',', ': ')))
-        #         log_file.write(u'\n')
-        #     else:
-        #         log_file.write(msg + u'\n')
+        #     from .util import log_debug
+        #     log_debug(msg, pretty_print=pretty_print)
 
     def get_cli(self):
         return self._cli
@@ -299,7 +295,7 @@ class AnsibleModuleDockerClient(AnsibleDockerClientBase):
             required_by=required_by or {},
         )
 
-        self.debug = self.module.params['debug']
+        self.debug = False  # self.module.params['debug']
         self.check_mode = self.module.check_mode
         self.diff = self.module._diff
 
diff --git a/plugins/module_utils/util.py b/plugins/module_utils/util.py
index c6fe5b59..a2b3e907 100644
--- a/plugins/module_utils/util.py
+++ b/plugins/module_utils/util.py
@@ -6,6 +6,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 
+import json
 import re
 from datetime import timedelta
 
@@ -85,6 +86,19 @@ def sanitize_result(data):
         return data
 
 
+def log_debug(msg, pretty_print=False):
+    """Write a log message to docker.log.
+
+    If ``pretty_print=True``, the message will be pretty-printed as JSON.
+    """
+    with open('docker.log', 'a') as log_file:
+        if pretty_print:
+            log_file.write(json.dumps(msg, sort_keys=True, indent=4, separators=(',', ': ')))
+            log_file.write(u'\n')
+        else:
+            log_file.write(msg + u'\n')
+
+
 class DockerBaseClass(object):
     def __init__(self):
         self.debug = False
@@ -92,12 +106,7 @@ class DockerBaseClass(object):
     def log(self, msg, pretty_print=False):
         pass
         # if self.debug:
-        #     log_file = open('docker.log', 'a')
-        #     if pretty_print:
-        #         log_file.write(json.dumps(msg, sort_keys=True, indent=4, separators=(',', ': ')))
-        #         log_file.write(u'\n')
-        #     else:
-        #         log_file.write(msg + u'\n')
+        #     log_debug(msg, pretty_print=pretty_print)
 
 
 def update_tls_hostname(result, old_behavior=False, deprecate_function=None, uses_tls=True):